setDebriefingText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
m (Some wiki formatting)
 
(20 intermediate revisions by 3 users not shown)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 0.50
|version1= 0.50


|gr1= Briefing
|gr1= Briefing


|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:
|descr= Sets debriefing title, text, subtitle, picture and background for a mission ending.
* "CONTINUE" - this is default type, basically an alias to do nothing
The end type could be the engine-defined ("CONTINUE", "KILLED", "LOSER", "END1", "END2", "END3", "END4", "END5", "END6"), config-defined (see [[Debriefing#Configuration|CfgDebriefing]]) or, with an alternative syntax of this command, any [[String]].
* "KILLED"
Given texts will be used to replace the corresponding texts on the debriefing screen.
* "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}}  
{{Feature|important|In order to benefit from alternative syntax functionality, there will have to be at least '''three''' arguments passed to the command; '''two''' arguments will trigger the old behaviour.}}
[[Image:endMission.jpg|400px]] [[Image:failMission.jpg|400px]]
[[File:endMission.jpg|400px]] [[File:failMission.jpg|400px]]


|s1= endType [[setDebriefingText]] [title, description]
|s1= endType [[setDebriefingText]] [title, description]
Line 25: Line 17:
|p1= endType: [[String]] - engine type
|p1= endType: [[String]] - engine type


|p2= [title, description]: [[Array]]
|p2= title: [[String]] - title text on the debriefing screen
 
|p3= title: [[String]] - title text on the debriefing screen


|p4= description: [[String]] - description text on the debriefing screen
|p3= description: [[String]] - description text on the debriefing screen


|r1= [[Nothing]]
|r1= [[Nothing]]
Line 35: Line 25:
|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]
|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]


|p21= endType: [[String]] - any name
|s2since= arma3 2.06


|p22= [title, description, subtitle, picture, background]: [[Array]]
|p21= endType: [[String]] - any name


|p23= title: [[String]] - title text on the debriefing screen
|p22= title: [[String]] - title text on the debriefing screen


|p24= description: [[String]] - description text on the debriefing screen
|p23= 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 ""''')  
|p24= subtitle: [[String]] - subtitle text on the debriefing screen ('''must''' be defined in order to trigger this syntax of the command)


|p26= picture (Optional): [[String]] - title picture
|p25= picture: [[String]] - (Optional) title picture


|p27= background (Optional): [[String]] - background picture
|p27= background: [[String]] - (Optional) background picture


|r2= [[Nothing]]
|r2= [[Nothing]]


|x1= <code>_currentObjective = ([[taskDescription]] ([[currentTask]] [[player]])) [[select]] 2;
|x1= <sqf>
"endDeath" [[setDebriefingText]] ["You Lose","All of your men were killed while assaulting the " + _currentObjective];</code>
_currentObjective = (taskDescription currentTask player) select 2;
"endDeath" setDebriefingText ["You Lose", "All of your men were killed while assaulting the " + _currentObjective];
</sqf>


|seealso= [[debriefingText]], [[disableDebriefingStats]], [[enableDebriefingStats]], [[endMission]], [[failMission]], [[missionEnd]]
|seealso= [[getDebriefingText]] [[disableDebriefingStats]] [[enableDebriefingStats]] [[endMission]] [[failMission]] [[missionEnd]]
}}
}}

Latest revision as of 17:31, 25 March 2024

Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
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"), 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.
⚠
In order to benefit from alternative syntax functionality, there will have to be at least three arguments passed to the command; two arguments will trigger the old behaviour.
endMission.jpg failMission.jpg
Groups:
Briefing

Syntax

Syntax:
endType setDebriefingText [title, description]
Parameters:
endType: String - engine type
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: 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 defined in order to trigger this syntax of the command)
picture: String - (Optional) title picture
background: String - (Optional) 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:
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
Retrieved from "https://community.bistudio.com/wiki?title=setDebriefingText&oldid=363195"