BIS fnc getName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (Generated by BIS_fnc_exportFunctionsToWiki)
 
m (Text replacement - "(\|[pr][0-9]+ *= *[^- ]*) *- *U([a-z ])" to "$1 - u$2")
 
(30 intermediate revisions by 4 users not shown)
Line 1: Line 1:
{{RV|type=function


{{Function|= Comments
|game1= arma3
____________________________________________________________________________________________
|version1= 1.00


| arma3 |= Game name
|gr1= Object Manipulation


|1.00|= Game version
|descr= Returns name of a unit. Name of unit is stored in it is namespace so it can be retrieved later, mainly for when unit dies. Name is stored in the variable '''BIS_fnc_getName_name'''.
____________________________________________________________________________________________


| <pre>/*
|s1= [object] call [[BIS_fnc_getName]]
Author: Nelson Duarte


Description:
|p1= object: [[Object]] - object whose name should be returned
Returns name of a unit
Name of unit is stored in it's namespace so it can be retrieved later, mainly for when unit dies


Parameters:
|r1= [[String]] - unit's name
OBJECT: Unit to get the name from
BOOL: Whether to force reading the name if not stored already in namespace and unit is dead


Returns:
|x1= <sqf>[player] call BIS_fnc_getName;</sqf>
STRING: Name of the unit
*/
#define VAR_NAME "BIS_fnc_getName_name"
 
</pre><small>''(Placeholder description extracted from the function header by [[BIS_fnc_exportFunctionsToWiki]])''</small> |= Description
____________________________________________________________________________________________
 
| <!-- [] call [[BIS_fnc_getName]]; --> |= Syntax
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
 
|x1= <code></code> |=
____________________________________________________________________________________________
 
| |= See also


|seealso= [[name]]
}}
}}
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<!-- Note Section BEGIN -->
<!-- Note Section END -->
</dl>
<h3 style="display:none">Bottom Section</h3>
[[Category:Function Group: Misc|{{uc:getName}}]]
[[Category:Functions|{{uc:getName}}]]
[[Category:{{Name|arma3}}: Functions|{{uc:getName}}]]

Latest revision as of 15:52, 8 November 2023

Arma 3 logo black.png1.00
Hover & click on the images for description

Description

Description:
Returns name of a unit. Name of unit is stored in it is namespace so it can be retrieved later, mainly for when unit dies. Name is stored in the variable BIS_fnc_getName_name.
Execution:
call
Groups:
Object Manipulation

Syntax

Syntax:
[object] call BIS_fnc_getName
Parameters:
object: Object - object whose name should be returned
Return Value:
String - unit's name

Examples

Example 1:
[player] call BIS_fnc_getName;

Additional Information

See also:
name

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
Retrieved from "https://community.bistudio.com/wiki?title=BIS_fnc_getName&oldid=349301"