BIS fnc jukebox: Difference between revisions
Jump to navigation
Jump to search
Lou Montana (talk | contribs) m (Text replacement - " \| *(\[[a-zA-Z,. ]*\] call ('''|\[\[)?BI(N|S)_fnc_[a-zA-Z]+('''|\]\])?) * \|p1=" to " |s1=$1 |p1=") |
Lou Montana (talk | contribs) m (Some wiki formatting) |
||
Line 1: | Line 1: | ||
{{RV|type=function | {{RV|type=function | ||
| arma3 | |game1= arma3 | ||
|version1= 1.08 | |||
|1.08 | |||
|gr1= Sound | |gr1= Sound | ||
| Plays music, depending on the player group status. | |descr= Plays music, depending on the player group status. | ||
{{Feature|Informative|If no music classes are given, the function will get them from config automatically.}} | {{Feature|Informative|If no music classes are given, the function will get them from config automatically.}} | ||
|s1=[function, parameters] call [[BIS_fnc_jukebox]] | |s1= [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: | ||
{{Columns|4| | |||
* "initialize" | * "initialize" | ||
* "terminate" | * "terminate" | ||
Line 29: | Line 29: | ||
* "isSafe" | * "isSafe" | ||
* "onEachFrame" | * "onEachFrame" | ||
}} | |||
|p2= parameters: [[Array]] - (Optional) | |p2= parameters: [[Array]] - (Optional) | ||
Line 57: | Line 57: | ||
* '''"onEachFrame"''': none | * '''"onEachFrame"''': none | ||
| | |r1= | ||
* [[Array]] for: | * [[Array]] for: | ||
** "readContainerFromConfig" | ** "readContainerFromConfig" |
Revision as of 04:56, 13 June 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