BIS fnc jukebox: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "|= Game name" to "|Game name=")
(8 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Function|Comments=
____________________________________________________________________________________________


{{Function|= Comments
| arma3 |Game name=
 
|1.08|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma3 |= Game name
| Plays music, depending on the player group status.
 
{{Informative|If no music classes are given, the function will get them from config automatically.}} |DESCRIPTION=
|1.00|= Game version
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| [function, parameters] call [[BIS_fnc_jukebox]] |SYNTAX=


Description:
|p1= function: [[String]] - (Optional, default "initialize") can be one of:
Plays music, depending on the player groups status
* "initialize"
* "terminate"
* "readContainerFromConfig"
* "isInitialized"
* "forceBehaviour"
* "status"
* "randomMusic"
* "selectMusic"
* "playMusic"
* "nearEnemies"
* "hasContact"
* "isContact"
* "isStealth"
* "isCombat"
* "isSafe"
* "onEachFrame"
&nbsp;|PARAMETER1=


Parameter(s):
|p2= parameters: [[Array]] - (Optional)
_this select 0: STRING - The sub-function to call
_this select 1: ARRAY - Parameters to be sent to sub-function
Returns:
Dependent on sub-function
*/


#define DEFAULT_VOLUME 0.2
* '''"initialize"''': [stealthMusics, combatMusics, safeMusics, volume, transition, radius, executionRate, noRepeat]
#define DEFAULT_TRANSITION 5
** stealthMusics: [[Array]] of [[String|Strings]]
#define DEFAULT_RADIUS 500
** combatMusics: [[Array]] of [[String|Strings]]
#define DEFAULT_EXECUTIONRATE 5
** safeMusics: [[Array]] of [[String|Strings]]
#define DEFAULT_NOREPEAT true
** volume: [[Number]]
* '''"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]
** container: [[Array]] of [[String|Strings]] - music list to choose from
* '''"selectMusic"''': none
* '''"playMusic"''': [musicName]
** musicName: [[String]]
* '''"nearEnemies"''': none
* '''"hasContact"''': none
* '''"isContact"''': none
* '''"isStealth"''': none
* '''"isCombat"''': none
* '''"isSafe"''': none
* '''"onEachFrame"''': none |PARAMETER2=


//Parameters
|
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
* [[Array]] for:
____________________________________________________________________________________________
** "readContainerFromConfig"
** "nearEnemies" - a list of enemies nearby


| <!-- [] call [[BIS_fnc_jukebox]]; --> |= Syntax
* [[Boolean]] for:
** "isInitialized"
** "hasContact"
** "isContact"
** "isStealth"
** "isCombat"
** "isSafe"


|p1= |= Parameter 1
* [[String]] for:
** "status" - can be "stealth", "combat", "safe" or "error"
** "randomMusic" - one of the available musics
** "selectMusic"


| |= Return value
* [[Nothing]] for:
** "initialize"
** "terminate"
** "forceBehaviour"
** "playMusic"
** "onEachFrame" |RETURNVALUE=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[] [[call]] [[BIS_fnc_jukebox]];</code> |EXAMPLE1=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[playMusic]], [[BIS_fnc_music]] |SEEALSO=
 
}}
}}


Revision as of 23:20, 30 August 2019

Arma 3 logo black.png1.08
Hover & click on the images for description

Description

Description:
Plays music, depending on the player group status.
ⓘ
If no music classes are given, the function will get them from config automatically.
Execution:
call
Groups:
Uncategorised

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]
  • "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"

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

Notes

Bottom Section

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