Properties
| Name | Type | Description | Script Name |
|---|---|---|---|
| Invalid status | Bool | Read Only Whether the current game is in illegal state, when it is in illegal state, it means the game has lost the value of confrontation, so it is recommended to end the game directly. |
IsInvalid |
| Game Time | Int | Read Only The length of the current game, in milliseconds. |
GameTimeCount |
| Current Round Index | Int | Read Only Workflow Current round index, through this value you can get the current round entity. |
CurrentRoundIndex |
| Current Phase Index | Int | Read Only Workflow Current phase index, by this value you can get the current phase entity. |
CurrentPhaseIndex |
| Mode template ID | Int | Read Only Preset template ID for UGC mode. |
ModeTemplateID |
| Enable Player Revive | Bool | Read Only Player Disable player resurrection if off |
EnablePlayerRevive |
| Enable Bot Revive | Bool | Read Only Player Disable Bot resurrection if off |
EnableBotRevive |
| Revival CD | Int | Read Only Player Resurrection time in seconds |
ReviveCD |
| Team Count | Int | Read Only Team Total number of teams in the game |
TeamNum |
| Team Member Count | Int | Read Only Team Number of members in each team |
TeamMemberNum |
| Equipment reset each round | Bool | Read Only Items Whether or not to reset equipment every round |
ResetEquipment |
| Enable out-of-zone damage | Bool | Read Only Safe Zone Whether or not to enable out-of-zone mechanic |
SafeZoneEnabled |
| Zone size | Float | Read Only Safe Zone Safe Zone Size |
SafeZoneSize |
| Zone shrink start time | Float | Read Only Safe Zone Shrinking Start Time |
SafeZoneStartTime |
| Zone shrink duration | Float | Read Only Safe Zone Shrinking Duration |
SafeZoneShrinkTime |
| Out-of-zone damage | Float | Read Only Safe Zone Out-of-Zone Damage |
SafeZoneDamage |
| Target score | Int | Read Only Game Results (Deprecated, please do not use) |
TargetScore |
| Elimination score | Int | Read Only Game Results (Deprecated, please do not use) |
KillingScore |
| Revival type | Int | Read Only Player Revival Type |
ReviveType |
| Round score ranking criteria (player) | Int List | Game Results (Deprecated, please do not use) |
PlayerRoundScoreType |
| Criteria importance (player) | Int List | Game Results (Deprecated, please do not use) |
PlayerRoundSortType |
| Round score ranking criteria (team) | Int List | Game Results (Deprecated, please do not use) |
TeamRoundScoreType |
| Criteria importance (team) | Int List | Game Results (Deprecated, please do not use) |
TeamRoundSortType |
| Score ranking criteria (MVP) | Int List | Game Results (Deprecated, please do not use) |
MVPScoreType |
| Criteria importance (MVP) | Int List | Game Results (Deprecated, please do not use) |
MVPScoreWeight |
| Round ranking score | Int List | Game Results (Deprecated, please do not use) |
RoundScore |
| Show criteria on results page | Int List | Game Results (Deprecated, please do not use) |
ShowScoreTypeResult |
| Total Round Count | Int | Read Only Workflow Total Round Count |
TotalRoundCount |
| Total Score | Int | Game Results (Deprecated, please do not use) |
TeamScoreType |
| Team Rank | Int | Game Results (Deprecated, please do not use) |
TeamScoreOrder |
| Individual Score | Int | Game Results (Deprecated, please do not use) |
PlayerScoreType |
| Player Rank | Int | Game Results (Deprecated, please do not use) |
PlayerScoreOrder |
| Get coins when match begins | Int | Economy Number of coins gained at the start of the round |
EcoCoinRoundBegin |
| Get coins for eliminating | Int | Economy Number of coins at kill |
EcoCoinKill |
| Get coins for victory | Int | Economy Number of coins when you win |
EcoCoinWin |
| Display coin amount or not | Bool | Economy Whether to show wallet UI |
IsShowCoin |
| Skybox | Skybox | Scene Skybox Entity |
SkyboxEnv |
| Frame Count | Int | Read Only Cumulative running frames since game start |
GameFrameCount |
| Enable Move | Bool | Read Only Player Enable Move |
IsMoveable |
| Custom Game Result | Bool | STD Library Whether to customize the settlement |
CustomGameResult |
| Allow joining midway | Bool | Read Only Whether to allow joining in the middle of the game |
EnableJoin |
| Enable low-graphics mode | Bool | Read Only Enable low frame rate mode, the game will run at 15FPS, otherwise 30FPS |
EnableLowFrame |
| Delta Time | Int | Read Only Logical frame update interval between two game server updates |
DeltaTime |
| Fixed Delta Time | Int | Read Only Fixed frame update interval 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 |