Class Player

Hierarchy

EventEmitter<MyPlayerEvents>
- Player
  - MyPlayer

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new Player(playerState?: Partial<PlayerState>, fields: ModelField[]): Player

Overrides EventEmitter.constructor
- Defined in core/player/Player.ts:43
Parameters
- playerState: Partial<PlayerState> = {}
- fields: ModelField[]
Returns Player

Properties

Private _events

_events: EventLite = ...

credentials

credentials: string = ''

fields

fields: ModelField[]

Private state

state: PlayerState

Accessors

avatar

get avatar(): string
set avatar(value: string): void

- Defined in core/player/Player.ts:67
Returns string
- Defined in core/player/Player.ts:70
Parameters
- value: string
Returns void

id

get id(): number

- Defined in core/player/Player.ts:49
Returns number

isStub

get isStub(): boolean

- Defined in core/player/Player.ts:74
Returns boolean

name

get name(): string
set name(value: string): void

- Defined in core/player/Player.ts:60
Returns string
- Defined in core/player/Player.ts:63
Parameters
- value: string
Returns void

score

get score(): number
set score(value: number): void

- Defined in core/player/Player.ts:53
Returns number
- Defined in core/player/Player.ts:56
Parameters
- value: number
Returns void

Methods

add

add(key: string, value: string | number | boolean): void

- Defined in core/player/Player.ts:165
Parameters
- key: string
- value: string | number | boolean
Returns void

fromJSON

fromJSON(state: Partial<PlayerState>): void

- Defined in core/player/Player.ts:82
Parameters
- state: Partial<PlayerState>
Returns void

get

get(key: string): string | number | boolean

- Defined in core/player/Player.ts:141
Parameters
- key: string
Returns string | number | boolean

getField

getField(key: string): ModelField

- Defined in core/player/Player.ts:122
Parameters
- key: string
Returns ModelField

getFieldName

getFieldName(key: string): string

- Defined in core/player/Player.ts:133
Parameters
- key: string
Returns string

getFieldVariantName

getFieldVariantName(key: string, value: string | number): string

- Defined in core/player/Player.ts:137
Parameters
- key: string
- value: string | number
Returns string

has

has(key: string): boolean

- Defined in core/player/Player.ts:173
Parameters
- key: string
Returns boolean

off

off<ET>(type: ET, handler: ((event: MyPlayerEvents[ET]) => void)): void

Inherited from EventEmitter.off
- Defined in core/events/EventEmitter.ts:12
Type Parameters
- ET extends keyof MyPlayerEvents
Parameters
- type: ET
- handler: ((event: MyPlayerEvents[ET]) => void)
  - - (event: MyPlayerEvents[ET]): void
    - Parameters
      - event: MyPlayerEvents[ET]
      Returns void
Returns void

on

on<ET>(type: ET, handler: ((event: MyPlayerEvents[ET]) => void)): void

Inherited from EventEmitter.on
- Defined in core/events/EventEmitter.ts:9
Type Parameters
- ET extends keyof MyPlayerEvents
Parameters
- type: ET
- handler: ((event: MyPlayerEvents[ET]) => void)
  - - (event: MyPlayerEvents[ET]): void
    - Parameters
      - event: MyPlayerEvents[ET]
      Returns void
Returns void

once

once<ET>(type: ET, handler: ((event: MyPlayerEvents[ET]) => void)): void

Inherited from EventEmitter.once
- Defined in core/events/EventEmitter.ts:15
Type Parameters
- ET extends keyof MyPlayerEvents
Parameters
- type: ET
- handler: ((event: MyPlayerEvents[ET]) => void)
  - - (event: MyPlayerEvents[ET]): void
    - Parameters
      - event: MyPlayerEvents[ET]
      Returns void
Returns void

remove

remove(): void

- Defined in core/player/Player.ts:181
Returns void

reset

reset(): void

- Defined in core/player/Player.ts:177
Returns void

set

set(key: string, value: string | number | boolean): void

- Defined in core/player/Player.ts:145
Parameters
- key: string
- value: string | number | boolean
Returns void

toJSON

toJSON(): PlayerState

- Defined in core/player/Player.ts:118
Returns PlayerState

toggle

toggle(key: string): void

- Defined in core/player/Player.ts:169
Parameters
- key: string
Returns void

Generated using TypeDoc