Class PlayerControl<RoomType>

Represents a player object for interacting with the game and other players.

See PlayerControlEvents for events to listen to.

Type Parameters

RoomType extends StatefulRoom

Hierarchy (View Summary)

NetworkedObject<RoomType, PlayerControlEvents<RoomType>>
- PlayerControl

Constructors

constructor

new PlayerControl<RoomType extends StatefulRoom<any>>(
    room: RoomType,
    spawnType: SpawnType,
    netId: number,
    ownerId: number,
    flags: number,
): PlayerControl<RoomType>
Type Parameters
- RoomType extends StatefulRoom<any>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerId: number
- flags: number
Returns PlayerControl<RoomType>
Overrides NetworkedObject.constructor
- Defined in packages/core/lib/objects/PlayerControl.ts:180

Properties

components

components: NetworkedObject<RoomType, any>[]

dirtyBit

dirtyBit: number = 0

The dirty state of this component.

flags

flags: number

Flags for this object, see SpawnFlag.

`Optional`guardianProtector

guardianProtector?: Player<RoomType>

The player (i.e. a guardian angel) who has protected this player, if the player is being protected..

isNew

isNew: boolean

Whether the player was just spawned, or was spawned before joining.

netId

netId: number

The net ID of this component.

ownerId

ownerId: number

The ID of the owner of this component.

player

player: Player<RoomType>

The player that this component belongs to.

playerId

playerId: number

The player ID of the player.

protectedByGuardian

protectedByGuardian: boolean

Whether or not this player has been protected bya guardian angel.

room

room: RoomType

The room that this component belongs to.

`Optional`shapeshiftTarget

shapeshiftTarget?: Player<RoomType>

The player that this player has shapeshifted as, if any.

spawnType

spawnType: SpawnType

The type of object that this component belongs to.

Accessors

owner

get owner(): undefined | StatefulRoom<any> | Player<RoomType>
Returns undefined | StatefulRoom<any> | Player<RoomType>
Inherited from NetworkedObject.owner
- Defined in packages/core/lib/NetworkedObject.ts:69

Methods

canMurder

canMurder(victim: PlayerControl<RoomType>): boolean
Parameters
- victim: PlayerControl<RoomType>
Returns boolean
- Defined in packages/core/lib/objects/PlayerControl.ts:1882

causeToDie

causeToDie(reason: string): Promise<void>
Parameters
- reason: string
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:737

checkColor

checkColor(color: Color): Promise<void>
Request for the host to check a color for this player and change it if it's taken.
Parameters
- color: Color
  The color to request.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:630

checkName

checkName(name: string): Promise<void>
Request for the host to check a name for this player and append numbers if it's taken.
Parameters
- name: string
  The name to request.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:511

completeTask

completeTask(taskIdx: number): void
Mark one of this player's tasks as completed.
Parameters
- taskIdx: number
  The index of the task to complete. Note: this is not the task ID but instead the index of the player's task, as in its position in the PlayerInfo.taskStates array.
  
  Emits a player.completetask event.
Returns void
Example
```
client.me.control.completeTask(0);
```
- Defined in packages/core/lib/objects/PlayerControl.ts:377

deserializeFromReader

deserializeFromReader(reader: HazelReader, spawn?: boolean): void
Parameters
- reader: HazelReader
- spawn: boolean = false
Returns void
Overrides NetworkedObject.deserializeFromReader
- Defined in packages/core/lib/objects/PlayerControl.ts:219

Destroy

Destroy(): void
Returns void
Inherited from NetworkedObject.Destroy
- Defined in packages/core/lib/NetworkedObject.ts:136

emit

emit<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Inherited from NetworkedObject.emit
- Defined in packages/core/lib/NetworkedObject.ts:101

emitSerial

emitSerial<Event extends BasicEvent>(event: Event): Promise<Event>
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Promise<Event>
Inherited from NetworkedObject.emitSerial
- Defined in packages/core/lib/NetworkedObject.ts:111

emitSync

emitSync<Event extends BasicEvent>(event: Event): Event
Type Parameters
- Event extends BasicEvent
Parameters
- event: Event
Returns Event
Inherited from NetworkedObject.emitSync
- Defined in packages/core/lib/NetworkedObject.ts:121

getComponentSafe

getComponentSafe<T>(
index: number,
ComponentType: NetworkedObjectConstructor<T>,
): undefined | T
Get a certain component from the object.
Type Parameters
- T
Parameters
- index: number
- ComponentType: NetworkedObjectConstructor<T>
  The component class to get.
Returns undefined | T
Inherited from NetworkedObject.getComponentSafe
- Defined in packages/core/lib/NetworkedObject.ts:142

getListeners

getListeners<Event extends BasicEvent = BasicEvent>(
event: string,
): Listener<Event>[]
Type Parameters
- Event extends BasicEvent = BasicEvent
Parameters
- event: string
Returns Listener<Event>[]
Inherited from NetworkedObject.getListeners
- Defined in packages/events/lib/EventEmitter.ts:150

getPlayerInfo

getPlayerInfo(): undefined | NetworkedPlayerInfo<RoomType>
Returns undefined | NetworkedPlayerInfo<RoomType>
- Defined in packages/core/lib/objects/PlayerControl.ts:215

handleRemoteCall

handleRemoteCall(rpc: BaseRpcMessage): Promise<void>
Parameters
- rpc: BaseRpcMessage
Returns Promise<void>
Overrides NetworkedObject.handleRemoteCall
- Defined in packages/core/lib/objects/PlayerControl.ts:247

killPlayer

killPlayer(victim: Player<RoomType>): Promise<void>
Parameters
- victim: Player<RoomType>
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:798

off

off<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.checkcolor"
        | "player.checkmurder"
        | "player.checkname"
        | "player.checkprotect"
        | "player.completetask"
        | "player.die"
        | "player.usemovingplatform"
        | "player.murder"
        | "player.protect"
        | "player.removeprotection"
        | "player.reportbody"
        | "player.revertshapeshift"
        | "player.chat"
        | "player.quickchat"
        | "player.setcolor"
        | "player.sethat"
        | "player.setlevel"
        | "player.setname"
        | "player.setnameplate"
        | "player.setpet"
        | "player.setrole"
        | "player.setskin"
        | "player.setstartcounter"
        | "player.setvisor"
        | "player.shapeshift"
        | "player.startmeeting"
        | "player.syncsettings",
>(
    event: EventName,
    listener: Listener<PlayerControlEvents<RoomType>[EventName]>,
): void
Type Parameters
- EventName extends
      | "component.spawn"
      | "component.despawn"
      | "player.checkcolor"
      | "player.checkmurder"
      | "player.checkname"
      | "player.checkprotect"
      | "player.completetask"
      | "player.die"
      | "player.usemovingplatform"
      | "player.murder"
      | "player.protect"
      | "player.removeprotection"
      | "player.reportbody"
      | "player.revertshapeshift"
      | "player.chat"
      | "player.quickchat"
      | "player.setcolor"
      | "player.sethat"
      | "player.setlevel"
      | "player.setname"
      | "player.setnameplate"
      | "player.setpet"
      | "player.setrole"
      | "player.setskin"
      | "player.setstartcounter"
      | "player.setvisor"
      | "player.shapeshift"
      | "player.startmeeting"
      | "player.syncsettings"
Parameters
- event: EventName
- listener: Listener<PlayerControlEvents<RoomType>[EventName]>
Returns void
Inherited from NetworkedObject.off
- Defined in packages/events/lib/EventEmitter.ts:137
off<K extends BasicEvent>(event: string, listener: Listener<K>): void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns void
Inherited from NetworkedObject.off
- Defined in packages/events/lib/EventEmitter.ts:141

on

on<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.checkcolor"
        | "player.checkmurder"
        | "player.checkname"
        | "player.checkprotect"
        | "player.completetask"
        | "player.die"
        | "player.usemovingplatform"
        | "player.murder"
        | "player.protect"
        | "player.removeprotection"
        | "player.reportbody"
        | "player.revertshapeshift"
        | "player.chat"
        | "player.quickchat"
        | "player.setcolor"
        | "player.sethat"
        | "player.setlevel"
        | "player.setname"
        | "player.setnameplate"
        | "player.setpet"
        | "player.setrole"
        | "player.setskin"
        | "player.setstartcounter"
        | "player.setvisor"
        | "player.shapeshift"
        | "player.startmeeting"
        | "player.syncsettings",
>(
    event: EventName,
    listener: Listener<PlayerControlEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "component.spawn"
      | "component.despawn"
      | "player.checkcolor"
      | "player.checkmurder"
      | "player.checkname"
      | "player.checkprotect"
      | "player.completetask"
      | "player.die"
      | "player.usemovingplatform"
      | "player.murder"
      | "player.protect"
      | "player.removeprotection"
      | "player.reportbody"
      | "player.revertshapeshift"
      | "player.chat"
      | "player.quickchat"
      | "player.setcolor"
      | "player.sethat"
      | "player.setlevel"
      | "player.setname"
      | "player.setnameplate"
      | "player.setpet"
      | "player.setrole"
      | "player.setskin"
      | "player.setstartcounter"
      | "player.setvisor"
      | "player.shapeshift"
      | "player.startmeeting"
      | "player.syncsettings"
Parameters
- event: EventName
- listener: Listener<PlayerControlEvents<RoomType>[EventName]>
Returns () => void
Inherited from NetworkedObject.on
- Defined in packages/events/lib/EventEmitter.ts:86
on<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from NetworkedObject.on
- Defined in packages/events/lib/EventEmitter.ts:90

once

once<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.checkcolor"
        | "player.checkmurder"
        | "player.checkname"
        | "player.checkprotect"
        | "player.completetask"
        | "player.die"
        | "player.usemovingplatform"
        | "player.murder"
        | "player.protect"
        | "player.removeprotection"
        | "player.reportbody"
        | "player.revertshapeshift"
        | "player.chat"
        | "player.quickchat"
        | "player.setcolor"
        | "player.sethat"
        | "player.setlevel"
        | "player.setname"
        | "player.setnameplate"
        | "player.setpet"
        | "player.setrole"
        | "player.setskin"
        | "player.setstartcounter"
        | "player.setvisor"
        | "player.shapeshift"
        | "player.startmeeting"
        | "player.syncsettings",
>(
    event: EventName,
    listener: Listener<PlayerControlEvents<RoomType>[EventName]>,
): () => void
Type Parameters
- EventName extends
      | "component.spawn"
      | "component.despawn"
      | "player.checkcolor"
      | "player.checkmurder"
      | "player.checkname"
      | "player.checkprotect"
      | "player.completetask"
      | "player.die"
      | "player.usemovingplatform"
      | "player.murder"
      | "player.protect"
      | "player.removeprotection"
      | "player.reportbody"
      | "player.revertshapeshift"
      | "player.chat"
      | "player.quickchat"
      | "player.setcolor"
      | "player.sethat"
      | "player.setlevel"
      | "player.setname"
      | "player.setnameplate"
      | "player.setpet"
      | "player.setrole"
      | "player.setskin"
      | "player.setstartcounter"
      | "player.setvisor"
      | "player.shapeshift"
      | "player.startmeeting"
      | "player.syncsettings"
Parameters
- event: EventName
- listener: Listener<PlayerControlEvents<RoomType>[EventName]>
Returns () => void
Inherited from NetworkedObject.once
- Defined in packages/events/lib/EventEmitter.ts:98
once<K extends BasicEvent>(event: string, listener: Listener<K>): () => void
Type Parameters
- K extends BasicEvent
Parameters
- event: string
- listener: Listener<K>
Returns () => void
Inherited from NetworkedObject.once
- Defined in packages/events/lib/EventEmitter.ts:102

processAwake

processAwake(): Promise<void>
Returns Promise<void>
Overrides NetworkedObject.processAwake
- Defined in packages/core/lib/objects/PlayerControl.ts:198

processFixedUpdate

processFixedUpdate(delta: number): Promise<void>
Parameters
- delta: number
Returns Promise<void>
Overrides NetworkedObject.processFixedUpdate
- Defined in packages/core/lib/objects/PlayerControl.ts:237

protectPlayer

protectPlayer(target: Player<RoomType>, angelColor?: Color): Promise<void>
Parameters
- target: Player<RoomType>
- angelColor: Color = ...
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1715

removeAllListeners

removeAllListeners(): void
Returns void
Inherited from NetworkedObject.removeAllListeners
- Defined in packages/events/lib/EventEmitter.ts:164

removeListeners

removeListeners(event: string): void
Parameters
- event: string
Returns void
Inherited from NetworkedObject.removeListeners
- Defined in packages/events/lib/EventEmitter.ts:159

removeProtection

removeProtection(timeout?: boolean): Promise<void>
Remove this player's protection from a guardian angel, if they have one.

Emits a player.removeprotection event. This is not networked, so other players will not see this update.
Parameters
- timeout: boolean = false
  Whether or not this is because of a timeout.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1947

revertShapeshift

revertShapeshift(): Promise<void>
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1878

sendChat

sendChat(message: string): Promise<void>
Send a chat message as this player.

Due to technical impossibilities, this event cannot be canceled or reverted.

Emits a player.chat event.
Parameters
- message: string
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:898

sendChatNote

sendChatNote(player: Player<RoomType>, type: DidVote): void
Send a player chat note for this player, i.e. "player x voted, x remaining.".
Parameters
- player: Player<RoomType>
- type: DidVote
Returns void
- Defined in packages/core/lib/objects/PlayerControl.ts:926

sendQuickChat

sendQuickChat(
message: StringNames | Player<RoomType>,
format?: (StringNames | Player<RoomType>)[],
): void
Send a quick chat message as this player.

Due to technical impossibilities, this event cannot be canceled or reverted.

Emits a player.quickchat event.
Parameters
- message: StringNames | Player<RoomType>
- Optionalformat: (StringNames | Player<RoomType>)[]
Returns void
- Defined in packages/core/lib/objects/PlayerControl.ts:1201

serializeToWriter

serializeToWriter(writer: HazelWriter, spawn?: boolean): boolean
Parameters
- writer: HazelWriter
- spawn: boolean = false
Returns boolean
Overrides NetworkedObject.serializeToWriter
- Defined in packages/core/lib/objects/PlayerControl.ts:227

setColor

setColor(color: Color): Promise<void>
Update this player's color. This is a host operation on official servers. Use PlayerControl.checkColor if you are calling this as not the host.

Emits a player.checkname event.
Parameters
- color: Color
  The color to set this player's name to.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:674

setHat

setHat(hatId: string): Promise<void>
Update this player's hat. This is not a host operation unless the client does not own this player.

Emits a player.sethat event.
Parameters
- hatId: string
  The hat to set this player's hat to, see Hat.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1313

setLevel

setLevel(level: number): Promise<void>
Parameters
- level: number
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1251

setName

setName(name: string): Promise<void>
Update this player's name. This is a host operation on official servers. Use PlayerControl.checkName if you are calling this as not the host.

Emits a player.setname event.
Parameters
- name: string
  The name to set this player's name to.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:555

setNameplate

setNameplate(nameplateId: string): Promise<void>
Update this player's nameplate. This is not a host operation unless the client does not own this player.

Emits a player.setnameplate event.
Parameters
- nameplateId: string
  The nameplate to set this player's nameplate to, see Nameplate.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1574

setPet

setPet(petId: string): Promise<void>
Update this player's pet. This is not a host operation unless the client does not own this player.

Emits a player.setpet event.
Parameters
- petId: string
  The pet to set this player's pet to, see Pet.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1444

setRole

setRole(roleCtr: typeof BaseRole): Promise<void>
Parameters
- roleCtr: typeof BaseRole
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1638

setSkin

setSkin(skinId: string): Promise<void>
Update this player's skin. This is not a host operation unless the client does not own this player.

Emits a player.setskin event.
Parameters
- skinId: string
  The skin to set this player's skin to, see Skin.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1379

setStartCounter

setStartCounter(counter: number): Promise<void>
Change the counter at the bottom of the screen while in the lobby, usually counting down from 5 to 1. This is a host-only operation on official servers.

Emits a player.setstartcounter event.
Parameters
- counter: number
  The counter to set to.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1098

setVisor

setVisor(visorId: string): Promise<void>
Update this player's visor. This is not a host operation unless the client does not own this player.

Emits a player.setvisor event.
Parameters
- visorId: string
  The visor to set this player's visor to, see Visor.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1509

shapeshift

shapeshift(target: Player<RoomType>, doAnimation?: boolean): Promise<void>
Parameters
- target: Player<RoomType>
- doAnimation: boolean = true
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1825

startMeeting

startMeeting(
body: Player<RoomType> | "emergency",
caller?: Player<RoomType>,
): Promise<void>
If you're the host, this will immediately begin a meeting Start a meeting and begin the meeting

Emits a player.startmeeting event.
Parameters
- body: Player<RoomType> | "emergency"
  The body that was reported, or "emergency" if it is an emergency meeting.
- Optionalcaller: Player<RoomType>
  The player that called this meeting.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1030

syncSettings

syncSettings(settings: GameSettings): Promise<void>
Change the room's settings. Use StatefulRoom.setSettings to pass a partial game objects object. This is a host operation on official servers.

Emits a player.syncsettings event.
Parameters
- settings: GameSettings
  The full game settings object to update the settings to.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:437

tryMurderPlayer

tryMurderPlayer(victim: Player<RoomType>): Promise<void>
Murder another a player. This operation can only be called if the player is the impostor on official servers.

Due to technical limitations, this operation cannot be canceled or reverted without advanced "breaking game", therefore it is out of scope of a single .revert() function on the event emitted.

Emits a player.murder event.
Parameters
- victim: Player<RoomType>
  The player to murder.
Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:827

usePlatform

usePlatform(): Promise<void>
Use the moving platfrom on the map, i.e. the one on Airship.

Emits a movingplatform.playerupdate event.

Returns Promise<void>
- Defined in packages/core/lib/objects/PlayerControl.ts:1159

wait

wait<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.checkcolor"
        | "player.checkmurder"
        | "player.checkname"
        | "player.checkprotect"
        | "player.completetask"
        | "player.die"
        | "player.usemovingplatform"
        | "player.murder"
        | "player.protect"
        | "player.removeprotection"
        | "player.reportbody"
        | "player.revertshapeshift"
        | "player.chat"
        | "player.quickchat"
        | "player.setcolor"
        | "player.sethat"
        | "player.setlevel"
        | "player.setname"
        | "player.setnameplate"
        | "player.setpet"
        | "player.setrole"
        | "player.setskin"
        | "player.setstartcounter"
        | "player.setvisor"
        | "player.shapeshift"
        | "player.startmeeting"
        | "player.syncsettings",
>(
    event: EventName,
): Promise<PlayerControlEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "component.spawn"
      | "component.despawn"
      | "player.checkcolor"
      | "player.checkmurder"
      | "player.checkname"
      | "player.checkprotect"
      | "player.completetask"
      | "player.die"
      | "player.usemovingplatform"
      | "player.murder"
      | "player.protect"
      | "player.removeprotection"
      | "player.reportbody"
      | "player.revertshapeshift"
      | "player.chat"
      | "player.quickchat"
      | "player.setcolor"
      | "player.sethat"
      | "player.setlevel"
      | "player.setname"
      | "player.setnameplate"
      | "player.setpet"
      | "player.setrole"
      | "player.setskin"
      | "player.setstartcounter"
      | "player.setvisor"
      | "player.shapeshift"
      | "player.startmeeting"
      | "player.syncsettings"
Parameters
- event: EventName
Returns Promise<PlayerControlEvents<RoomType>[EventName]>
Inherited from NetworkedObject.wait
- Defined in packages/events/lib/EventEmitter.ts:111
wait(event: string): Promise<BasicEvent>
Parameters
- event: string
Returns Promise<BasicEvent>
Inherited from NetworkedObject.wait
- Defined in packages/events/lib/EventEmitter.ts:114

waitf

waitf<
    EventName extends
        | "component.spawn"
        | "component.despawn"
        | "player.checkcolor"
        | "player.checkmurder"
        | "player.checkname"
        | "player.checkprotect"
        | "player.completetask"
        | "player.die"
        | "player.usemovingplatform"
        | "player.murder"
        | "player.protect"
        | "player.removeprotection"
        | "player.reportbody"
        | "player.revertshapeshift"
        | "player.chat"
        | "player.quickchat"
        | "player.setcolor"
        | "player.sethat"
        | "player.setlevel"
        | "player.setname"
        | "player.setnameplate"
        | "player.setpet"
        | "player.setrole"
        | "player.setskin"
        | "player.setstartcounter"
        | "player.setvisor"
        | "player.shapeshift"
        | "player.startmeeting"
        | "player.syncsettings",
>(
    event: EventName,
    filter: (
        ev: PlayerControlEvents<RoomType>[EventName],
    ) => boolean | Promise<boolean>,
): Promise<PlayerControlEvents<RoomType>[EventName]>
Type Parameters
- EventName extends
      | "component.spawn"
      | "component.despawn"
      | "player.checkcolor"
      | "player.checkmurder"
      | "player.checkname"
      | "player.checkprotect"
      | "player.completetask"
      | "player.die"
      | "player.usemovingplatform"
      | "player.murder"
      | "player.protect"
      | "player.removeprotection"
      | "player.reportbody"
      | "player.revertshapeshift"
      | "player.chat"
      | "player.quickchat"
      | "player.setcolor"
      | "player.sethat"
      | "player.setlevel"
      | "player.setname"
      | "player.setnameplate"
      | "player.setpet"
      | "player.setrole"
      | "player.setskin"
      | "player.setstartcounter"
      | "player.setvisor"
      | "player.shapeshift"
      | "player.startmeeting"
      | "player.syncsettings"
Parameters
- event: EventName
- filter: (ev: PlayerControlEvents<RoomType>[EventName]) => boolean | Promise<boolean>
Returns Promise<PlayerControlEvents<RoomType>[EventName]>
Inherited from NetworkedObject.waitf
- Defined in packages/events/lib/EventEmitter.ts:121
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>
Inherited from NetworkedObject.waitf
- Defined in packages/events/lib/EventEmitter.ts:125

Class PlayerControl<RoomType>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns PlayerControl<RoomType>

Properties

components

dirtyBit

flags

OptionalguardianProtector

isNew

netId

ownerId

player

playerId

protectedByGuardian

room

OptionalshapeshiftTarget

spawnType

Accessors

owner

Returns undefined | StatefulRoom<any> | Player<RoomType>

Methods

canMurder

Parameters

Returns boolean

causeToDie

Parameters

Returns Promise<void>

checkColor

Parameters

Returns Promise<void>

checkName

Parameters

Returns Promise<void>

completeTask

Parameters

Returns void

Example

deserializeFromReader

Parameters

Returns void

Destroy

Returns void

emit

Type Parameters

Parameters

Returns Promise<Event>

emitSerial

Type Parameters

Parameters

Returns Promise<Event>

emitSync

Type Parameters

Parameters

Returns Event

getComponentSafe

Type Parameters

Parameters

Returns undefined | T

getListeners

Type Parameters

Parameters

Returns Listener<Event>[]

getPlayerInfo

Returns undefined | NetworkedPlayerInfo<RoomType>

handleRemoteCall

Parameters

Returns Promise<void>

killPlayer

Parameters

Returns Promise<void>

`Optional`guardianProtector

`Optional`shapeshiftTarget