Discuss this page on this page's [[objGetName Talk Page|Talk Page]]

=== objGetName ===

See [[http://xelerus.de/index.php?s=functions&function=99|objGetName at Xelerus]]

^ Syntax | (objGetName spaceObject [nameflags]) -> string |
^ Arguments | spaceObject: The space object that you want the name from. |
^ | <nowiki>[</nowiki>[[legend#name_flags|nameflags]]]: An optional naming code |
^ Returns | string: The name of the space object. |
^ Category | [[name functions|name]], [[spaceobject functions|spaceObject]] |
^ Description | Returns the name of space object. You can provide flag(s) to indicate how you want the name formatted. |

=== Example ===

<code lisp>(objGetName gplayerShip)</code>

Returns the name of the player ship.

<code lisp>(objGetName gplayerShip 2)</code>

Returns the pluralized name of the player ship.

=== Name flags === 

These flags are used for controlling the formatting of names of items, ships and stations.  Flags can be added together to create a certain formatting, ie. 3 would be pluralized and capitalized.
<code>
1 - capitalize
2 - pluralize
4 - prefix with 'the' or 'a'
8 - prefix with count
</code>

Taken from [[legend#name_flags|Name Flags Legend]]

Return to [[:Functions]] list