PlayerControl | SkeldJS

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

See PlayerControlEvents for events to listen to.

Type parameters

RoomType: Hostable

Hierarchy

Networkable<PlayerControlData, PlayerControlEvents<RoomType>, RoomType>
- PlayerControl

Implements

PlayerControlData

Index

Methods

Properties

Constructors

constructor

Accessors

owner

Methods

Awake

Awake(): void

Overrides Networkable.Awake
- Defined in core/lib/objects/PlayerControl.ts:202
Returns void

Deserialize

Deserialize(reader: HazelReader, spawn?: boolean): void

Overrides Networkable.Deserialize
- Defined in core/lib/objects/PlayerControl.ts:243
Parameters
- reader: HazelReader
- spawn: boolean = false
Returns void

Destroy

Destroy(): void

Inherited from Networkable.Destroy
- Defined in core/lib/Networkable.ts:174
Returns void

FixedUpdate

FixedUpdate(delta: number): void

Overrides Networkable.FixedUpdate
- Defined in core/lib/objects/PlayerControl.ts:261
Parameters
- delta: number
Returns void

HandleRpc

HandleRpc(rpc: BaseRpcMessage): Promise<void>

Overrides Networkable.HandleRpc
- Defined in core/lib/objects/PlayerControl.ts:271
Parameters
- rpc: BaseRpcMessage
Returns Promise<void>

PreSerialize

PreSerialize(): void

Inherited from Networkable.PreSerialize
- Defined in core/lib/Networkable.ts:166
Returns void

Serialize

Serialize(writer: HazelWriter, spawn?: boolean): boolean

Overrides Networkable.Serialize
- Defined in core/lib/objects/PlayerControl.ts:251
Parameters
- writer: HazelWriter
- spawn: boolean = false
Returns boolean

canBeManaged

canBeManaged(): boolean

Inherited from Networkable.canBeManaged
- Defined in core/lib/Networkable.ts:209
Whether or not this object

Returns boolean

checkColor

checkColor(color: Color): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:663
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>

checkName

checkName(name: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:533
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>

completeTask

completeTask(taskIdx: number): void

- Defined in core/lib/objects/PlayerControl.ts:397
Mark one of this player's tasks as completed.
example
```
client.me.control.completeTask(0);
```
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

despawn

despawn(): void

Inherited from Networkable.despawn
- Defined in core/lib/Networkable.ts:202
Despawns the component from the room it belongs in.

Returns void

emit

emit<Event>(event: Event): Promise<Event>

Inherited from Networkable.emit
- Defined in core/lib/Networkable.ts:129
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSerial

emitSerial<Event>(event: Event): Promise<Event>

Inherited from Networkable.emitSerial
- Defined in core/lib/Networkable.ts:139
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Promise<Event>

emitSync

emitSync<Event>(event: Event): Event

Inherited from Networkable.emitSync
- Defined in core/lib/Networkable.ts:149
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: Event
Returns Event

getComponent

getComponent<T>(component: NetworkableConstructor<T>): undefined | T

Overrides Networkable.getComponent
- Defined in core/lib/objects/PlayerControl.ts:223
Type parameters
- T: Networkable<any, NetworkableEvents<Hostable<any>>, Hostable<any>, T>
Parameters
- component: NetworkableConstructor<T>
Returns undefined | T

getListeners

getListeners<Event>(event: string): Listener<Event>[]

Inherited from Networkable.getListeners
- Defined in events/lib/EventEmitter.ts:138
Type parameters
- Event: BasicEvent<Event>
Parameters
- event: string
Returns Listener<Event>[]

kill

kill(reason: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:776
Parameters
- reason: string
Returns Promise<void>

murderPlayer

murderPlayer(victim: PlayerData<Hostable<any>>): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:843
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: PlayerData<Hostable<any>>
  
  The player to murder.
Returns Promise<void>

off

off<EventName>(event: EventName, listener: Listener<PlayerControlEvents<RoomType>[EventName]>): void
off<K>(event: string, listener: Listener<K>): void

Inherited from Networkable.off
- Defined in events/lib/EventEmitter.ts:125
Type parameters
- EventName: "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.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 Networkable.off
- Defined in events/lib/EventEmitter.ts:129
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns void

on

on<EventName>(event: EventName, listener: Listener<PlayerControlEvents<RoomType>[EventName]>): () => void
on<K>(event: string, listener: Listener<K>): () => void

Inherited from Networkable.on
- Defined in events/lib/EventEmitter.ts:74
Type parameters
- EventName: "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.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
- - (): void
  - Returns void
Inherited from Networkable.on
- Defined in events/lib/EventEmitter.ts:78
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

once

once<EventName>(event: EventName, listener: Listener<PlayerControlEvents<RoomType>[EventName]>): () => void
once<K>(event: string, listener: Listener<K>): () => void

Inherited from Networkable.once
- Defined in events/lib/EventEmitter.ts:86
Type parameters
- EventName: "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.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
- - (): void
  - Returns void
Inherited from Networkable.once
- Defined in events/lib/EventEmitter.ts:90
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- listener: Listener<K>
Returns () => void
- - (): void
  - Returns void

protectPlayer

protectPlayer(target: PlayerData<Hostable<any>>, angelColor?: Color): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1701
Parameters
- target: PlayerData<Hostable<any>>
- angelColor: Color = ...
Returns Promise<void>

removeAllListeners

removeAllListeners(): void

Inherited from Networkable.removeAllListeners
- Defined in events/lib/EventEmitter.ts:152
Returns void

removeListeners

removeListeners(event: string): void

Inherited from Networkable.removeListeners
- Defined in events/lib/EventEmitter.ts:147
Parameters
- event: string
Returns void

removeProtection

removeProtection(timeout?: boolean): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1907
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>

revertShapeshift

revertShapeshift(): Promise<void>

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

sendChat

sendChat(message: string): void

- Defined in core/lib/objects/PlayerControl.ts:935
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 void

sendChatNote

sendChatNote(player: PlayerData<Hostable<any>>, type: DidVote): void

- Defined in core/lib/objects/PlayerControl.ts:962
Send a player chat note for this player, i.e. "player x voted, x remaining.".

Parameters
- player: PlayerData<Hostable<any>>
- type: DidVote
Returns void

sendQuickChat

sendQuickChat(message: PlayerData<Hostable<any>> | StringNames, format?: (PlayerData<Hostable<any>> | StringNames)[]): void

- Defined in core/lib/objects/PlayerControl.ts:1228
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: PlayerData<Hostable<any>> | StringNames
- Optional format: (PlayerData<Hostable<any>> | StringNames)[]
Returns void

setColor

setColor(color: Color): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:710
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>

setHat

setHat(hatId: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1293
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>

setName

setName(name: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:580
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>

setNameplate

setNameplate(nameplateId: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1569
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>

setPet

setPet(petId: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1431
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>

setRole

setRole(roleCtr: typeof BaseRole): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1633
Parameters
- roleCtr: typeof BaseRole
Returns Promise<void>

setSkin

setSkin(skinId: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1362
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>

setStartCounter

setStartCounter(counter: number): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1125
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>

setVisor

setVisor(visorId: string): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1500
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>

shapeshift

shapeshift(target: PlayerData<RoomType>, doAnimation?: boolean): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1807
Parameters
- target: PlayerData<RoomType>
- doAnimation: boolean = true
Returns Promise<void>

spawn

spawn(): void

Inherited from Networkable.spawn
- Defined in core/lib/Networkable.ts:195
Spawn this component if does not exist in the room it belongs in.

Returns void

startMeeting

startMeeting(body: PlayerData<Hostable<any>> | "emergency", caller?: PlayerData<Hostable<any>>): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1057
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: PlayerData<Hostable<any>> | "emergency"
  
  The body that was reported, or "emergency" if it is an emergency meeting.
- Optional caller: PlayerData<Hostable<any>>
  
  The player that called this meeting.
Returns Promise<void>

syncSettings

syncSettings(settings: GameSettings): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:456
Change the room's settings. Use Hostable.setSettings to pass a partial game objects object. This is a host operation on official servers.

Emits a player.syncsettings event.

property

settings The full game settings object to update the settings to.

Parameters
- settings: GameSettings
Returns Promise<void>

usePlatform

usePlatform(): Promise<void>

- Defined in core/lib/objects/PlayerControl.ts:1186
Use the moving platfrom on the map, i.e. the one on Airship.

Emits a movingplatform.playerupdate event.

Returns Promise<void>

wait

wait<EventName>(event: EventName): Promise<PlayerControlEvents<RoomType>[EventName]>
wait(event: string): Promise<BasicEvent>

Inherited from Networkable.wait
- Defined in events/lib/EventEmitter.ts:99
Type parameters
- EventName: "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.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 Networkable.wait
- Defined in events/lib/EventEmitter.ts:102
Parameters
- event: string
Returns Promise<BasicEvent>

waitf

waitf<EventName>(event: EventName, filter: (ev: PlayerControlEvents<RoomType>[EventName]) => boolean | Promise<boolean>): Promise<PlayerControlEvents<RoomType>[EventName]>
waitf<K>(event: string, filter: (ev: K) => boolean | Promise<boolean>): Promise<BasicEvent>

Inherited from Networkable.waitf
- Defined in events/lib/EventEmitter.ts:109
Type parameters
- EventName: "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.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>
  - - (ev: PlayerControlEvents<RoomType>[EventName]): boolean | Promise<boolean>
    - Parameters
      - ev: PlayerControlEvents<RoomType>[EventName]
      Returns boolean | Promise<boolean>
Returns Promise<PlayerControlEvents<RoomType>[EventName]>
Inherited from Networkable.waitf
- Defined in events/lib/EventEmitter.ts:113
Type parameters
- K: BasicEvent<K>
Parameters
- event: string
- filter: (ev: K) => boolean | Promise<boolean>
  - - (ev: K): boolean | Promise<boolean>
    - Parameters
      - ev: K
      Returns boolean | Promise<boolean>
Returns Promise<BasicEvent>

Properties

components

components: Networkable<any, NetworkableEvents<Hostable<any>>, RoomType>[]

dirtyBit

dirtyBit: number = 0

The dirty state of this component.

flags

flags: number

Flags for this object, see SpawnFlag.

Optional guardianProtector

guardianProtector: PlayerData<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: PlayerData<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: PlayerData<RoomType>

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

spawnType

spawnType: SpawnType

The type of object that this component belongs to.

Constructors

constructor

new PlayerControl<RoomType>(room: RoomType, spawnType: SpawnType, netId: number, ownerid: number, flags: number, data?: HazelReader | PlayerControlData): PlayerControl<RoomType>

Overrides Networkable<PlayerControlData,PlayerControlEvents<RoomType>,RoomType>.constructor
- Defined in core/lib/objects/PlayerControl.ts:183
Type parameters
- RoomType: Hostable<any, RoomType>
Parameters
- room: RoomType
- spawnType: SpawnType
- netId: number
- ownerid: number
- flags: number
- Optional data: HazelReader | PlayerControlData
Returns PlayerControl<RoomType>

Accessors

owner

get owner(): undefined | Hostable<any> | PlayerData<RoomType>

- Defined in core/lib/Networkable.ts:84
Returns undefined | Hostable<any> | PlayerData<RoomType>

Type parameters

RoomType: Hostable

Hierarchy

Implements

Index

Methods

Properties

Constructors

Accessors

Methods

Awake

Returns void

Deserialize

Parameters

reader: HazelReader

spawn: boolean = false

Returns void

Destroy

Returns void

FixedUpdate

Parameters

delta: number

Returns void

HandleRpc

Parameters

rpc: BaseRpcMessage

Returns Promise<void>

PreSerialize

Returns void

Serialize

Parameters

writer: HazelWriter

spawn: boolean = false

Returns boolean

canBeManaged

Returns boolean

checkColor

Parameters

color: Color

Returns Promise<void>

checkName

Parameters

name: string

Returns Promise<void>

completeTask

Parameters

taskIdx: number

Returns void

despawn

Returns void

emit

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSerial

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Promise<Event>

emitSync

Type parameters

Event: BasicEvent<Event>

Parameters

event: Event

Returns Event

getComponent

Type parameters

T: Networkable<any, NetworkableEvents<Hostable<any>>, Hostable<any>, T>

Parameters

component: NetworkableConstructor<T>

Returns undefined | T

getListeners

Type parameters

Event: BasicEvent<Event>

Parameters

event: string

Returns Listener<Event>[]