Difference between revisions of "name"

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - "<h3 style="display:none">Bottom Section</h3> " to "")
 
(34 intermediate revisions by 7 users not shown)
Line 1: Line 1:
{{Command|= Comments
+
{{Command
____________________________________________________________________________________________
 
  
| ofp |= Game name
+
| ofp
  
|1.00|= Game version
+
|1.00
____________________________________________________________________________________________
 
  
| 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. Since Arma 3 [[setName]] can be used on a person to set [[name]].
+
|gr1= Unit Identity
  
If used on vehicle, name of first crew member (in order commander, driver, gunner).
+
|gr2= Locations
  
If used on an object, "Error: No unit" is being returned. |= 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.<br>
____________________________________________________________________________________________
+
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]].}}
  
| [[String]] <nowiki>=</nowiki> '''name''' object |= Syntax
+
| [[name]] object
  
|p1= object: [[Object]] or [[Location]]|= Parameter 1
+
|p1= object: [[Object]]
  
| [[String]] |= Return value
+
| [[String]]
____________________________________________________________________________________________
+
 
 +
|s2= [[name]] location |Alternative syntax=
 +
 
 +
|p21= location: [[Location]]
 +
 
 +
|r2= [[String]]
 
   
 
   
|x1= <code>_name <nowiki>=</nowiki> '''name''' [[vehicle]] [[player]]</code> |= Example 1
+
|x1= <code>_name = [[name]] [[player]];</code>
____________________________________________________________________________________________
 
  
| [[profileName]], [[setName]] |= See also
+
|x2= <code>_locationName = [[name]] myLocation;</code>
  
 +
|x3= <code>[[name]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "Hill"]; {{cc|""}}
 +
[[text]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "Hill"]; {{cc|"Lesnoy Khrebet"}}</code>
 +
 +
| [[profileName]], [[setName]], [[nameSound]], [[setNameSound]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]]
 
}}
 
}}
  
 
<h3 style="display:none">Notes</h3>
 
<h3 style="display:none">Notes</h3>
 +
<dl class="command_description">
 +
<!-- Note Section BEGIN -->
 +
 +
<dt class="note">[[User:kju|kju]]
 +
<dd class="note">[[Location]] variant appears to be only for the 3d editor.
 +
 +
<!-- Note Section END -->
 +
</dl>
 
<dl class="command_description">
 
<dl class="command_description">
 
<!-- Note Section BEGIN -->
 
<!-- Note Section BEGIN -->
  
 
<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 [[Multiplayer Scripting#Join In Progress|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>
  
<h3 style="display:none">Bottom Section</h3>
 
  
  
[[Category:Scripting Commands|NAME]]
+
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.96|NAME]]
+
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands OFP 1.46|NAME]]
+
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA|NAME]]
+
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma2|Scripting Commands}}
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|arma3|Scripting Commands}}
[[Category:Command_Group:_Object_Information|{{uc:{{PAGENAME}}}}]]
+
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 01:44, 18 January 2021

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
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
Groups:
Unit IdentityLocations

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