Class Game

Access core properties of the currently running game instance.

Properties

gameId localPlayer organizationId platform serverId

Methods

IsClient IsHosting IsMobile IsServer WaitForGameData

Properties

Static gameId

gameId: string

While in editor, this will reflect whatever is defined in Assets/GameConfig.asset

Static localPlayer

localPlayer: Player = ...

The local client's player.

On the server this is undefined.

There is a brief moment on client startup when localPlayer is undefined. You can listen for when the local player is loaded with WaitForLocalPlayerLoaded

Static organizationId

organizationId: string

Empty string when in editor.

Static platform

platform: AirshipPlatform = ...

The platform of this device.

To get a certain player's platform, use Player.platform

Static serverId

serverId: string

Empty string when in editor.

Methods

Static IsClient

  • IsClient(): boolean

  • Returns boolean

    True if this game instance is acting as a player client. When published this will be true for all players. In local development in Shared Server Mode this will also be true (because the client is operating as both server and client).

Static IsHosting

  • IsHosting(): boolean

  • Shortcut for checking if both IsClient() and IsServer() is true.

    Returns boolean

Static IsMobile

  • IsMobile(): boolean

  • Returns true if device is a phone or tablet.

    Returns false if on desktop or console.

    Returns boolean

Static IsServer

  • IsServer(): boolean

  • Returns boolean

    True if this game instance is acting as the server. When published this will only be true on the game server. In local development in Shared Server Mode this will also be true (because the client is operating as both server and client).

Static WaitForGameData

  • WaitForGameData(): GameDto

  • Yields until Game.gameData has been loaded.

    Returns GameDto

Settings

Member Visibility

Theme

On This Page

gameIdlocalPlayerorganizationIdplatformserverIdIsClientIsHostingIsMobileIsServerWaitForGameData