setDebriefingText: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(44 intermediate revisions by 6 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
____________________________________________________________________________________________


| Sets debriefing text. |= Description
|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.
____________________________________________________________________________________________


| endType '''setDebriefingText''' [title, description] |= Syntax
{{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 the old behaviour.}}
[[Image:endMission.jpg|400px]] [[Image:failMission.jpg|400px]]


|p1= endType: [[String]] |= PARAMETER1
|s1= endType [[setDebriefingText]] [title, description]


|p2= [title, description]: [[Array]] |= PARAMETER2
|p1= endType: [[String]] - engine type


|p3= title: [[String]] |= PARAMETER3
|p2= title: [[String]] - title text on the debriefing screen


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


| [[Nothing]] |= RETURNVALUE
|r1= [[Nothing]]


|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]


|x1= <code>
|s2since= arma3 2.06
</code>|= EXAMPLE1


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


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


| |= MPBEHAVIOUR
|p23= description: [[String]] - description text on the debriefing screen
____________________________________________________________________________________________
 
}}
|p24= subtitle: [[String]] - subtitle text on the debriefing screen ('''Must be set to use this syntax, even if to empty string ""''')
 
|p25= picture (Optional): [[String]] - title picture
 
|p27= background (Optional): [[String]] - background picture


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


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


<h3 style='display:none'>Bottom Section</h3>
|seealso= [[getDebriefingText]], [[disableDebriefingStats]], [[enableDebriefingStats]], [[endMission]], [[failMission]], [[missionEnd]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]
}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]

Revision as of 14:00, 13 September 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"), 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 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 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=293452"