Differences

This shows you the differences between two versions of the page.

--- scripting:reference:system_functions:subgamefunctions [2020/01/29 06:04] – mit
+++ scripting:reference:system_functions:subgamefunctions [2023/04/15 11:43] (current) – [SubgameJoin] mit
@@ Line 3: / Line 3: @@
 System functions that are used to create, monitor and manipulate subgames. An overview of the Subgame system can be found [[Scripting:Subgames|here]].
-=== Setup and Exit ===
+===== Setup and Exit =====
+Functions to join players to a subgame, start timers and register events.
 ==== SubgameJoin ====
+SubgameJoin( SubgameID, PlayerID)
 ==== SubgameLeave ====
 ==== SubgameReset ====
@@ Line 12: / Line 15: @@
 ==== SubgameRegisterEvent ====
-=== Messaging and alerts ===
+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 ====
@@ Line 23: / Line 31: @@
 ==== 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 ===
+===== 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 )|
+^ Format | SubgameGetStat( Subgame_Num, Stat_Name )|
 ^ Description | Gets the value of a named stat (variable) within a subgame |
 ^ Parameters | Subgame number \\ Stat name |
@@ Line 41: / Line 53: @@
 ==== SubgameIncrementScore ====
-=== Subgame information ===
+===== Subgame information =====
 These functions provide information about the general state of the subgame and the players in it.
@@ Line 52: / Line 64: @@
 ==== SubgameGetTimerRemaining ====
-=== Subgame conclusion information ===
+===== 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.
@@ Line 58: / Line 70: @@
 ==== SubgameNumPlayersWithPlayerListScore ====
 ==== SubgameGetPlayerWithPlayerListScore ====
+See also:
+  * [[Scripting:Reference:system_functions:PlayerStatusFunctions#sysGenerateTopPlayerVarsList|sysGenerateTopPlayerVarsList]] \\
+  * [[Scripting:Reference:system_functions:PlayerStatusFunctions#sysGetTopPlayer|sysGetTopPlayer]]
+  * [[Scripting:Reference:system_functions:PlayerStatusFunctions#sysGetPlayerListScore|sysGetPlayerListScore ]]
 ==== SubgameWebpostDuelScore ====