Game | @leancloud/client-engine

Hierarchy

EventEmitter
- Game

Index

Constructors

constructor

Properties

Accessors

Constructors

constructor

new Game(room: Room, masterClient: Client): Game

Overrides ILoadBalancerConsumer.constructor
- Defined in src/game.ts:67
Parameters
- room: Room
- masterClient: Client
Returns Game

Properties

Protected customEvent$

customEvent$: Observable<object> = fromEvent<CustomEventPayload>(this.masterClient,Event.CUSTOM_EVENT,)

customEvents Observable

masterClient

masterClient: Client

registeredPlayers

registeredPlayers: Set<string> = new Set<string>()

room

room: Room

Static defaultMaxListeners

defaultMaxListeners: number

Static defaultSeatCount

defaultSeatCount: number = 2

每局游戏房间的默认空位数量。

Static errorMonitor

errorMonitor: keyof symbol

This symbol shall be used to install a listener for only monitoring 'error' events. Listeners installed using this symbol are called before the regular 'error' listeners are called.

Installing a listener using this symbol does not change the behavior once an 'error' event is emitted, therefore the process will still crash if no regular 'error' listener is installed.

Static Optional maxSeatCount

maxSeatCount: undefined | number

每局游戏房间的最大空位数量。

Static Optional minSeatCount

minSeatCount: undefined | number

每局游戏房间的最小空位数量。

Accessors

availableSeatCount

get availableSeatCount(): number

- Defined in src/game.ts:23
Returns number

players

get players(): Player[]

- Defined in src/game.ts:34
不包含 masterClient 的玩家列表。

Returns Player[]

seatCount

get seatCount(): number

- Defined in src/game.ts:43
游戏房间的空位数量

Returns number

Methods

addListener

addListener(event: string | symbol, listener: function): this

Inherited from Game.addListener
- Defined in node_modules/@types/node/events.d.ts:62
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

Protected broadcast

broadcast(eventId: CustomEventId, eventData?: object, options?: object): Promise<void>

- Defined in src/game.ts:114
向玩家广播自定义事件。

Parameters
- eventId: CustomEventId
- Default value eventData: object = {}
  - [key: string]: any
- Default value options: object = {}
  - Optional exclude?: number[]
Returns Promise<void>

cancelReservation

cancelReservation(playerId: string): void

- Defined in src/game.ts:84
Parameters
- playerId: string
Returns void

destroy

destroy(): void

- Defined in src/game.ts:105
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from Game.emit
- Defined in node_modules/@types/node/events.d.ts:72
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

eventNames

eventNames(): Array<string | symbol>

Inherited from Game.eventNames
- Defined in node_modules/@types/node/events.d.ts:77
Returns Array<string | symbol>

Protected forwardToTheRests

forwardToTheRests(originalEvent: CustomEventPayload, transform?: function, eventId?: CustomEventId): Promise<void>

- Defined in src/game.ts:138
向其他玩家转发自定义事件。该方法会在转发后的事件内容中增加 originalSenderId 字段。

Parameters
- originalEvent: CustomEventPayload
  
  原始事件
- Default value transform: function = (data) => data
  
  变形事件内容
  - - (originalEventData: CustomEventData): CustomEventData
    - Parameters
      - originalEventData: CustomEventData
      Returns CustomEventData
- Default value eventId: CustomEventId = originalEvent.eventId
  
  指定新的事件 ID
Returns Promise<void>

getMaxListeners

getMaxListeners(): number

Inherited from Game.getMaxListeners
- Defined in node_modules/@types/node/events.d.ts:69
Returns number

Protected getStream

getStream(eventId?: CustomEventId, player?: Player, timeout?: undefined | number): Observable<object>

- Defined in src/game.ts:163
获取指定的自定义事件，指定 player 发送的事件流。参阅 http://reactivex.io/rxjs 了解更多。

Parameters
- Optional eventId: CustomEventId
- Optional player: Player
- Optional timeout: undefined | number
Returns Observable<object>

listenerCount

listenerCount(event: string | symbol): number

Inherited from Game.listenerCount
- Defined in node_modules/@types/node/events.d.ts:73
Parameters
- event: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from Game.listeners
- Defined in node_modules/@types/node/events.d.ts:70
Parameters
- event: string | symbol
Returns Function[]

makeReservation

makeReservation(playerId: string): void

- Defined in src/game.ts:79
Parameters
- playerId: string
Returns void

off

off(event: string | symbol, listener: function): this

Inherited from Game.off
- Defined in node_modules/@types/node/events.d.ts:66
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: string | symbol, listener: function): this

Inherited from Game.on
- Defined in node_modules/@types/node/events.d.ts:63
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: string | symbol, listener: function): this

Inherited from Game.once
- Defined in node_modules/@types/node/events.d.ts:64
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependListener

prependListener(event: string | symbol, listener: function): this

Inherited from Game.prependListener
- Defined in node_modules/@types/node/events.d.ts:75
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: string | symbol, listener: function): this

Inherited from Game.prependOnceListener
- Defined in node_modules/@types/node/events.d.ts:76
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from Game.rawListeners
- Defined in node_modules/@types/node/events.d.ts:71
Parameters
- event: string | symbol
Returns Function[]

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from Game.removeAllListeners
- Defined in node_modules/@types/node/events.d.ts:67
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: string | symbol, listener: function): this

Inherited from Game.removeListener
- Defined in node_modules/@types/node/events.d.ts:65
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from Game.setMaxListeners
- Defined in node_modules/@types/node/events.d.ts:68
Parameters
- n: number
Returns this

Protected takeFirst

takeFirst(eventId?: CustomEventId, player?: Player, timeout?: undefined | number): Observable<object>

- Defined in src/game.ts:175
获取指定的自定义事件，指定 player 发送的从现在开始算的第一个事件的流。参阅 http://reactivex.io/rxjs 了解更多。

Parameters
- Optional eventId: CustomEventId
- Optional player: Player
- Optional timeout: undefined | number
Returns Observable<object>

terminate

terminate(): Promise<any>

- Defined in src/game.ts:94
当收到服务关闭通知时，游戏的结束逻辑。默认情况下，会等游戏结束或者所有玩家离开房间后认为该局游戏可以下线了。你可以在子类中扩展或覆盖该行为。

Returns Promise<any>

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from Game.listenerCount
- Defined in node_modules/@types/node/events.d.ts:44
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

room: Room

masterClient: Client

Returns Game

Properties

Protected customEvent$

masterClient

registeredPlayers

room

Static defaultMaxListeners

Static defaultSeatCount

Static errorMonitor

Static Optional maxSeatCount

Static Optional minSeatCount

Accessors

availableSeatCount

Returns number

players

Returns Player[]

seatCount

Returns number

Methods

addListener

Parameters

event: string | symbol

listener: function

Parameters

Rest ...args: any[]

Returns void

Returns this

Protected broadcast

Parameters

eventId: CustomEventId

Default value eventData: object = {}

[key: string]: any

Default value options: object = {}

Optional exclude?: number[]

Returns Promise<void>

cancelReservation

Parameters

playerId: string

Returns void

destroy

Returns void

emit

Parameters

event: string | symbol

Rest ...args: any[]

Returns boolean

eventNames

Returns Array<string | symbol>

Protected forwardToTheRests

Parameters

originalEvent: CustomEventPayload

Default value transform: function = (data) => data

Parameters

originalEventData: CustomEventData

Returns CustomEventData

Default value eventId: CustomEventId = originalEvent.eventId

Returns Promise<void>

getMaxListeners

Returns number

Protected getStream

Parameters

Optional eventId: CustomEventId

Optional player: Player

Optional timeout: undefined | number

Returns Observable<object>

listenerCount

Parameters

event: string | symbol

Returns number