BIS fnc EXP camp playSubtitles: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " {{Function|Comments=" to "{{Function|Comments=")
(Fix description)
Line 8: Line 8:


| 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.
{{note|Subtitles can be cancel by setting BIS_fnc_EXP_camp_playSubtitles_terminate to [[true]]}}
{{Informative | Subtitles can be cancel by setting <tt>BIS_fnc_EXP_camp_playSubtitles_terminate</tt> to [[true]].}}
|DESCRIPTION=
|DESCRIPTION=
____________________________________________________________________________________________
____________________________________________________________________________________________


| [ [Array] ] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]];
| [subtitleDetail1, subtitleDetail2, ...] spawn [[BIS_fnc_EXP_camp_playSubtitles]]


|p1= subtitleDetailN: [[Array]] - format [speaker, text, timing]:
* speaker: [[String]] - Name of the speaker
* text: [[String]] - Subtitle
* timing: [[Number]] - Time at which the subtitle is played


|p1= Array [[Array]] - Array containing all infos for the first subtitle |PARAMETER1=
| [[Bool]] - [[true]] if successful, [[false]] if not |RETURNVALUE=
*|p2= Array select 0 [[String]] - Name of the speaker |PARAMETER2=
*|p3= Array select 1 [[String]] - Subtitle |PARAMETER3=
*|p4= Array select 2 [[Number]] - Time at which the subtitle is played |PARAMETER4=
 
| [[Bool]] - True if sucessful, false if not |= return
____________________________________________________________________________________________
____________________________________________________________________________________________


|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]];//Shows a subtitle immediately</code> |EXAMPLE1=
] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]]; {{cc|Shows a subtitle immediately}}</code> |EXAMPLE1=
|x2= <code>[  
|x2= <code>[
  ["Speaker1","Subtitle1",0],  
["Speaker1", "Subtitle1", 0],
  ["Speaker2","Subtitle2",5],  
["Speaker2", "Subtitle2", 5],
  ["Speaker3","Subtitle3",10],  
["Speaker3", "Subtitle3", 10],
  ["Speaker4","Subtitle5",15]  
["Speaker4", "Subtitle5", 15]
] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]]; //Displays 4 subtitles, with 5 seconds in between them</code> |EXAMPLE2=
] [[spawn]] [[BIS_fnc_EXP_camp_playSubtitles]]; {{cc|Displays 4 subtitles with 5 seconds between them}}</code> |EXAMPLE2=
 
____________________________________________________________________________________________
____________________________________________________________________________________________


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


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


Revision as of 12:19, 25 March 2020

Arma 3 logo black.png1.62
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:
Uncategorised

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:
Bool - 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

Notes

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_EXP_camp_playSubtitles&oldid=150083"