BIS fnc variableSpaceRemove: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (pf)
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *U([a-z ])" to "$1 - u$2")
 
(22 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma2 |Game name=
|game1= arma2
|version1= 1.00


|1.00|Game version=
|game2= arma2oa
____________________________________________________________________________________________
|version2= 1.50


|Remove element from variable from someone's variable space.|Description=
|game3= tkoh
____________________________________________________________________________________________
|version3= 1.00


| [object,varName,element,global,inArray] call [[BIS_fnc_variableSpaceRemove]] |Syntax=
|game4= arma3
|version4= 0.50


|p1=object: [[Object]] - Owner of variable space |Parameter 1=
|gr1= Variables


|p2=varName: [[String]] - Name of variable |Parameter 2=
|descr= Remove element from variable from someone's variable space.


|p3=element: [[Anything]] - Element which will be removed (must be of same type as variable) |Parameter 3=
|s1= [object,varName,element,global,inArray] call [[BIS_fnc_variableSpaceRemove]]


|p4=global: [[Boolean]] - (Optional, default [[false]]) [[True]] to save modified variable globally]] |Parameter 4=
|p1= object: [[Object]] - owner of variable space


| [[Anything]] - Updated variable|Return value=
|p2= varName: [[String]] - name of variable
____________________________________________________________________________________________


|x1= <code>[ [[player]],"someVar",1337,[[true]] ] [[call]] [[BIS_fnc_variableSpaceRemove]];</code>|Example 1=
|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


| [[BIS_fnc_variableSpaceAdd]] |See also=
|x1= <sqf>[player, "someVar", 1337, true] call BIS_fnc_variableSpaceRemove;</sqf>
 
|seealso= [[BIS_fnc_variableSpaceAdd]] [[setVariable]]
}}
}}
<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:variableSpaceRemove}}]]
[[Category:Functions|{{uc:variableSpaceRemove}}]]
[[Category:{{Name|arma2}}: Functions|{{uc:variableSpaceRemove}}]]
[[Category:{{Name|arma2oa}}: Functions|{{uc:variableSpaceRemove}}]]
[[Category:{{Name|tkoh}}: Functions|{{uc:variableSpaceRemove}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:variableSpaceRemove}}]]

Latest revision as of 15:52, 8 November 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:
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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_variableSpaceRemove&oldid=349319"