BIS fnc variableSpaceRemove: 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)
Line 1: Line 1:
{{RV|type=function
{{RV|type=function
| arma2|1.00|gr1= Variables|Remove element from variable from someone's variable space.|s1=[object,varName,element,global,inArray] call [[BIS_fnc_variableSpaceRemove]]


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

Revision as of 05:33, 13 June 2021

Hover & click on the images for description

Description

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

Syntax

Syntax:
[object,varName,element,global,inArray] call BIS_fnc_variableSpaceRemove
Parameters:
object: Object - Owner of variable space
varName: String - Name of variable
element: Anything - Element which will be removed (must be of same type as variable)
global: Boolean - (Optional, default false) true to save modified variable globally]]
Return Value:
Anything - Updated variable

Examples

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

Additional Information

See also:
BIS_fnc_variableSpaceAdd setVariable

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