Player

Player represents a user playing the game.

Inherits: NPC

Properties

• UserID: number
• CanMove: boolean
• SprintSpeed: number
• Stamina: number
• MaxStamina: number
• UseStamina: boolean
• StaminaRegen: number
• StaminaBurn: number
• RespawnTime: number
• UseHeadTurning: boolean
• UseBubbleChat: boolean
• AutoLoadAppearance: boolean
• NetworkPing: number
• IsAdmin: boolean
• IsCreator: boolean
• ChatColor: Color
• IsLocal: boolean
• IsClimbing: boolean
• ClimbingTruss: Truss
• UserPlatform: ClientPlatformEnum
• Inventory: Inventory

Methods

Jump() → nil

Makes the player jump.

Kick(reason: string) → nil

Kicks the player from the game with the specified reason.

UnequipTool() → nil

Unequips the currently equipped tool of the player.

Respawn() → nil

Respawns the player.

ResetAppearance() → nil

Resets the player's appearance to the default.

Events

• Chatted: Fires when this player chats
• Respawned: Fires when this player has respawned