setDebriefingText: Difference between revisions

Revision as of 08:12, 5 August 2021

Hover & click on the images for description

Description

Description:

Sets debriefing title and text (plus subtitle, picture and background with alt syntax) for a mission ending. The end type could be the engine defined (see below),the config defined (see CfgDebriefing) or, with an alternative syntax of this command, any String. Given texts will be used to replace the corresponding texts on the debriefing screen. Engine defined endings:

"CONTINUE" - this is default type, basically an alias to do nothing
"KILLED"
"LOSER"
"END1"
"END2"
"END3"
"END4"
"END5"
"END6"

⚠

In order to benefit from alternative syntax functionality, there will have to be at least 3 arguments passed to the command. 2 arguments will trigger old behaviour

Groups:

Briefing

Syntax

Syntax:: endType setDebriefingText [title, description]
Parameters:: endType: String - engine type
: [title, description]: Array
: title: String - title text on the debriefing screen
: description: String - description text on the debriefing screen
Return Value:: Nothing

Alternative Syntax

Syntax:: endType setDebriefingText [title, description, subtitle, picture, background]
Parameters:: endType: String - any name
: [title, description, subtitle, picture, background]: Array
: title: String - title text on the debriefing screen
: description: String - description text on the debriefing screen
: subtitle: String - subtitle text on the debriefing screen (Must be set to use this syntax, even if to empty string "")
: picture (Optional): String - title picture
: background (Optional): String - background picture
Return Value:: Nothing

Examples

Example 1:: _currentObjective = (taskDescription (currentTask player)) select 2; "endDeath" setDebriefingText ["You Lose","All of your men were killed while assaulting the " + _currentObjective];

Additional Information

See also:: debriefingText disableDebriefingStats enableDebriefingStats

Notes

: Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord or on the Forums.
Only post proven facts here! Add Note

@@ Line 4: / Line 4: @@
 |version1= 0.50
-|gr1= Broken Commands
-|gr2= Briefing
+|gr1= Briefing
-|descr= Sets debriefing text for endType defined in [[Debriefing#Configuration|CfgDebriefing]].
+|descr= Sets debriefing title and text (plus subtitle, picture and background with alt syntax) for a mission ending. The end type could be the engine defined (see below),the config defined (see [[Debriefing#Configuration|CfgDebriefing]]) or, with an alternative syntax of this command, any [[String]]. Given texts will be used to replace the corresponding texts on the debriefing screen. Engine defined endings:
-{{Feature | Warning | This command is broken. https://feedback.bistudio.com/T85682 }}
+* "CONTINUE" - this is default type, basically an alias to do nothing
+* "KILLED"
+* "LOSER"
+* "END1"
+* "END2"
+* "END3"
+* "END4"
+* "END5"
+* "END6"
+{{Feature | Important | In order to benefit from alternative syntax functionality, there will have to be at least 3 arguments passed to the command. 2 arguments will trigger old behaviour}}
 |s1= endType [[setDebriefingText]] [title, description]
-|p1= endType: [[String]]
+|p1= endType: [[String]] - engine type
 |p2= [title, description]: [[Array]]
-|p3= title: [[String]]
+|p3= title: [[String]] - title text on the debriefing screen
-|p4= description: [[String]]
+|p4= description: [[String]] - description text on the debriefing screen
 |r1= [[Nothing]]
+|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]
+|p21= endType: [[String]] - any name
+|p22=  [title, description, subtitle, picture, background]: [[Array]]
+|p23= title: [[String]] - title text on the debriefing screen
+|p24= description: [[String]] - description text on the debriefing screen
+|p25= subtitle: [[String]] - subtitle text on the debriefing screen ('''Must be set to use this syntax, even if to empty string ""''')
+|p26= picture (Optional): [[String]] - title picture
+|p27= background (Optional): [[String]] - background picture
+|r2= [[Nothing]]
 |x1= <code>_currentObjective = ([[taskDescription]] ([[currentTask]] [[player]])) [[select]] 2;