Player

A player in the game

Properties

Name Type Description
UserIdNumber
UsernameString
RankNumber
MousePlayerMouseGets the player's mouse data
BodyPlayerBodyGets the player's body data
VelocityVector3Gets the player's current base velocity
RagdollEnabledBoolean
RagdollDespawnTimeNumber
HealthNumberGet/set the player's health
MaxHealthNumberGet/set the player's max health
WalkSpeedNumberGet/set the player's walkspeed
JumpPowerNumberGet/set the player's jump power
FirstPersonLockBoolean
AllowSprintingBoolean
CDataCDataThe coordinate data of this object in the 3D gamespace.
IsGroundedBooleanCheck if the player is currently on the ground
CameraCamera
Inherited from Dynamic Name Enabled Root Tag Position Rotation LocalRotation Size Parent TextureID TextureTiling TextureTilingY

Functions

Name Returns Description
DestroyVoidRemoves the dynamic from the game and all of its child dynamics
CloneDynamicClone this object and return the new one.
IsInGroupBoolean
KickVoidDisconnects a player with an optional message
AddToolVoid
KillVoidKills the player
TakeDamageVoidDeals damage to the player
PlayAnimationVoidCauses the player to play an animation
PromptAssetBuyVoidPrompt the user with an Interface to buy an asset
OwnsGamepackageBooleanCheck if player owns the specified GamePackage (by id)
GetKeyDownBooleanPlease use the Input class instead now! Deprecated.
GetKeyHeldBooleanPlease use the Input class instead now! Deprecated.
AddVelocityVoid
SetVelocityVoid
Inherited from Dynamic SetParent Log IsA FindFirstChild FindFirstChildOfClass FindFirstParentOfClass MoveTo NetworkSync LookAt LocalToWorldPoint GetChildren ClearChildren

Events

Name Description
TouchedOccurs when an object bumps into the player.
TouchEnded