setDebriefingText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\{\{GameCategory\|(arma[0123])\|[ _]?New[ _]Scripting[ _]Commands[ _]List\}\}" to "{{GameCategory|$1|New Scripting Commands}}")
m (Some wiki formatting)
 
(42 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 0.50


|0.50|Game version=
|gr1= Briefing


|gr1= Broken Commands |GROUP1=
|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"), 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.


|gr2= Briefing |GROUP2=
{{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.}}
____________________________________________________________________________________________
[[File:endMission.jpg|400px]] [[File:failMission.jpg|400px]]


| Sets debriefing text for endType defined in [[Debriefing#Configuration|CfgDebriefing]].
|s1= endType [[setDebriefingText]] [title, description]
<br><br>
{{Warning | This command is broken. https://feedback.bistudio.com/T85682 }} |DESCRIPTION=
____________________________________________________________________________________________


| endType '''setDebriefingText''' [title, description] |SYNTAX=
|p1= endType: [[String]] - engine type


|p1= endType: [[String]] |PARAMETER1=
|p2= title: [[String]] - title text on the debriefing screen


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


|p3= title: [[String]] |PARAMETER3=
|r1= [[Nothing]]


|p4= description: [[String]] |PARAMETER4=
|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]


| [[Nothing]] |RETURNVALUE=  
|s2since= arma3 2.06


|p21= endType: [[String]] - any name


|x1= <code>_currentObjective = ([[taskDescription]] ([[currentTask]] [[player]])) [[select]] 2;
|p22= title: [[String]] - title text on the debriefing screen
"endDeath" [[setDebriefingText]] ["You Lose","All of your men were killed while assaulting the " + _currentObjective];</code>|EXAMPLE1=


____________________________________________________________________________________________
|p23= description: [[String]] - description text on the debriefing screen


| [[debriefingText]], [[disableDebriefingStats]], [[enableDebriefingStats]] |SEEALSO=
|p24= subtitle: [[String]] - subtitle text on the debriefing screen ('''must''' be defined in order to trigger this syntax of the command)


| |MPBEHAVIOUR=  
|p25= picture: [[String]] - (Optional) title picture
____________________________________________________________________________________________
 
}}
|p27= background: [[String]] - (Optional) background picture


<h3 style='display:none'>Notes</h3>
|r2= [[Nothing]]
<dl class='command_description'>
<!-- Note Section BEGIN -->


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


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[getDebriefingText]] [[disableDebriefingStats]] [[enableDebriefingStats]] [[endMission]] [[failMission]] [[missionEnd]]
{{GameCategory|arma3|New Scripting Commands}}
}}
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

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"