BIS fnc EXP camp playSubtitles: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "")
m (Text replacement - " *\| *([Cc]omments|COMMENTS|[Gg]ame [Nn]ame|Game [Vv]ersion|Game Version \(number surrounded by NO SPACES\)|Multiplayer Arguments \("local" or "global"\)|Multiplayer Effects \("local" or "global"\)|Multiplayer Execution \("server" o...)
Line 1: Line 1:
{{Function|Comments=
{{Function


| arma3 |Game name=
| arma3


|1.62|Game version=
|1.62


|gr1 = GUI |GROUP1=
|gr1 = GUI


| Displays the given subtitles at the correctly defined moments. Each array added to the parameters represents one subtitle.
| Displays the given subtitles at the correctly defined moments. Each array added to the parameters represents one subtitle.
{{Informative | Subtitles can be cancel by setting <tt>BIS_fnc_EXP_camp_playSubtitles_terminate</tt> to [[true]].}}
{{Informative | Subtitles can be cancel by setting <tt>BIS_fnc_EXP_camp_playSubtitles_terminate</tt> to [[true]].}}
|DESCRIPTION=
 


| [subtitleDetail1, subtitleDetail2, ...] spawn [[BIS_fnc_EXP_camp_playSubtitles]]
| [subtitleDetail1, subtitleDetail2, ...] spawn [[BIS_fnc_EXP_camp_playSubtitles]]
Line 18: Line 18:
* timing: [[Number]] - Time at which the subtitle is played
* timing: [[Number]] - Time at which the subtitle is played


| [[Boolean]] - [[true]] if successful, [[false]] if not |RETURNVALUE=
| [[Boolean]] - [[true]] if successful, [[false]] if not


|x1= <code>[
|x1= <code>[
["CROSSROAD", "Mission is a go, I repeat, mission is a go! Crossroad, out.", 0]
["CROSSROAD", "Mission is a go, I repeat, mission is a go! Crossroad, out.", 0]
] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]]; {{cc|Shows a subtitle immediately}}</code> |EXAMPLE1=
] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]]; {{cc|Shows a subtitle immediately}}</code>
|x2= <code>[
|x2= <code>[
["Speaker1", "Subtitle1", 0],
["Speaker1", "Subtitle1", 0],
Line 28: Line 28:
["Speaker3", "Subtitle3", 10],
["Speaker3", "Subtitle3", 10],
["Speaker4", "Subtitle5", 15]
["Speaker4", "Subtitle5", 15]
] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]]; {{cc|Displays 4 subtitles with 5 seconds between them}}</code> |EXAMPLE2=
] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]]; {{cc|Displays 4 subtitles with 5 seconds between them}}</code>


|exec= spawn |Execution By (defaults to [[call]] if omitted)=
|exec= spawn |Execution By (defaults to [[call]] if omitted)=


| [[Conversations]] [[BIS_fnc_showSubtitle]] |SEEALSO=
| [[Conversations]] [[BIS_fnc_showSubtitle]]
}}
}}



Revision as of 23:21, 17 January 2021

Hover & click on the images for description

Description

Description:
Displays the given subtitles at the correctly defined moments. Each array added to the parameters represents one subtitle.
Subtitles can be cancel by setting BIS_fnc_EXP_camp_playSubtitles_terminate to true.
Execution:
spawn
Groups:
GUI

Syntax

Syntax:
[subtitleDetail1, subtitleDetail2, ...] spawn BIS_fnc_EXP_camp_playSubtitles
Parameters:
subtitleDetailN: Array - format [speaker, text, timing]:
  • speaker: String - Name of the speaker
  • text: String - Subtitle
  • timing: Number - Time at which the subtitle is played
Return Value:
Boolean - true if successful, false if not

Examples

Example 1:
[ ["CROSSROAD", "Mission is a go, I repeat, mission is a go! Crossroad, out.", 0] ] spawn BIS_fnc_EXP_camp_playSubtitles; // Shows a subtitle immediately
Example 2:
[ ["Speaker1", "Subtitle1", 0], ["Speaker2", "Subtitle2", 5], ["Speaker3", "Subtitle3", 10], ["Speaker4", "Subtitle5", 15] ] spawn BIS_fnc_EXP_camp_playSubtitles; // Displays 4 subtitles with 5 seconds between them

Additional Information

See also:
Conversations BIS_fnc_showSubtitle

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


Bottom Section