setDebriefingText: Difference between revisions
Jump to navigation
Jump to search
m (template:command argument fix) |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
(39 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
{{ | {{RV|type=command | ||
| arma3 |= | |game1= arma3 | ||
|version1= 0.50 | |||
| | |gr1= Briefing | ||
| Sets debriefing text for | |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 the old behaviour.}} | ||
[[Image:endMission.jpg|400px]] [[Image:failMission.jpg|400px]] | |||
| | |s1= endType [[setDebriefingText]] [title, description] | ||
| | |p1= endType: [[String]] - engine type | ||
| | |p2= title: [[String]] - title text on the debriefing screen | ||
| | |p3= description: [[String]] - description text on the debriefing screen | ||
| [[Nothing]] | |r1= [[Nothing]] | ||
|s2= endType [[setDebriefingText]] [title, description, subtitle, picture, background] | |||
| | |s2since= arma3 2.06 | ||
|p21= endType: [[String]] - any name | |||
|p22= title: [[String]] - title text on the debriefing screen | |||
|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 | ||
|r2= [[Nothing]] | |||
< | |x1= <code>_currentObjective = ([[taskDescription]] ([[currentTask]] [[player]])) [[select]] 2; | ||
</ | "endDeath" [[setDebriefingText]] ["You Lose","All of your men were killed while assaulting the " + _currentObjective];</code> | ||
|seealso= [[getDebriefingText]], [[disableDebriefingStats]], [[enableDebriefingStats]], [[endMission]], [[failMission]], [[missionEnd]] | |||
[[ | }} | ||
[[ | |||
[[ |
Revision as of 14:00, 13 September 2021
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.
- 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