API SectorIDFromLocationStr: Difference between revisions
From Vendetta Lua
Jump to navigationJump to search
split |
m provided example for one word name |
||
| (One intermediate revision by one other user not shown) | |||
| Line 5: | Line 5: | ||
'''Description:'''<br> | '''Description:'''<br> | ||
Convert a location string into a [[sectorid]]. | Convert a location string into a [[sectorid]]. | ||
For two word system names only first word must be specified, otherwise it doesn't work (e.g. Geira rather than Geira Rutilus). | |||
<br> | <br> | ||
'''Arguments:'''<br> | '''Arguments:'''<br> | ||
| Line 13: | Line 14: | ||
<br> | <br> | ||
'''Example:'''<br> | '''Example:'''<br> | ||
<source lang="lua">SectorIDFromLocationStr("Sedina H-9") -> 5000</source><br> | <source lang="lua"> | ||
SectorIDFromLocationStr("Sedina H-9") -> 5000</source><br> | |||
Latest revision as of 20:24, 4 June 2009
SectorIDFromLocationStr
Definition:
SectorIDFromLocationStr(string location) -> int sectorid
Description:
Convert a location string into a sectorid.
For two word system names only first word must be specified, otherwise it doesn't work (e.g. Geira rather than Geira Rutilus).
Arguments:
location location string. output of API_Index#ShortLocationStr
Returns:
sectorid sectorid
Example:
<source lang="lua">
SectorIDFromLocationStr("Sedina H-9") -> 5000</source>
