BIS fnc objectVar: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Fix example)
m (Text replacement - "= <code>([^<{]+)<\/code>" to "= <sqf>$1</sqf>")
 
(25 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Function|Comments=
{{RV|type=function
____________________________________________________________________________________________


| arma3 |Game name=
|game1= arma3
|version1= 1.00


|1.00|Game version=
|gr1= Object Manipulation
____________________________________________________________________________________________


| Return a unique object variable. The variable is preserved after unit respawn. |Description=
|descr= Return a unique object variable. The variable is preserved after unit respawn.
____________________________________________________________________________________________


| [object'', varNameRoot''] call [[BIS_fnc_objectVar]] |Syntax=
|s1= [object, varNameRoot] call [[BIS_fnc_objectVar]]


|p1= object: [[Object]] |Parameter 1=
|p1= object: [[Object]]


|p2= varNameRoot: [[String]] - (Optional, default "bis_o") - variable name root - a number will be added behind it |Parameter 2=
|p2= varNameRoot: [[String]] - (Optional, default "bis_o") - variable name root - a number will be added behind it


| [[String]] - generated variable name |Return value=
|r1= [[String]] - generated variable name
____________________________________________________________________________________________


|x1= <code>[[hint]] [[str]] ([[player]] [[call]] [[BIS_fnc_objectVar]]); {{codecomment|// "bis_o1"}}
|x1= <sqf>hint str (player call BIS_fnc_objectVar); // "bis_o1"
[[hint]] [[str]] ([[player]] == ([[missionNamespace]] [[getVariable]] "bis_o1")); {{codecomment|// true}}</code> |Example 1=
hint str (player == (missionNamespace getVariable "bis_o1")); // true</sqf>
____________________________________________________________________________________________


| [[netId]], [[objectFromNetId]], [[setVariable]], [[setVehicleVarName]] |See also=
|seealso= [[netId]] [[objectFromNetId]] [[setVariable]] [[setVehicleVarName]]
}}
}}
<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:Functions|{{uc:objectVar}}]]
[[Category:Function Group: Objects|{{uc:objectVar}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:objectVar}}]]

Latest revision as of 17:00, 13 July 2022

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Return a unique object variable. The variable is preserved after unit respawn.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[object, varNameRoot] call BIS_fnc_objectVar
Parameters:
object: Object
varNameRoot: String - (Optional, default "bis_o") - variable name root - a number will be added behind it
Return Value:
String - generated variable name

Examples

Example 1:
hint str (player call BIS_fnc_objectVar); // "bis_o1" hint str (player == (missionNamespace getVariable "bis_o1")); // true

Additional Information

See also:
netId objectFromNetId setVariable setVehicleVarName

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_objectVar&oldid=328361"