Player

Required Module

Components & Properties

Name Description
Character skill[Obsolete] Character skill
Skill ID The character skill ID in AvatarSkill.csv
Game entity.Enable Player Revive \
Game entity.Enable Bot Revive \
Game entity.Revival CD \
Game entity.Revival type \
Game entity.Enable Move \
Player State Type The status of a player: alive, knocked down, or eliminated
Player Pose Type \
Gender Type Gender enum
Player.Player Status A player’s status: active, knocked down, or eliminated
Player.Movement status \
Player.Sprint status \
Player.Attack status \
Player.Jump status \
Player.Gender Gender
Player.Skeleton The pivot used to access the skeleton mask
Player.Knockdown Status Settings for the response to the knockdown state when eliminated
Player.Show Damage Number True by default. Displays damage number.
Knock-down Type The response to the knockdown state: maintain default logic, skip the knockdown state, or force into knockdown.
Player Revival Source Type \
Player Behavior Type \
Player Behavior Status Type \
Skeleton[Obsolete] \
Player UI type The player’s HUD type
Skeleton The pivot used to access the skeleton mask
Equipment Accessory Equip attachment
Player or Vehicle The alias for the player/vehicle entity type

Event

Name Description
On Player Quit Triggered when a player quits
On Player Join Triggered when a player joins the game
On Player Revived Triggered when a player is respwaned
On Revived Triggered when the player respwans
On Disconnect Triggered when a player disconnects
On Reconnect Triggered when a player reconnects
On Attack Triggered when the player presses the fire button
On Jump Triggered when the player jumps
On Jump Stop Triggered when the player finishes jumping.
On Fall Triggered when the player falls
On Fall Stop Triggered when the player finishes falling.
On Crouch Triggered when the player crouches
On Prone Triggered when the player goes prone
On Sprint Triggered when the player sprints
On Move Triggered when the player moves
On Idle Triggered when the player is idle
On Use Avatar Skill Triggered when the player uses a skill
On Stand Up Triggered when the player stands up from any other posture
On Surfing Triggered when the player uses a wakeboard
On Surfing Stop Triggered when the player stops using the wakeboard
On Sprint Stop Triggered when the player ends a sprint

API

Name Description
Add HP Restore health to the designated player without exceeding the health limit
Teleport Teleport the target to a specified location
Get random spawn coordinates[Obsolete] Get the available coordinates of the random spawn point that is currently available but not fully occupied (deprecated, please use GetRandomSpawnPosition)
Get Random Spawn Position Get the coordinates of a random spawn point, which will only be randomly selected from available spawn points that are not fully occupied
Revive Resurrecting a Designated Player
Set Behavior Status Set the player’s behavior state
Play Character Animation Clip Play character animations, support custom animation resources
Play Character Animation Clip Override Play a character animation clip with the option to override the game’s default animation
Set Character Sets the character resource of the specified player
Set Forward Set the player’s direction
Set Skills Set the target player’s skill list
Get Skills Get the target player’s skill list
Quit Game Kick the target player out of the game
Skeleton scale[Obsolete] (Obsolete, do not use, see the property :Skeleton for related information)
Hit Fly Give the player a knock-up effect. The target player will fall at a fixed acceleration, and will be forced to stop after a collision in the air.
Set Default UI Status Set the target player’s default interface visibility
Request Match Making The target player requests to match the specified map
Set Falling Damage Set the player’s fall damage, and set different damage according to the height segment
Exit Vehicle Force the targeted player to leave the vehicle
Get Local Aim Direction Get the player’s local aiming direction
Start Parachute Start parachuting