Game | @gathertown/gather-game-client

Hierarchy

Game

Index

Constructors

constructor

Methods

Constructors

constructor

new Game(spaceId: undefined | string, getAuth: () => Promise<EngineAuth>, onInput?: (dir: MoveDirectionEnum_ENUM, stopped: boolean, inputId: number) => void, dispatchGameUpdate?: (delta: PartialGameState<Player>) => void, dispatchMapUpdate?: (mapId: string, map: Readonly<GameMapV2>) => void, options?: GameOptions): Game

- Defined in gather-game-client/src/Game.ts:167
Parameters
- spaceId: undefined | string
- getAuth: () => Promise<EngineAuth>
  - - (): Promise<EngineAuth>
    - Returns Promise<EngineAuth>
- Optional onInput: (dir: MoveDirectionEnum_ENUM, stopped: boolean, inputId: number) => void
  - - (dir: MoveDirectionEnum_ENUM, stopped: boolean, inputId: number): void
    - Parameters
      - dir: MoveDirectionEnum_ENUM
      - stopped: boolean
      - inputId: number
      Returns void
- Optional dispatchGameUpdate: (delta: PartialGameState<Player>) => void
  - - (delta: PartialGameState<Player>): void
    - Parameters
      - delta: PartialGameState<Player>
      Returns void
- Optional dispatchMapUpdate: (mapId: string, map: Readonly<GameMapV2>) => void
  - - (mapId: string, map: Readonly<GameMapV2>): void
    - Parameters
      - mapId: string
      - map: Readonly<GameMapV2>
      Returns void
- Optional options: GameOptions
Returns Game

Properties

Private _connectCalledAt

_connectCalledAt: number = 0

Private _connectedAtMs

_connectedAtMs: number = 0

Private _encIdMapping

_encIdMapping: {} = {}

Type declaration

[encId: number]: string

Private _initializedAtMs

_initializedAtMs: number = 0

Private _onMapCounts

_onMapCounts: {} = {}

Type declaration

[mapId: string]: number

Private _timeToConnect

_timeToConnect: number = -1

completeMaps

completeMaps: {} = ...

Type declaration

[id: string]: GameMapV2

connected

connected: boolean = false

Optional debugOverrideServer

debugOverrideServer: string

Private disconnectHandlers

disconnectHandlers: {} = {}

Type declaration

[uuid: string]: (code?: number, reason?: string) => void
- - (code?: number, reason?: string): void
  - Parameters
    - Optional code: number
    - Optional reason: string
    Returns void

Optional dispatchGameUpdate

dispatchGameUpdate: (delta: PartialGameState<Player>) => void

Type declaration

- (delta: PartialGameState<Player>): void
- Parameters
  - delta: PartialGameState<Player>
  Returns void

Optional dispatchMapUpdate

dispatchMapUpdate: (mapId: string, map: Readonly<GameMapV2>) => void

Type declaration

- (mapId: string, map: Readonly<GameMapV2>): void
- Parameters
  - mapId: string
  - map: Readonly<GameMapV2>
  Returns void

engine

engine: Engine

Private eventSubscriptions

eventSubscriptions: {} = {}

Type declaration

getAuth

getAuth: () => Promise<EngineAuth>

Type declaration

- (): Promise<EngineAuth>
- Returns Promise<EngineAuth>

Private hasSentMapSinceConnect

hasSentMapSinceConnect: boolean = false

inputId

inputId: number = 1

lastMapUpdateIds

lastMapUpdateIds: {} = ...

Type declaration

[id: string]: number

legacySubscriptions

legacySubscriptions: {} = {}

deprecated

Type declaration

[uuid: string]: GameSpaceSubscription

legacySubscriptionsConnection

legacySubscriptionsConnection: {} = {}

deprecated

Type declaration

[uuid: string]: (connected: boolean) => void
- - (connected: boolean): void
  - Parameters
    - connected: boolean
    Returns void

Private mapDataCheckInterval

mapDataCheckInterval: undefined | Timeout

Private mapDataChecks

mapDataChecks: number = 0

Private mapsAccumulator

mapsAccumulator: MapsAccumulator = ...

onInput

onInput: undefined | ((dir: MoveDirectionEnum_ENUM, stopped: boolean, inputId: number) => void)

partialMaps

partialMaps: {} = ...

Type declaration

[id: string]: Partial<GameMapV2>

players

players: {} = {}

Type declaration

[uid: string]: Player

putMetric

putMetric: (metricName: string, metricValue: any) => void = ...

Type declaration

- (metricName: string, metricValue: any): void
- Parameters
  - metricName: string
  - metricValue: any
  Returns void

Optional spaceId

spaceId: string

Private subscriptions

subscriptions: GameEventSubscriptionMap = {}

Private timeToFirstOnMapsMs

timeToFirstOnMapsMs: {} = {}

Type declaration

[mapId: string]: number

Private updateSubscriptionsPromise

updateSubscriptionsPromise: undefined | Promise<void>

Methods

_setupEngineCallbacks

_setupEngineCallbacks(): void

- Defined in gather-game-client/src/Game.ts:222
Returns void

_startMapDataCheckInterval

_startMapDataCheckInterval(): void

- Defined in gather-game-client/src/Game.ts:1523
Returns void

banPlayer

banPlayer(user: string): void

- Defined in gather-game-client/src/Game.ts:962
Parameters
- user: string
Returns void

block

block(blockedUserId: string, blocked: boolean): void

- Defined in gather-game-client/src/Game.ts:756
Parameters
- blockedUserId: string
- blocked: boolean
Returns void

chat

chat(chatRecipient: string, localPlayers: string[], mapId: string, data: { contents: string; id?: string }): void

- Defined in gather-game-client/src/Game.ts:989
Parameters
- chatRecipient: string
- localPlayers: string[]
- mapId: string
- data: { contents: string; id?: string }
  - contents: string
  - Optional id?: string
Returns void

clearItem

clearItem(targetId?: string): void

- Defined in gather-game-client/src/Game.ts:919
Parameters
- Optional targetId: string
Returns void

connect

connect(): undefined | Promise<void>

- Defined in gather-game-client/src/Game.ts:488
Call this once when connecting to a space.

Returns undefined | Promise<void>

debug

debug(debugState?: boolean): void

- Defined in gather-game-client/src/Game.ts:154
Parameters
- debugState: boolean = true
Returns void

deleteObject

deleteObject(mapId: string, objId: string, createTxnId?: boolean): Promise<unknown>

- Defined in gather-game-client/src/Game.ts:1432
Parameters
- mapId: string
- objId: string
- createTxnId: boolean = false
Returns Promise<unknown>

deleteObjectByKey

deleteObjectByKey(mapId: string, key: number, createTxnId?: boolean): Promise<unknown>

- Defined in gather-game-client/src/Game.ts:1419
Parameters
- mapId: string
- key: number
- createTxnId: boolean = false
Returns Promise<unknown>

disconnect

disconnect(): void

- Defined in gather-game-client/src/Game.ts:518
Returns void

editChatMessage

editChatMessage(message: EditChatMessage): void

- Defined in gather-game-client/src/Game.ts:1005
Parameters
- message: EditChatMessage
Returns void

enter

enter(info: SpaceUserInfo, spawnToken?: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:639
Parameters
- info: SpaceUserInfo
- Optional spawnToken: string
- Optional targetId: string
Returns void

enterPortal

enterPortal(targetUrl: string, targetId?: string, bypassPrompt?: boolean): void

- Defined in gather-game-client/src/Game.ts:1067
Parameters
- targetUrl: string
- Optional targetId: string
- Optional bypassPrompt: boolean
Returns void

enterWhisper

enterWhisper(recipientId: string, dir: MoveDirectionEnum_ENUM): void

- Defined in gather-game-client/src/Game.ts:714
Parameters
- recipientId: string
  
  player ID of the other
- dir: MoveDirectionEnum_ENUM
  
  MoveDirection enum
Returns void

exit

exit(): void

- Defined in gather-game-client/src/Game.ts:645
Returns void

filterObjectsInMap

filterObjectsInMap(mapId: string, filter: (obj: Partial<MapObject>) => boolean): MapObject[]

- Defined in gather-game-client/src/Game.ts:1577
Returns a list of all objects in the map matching a condition.

example

game.filterObjectsInMap("park-legacy", (obj) => obj.id.startsWith("password-door")); // finds all password doors in a map

Parameters
- mapId: string
  
  The map you want to filter objects on.
- filter: (obj: Partial<MapObject>) => boolean
  
  A predicate that returns a truthy value if you want the object to be returned.
  - - (obj: Partial<MapObject>): boolean
    - Parameters
      - obj: Partial<MapObject>
      Returns boolean
Returns MapObject[]

filterPlayersInSpace

filterPlayersInSpace(filter: (player: Partial<Player>) => boolean): Player[]

- Defined in gather-game-client/src/Game.ts:1596
Returns a list of all players in the space matching a condition.

example

filterPlayersInSpace((player) => player.name === "Evelyn"); // returns the Player object for all players named Evelyn

Parameters
- filter: (player: Partial<Player>) => boolean
  
  A predicate that retunrs a truthy value if you want the player to be returned
  - - (player: Partial<Player>): boolean
    - Parameters
      - player: Partial<Player>
      Returns boolean
Returns Player[]

getDebugHistory

getDebugHistory(): string

- Defined in gather-game-client/src/Game.ts:1537
Returns string

getKnownCompletedMaps

getKnownCompletedMaps(): string[]

- Defined in gather-game-client/src/Game.ts:1567
Returns the keys for all completed maps. See docstring for getKnownPartialMaps().

Returns string[]

getKnownPartialMaps

getKnownPartialMaps(): string[]

- Defined in gather-game-client/src/Game.ts:1560
Returns all known maps- i.e the keys of game.partialMaps We add this abstraction for convience and clarity, and because game.partialMaps could be renamed. You should prefer to use this function.

Returns string[]

getObject

getObject(objId: string, mapId?: string): null | { mapId: string; obj: undefined | MapObject }

- Defined in gather-game-client/src/Game.ts:1364
Parameters
- objId: string
- Optional mapId: string
Returns null | { mapId: string; obj: undefined | MapObject }

getPlayer

getPlayer(uid: string): undefined | Player

- Defined in gather-game-client/src/Game.ts:531
Parameters
- uid: string
Returns undefined | Player

getPlayersInMap

getPlayersInMap(mapId: string): Player[]

- Defined in gather-game-client/src/Game.ts:1547
Returns all players that are in the same map as you.

example

game.getPlayersInMap("new office")

Parameters
- mapId: string
  
  The string mapId you want to filter on
Returns Player[]

getStats

getStats(): { currentMap: undefined | string; engine: { bufferedAmount: SlidingWindowMetrics; bytesReceivedSinceConnect: number; bytesSentSinceConnect: number; closeCodeCount: {}; connected: boolean; eventCountsSinceOpen: {}; latency: SlidingWindowMetrics; reconnects: { recentAttempts: number; timeSpentDisconnectedMs: SlidingWindowMetrics } }; gameClientAgeMs: number; gameClientVersion: string; numPlayers: number; onMapCountsAllTime: {}; preferredRegion: undefined | string; preferredRegionPing: number; serverURL: string; timeToConnect: number; timeToFirstOnMapMs: {}; wsReadyState: undefined | number }

- Defined in gather-game-client/src/Game.ts:1476
Returns { currentMap: undefined | string; engine: { bufferedAmount: SlidingWindowMetrics; bytesReceivedSinceConnect: number; bytesSentSinceConnect: number; closeCodeCount: {}; connected: boolean; eventCountsSinceOpen: {}; latency: SlidingWindowMetrics; reconnects: { recentAttempts: number; timeSpentDisconnectedMs: SlidingWindowMetrics } }; gameClientAgeMs: number; gameClientVersion: string; numPlayers: number; onMapCountsAllTime: {}; preferredRegion: undefined | string; preferredRegionPing: number; serverURL: string; timeToConnect: number; timeToFirstOnMapMs: {}; wsReadyState: undefined | number }
- currentMap: undefined | string
- engine: { bufferedAmount: SlidingWindowMetrics; bytesReceivedSinceConnect: number; bytesSentSinceConnect: number; closeCodeCount: {}; connected: boolean; eventCountsSinceOpen: {}; latency: SlidingWindowMetrics; reconnects: { recentAttempts: number; timeSpentDisconnectedMs: SlidingWindowMetrics } }
  - bufferedAmount: SlidingWindowMetrics
  - bytesReceivedSinceConnect: number
  - bytesSentSinceConnect: number
  - closeCodeCount: {}
    - [code: number]: number
  - connected: boolean
  - eventCountsSinceOpen: {}
    - [event: string]: number
  - latency: SlidingWindowMetrics
  - reconnects: { recentAttempts: number; timeSpentDisconnectedMs: SlidingWindowMetrics }
    - recentAttempts: number
    - timeSpentDisconnectedMs: SlidingWindowMetrics
- gameClientAgeMs: number
- gameClientVersion: string
- numPlayers: number
- onMapCountsAllTime: {}
  - [mapId: string]: number
- preferredRegion: undefined | string
- preferredRegionPing: number
- serverURL: string
- timeToConnect: number
- timeToFirstOnMapMs: {}
  - [mapId: string]: number
- wsReadyState: undefined | number

ghost

ghost(ghost: number, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:699
Puts the currently connected client in ghost mode

Parameters
- ghost: number
  
  ghost value, either 1 or 0; whether you are ghosting or not.
- Optional targetId: string
  
  id of player whose ghost value you want to set (must be space owner to set)
Returns void

init

init(spaceId: string, _overrideServer?: string): void

- Defined in gather-game-client/src/Game.ts:204
Parameters
- spaceId: string
- Optional _overrideServer: string
Returns void

interact

interact(objId: string, data?: any): void

- Defined in gather-game-client/src/Game.ts:980
Parameters
- objId: string
- Optional data: any
Returns void

isPlayerInPrivateSpace

isPlayerInPrivateSpace(player: Partial<Player>, mapId: string, privateSpaceId: string): boolean

- Defined in gather-game-client/src/Game.ts:1615
Utility function that returns true if a player is standing inside a given private space. Requires the map to be defined first - use game.waitForInit() to be sure it has been defined. You can pass this directly into filterPlayersInSpace using a thunk.

example

isPlayerInPrivateSpace(player, "new office", "library") // returns if a given player is in the library

example

filterPlayersInSpace((player) => isPlayerInPrivateSpace(player, "new office", "library")); // finds everyone on that tile

Parameters
- player: Partial<Player>
  
  A Partial referencing the player
- mapId: string
  
  the map the private tile is in
- privateSpaceId: string
  
  the name of the private space you put in the mapmaker
Returns boolean

kickPlayer

kickPlayer(user: string): void

- Defined in gather-game-client/src/Game.ts:970
Parameters
- user: string
Returns void

leaveWhisper

leaveWhisper(): void

- Defined in gather-game-client/src/Game.ts:723
Returns void

move

move(dir: MoveDirectionEnum_ENUM, stopped?: boolean, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:662
Parameters
- dir: MoveDirectionEnum_ENUM
- stopped: boolean = false
- Optional targetId: string
Returns void

moveMapObject

moveMapObject(mapId: string, objectId: string, targetWorldPos: { x: number; xOffset?: number; y: number; yOffset?: number }, durationMs: number, easing?: "Linear" | "Cubic" | "Elastic" | "Bounce" | "Back"): void

- Defined in gather-game-client/src/Game.ts:1201
Animates an object moving from its current position to targetWorldPos. Also handles setting the object's new position in the map itself.

Parameters
- mapId: string
- objectId: string
- targetWorldPos: { x: number; xOffset?: number; y: number; yOffset?: number }
  - x: number
  - Optional xOffset?: number
  - y: number
  - Optional yOffset?: number
- durationMs: number
- easing: "Linear" | "Cubic" | "Elastic" | "Bounce" | "Back" = "Linear"
Returns void

notify

notify(notification: string): void

- Defined in gather-game-client/src/Game.ts:1011
Parameters
- notification: string
Returns void

patchGatherEventsSpaceSession

patchGatherEventsSpaceSession(playerUpdatesSession: PlayerUpdatesSession): void

- Defined in gather-game-client/src/Game.ts:1599
Parameters
- playerUpdatesSession: PlayerUpdatesSession
Returns void

playSound

playSound(src: string, volume: number, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:683
Utility function for map developers that plays a sound file on the client, once. Use targetId if you are a space owner to play a sound on another client. If no sound is specified, it plays for the entire space. You must be a space owner to play a sound on the whole space.

Parameters
- src: string
  
  HTMl5 compliant audio resource, e.g a URL to a mp3
- volume: number
  
  scalar volume from 0 to 1.0
- Optional targetId: string
  
  id of another player you want to play the sound on
Returns void

pointer

pointer(objectId: string, x: number, y: number): void

- Defined in gather-game-client/src/Game.ts:765
Parameters
- objectId: string
- x: number
- y: number
Returns void

publishEvent

publishEvent<T>(eventId: T, data: ServerClientEventByCase<T>, context: ServerClientEventContext): void

- Defined in gather-game-client/src/Game.ts:538
Type parameters
- T: "info" | "warn" | "error" | "ready" | "serverHeartbeat" | "transactionStatus" | "playerMoves" | "playerSetsStatus" | "playerSpotlights" | "playerRings" | "playerChats" | "playerInteracts" | "playerGhosts" | "playerEntersWhisper" | "playerLeavesWhisper" | "playerActivelySpeaks" | "playerSetsWorkCondition" | "playerSetsName" | "playerSetsTextStatus" | "playerSetsEmojiStatus" | "playerSetsAffiliation" | "playerExits" | "respawnComplete" | "playerSetsOutfitString" | "playerSetsIsSignedIn" | "spaceOverwrites" | "spaceIsClosed" | "playerEntersPortal" | "spaceSetsIdMapping" | "playerSetsLastActive" | "playerShootsConfetti" | "playerSetsEventStatus" | "playerSetsInConversation" | "playerSetsCurrentDesk" | "playerSetsCurrentArea" | "playerSetsImagePointer" | "cookieFound" | "playerEntersWhisperV2" | "playerSetsGoKartId" | "mapSetDimensions" | "mapSetCollisions" | "mapSetBackgroundImagePath" | "mapSetForegroundImagePath" | "mapSetSprites" | "mapSetSpaces" | "mapSetSpawns" | "mapSetPortals" | "mapSetAnnouncer" | "mapSetAssets" | "mapSetObjects" | "mapSetName" | "mapSetMuteOnEntry" | "mapSetUseDrawnBG" | "mapSetWalls" | "mapSetFloors" | "mapSetAreas" | "mapDeleteObject" | "mapSetSpawn" | "playerSetsIsAlone" | "playerJoins" | "mapSetEnabledChats" | "mapSetDescription" | "mapSetDecoration" | "mapSetTutorialTasks" | "mapSetMiniMapImagePath" | "spacePlaysSound" | "mapSetScript" | "mapSetDesks" | "playerSetsIsMobile" | "setScreenPointerServer" | "playerSetsEmoteV2" | "playerSetsFocusModeEndTime" | "spaceSetsSpaceMembers" | "customEvent" | "playerSetsOpenToConversation" | "playerBlocks" | "playerUpdatesFocusModeStatus" | "playerNotifies" | "playerSetsItemString" | "playerTriggersItem" | "playerSetsFollowTarget" | "playerRequestsToLead" | "playerSetsManualVideoSrc" | "playerSetsIsNpc" | "playerSetsSubtitle" | "mapCommitsChanges" | "playerUpdatesSession" | "mapMoveObject" | "playerEditsChatMessage"
Parameters
- eventId: T
- data: ServerClientEventByCase<T>
- context: ServerClientEventContext
Returns void

requestToLead

requestToLead(target: string, snapshot?: string): Promise<void>

- Defined in gather-game-client/src/Game.ts:1446
Parameters
- target: string
- snapshot: string = ""
Returns Promise<void>

respawn

respawn(): void

- Defined in gather-game-client/src/Game.ts:648
Returns void

ring

ring(user: string): void

- Defined in gather-game-client/src/Game.ts:748
Parameters
- user: string
Returns void

screenPointer

screenPointer(screenId: string, x: number, y: number): void

- Defined in gather-game-client/src/Game.ts:775
Parameters
- screenId: string
- x: number
- y: number
Returns void

setActivelySpeaking

setActivelySpeaking(activelySpeaking: boolean): void

- Defined in gather-game-client/src/Game.ts:785
Parameters
- activelySpeaking: boolean
Returns void

setAffiliation

setAffiliation(affiliation: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:855
Parameters
- affiliation: string
- Optional targetId: string
Returns void

setCurrentArea

setCurrentArea(currentArea: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:900
Parameters
- currentArea: string
- Optional targetId: string
Returns void

setCurrentDesk

setCurrentDesk(currentDesk: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:891
Parameters
- currentDesk: string
- Optional targetId: string
Returns void

setEmojiStatus

setEmojiStatus(emojiStatus: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:846
Parameters
- emojiStatus: string
- Optional targetId: string
Returns void

setEmote

setEmote(emote: undefined | string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:793
Parameters
- emote: undefined | string
- Optional targetId: string
Returns void

setEventStatus

setEventStatus(eventStatus: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:873
Parameters
- eventStatus: string
- Optional targetId: string
Returns void

setFocusModeEndTime

setFocusModeEndTime(focusModeEndTime: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:1048
Parameters
- focusModeEndTime: string
- Optional targetId: string
Returns void

setFollowTarget

setFollowTarget(followTarget: string): void

- Defined in gather-game-client/src/Game.ts:1058
Parameters
- followTarget: string
Returns void

setGoKartId

setGoKartId(goKartId: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:1028
Parameters
- goKartId: string
- Optional targetId: string
Returns void

setImpassable

setImpassable(mapId: string, x: number, y: number, impassable?: boolean): void

- Defined in gather-game-client/src/Game.ts:1353
Parameters
- mapId: string
- x: number
- y: number
- impassable: boolean = true
Returns void

setInConversation

setInConversation(inConversation: boolean, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:882
Parameters
- inConversation: boolean
- Optional targetId: string
Returns void

setIsAlone

setIsAlone(isAlone: boolean, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:1038
Parameters
- isAlone: boolean
- Optional targetId: string
Returns void

setIsMobile

setIsMobile(isMobile: boolean): void

- Defined in gather-game-client/src/Game.ts:829
Parameters
- isMobile: boolean
Returns void

setItem

setItem(itemId: string, itemImage: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:928
Parameters
- itemId: string
- itemImage: string
- Optional targetId: string
Returns void

setManualVideoSrc

setManualVideoSrc(manualVideoSrc: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:1456
Parameters
- manualVideoSrc: string
- Optional targetId: string
Returns void

setMapAnnouncer

setMapAnnouncer(mapId: string, announcer: Announcer[]): void

- Defined in gather-game-client/src/Game.ts:1164
Parameters
- mapId: string
- announcer: Announcer[]
Returns void

setMapAreas

setMapAreas(mapId: string, areas: {}): void

- Defined in gather-game-client/src/Game.ts:1292
Parameters
- mapId: string
- areas: {}
  - [areaName: string]: WireArea
Returns void

setMapBackgroundImagePath

setMapBackgroundImagePath(mapId: string, backgroundImagePath: string): void

- Defined in gather-game-client/src/Game.ts:1104
Parameters
- mapId: string
- backgroundImagePath: string
Returns void

setMapCollisions

setMapCollisions(mapId: string, x: number, y: number, w: number, h: number, mask: string): void

- Defined in gather-game-client/src/Game.ts:1090
Parameters
- mapId: string
- x: number
- y: number
- w: number
- h: number
- mask: string
Returns void

setMapDecoration

setMapDecoration(mapId: string, decoration: string): void

- Defined in gather-game-client/src/Game.ts:1332
Parameters
- mapId: string
- decoration: string
Returns void

setMapDescription

setMapDescription(mapId: string, description: string): void

- Defined in gather-game-client/src/Game.ts:1322
Parameters
- mapId: string
- description: string
Returns void

setMapDimensions

setMapDimensions(mapId: string, width: number, height: number): void

- Defined in gather-game-client/src/Game.ts:1079
Parameters
- mapId: string
- width: number
- height: number
Returns void

setMapEnabledChats

setMapEnabledChats(mapId: string, enabledChats: EnabledChat[]): void

- Defined in gather-game-client/src/Game.ts:1312
Parameters
- mapId: string
- enabledChats: EnabledChat[]
Returns void

setMapFloors

setMapFloors(mapId: string, floors: WallFloorBlock[]): void

- Defined in gather-game-client/src/Game.ts:1272
Parameters
- mapId: string
- floors: WallFloorBlock[]
Returns void

setMapForegroundImagePath

setMapForegroundImagePath(mapId: string, foregroundImagePath: string): void

- Defined in gather-game-client/src/Game.ts:1114
Parameters
- mapId: string
- foregroundImagePath: string
Returns void

setMapMiniMapImagePath

setMapMiniMapImagePath(mapId: string, miniMapImagePath: string): void

- Defined in gather-game-client/src/Game.ts:1302
Parameters
- mapId: string
- miniMapImagePath: string
Returns void

setMapMuteOnEntry

setMapMuteOnEntry(mapId: string, muteOnEntry: boolean): void

- Defined in gather-game-client/src/Game.ts:1233
Parameters
- mapId: string
- muteOnEntry: boolean
Returns void

setMapName

setMapName(mapId: string, name: string): void

- Defined in gather-game-client/src/Game.ts:1223
Parameters
- mapId: string
- name: string
Returns void

setMapObjects

setMapObjects(mapId: string, objects: {}, updatesAreOverwrites?: boolean): void

- Defined in gather-game-client/src/Game.ts:1174
Parameters
- mapId: string
- objects: {}
  - [key: number]: Partial<MapObject>
- Optional updatesAreOverwrites: boolean
Returns void

setMapPortals

setMapPortals(mapId: string, portals: Portal[]): void

- Defined in gather-game-client/src/Game.ts:1154
Parameters
- mapId: string
- portals: Portal[]
Returns void

setMapSpaces

setMapSpaces(mapId: string, spaces: Space[]): void

- Defined in gather-game-client/src/Game.ts:1144
Parameters
- mapId: string
- spaces: Space[]
Returns void

setMapSpawns

setMapSpawns(mapId: string, spawns: SpawnPoint[]): void

- Defined in gather-game-client/src/Game.ts:1134
Parameters
- mapId: string
- spawns: SpawnPoint[]
Returns void

setMapSprites

setMapSprites(mapId: string, sprites: number[]): void

- Defined in gather-game-client/src/Game.ts:1124
Parameters
- mapId: string
- sprites: number[]
Returns void

setMapTutorialTasks

setMapTutorialTasks(mapId: string, tutorialTasks: TutorialTasks): void

- Defined in gather-game-client/src/Game.ts:1342
Parameters
- mapId: string
- tutorialTasks: TutorialTasks
Returns void

setMapUseDrawnBG

setMapUseDrawnBG(mapId: string, useDrawnBG: boolean): void

- Defined in gather-game-client/src/Game.ts:1243
Parameters
- mapId: string
- useDrawnBG: boolean
Returns void

setMapWalls

setMapWalls(mapId: string, walls: WallFloorBlock[]): void

- Defined in gather-game-client/src/Game.ts:1253
Parameters
- mapId: string
- walls: WallFloorBlock[]
Returns void

setName

setName(name: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:820
Parameters
- name: string
- Optional targetId: string
Returns void

setObject

setObject(mapId: string, objId: string, obj: Partial<MapObject>, useTxnId?: boolean): void | Promise<unknown>

- Defined in gather-game-client/src/Game.ts:1379
Parameters
- mapId: string
- objId: string
- obj: Partial<MapObject>
- useTxnId: boolean = false
Returns void | Promise<unknown>

setOpenToConversation

setOpenToConversation(openToConversation: boolean, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:802
Parameters
- openToConversation: boolean
- Optional targetId: string
Returns void

setOutfitString

setOutfitString(outfitString: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:909
Parameters
- outfitString: string
- Optional targetId: string
Returns void

setSpotlight

setSpotlight(user: string, spotlighted: boolean): void

- Defined in gather-game-client/src/Game.ts:953
Parameters
- user: string
- spotlighted: boolean
Returns void

setStatus

setStatus(status: boolean, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:864
Parameters
- status: boolean
- Optional targetId: string
Returns void

setSubtitle

setSubtitle(subtitle: string, targetId?: string): Promise<void>

- Defined in gather-game-client/src/Game.ts:1466
Parameters
- subtitle: string
- Optional targetId: string
Returns Promise<void>

setTextStatus

setTextStatus(textStatus: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:837
Parameters
- textStatus: string
- Optional targetId: string
Returns void

setWorkCondition

setWorkCondition(workCondition: boolean, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:811
Parameters
- workCondition: boolean
- Optional targetId: string
Returns void

shootConfetti

shootConfetti(targetId?: string): void

- Defined in gather-game-client/src/Game.ts:1020
Parameters
- Optional targetId: string
Returns void

spawn

spawn(spawnToken: string): void

- Defined in gather-game-client/src/Game.ts:654
Parameters
- spawnToken: string
Returns void

subscribeToAll

subscribeToAll(): void

- Defined in gather-game-client/src/Game.ts:1501
Returns void

subscribeToConnection

subscribeToConnection(callback: (connected: boolean) => void): () => void

- Defined in gather-game-client/src/Game.ts:622
Parameters
- callback: (connected: boolean) => void
  - - (connected: boolean): void
    - Parameters
      - connected: boolean
      Returns void
Returns () => void
- - (): void
  - Returns void

subscribeToDisconnection

subscribeToDisconnection(callback: (code?: number, reason?: string) => void): () => void

- Defined in gather-game-client/src/Game.ts:629
Parameters
- callback: (code?: number, reason?: string) => void
  - - (code?: number, reason?: string): void
    - Parameters
      - Optional code: number
      - Optional reason: string
      Returns void
Returns () => void
- - (): void
  - Returns void

subscribeToEvent

subscribeToEvent<T>(eventId: T, handler: (data: ServerClientEventByCase<T>, context: ServerClientEventContext) => void): () => void

- Defined in gather-game-client/src/Game.ts:575
Type parameters
- T: "info" | "warn" | "error" | "ready" | "serverHeartbeat" | "transactionStatus" | "playerMoves" | "playerSetsStatus" | "playerSpotlights" | "playerRings" | "playerChats" | "playerInteracts" | "playerGhosts" | "playerEntersWhisper" | "playerLeavesWhisper" | "playerActivelySpeaks" | "playerSetsWorkCondition" | "playerSetsName" | "playerSetsTextStatus" | "playerSetsEmojiStatus" | "playerSetsAffiliation" | "playerExits" | "respawnComplete" | "playerSetsOutfitString" | "playerSetsIsSignedIn" | "spaceOverwrites" | "spaceIsClosed" | "playerEntersPortal" | "spaceSetsIdMapping" | "playerSetsLastActive" | "playerShootsConfetti" | "playerSetsEventStatus" | "playerSetsInConversation" | "playerSetsCurrentDesk" | "playerSetsCurrentArea" | "playerSetsImagePointer" | "cookieFound" | "playerEntersWhisperV2" | "playerSetsGoKartId" | "mapSetDimensions" | "mapSetCollisions" | "mapSetBackgroundImagePath" | "mapSetForegroundImagePath" | "mapSetSprites" | "mapSetSpaces" | "mapSetSpawns" | "mapSetPortals" | "mapSetAnnouncer" | "mapSetAssets" | "mapSetObjects" | "mapSetName" | "mapSetMuteOnEntry" | "mapSetUseDrawnBG" | "mapSetWalls" | "mapSetFloors" | "mapSetAreas" | "mapDeleteObject" | "mapSetSpawn" | "playerSetsIsAlone" | "playerJoins" | "mapSetEnabledChats" | "mapSetDescription" | "mapSetDecoration" | "mapSetTutorialTasks" | "mapSetMiniMapImagePath" | "spacePlaysSound" | "mapSetScript" | "mapSetDesks" | "playerSetsIsMobile" | "setScreenPointerServer" | "playerSetsEmoteV2" | "playerSetsFocusModeEndTime" | "spaceSetsSpaceMembers" | "customEvent" | "playerSetsOpenToConversation" | "playerBlocks" | "playerUpdatesFocusModeStatus" | "playerNotifies" | "playerSetsItemString" | "playerTriggersItem" | "playerSetsFollowTarget" | "playerRequestsToLead" | "playerSetsManualVideoSrc" | "playerSetsIsNpc" | "playerSetsSubtitle" | "mapCommitsChanges" | "playerUpdatesSession" | "mapMoveObject" | "playerEditsChatMessage"
Parameters
- eventId: T
- handler: (data: ServerClientEventByCase<T>, context: ServerClientEventContext) => void
  - - (data: ServerClientEventByCase<T>, context: ServerClientEventContext): void
    - Parameters
      - data: ServerClientEventByCase<T>
      - context: ServerClientEventContext
      Returns void
Returns () => void
- - (): void
  - Returns void

subscribeToSpace

subscribeToSpace(space: string, listeners: Readonly<{ onMap: any }>): () => void

- Defined in gather-game-client/src/Game.ts:604
Parameters
- space: string
- listeners: Readonly<{ onMap: any }>
Returns () => void
- - (): void
  - Returns void

Private subscriptionFailedCallback

subscriptionFailedCallback(reason: string): void

- Defined in gather-game-client/src/Game.ts:94
Parameters
- reason: string
Returns void

Private subscriptionFinishedCallback

subscriptionFinishedCallback(): void

- Defined in gather-game-client/src/Game.ts:91
Returns void

teleport

teleport(mapId: string, x: number, y: number, targetId?: string, direction?: SpriteDirectionEnum_ENUM): void

- Defined in gather-game-client/src/Game.ts:730
Parameters
- mapId: string
- x: number
- y: number
- Optional targetId: string
- direction: SpriteDirectionEnum_ENUM = ...
Returns void

triggerItem

triggerItem(closestObject?: string, closestObjectTemplate?: string, targetId?: string): void

- Defined in gather-game-client/src/Game.ts:943
Parameters
- Optional closestObject: string
- Optional closestObjectTemplate: string
- Optional targetId: string
Returns void

waitForInit

waitForInit(): Promise<void>

- Defined in gather-game-client/src/Game.ts:509
Returns Promise<void>

a Promise that resolves when initialization is finished. Rejects if you attempt to wait before init-ing.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

spaceId: undefined | string

getAuth: () => Promise<EngineAuth>

Returns Promise<EngineAuth>

Optional onInput: (dir: MoveDirectionEnum_ENUM, stopped: boolean, inputId: number) => void

Parameters

dir: MoveDirectionEnum_ENUM

stopped: boolean

inputId: number

Returns void

Optional dispatchGameUpdate: (delta: PartialGameState<Player>) => void

Parameters

delta: PartialGameState<Player>

Returns void

Optional dispatchMapUpdate: (mapId: string, map: Readonly<GameMapV2>) => void

Parameters

mapId: string

map: Readonly<GameMapV2>

Returns void

Optional options: GameOptions

Returns Game

Properties

Private _connectCalledAt

Private _connectedAtMs

Private _encIdMapping

Type declaration

[encId: number]: string

Private _initializedAtMs

Private _onMapCounts

Type declaration

[mapId: string]: number

Private _timeToConnect

completeMaps

Type declaration

[id: string]: GameMapV2

connected

Optional debugOverrideServer

Private disconnectHandlers

Type declaration

[uuid: string]: (code?: number, reason?: string) => void

Parameters

Optional code: number

Optional reason: string

Returns void

Optional dispatchGameUpdate

Type declaration

Parameters

delta: PartialGameState<Player>

Returns void

Optional dispatchMapUpdate

Type declaration

Parameters

mapId: string

map: Readonly<GameMapV2>

Returns void

engine

Private eventSubscriptions

Type declaration

getAuth

Type declaration

Returns Promise<EngineAuth>

Private hasSentMapSinceConnect

inputId

lastMapUpdateIds

Type declaration

[id: string]: number

legacySubscriptions

Type declaration

[uuid: string]: GameSpaceSubscription

legacySubscriptionsConnection

Type declaration

[uuid: string]: (connected: boolean) => void

Parameters