vehicleVarName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " be local" to " be local")
No edit summary
 
(12 intermediate revisions by 3 users not shown)
Line 17: Line 17:


|arg= global
|arg= global
|eff= local


|gr1= Object Manipulation
|gr1= Object Manipulation


|descr= Returns the variable name that contains a primary editor reference to this object. This is the variable given in the ''Insert Unit dialog / name field'' in the editor. It can be changed using [[setVehicleVarName]]. <br>
|descr= Returns the variable name that contains a primary editor reference to this object. This is the variable given in the ''Insert Unit dialog / name field'' in the editor. It can be changed using [[setVehicleVarName]].


|mp= Since it is possible to [[setVehicleVarName]] individually on each PC, the value of [[vehicleVarName]] returned will be [[Multiplayer Scripting#Locality|local]] to the PC on which command is executed.
{{Feature|informative|Respawned unit will have the same vehicleVarName as the corpse left behind, however actual [[missionNamespace]] variable of the same name will only contain respawned unit.}}


|s1= [[vehicleVarName]] object
|s1= [[vehicleVarName]] object
Line 30: Line 28:
|p1= object: [[Object]]
|p1= object: [[Object]]


|r1= [[String]] - Variable name, if none was set, {{ic|""}} is returned
|r1= [[String]] - variable name, if none was set, an empty string is returned


|x1= <code>[[hint]] [[vehicleVarName]] [[player]];</code>
|x1= <sqf>hint vehicleVarName player;</sqf>


|seealso= [[setVehicleVarName]] [[BIS_fnc_objectVar]]
|seealso= [[setVehicleVarName]] [[BIS_fnc_objectVar]]
}}
}}


<dl class="command_description">
{{Note
 
|user= Killzone_Kid
<dt></dt>
|timestamp= 20150419084500
<dd class="notedate">Posted on April 19, 2015 - 08:45 (UTC)</dd>
|text= To get variable names referencing an object in mission namespace:
<dt class="note">[[User:Killzone Kid|Killzone Kid]]</dt>
<sqf>
<dd class="note">
KK_fnc_objectVarNames = {
To get variable names referencing an object in mission namespace:
private "_names";
<code>KK_fnc_objectVarNames <nowiki>=</nowiki> {
_names = [];
[[private]] "_names";
_names <nowiki>=</nowiki> [];
{
{
[[if]] ([[missionNamespace]] [[getVariable]] _x [[isEqualTo]] _this) [[then]] {
if (missionNamespace getVariable _x isEqualTo _this) then {
_names [[pushBack]] _x;
_names pushBack _x;
};
};
} [[forEach]] [[allVariables]] [[missionNamespace]];
} forEach allVariables missionNamespace;
_names
_names
};
};


{{cc|Example}}
// Example
myGroup <nowiki>=</nowiki> [[group]] [[player]];
myGroup = group player;
aGroup <nowiki>=</nowiki> [[group]] [[player]];
aGroup = group player;
[[hint]] [[str]] ([[group]] [[player]] [[call]] KK_fnc_objectVarNames); //["agroup","mygroup"]</code>
hint str (group player call KK_fnc_objectVarNames); // ["agroup", "mygroup"]
</dd>
</sqf>
 
}}
</dl>

Latest revision as of 20:33, 28 February 2024

Logo A1 black.png1.00Logo A2.png1.00A2 OA Logo.png1.50tkoh logo small.png1.00Arma 3 logo black.png0.50
GAGlobal
Hover & click on the images for description

Description

Description:
Returns the variable name that contains a primary editor reference to this object. This is the variable given in the Insert Unit dialog / name field in the editor. It can be changed using setVehicleVarName.
ⓘ
Respawned unit will have the same vehicleVarName as the corpse left behind, however actual missionNamespace variable of the same name will only contain respawned unit.
Groups:
Object Manipulation

Syntax

Syntax:
vehicleVarName object
Parameters:
object: Object
Return Value:
String - variable name, if none was set, an empty string is returned

Examples

Example 1:
hint vehicleVarName player;

Additional Information

See also:
setVehicleVarName BIS_fnc_objectVar

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
Killzone_Kid - c
Posted on Apr 19, 2015 - 08:45 (UTC)
To get variable names referencing an object in mission namespace:
KK_fnc_objectVarNames = { private "_names"; _names = []; { if (missionNamespace getVariable _x isEqualTo _this) then { _names pushBack _x; }; } forEach allVariables missionNamespace; _names }; // Example myGroup = group player; aGroup = group player; hint str (group player call KK_fnc_objectVarNames); // ["agroup", "mygroup"]
Retrieved from "https://community.bistudio.com/wiki?title=vehicleVarName&oldid=352868"