Search
Preparing search index...
The search index is not available
@mixer/interactive-node
Options
All
Public
Public/Protected
All
Inherited
Menu
Globals
IClient
Interface IClient
Hierarchy
EventEmitter
IClient
Implemented by
Client
GameClient
ParticipantClient
Index
Properties
client
Type
state
default
Max
Listeners
Methods
add
Listener
create
Controls
create
Groups
create
Scene
create
Scenes
delete
Controls
delete
Group
delete
Scene
emit
event
Names
execute
get
Max
Listeners
get
Time
give
Input
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
ready
remove
All
Listeners
remove
Listener
set
Max
Listeners
update
Controls
update
Groups
update
Participants
update
Scenes
listener
Count
Properties
client
Type
client
Type
:
ClientType
state
state
:
IState
Static
default
Max
Listeners
default
Max
Listeners
:
number
Methods
add
Listener
add
Listener
(
event
:
string
|
symbol
, listener
:
Function
)
:
this
Parameters
event:
string
|
symbol
listener:
Function
Returns
this
create
Controls
create
Controls
(
controls
:
ISceneData
)
:
Promise
<
IControl
[]
>
Parameters
controls:
ISceneData
Returns
Promise
<
IControl
[]
>
create
Groups
create
Groups
(
groups
:
IGroupDataArray
)
:
Promise
<
IGroupDataArray
>
Parameters
groups:
IGroupDataArray
Returns
Promise
<
IGroupDataArray
>
create
Scene
create
Scene
(
scene
:
ISceneData
)
:
Promise
<
ISceneData
>
Parameters
scene:
ISceneData
Returns
Promise
<
ISceneData
>
create
Scenes
create
Scenes
(
scenes
:
ISceneDataArray
)
:
Promise
<
ISceneDataArray
>
Parameters
scenes:
ISceneDataArray
Returns
Promise
<
ISceneDataArray
>
delete
Controls
delete
Controls
(
controls
:
ISceneControlDeletion
)
:
Promise
<
void
>
Parameters
controls:
ISceneControlDeletion
Returns
Promise
<
void
>
delete
Group
delete
Group
(
data
:
IGroupDeletionParams
)
:
Promise
<
void
>
Parameters
data:
IGroupDeletionParams
Returns
Promise
<
void
>
delete
Scene
delete
Scene
(
data
:
ISceneDeletionParams
)
:
Promise
<
void
>
Parameters
data:
ISceneDeletionParams
Returns
Promise
<
void
>
emit
emit
(
event
:
string
|
symbol
,
...
args
:
any
[]
)
:
boolean
Parameters
event:
string
|
symbol
Rest
...
args:
any
[]
Returns
boolean
event
Names
event
Names
(
)
:
(
string
|
symbol
)
[]
Returns
(
string
|
symbol
)
[]
execute
execute<T>
(
method
:
string
, params
:
T
, discard
:
boolean
)
:
Promise
<
any
>
Type parameters
T
Parameters
method:
string
params:
T
discard:
boolean
Returns
Promise
<
any
>
get
Max
Listeners
get
Max
Listeners
(
)
:
number
Returns
number
get
Time
get
Time
(
)
:
Promise
<
number
>
Returns
Promise
<
number
>
give
Input
give
Input<T>
(
_
:
T
)
:
Promise
<
void
>
Type parameters
T
:
IInput
Parameters
_:
T
Returns
Promise
<
void
>
listener
Count
listener
Count
(
type
:
string
|
symbol
)
:
number
Parameters
type:
string
|
symbol
Returns
number
listeners
listeners
(
event
:
string
|
symbol
)
:
Function
[]
Parameters
event:
string
|
symbol
Returns
Function
[]
on
on
(
event
:
"open"
, listener
:
function
)
:
this
on
(
event
:
"send"
, listener
:
function
)
:
this
on
(
event
:
"message"
, listener
:
function
)
:
this
on
(
event
:
"error"
, listener
:
function
)
:
this
on
(
event
:
"hello"
, listener
:
function
)
:
this
on
(
event
:
string
, listener
:
Function
)
:
this
Parameters
event:
"open"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
"send"
listener:
function
(
payload
:
string
)
:
void
Parameters
payload:
string
Returns
void
Returns
this
Parameters
event:
"message"
listener:
function
(
payload
:
string
)
:
void
Parameters
payload:
string
Returns
void
Returns
this
Parameters
event:
"error"
listener:
function
(
err
:
Base
)
:
void
Parameters
err:
Base
Returns
void
Returns
this
Parameters
event:
"hello"
listener:
function
(
)
:
void
Returns
void
Returns
this
Parameters
event:
string
listener:
Function
Returns
this
once
once
(
event
:
string
|
symbol
, listener
:
Function
)
:
this
Parameters
event:
string
|
symbol
listener:
Function
Returns
this
prepend
Listener
prepend
Listener
(
event
:
string
|
symbol
, listener
:
Function
)
:
this
Parameters
event:
string
|
symbol
listener:
Function
Returns
this
prepend
Once
Listener
prepend
Once
Listener
(
event
:
string
|
symbol
, listener
:
Function
)
:
this
Parameters
event:
string
|
symbol
listener:
Function
Returns
this
ready
ready
(
isReady
:
boolean
)
:
Promise
<
void
>
Parameters
isReady:
boolean
Returns
Promise
<
void
>
remove
All
Listeners
remove
All
Listeners
(
event
?:
string
|
symbol
)
:
this
Parameters
Optional
event:
string
|
symbol
Returns
this
remove
Listener
remove
Listener
(
event
:
string
|
symbol
, listener
:
Function
)
:
this
Parameters
event:
string
|
symbol
listener:
Function
Returns
this
set
Max
Listeners
set
Max
Listeners
(
n
:
number
)
:
this
Parameters
n:
number
Returns
this
update
Controls
update
Controls
(
controls
:
ISceneData
)
:
Promise
<
void
>
Parameters
controls:
ISceneData
Returns
Promise
<
void
>
update
Groups
update
Groups
(
groups
:
IGroupDataArray
)
:
Promise
<
IGroupDataArray
>
Parameters
groups:
IGroupDataArray
Returns
Promise
<
IGroupDataArray
>
update
Participants
update
Participants
(
participants
:
IParticipantArray
)
:
Promise
<
void
>
Parameters
participants:
IParticipantArray
Returns
Promise
<
void
>
update
Scenes
update
Scenes
(
scenes
:
ISceneDataArray
)
:
Promise
<
void
>
Parameters
scenes:
ISceneDataArray
Returns
Promise
<
void
>
Static
listener
Count
listener
Count
(
emitter
:
EventEmitter
, event
:
string
|
symbol
)
:
number
Parameters
emitter:
EventEmitter
event:
string
|
symbol
Returns
number
Globals
IClient
client
Type
state
default
Max
Listeners
add
Listener
create
Controls
create
Groups
create
Scene
create
Scenes
delete
Controls
delete
Group
delete
Scene
emit
event
Names
execute
get
Max
Listeners
get
Time
give
Input
listener
Count
listeners
on
once
prepend
Listener
prepend
Once
Listener
ready
remove
All
Listeners
remove
Listener
set
Max
Listeners
update
Controls
update
Groups
update
Participants
update
Scenes
listener
Count
Generated using
TypeDoc