Difference between revisions of "name"

From Bohemia Interactive Community
Jump to navigation Jump to search
(name cannot be used on a vehicle)
m (Text replacement - "[[Category:Scripting Commands ArmA|" to "[[Category:Scripting Commands Armed Assault|")
 
(11 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command|Comments=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| ofp |= Game name
+
| ofp |Game name=
  
|1.00|= Game version
+
|1.00|Game version=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
 
| 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 [[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.
+
When argument is [[Location]], the location's name is returned. To return the textual value of a location use [[text]] command instead.<br><br>
 
+
{{Feature arma3 | [[setName]] can be used on a person to set [[name]]. However in multiplayer [[name]] always returns [[profileName]].}}|DESCRIPTION=
<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
+
| [[name]] object |SYNTAX=
  
|p1= object: [[Object]]|= Parameter 1
+
|p1= object: [[Object]] |PARAMETER1=
  
| [[String]] |= Return value
+
| [[String]] |RETURNVALUE=
  
| s2= '''name''' location |= Syntax
+
|s2= [[name]] location |Alternative syntax=
  
|p21= location: [[Location]] |= Parameter 1
+
|p21= location: [[Location]] |PARAMETER2=
  
| r2= [[String]] |= Return value
+
|r2= [[String]] |RETURNVALUE2=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
 
   
 
   
|x1= <code>_locationName = [[name]] myLocation;</code> |= Example 1
+
|x1= <code>_name = [[name]] [[player]];</code> |EXAMPLE1=
|x2= <code>[[name]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "Hill"]; //""
+
 
[[text]] [[nearestLocation]] <nowiki>[</nowiki>[[position]] [[player]], "Hill"]; //"Lesnoy Khrebet"</code> |= Example 2
+
|x2= <code>_locationName = [[name]] myLocation;</code> |EXAMPLE2=
 +
 
 +
|x3= <code>[[name]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "Hill"]; {{cc|""}}
 +
[[text]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "Hill"]; {{cc|"Lesnoy Khrebet"}}</code> |EXAMPLE3=
 
____________________________________________________________________________________________
 
____________________________________________________________________________________________
  
| [[profileName]], [[setName]], [[nameSound]], [[setNameSound]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]]|= See also
+
| [[profileName]], [[setName]], [[nameSound]], [[setNameSound]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]]|SEEALSO=
 
 
 
}}
 
}}
  
Line 39: Line 40:
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
  
<dt class="note">'''[[User:kju|kju]]'''
+
<dt class="note">[[User:kju|kju]]
 
<dd class="note">[[Location]] variant appears to be only for the 3d editor.
 
<dd class="note">[[Location]] variant appears to be only for the 3d editor.
  
Line 48: Line 49:
  
 
<dd class="notedate">Posted on August 4, 2006 - 10:56
 
<dd class="notedate">Posted on August 4, 2006 - 10:56
<dt class="note">'''[[User:Hardrock|hardrock]]'''<dd class="note">''Notes from before the conversion:''
+
<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 class="notedate">Posted on December 15, 2006 - 05:27
 
<dd class="notedate">Posted on December 15, 2006 - 05:27
<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:  
+
<dt class="note">[[User:Kronzky|Kronzky]]
hint format["Unit's name: %1",_unitobject]
+
<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:  
 +
<code>[[hint]] [[format]] ["Unit's name: %1", _unitobject];</code>
  
 
<dd class="notedate">Posted on April 14, 2009
 
<dd class="notedate">Posted on April 14, 2009
<dt class="note">'''[[User:Alef|alef]]'''
+
<dt class="note">[[User:Alef|alef]]
<dd class="note">Will return
+
<dd class="note">Will return <tt>Error: No vehicle</tt> for [[JIP]] players in [[init.sqf]], if no [[sleep]] were performed
Error: No vehicle
 
for JIP players in init.sqf, if no [[sleep]] were performed
 
 
<!-- Note Section END -->
 
<!-- Note Section END -->
 
</dl>
 
</dl>
Line 67: Line 68:
  
  
[[Category:Scripting Commands|NAME]]
+
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
 +
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|NAME]]
+
[[Category:Scripting Commands Armed Assault|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|NAME]]
+
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|NAME]]
 
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
 
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
 
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{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}}}}]]
 
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Editor_Control|{{uc:{{PAGENAME}}}}]]
 

Latest revision as of 20:05, 3 June 2020

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.

Arma 3 logo black.png
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 and discuss on the Arma Discord or on the Forums.

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