Player¶
Inherits NPC
Player represents a user playing the game.
Not newable
This object cannot be created by scripts using Instance.New().
Properties¶
UserID : number¶
The unique ID of the player.
CanMove : boolean¶
Determines whether the player can move.
SprintSpeed : number¶
Determines the sprinting speed of the player.
Stamina : number¶
Determines the current stamina of the player.
MaxStamina : number¶
Determines the maximum stamina of the player.
UseStamina : boolean¶
Determines whether the player uses stamina.
StaminaRegen : number¶
Determines the rate at which the player's stamina regenerates.
StaminaBurn : number¶
Determines the rate at which the player's stamina depletes while sprinting.
RespawnTime : number¶
Determines the time the player has to wait before respawning.
UseHeadTurning : boolean¶
Determines whether the player uses head turning.
UseBubbleChat : boolean¶
Determines whether the player uses bubble chat.
AutoLoadAppearance : boolean¶
Determines whether the player's appearance is automatically loaded.
NetworkPing : number¶
The amount of network latency (ping) the player is experiencing.
IsAdmin : boolean¶
Determines whether the player is an administrator.
IsCreator : boolean¶
Determines whether the player is the creator of the game.
ChatColor : Color¶
Determines the chat color of the player.
IsLocal : boolean¶
Determines whether the player is the local player.
IsClimbing : boolean¶
Determines whether the player is currently climbing.
ClimbingTruss : Truss¶
Determines the truss the player is currently climbing.
UserPlatform : ClientPlatform¶
Determines the platform the player is using.
Inventory : Inventory¶
The inventory of the player.
Methods¶
Jump → nil¶
Parameters: ``
Makes the player jump.
Kick → nil¶
Parameters: reason [ string ]
Kicks the player from the game with the specified reason.
UnequipTool → nil¶
Parameters: ``
Unequips the currently equipped tool of the player.
Respawn → nil¶
Parameters: ``
Respawns the player.
ResetAppearance → nil¶
Parameters: ``
Resets the player's appearance to the default.
Events¶
Chatted¶
Parameters: message [ string ]
Fires when this player chats
Respawned¶
Parameters: ``
Fires when this player has respawned