Player
A player in the game
Properties
Name | Type | Description |
---|---|---|
UserId | Number | |
Username | String | |
Rank | Number | |
Mouse | PlayerMouse | Gets the player's mouse data |
Body | PlayerBody | Gets the player's body data |
Velocity | Vector3 | Gets the player's current base velocity |
RagdollEnabled | Boolean | |
RagdollDespawnTime | Number | |
Health | Number | Get/set the player's health |
MaxHealth | Number | Get/set the player's max health |
WalkSpeed | Number | Get/set the player's walkspeed |
JumpPower | Number | Get/set the player's jump power |
FirstPersonLock | Boolean | |
AllowSprinting | Boolean | |
CData | CData | The coordinate data of this object in the 3D gamespace. |
IsGrounded | Boolean | Check if the player is currently on the ground |
Camera | Camera |
Inherited from Dynamic | Name Enabled Root Tag Position Rotation LocalRotation Size Parent TextureID TextureTiling TextureTilingY |
Functions
Name | Returns | Description |
---|---|---|
Destroy | Void | Removes the dynamic from the game and all of its child dynamics |
Clone | Dynamic | Clone this object and return the new one. |
Kick | Void | Disconnects a player with an optional message |
AddTool | Void | |
Kill | Void | Kills the player |
TakeDamage | Void | Deals damage to the player |
PlayAnimation | Void | Causes the player to play an animation |
PromptAssetBuy | Void | Prompt the user with an Interface to buy an asset |
OwnsGamepackage | Boolean | Check if player owns the specified GamePackage (by id) |
GetKeyDown | Boolean | Must be called from LocalScript |
GetKeyHeld | Boolean | Must be called from LocalScript |
AddVelocity | Void | |
SetVelocity | Void |
Inherited from Dynamic | SetParent Log IsA FindFirstChild FindFirstChildOfClass FindFirstParentOfClass MoveTo NetworkSync LookAt LocalToWorldPoint GetChildren ClearChildren |
Events
Name | Description |
---|---|
Touched | Occurs when an object bumps into the player. |
TouchEnded |