setDebriefingText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(Fix description)
m (Reverted edits by Lou Montana (talk) to last revision by killzone_kid)
Tag: Rollback
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 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.
|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.  
{{{!}} style="margin: auto"
 
{{!}} [[File:endMission.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}}  
{{!}} [[File:failMission.jpg|400px]]
[[Image:endMission.jpg|400px]] [[Image:failMission.jpg|400px]]
{{!}}}
 
|s1= endType [[setDebriefingText]] [title, description]
 
|p1= endType: [[String]] - engine type
 
|p2= [title, description]: [[Array]]
 
|p3= title: [[String]] - title text on the debriefing screen


|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}}.
|p4= description: [[String]] - description text on the debriefing screen


|s1= endType [[setDebriefingText]] [title, description, subtitle, picture, background]
|r1= [[Nothing]]


|p1= endType: [[String]] - engine type. Engine defined endings:
|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]       Since Arma 3 v2.05.147996
{{Columns|4|
* "CONTINUE" - this is default type, basically an alias to do nothing
* "KILLED"
* "LOSER"
* "END1"
* "END2"
* "END3"
* "END4"
* "END5"
* "END6"
}}


|p2= title: [[String]] - title text on the debriefing screen
|p21= endType: [[String]] - any name


|p3= description: [[String]] - description text on the debriefing screen
|p22= [title, description, subtitle, picture, background]: [[Array]]


|p4= subtitle: [[String]] - subtitle text on the debriefing screen - '''must''' be set for the command to have effect
|p23= title: [[String]] - title text on the debriefing screen


|p5= picture: [[String]] - (Optional, default "") title picture
|p24= description: [[String]] - description text on the debriefing screen


|p6= background : [[String]] - (Optional, default "") background picture
|p25= subtitle: [[String]] - subtitle text on the debriefing screen ('''Must be set to use this syntax, even if to empty string ""''')  


|r1= [[Nothing]]
|p26= picture (Optional): [[String]] - title picture
 
|p27= background (Optional): [[String]] - background picture
 
|r2= [[Nothing]]


|x1= <code>[[private]] _currentObjective = ([[taskDescription]] ([[currentTask]] [[player]])) [[select]] 2;
|x1= <code>_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]]
|seealso= [[getDebriefingText]], [[disableDebriefingStats]], [[enableDebriefingStats]], [[endMission]], [[failMission]], [[missionEnd]]
}}
}}

Revision as of 12:34, 5 August 2021

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"), 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.
⚠
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
endMission.jpg failMission.jpg
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]       Since Arma 3 v2.05.147996
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:
getDebriefingTextdisableDebriefingStatsenableDebriefingStatsendMissionfailMissionmissionEnd

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=291438"