API GetStationName

From Vendetta Lua
Revision as of 22:01, 25 January 2009 by Chefkoch (talk | contribs) (split)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigationJump to search

GetStationName

Definition: GetStationName(int stationid) -> string name
Description:
Get the name of a station. If the provided stationid is invalid the function produces a lua error.
Arguments:

  • stationid stationid or nil for the current station


Returns:

  • name Long name of the current station if no argument is given, otherwise the sector name and coordinates of a station.


Example:
<source lang="lua"> GetStationName(200*256+1) --returns "Sol II H-13" (200 is the sectorid for Sol II, H-13) GetStationName() -- returns "SkyCommand" when in the station at Sol II, H-13 </source>