Class Player

Hierarchy (view full)

EventEmitter<MyPlayerEvents>
- Player
  - MyPlayer

Index

Constructors

constructor

new Player(playerState?, fields, coreSdk): Player
Parameters
- playerState: Partial<PlayerState> = {}
- fields: ModelField[]
- coreSdk: CoreSDK
Returns Player
Overrides EventEmitter.constructor
- Defined in core/player/Player.ts:62

Properties

`Private` #fieldsMap

#fieldsMap: Record<string, ModelField> = {}

`Private` #limitsFields

#limitsFields: ModelField[] = []

`Private` _events

_events: EventLite = ...

_wasReset

_wasReset: boolean = false

`Private` coreSdk

coreSdk: CoreSDK

credentials

credentials: string = ''

fields

fields: ModelField[]

isPublicFieldsDirty

isPublicFieldsDirty: boolean = false

modifiedAt

modifiedAt: string = ''

saveFormat

saveFormat: ProgressSaveFormat = ...

`Private` state

state: PlayerState

updateTime

updateTime: number

Accessors

avatar

get avatar(): string
Returns string
- Defined in core/player/Player.ts:86
set avatar(value): void
Parameters
- value: string
Returns void
- Defined in core/player/Player.ts:89

id

get id(): number
Returns number
- Defined in core/player/Player.ts:68

isStub

get isStub(): boolean
Returns boolean
- Defined in core/player/Player.ts:93

name

get name(): string
Returns string
- Defined in core/player/Player.ts:79
set name(value): void
Parameters
- value: string
Returns void
- Defined in core/player/Player.ts:82

score

get score(): number
Returns number
- Defined in core/player/Player.ts:72
set score(value): void
Parameters
- value: number
Returns void
- Defined in core/player/Player.ts:75

Methods

`Private` #setFields

#setFields(fields): void
Parameters
- fields: ModelField[]
Returns void
- Defined in core/player/Player.ts:338

`Private` _convert

_convert(key, value): string | number | boolean
Private
Parameters
- key: string
- value: string | number | boolean
Returns string | number | boolean
- Defined in core/player/Player.ts:283

`Private` _incrementField

_incrementField(field): void
Parameters
- field: ModelField
Returns void
- Defined in core/player/Player.ts:310

`Private` _initializeIncrementFields

_initializeIncrementFields(): void
Returns void
- Defined in core/player/Player.ts:302

_syncIncrementVariable

_syncIncrementVariable(): void
Returns void
- Defined in core/player/Player.ts:334

add

add(key, value): void
Parameters
- key: string
- value: string | number | boolean
Returns void
- Defined in core/player/Player.ts:258

fromJSON

fromJSON(state): void
Parameters
- state: Partial<PlayerState>
Returns void
- Defined in core/player/Player.ts:101

get

get(key): string | number | boolean
Parameters
- key: string
Returns string | number | boolean
- Defined in core/player/Player.ts:195

getField

getField(key): ModelField
Parameters
- key: string
Returns ModelField
- Defined in core/player/Player.ts:158

getFieldName

getFieldName(key): string
Parameters
- key: string
Returns string
- Defined in core/player/Player.ts:169

getFieldVariantName

getFieldVariantName(key, value): string
Parameters
- key: string
- value: string | number
Returns string
- Defined in core/player/Player.ts:173

getMaxValue

getMaxValue(key): string | number | boolean
Parameters
- key: string
Returns string | number | boolean
- Defined in core/player/Player.ts:186

getMinValue

getMinValue(key): string | number | boolean
Parameters
- key: string
Returns string | number | boolean
- Defined in core/player/Player.ts:177

has

has(key): boolean
Parameters
- key: string
Returns boolean
- Defined in core/player/Player.ts:266

off

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

on

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

once

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

remove

remove(): void
Returns void
- Defined in core/player/Player.ts:275

reset

reset(): void
Returns void
- Defined in core/player/Player.ts:270

set

set(key, value): void
Parameters
- key: string
- value: string | number | boolean
Returns void
- Defined in core/player/Player.ts:199

toJSON

toJSON(): PlayerState
Returns PlayerState
- Defined in core/player/Player.ts:149

toggle

toggle(key): void
Parameters
- key: string
Returns void
- Defined in core/player/Player.ts:262