setDebriefingText: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - " \|([ps][0-9]+) *= " to " |$1= ")
m (Some wiki formatting)
Line 3: Line 3:
|game1= arma3
|game1= arma3
|version1= 0.50
|version1= 0.50


|gr1= Briefing
|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, 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.  


{{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 3 arguments passed to the command. 2 arguments will trigger the old behaviour.}}
[[Image:endMission.jpg|400px]] [[Image:failMission.jpg|400px]]
[[Image:endMission.jpg|400px]] [[Image:failMission.jpg|400px]]


Line 16: Line 15:
|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
|p3= description: [[String]] - description text on the debriefing screen


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


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


|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background]       Since Arma 3 v2.05.147996
|s2since= arma3 2.06


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


|p22= [title, description, subtitle, picture, background]: [[Array]]
|p22= title: [[String]] - title text on the debriefing screen
 
|p23= 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 set to use this syntax, even if to empty string ""''')  


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


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

Revision as of 13:00, 13 September 2021

Arma 3 logo black.png 0.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"