BIS fnc jukebox: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " <h3 style="display:none">Notes</h3> <dl class="command_description"> <!-- Note Section BEGIN --> <!-- Note Section END --> </dl>" to "") |
Lou Montana (talk | contribs) 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 | {{Function | ||
| arma3 | | arma3 | ||
|1.08 | |1.08 | ||
|gr1 = Sound | |gr1 = Sound | ||
| Plays music, depending on the player group status. | | Plays music, depending on the player group status. | ||
{{Informative|If no music classes are given, the function will get them from config automatically.}} | {{Informative|If no music classes are given, the function will get them from config automatically.}} | ||
| [function, parameters] call [[BIS_fnc_jukebox]] | | [function, parameters] call [[BIS_fnc_jukebox]] | ||
|p1= function: [[String]] - (Optional, default "initialize") can be one of: | |p1= function: [[String]] - (Optional, default "initialize") can be one of: | ||
| Line 29: | Line 29: | ||
* "isSafe" | * "isSafe" | ||
* "onEachFrame" | * "onEachFrame" | ||
| | ||
|p2= parameters: [[Array]] - (Optional) | |p2= parameters: [[Array]] - (Optional) | ||
| Line 55: | Line 55: | ||
* '''"isCombat"''': none | * '''"isCombat"''': none | ||
* '''"isSafe"''': none | * '''"isSafe"''': none | ||
* '''"onEachFrame"''': none | * '''"onEachFrame"''': none | ||
| | | | ||
| Line 80: | Line 80: | ||
** "forceBehaviour" | ** "forceBehaviour" | ||
** "playMusic" | ** "playMusic" | ||
** "onEachFrame" | ** "onEachFrame" | ||
|x1= <code>[] [[call]] [[BIS_fnc_jukebox]];</code> | |x1= <code>[] [[call]] [[BIS_fnc_jukebox]];</code> | ||
| [[playMusic]], [[BIS_fnc_music]] | | [[playMusic]], [[BIS_fnc_music]] | ||
}} | }} | ||
Revision as of 23:11, 17 January 2021
Description
Syntax
- Syntax:
- [function, parameters] call BIS_fnc_jukebox
- Parameters:
- function: String - (Optional, default "initialize") can be one of:
- "initialize"
- "terminate"
- "readContainerFromConfig"
- "isInitialized"
- "forceBehaviour"
- "status"
- "randomMusic"
- "selectMusic"
- "playMusic"
- "nearEnemies"
- "hasContact"
- "isContact"
- "isStealth"
- "isCombat"
- "isSafe"
- "onEachFrame"
- parameters: Array - (Optional)
- "initialize": [stealthMusics, combatMusics, safeMusics, volume, transition, radius, executionRate, noRepeat]
- "terminate": none
- "readContainerFromConfig": [wantedTheme]
- "isInitialized": none
- "forceBehaviour": [behaviour]
- behaviour: String - can be "stealth", "combat" or "safe". Any other value will reset the forced behaviour.
- "status": none
- "randomMusic": [container]
- "selectMusic": none
- "playMusic": [musicName]
- musicName: String
- "nearEnemies": none
- "hasContact": none
- "isContact": none
- "isStealth": none
- "isCombat": none
- "isSafe": none
- "onEachFrame": none
- Return Value:
-
- Array for:
- "readContainerFromConfig"
- "nearEnemies" - a list of enemies nearby
- Boolean for:
- "isInitialized"
- "hasContact"
- "isContact"
- "isStealth"
- "isCombat"
- "isSafe"
- String for:
- "status" - can be "stealth", "combat", "safe" or "error"
- "randomMusic" - one of the available musics
- "selectMusic"
- Nothing for:
- "initialize"
- "terminate"
- "forceBehaviour"
- "playMusic"
- "onEachFrame"
- Array for:
Examples
- Example 1:
[] call BIS_fnc_jukebox;
Additional Information
- See also:
- playMusicBIS_fnc_music
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