name: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Text replacement - " *\| *Alternative [Ss]yntax *[0-9]* *= * " to " ")
No edit summary
 
(47 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{RV|type=command
{{RV|type=command


| ofp
|game1= ofp
|version1= 1.00


|1.00
|game2= ofpe
|version2= 1.00
 
|game3= arma1
|version3= 1.00
 
|game4= arma2
|version4= 1.00
 
|game5= arma2oa
|version5= 1.50
 
|game6= tkoh
|version6= 1.00
 
|game7= arma3
|version7= 0.50


|gr1= Unit Identity
|gr1= Unit Identity
Line 9: Line 26:
|gr2= Locations
|gr2= Locations


| 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.<br><br>
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.
{{Feature|arma3 | [[setName]] can be used on a person to set [[name]]. However in multiplayer [[name]] always returns [[profileName]].}}


| [[name]] object
|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


|p1= object: [[Object]]
|p1= object: [[Object]]


| [[String]]
|r1= [[String]]


|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= <code>_name = [[name]] [[player]];</code>


|x2= <code>_locationName = [[name]] myLocation;</code>
|s3= [[name]] namespace
|s3since= arma3 2.18


|x3= <code>[[name]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "Hill"]; {{cc|""}}
|p41= namespace: [[Namespace]]
[[text]] [[nearestLocation]] [<nowiki/>[[position]] [[player]], "Hill"]; {{cc|"Lesnoy Khrebet"}}</code>


| [[profileName]], [[setName]], [[nameSound]], [[setNameSound]], [[createLocation]], [[deleteLocation]], [[drawLocation]], [[locationPosition]], [[locationNull]], [[nearestLocation]], [[nearestLocations]], [[nearestLocationWithDubbing]]
|r3= [[String]] - namespace's ''name''. Possible values:
}}


<dl class="command_description">
* "mission" - for [[missionNamespace]]
<!-- Note Section BEGIN -->
* "profile" - for [[profileNamespace]]
* "ui" - for [[uiNamespace]]
* "parsing" - for [[parsingNamespace]]
* "local" - for [[localNamespace]]
* "missionprofile" - for [[missionProfileNamespace]]
* "server" - for [[serverNamespace]]
* "" - for some unnamed namespaces like temporary or server config for example.
* "null" - null namespace (this should never happen)


<dt class="note">[[User:kju|kju]]</dt>
|x1= <sqf>_name = name player;</sqf>
<dd class="note">[[Location]] variant appears to be only for the 3d editor.


<!-- Note Section END -->
|x2= <sqf>_locationName = name myLocation;</sqf>
</dl>
<dl class="command_description">
<!-- Note Section BEGIN -->


<dd class="notedate">Posted on August 4, 2006 - 10:56</dd>
|x3= <sqf>
<dt class="note">[[User:Hardrock|hardrock]]</dt>
name nearestLocation [position player, "Hill"]; // ""
<dd class="note">''Notes from before the conversion:''
text nearestLocation [position player, "Hill"]; // "Lesnoy Khrebet"
</sqf>


Name will return an error for units that have been dead for more than a few seconds.
|x4= <sqf>_currentNamespace = name currentNamespace;</sqf>


<dd class="notedate">Posted on December 15, 2006 - 05:27</dd>
|seealso= [[profileName]] [[setName]] [[setIdentity]] [[nameSound]] [[setNameSound]] [[createLocation]] [[deleteLocation]] [[locationPosition]] [[nearestLocation]] [[nearestLocations]] [[nearestLocationWithDubbing]]
<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:
<code>[[hint]] [[format]] ["Unit's name: %1", _unitobject];</code>


<dd class="notedate">Posted on April 14, 2009</dd>
{{Note
<dt class="note">[[User:Alef|alef]]</dt>
|user= Kju
<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
|timestamp= 20170130194200
<!-- Note Section END -->
|text= [[Location]] variant appears to be only for the 3d editor.
</dl>
}}


 
{{Note
[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|user= Alef
[[Category:Scripting Commands OFP 1.46|{{uc:{{PAGENAME}}}}]]
|timestamp= 20090414014100
[[Category:Scripting Commands OFP 1.96|{{uc:{{PAGENAME}}}}]]
|text= Will return {{hl|Error: No vehicle}} for [[Multiplayer Scripting#Join In Progress|JIP]] players in [[init.sqf]], if no [[sleep]] were performed.
[[Category:Scripting Commands OFP 1.99|{{uc:{{PAGENAME}}}}]]
}}
{{GameCategory|arma1|Scripting Commands}}
{{GameCategory|arma2|Scripting Commands}}
{{GameCategory|arma3|Scripting Commands}}
{{GameCategory|tkoh|Scripting Commands}}

Latest revision as of 23:20, 3 July 2024

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 1

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

Syntax 2

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

Syntax 3

Syntax:
name namespace
Parameters:
namespace: Namespace
Return Value:
String - namespace's name. Possible values:

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"
Example 4:
_currentNamespace = name currentNamespace;

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=364967"