BIS fnc sceneCheckWeapons: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "|= Game name" to "|Game name=")
m (filled page)
Line 1: Line 1:
{{Function


{{Function|Comments=
|game1= arma2
____________________________________________________________________________________________


| arma2 |Game name=
|version1= 1.00


|1.00|Game version=
<!--|exec= server|=-->
____________________________________________________________________________________________


| <pre>
<!--|arg= local-->
/**************************************************************************************************************************
Version: 1.0
Name: CheckWeaponsBefore scene
DESCRIPTION: Checks if participants haven't missing weapon or haven't it selected before scene
Function works as toggle -  
1st run of script: running in SETUP mode - sets correct weapons for scene
2nd run of script: running in RESTORE mode - restore origin weapons(delete weapons after scene if character hadn't any)
There is default SETUP: [[BIS_Cooper, "primary"],[BIS_Ohara, "primary"],[BIS_Rodriguez, "primary"],[BIS_Sykes, "primary"],[BIS_Miles, "primary"]]
 
PARAMETERS: _participants: ARRAY of arrays in format [[character1, "typeofweapon"],[character2, "typeofweapon"],..,[characterx, "typeofweapon"]]
where character is for example BIS_Cooper and typeofweapon is one of primary/pistol
RETURNED VALUE: nothing
****************************************************************************************************************************/


</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |DESCRIPTION=
<!--|eff= local-->
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_sceneCheckWeapons]]; --> |SYNTAX=
|descr= Checks if participants haven't missing weapon or haven't it selected before scene<br>Function works as toggle -  
  <br>1st run of script: running in SETUP mode - sets correct weapons for scene<br>
  2nd run of script: running in RESTORE mode - restore origin weapons(delete weapons after scene if character hadn't any)


|p1= |PARAMETER1=
||s1= [participants] call [[BIS_fnc_sceneCheckWeapons]]|=Syntax


| |RETURNVALUE=
|p1= participants: [[Array]] - (Optional, default [[BIS_Cooper, "primary"],[BIS_Ohara, "primary"],[BIS_Rodriguez, "primary"],[BIS_Sykes, "primary"],[BIS_Miles, "primary"]]) An array of arrays in format:<br>
____________________________________________________________________________________________
0: [[Object]] - Unit to check<br>1: [[String]] - Weapon type (primary, pistol)


|x1= <code></code> |=
|r1= [[Nothing]]
____________________________________________________________________________________________


| |SEEALSO=
|x1= <code>[[BIS_Cooper, "primary"],[BIS_Ohara, "primary"],[BIS_Rodriguez, "primary"],[BIS_Sykes, "primary"],[BIS_Miles, "primary"]] [[call]] [[BIS_fnc_sceneCheckWeapons]];</code>
 
|exec= call
 
|seealso=


}}
}}

Revision as of 11:16, 8 January 2020

Logo A2.png1.00
Hover & click on the images for description

Description

Description:
Checks if participants haven't missing weapon or haven't it selected before scene
Function works as toggle -
1st run of script: running in SETUP mode - sets correct weapons for scene
2nd run of script: running in RESTORE mode - restore origin weapons(delete weapons after scene if character hadn't any)
Execution:
call
Groups:
Uncategorised

Syntax

Syntax:
[participants] call BIS_fnc_sceneCheckWeapons
Parameters:
participants: Array - (Optional, default [[BIS_Cooper, "primary"],[BIS_Ohara, "primary"],[BIS_Rodriguez, "primary"],[BIS_Sykes, "primary"],[BIS_Miles, "primary"]]) An array of arrays in format:
0: Object - Unit to check
1: String - Weapon type (primary, pistol)
Return Value:
Nothing

Examples

Example 1:
[[BIS_Cooper, "primary"],[BIS_Ohara, "primary"],[BIS_Rodriguez, "primary"],[BIS_Sykes, "primary"],[BIS_Miles, "primary"]] call BIS_fnc_sceneCheckWeapons;

Additional Information

See also:
See also needed

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_sceneCheckWeapons&oldid=146267"