Game entity

Global

STD Library
Component
Combine:
entity

Properties

Name Type Description Script Name
Invalid status Bool Read Only
IsInvalid
Game Time Int Read Only
GameTimeCount
Current Round Index Int Read Only Workflow
CurrentRoundIndex
Current Phase Index Int Read Only Workflow
CurrentPhaseIndex
Mode template ID Int Read Only
ModeTemplateID
Enable Player Revive Bool Read Only Player
EnablePlayerRevive
Enable Bot Revive Bool Read Only Player
EnableBotRevive
Revival CD Int Read Only Player
ReviveCD
Team Count Int Read Only Team
TeamNum
Team Member Count Int Read Only Team
TeamMemberNum
Equipment reset each round Bool Read Only Items
ResetEquipment
Enable out-of-zone damage Bool Read Only Safe Zone
SafeZoneEnabled
Zone size Float Read Only Safe Zone
SafeZoneSize
Zone shrink start time Float Read Only Safe Zone
SafeZoneStartTime
Zone shrink duration Float Read Only Safe Zone
SafeZoneShrinkTime
Out-of-zone damage Float Read Only Safe Zone
SafeZoneDamage
Target score Int Read Only Game Results
TargetScore
Elimination score Int Read Only Game Results
KillingScore
Revival type Int Read Only Player
ReviveType
Round score ranking criteria (player) Int List Game Results
PlayerRoundScoreType
Criteria importance (player) Int List Game Results
PlayerRoundSortType
Round score ranking criteria (team) Int List Game Results
TeamRoundScoreType
Criteria importance (team) Int List Game Results
TeamRoundSortType
Score ranking criteria (MVP) Int List Game Results
MVPScoreType
Criteria importance (MVP) Int List Game Results
MVPScoreWeight
Round ranking score Int List Game Results
RoundScore
Show criteria on results page Int List Game Results
ShowScoreTypeResult
Total Round Count Int Read Only Workflow
Total # of rounds
TotalRoundCount
Total Score Int Game Results
TeamScoreType
Team Rank Int Game Results
TeamScoreOrder
Individual Score Int Game Results
PlayerScoreType
Player Rank Int Game Results
PlayerScoreOrder
Get coins when match begins Int Economy
EcoCoinRoundBegin
Get coins for eliminating Int Economy
EcoCoinKill
Get coins for victory Int Economy
EcoCoinWin
Display coin amount or not Bool Economy
IsShowCoin
Skybox Skybox Scene
SkyboxEnv
Frame Count Int Read Only
GameFrameCount
Enable Move Bool Read Only Player
IsMoveable
Custom Game Result Bool STD Library
CustomGameResult
Allow joining midway Bool Read Only
EnableJoin
Enable low-graphics mode Bool Read Only
When low fps is on, the game will run on 15 fps; or else 30 fps
EnableLowFrame
Delta Time Int Read Only
The interval between the 2 logic frame updates of the GS
DeltaTime
Fixed Delta Time Int Read Only
The fixed time interval for frame updates in milliseconds
FixedDeltaTime

Event

Name Description
On Game Start Triggered when the game starts, the server will be ready some time earlier than the client
On Game End Triggered at the end of the game. This event is triggered before the game ends on the server.
On Round Start Triggered at the start of each round
On Round End Triggered at the end of each round
On Phase Start Triggered at the beginning of each phase
On Phase End Triggered at the end of each phase
On Player Quit Triggered when a player quits
On Player Score Change[Obsolete] Triggered when the player’s score changes
On Team Score Change[Obsolete] Triggered when the team score changes
On Player Be Eliminated Triggered when a player dies
On Player Assist Triggered when a player assists
On Player Deal Damage Triggered when a player deals damage
On Player Eliminate Triggered when a player causes a kill
On Player Join Triggered when a player joins the game
On Player Revived Triggered when a player is respwaned
On Team Remove Triggered when a team is removed
On Team Add Triggered when a team is added
On Team Ace Triggered when a team is aced
On Scene Load Triggered when a scene is loaded successfully
On Scene Switch Triggered when the scene switches successfully
On Camera Raycast This event is triggered when the camera ray detection is triggered by a client click event
On Game Pause Fired after calling the pause game API
On Game Resume Triggered after calling the resume game API