SkeldJS
Preparing search index...
@skeldjs/core
VentilationSystem
Class VentilationSystem<RoomType>
Type Parameters
RoomType
extends
StatefulRoom
Hierarchy (
View Summary
)
System
<
RoomType
>
VentilationSystem
Index
Constructors
constructor
Properties
is
Dirty
players
Cleaning
Vents
player
Sequence
Id
players
Inside
Vents
ship
Status
system
Type
Accessors
room
Methods
can
Be
Sabotaged
cancel
Data
Update
create
Data
emit
emit
Serial
emit
Sync
get
Listeners
handle
Data
handle
Update
off
on
once
parse
Data
parse
Update
process
Fixed
Update
push
Data
Update
remove
All
Listeners
remove
Listeners
send
Update
System
wait
waitf
Constructors
constructor
new
VentilationSystem
<
RoomType
extends
StatefulRoom
<
StatefulRoom
<
any
,
{}
>
,
{}
>
>
(
shipStatus
:
ShipStatus
<
RoomType
>
,
systemType
:
SystemType
,
)
:
VentilationSystem
<
RoomType
>
Type Parameters
RoomType
extends
StatefulRoom
<
StatefulRoom
<
any
,
{}
>
,
{}
>
Parameters
shipStatus
:
ShipStatus
<
RoomType
>
systemType
:
SystemType
Returns
VentilationSystem
<
RoomType
>
Properties
is
Dirty
isDirty
:
boolean
= false
players
Cleaning
Vents
playersCleaningVents
:
Map
<
Player
<
RoomType
>
,
number
>
= ...
player
Sequence
Id
playerSequenceId
:
Map
<
Player
<
RoomType
>
,
number
>
= ...
players
Inside
Vents
playersInsideVents
:
Map
<
Player
<
RoomType
>
,
number
>
= ...
Readonly
ship
Status
shipStatus
:
ShipStatus
<
RoomType
>
Readonly
system
Type
systemType
:
SystemType
Accessors
room
get
room
()
:
RoomType
Return the room that this system belongs to.
Returns
RoomType
Methods
can
Be
Sabotaged
canBeSabotaged
()
:
this
is
SabotagableSystem
<
RoomType
,
{}
>
Returns
this
is
SabotagableSystem
<
RoomType
,
{}
>
cancel
Data
Update
cancelDataUpdate
()
:
void
Returns
void
create
Data
createData
(
dataState
:
DataState
)
:
undefined
|
BaseSystemMessage
Parameters
dataState
:
DataState
Returns
undefined
|
BaseSystemMessage
emit
emit
<
Event
extends
BasicEvent
>
(
event
:
Event
)
:
Promise
<
Event
>
Type Parameters
Event
extends
BasicEvent
Parameters
event
:
Event
Returns
Promise
<
Event
>
emit
Serial
emitSerial
<
Event
extends
BasicEvent
>
(
event
:
Event
)
:
Promise
<
Event
>
Type Parameters
Event
extends
BasicEvent
Parameters
event
:
Event
Returns
Promise
<
Event
>
emit
Sync
emitSync
<
Event
extends
BasicEvent
>
(
event
:
Event
)
:
Event
Type Parameters
Event
extends
BasicEvent
Parameters
event
:
Event
Returns
Event
get
Listeners
getListeners
<
Event
extends
BasicEvent
=
BasicEvent
>
(
event
:
string
,
)
:
Listener
<
Event
>
[]
Type Parameters
Event
extends
BasicEvent
=
BasicEvent
Parameters
event
:
string
Returns
Listener
<
Event
>
[]
handle
Data
handleData
(
data
:
BaseSystemMessage
)
:
Promise
<
void
>
Parameters
data
:
BaseSystemMessage
Returns
Promise
<
void
>
handle
Update
handleUpdate
(
player
:
Player
<
RoomType
>
,
message
:
BaseSystemMessage
,
)
:
Promise
<
void
>
Parameters
player
:
Player
<
RoomType
>
message
:
BaseSystemMessage
Returns
Promise
<
void
>
off
off
<
EventName
extends
never
>
(
event
:
EventName
,
listener
:
Listener
<
SystemEvents
<
RoomType
>
[
EventName
]
>
,
)
:
void
Type Parameters
EventName
extends
never
Parameters
event
:
EventName
listener
:
Listener
<
SystemEvents
<
RoomType
>
[
EventName
]
>
Returns
void
off
<
K
extends
BasicEvent
>
(
event
:
string
,
listener
:
Listener
<
K
>
)
:
void
Type Parameters
K
extends
BasicEvent
Parameters
event
:
string
listener
:
Listener
<
K
>
Returns
void
on
on
<
EventName
extends
never
>
(
event
:
EventName
,
listener
:
Listener
<
SystemEvents
<
RoomType
>
[
EventName
]
>
,
)
:
()
=>
void
Type Parameters
EventName
extends
never
Parameters
event
:
EventName
listener
:
Listener
<
SystemEvents
<
RoomType
>
[
EventName
]
>
Returns
()
=>
void
on
<
K
extends
BasicEvent
>
(
event
:
string
,
listener
:
Listener
<
K
>
)
:
()
=>
void
Type Parameters
K
extends
BasicEvent
Parameters
event
:
string
listener
:
Listener
<
K
>
Returns
()
=>
void
once
once
<
EventName
extends
never
>
(
event
:
EventName
,
listener
:
Listener
<
SystemEvents
<
RoomType
>
[
EventName
]
>
,
)
:
()
=>
void
Type Parameters
EventName
extends
never
Parameters
event
:
EventName
listener
:
Listener
<
SystemEvents
<
RoomType
>
[
EventName
]
>
Returns
()
=>
void
once
<
K
extends
BasicEvent
>
(
event
:
string
,
listener
:
Listener
<
K
>
)
:
()
=>
void
Type Parameters
K
extends
BasicEvent
Parameters
event
:
string
listener
:
Listener
<
K
>
Returns
()
=>
void
parse
Data
parseData
(
dataState
:
DataState
,
reader
:
HazelReader
,
)
:
undefined
|
BaseSystemMessage
Parameters
dataState
:
DataState
reader
:
HazelReader
Returns
undefined
|
BaseSystemMessage
parse
Update
parseUpdate
(
reader
:
HazelReader
)
:
undefined
|
BaseSystemMessage
Parameters
reader
:
HazelReader
Returns
undefined
|
BaseSystemMessage
process
Fixed
Update
processFixedUpdate
(
deltaSeconds
:
number
)
:
Promise
<
void
>
Parameters
deltaSeconds
:
number
Returns
Promise
<
void
>
push
Data
Update
pushDataUpdate
()
:
void
Returns
void
remove
All
Listeners
removeAllListeners
()
:
void
Returns
void
remove
Listeners
removeListeners
(
event
:
string
)
:
void
Parameters
event
:
string
Returns
void
send
Update
System
sendUpdateSystem
(
message
:
BaseSystemMessage
)
:
Promise
<
void
>
Parameters
message
:
BaseSystemMessage
Returns
Promise
<
void
>
wait
wait
<
EventName
extends
never
>
(
event
:
EventName
,
)
:
Promise
<
SystemEvents
<
RoomType
>
[
EventName
]
>
Type Parameters
EventName
extends
never
Parameters
event
:
EventName
Returns
Promise
<
SystemEvents
<
RoomType
>
[
EventName
]
>
wait
(
event
:
string
)
:
Promise
<
BasicEvent
>
Parameters
event
:
string
Returns
Promise
<
BasicEvent
>
waitf
waitf
<
EventName
extends
never
>
(
event
:
EventName
,
filter
:
(
ev
:
SystemEvents
<
RoomType
>
[
EventName
]
,
)
=>
boolean
|
Promise
<
boolean
>
,
)
:
Promise
<
SystemEvents
<
RoomType
>
[
EventName
]
>
Type Parameters
EventName
extends
never
Parameters
event
:
EventName
filter
:
(
ev
:
SystemEvents
<
RoomType
>
[
EventName
]
)
=>
boolean
|
Promise
<
boolean
>
Returns
Promise
<
SystemEvents
<
RoomType
>
[
EventName
]
>
waitf
<
K
extends
BasicEvent
>
(
event
:
string
,
filter
:
(
ev
:
K
)
=>
boolean
|
Promise
<
boolean
>
,
)
:
Promise
<
BasicEvent
>
Type Parameters
K
extends
BasicEvent
Parameters
event
:
string
filter
:
(
ev
:
K
)
=>
boolean
|
Promise
<
boolean
>
Returns
Promise
<
BasicEvent
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
is
Dirty
players
Cleaning
Vents
player
Sequence
Id
players
Inside
Vents
ship
Status
system
Type
Accessors
room
Methods
can
Be
Sabotaged
cancel
Data
Update
create
Data
emit
emit
Serial
emit
Sync
get
Listeners
handle
Data
handle
Update
off
on
once
parse
Data
parse
Update
process
Fixed
Update
push
Data
Update
remove
All
Listeners
remove
Listeners
send
Update
System
wait
waitf
SkeldJS
Loading...
Return the room that this system belongs to.