setVehicleVarName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "\| *((\[\[[a-zA-Z0-9_ |()]+\]\],? ?)+) * \}\}" to "|seealso= $1 }}")
(formatting and cleanup)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| arma1
|game1= arma1


|1.00
|version1= 1.00
 
|game2= arma2
 
|version2= 1.00
 
|game3= arma2oa
 
|version3= 1.51
 
|game4= tkoh
 
|version4= 1.00
 
|game5= arma3
 
|version5= 0.50


|arg= global
|arg= global
Line 11: Line 27:
|gr1= Object Manipulation
|gr1= Object Manipulation


| Sets string representation of an object to a custom string. For example it is possible to return "MyFerrari" instead of default "ce06b00# 164274: offroad_01_unarmed_f.p3d" when querying object as string:  
|descr= Sets string representation of an object to a custom string. For example it is possible to return "MyFerrari" instead of default "ce06b00# 164274: offroad_01_unarmed_f.p3d" when querying object as string:  
<code>[[hint]] [[str]] _offroad; //MyFerrari</code>
<code>[[hint]] [[str]] _offroad; //MyFerrari</code><br>
When a vehicle is created and named in the editor, the name becomes both the variable containing the vehicle object and the string representation of the vehicle object. [[vehicleVarName]] on the other hand is only string representation of the object. So if you want to refer to the actual object by its [[vehicleVarName]], an extra step needed to assign the object to a variable of the same name. For example to see and refer to offroad as myFerrari:
When a vehicle is created and named in the editor, the name becomes both the variable containing the vehicle object and the string representation of the vehicle object. In scripts an extra step is needed to achieve the same effect. See [[{{PAGENAME}}#Example_1|Example 1]].
<code>_offroad [[setVehicleVarName]] "MyFerrari";
 
MyFerrari {{=}} _offroad;</code>
{{Feature|arma3|This does not work with [[Arma 3: Simple Objects]].}}
In multiplayer environment [[setVehicleVarName]] has to be executed on every PC if you want the custom name to be known everywhere. If vehicle is created and named in the editor, the vehicle name will be known globally automatically. <br>
 
To reset [[vehicleVarName]] and [[str]] representation of the object to original form set [[vehicleVarName]] to an empty string:
|mp= In multiplayer environment [[setVehicleVarName]] has to be executed on every PC if you want the custom name to be known everywhere. If vehicle is created and named in the editor, the vehicle name will be known globally automatically.
<code>_offroad [[setVehicleVarName]] "";</code>


| object''' setVehicleVarName''' name
|s1= object '''setVehicleVarName''' name


|p1= object: [[Object]]
|p1= object: [[Object]]
Line 26: Line 41:
|p2= name: [[String]]
|p2= name: [[String]]


| [[Nothing]]
|r1= [[Nothing]]
   
   
|x1= <code>[[player]] [[setVehicleVarName]] "aP";
|x1= <code>[[player]] [[setVehicleVarName]] "aP";{{cc|Change the string representation and assign it to a variable to work with}}
aP = [[player]];</code>
aP = [[player]];</code>
|mp= Execute on every client
|seealso= [[vehicleVarName]] [[BIS_fnc_objectVar]]
}}


|x2= <code>_offroad [[setVehicleVarName]] ""; {{cc|Reset string representation to the default value}}</code>


{{GameCategory|ofpe|Scripting Commands}}
|seealso= [[vehicleVarName]] [[BIS_fnc_objectVar]]
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}


<!-- CONTINUE Notes -->
}}
<dl class="command_description">
<dd class="notedate">Posted on November 4, 2019 - 10:03 (UTC)</dd>
<dt class="note">[[User:DrSova|DrSova]]</dt>
<dd class="note">
Doesn't work with simple objects
</dd>
</dl>
<!-- DISCONTINUE Notes -->

Revision as of 10:39, 28 March 2021

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

Description

Description:
Sets string representation of an object to a custom string. For example it is possible to return "MyFerrari" instead of default "ce06b00# 164274: offroad_01_unarmed_f.p3d" when querying object as string: hint str _offroad; //MyFerrari
When a vehicle is created and named in the editor, the name becomes both the variable containing the vehicle object and the string representation of the vehicle object. In scripts an extra step is needed to achieve the same effect. See Example 1.
Arma 3
This does not work with Arma 3: Simple Objects.
Multiplayer:
In multiplayer environment setVehicleVarName has to be executed on every PC if you want the custom name to be known everywhere. If vehicle is created and named in the editor, the vehicle name will be known globally automatically.
Groups:
Object Manipulation

Syntax

Syntax:
object setVehicleVarName name
Parameters:
object: Object
name: String
Return Value:
Nothing

Examples

Example 1:
player setVehicleVarName "aP";// Change the string representation and assign it to a variable to work with aP = player;
Example 2:
_offroad setVehicleVarName ""; // Reset string representation to the default value

Additional Information

See also:
vehicleVarName 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
Retrieved from "https://community.bistudio.com/wiki?title=setVehicleVarName&oldid=251938"