setName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
No edit summary
(Fix versions)
 
(60 intermediate revisions by 6 users not shown)
Line 1: Line 1:
{{Command|= Comments
{{RV|type=command
____________________________________________________________________________________________


| arma |= Game name
|game1= arma1
|version1= 1.08


|1.08|= Game version
|game2= arma2
|version2= 1.00


|arg= |= Arguments in MP
|game3= arma2oa
|version3= 1.50


|eff= local |= Effects in MP
|game4= tkoh
____________________________________________________________________________________________
|version4= 1.00


| Sets the name of a location or a person. In Arma 3 this can be used to set [[name]] of a person but only in single player. |= Description
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


| object '''setName''' name |= Syntax
|arg= global


|p1= object: [[Location]] or [[Object]] |= Parameter 1
|eff= local
|p2= name: [[String]] |= Parameter 2


|[[Nothing]] |= Return value
|gr1= Unit Identity
____________________________________________________________________________________________


|s2= unit '''setName''' [name, first name, last name] |= Alternative Syntax
|gr2= Locations


|p21= unit: [[Object]] |= Parameter 1
|descr= Sets the name of a location or a person (person only in single player).
|p22= name: [[String]] |= Parameter 2
|p23= first name: [[String]] |= Parameter 3
|p24= last name: [[String]] |= Parameter 4


|r2= [[Nothing]] |= Return value
|s1= thing [[setName]] name
____________________________________________________________________________________________
 
|x1= <code>myLocation [[setName]] "My Location Name";</code> |= Example 1
|x2= <code>[[player]] [[setName]] "New Name";</code> |= Example 2
|x3= <code>[[player]] [[setName]] ["Ben Kerry","Ben","Kerry"];</code> |= Example 3
____________________________________________________________________________________________


| [[name]] |= See also
|p1= thing: [[Location]] or {{GVI|arma3|1.02|size= 0.75}} [[Object]]


}}
|p2= name: [[String]]


<h3 style="display:none">Notes</h3>
|r1= [[Nothing]]
<dl class="command_description">
<!-- Note Section BEGIN -->


<dt class="note">'''[[User:kju|kju]]'''
|s2= unit [[setName]] [name, firstName, lastName]
<dd class="note">Appears to be only for the 3d editor.


<dt class="note">'''[[User:Druid|Druid]]'''
|s2since= arma3 1.02
<dd class="note">Support of a person as the first parameter from Arma 3 v. 1.02.


<dd class="notedate">Posted on April 12, 2014
|p21= unit: [[Object]]
<dt class="note">'''[[User:Waffle SS.|Waffle SS.]]'''
<dd class="note">Seems to have no effect on players in Multiplayer. (ArmA 3 v1.00)
<BR><BR>


<!-- Note Section END -->
|p22= name: [[String]]
</dl>


<h3 style="display:none">Bottom Section</h3>
|p23= firstName: [[String]]


|p24= lastName: [[String]]


[[Category:Scripting Commands|{{uc:{{PAGENAME}}}}]]
|r2= [[Nothing]]
[[Category:Scripting Commands ArmA|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Locations|{{uc:{{PAGENAME}}}}]]
[[Category:Command_Group:_Editor_Control|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands ArmA2|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting Commands Arma 3|{{uc:{{PAGENAME}}}}]]
[[Category:Scripting_Commands_Take_On_Helicopters|{{uc:{{PAGENAME}}}}]]
[[Category:Arma_3:_New_Scripting_Commands_List|{{uc:{{PAGENAME}}}}]]


{{subst:Add new note/construct|
|x1= <sqf>myLocation setName "My Location Name";</sqf>
<!--
* Replace from here (including the arrow just above)


* Please add your note here, replacing these comments
|x2= <sqf>player setName "New Name";</sqf>
* Please '''PREVIEW YOUR ADDITION BEFORE SAVING'''
* Thank you


* Equal symbols "=" should be added as "{{subst:=}}" (excluding quotes)
|x3= <sqf>player setName ["Ben Kerry","Ben","Kerry"];</sqf>
* Pipes "|" should be added as "{{subst:!}}" (excluding quotes)
* New lines should be forced by the use of "<br>" tags
* Examples should be placed between tags <code>_like {{subst:=}} [[_this]];</code>


* Replace to here (including the arrow just below)
|seealso= [[name]] [[nameSound]] [[setNameSound]] [[setIdentity]]
Only last name will appear in command bar i.e. this setname _mynameArray will display _mynameArray select 2. If setname is used with a string : this setname "blah", nothing occurs in command bar and default randomized name is displayed.
}}
 
Dealing with the units' names in a script, _x (in a foreach units group, for example) will return the "object" as B ALFA 4-1:2 or the name written in ai unit name field in editor (if exists). This context is rather a "variable name" for each object (ai) than an "identity name" as given via setname function.


{{Note
|user= Pierre MGI
|timestamp= 20140818221500
|text= Only last name will appear in command bar i.e. <sqf inline>this setName _myNameArray</sqf> will display <sqf inline>_myNameArray select 2</sqf>.
If [[setName]] is used with a string e.g <sqf inline>this setName "blah"</sqf>, nothing occurs in the command bar and the default randomized name is displayed.<br><br>
Dealing with the units' names in a script, _x (in a <sqf inline>forEach units _group</sqf>, for example) will return the "object" as {{hl|B ALFA 4-1:2}} or the name written in ai unit name field in editor (if exists).
This context is rather a "variable name" for each object (ai) than an "identity name" as given ''via'' the [[setName]] command.
}}
}}

Latest revision as of 18:35, 20 April 2023

Hover & click on the images for description

Description

Description:
Sets the name of a location or a person (person only in single player).
Groups:
Unit IdentityLocations

Syntax

Syntax:
thing setName name
Parameters:
thing: Location or Arma 3 logo black.png1.02 Object
name: String
Return Value:
Nothing

Alternative Syntax

Syntax:
unit setName [name, firstName, lastName]
Parameters:
unit: Object
name: String
firstName: String
lastName: String
Return Value:
Nothing

Examples

Example 1:
myLocation setName "My Location Name";
Example 2:
player setName "New Name";
Example 3:
player setName ["Ben Kerry","Ben","Kerry"];

Additional Information

See also:
name nameSound setNameSound setIdentity

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
Pierre MGI - c
Posted on Aug 18, 2014 - 22:15 (UTC)
Only last name will appear in command bar i.e. this setName _myNameArray will display _myNameArray select 2. If setName is used with a string e.g this setName "blah", nothing occurs in the command bar and the default randomized name is displayed.

Dealing with the units' names in a script, _x (in a forEach units _group, for example) will return the "object" as B ALFA 4-1:2 or the name written in ai unit name field in editor (if exists). This context is rather a "variable name" for each object (ai) than an "identity name" as given via the setName command.