vehicleVarName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
(cleaned up, mp params, example)
Line 5: Line 5:


|1.00|= Game version
|1.00|= Game version
|arg= global |=
|eff= local |= Effects in MP
____________________________________________________________________________________________
____________________________________________________________________________________________


| Returns the name of the variable which 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]]. If ''object'' refers to a vehicle that wasn't given a name in the editor, the return value is an empty string, "".|= Description
| Returns the name of the variable which 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>
If ''object'' refers to a vehicle that wasn't given a name in the editor, the return value is an empty string, "".
<br>Since it is possible to [[setVehicleVarName]] individually on each PC, the value of [[vehicleVarName]] returned will be [[local]] to the PC on which command is executed. |= Description
____________________________________________________________________________________________
____________________________________________________________________________________________


| [[String]] <nowiki>=</nowiki> '''vehicleVarName''' objectName |= Syntax
| '''vehicleVarName''' object |= Syntax


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


| [[String]] |= Return value
| [[String]] |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________
 
|x1= <code>[[hint]] [[vehicleVarName]] [[player]];</code> |= Example 1


| [[setVehicleVarName]], [[isValidVarName_(VBS2)|isValidVarName (VBS2)]]  |= See also
| [[setVehicleVarName]] |= See also


}}
}}

Revision as of 00:32, 24 April 2014

-wrong parameter ("Arma") defined!-1.00
Hover & click on the images for description

Description

Description:
Returns the name of the variable which 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.
If object refers to a vehicle that wasn't given a name in the editor, the return value is an empty string, "".
Since it is possible to setVehicleVarName individually on each PC, the value of vehicleVarName returned will be local to the PC on which command is executed.
Groups:
Uncategorised

Syntax

Syntax:
vehicleVarName object
Parameters:
object: Object
Return Value:
String

Examples

Example 1:
hint vehicleVarName player;

Additional Information

See also:
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

Notes

Bottom Section