BIS fnc variableSpaceAdd: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision)
m (pf)
Line 1: Line 1:
 
{{Function|Comments=
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________


| arma2 |= Game name
| arma2 |Game name=


|1.00|= Game version
|1.00|Game version=
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>
|Add element to variable from someone's variable space.|Description=
/*
____________________________________________________________________________________________
File: variableSpaceAdd.sqf


Description:
| [object,varName,element,global,inArray] call [[BIS_fnc_variableSpaceAdd]] |Syntax=
Add element to variable from someone's variable space.


Parameter(s):
|p1=object: [[Object]] - Owner of variable space |Parameter 1=
_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:
|p2=varName: [[String]] - Name of variable |Parameter 2=
ANYTHING - updated variable


*/
|p3=element: [[Anything]] - Element which will be added (must be of same type as variable) |Parameter 3=
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_variableSpaceAdd]]; --> |= Syntax
|p4=global: [[Boolean]] - (Optional, default [[false]]) [[True]] to save modified variable globally]] |Parameter 4=


|p1= |= Parameter 1
|p5=inArray: [[Boolean]] - (Optional, default [[false]]) [[True]] to check if element is already in variable (only for [[Array|arrays]]) |Parameter 5=


| |= Return value
| [[Anything]] - Updated variable|Return value=
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[ [[player]],"someVar",1337,[[true]],[[true]] ] [[call]] [[BIS_fnc_variableSpaceAdd]];</code>|Example 1=
 
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[BIS_fnc_variableSpaceRemove]] |See also=
 
}}
}}


Revision as of 23:13, 27 June 2018

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

Description

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

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

Notes

Bottom Section

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