BIS fnc variableSpaceAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *(\[[a-zA-Z,. ]*\] call ('''|\[\[)?BI(N|S)_fnc_[a-zA-Z]+('''|\]\])?) *\|p1=" to "|s1=$1 |p1=")
m (Some wiki formatting)
 
(8 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function
| arma2|1.00|gr1= Variables|Add element to variable from someone's variable space.|s1=[object,varName,element,global,inArray] call [[BIS_fnc_variableSpaceAdd]]


|p1=object: [[Object]] - Owner of variable space|p2=varName: [[String]] - Name of variable|p3=element: [[Anything]] - Element which will be added (must be of same type as variable)|p4=global: [[Boolean]] - (Optional, default [[false]]) [[true]] to save modified variable globally]]|p5=inArray: [[Boolean]] - (Optional, default [[false]]) [[true]] to check if element is already in variable (only for [[Array|arrays]])| [[Anything]] - Updated variable|x1= <code>[ [[player]],"someVar",1337,[[true]],[[true]] ] [[call]] [[BIS_fnc_variableSpaceAdd]];</code>
|game1= arma2
|version1= 1.00
 
|game2= arma2oa
|version2= 1.50
 
|game3= tkoh
|version3= 1.00
 
|game4= arma3
|version4= 0.50
 
|gr1= Variables
 
|descr= Add element to variable from someone's variable space.
 
|s1= [object, varName, element, global, inArray] call [[BIS_fnc_variableSpaceAdd]]
 
|p1= object: [[Object]] - owner of variable space
 
|p2= varName: [[String]] - name of variable
 
|p3= element: [[Anything]] - element which will be added (must be of same type as variable)
 
|p4= global: [[Boolean]] - (Optional, default [[false]]) [[true]] to save modified variable globally
 
|p5= inArray: [[Boolean]] - (Optional, default [[false]]) [[true]] to check if element is already in variable (only for [[Array]]s)
 
|r1= [[Anything]] - updated variable
 
|x1= <sqf>[player, "someVar", 1337, true, true] call BIS_fnc_variableSpaceAdd;</sqf>
 
|seealso= [[BIS_fnc_variableSpaceRemove]]
|seealso= [[BIS_fnc_variableSpaceRemove]]
}}
}}
[[Category:{{Name|arma2}}: Functions|{{uc:variableSpaceAdd}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:variableSpaceAdd}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:variableSpaceAdd}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:variableSpaceAdd}}]]

Latest revision as of 13:01, 15 January 2023

Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
Hover & click on the images for description

Description

Description:
Add element to variable from someone's variable space.
Execution:
call
Groups:
Variables

Syntax

Syntax:
[object, varName, element, global, inArray] call BIS_fnc_variableSpaceAdd
Parameters:
object: Object - owner of variable space
varName: String - name of variable
element: Anything - element which will be added (must be of same type as variable)
global: Boolean - (Optional, default false) true to save modified variable globally
inArray: Boolean - (Optional, default false) true to check if element is already in variable (only for Arrays)
Return Value:
Anything - updated variable

Examples

Example 1:
[player, "someVar", 1337, true, true] call BIS_fnc_variableSpaceAdd;

Additional Information

See also:
BIS_fnc_variableSpaceRemove

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_variableSpaceAdd&oldid=337310"