Table of Contents

Script Subgame Function Reference

System functions that are used to create, monitor and manipulate subgames. An overview of the Subgame system can be found here.

Setup and Exit

Functions to join players to a subgame, start timers and register events.

SubgameJoin

SubgameJoin( SubgameID, PlayerID)

SubgameLeave

SubgameReset

SubgameSetTimer

SubgameKillTimer

SubgameRegisterEvent

e.g. SubgameRegisterEvent( 2, “PlayerLeave”, “MySubgamePlayerLeave” ) → Triggers Event( “Subgame”, “MySubgamePlayerLeave” )

Messaging and alerts

A set of functions that allow you to trigger script events, play sounds and activate UI, either on everyone joined to the subgame or on all players in the subgame on a particular team.

SubgameEventAll

SubgameMessageAll

SubgameSoundAll

SubgameEventTeam

SubgameMessageTeam

SubgameSoundTeam

SubgameActivateUI

SubgameActivateScoreboard

SubgameActivatePlayerListScores

Format SubgameActivatePlayerListScores ( Subgame_Num, Mode )
Description Activates the Player List Scores display for the participants of the subgame. Use commands *setplayerlistscore and *incplayerlistscore to update the player score and then functions like SubgameGetHighestPlayerListScore can be used to determine the subgame winners
Parameters Subgame number
Mode
Example TBD

Subgame Stats & Scores

'Stats' are generic values that can be used to track whatever you want - maybe number of kills, items collected, whatever. 'Scores' are usually associated with a team and can be displayed on the players' screens (See SubgameActivateScoreboard above).

SubgameGetStat

Format SubgameGetStat( Subgame_Num, Stat_Name )
Description Gets the value of a named stat (variable) within a subgame
Parameters Subgame number
Stat name
Example TBD

SubgameIncrementStat

SubgameDecrementStat

SubgameSetStat

SubgameGetScore

SubgameSetScore

SubgameIncrementScore

Subgame information

These functions provide information about the general state of the subgame and the players in it.

SubgameChallengeGetPlayer

SubgameGetNumPlayers

SubgameIsPlayerInGame

SubgameGetPlayer

SubgameGetNumPlayersOnTeam

SubgameGetTimerRemaining

Subgame conclusion information

This set of functions allow you to calculate victory conditions, for instance, by calculating how many players reached a certain threshold or who got the highest score.

SubgameGetHighestPlayerListScore

SubgameNumPlayersWithPlayerListScore

SubgameGetPlayerWithPlayerListScore

See also:

SubgameWebpostDuelScore