name: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Some wiki formatting)
(Add specifics about identical names)
Line 26: Line 26:
|gr2= Locations
|gr2= Locations


|descr= 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>
|descr= 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.
When argument is [[Location]], the location's name is returned. To return the textual value of a location use [[text]] command instead.{{Feature | arma3 | [[setName]] can be used on a person to set [[name]]. However in multiplayer [[name]] always returns [[profileName]].}}
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.
 
|mp=  [[name]] returns [[profileName]], eventually suffixed by the server in the event of identical names, e.g {{hl|username}}/{{hl|username (2)}}.
 
|pr= {{Feature|important|If the provided unit is dead and has been removed from its group, its identity has then been purged to save memory and using [[name]] on it will result in a logged error.}}


|s1= [[name]] object
|s1= [[name]] object
Line 36: Line 40:


|s2= [[name]] location
|s2= [[name]] location
|s2since= arma1 1.08


|p21= location: [[Location]]
|p21= location: [[Location]]


|r2= [[String]]
|r2= [[String]] - the location's ''name''. To get its textual value, use [[text]] (see {{Link|#Example 3}})


|x1= <sqf>_name = name player;</sqf>
|x1= <sqf>_name = name player;</sqf>
Line 50: Line 56:
</sqf>
</sqf>


|seealso= [[profileName]] [[setName]] [[nameSound]] [[setNameSound]] [[createLocation]] [[deleteLocation]] [[drawLocation]] [[locationPosition]] [[locationNull]] [[nearestLocation]] [[nearestLocations]] [[nearestLocationWithDubbing]]
|seealso= [[profileName]] [[setName]] [[setIdentity]] [[nameSound]] [[setNameSound]] [[createLocation]] [[deleteLocation]] [[locationPosition]] [[nearestLocation]] [[nearestLocations]] [[nearestLocationWithDubbing]]
}}
}}


<dl class="command_description">
{{Note
|user= Kju
|timestamp= 20170130194200
|text= [[Location]] variant appears to be only for the 3d editor.
}}


<dt class="note">[[User:kju|kju]]</dt>
{{Note
<dd class="note">[[Location]] variant appears to be only for the 3d editor.
|user= Alef
 
|timestamp= 20090414014100
<dt><dt>
|text= Will return {{hl|Error: No vehicle}} for [[Multiplayer Scripting#Join In Progress|JIP]] players in [[init.sqf]], if no [[sleep]] were performed.
<dd class="notedate">Posted on August 4, 2006 - 10:56</dd>
}}
<dt class="note">[[User:Hardrock|hardrock]]</dt>
<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.
<dt><dt>
<dd class="notedate">Posted on December 15, 2006 - 05:27</dd>
<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:
<sqf>hint format ["Unit's name: %1", _unitobject];</sqf>
<dt><dt>
<dd class="notedate">Posted on April 14, 2009</dd>
<dt class="note">[[User:Alef|alef]]</dt>
<dd class="note">Will return {{hl|Error: No vehicle}} for [[Multiplayer Scripting#Join In Progress|JIP]] players in [[init.sqf]], if no [[sleep]] were performed
</dl>

Revision as of 18:45, 20 April 2023

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

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.
Multiplayer:
name returns profileName, eventually suffixed by the server in the event of identical names, e.g username/username (2).
Problems:
⚠
If the provided unit is dead and has been removed from its group, its identity has then been purged to save memory and using name on it will result in a logged error.
Groups:
Unit IdentityLocations

Syntax

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

Alternative Syntax

Syntax:
name location
Parameters:
location: Location
Return Value:
String - the location's name. To get its textual value, use text (see Example 3)

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:
profileName setName setIdentity nameSound setNameSound createLocation deleteLocation locationPosition nearestLocation nearestLocations nearestLocationWithDubbing

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
Kju - c
Posted on Jan 30, 2017 - 19:42 (UTC)
Location variant appears to be only for the 3d editor.
Alef - c
Posted on Apr 14, 2009 - 01:41 (UTC)
Will return Error: No vehicle for JIP players in init.sqf, if no sleep were performed.
Retrieved from "https://community.bistudio.com/wiki?title=name&oldid=338974"