Difference between revisions of "name"

From Bohemia Interactive Community
Jump to navigation Jump to search
m
m (template:command argument fix)
(21 intermediate revisions by 10 users not shown)
Line 7: Line 7:
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| The name given to a unit using the [[setIdentity]] instruction or selected randomly by the game engine if [[setIdentity]] has not been used on the unit.
+
| When argument is [[Object]], the command returns the name given to a unit using the [[setIdentity]] instruction or selected randomly by the game engine if [[setIdentity]] has not been used on the unit. If used on vehicle, name of first crew member (in order commander, driver, gunner). If used on an object, "Error: No unit" is being returned.<br>
 +
When argument is [[Location]], the location's name is returned. To return the textual value of a location use [[text]] command instead.
  
−
If used on vehicle, name of first crew member (in order commander, driver, gunner).
+
<br><br>'''NOTE:''' In Arma 3 [[setName]] can be used on a person to set [[name]]. However in multiplayer [[name]] always returns [[profileName]]. |DESCRIPTION=
 +
____________________________________________________________________________________________
 +
 
 +
| '''name''' object |SYNTAX=
 +
 
 +
|p1= object: [[Object]]|PARAMETER1=
  
−
If used on an object, "Error: No unit" is being returned. |= Description
+
| [[String]] |RETURNVALUE=
−
____________________________________________________________________________________________
 
  
−
| [[String]] <nowiki>=</nowiki> '''name''' object |= Syntax
+
| s2= '''name''' location |SYNTAX=
  
−
|p1= object: [[Object]] |= Parameter 1
+
|p21= location: [[Location]] |PARAMETER1=
  
−
| [[String]] |= Return value
+
| r2= [[String]] |RETURNVALUE=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
−
|x1= <code>_name <nowiki>=</nowiki> '''name''' [[vehicle]] [[player]]</code> |= Example 1
+
|x1= <code>_name = [[name]] [[player]];</code> |EXAMPLE1=
 +
|x2= <code>_locationName = [[name]] myLocation;</code> |EXAMPLE2=
 +
|x3= <code>[[name]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "Hill"]; //""
 +
[[text]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "Hill"]; //"Lesnoy Khrebet"</code> |EXAMPLE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
−
| |= See also
+
| [[profileName]], [[setName]], [[nameSound]], [[setNameSound]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]]|SEEALSO=
  
 
}}
 
}}
Line 32: Line 40:
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
  
−
<dd class="notedate">Posted on August 4, 2006 - 10:56</dd>
+
<dt class="note">'''[[User:kju|kju]]'''
−
<dt class="note">'''[[User:Hardrock|hardrock]]'''</dt><dd class="note">''Notes from before the conversion:''
+
<dd class="note">[[Location]] variant appears to be only for the 3d editor.
 +
 
 +
<!-- Note Section END -->
 +
</dl>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
 +
 
 +
<dd class="notedate">Posted on August 4, 2006 - 10:56
 +
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''Notes from before the conversion:''
  
 
Name will return an error for units that have been dead for more than a few seconds.
 
Name will return an error for units that have been dead for more than a few seconds.
−
</dd>
+
 
−
<dd class="notedate">Posted on December 15, 2006 - 05:27</dd>
+
<dd class="notedate">Posted on December 15, 2006 - 05:27
−
<dt class="note">'''[[User:Kronzky|Kronzky]]'''</dt><dd class="note">To return the name of the unit that was given in the editor's "name" field, call up the unit's object in a format statement:  
+
<dt class="note">'''[[User:Kronzky|Kronzky]]'''<dd class="note">To return the name of the unit that was given in the editor's "name" field, call up the unit's object in a format statement:  
−
  hint format["Unit's name: %1",_unitobject]</dd>
+
  hint format["Unit's name: %1",_unitobject]
 +
 
 +
<dd class="notedate">Posted on April 14, 2009
 +
<dt class="note">'''[[User:Alef|alef]]'''
 +
<dd class="note">Will return
 +
Error: No vehicle
 +
for JIP players in init.sqf, if no [[sleep]] were performed
 
<!-- Note Section END -->
 
<!-- Note Section END -->
 
</dl>
 
</dl>
Line 47: Line 69:
  
 
[[Category:Scripting Commands|NAME]]
 
[[Category:Scripting Commands|NAME]]
 +
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.96|NAME]]
 
[[Category:Scripting Commands OFP 1.96|NAME]]
 
[[Category:Scripting Commands OFP 1.46|NAME]]
 
[[Category:Scripting Commands OFP 1.46|NAME]]
 
[[Category:Scripting Commands ArmA|NAME]]
 
[[Category:Scripting Commands ArmA|NAME]]
 +
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
 
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]

Revision as of 15:44, 7 April 2019

Introduced with Operation Flashpoint version 1.001.00
Hover & click on the images for descriptions

Description

Description:
When argument is Object, the command returns the name given to a unit using the setIdentity instruction or selected randomly by the game engine if setIdentity has not been used on the unit. If used on vehicle, name of first crew member (in order commander, driver, gunner). If used on an object, "Error: No unit" is being returned.
When argument is Location, the location's name is returned. To return the textual value of a location use text command instead.

NOTE: In Arma 3 setName can be used on a person to set name. However in multiplayer name always returns profileName.

Syntax

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

Alternative Syntax

Syntax:
name location
Parameters:
location: Location
Return Value:
String

Examples

Example 1:
_name = name player;
Example 2:
_locationName = name myLocation;
Example 3:
name nearestLocation [position player, "Hill"]; //"" text nearestLocation [position player, "Hill"]; //"Lesnoy Khrebet"

Additional Information

See also:
profileNamesetNamenameSoundsetNameSoundcreateLocationdeleteLocationdrawLocationlocationPositionlocationNullnearestLocationnearestLocationsnearestLocationWithDubbing

Notes

i
Only post proven facts here. Report bugs on the feedback tracker. Use the Talk page or the Forums for discussions.

Add New Note | How To

Notes

kju
Location variant appears to be only for the 3d editor.
Posted on August 4, 2006 - 10:56
hardrock
Notes from before the conversion: Name will return an error for units that have been dead for more than a few seconds.
Posted on December 15, 2006 - 05:27
Kronzky
To return the name of the unit that was given in the editor's "name" field, call up the unit's object in a format statement: hint format["Unit's name: %1",_unitobject]
Posted on April 14, 2009
alef
Will return Error: No vehicle for JIP players in init.sqf, if no sleep were performed

Bottom Section

Retrieved from "https://community.bistudio.com/wiki?title=name&oldid=122145"