Difference between revisions of "CZCareerHUD"

From AlliedModders Wiki
Jump to: navigation, search
 
(CZCareerHUD Event)
 
(3 intermediate revisions by the same user not shown)
Line 7: Line 7:
 
{{hl1msg|*|Parameters}}
 
{{hl1msg|*|Parameters}}
 
{{end-hl1msg}}
 
{{end-hl1msg}}
{{qnotice|Using an invalid type has no repercussions whatsoever.}}<br>
+
{{qnotice|Using an invalid type has no repercussions whatsoever. Therefore, you can use this to make your own custom communications (you can send any number of arguments of any type after the first string).}}<br>
{{qnotice|The types are case-sensitive.}}<br><br>
+
{{qnotice|The Type argument is case-sensitive.}}<br>
 +
{{qnotice|This event has some limited functionality in CS and CZ multiplayer (albeit better in CZ).}}<br><br>
 
The Parameters will change depending on what type you use. Below are the Parameters for the known valid types. Assume that the Type for each one of them is the same as the header for that section.
 
The Parameters will change depending on what type you use. Below are the Parameters for the known valid types. Assume that the Type for each one of them is the same as the header for that section.
  
 
==ROUND==
 
==ROUND==
Sent at the end of a round, displays the round results billboard (ie: "Your Team has Won this Round...") that shows how the round went and what objectives are left.<br>
+
Sent at the end of a round, displays the round results billboard (ie: "Your Team has Won this Round...").<br>
 
{{qnotice|Round Result can be 0 (draw), 1 (your team won), or 2 (your team lost). The billboard header and sound played change depending on this. If Round Result is not 0, 1, or 2, it is assumed a draw.}}
 
{{qnotice|Round Result can be 0 (draw), 1 (your team won), or 2 (your team lost). The billboard header and sound played change depending on this. If Round Result is not 0, 1, or 2, it is assumed a draw.}}
 
{{begin-hl1msg|ROUND|long,long,byte,byte,byte}}
 
{{begin-hl1msg|ROUND|long,long,byte,byte,byte}}
Line 25: Line 26:
 
{{hl1msg|string|ROUND}}
 
{{hl1msg|string|ROUND}}
 
{{hl1msg|long|5}}
 
{{hl1msg|long|5}}
{{hl1msg|long|7}}
+
{{hl1msg|long|6}}
 
{{hl1msg|byte|3}}
 
{{hl1msg|byte|3}}
 
{{hl1msg|byte|2}}
 
{{hl1msg|byte|2}}

Latest revision as of 21:04, 30 December 2006

CZCareerHUD Event

This event displays certain HUD elements regarding Condition Zero singleplayer missions. Here is its basic layout:

Name: CZCareerHUD
Structure:
string Type
* Parameters


Note: Using an invalid type has no repercussions whatsoever. Therefore, you can use this to make your own custom communications (you can send any number of arguments of any type after the first string).
Note: The Type argument is case-sensitive.
Note: This event has some limited functionality in CS and CZ multiplayer (albeit better in CZ).

The Parameters will change depending on what type you use. Below are the Parameters for the known valid types. Assume that the Type for each one of them is the same as the header for that section.

ROUND

Sent at the end of a round, displays the round results billboard (ie: "Your Team has Won this Round...").
Note: Round Result can be 0 (draw), 1 (your team won), or 2 (your team lost). The billboard header and sound played change depending on this. If Round Result is not 0, 1, or 2, it is assumed a draw.

Name: ROUND
Structure:
long CT Wins
long T Wins
byte Wins Required
byte Lead Required
byte Round Result


Example usage:

Name: CZCareerHUD
Structure:
string ROUND
long 5
long 6
byte 3
byte 2
byte 0


MATCH

Sent at the end of a mission, after it is finished, and after CZCareer's MATCH. Displays the match results billboard (ie: "Your Team is Victorious!").
Note: The Wins/Leads Required is used, based on the CT/T Wins, to decide if your team won or lost. The purpose of having the Round Result is unknown.

Name: MATCH
Structure:
long CT Wins
long T Wins
byte Wins Required
byte Lead Required
byte Round Result?


Example usage:

Name: CZCareerHUD
Structure:
string MATCH
long 7
long 5
byte 3
byte 2
byte 1