Class WorldsService

Namespace

Coherence.Cloud

Assembly

Coherence.Runtime.dll

public class WorldsService

Inheritance

object

WorldsService

Extension Methods

WorldServiceCoroutineExtensions.WaitForFetchWorlds(WorldsService, string, string)

WorldServiceCoroutineExtensions.WaitForInitialization(WorldsService)

Constructors

WorldsService(CloudCredentialsPair, IRuntimeSettings)

public WorldsService(CloudCredentialsPair credentialsPair = null, IRuntimeSettings runtimeSettings = null)

Parameters

credentialsPair CloudCredentialsPair

runtimeSettings IRuntimeSettings

Properties

IsReady

Returns true when the Web Socket is connected and when we are logged in to coherence Cloud.

public bool IsReady { get; }

Property Value

bool

Methods

FetchWorlds(Action<RequestResponse<IReadOnlyList<WorldData>>>, string, string)

Get the list of available/online worlds that you have created in your coherence Dashboard.

public void FetchWorlds(Action<RequestResponse<IReadOnlyList<WorldData>>> onRequestFinished, string region = "", string simSlug = "")

Parameters

onRequestFinished Action<RequestResponse<IReadOnlyList<WorldData>>>

Callback that will be invoked when the request finished, with the list of worlds.

region string

Filter the available worlds by a specific region.

simSlug string

Filter the available worlds by a specific Simulator slug.

FetchWorldsAsync(string, string)

Get the list of available/online worlds that you have created in your coherence Dashboard asynchronously.

public Task<IReadOnlyList<WorldData>> FetchWorldsAsync(string region = "", string simSlug = "")

Parameters

region string

Filter the available worlds by a specific region.

simSlug string

Filter the available worlds by a specific Simulator slug.

Returns

Task<IReadOnlyList<WorldData>>

Return true to accept the request for authority.

GetFetchWorldsCooldown()

public TimeSpan GetFetchWorldsCooldown()

Returns

TimeSpan

Returns the internal cooldown for the Fetch Worlds endpoint.