Search
Preparing search index...
The search index is not available
game-score-sdk
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
game-score-sdk
Player
Class Player
Hierarchy
EventEmitter
<
MyPlayerEvents
>
Player
MyPlayer
Index
Constructors
constructor
Properties
_events
credentials
fields
state
Accessors
avatar
id
is
Stub
name
score
Methods
_convert
add
fromJSON
get
get
Field
get
Field
Name
get
Field
Variant
Name
has
off
on
once
remove
reset
set
toJSON
toggle
Constructors
constructor
new
Player
(
playerState
?:
Partial
<
PlayerState
>
, fields
:
ModelField
[]
)
:
Player
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
Returns
string
Parameters
value:
string
Returns
void
id
get
id
(
)
:
number
Returns
number
is
Stub
get
isStub
(
)
:
boolean
Returns
boolean
name
get
name
(
)
:
string
set
name
(
value
:
string
)
:
void
Returns
string
Parameters
value:
string
Returns
void
score
get
score
(
)
:
number
set
score
(
value
:
number
)
:
void
Returns
number
Parameters
value:
number
Returns
void
Methods
Private
_convert
_convert
(
key
:
string
, value
:
string
|
number
|
boolean
)
:
string
|
number
|
boolean
Parameters
key:
string
value:
string
|
number
|
boolean
Returns
string
|
number
|
boolean
add
add
(
key
:
string
, value
:
string
|
number
|
boolean
)
:
void
Parameters
key:
string
value:
string
|
number
|
boolean
Returns
void
fromJSON
fromJSON
(
state
:
Partial
<
PlayerState
>
)
:
void
Parameters
state:
Partial
<
PlayerState
>
Returns
void
get
get
(
key
:
string
)
:
string
|
number
|
boolean
Parameters
key:
string
Returns
string
|
number
|
boolean
get
Field
get
Field
(
key
:
string
)
:
ModelField
Parameters
key:
string
Returns
ModelField
get
Field
Name
get
Field
Name
(
key
:
string
)
:
string
Parameters
key:
string
Returns
string
get
Field
Variant
Name
get
Field
Variant
Name
(
key
:
string
, value
:
string
|
number
)
:
string
Parameters
key:
string
value:
string
|
number
Returns
string
has
has
(
key
:
string
)
:
boolean
Parameters
key:
string
Returns
boolean
off
off
<
ET
>
(
type
:
ET
, handler
:
(
(
event
:
MyPlayerEvents
[
ET
]
)
=>
void
)
)
:
void
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
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
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
Returns
void
reset
reset
(
)
:
void
Returns
void
set
set
(
key
:
string
, value
:
string
|
number
|
boolean
)
:
void
Parameters
key:
string
value:
string
|
number
|
boolean
Returns
void
toJSON
toJSON
(
)
:
PlayerState
Returns
PlayerState
toggle
toggle
(
key
:
string
)
:
void
Parameters
key:
string
Returns
void
Exports
Player
constructor
_events
credentials
fields
state
avatar
id
is
Stub
name
score
_convert
add
fromJSON
get
get
Field
get
Field
Name
get
Field
Variant
Name
has
off
on
once
remove
reset
set
toJSON
toggle
Generated using
TypeDoc