Class WorldsService
public class WorldsService
- Inheritance
-
WorldsService
- Extension Methods
Constructors
WorldsService(CloudCredentialsPair, IRuntimeSettings)
public WorldsService(CloudCredentialsPair credentialsPair = null, IRuntimeSettings runtimeSettings = null)
Parameters
credentialsPair
CloudCredentialsPairruntimeSettings
IRuntimeSettings
Properties
IsLoggedIn
Returns true when the Web Socket is connected and when we are logged in to coherence Cloud.
public bool IsLoggedIn { get; }
Property Value
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
stringFilter the available worlds by a specific region.
simSlug
stringFilter 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
stringFilter the available worlds by a specific region.
simSlug
stringFilter 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.