BIS fnc variableSpaceAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Some wiki formatting)
 
(25 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma2
____________________________________________________________________________________________
|version1= 1.00


| arma2 |= Game name
|game2= arma2oa
|version2= 1.50


|1.00|= Game version
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| <pre>
|game4= arma3
/*
|version4= 0.50
File: variableSpaceAdd.sqf


Description:
|gr1= Variables
Add element to variable from someone's variable space.


Parameter(s):
|descr= Add element to variable from someone's variable space.
_this select 0: OBJECT - owner of variable space
_this select 1: STRING - Name of variable
_this select 2: ANYTHING - element which will be added (must be of same type as variable)
_this select 3: BOOLEAN - optional - True if modified variable will be saved globally.
_this select 4: BOOLEAN - optional - True if you want to check whether element is already in variable (only for arrays).


Returned values:
|s1= [object, varName, element, global, inArray] call [[BIS_fnc_variableSpaceAdd]]
ANYTHING - updated variable


*/
|p1= object: [[Object]] - owner of variable space
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_variableSpaceAdd]]; --> |= Syntax
|p2= varName: [[String]] - name of variable


|p1= |= Parameter 1
|p3= element: [[Anything]] - element which will be added (must be of same type as variable)


| |= Return value
|p4= global: [[Boolean]] - (Optional, default [[false]]) [[true]] to save modified variable globally
____________________________________________________________________________________________


|x1= <code></code> |=
|p5= inArray: [[Boolean]] - (Optional, default [[false]]) [[true]] to check if element is already in variable (only for [[Array]]s)
____________________________________________________________________________________________


| |= See also
|r1= [[Anything]] - updated variable


|x1= <sqf>[player, "someVar", 1337, true, true] call BIS_fnc_variableSpaceAdd;</sqf>
|seealso= [[BIS_fnc_variableSpaceRemove]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Variables|{{uc:variableSpaceAdd}}]]
[[Category:Functions|{{uc:variableSpaceAdd}}]]
[[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"