BIS fnc getName: Difference between revisions

From Bohemia Interactive Community
Jump to navigation Jump to search
m (1 revision imported: BIS Functions update 7/7)
m (pf)
Line 1: Line 1:
{{Function|= Comments
{{Function|= Comments
____________________________________________________________________________________________
____________________________________________________________________________________________
Line 8: Line 7:
____________________________________________________________________________________________
____________________________________________________________________________________________


| <pre>/*
| 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. Name is stored in the variable '''BIS_fnc_getName_name'''.|= Description
Author: Nelson Duarte
____________________________________________________________________________________________


Description:
| [object] call [[BIS_fnc_getName]] |= Syntax
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:
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:
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
|p1= object: [[Object]] - Object whose name should be returned |= Parameter 1
____________________________________________________________________________________________
____________________________________________________________________________________________


| <!-- [] call [[BIS_fnc_getName]]; --> |= Syntax
| [[String]] - Unit's name |= Return value
|p1= |= Parameter 1
 
| |= Return value
____________________________________________________________________________________________
____________________________________________________________________________________________


|x1= <code></code> |=  
|x1= <code>[ [[player]] ] [[call]] [[BIS_fnc_getName]];</code> |=
____________________________________________________________________________________________
____________________________________________________________________________________________


| |= See also
| [[name]] |= See also
 
}}
}}
<h3 style="display:none">Notes</h3>
<h3 style="display:none">Notes</h3>
<dl class="command_description">
<dl class="command_description">

Revision as of 14:48, 30 May 2018

Hover & click on the images for description

Description

Description:
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. Name is stored in the variable BIS_fnc_getName_name.
Execution:
call
Groups:
Uncategorised

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

Notes

Bottom Section