Optional spawn: booleanOptional spawn: booleanMark one of this player's tasks as completed.
client.me.control.completeTask(0);
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 taskStates array.
Emits a player.completetask event.
Get a certain component from the object.
The component class to get.
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.
The player to murder.
Optional angelColor: ColorRemove 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.
Optional timeout: booleanWhether or not this is because of a timeout.
Send a chat message as this player.
Due to technical impossibilities, this event cannot be canceled or reverted.
Emits a player.chat event.
Send a player chat note for this player, i.e. "player x voted, x remaining.".
Send a quick chat message as this player.
Due to technical impossibilities, this event cannot be canceled or reverted.
Emits a player.quickchat event.
Optional format: (PlayerData<Hostable<any>> | StringNames)[]Update this player's color. This is a host operation on official servers. Use checkColor if you are calling this as not the host.
Emits a player.checkname event.
The color to set this player's name to.
Update this player's hat. This is not a host operation unless the client does not own this player.
Emits a player.sethat event.
The hat to set this player's hat to, see Hat.
Update this player's name. This is a host operation on official servers. Use checkName if you are calling this as not the host.
Emits a player.setname event.
The name to set this player's name to.
Update this player's nameplate. This is not a host operation unless the client does not own this player.
Emits a player.setnameplate event.
The nameplate to set this player's nameplate to, see Nameplate.
Update this player's pet. This is not a host operation unless the client does not own this player.
Emits a player.setpet event.
The pet to set this player's pet to, see Pet.
Update this player's skin. This is not a host operation unless the client does not own this player.
Emits a player.setskin event.
The skin to set this player's skin to, see Skin.
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.
The counter to set to.
Update this player's visor. This is not a host operation unless the client does not own this player.
Emits a player.setvisor event.
The visor to set this player's visor to, see Visor.
Optional doAnimation: booleanIf you're the host, this will immediately begin a meeting Start a meeting and begin the meeting
Emits a player.startmeeting event.
The body that was reported, or "emergency" if it is an emergency meeting.
Optional caller: PlayerData<Hostable<any>>The player that called this meeting.
Change the room's settings. Use setSettings to pass a partial game objects object. This is a host operation on official servers.
Emits a player.syncsettings event.
The full game settings object to update the settings to.
Use the moving platfrom on the map, i.e. the one on Airship.
Emits a movingplatform.playerupdate event.
The dirty state of this component.
Flags for this object, see SpawnFlag.
Optional guardianThe player (i.e. a guardian angel) who has protected this player, if the player is being protected..
Whether the player was just spawned, or was spawned before joining.
The net ID of this component.
The ID of the owner of this component.
The player that this component belongs to.
The player ID of the player.
Whether or not this player has been protected bya guardian angel.
The room that this component belongs to.
Optional shapeshiftThe player that this player has shapeshifted as, if any.
The type of object that this component belongs to.
Optional data: PlayerControlData | HazelReaderGenerated using TypeDoc
Represents a player object for interacting with the game and other players.
See PlayerControlEvents for events to listen to.