setDebriefingText: Difference between revisions

Revision as of 11:06, 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 engine-defined (see endType parameter), 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.

Problems:

While optional for the game, subtitle must be set for this command to have any effect ("" will do) - available since

2.06.

Groups:

Briefing

Syntax

Syntax:

endType setDebriefingText [title, description, subtitle, picture, background]

Parameters:

endType: String - engine type. Engine defined endings:

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

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 for the command to have effect

picture: String - (Optional, default "") title picture

background : String - (Optional, default "") background picture

Return Value:

Nothing

Examples

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

Additional Information

See also:: getDebriefingText disableDebriefingStats enableDebriefingStats endMission failMission missionEnd

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 3: / Line 3: @@
 |game1= arma3
 |version1= 0.50
 |gr1= Briefing
-|descr= Sets debriefing title, text, subtitle, picture and background for a mission ending. The end type could be the engine defined ("CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", "END6"), 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.
+|descr= Sets debriefing title and text (plus subtitle, picture and background with alt syntax) for a mission ending. The end type could be engine-defined (see [[#Syntax_1|''endType'' parameter]]), 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.
+{{{!}} style="margin: auto"
+{{!}} [[File:endMission.jpg|400px]]
+{{!}} [[File:failMission.jpg|400px]]
+{{!}}}
-{{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}}
+|pr= While optional for the game, ''subtitle'' '''must''' be set for this command to have any effect ({{ic|""}} will do) - available since {{GVI|arma3|2.06}}.
-[[Image:endMission.jpg|400px]] [[Image:failMission.jpg|400px]]
-|s1= endType [[setDebriefingText]] [title, description]
+|s1= endType [[setDebriefingText]] [title, description, subtitle, picture, background]
-|p1= endType: [[String]] - engine type
+|p1= endType: [[String]] - engine type. Engine defined endings:
+{{Columns|4|
+* "CONTINUE" - this is default type, basically an alias to do nothing
+* "KILLED"
+* "LOSER"
+* "END1"
+* "END2"
+* "END3"
+* "END4"
+* "END5"
+* "END6"
+}}
-|p2= [title, description]: [[Array]]
+|p2= title: [[String]] - title text on the debriefing screen
-|p3= title: [[String]] - title text on the debriefing screen
+|p3= description: [[String]] - description text on the debriefing screen
-|p4= description: [[String]] - description text on the debriefing screen
+|p4= subtitle: [[String]] - subtitle text on the debriefing screen - '''must''' be set for the command to have effect
-|r1= [[Nothing]]
+|p5= picture: [[String]] - (Optional, default "") title picture
-|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Since Arma 3 v2.05.147996
+|p6= background : [[String]] - (Optional, default "") background picture
-|p21= endType: [[String]] - any name
+|r1= [[Nothing]]
-|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;
+|x1= <code>[[private]] _currentObjective = ([[taskDescription]] ([[currentTask]] [[player]])) [[select]] 2;
-"endDeath" [[setDebriefingText]] ["You Lose","All of your men were killed while assaulting the " + _currentObjective];</code>
+"endDeath" [[setDebriefingText]] ["You Lose", "All of your men were killed while assaulting the " + _currentObjective];</code>
 |seealso= [[getDebriefingText]], [[disableDebriefingStats]], [[enableDebriefingStats]], [[endMission]], [[failMission]], [[missionEnd]]
 }}