API Index2: Difference between revisions

From Vendetta Lua
Jump to navigationJump to search
← Older edit
No edit summary
Link GetPrimaryShipIDOfPlayer
 
(60 intermediate revisions by 11 users not shown)
Line 1: Line 1:
Playground for a different index format
See also [[:Category:API]].
 
= [[API_Interface_Index|Interface]] =
 
'''[[AdditionalHUDText]]'''


= General =
= General =
Line 10: Line 14:


'''[[API_Article|Article]]'''(string ''word'') -> string ''out'' :: prepends the appropriate article to the string ''word''
'''[[API_Article|Article]]'''(string ''word'') -> string ''out'' :: prepends the appropriate article to the string ''word''
'''[[API_AssignOwnerKey|AssignOwnerKey]]'''(string keyid) -> nil :: Assign an owner key to this station


'''[[API_CanUseAddon|CanUseAddon]]'''(int ''itemid'') -> bool ''ret1'', {string l1 ..} :: check if the player can equip the addon ''itemid''
'''[[API_CanUseAddon|CanUseAddon]]'''(int ''itemid'') -> bool ''ret1'', {string l1 ..} :: check if the player can equip the addon ''itemid''
Line 17: Line 23:
'''[[API_CancelPurchaseShipLoadout|CancelPurchaseShipLoadout]]'''() -> nil :: Interrupt purchase of ship loadout
'''[[API_CancelPurchaseShipLoadout|CancelPurchaseShipLoadout]]'''() -> nil :: Interrupt purchase of ship loadout


'''[[API_CheckCharProximity|CheckCharProximity]]'''(int dist, charid) -> bool inrange :: Tell if a character at a given distance is within proximity range. The function only returns true once for every character in radar proximity range. Any further checks will return false until the character leaves the range.
'''[[API_CheckCharProximity|CheckCharProximity]]'''() -> nil :: stub


'''[[API_CheckProximityWarning|CheckProximityWarning]]'''() -> nil :: Trigger the PROXIMITY_ALERT event if a character, that hasn't been before, is within proximity range
'''[[API_CheckProximityWarning|CheckProximityWarning]]'''() -> nil :: Trigger the PROXIMITY_ALERT event if a character, that hasn't been before, is within proximity range


'''[[API_CheckStorageAndUnloadCargo|CheckStorageAndUnloadCargo]]'''({{int itemid, int quantity} ..}, function cb) -> nil :: Unload cargo items and quantities according to the provided table also checks station storage and pops up a dialog if not enough available
'''[[API_CheckStorageAndUnloadCargo|CheckStorageAndUnloadCargo]]'''({{int itemid, int quantity} ..}, function cb) -> nil :: Unload cargo items and with storage space check


'''[[API_ClearGeneralChatLog|ClearGeneralChatLog]]'''() -> nil :: clears general chat log..
'''[[API_ClearGeneralChatLog|ClearGeneralChatLog]]'''() -> nil :: clears general chat log..


'''[[API_ClearLastShipLoadout|ClearLastShipLoadout]]'''() -> nil :: clear last shiploadout. prevents client from asking to rebuy ship after destruction
'''[[API_ClearLastShipLoadout|ClearLastShipLoadout]]'''() -> nil :: clear last shiploadout


'''[[API_ClearMissionChatLog|ClearMissionChatLog]]'''() -> nil :: clears mission log..
'''[[API_ClearMissionChatLog|ClearMissionChatLog]]'''() -> nil :: clears mission log..


'''[[API_ClearProximityCache|ClearProximityCache]]'''() -> nil  :: Clear list of characters in proximity range. Stops [[API_Index#CheckCharProximity|CheckCharProximity]] and [[API_Index#CheckProximityWarning|CheckProximityWarning]] from ignoring them.
'''[[API_ClearProximityCache|ClearProximityCache]]'''() -> nil  :: Clear list of characters in proximity range


'''[[API_ClearStationChatLog|ClearStationChatLog]]'''() -> nil :: clears station log (bar)..
'''[[API_ClearStationChatLog|ClearStationChatLog]]'''() -> nil :: clears station log (bar)..
Line 42: Line 48:


'''[[API_DeleteCharacter|DeleteCharacter]]'''(int slot) -> nil :: Deletes the character in the character slot ''slot''
'''[[API_DeleteCharacter|DeleteCharacter]]'''(int slot) -> nil :: Deletes the character in the character slot ''slot''
'''[[API_DisableNPCProximityWarning|DisableNPCProximityWarning]]'''() -> nil :: Disable proximity warnings for NPC
'''[[API_DisableOneOffProximityWarning|DisableOneOffProximityWarning]]'''() -> nil :: Disable one off proximity warning. Trigger proximity warning more than once for the same ship.
'''[[API_DisablePlayerProximityWarning|DisablePlayerProximityWarning]]'''() -> nil :: Disable proximity warnings for players


'''[[API_DisableProximityWarning|DisableProximityWarning]]'''() -> nil :: disable the proximity warning ...
'''[[API_DisableProximityWarning|DisableProximityWarning]]'''() -> nil :: disable the proximity warning ...


'''[[API_DisconnectAddon|DisconnectAddon]]'''(int ''itemid'') -> bool ret1 :: detaches the addon ''itemid'' and stores it in the station
'''[[API_DisconnectAddon|DisconnectAddon]]'''(int ''itemid'') -> bool ret1 :: detaches the addon ''itemid'' and stores it in the station
Note: detached items will likely have a different itemid in the station


'''[[API_DisconnectAllAddons|DisconnectAllAddons]]'''() -> nil :: Detach all addons from the active ship and store them in the current station
'''[[API_DisconnectAllAddons|DisconnectAllAddons]]'''() -> nil :: detaches all addons from the active ship and stores them in the current station


'''[[API_EnableProximityWarning|EnableProximityWarning]]'''DisableProximityWarning() -> nil :: enable the proximity warning ...
'''[[API_EnableNPCProximityWarning|EnableNPCProximityWarning]]'''() -> nil :: Enable proximity warnings for NPC
 
'''[[API_EnableOneOffProximityWarning|EnableOneOffProximityWarning]]'''() -> nil :: Enable one off proximity warning. Trigger proximity warning only once for the same ship.
 
'''[[API_EnablePlayerProximityWarning|EnablePlayerProximityWarning]]'''() -> nil :: Enable proximity warnings for players
 
'''[[API_EnableProximityWarning|EnableProximityWarning]]'''() -> nil :: enable the proximity warning ...


'''[[API_EnableVoiceChat|EnableVoiceChat]]'''(bool enable) -> nil :: Toggle Voice chat
'''[[API_EnableVoiceChat|EnableVoiceChat]]'''(bool enable) -> nil :: Toggle Voice chat
'''[[API_FactionToSignedFaction|FactionToSignedFaction]]'''(int faction) -> int :: Convert absolute faction values (0 to 65535) into signed faction values (-1000 to 1000).  Results are rounded down.


'''[[API_FindAndReplaceTags|FindAndReplaceTags]]'''(string text, table matches) -> string ret1 :: Replaces all occurances of with < and > enclosed substrings in ''text'' with matching values from the provided table
'''[[API_FindAndReplaceTags|FindAndReplaceTags]]'''(string text, table matches) -> string ret1 :: Replaces all occurances of with < and > enclosed substrings in ''text'' with matching values from the provided table
Line 60: Line 79:
'''[[API_ForEachBuddy|ForEachBuddy]]'''(function func(string name, bool isonline, int sectorid)) -> nil :: calls ''func'' with the name, if the player is online for each of your buddies as well as his position if the player is currently online
'''[[API_ForEachBuddy|ForEachBuddy]]'''(function func(string name, bool isonline, int sectorid)) -> nil :: calls ''func'' with the name, if the player is online for each of your buddies as well as his position if the player is currently online


'''[[API_ForEachPlayer|ForEachPlayer]]'''(function func(int charid)) -> nil :: calls ''func'' with the character id of each player in the sector. that includes bots and the sector thingy itself
'''[[API_ForEachPlayer|ForEachPlayer]]'''(function func(int charid)) -> nil :: calls ''func'' with the character id of each player in the sector
This function is called by the toplist when you open it.


'''[[API_ForgiveKiller|ForgiveKiller]]'''(bool forgive) -> nil :: Forgive the last killer.
'''[[API_ForgiveKiller|ForgiveKiller]]'''(bool forgive) -> nil :: Forgive the last killer.
Line 95: Line 113:
'''[[API_GetActiveMissionInfo|GetActiveMissionInfo]]'''(int num) -> string mname table mmsg int itemid :: Get information about the selcted active mission
'''[[API_GetActiveMissionInfo|GetActiveMissionInfo]]'''(int num) -> string mname table mmsg int itemid :: Get information about the selcted active mission


'''[[API_GetActiveShipCargoCount|GetActiveShipCargoCount]]'''() -> int cargocount :: returns amount of cargo in the ship
'''[[API_GetActiveShipCargoCount|GetActiveShipCargoCount]]'''() -> int cargocount :: returns amount of cargo in the ship in cu


'''[[API_GetActiveShipEnergy|GetActiveShipEnergy]]'''() -> float eng fraction :: returns the energy level of the active ship
'''[[API_GetActiveShipEnergy|GetActiveShipEnergy]]'''() -> float eng fraction :: returns the energy level of the active ship
Line 141: Line 159:
'''[[API_GetCargoValue|GetCargoValue]]'''() -> int value, price :: Get value and buy price of the cargo and equipped addons on the active ship at the current station
'''[[API_GetCargoValue|GetCargoValue]]'''() -> int value, price :: Get value and buy price of the cargo and equipped addons on the active ship at the current station


'''[[API_GetCharacterDescription|GetCharacterDescription]]'''() -> string desc :: Get the character description for your and possibly other chars. It just returns an empty string when an argument is passed to it, which suggests that it accepts one or more unknown arguments.
'''[[API_GetCharacterDescription|GetCharacterDescription]]'''(int charid) -> string desc :: Get the character description of a character


'''[[API_GetCharacterID|GetCharacterID]]'''(int nodeid) -> int charid :: returns character id of the provided node id
'''[[API_GetCharacterID|GetCharacterID]]'''(int nodeid) -> int charid :: returns character id of the provided node id
Line 149: Line 167:
'''[[API_GetCharacterInfo|GetCharacterInfo]]'''(int cslot) -> string name faction int money kills deaths loc home cl ll hl tl ml :: Get information about your characters
'''[[API_GetCharacterInfo|GetCharacterInfo]]'''(int cslot) -> string name faction int money kills deaths loc home cl ll hl tl ml :: Get information about your characters


'''[[API_GetCharacterKillDeaths|GetCharacterKillDeaths]]'''(int charid) -> int kills deaths pks :: get info about kills and deaths. returns your own info if no charid given or a lua error if an invalid one ...
'''[[API_GetCharacterKillDeaths|GetCharacterKillDeaths]]'''(int charid) -> int kills deaths pks :: get info about kills and deaths
 
'''[[API_GetConqueredSectorsInSystem|GetConqueredSectorsInSystem]]'''(int systemid) -> table sectors :: Get table with conquered sectors in the given system
 
'''[[API_GetConqueredStatus|GetConqueredStatus]]'''(int sectorid) -> int faction :: Get faction that conquered the given sector


'''[[API_GetCurrentSectorid|GetCurrentSectorid]]'''() -> int sectorid :: get current sector id
'''[[API_GetCurrentSectorid|GetCurrentSectorid]]'''() -> int sectorid :: get current sector id
'''[[API_GetCurrentStationID|GetCurrentStationID]]'''() -> int stationid :: get current station id


'''[[API_GetCurrentStationType|GetCurrentStationType]]'''() -> int type :: return the current station type..
'''[[API_GetCurrentStationType|GetCurrentStationType]]'''() -> int type :: return the current station type..
Line 179: Line 203:
'''[[API_GetGuildBalance|GetGuildBalance]]'''() -> int balance :: get amount of money in guild bank
'''[[API_GetGuildBalance|GetGuildBalance]]'''() -> int balance :: get amount of money in guild bank


'''[[API_GetGuildBankPrivileges|GetGuildBankPrivileges]]'''() -> table deposit withdraw logview :: get your guilds bank privileges as three tables. they contain the ranks carrying each privilege.
'''[[API_GetGuildBankPrivileges|GetGuildBankPrivileges]]'''() -> table deposit withdraw logview :: get your guilds bank privileges as three tables
see [API_Index#Guild]


'''[[API_GetGuildBankWithdrawalLimits|GetGuildBankWithdrawalLimits]]'''() -> int ret1 ret2 ret3 :: get withdrawal limits? returns three numbers
'''[[API_GetGuildBankWithdrawalLimits|GetGuildBankWithdrawalLimits]]'''() -> int ret1 ret2 ret3 :: get withdrawal limits? returns three numbers
Line 227: Line 250:


'''[[API_GetItemPartialDesc|GetItemPartialDesc]]'''(table item) -> string desc :: get partial description of an inventory item
'''[[API_GetItemPartialDesc|GetItemPartialDesc]]'''(table item) -> string desc :: get partial description of an inventory item
'''[[API_GetJoinedChannels|GetJoinedChannels]]'''() -> table channels :: get array with currently joined channels
'''[[API_GetKeyInfo|GetKeyInfo]]'''(int keyindex) -> string keyid, string desc  :: Get information about the key with the given index in the keychain


'''[[API_GetLastAggressor|GetLastAggressor]]'''(int itemid) -> int nodeid ret1 :: get node id of last aggressor and some number
'''[[API_GetLastAggressor|GetLastAggressor]]'''(int itemid) -> int nodeid ret1 :: get node id of last aggressor and some number


'''[[API_GetJoinedChannels|GetJoinedChannels]]'''() -> table channels :: get array with currently joined channels
'''[[API_GetLastPrivateSpeaker|GetLastPrivateSpeaker]]'''() -> string name :: get name of last character that pmed you
 
'''[[API_GetLastPrivateSpeaker|GetLastPrivateSpeaker]]'''(int itemid) -> string name :: get name of last character that pmed you


'''[[API_GetLastShipLoadout|GetLastShipLoadout]]'''() -> {groups = {1 = group1 .. 18 = group18}, int ship, ports= {1 = port1 ..}, int shipcolor} :: get last ship loadout, color and weapon groups. this function only works in space
'''[[API_GetLastShipLoadout|GetLastShipLoadout]]'''() -> {groups = {1 = group1 .. 18 = group18}, int ship, ports= {1 = port1 ..}, int shipcolor} :: get last ship loadout, color and weapon groups


'''[[API_GetLastShipLoadoutPurchaseCost|GetLastShipLoadoutPurchaseCost]]'''() -> int cost :: what you payed for your last ship(?)
'''[[API_GetLastShipLoadoutPurchaseCost|GetLastShipLoadoutPurchaseCost]]'''() -> int cost :: what you payed for your last ship(?)
Line 258: Line 283:
'''[[API_GetNewsHeadline|GetNewsHeadline]]'''(int index) -> string title int time ret1  :: get headline, post time and some number
'''[[API_GetNewsHeadline|GetNewsHeadline]]'''(int index) -> string title int time ret1  :: get headline, post time and some number


'''[[API_GetNumAccomplishments|GetNumAccomplishments]]'''(int charid) -> int accomplishments :: get number of accomplishmeants for given character(?). not well tested, may require caching of the char info
'''[[API_GetNewspostItem|GetNewspostItem]]'''(int index) -> int id, time, string subject, bool important  :: Get news post info
 
'''[[API_GetNumAccomplishments|GetNumAccomplishments]]'''(int charid) -> int accomplishments :: get number of accomplishmeants for given character


'''[[API_GetNumActiveMissions|GetNumActiveMissions]]'''() -> int missions :: get number of active missions.
'''[[API_GetNumActiveMissions|GetNumActiveMissions]]'''() -> int missions :: get number of active missions.
Line 268: Line 295:
'''[[API_GetNumCompletedMissions|GetNumCompletedMissions]]'''() -> int missions :: get number of completed missions
'''[[API_GetNumCompletedMissions|GetNumCompletedMissions]]'''() -> int missions :: get number of completed missions


'''[[API_GetNumFinishedMissions|GetNumFinishedMissions]]'''() -> int missions :: get number of finished missions. as displayed in the mission log panel
'''[[API_GetNumFinishedMissions|GetNumFinishedMissions]]'''() -> int missions :: get number of finished missions


'''[[API_GetNumGroupMembers|GetNumGroupMembers]]'''GetNumCharacters() -> int chars :: get number of characters in your group
'''[[API_GetNumGroupMembers|GetNumGroupMembers]]''' -> int chars :: get number of characters in your group


'''[[API_GetNumGuildMembers|GetNumGuildMembers]]'''() -> int numchars :: get number of online guildmembers  
'''[[API_GetNumGuildMembers|GetNumGuildMembers]]'''() -> int numchars :: get number of online guildmembers  
'''[[API_GetNumKeysInKeychain|GetNumKeysInKeychain]]'''() -> nil :: Get number of keys in the keychain


'''[[API_GetNumNewsHeadlines|GetNumNewsHeadlines]]'''() -> int num :: get number of news headlines..  
'''[[API_GetNumNewsHeadlines|GetNumNewsHeadlines]]'''() -> int num :: get number of news headlines..  


'''[[API_GetNumStationDesiredItems|GetNumStationDesiredItems]]'''() -> int num :: Get number of items this station desires. The names of the items can then be fetched with [[API Index#GetStationDesiredItem|GetStationDesiredItem]].
'''[[API_GetNumNewsposts|GetNumNewsposts]]'''() -> int num :: Get number of news posts
 
'''[[API_GetNumOccasions|GetNumOccasions]]'''() -> int num :: Get number of ccassion announcments (events)
 
'''[[API_GetNumStationDesiredItems|GetNumStationDesiredItems]]'''() -> int num :: Get number of items this station desires


'''[[API_GetNumStationMerch|GetNumStationMerch]]'''() -> int num :: get number of addons, ships an cargo this station sells
'''[[API_GetNumStationMerch|GetNumStationMerch]]'''() -> int num :: get number of addons, ships an cargo this station sells
Line 283: Line 316:


'''[[API_GetNumTips|GetNumTips]]'''() -> int num :: get size of load screen tips pool
'''[[API_GetNumTips|GetNumTips]]'''() -> int num :: get size of load screen tips pool
'''[[API_GetOccasionItem|GetOccasionItem]]'''(int index) -> int id, time, duration, string name, bool important, int timestamp  :: Get occasion (event) info


'''[[API_GetParentHealth|GetParentHealth]]'''() -> float ret1 ret2 :: get health of object this one is attached to (turret to capship). untested!
'''[[API_GetParentHealth|GetParentHealth]]'''() -> float ret1 ret2 :: get health of object this one is attached to (turret to capship). untested!
Line 294: Line 329:
'''[[API_GetPlayerHealth|GetPlayerHealth]]'''(int charid) -> float health :: get health of provided character
'''[[API_GetPlayerHealth|GetPlayerHealth]]'''(int charid) -> float health :: get health of provided character


'''[[API_GetPlayerName|GetPlayerName]]'''(int charid) -> string name :: get name of character
'''[[API_GetPlayerName|GetPlayerName]]'''([int charid]) -> string name :: get name of character
 
'''[[API_GetPlayerNodeID|GetPlayerNodeID]]'''(int charid) -> int nodeid :: get [[nodeid]] of a character in the sector


'''[[API_GetPlayerNodeID|GetPlayerNodeID]]'''(int charid) -> int nodeid :: get [[nodeid]] of a character in the sector
'''[[API_GetPlayerNodeID|GetPlayerNodeID]]'''(int charid) -> int nodeid :: get [[nodeid]] of a character in the sector


'''[[API_GetPrimaryShipIDOfPlayer|GetPrimaryShipIDOfPlayer]]'''(int charid) -> int shipid :: get shipid of a character (= objectid?)
'''[[API_GetPOI|GetPOI]]'''() -> table :: returns a table of all discovered points-of-interest in the current system.
 
'''[[API_GetPrimaryShipIDOfPlayer|GetPrimaryShipIDOfPlayer]]'''(int charid) -> int objectid :: get objectid of provided character


'''[[API_GetPrimaryShipNameOfPlayer|GetPrimaryShipNameOfPlayer]]'''(int charid) -> string name :: get ship name (type) of provided character
'''[[API_GetPrimaryShipNameOfPlayer|GetPrimaryShipNameOfPlayer]]'''(int charid) -> string name :: get ship name (type) of provided character
Line 304: Line 343:
'''[[API_GetProximityWarningDistance|GetProximityWarningDistance]]'''() -> int dist :: get proxy warnign distance
'''[[API_GetProximityWarningDistance|GetProximityWarningDistance]]'''() -> int dist :: get proxy warnign distance
Note: even returns the distance when proxy warning is disabled
Note: even returns the distance when proxy warning is disabled
'''[[API_GetProximityWarningTimeout|GetProximityWarningTimeout]]'''() -> int timeout :: Get minimum time between proximity warnings
'''[[API_GetRadarDistance|GetRadarDistance]]'''(int charid) -> float distance :: get distance to another character
'''[[API_GetRegisteredCommands|GetRegisteredCommands]]'''() -> table commands :: get all commands
'''[[API_GetRegisteredUserCommands|GetRegisteredUserCommands]]'''() -> table commands :: get all user registered commands


'''[[API_GetSectorAlignment|GetSectorAlignment]]'''() -> int alignment :: returns the alignment of the current sector
'''[[API_GetSectorAlignment|GetSectorAlignment]]'''() -> int alignment :: returns the alignment of the current sector


'''[[API_GetSectorMonitoredStatus|GetSectorMonitoredStatus]]'''() -> int monitor :: returns the monitor status of the current sector (Unmonitored, Guarded ...) see: [[FactionMonitor]] and [[FactionMonitorStr]]
'''[[API_GetSectorIDOfStation|GetSectorIDOfStation]]'''(int stationid) -> int sectorid  :: Get sector id of the given station
 
'''[[API_GetSectorMonitoredStatus|GetSectorMonitoredStatus]]'''() -> int monitor :: returns the monitor status of the current sector (Unmonitored, Guarded ...)


'''[[API_GetShipAmmoPrices|GetShipAmmoPrices]]'''(int ship) -> table prices :: get cost of ship ammo
'''[[API_GetShipAmmoPrices|GetShipAmmoPrices]]'''(int ship) -> table prices :: get cost of ship ammo
Line 319: Line 368:
'''[[API_GetShipMaxCargo|GetShipMaxCargo]]'''(int itemid) -> int cargo :: get amount of cargo the given ship can hold
'''[[API_GetShipMaxCargo|GetShipMaxCargo]]'''(int itemid) -> int cargo :: get amount of cargo the given ship can hold


'''[[API_GetShipMeshInfo|GetShipMeshInfo]]'''(int itemid) -> string id model int color :: get mesh information about equipment in your inventory. if an invalid itemid is given the info about the current ship is returned
'''[[API_GetShipMeshInfo|GetShipMeshInfo]]'''(int itemid) -> string id model int color :: get mesh information about equipment in your inventory


'''[[API_GetShipPortIDOfItem|GetShipPortIDOfItem]]'''(int itemid1, int itemid2) -> int portid :: get port of weapon in one of your ships
'''[[API_GetShipPortIDOfItem|GetShipPortIDOfItem]]'''(int itemid1, int itemid2) -> int portid :: get port of weapon in one of your ships
Line 328: Line 377:


'''[[API_GetSkirmishInfo|GetSkirmishInfo]]'''() -> int crew1 crew2 init1 init2 string name1 name2 bool active :: returns crew info for skirmish missions
'''[[API_GetSkirmishInfo|GetSkirmishInfo]]'''() -> int crew1 crew2 init1 init2 string name1 name2 bool active :: returns crew info for skirmish missions
'''[[API_GetStartingSectors|GetStartingSectors]]'''(int factionid) -> table sectors :: get list of starting sectors for the given faction


'''[[API_GetStationAddonList|GetStationAddonList]]'''() -> {int itemid ..} :: get array with your addons in the station hold
'''[[API_GetStationAddonList|GetStationAddonList]]'''() -> {int itemid ..} :: get array with your addons in the station hold


'''[[API_GetStationAmmoInfoByID|GetStationAmmoInfoByID]]'''GetStationAmmoByID(int itemid) -> {bool is_ammorepair, string type, int unitcost, int price, string longdesc, string desc,  bool locallyproduced, int itemid, string icon} :: get info about ammo based weapons in the station by item id
'''[[API_GetStationAmmoInfoByID|GetStationAmmoInfoByID]]'''(int itemid) -> {bool is_ammorepair, string type, int unitcost, int price, string longdesc, string desc,  bool locallyproduced, int itemid, string icon} :: get info about ammo based weapons in the station by item id


'''[[API_GetStationCargoList|GetStationCargoList]]'''() -> {int itemid ..} :: get list of cargo items in the current station. produces error when called outside station..
'''[[API_GetStationCargoList|GetStationCargoList]]'''() -> {int itemid ..} :: get list of cargo items in the current station. produces error when called outside station..
Line 339: Line 390:
'''[[API_GetStationCurrentCargo|GetStationCurrentCargo]]'''() -> int cargo :: get amount of cargo currently in this station. including cargo, equipment, ships ..
'''[[API_GetStationCurrentCargo|GetStationCurrentCargo]]'''() -> int cargo :: get amount of cargo currently in this station. including cargo, equipment, ships ..


'''[[API_GetStationDesiredItem|GetStationDesiredItem]]'''(int index) -> string ditem :: Get the string name of an item that this station desires. The index ranges from 1 to [[API Index#GetNumStationDesiredItems|GetNumStationDesiredItems()]].
'''[[API_GetStationDesiredItem|GetStationDesiredItem]]'''(int index) -> string ditem :: Get the string name of an item that this station desires


'''[[API_GetStationFaction|GetStationFaction]]'''(int stationid) -> int factionid :: get faction of the given station
'''[[API_GetStationFaction|GetStationFaction]]'''(int stationid) -> int factionid :: get faction of the given station
Line 345: Line 396:
'''[[API_GetStationFactionAppraisalModifier|GetStationFactionAppraisalModifier]]'''() -> float modifier :: Returns a number that seems to affect the price of storage space. depends on faction standing or something
'''[[API_GetStationFactionAppraisalModifier|GetStationFactionAppraisalModifier]]'''() -> float modifier :: Returns a number that seems to affect the price of storage space. depends on faction standing or something


'''[[API_GetStationLocation|GetStationLocation]]'''() -> int stationid :: get the [[stationid]] of the current station  
'''[[API_GetStationLocation|GetStationLocation]]'''(int stationid1) -> int stationid2 :: get the [[stationid]] of the current station  


'''[[API_GetStationMaxCargo|GetStationMaxCargo]]'''() -> int cargo :: return amount of cargo this station can hold.
'''[[API_GetStationMaxCargo|GetStationMaxCargo]]'''() -> int cargo :: return amount of cargo this station can hold.
Line 353: Line 404:
'''[[API_GetStationMerchInfoByID|GetStationMerchInfoByID]]'''(int itemid) -> { neededlevels = {int l1 .. l5}, int price, string longdesc, float mass, string sortgroup, int volume, string extendeddesc, string type, string meshfile, bool usable, int itemid, string icon } :: get info about items this station sells by itemid
'''[[API_GetStationMerchInfoByID|GetStationMerchInfoByID]]'''(int itemid) -> { neededlevels = {int l1 .. l5}, int price, string longdesc, float mass, string sortgroup, int volume, string extendeddesc, string type, string meshfile, bool usable, int itemid, string icon } :: get info about items this station sells by itemid


'''[[API_GetStationMerchPriceByID|GetStationMerchPriceByID]]'''GetStationMerchInfoByID(int itemid) -> int price :: get price of an item this station sells
'''[[API_GetStationMerchPriceByID|GetStationMerchPriceByID]]'''(int itemid) -> int price :: get price of an item this station sells


'''[[API_GetStationName|GetStationName]]'''(int stationid) -> string name :: Get the name of a station. If the provided stationid is invalid the function produces a lua error.
'''[[API_GetStationName|GetStationName]]'''(int stationid) -> string name :: Get the name of a station. If the provided stationid is invalid the function produces a lua error.
Line 367: Line 418:
'''[[API_GetStationType|GetStationType]]'''() -> string stype :: get station type
'''[[API_GetStationType|GetStationType]]'''() -> string stype :: get station type


'''[[API_GetStorageItemInfo|GetStorageItemInfo]]'''() -> ?? :: no clue. can't make it return anything
'''[[API_GetStorageItemInfo|GetStorageItemInfo]]'''(int itemid) -> int stationid :: get stationid of a storage container


'''[[API_GetStorageLocationSector|GetStorageLocationSector]]'''(int arg1) -> int ret1 :: returns some number when fed with an itemid
'''[[API_GetStorageLocationSector|GetStorageLocationSector]]'''(int arg1) -> int ret1 :: returns some number when fed with an itemid
Line 395: Line 446:
'''[[API_HasActiveShip|HasActiveShip]]'''() -> bool aship :: return true if the player has an active ship
'''[[API_HasActiveShip|HasActiveShip]]'''() -> bool aship :: return true if the player has an active ship


'''[[API_HasLastShipLoadout|HasLastShipLoadout]]'''() -> bool loadout :: return true if the player has a last ship loadout saved. (see ClearLastShipLoadout)
'''[[API_HasLastShipLoadout|HasLastShipLoadout]]'''() -> bool loadout :: return true if the player has a last ship loadout saved


'''[[API_IsConnected|IsConnected]]'''() -> bool connected :: return true if the player is connected to the game
'''[[API_IsConnected|IsConnected]]'''() -> bool connected :: return true if the player is connected to the game
Line 406: Line 457:


'''[[API_IsInDuel|IsInDuel]]'''() -> bool duel :: Returns true if the player is in a duel
'''[[API_IsInDuel|IsInDuel]]'''() -> bool duel :: Returns true if the player is in a duel
'''[[API_IsNPCProximityWarningEnabled|IsNPCProximityWarningEnabled]]'''() -> bool state :: Get NPC proximity warning state
'''[[API_IsOneOffProximityWarningEnabled|IsOneOffProximityWarningEnabled]]'''() -> bool state :: Get one off proximity warning state
'''[[API_IsPlayerProximityWarningEnabled|IsPlayerProximityWarningEnabled]]'''() -> bool state :: Get Player proximity warning state


'''[[API_IsPlayerRequestingBuddy|IsPlayerRequestingBuddy]]'''(string name) -> bool req :: Tell if the given player is requesting to become a buddy
'''[[API_IsPlayerRequestingBuddy|IsPlayerRequestingBuddy]]'''(string name) -> bool req :: Tell if the given player is requesting to become a buddy
Line 416: Line 473:


'''[[API_IsStormPresent|IsStormPresent]]'''() -> bool isstorm :: tell if there's a storm in the current sector
'''[[API_IsStormPresent|IsStormPresent]]'''() -> bool isstorm :: tell if there's a storm in the current sector
'''[[API_IsTrainingSector|IsTrainingSector]]'''(int sectorid) -> bool tsector :: tell if the given sector is a training sector


'''[[API_IsTransactionInProgress|IsTransactionInProgress]]'''() -> bool trans :: tell if a transaction is in progress (like selling a ship, items ..)
'''[[API_IsTransactionInProgress|IsTransactionInProgress]]'''() -> bool trans :: tell if a transaction is in progress (like selling a ship, items ..)
Line 461: Line 520:
'''[[API_OnIdle|OnIdle]]'''(float delta) -> nil :: Idle handler
'''[[API_OnIdle|OnIdle]]'''(float delta) -> nil :: Idle handler


'''[[API_OpenAlarm|OpenAlarm]]'''(string title, text, buttontext) -> nil :: Show [[API_index#ConfirmationDialog|ConfirmationDialog]] with the given message
'''[[API_OpenAlarm|OpenAlarm]]'''(string title, text, buttontext) -> nil :: Show [[API_ConfirmationDialog|ConfirmationDialog]] with the given message


'''[[API_OverlapPrevention|OverlapPrevention]]'''(table ip) -> bool overlap :: Adjust icon positions in a viewport so that they don't overlap
'''[[API_OverlapPrevention|OverlapPrevention]]'''(table ip) -> bool overlap :: Adjust icon positions in a viewport so that they don't overlap
Line 469: Line 528:
'''[[API_PlayerInStation|PlayerInStation]]'''() -> bool instation :: tell if the player is in a station or capship
'''[[API_PlayerInStation|PlayerInStation]]'''() -> bool instation :: tell if the player is in a station or capship


'''[[API_PlayerInventoryPairs|PlayerInventoryPairs]]'''() -> int itemid table iteminfo :: Iterator function that returns information about an item in the players inventory each time it is called. works like pairs()
'''[[API_PlayerInventoryPairs|PlayerInventoryPairs]]'''() -> int itemid table iteminfo :: Iterator function that returns information about an item in the players inventory each time it is called


'''[[API_PrintJoinUsage|PrintJoinUsage]]'''() -> nil :: prints how to use /join to the chatarea
'''[[API_PrintJoinUsage|PrintJoinUsage]]'''() -> nil :: prints how to use /join to the chatarea
Line 479: Line 538:
'''[[API_PrintTransactionTable|PrintTransactionTable]]'''() -> nil :: print pending transactions.
'''[[API_PrintTransactionTable|PrintTransactionTable]]'''() -> nil :: print pending transactions.


'''[[API_ProcessEvent|ProcessEvent]]'''(string eventtype, data) -> nil :: Processes various events. Trigger a with [[Function_Index#RegisterEvent]] defined event
'''[[API_ProcessEvent|ProcessEvent]]'''(string eventtype, data) -> nil :: Processes various events. Trigger a with [[API_RegisterEvent|RegisterEvent]] defined event


'''[[API_PurchaseMerchandiseItem|PurchaseMerchandiseItem]]'''(int itemid, int amount) -> nil :: buy the provided item
'''[[API_PurchaseMerchandiseItem|PurchaseMerchandiseItem]]'''(int itemid, int amount, function callback) -> nil :: buy the provided item


'''[[API_PurchaseShipLoadout|PurchaseShipLoadout]]'''(func arg1) -> ?? :: no clue takes function as first argument
'''[[API_PurchaseShipLoadout|PurchaseShipLoadout]]'''(function buybackdone_cb(boolean success), loadout) -> nil :: Buys ship presets as stored in ShipPresets table. buybackdone_cb is called on success/failure.


'''[[API_RegisterEvent|RegisterEvent]]'''({func OnEvent}, string eventtype) -> nil :: hook up object to event. the obect is a table with a method called OnEvent that is called when the event is triggered
'''[[API_RegisterEvent|RegisterEvent]]'''(object eventhandler, string eventtype) -> nil :: Hook up object to event


'''[[API_RegisterUserCommand|RegisterUserCommand]]'''(string commandname, func callback(dataarg, {arguments1, ..}), data) -> nil :: hook up object to command
'''[[API_RegisterUserCommand|RegisterUserCommand]]'''(string commandname, func callback(dataarg, {arguments1, ..}), data) -> nil :: hook up object to command
Line 491: Line 550:
'''[[API_ReinitIconPositions|ReinitIconPositions]]'''(timer icontimer, int ship, userdata viewport, table iconlist, userdata iconcontainer, table ipcache) -> nil :: Setup icons in a viewport
'''[[API_ReinitIconPositions|ReinitIconPositions]]'''(timer icontimer, int ship, userdata viewport, table iconlist, userdata iconcontainer, table ipcache) -> nil :: Setup icons in a viewport


'''[[API_ReloadInterface|ReloadInterface]]'''() -> nil :: Reloads everything related to the interface that isn't a texture. This means VO lua scripts as well as scripts in the /plugins directory.
'''[[API_ReloadInterface|ReloadInterface]]'''() -> nil :: Reloads everything related to the interface that isn't a texture


'''[[API_RentStorage|RentStorage]]'''(int storage) -> nil :: Rent storage space at the current station.
'''[[API_RentStorage|RentStorage]]'''(int storage) -> nil :: Rent storage space at the current station.


'''[[API_RepairShip|RepairShip]]'''() -> ?? :: not tested
'''[[API_RepairShip|RepairShip]]'''(int itemid, int x, func cb) -> nil :: Repairs the ship itemid in the station


'''[[API_ReplenishAll|ReplenishAll]]'''(int itemid, func cb) -> nil :: replenish all weapons on provided ship
'''[[API_ReplenishAll|ReplenishAll]]'''(int itemid, func cb) -> nil :: replenish all weapons on provided ship
Line 505: Line 564:
'''[[API_RequestLaunch|RequestLaunch]]'''() -> bool ret :: Launches from the station. Any issues preventing launch are reported via pop-up window. Otherwise, the player's ship undocks.  
'''[[API_RequestLaunch|RequestLaunch]]'''() -> bool ret :: Launches from the station. Any issues preventing launch are reported via pop-up window. Otherwise, the player's ship undocks.  


'''[[API_RequestMissionDetails|RequestMissionDetails]]'''(int missionid) -> nil :: Request information about the given mission (aka the info button) and pop up [[API_Index#MissionPromptDialog]] if id is valid
'''[[API_RequestMissionDetails|RequestMissionDetails]]'''(int missionid) -> nil :: '''(Deprecated)'''Request information about the given mission (aka the info button)
 
'''[[API_RequestMissionExtendedDescription|RequestMissionExtendedDescription]]'''(string missionid, int stationid) -> bool :: Requests an extended mission description; result is received via the MISSION_QUESTION_OPEN event


'''[[API_RequestMissionList|RequestMissionList]]'''() -> nil :: no clue. maybe used by /updatestation
'''[[API_RequestMissionList|RequestMissionList]]'''() -> nil :: no clue. maybe used by /updatestation


'''[[API_RequestNewsArticle|RequestNewsArticle]]'''(int newsindex) -> nil :: ask server for news item(?)
'''[[API_RequestNewsArticle|RequestNewsArticle]]'''(int newsindex) -> nil :: ask server for news item(?)
fills [[API_Index#NewsDialog]] with given news item
fills [[API_NewsDialog]] with given news item


'''[[API_RequestNewsHeadlines|RequestNewsHeadlines]]'''() -> nil :: ask server for news item list?
'''[[API_RequestNewsHeadlines|RequestNewsHeadlines]]'''() -> nil :: ask server for news item list?
'''[[API_RequestNewspostInfo|RequestNewspostInfo]]'''(int id) -> nil :: Request a news item. The result is returned with the UPDATE_NEWS event
'''[[API_RequestOccasionInfo|RequestOccasionInfo]]'''(int id) -> nil :: Request an occassion item (event). The result is returned with the UPDATE_NEWS event


'''[[API_RequestTargetStats|RequestTargetStats]]'''() -> int charid :: get character id of target (considreing the name maybe more?)
'''[[API_RequestTargetStats|RequestTargetStats]]'''() -> int charid :: get character id of target (considreing the name maybe more?)
Line 530: Line 595:
'''[[API_SaveNavpath|SaveNavpath]]'''({int sectorid1 ..}, string name) -> nil :: Save the provided navroute
'''[[API_SaveNavpath|SaveNavpath]]'''({int sectorid1 ..}, string name) -> nil :: Save the provided navroute


'''[[API_SaveShipLoadout|SaveShipLoadout]]'''() -> ?? :: save shiploadout? after a ClearLastShipLoadout() this function causes the buy back dialog to pop up again but the ship won't be rebought.. maybe it needs a loadout as arg
'''[[API_SaveShipLoadout|SaveShipLoadout]]'''(int itemid) -> table preset :: create a preset from the given ships loadout


'''[[API_SectorIDFromLocationStr|SectorIDFromLocationStr]]'''(string location) -> int sectorid :: Convert a location string into a [[sectorid]].
'''[[API_SectorIDFromLocationStr|SectorIDFromLocationStr]]'''(string location) -> int sectorid :: Convert a location string into a [[sectorid]].
Line 536: Line 601:
'''[[API_SelectActiveShip|SelectActiveShip]]'''(int itemid) -> nil :: Set the given ship active
'''[[API_SelectActiveShip|SelectActiveShip]]'''(int itemid) -> nil :: Set the given ship active


'''[[API_SelectCharacter|SelectCharacter]]'''(int charslot) -> nil :: Select characteri in given slot and enter the game with it (only "works" when you haven'T one selected yet)
'''[[API_SelectCharacter|SelectCharacter]]'''(int charslot) -> nil :: Select character in given slot and enter the game with it


'''[[API_SellInventoryItem|SellInventoryItem]]'''(int itemid, int amount) -> nil :: Sell the provided amount of an inventory item from the current station or ship when docked to a station
'''[[API_SellInventoryItem|SellInventoryItem]]'''(int itemid, int amount) -> nil :: Sell the provided amount of an inventory item from the current station or ship


'''[[API_SendChat|SendChat]]'''(string msg, string dst, string dstparam) -> nil :: Send a message to the provided destination.
'''[[API_SendChat|SendChat]]'''(string msg, string dst, string dstparam) -> nil :: Send a message to the provided destination.


'''[[API_SendMissionQuestionResponse|SendMissionQuestionResponse]]'''(int num) -> nil :: called by the initial info dialog 1 = accept, 0 = decline
'''[[API_SendMissionQuestionResponse|SendMissionQuestionResponse]]'''(int num) -> nil :: '''(Deprecated)'''called by the initial info dialog 1 = accept, 0 = decline


'''[[API_SetChatLogRead|SetChatLogRead]]'''() -> nil :: Mark the general chat log as read/displayed
'''[[API_SetChatLogRead|SetChatLogRead]]'''() -> nil :: Mark the general chat log as read/displayed
Line 557: Line 622:


'''[[API_SetProximityWarningDistance|SetProximityWarningDistance]]'''(int dist) -> nil :: set proximity warning distance ..
'''[[API_SetProximityWarningDistance|SetProximityWarningDistance]]'''(int dist) -> nil :: set proximity warning distance ..
'''[[API_SetProximityWarningTimeout|SetProximityWarningTimeout]]'''(int timeout) -> nil :: Set minimum time between proximity warnings


'''[[API_SetShipPurchaseColor|SetShipPurchaseColor]]'''(int color) -> nil :: color of the next ship the player will buy
'''[[API_SetShipPurchaseColor|SetShipPurchaseColor]]'''(int color) -> nil :: color of the next ship the player will buy
Line 571: Line 638:


'''[[API_ShouldTutorialRun|ShouldTutorialRun]]'''() -> bool tut :: tell if the player has done the tutorial
'''[[API_ShouldTutorialRun|ShouldTutorialRun]]'''() -> bool tut :: tell if the player has done the tutorial
'''[[API_SplitLocationID|SplitLocationID]]'''(int stationid) -> int sectorid stationidx :: split up a stationid into sectorid and station index


'''[[API_SplitSectorID|SplitSectorID]]'''(int sectorid) -> int systemid sectorh sectorv  :: split up a sectorid into systemid and axis on the system grid  
'''[[API_SplitSectorID|SplitSectorID]]'''(int sectorid) -> int systemid sectorh sectorv  :: split up a sectorid into systemid and axis on the system grid  


'''[[API_SplitStationID|SplitStationID]]'''(int stationid) -> int systemidl sectorhv :: split up a stationid into systemid -1 and sector in system. this may be totally wrong
'''[[API_SplitStationID|SplitStationID]]'''(int stationid) -> int systemidl sectorhv :: :: split up a stationid into sectorid and station index


'''[[API_StartSellInventoryItem|StartSellInventoryItem]]'''(int itemid, function cb) -> nil :: Receive instant price updates for the given item.
'''[[API_StartSellInventoryItem|StartSellInventoryItem]]'''(int itemid, function cb) -> nil :: Receive instant price updates for the given item.
Line 596: Line 665:
'''[[API_UnloadSellCargo|UnloadSellCargo]]'''({{int itemid, int quantity} ..}, function cb) -> nil :: Unload and sell cargo items and quantities according to the provided table  
'''[[API_UnloadSellCargo|UnloadSellCargo]]'''({{int itemid, int quantity} ..}, function cb) -> nil :: Unload and sell cargo items and quantities according to the provided table  


'''[[API_UnregisterEvent|UnregisterEvent]]'''({func OnEvent}, string eventtype) -> nil :: Unregister an event registered with [[Function_Index#RegisterEvent]]
'''[[API_UnregisterEvent|UnregisterEvent]]'''(object, string eventtype) -> nil :: Unregister an object registered with [[API_RegisterEvent|RegisterEvent]]


'''[[API_UnregisterUserCommand|UnregisterUserCommand]]'''(string command) -> nil :: Unregister a command registered with [[API Index#RegisterUserCommand|RegisterUserCommand]]
'''[[API_UnregisterUserCommand|UnregisterUserCommand]]'''(string command) -> nil :: Unregister a command registered with [[API Index#RegisterUserCommand|RegisterUserCommand]]


'''[[API_UnrentStorage|UnrentStorage]]'''(int storage) -> nil :: Unrent storage space at the current station.
'''[[API_UnrentStorage|UnrentStorage]]'''(int storage) -> nil :: Unrent storage space at the current station.
'''[[API_UpdateAllRadarFriendlyStatus|UpdateAllRadarFriendlyStatus]]'''() -> nil :: Update the radar with the new status when overriding GetFriendlyStatus
'''[[API_UpdateRadarFriendlyStatus|UpdateRadarFriendlyStatus]]'''(int nodeid) -> nil :: Update the radar with the new status when overriding GetFriendlyStatus


'''[[API_XMLTagToString|XMLTagToString]]'''() -> nil :: might the reverse of ParseXML
'''[[API_XMLTagToString|XMLTagToString]]'''() -> nil :: might the reverse of ParseXML
Line 606: Line 679:
'''[[API__ERRORMESSAGE|_ERRORMESSAGE]]'''(string msg) -> nil :: creates an error message with the provided string. probably more
'''[[API__ERRORMESSAGE|_ERRORMESSAGE]]'''(string msg) -> nil :: creates an error message with the provided string. probably more


'''[[API_assert|assert]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_assert|assert]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-assert]


'''[[API_bbhash|bbhash]]'''(string input, int arg2) -> string hash :: Seems to be some kind of hash function
'''[[API_bbhash|bbhash]]'''(string input, int arg2) -> string hash :: Seems to be some kind of hash function
Line 614: Line 687:
'''[[API_clearscene|clearscene]]'''() -> nil :: removes al objects from the game world
'''[[API_clearscene|clearscene]]'''() -> nil :: removes al objects from the game world


'''[[API_collectgarbage|collectgarbage]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_collectgarbage|collectgarbage]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-collectgarbage]


'''[[API_comma_value|comma_value]]'''(float number) -> string formatted_number :: returns a formatted version of the provided number according to [[API_Index#SI_unit]]
'''[[API_comma_value|comma_value]]'''(float number) -> string formatted_number :: returns a formatted version of the provided number according to [[API_Index#SI_unit]]


'''[[API_console_clear|console_clear]]'''() -> nil :: clear console on the next [[API_Index#ReloadInterface]]
'''[[API_console_clear|console_clear]]'''() -> nil :: clear console on the next [[API_ReloadInterface]]


'''[[API_console_print|console_print]]'''(string text) -> nil :: print the given string to the ingame console
'''[[API_console_print|console_print]]'''(string text) -> nil :: print the given string to the ingame console
Line 628: Line 701:
'''[[API_deviceByMode|deviceByMode]]'''(table arg1, mode) -> table ret :: not sure. possibly to find audio devices by capability
'''[[API_deviceByMode|deviceByMode]]'''(table arg1, mode) -> table ret :: not sure. possibly to find audio devices by capability


'''[[API_dofile|dofile]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_dofile|dofile]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-dofile]


'''[[API_error|error]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_error|error]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-error]


'''[[API_factionfriendlyness|factionfriendlyness]]'''(int standing) -> string name :: get string that represents the given faction standing  
'''[[API_factionfriendlyness|factionfriendlyness]]'''(int standing) -> string name :: get string that represents the given faction standing  
Line 648: Line 721:
'''[[API_hextorgb|hextorgb]]'''(string hexcolors) -> string deccolors :: Convert hexadecimal formated color string into a decimal one used by [[iup]]
'''[[API_hextorgb|hextorgb]]'''(string hexcolors) -> string deccolors :: Convert hexadecimal formated color string into a decimal one used by [[iup]]


'''[[API_ipairs|ipairs]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_ipairs|ipairs]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-ipairs]


'''[[API_load|load]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_load|load]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-load]


'''[[API_loadfile|loadfile]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_loadfile|loadfile]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-loadfile]


'''[[API_loadscene|loadscene]]'''(string scene) -> ?? :: load a scene(?). don't know how it works though
'''[[API_loadscene|loadscene]]'''(string scene) -> ?? :: load a scene(?). don't know how it works though


'''[[API_loadstring|loadstring]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_loadstring|loadstring]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-loadstring]


'''[[API_log_chat|log_chat]]'''(string str) -> nil :: Writes current time and given string to the errors.log
'''[[API_log_chat|log_chat]]'''(string str) -> nil :: Writes current time and given string to the errors.log
Line 662: Line 735:
'''[[API_log_print|log_print]]'''(string str) -> nil :: Writes string to the errors.log
'''[[API_log_print|log_print]]'''(string str) -> nil :: Writes string to the errors.log


'''[[API_next|next]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_next|next]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-next]


'''[[API_oper|oper]]''' :: not gonna bother
'''[[API_oper|oper]]''' :: not gonna bother


'''[[API_pairs|pairs]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_pairs|pairs]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-pairs]


'''[[API_pcall|pcall]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_pcall|pcall]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-pcall]


'''[[API_print|print]]'''(string str) -> nil :: print given string to the chat area
'''[[API_print|print]]'''(string str) -> nil :: print given string to the chat area
Line 674: Line 747:
'''[[API_printtable|printtable]]'''{in} -> nil :: print contents of a table to the console
'''[[API_printtable|printtable]]'''{in} -> nil :: print contents of a table to the console


'''[[API_purchaseprint|purchaseprint]]'''(string str) -> nil :: print given string to the chat area via CHAT_MSG_CONFIRMATION event. Results in white text by default. Same as when buying or selling  things.
'''[[API_purchaseprint|purchaseprint]]'''(string str) -> nil :: print given string to the chat area via CHAT_MSG_CONFIRMATION event.
 
'''[[API_rawequal|rawequal]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-rawequal]


'''[[API_rawequal|rawequal]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_rawget|rawget]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-rawget]


'''[[API_rawget|rawget]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_rawset|rawset]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-rawset]


'''[[API_rawset|rawset]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_require|require]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-require]


'''[[API_rgbtohex|rgbtohex]]'''(string deccolor) -> string hexcolor :: Returns string containing escaped hexadecimal version of the in decimal given color
'''[[API_rgbtohex|rgbtohex]]'''(string deccolor) -> string hexcolor :: Returns string containing escaped hexadecimal version of the in decimal given color
Line 688: Line 763:
'''[[API_sectorprint|sectorprint]]'''(string str) -> nil :: print given string to the chat area via CHAT_MSG_SERVER_SECTOR event. Results in white text by default.
'''[[API_sectorprint|sectorprint]]'''(string str) -> nil :: print given string to the chat area via CHAT_MSG_SERVER_SECTOR event. Results in white text by default.


'''[[API_select|select]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_select|select]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-select]
 
'''[[API_sort_commodities|sort_commodities]]'''(table a, b) -> bool order :: Sort function for [[iteminfo]] tables. See table.sort in the lua reference
 
'''[[API_sort_sellable_commodities|sort_sellable_commodities]]'''(table a, b) -> bool order :: Sort function for [[iteminfo]] tables that prioritizes items in the active ship. See table.sort in the lua reference
 
'''[[API_storagelocationcompare|storagelocationcompare]]'''(int a, b) -> bool order :: Sort function for [[locationid]] values. See table.sort in the lua reference


'''[[API_spickle|spickle]]'''(table intab) -> string :: Converts a table into a string roughly of the format "value","value",{"tablevalue","tablevalue";tablekey="value"};key="value",key="value"
'''[[API_spickle|spickle]]'''(table intab) -> string :: Converts a table into a string roughly of the format "value","value",{"tablevalue","tablevalue";tablekey="value"};key="value",key="value"
Line 698: Line 779:
'''[[API_tabcomplete|tabcomplete]]''' :: produces lua error..
'''[[API_tabcomplete|tabcomplete]]''' :: produces lua error..


'''[[API_tonumber|tonumber]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_testconquered|testconquered]]'''(int sectorid, factionid) -> nil :: test function. sets conquerer of the given sector


'''[[API_tostring|tostring]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_tonumber|tonumber]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-tonumber]


'''[[API_type|type]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_tostring|tostring]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-tostring]


'''[[API_unpack|unpack]]''' :: [http://www.lua.org/manual/5.0/manual.html#5.1]
'''[[API_type|type]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-type]
 
'''[[API_unpack|unpack]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-unpack]


'''[[API_undeclare|undeclare]]'''(string name) -> nil :: undeclare a variable created with [[Function_Index#declare]]
'''[[API_undeclare|undeclare]]'''(string name) -> nil :: undeclare a variable created with [[Function_Index#declare]]
Line 710: Line 793:
'''[[API_unspickle|unspickle]]'''(string in) ->  table outtab :: Converts a spickled string into a table
'''[[API_unspickle|unspickle]]'''(string in) ->  table outtab :: Converts a spickled string into a table


'''[[API_xpcall|xpcall]]''' :: [http://www.lua.org/manual/5.1/manual.html#pdf-xpcall]


== Tables ==
== Tables ==


[[API_Bitlib|'''Bitlib''']]
'''[[Bitlib]]''' :: functions to manipulate the bitwise operations
 
functions to manipulate the bitwise operations
 
= Interface =
 
== Functions ==
 
'''[[API_AccomplishmentTemplate|AccomplishmentTemplate]]'''(function cb(string desc)) -> userdate box :: Create box with accomplishment icons (targetinfo dialog). see: [[AccomplishmentTemplate]]
 
'''[[API_AccomplishmentTemplate2|AccomplishmentTemplate2]]'''(function cb(string desc, int type, level)) -> userdate box :: Create list with accomplishment icons (pda playerinfo dialog). see: [[AccomplishmentTemplate]]
 
'''[[API_ChatLogTemplate|ChatLogTemplate]]'''(string bg, string scrolledbg, function updatecb, string editbg, bool clickable) -> table container :: Create rudimentary chet container. See [[ChatLogTemplate]]
 
'''[[API_CreateBig3DViewMenu|CreateBig3DViewMenu]]'''() -> userdata dialog :: Create [[API_Index#Big3DViewDialog|Big3DViewDialog]] a [[Big3DViewDialog]]
 
'''[[API_CreateCancelLoadoutMenu|CreateCancelLoadoutMenu]]'''() -> userdata dialog :: Create fullscreen dialog with button and message. See [[MessageDialog]]
 
'''[[API_CreateCapShipChatTab|CreateCapShipChatTab]]'''() -> userdata box :: Create box with "Ship Com" tab. See [[ChatLogTemplate]]
 
'''[[API_CreateCapShipFactionInfo|CreateCapShipFactionInfo]]'''() -> userdata box ::
 
'''[[API_CreateCapShipPDATab|CreateCapShipPDATab]]'''() -> userdata box ::
 
'''[[API_CreateCapShipRepairTab|CreateCapShipRepairTab]]'''() -> userdata box ::
 
'''[[API_CreateCapShipTacticalTab|CreateCapShipTacticalTab]]'''() -> userdata box ::
 
'''[[API_CreateCapShipTurretTab|CreateCapShipTurretTab]]'''() -> userdata box, button :: Create [[CapShipTurretTab]] and the select button
 
'''[[API_CreateCharCreateFailedMenu|CreateCharCreateFailedMenu]]'''() -> userdata dialog :: Create fullscreen dialog with button and message. See [[MessageDialog]]
The created variant pops up [[API_Index#CharCreateDialog|CharCreateDialog]] after clicking the button
 
'''[[API_CreateCharCreateMenu|CreateCharCreateMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateCharSelectFailedMenu|CreateCharSelectFailedMenu]]'''() -> userdata dialog :: Create fullscreen dialog with button and message. See [[MessageDialog]]
The created variant pops up [[API_Index#CharSelectDialog|CharSelectDialog]] after clicking the button
 
'''[[API_CreateCharSelectMenu|CreateCharSelectMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateCharacterPDATab|CreateCharacterPDATab]]'''() -> userdata box, tab1, tab2, tab3 ::
 
'''[[API_CreateCommPDATab|CreateCommPDATab]]'''() -> userdata box ::
 
'''[[API_CreateConnectingMenu|CreateConnectingMenu]]'''() -> userdata dialog :: Create fullscreen dialog with button and message. See [[MessageDialog]]
The created variant logs out after clicking the button
 
'''[[API_CreateCreditsDialog|CreateCreditsDialog]]'''(userdata parent) -> userdata dialog :: Create credits dialog
 
'''[[API_CreateEULAMenu|CreateEULAMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateInvalidAmountMenu|CreateInvalidAmountMenu]]'''() -> userdata dialog :: Create fullscreen dialog with button and message. See [[msgdlgtemplate1]]
 
'''[[API_CreateInventoryPDATab|CreateInventoryPDATab]]'''() -> userdata dialog, tab1, tab2 ::
 
'''[[API_CreateKilledByPDATab|CreateKilledByPDATab]]'''() -> userdata box ::
 
'''[[API_CreateKilledPDATab|CreateKilledPDATab]]'''() -> userdata box ::
 
'''[[API_CreateLoadingMenu|CreateLoadingMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateLoginDialog|CreateLoginDialog]]'''() -> userdata dialog ::
 
'''[[API_CreateLoginHelpDialog|CreateLoginHelpDialog]]'''(userdata parent) -> userdata dialog :: Create fullscreen dialog with help text for the login screen and a close button
 
'''[[API_CreateLowGridPowerDialog|CreateLowGridPowerDialog]]'''() -> userdata dialog :: Create fullscreen dialog with low grid power error
 
'''[[API_CreateMissionAbortMenu|CreateMissionAbortMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateMissionPromptMenu|CreateMissionPromptMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateMissionsPDATab|CreateMissionsPDATab]]'''() -> userdata box, tab1, tab2, tab3, tab4, infobutton ::
 
'''[[API_CreateNavigationPDATab|CreateNavigationPDATab]]'''() -> userdata box ::
 
'''[[API_CreateNearbyShipsPDATab|CreateNearbyShipsPDATab]]'''() -> userdata box ::
 
'''[[API_CreateNewsMenu|CreateNewsMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateNotEnoughStorageMenu|CreateNotEnoughStorageMenu]]'''() -> userdata dialog :: Create fullscreen dialog with button and message. See [[msgdlgtemplate1]]
 
'''[[API_CreateNotificationMenu|CreateNotificationMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateOptionsMenu|CreateOptionsMenu]]'''() -> userdata dialog ::
 
'''[[API_CreatePDA|CreatePDA]]'''() -> userdata dialog ::
 
'''[[API_CreatePDATab1|CreatePDATab1]]'''() -> userdata box ::
 
'''[[API_CreatePVPTab|CreatePVPTab]]'''() -> userdata box ::
 
'''[[API_CreateQuantityPurchaseMenu|CreateQuantityPurchaseMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateSensorPDATab|CreateSensorPDATab]]'''() -> userdata box, tab1, tab2, tab3, tab4, tab5 ::
 
'''[[API_CreateShipCargoPDATab|CreateShipCargoPDATab]]'''() -> userdata box ::
 
'''[[API_CreateShipPDATab|CreateShipPDATab]]'''() -> userdata box, tab1 ::
 
'''[[API_CreateStation|CreateStation]]'''() -> userdata dialog ::
 
'''[[API_CreateStationBlankTab|CreateStationBlankTab]]'''() -> userdata box ::
 
'''[[API_CreateStationChatTab|CreateStationChatTab]]'''() -> userdata box ::
 
'''[[API_CreateStationCommerceTab|CreateStationCommerceTab]]'''() -> userdata box ::
 
'''[[API_CreateStationCommoditiesBuyTab|CreateStationCommoditiesBuyTab]]'''() -> userdata box ::
 
'''[[API_CreateStationCommoditiesLoadTab|CreateStationCommoditiesLoadTab]]'''() -> userdata box ::
 
'''[[API_CreateStationCommoditiesSellTab|CreateStationCommoditiesSellTab]]'''() -> userdata box ::
 
'''[[API_CreateStationCommoditiesTab|CreateStationCommoditiesTab]]'''() -> userdata box ::
 
'''[[API_CreateStationEquipmentBuyTab|CreateStationEquipmentBuyTab]]'''() -> userdata box ::
 
'''[[API_CreateStationEquipmentManageTab|CreateStationEquipmentManageTab]]'''() -> userdata box ::
 
'''[[API_CreateStationEquipmentSellTab|CreateStationEquipmentSellTab]]'''() -> userdata box :: Unused. Creates old equipment sell tab.
 
'''[[API_CreateStationEquipmentTab|CreateStationEquipmentTab]]'''() -> userdata box ::
 
'''[[API_CreateStationFactionInfo|CreateStationFactionInfo]]'''() -> userdata dialog :: Create [[StationFactionInfo]]
 
'''[[API_CreateStationHelpMenu|CreateStationHelpMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateStationMissionBuyTab|CreateStationMissionBuyTab]]'''() -> userdata box, button ::
 
'''[[API_CreateStationPDATab|CreateStationPDATab]]'''() -> userdata box ::
 
'''[[API_CreateStationPortConfigTab|CreateStationPortConfigTab]]'''() -> userdata box ::
 
'''[[API_CreateStationShipPurchaseTab|CreateStationShipPurchaseTab]]'''() -> userdata box, button ::
 
'''[[API_CreateStationShipSelectionTab|CreateStationShipSelectionTab]]'''() -> userdata box ::
 
'''[[API_CreateStationShipStatusTab|CreateStationShipStatusTab]]'''() -> userdata box :: Unused. Creates old ship status tab.
 
'''[[API_CreateStationVisitsPDATab|CreateStationVisitsPDATab]]'''() -> userdata box ::
 
'''[[API_CreateStationWelcomeTab|CreateStationWelcomeTab]]'''() -> userdata box ::
 
'''[[API_CreateStorageRentalDialog|CreateStorageRentalDialog]]'''() -> userdata dialog :: Create storage rental dialog
 
'''[[API_CreateSurveyMenu|CreateSurveyMenu]]'''() -> userdata dialog ::
 
'''[[API_CreateTargetInfo|CreateTargetInfo]]'''() -> userdata box ::
 
'''[[API_CreateVoiceChatOptions|CreateVoiceChatOptions]]'''() -> userdata dialog :: Create Voicechat options dialog
 
'''[[API_FactionStandingTemplate|FactionStandingTemplate]]'''(function cb, frame, filler, string expand) -> userdata container :: Creates a container with a list of faction standings of a character. Details: [[FactionStandingTemplate]]
 
'''[[API_FactionStandingWithInfoTemplate|FactionStandingWithInfoTemplate]]'''() -> userdata container :: Wrapper around [[API_Index#FactionStandingTemplate|FactionStandingTemplate]] that adds faction descriptions to the list.
 
'''[[API_FadeControl|FadeControl]]'''(userdata control, int timetofade, float startalpha, endalpha, function cb, ...) -> nil :: Fade an iup control by modifying its alpha field. Usually a label.
 
'''[[API_FadeLookup|FadeLookup]]'''(userdata control) -> table fi :: Get a fade info table of a control that is currently being faded.
 
'''[[API_FadeStop|FadeStop]]'''(userdata control) -> nil :: Stop fading a control
 
'''[[API_FillInObjectInfo|FillInObjectInfo]]'''(string name, desc) -> nil :: Put given name and description into the character info dialog
 
'''[[API_FillInPlayerInfo|FillInPlayerInfo]]'''(int charid) -> nil :: Fill character info dialog with info of given character
 
'''[[API_GetChatLogReadState|GetChatLogReadState]]'''() -> bool read :: Tell if the general chat log was displayed. [[API_Index#SetChatLogRead|SetChatLogRead]] was called since the last line was added to the log.
 
'''[[API_GetCurrentChatTab|GetCurrentChatTab]]'''() -> int tab :: Unused. Get The current chat tab (general chat or mission chat)
 
'''[[API_GetMissionLogReadState|GetMissionLogReadState]]'''GetMissiontLogReadState() -> bool read :: Tell if the mission chat/advanmcement log was displayed. [[API_Index#SetMissionLogRead|SetMissionLogRead]] was called since the last line was added to the log.
 
'''[[API_GetProfitColor|GetProfitColor]]'''(int price, cost) -> string color :: get color depending on the given prices
 
'''[[API_GetProfitHexColor|GetProfitHexColor]]'''(int price, cost) -> string color :: get color in hex format depending on the given prices
 
'''[[API_GetStationLogReadState|GetStationLogReadState]]'''() -> bool read :: Tell if the stationlog/bar was displayed. [[API_Index#SetStationLogRead|SetStationLogRead]] was called since the last line was added to the log.
 
'''[[API_HelpCharAccom|HelpCharAccom]]''' :: [[helpfunc]]
 
'''[[API_HelpCharFaction|HelpCharFaction]]''' :: [[helpfunc]]
 
'''[[API_HelpCharGuild|HelpCharGuild]]''' :: [[helpfunc]]
 
'''[[API_HelpCharInventory|HelpCharInventory]]''' :: [[helpfunc]]
 
'''[[API_HelpCharStats|HelpCharStats]]''' :: [[helpfunc]]
 
'''[[API_HelpCommoditiesAction|HelpCommoditiesAction]]''' :: [[helpfunc]]
 
'''[[API_HelpGridPower|HelpGridPower]]''' :: [[helpfunc]]
 
'''[[API_HelpIgnore|HelpIgnore]]''' :: [[helpfunc]]
 
'''[[API_HelpLargeAddonsAction|HelpLargeAddonsAction]]''' :: [[helpfunc]]
 
'''[[API_HelpOtherAddonsAction|HelpOtherAddonsAction]]''' :: [[helpfunc]]
 
'''[[API_HelpPDAAdvancementLog|HelpPDAAdvancementLog]]''' :: [[helpfunc]]
 
'''[[API_HelpPDAJettison|HelpPDAJettison]]''' :: [[helpfunc]]
 
'''[[API_HelpPDAKilledByList|HelpPDAKilledByList]]''' :: [[helpfunc]]
 
'''[[API_HelpPDAKilledList|HelpPDAKilledList]]''' :: [[helpfunc]]


'''[[API_HelpPDAMissionLog|HelpPDAMissionLog]]''' :: [[helpfunc]]
'''[[Buddy]]''' :: functions to manipulate the characters buddylist


'''[[API_HelpPDAMissionNotes|HelpPDAMissionNotes]]''' :: [[helpfunc]]
'''[[Duel]]''' :: Duel related methods


'''[[API_HelpPDANearbyShips|HelpPDANearbyShips]]''' :: [[helpfunc]]
'''[[FactionArticle]]''' :: table with faction articles. indices represent [[factionid]]. see: [[API_Article|Article]]


'''[[API_HelpPDAPVPList|HelpPDAPVPList]]''' :: [[helpfunc]]
'''[[FactionColor]]''' :: table with faction colors. indices represent [[factionid]]


'''[[API_HelpPDAStationVisitsList|HelpPDAStationVisitsList]]''' :: [[helpfunc]]
'''[[FactionColor_RGB]]''' :: table that maps [[factionid]]'s to colors in RGB format


'''[[API_HelpSellAction|HelpSellAction]]''' :: [[helpfunc]]
'''[[FactionMonitor]]''' :: table with monitoring types. indices represent numeric monitoring types and values, string representations of that type


'''[[API_HelpSellAddons|HelpSellAddons]]''' :: [[helpfunc]]
'''[[FactionMonitorStr]]''' :: table with monitoring types. values represent numeric monitoring types and indices, string representations of that type


'''[[API_HelpSellCommodities|HelpSellCommodities]]''' :: [[helpfunc]]
'''[[FactionName]]''' :: Array with short names of the ingame faction


'''[[API_HelpShipAmmo|HelpShipAmmo]]''' :: [[helpfunc]]
'''[[FactionNameFull]]''' :: Array with long names of the ingame faction


'''[[API_HelpShipCargo|HelpShipCargo]]''' :: [[helpfunc]]
'''[[FactionStanding]]''' :: table for mapping names of standing levels to it#s int value


'''[[API_HelpShipEquip|HelpShipEquip]]''' :: [[helpfunc]]
'''[[FriendKeys]]''' :: taable friend key related functions


'''[[API_HelpShipGroup|HelpShipGroup]]''' :: [[helpfunc]]
'''[[Game]]''' :: functions to control a few game features ..


'''[[API_HelpShipPurchase|HelpShipPurchase]]''' :: [[helpfunc]]
'''[[GeneralChatPanel]]''' :: table with parts of a chat area.
seems to point to PDA or HUD chat panel depending on what is visible(?)


'''[[API_HelpShipSelect|HelpShipSelect]]''' :: [[helpfunc]]
'''[[Group]]''' :: Group related functions


'''[[API_HelpShipStatus|HelpShipStatus]]''' :: [[helpfunc]]
'''[[Guild]]''' :: Guild related functions


'''[[API_HelpSmallAddonsAction|HelpSmallAddonsAction]]''' :: [[helpfunc]]
'''[[Gunner]]''' :: Gunner related functions for multiplayer ships


'''[[API_HelpStationAddonEquip|HelpStationAddonEquip]]''' :: [[helpfunc]]
'''[[HUD]]''' :: HUD related functions


'''[[API_HelpStationAddonGroups|HelpStationAddonGroups]]''' :: [[helpfunc]]
'''[[Ignore]]''' :: Ignorelist related functions


'''[[API_HelpStationBuddies|HelpStationBuddies]]''' :: [[helpfunc]]
'''[[InvManager]]''' :: functions to get information about inventory items


'''[[API_HelpStationMission|HelpStationMission]]''' :: [[helpfunc]]
'''[[lcd]]''' ->  :: functions for the Logitech G-series keyboard screens


'''[[API_HelpStationNav|HelpStationNav]]''' :: [[helpfunc]]
'''[[Keychain]]''' :: keychain management


'''[[API_HelpStationNews|HelpStationNews]]''' :: [[helpfunc]]
'''[[Mentor]]''' :: Mentor related functions


'''[[API_HelpStationWelcome|HelpStationWelcome]]''' :: [[helpfunc]]
'''[[MissionLogPanel]]''' :: table with parts of the mission log


'''[[API_HelpSystemNotes|HelpSystemNotes]]''' :: [[helpfunc]]
'''[[NavRoute]]''' :: functions to manipulate your NavRoute


'''[[API_HelpVoiceChat|HelpVoiceChat]]''' :: [[helpfunc]]
'''[[ShipOrder]]''' :: table containing the ordering of ships in lists(?)


'''[[API_HideAllDialogs|HideAllDialogs]]'''() -> nil :: Hide all dialogs that were shown with [[API_Index#ShowDialog|ShowDialog]] or [[API_Index#PopupDialog|PopupDialog]]
'''[[ShipPalette]]''' :: array that maps palette color values (1-256) to rgb values represented as gvectors


'''[[API_HideDialog|HideDialog]]'''(userdata dialog) -> nil :: Hide a dialog that was shown with [[API_Index#ShowDialog|ShowDialog]] or [[API_Index#PopupDialog|PopupDialog]]
'''[[ShipPalette_string]]''' :: array that maps palette color values (1-256) to rgb values represented as strings


'''[[API_HideTooltip|HideTooltip]]'''() -> nil :: Hide [[API_Index#ToolTip|ToolTip]], the tooltip dialog
'''[[ShipPresets]]''' :: array with properties of ship presets


'''[[API_PopupDialog|PopupDialog]]'''(userdata dialog, int x, y) -> nil :: Wrapper around [[iup#Popup|iup.Popup]] that allows the dialog to be closed with [[API_Index#HideDialog|HideDialog]] or [[API_Index#HideAllDialogs|HideAllDialogs]]
'''[[ShipSkinNames]]''' :: array containing livery names


'''[[API_ShowDialog|ShowDialog]]'''(userdata dialog, int x, y) -> nil :: Wrapper around [[iup#Show|iup.Show]] that allows the dialog to be closed with [[API_Index#HideDialog|HideDialog]] or [[API_Index#HideAllDialogs|HideAllDialogs]]
'''[[ShipSkinDescriptions]]''' :: array containing livery descriptions


'''[[API_ShowTooltip|ShowTooltip]]'''(int x, y, string text) -> nil :: Show the [[API_Index#ToolTip|ToolTip]] the tooltip dialog with the given text
'''[[Skills]]''' :: table to translate skillid's into skill names and back


'''[[API_StopTutorial|StopTutorial]]'''() -> nil :: does nothing..
'''[[SystemNames]]''' :: Table to translate systemid's into system names and back.  


'''[[API_TutorialEnd|TutorialEnd]]'''() -> nil :: finish up the tutorial
'''[[SystemNotes]]''' :: System Notes public table. Used for adding notes to the navmap.


'''[[API_TutorialPart1|TutorialPart1]]'''() -> nil :: Launch a tutorial segment
'''[[TagFuncs]]''' :: Text markup callbacks(?)


'''[[API_TutorialPart2|TutorialPart2]]'''() -> nil :: Launch a tutorial segment
'''[[TCPSocket]]''' :: socket class


'''[[API_TutorialPart3|TutorialPart3]]'''() -> nil :: Launch a tutorial segment
'''[[Thread]]''' :: Thread library


'''[[API_TutorialPart4|TutorialPart4]]'''() -> nil :: Launch a tutorial segment
'''[[Timer]]''' :: Timer class


'''[[API_TutorialPart5|TutorialPart5]]'''() -> nil :: Launch a tutorial segment
'''[[VoiceChat]]''' :: voice chat related functions


'''[[API_TutorialPart6|TutorialPart6]]'''() -> nil :: Launch a tutorial segment
'''[[Vote]]''' :: functions to use the voting feature


'''[[API_TutorialPart7|TutorialPart7]]'''() -> nil :: Launch a tutorial segment
'''[[_generalchatlog]]''' :: array with chatlog


'''[[API_TutorialPart8|TutorialPart8]]'''() -> nil :: Launch a tutorial segment
'''[[_missionlog]]''' :: array with mission log


'''[[API_TutorialPart9|TutorialPart9]]'''() -> nil :: Launch a tutorial segment
'''[[_stationlog]]''' :: array with log of visisted stations


'''[[API_TutorialPart10|TutorialPart10]]'''() -> nil :: Launch a tutorial segment
'''[[chatinfo]]''' :: table with display options for each chat event


'''[[API_TutorialPart11|TutorialPart11]]'''() -> nil :: Launch a tutorial segment
'''[[chatreceiver]]''' :: event handler for chat events


'''[[API_TutorialPart12|TutorialPart12]]'''() -> nil :: Launch a tutorial segment
'''[[command_pretty_names]]''' :: table that maps commands to their descriptions


'''[[API_TutorialPart13|TutorialPart13]]'''() -> nil :: Launch a tutorial segment
'''[[coroutine]]''' :: coroutine class


'''[[API_UpdateFade|UpdateFade]]'''(float delta) -> nil :: Do a fade step on controls registered with [[API_index#FadeControl|FadeControl]]
'''[[debug]]''' :: debugging helpers


'''[[API_chatareatemplate|chatareatemplate]]'''(string statontabname, bool expanded) -> table container :: create old style chatarea that combines general, mission and station log. the container seems to be incompatible with the [[API_Index#chatareatemplate2|chatareatemplate2]] based maximized chat containers which breaks the maximize button
'''[[gkini]]''' :: functions to manipulate the games config file


'''[[API_chatareatemplate2|chatareatemplate2]]'''(bool maximized) -> userdata box :: create a chatarea control. wrapper around [[API_Index#ChatLogTemplate|ChatLogTemplate]]
'''[[gkinterface]]''' :: interface related functions..


'''[[API_clear_accomlistbox|clear_accomlistbox]]'''(userdata control, table itemlist) -> int selection :: Clear an accomplishment list control. See: [[API_index#AccomplishmentTemplate|AccomplishmentTemplate]]
'''[[gkmisc]]''' :: misc functions ..


'''[[API_clear_listbox|clear_listbox]]'''(userdata control, table itemlist) -> int selection :: Clear a list control
'''[[gknet]]''' :: network related functions


'''[[API_create_char_guild_tab|create_char_guild_tab]]'''(bool sub) -> userdata box :: Create guild tab
'''[[gksound]]''' :: audio related functions


'''[[API_create_char_inventory_tab|create_char_inventory_tab]]'''create_char_guild_tab(bool expand_local_branches, show_prices, showsellbutton) -> userdata box, tree :: Create inventory tab
'''[[gvector]]''' :: gvector class. to create and manipulate vectors


'''[[API_create_jettison_tab|create_jettison_tab]]'''() -> userdata box ::  
'''[[ignore_time]]''' :: array with with ignored name and period entries


'''[[API_create_ship_group_template|create_ship_group_template]]'''(table iconlist, bool sub) -> userdata box :: Create weapon groups tab
'''[[joystick]]''' :: functions to change joystick settings


'''[[API_factioncontroltemplate3|factioncontroltemplate3]]'''(userdata frame, function cb, float font) -> userdata container :: Create a fancy progressbar/faction standing indicator
'''[[math3d]]''' :: functions to do some vector math


'''[[API_fill_accomlistbox|fill_accomlistbox]]'''(userdata control, table itemlist, function setup_cb, click_cb) -> table dialoglist :: fill an accomplishement listbox with [[accomlistsubdialog]]s according to given values. normally called from [[API_Index#AccomplishmentTemplate2|AccomplishmentTemplate2]]
'''[[math]]''' :: standard math library


'''[[API_fill_listbox|fill_listbox]]'''(userdata control, table itemlist, int curselindex, function setup_cb, bool show_quantity, show_price) -> table dialoglist :: fill a listbox with [[listsubdialog]]s according to given values
'''[[os]]''' :: functions to interface with the operating system


'''[[API_get_itemdlg|get_itemdlg]]'''(bool showquantity, showprice) -> table dialog :: Get a new [[listsubdialog]] or recycle one from the cache
'''[[quaternion]]''' :: quaternion class. to create and manipulate quats


'''[[API_get_jettisonitemdlg|get_jettisonitemdlg]]'''(int itemid) -> userdata dialog :: Get a new [[jettisonlistsubdialog]] or recycle one from the cache
'''[[radar]]''' :: functions to query and set radar parameters


'''[[API_getheight|getheight]]'''(userdata control) -> int height :: Get height of an iup control
'''[[string]]''' :: string manipulation functions


'''[[API_getwidth|getwidth]]'''(userdata control) -> int width :: Get width of an iup control
'''[[table]]''' :: standard table library


'''[[API_guildaccessdialogtemplate|guildaccessdialogtemplate]]'''() -> userdata dialog :: create guild access dialog
== Variables ==


'''[[API_guildactivitylogdialogtemplate|guildactivitylogdialogtemplate]]'''() -> userdata dialog :: create guild activity dialog
'''CLASSTYPE_ADDON''' -> 2 :: inventory item class of addons


'''[[API_guildbanklogdialogtemplate|guildbanklogdialogtemplate]]'''() -> userdata dialog :: create guild bank dialog
'''CLASSTYPE_FLAG''' -> 3 :: inventory item class of flags(?)


'''[[API_msgdlgtemplate1|msgdlgtemplate1]]'''(string msg, buttontext, function button_cb, string size, posx, posy, bgcolor) -> userdata dialog :: Create fullscreen dialog with button and message
'''CLASSTYPE_GENERIC''' -> 0 :: inventory item class of generic items


'''[[API_msgdlgtemplate1a|msgdlgtemplate1a]]'''(string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog :: Create a dialog and optionally disable input to the background except to the given control.
'''CLASSTYPE_MISSION''' -> 5 :: inventory item class of missions
Note: if a control is given display the dialog with :show_all() if not use [[API_Index#ShowDialog|ShowDialog]] or :show()


'''[[API_msgdlgtemplate1aDone|msgdlgtemplate1aDone]]'''(function button_cb, string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog :: Same as [[API_Index#msgdlgtemplate1a|msgdlgtemplate1a]] but with a "Close" button
'''CLASSTYPE_SHIP''' -> 1 :: inventory item class of ships


'''[[API_msgdlgtemplate1aNext|msgdlgtemplate1aNext]]'''(function button_cb, string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog :: Same as [[API_Index#msgdlgtemplate1a|msgdlgtemplate1a]] but with a "Next" button
'''CLASSTYPE_STORAGE''' -> 4 :: inventory item class of storage containers (station hold)


'''[[API_msgdlgtemplate2|msgdlgtemplate2]]'''(string msg, ltitle, function lcb, string rtitle, function rcb, string bgcolor, alignment) -> userdata dialog :: Create a fullscreen dialog with two buttons and a message
'''Platform''' -> "Unix", "MacOS", "Windows", "iOS", and "Android" :: string representing the platform the game is running on


'''[[API_msgdlgtemplate2withcheck|msgdlgtemplate2withcheck]]'''(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog :: Create a fullscreen dialog with two buttons, a checkbox and a message
'''SubPlatform''' -> Windows: "Metro"; Android: "OUYA", "NvidiaShield", "GameStick", "XperiaPlay", "SonyS2", "ASB" (Amazon Fire TV)


'''[[API_msgpromptdlgtemplate2|msgpromptdlgtemplate2]]'''(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog :: Create a fullscreen dialog with two buttons, an entry field and a message
'''SubSubPlatform''' -> Metro: "ARM" or "x86"; Android: "ARM", "x86", "mips" (x86 is AndroidTV)


'''[[API_msgpromptdlgtemplate2|msgpromptdlgtemplate2]]'''(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog :: Create a fullscreen dialog with two buttons, an entry field and a message
'''VO_VERSION''' -> 3 :: games major version


'''[[API_msgpromptdlgtemplate2lines|msgpromptdlgtemplate2lines]]'''(string msg, msg2, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog :: Create a fullscreen dialog with two buttons, two entry fields and two messages
'''_VERSION''' -> "Lua 5.1" :: lua version


'''[[API_multidlgtemplate2|multidlgtemplate2]]'''(string msg, msg2, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog :: Create a fullscreen dialog with two buttons and two messages (one in a [[iup#multiline|multiline]] control)
[[Category:API]]

Latest revision as of 08:51, 5 December 2023

See also Category:API.

Interface

AdditionalHUDText

General

Functions

AbbrLocationStr(int sectorid) -> string name :: Get abbreviated sector name for sectorid

AbortMission(int itemid) -> nil :: Abort a mission

Article(string word) -> string out :: prepends the appropriate article to the string word

AssignOwnerKey(string keyid) -> nil :: Assign an owner key to this station

CanUseAddon(int itemid) -> bool ret1, {string l1 ..} :: check if the player can equip the addon itemid

CanUseMerchandise(table iteminfo) -> bool ret1, {string l1 ..} :: check if the player can use the item iteminfo

CancelPurchaseShipLoadout() -> nil :: Interrupt purchase of ship loadout

CheckCharProximity() -> nil :: stub

CheckProximityWarning() -> nil :: Trigger the PROXIMITY_ALERT event if a character, that hasn't been before, is within proximity range

CheckStorageAndUnloadCargo({{int itemid, int quantity} ..}, function cb) -> nil :: Unload cargo items and with storage space check

ClearGeneralChatLog() -> nil :: clears general chat log..

ClearLastShipLoadout() -> nil :: clear last shiploadout

ClearMissionChatLog() -> nil :: clears mission log..

ClearProximityCache() -> nil  :: Clear list of characters in proximity range

ClearStationChatLog() -> nil :: clears station log (bar)..

ConfigureMultipleWeaponGroups({table group1key1, table group1key2 ... table group1key6, table group2key1, table group2key2...}, function cb) -> nil :: configures weapon groups according to given tables.

ConfigureWeaponGroup(int id, table port_ids, function cb) -> nil :: Configures one weapon group

ConnectAddon(int portid, int itemid, function cb) -> bool canconnect :: Attaches the addon itemid to the active ship in port portid

CreateCharacter(int name, int nation) -> nil :: Creates the character of the given nation

DeleteCharacter(int slot) -> nil :: Deletes the character in the character slot slot

DisableNPCProximityWarning() -> nil :: Disable proximity warnings for NPC

DisableOneOffProximityWarning() -> nil :: Disable one off proximity warning. Trigger proximity warning more than once for the same ship.

DisablePlayerProximityWarning() -> nil :: Disable proximity warnings for players

DisableProximityWarning() -> nil :: disable the proximity warning ...

DisconnectAddon(int itemid) -> bool ret1 :: detaches the addon itemid and stores it in the station

DisconnectAllAddons() -> nil :: detaches all addons from the active ship and stores them in the current station

EnableNPCProximityWarning() -> nil :: Enable proximity warnings for NPC

EnableOneOffProximityWarning() -> nil :: Enable one off proximity warning. Trigger proximity warning only once for the same ship.

EnablePlayerProximityWarning() -> nil :: Enable proximity warnings for players

EnableProximityWarning() -> nil :: enable the proximity warning ...

EnableVoiceChat(bool enable) -> nil :: Toggle Voice chat

FactionToSignedFaction(int faction) -> int :: Convert absolute faction values (0 to 65535) into signed faction values (-1000 to 1000). Results are rounded down.

FindAndReplaceTags(string text, table matches) -> string ret1 :: Replaces all occurances of with < and > enclosed substrings in text with matching values from the provided table

FindAndReplaceTagsCB(string text, function cb) -> string ret1 :: Pass each occurances of with < and > enclosed substrings in text to cb and replace them with the return value

ForEachBuddy(function func(string name, bool isonline, int sectorid)) -> nil :: calls func with the name, if the player is online for each of your buddies as well as his position if the player is currently online

ForEachPlayer(function func(int charid)) -> nil :: calls func with the character id of each player in the sector

ForgiveKiller(bool forgive) -> nil :: Forgive the last killer.

GeneratePlayerDiedMessage(string name1, name2, int weapon) -> string msg :: generate appropiate kill message for the arguments.

GetAccomplishmentBigSize(int type, level) -> string bigsize :: Get size of accomplishment medal

GetAccomplishmentBigTexture(int type, level) -> string tex :: Get texture of accomplishment medal

GetAccomplishmentBigUV(int type, level) -> string uv :: Get uv mapping of accomplishment medal

GetAccomplishmentCategory(int type, level) -> string category :: Get category of accomplishment

GetAccomplishmentDescription(int type, level) -> string desc :: Get description of accomplishment

GetAccomplishmentLevels(int accomid) -> int curlevel int reqlevel :: returns the current and the required level for the selected accomplishment

GetAccomplishmentName(int type, level) -> string name :: Get name of accomplishment

GetAccomplishmentSize(int type, level) -> string size :: Get size of accomplishment badge

GetAccomplishmentTexture(int type, level) -> string tex :: Get texture of accomplishment badge

GetAccomplishmentTitle(int type, level) -> string title :: Get title of accomplishment

GetAccomplishmentType(int accomindex, char) -> int accomplishmenttype int accomplishmentlevel :: returns some numbers..

GetAccomplishmentUV(int type, level) -> string uv :: Get uv mapping of accomplishment badge

GetActiveChatChannel() -> int channel :: returns the active channel

GetActiveMissionInfo(int num) -> string mname table mmsg int itemid :: Get information about the selcted active mission

GetActiveShipCargoCount() -> int cargocount :: returns amount of cargo in the ship in cu

GetActiveShipEnergy() -> float eng fraction :: returns the energy level of the active ship

GetActiveShipHealth() -> int d1 d2 d3 d4 d5 d6 dmg max  :: returns information about the active ships health

GetActiveShipGridPowerAndUsage() -> int power usage :: returns the energy grid power and usage of the current ship..

GetActiveShipID() -> int itemid :: returns itemid of active ship

GetActiveShipItemIDAtPort(int portid) -> int itemid :: returns itemid of addon in selected port

GetActiveShipMass() -> int mass :: returns mass of active ship

GetActiveShipMaxCargo() -> int cargo :: returns amount of cargo space of the active ship in cu

GetActiveShipMaxSpeed() -> int speed :: returns max nonturbo speed of active ship

GetActiveShipName() -> string name :: returns a string with the active ships name

GetActiveShipNumAddonPorts() -> int ports :: returns number of ports in active ship

GetActiveShipPortIDOfItem(int itemid) -> int portid :: returns portid of the given addon in active ship

GetActiveShipPortInfo(int portid) -> table portinfo :: returns information about the given port

GetActiveShipSelectedWeaponGroupIDs() -> int id1 id2 id3 :: returns ids of the selected weapon groups ...

GetActiveShipSpeed() -> int speed :: returns current speed of active ship

GetActiveShipWeaponGroup(int id) -> table group :: return which ports are enabled in the provided group

GetAddonItemInfo(int itemid) -> int current maximum :: Returns current and maximum ammo if itemid is a weapon with ammo, or current/maximum armor if itemid is a ship.

GetAvailableMissionInfo(int midx) -> {int itemtype, string name, bool active, int category, string icon, string desc} :: Returns information about the mission with the given index.

GetBarPatrons() -> {[charid1], [charid2]...} :: get people in the current station bar

GetBestPriceInfoOfItem(int item) -> int price, station :: Get highest sell price of a cargo item in the active ship in the currentsystem

GetBotSightedInfoForSector(int sectorid) -> string botinfo :: returns bot ihnfo text for the given sector

GetBuddyInfo(int char) -> string name, bool isonline, int sectorid :: Get name, online status and location of a buddy

GetCargoValue() -> int value, price :: Get value and buy price of the cargo and equipped addons on the active ship at the current station

GetCharacterDescription(int charid) -> string desc :: Get the character description of a character

GetCharacterID(int nodeid) -> int charid :: returns character id of the provided node id

GetCharacterIDByName(string name) -> int charid :: get character id by name

GetCharacterInfo(int cslot) -> string name faction int money kills deaths loc home cl ll hl tl ml :: Get information about your characters

GetCharacterKillDeaths(int charid) -> int kills deaths pks :: get info about kills and deaths

GetConqueredSectorsInSystem(int systemid) -> table sectors :: Get table with conquered sectors in the given system

GetConqueredStatus(int sectorid) -> int faction :: Get faction that conquered the given sector

GetCurrentSectorid() -> int sectorid :: get current sector id

GetCurrentStationID() -> int stationid :: get current station id

GetCurrentStationType() -> int type :: return the current station type..

GetCurrentSystemid() -> int systemid :: get current system id..

GetEULA() -> string eula :: return eula

GetFactionInfo(int faction) -> string info :: get faction info text for the provided faction

GetFinishedMissionInfo() -> string name table msg int itemid :: see GetActiveMissionInfo

GetFriendlyStatus(int char) -> int fstatus :: get friendlyness of a character

GetFullPath(int sector, table navroute) -> table fullpath :: Get the full path, including wormhole sectors, from sector along navroute

GetGeneralChatLog() -> table log :: returns the chatlog

GetGroupMemberID(int index) -> int charid :: get charid of group member with given index

GetGroupMemberLocation(int charid) -> int loc :: get location of a groupmember

GetGroupOwnerID() -> int charid :: get charid of group owner

GetGuildAcronym() -> string acronym :: get your guilds acronym

GetGuildBalance() -> int balance :: get amount of money in guild bank

GetGuildBankPrivileges() -> table deposit withdraw logview :: get your guilds bank privileges as three tables

GetGuildBankWithdrawalLimits() -> int ret1 ret2 ret3 :: get withdrawal limits? returns three numbers

GetGuildMOTD() -> string motd :: get your guilds message of the day

GetGuildMemberInfo(int index) -> int charid rank string name  :: get information about the guildmember of the given index

GetGuildMemberInfoByCharID(int charid) -> int charid rank string name  :: get information about the guildmember

GetGuildName() -> string name :: get guild name

GetGuildTag(int charid) -> string tag :: get guild tag of self or another character.

GetHomeStation() -> int sectorid :: get sectorid of home station

GetInventoryItemClassSubType(int itemid) -> int subtype :: get subclass of an item

GetInventoryItemClassType(int itemid) -> int type :: get class of an item

GetInventoryItemContainerID(int itemid) -> int container :: get container of item

GetInventoryItemExtendedDesc(int itemid) -> string desc :: get description of item

GetInventoryItemIcon(int itemid) -> string path :: get path to icon of inventory item

GetInventoryItemInfo(int itemid) -> string ipath name int quant float mass string sdesc desc1 desc2 int container class subtype :: get most info about inventory item

GetInventoryItemLocation(int itemid) -> int stationid :: get location of an inventory item

GetInventoryItemLongDesc(int itemid) -> string desc :: get long description of an inventory item

GetInventoryItemMass(int itemid) -> float mass :: get mass of inventory item

GetInventoryItemName(int itemid) -> string name :: get name of inventory item

GetInventoryItemQuantity(int itemid) -> int quant :: get quantity of inventory item..

GetInventoryItemType(int itemid) -> int type :: get item type

GetInventoryItemUnitCost(int itemid) -> int cost :: get price paid for the given item(?)

GetInventoryItemVolume(int itemid) -> int volume :: get per unit volume of item in cu

GetItemFullDesc(table item) -> string desc :: get full description of an inventory item

GetItemPartialDesc(table item) -> string desc :: get partial description of an inventory item

GetJoinedChannels() -> table channels :: get array with currently joined channels

GetKeyInfo(int keyindex) -> string keyid, string desc  :: Get information about the key with the given index in the keychain

GetLastAggressor(int itemid) -> int nodeid ret1 :: get node id of last aggressor and some number

GetLastPrivateSpeaker() -> string name :: get name of last character that pmed you

GetLastShipLoadout() -> {groups = {1 = group1 .. 18 = group18}, int ship, ports= {1 = port1 ..}, int shipcolor} :: get last ship loadout, color and weapon groups

GetLastShipLoadoutPurchaseCost() -> int cost :: what you payed for your last ship(?)

GetLicenseLevel(int type) -> int level :: get the level of the provided license

GetLicenseRequirement(int level) -> int xp :: get xp required for given level

GetListOfSeenNames() -> table names :: get table with names of characters that have been in the same sector as the player or have sent messages

GetMaxRadarDistance() -> int dist :: get current(?) max radar range

GetMinJumpDistance() -> int dist :: get minimum distance from large objects to jump

GetMissionChatLog() -> {bool updated, string 1.. } :: get advancement log

GetMissionTimers() -> int time :: get time left on the current mission. may have some functionality for multiple missions

GetMoney() -> int money :: get how many credits you own

GetNationKills(int nation) -> int kills :: get number of player kills for the given nation

GetNewsHeadline(int index) -> string title int time ret1  :: get headline, post time and some number

GetNewspostItem(int index) -> int id, time, string subject, bool important  :: Get news post info

GetNumAccomplishments(int charid) -> int accomplishments :: get number of accomplishmeants for given character

GetNumActiveMissions() -> int missions :: get number of active missions.

GetNumAvailableMissions() -> int missions :: get number of available missions

GetNumCharacters() -> int chars :: get number of characters you have defined

GetNumCompletedMissions() -> int missions :: get number of completed missions

GetNumFinishedMissions() -> int missions :: get number of finished missions

GetNumGroupMembers -> int chars :: get number of characters in your group

GetNumGuildMembers() -> int numchars :: get number of online guildmembers

GetNumKeysInKeychain() -> nil :: Get number of keys in the keychain

GetNumNewsHeadlines() -> int num :: get number of news headlines..

GetNumNewsposts() -> int num :: Get number of news posts

GetNumOccasions() -> int num :: Get number of ccassion announcments (events)

GetNumStationDesiredItems() -> int num :: Get number of items this station desires

GetNumStationMerch() -> int num :: get number of addons, ships an cargo this station sells

GetNumStationTurrets() -> int num :: get number of turrets on this station or ship

GetNumTips() -> int num :: get size of load screen tips pool

GetOccasionItem(int index) -> int id, time, duration, string name, bool important, int timestamp  :: Get occasion (event) info

GetParentHealth() -> float ret1 ret2 :: get health of object this one is attached to (turret to capship). untested!

GetPlayerDistance(int charid) -> float distance :: get distance to another character

GetPlayerFaction(int charid) -> int factionid :: get nation of a player

GetPlayerFactionStanding(int factionid, charid) -> int standing :: get a players standing with a faction

GetPlayerHealth(int charid) -> float health :: get health of provided character

GetPlayerName([int charid]) -> string name :: get name of character

GetPlayerNodeID(int charid) -> int nodeid :: get nodeid of a character in the sector

GetPlayerNodeID(int charid) -> int nodeid :: get nodeid of a character in the sector

GetPOI() -> table :: returns a table of all discovered points-of-interest in the current system.

GetPrimaryShipIDOfPlayer(int charid) -> int objectid :: get objectid of provided character

GetPrimaryShipNameOfPlayer(int charid) -> string name :: get ship name (type) of provided character

GetProximityWarningDistance() -> int dist :: get proxy warnign distance Note: even returns the distance when proxy warning is disabled

GetProximityWarningTimeout() -> int timeout :: Get minimum time between proximity warnings

GetRadarDistance(int charid) -> float distance :: get distance to another character

GetRegisteredCommands() -> table commands :: get all commands

GetRegisteredUserCommands() -> table commands :: get all user registered commands

GetSectorAlignment() -> int alignment :: returns the alignment of the current sector

GetSectorIDOfStation(int stationid) -> int sectorid  :: Get sector id of the given station

GetSectorMonitoredStatus() -> int monitor :: returns the monitor status of the current sector (Unmonitored, Guarded ...)

GetShipAmmoPrices(int ship) -> table prices :: get cost of ship ammo

GetShipCargoCount(int itemid) -> int num :: get amount of cargo in the ship

GetShipInventory(int itemid) -> {cargo = {int cargoitemid ..}, addons = {int addonitemid ..}} :: get itemids of items attached to a ship

GetShipList() -> {int itemid ..} :: get list of your ships in the current station. produces error when called outside station..

GetShipMaxCargo(int itemid) -> int cargo :: get amount of cargo the given ship can hold

GetShipMeshInfo(int itemid) -> string id model int color :: get mesh information about equipment in your inventory

GetShipPortIDOfItem(int itemid1, int itemid2) -> int portid :: get port of weapon in one of your ships

GetShipPurchaseColor() -> int color :: get selected color from the color picker

GetSkillLevel(int licenseid) -> int current next :: get current and required xp for next level or provided skill

GetSkirmishInfo() -> int crew1 crew2 init1 init2 string name1 name2 bool active :: returns crew info for skirmish missions

GetStartingSectors(int factionid) -> table sectors :: get list of starting sectors for the given faction

GetStationAddonList() -> {int itemid ..} :: get array with your addons in the station hold

GetStationAmmoInfoByID(int itemid) -> {bool is_ammorepair, string type, int unitcost, int price, string longdesc, string desc, bool locallyproduced, int itemid, string icon} :: get info about ammo based weapons in the station by item id

GetStationCargoList() -> {int itemid ..} :: get list of cargo items in the current station. produces error when called outside station..

GetStationChatLog() -> {string msg ..} :: get table with messages in the station chat

GetStationCurrentCargo() -> int cargo :: get amount of cargo currently in this station. including cargo, equipment, ships ..

GetStationDesiredItem(int index) -> string ditem :: Get the string name of an item that this station desires

GetStationFaction(int stationid) -> int factionid :: get faction of the given station

GetStationFactionAppraisalModifier() -> float modifier :: Returns a number that seems to affect the price of storage space. depends on faction standing or something

GetStationLocation(int stationid1) -> int stationid2 :: get the stationid of the current station

GetStationMaxCargo() -> int cargo :: return amount of cargo this station can hold.

GetStationMerchInfo(int merchid) -> { neededlevels = {int l1 .. l5}, int price, string longdesc, float mass, string sortgroup, int volume, string extendeddesc, string type, string meshfile, bool usable, int itemid, string icon } :: get info about items this station sells

GetStationMerchInfoByID(int itemid) -> { neededlevels = {int l1 .. l5}, int price, string longdesc, float mass, string sortgroup, int volume, string extendeddesc, string type, string meshfile, bool usable, int itemid, string icon } :: get info about items this station sells by itemid

GetStationMerchPriceByID(int itemid) -> int price :: get price of an item this station sells

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

GetStationSellableInventoryInfoByID() -> {bool is_ammorepair, string type, int unitcost, int price, string longdesc, string desc, string name, bool locallyproduced, neededlevels = {string l1 .. l5}, int itemid, string icon } :: get sellable inventory info by id ...

GetStationSellableInventoryPriceByID(int itemid, int quantity) -> int value, unitprice :: Get value of inventory items and price per unit in the current station

GetStationShipList(int itemid) -> {int itemid1 ..} :: get array of your ships in the current station

GetStationTurretInfo(int turretid) -> {int objectid, int nodeid, float armorpercent, int itemid} :: get information about a stations or ships turrets

GetStationType() -> string stype :: get station type

GetStorageItemInfo(int itemid) -> int stationid :: get stationid of a storage container

GetStorageLocationSector(int arg1) -> int ret1 :: returns some number when fed with an itemid

GetSurveyChoices() -> {} :: returns an empty table!

GetSurveyQuestion() -> string ret1 :: returns an empty string!

GetSystemID(int sectorid) -> int systemid :: get systemid of the given sector. lua error on nil

GetTargetDistance() -> float dist :: get distance to target

GetTargetFriendlyStatus() -> int fstatus :: get friendlyness of target

GetTargetInfo() -> string name float health dist int factionid string guild ship :: get info about target

GetTip(int tipid) -> string tip :: get loading screen with given index

GetTurretNamesByStationType(string stype) -> {string tur1 ..} :: get turret name of provided station type

GetTutorialLevel() -> int num :: return if the player has done the tutorial(?)

GetUserName() -> string Name :: Returns the username.

GiveMoney(string char, int amount) -> nil :: transfer money to a character

HasActiveShip() -> bool aship :: return true if the player has an active ship

HasLastShipLoadout() -> bool loadout :: return true if the player has a last ship loadout saved

IsConnected() -> bool connected :: return true if the player is connected to the game

IsEnemy(charid) -> bool enemy :: Part of the base radar functionality. Used in conjunction with GetFriendlyStatus.

IsGroupMember(int charid) -> bool grmember :: tell if the provided character is a group member

IsGuildMember(int charid) -> bool guildmember :: tell if the provided character is a guild member

IsInDuel() -> bool duel :: Returns true if the player is in a duel

IsNPCProximityWarningEnabled() -> bool state :: Get NPC proximity warning state

IsOneOffProximityWarningEnabled() -> bool state :: Get one off proximity warning state

IsPlayerProximityWarningEnabled() -> bool state :: Get Player proximity warning state

IsPlayerRequestingBuddy(string name) -> bool req :: Tell if the given player is requesting to become a buddy

IsPlayerRequestingDuel(string name) -> bool req :: Tell if the given player is requesting a duel

IsPlayerRequestingGroupInvite(string name) -> bool req :: Tell if the given player has sent a group invite

IsProximityWarningEnabled() -> bool isproxy :: tell if proximity warning is enabled

IsStormPresent() -> bool isstorm :: tell if there's a storm in the current sector

IsTrainingSector(int sectorid) -> bool tsector :: tell if the given sector is a training sector

IsTransactionInProgress() -> bool trans :: tell if a transaction is in progress (like selling a ship, items ..)

IsVoiceChatEnabled() -> bool vc :: tell if voice chat is enabled

JettisonAll() -> nil :: Jettison all of your ships cargo

JettisonMultiple{item1 = {int id, int quantity} ..} -> nil :: Jettison cargo items and quantitiss according to the provided table

JettisonSingle(int itemid, int quantity) -> nil :: Jettison provided type and amount of cargo

JoinChannel{channelid1 ..} -> nil :: join the provided channels without leaving existing channels

LeaveChannel{channelid1 ..} -> nil :: leave the provided channels

ListChannels() -> nil :: print list of currently joined channels and usage info to the chatarea

LoadCargo({{int itemid, int quantity} ..}, function cb) -> nil :: Load cargo items and quantitiss according to the provided table

LoadChannels() -> nil :: restore chat channels from config file(?)

LoadMissionNotes() -> string notes :: read and return players notes from playernotes.txt. See also: Function_Index#SaveMissionNotes

LoadNavpath(string navpath) -> {int sectorid1 ..} :: load navroute by name and return array with hops

LoadShipPresets() -> nil :: read ship presets from config file and setup buyback dialog

LoadSystemNotes(int systemid) -> string notes :: load system notes from settings/<charactername>/system<systemid>notes.txt

LocationStr(int sectorid) -> string sname :: translate a sectorid into a sector name. error if no argument provided

Login(string username, string password) -> nil :: Login to the game. crashes game when arguments are missing...

Logout() -> nil :: Inititate logout sequence.

MakeBotName(string nameset, int seed) -> string name :: Generate a name fromthe given nameset and optional random seed

MakeBuyBackQuestionDlg() -> userdata dialog :: Create the buyback dialog

NPlural(string arg1, string arg2) -> string pstring :: concaterates the two provided strings together and pluralizes the result

MakeBuyBackQuestionDlg() -> userdata dialog :: Create the buyback dialog

OnIdle(float delta) -> nil :: Idle handler

OpenAlarm(string title, text, buttontext) -> nil :: Show ConfirmationDialog with the given message

OverlapPrevention(table ip) -> bool overlap :: Adjust icon positions in a viewport so that they don't overlap

ParseXML(string xmlstring) -> {dom} :: returns the provided string as a collection of substrings and nodes as subtables ..see example

PlayerInStation() -> bool instation :: tell if the player is in a station or capship

PlayerInventoryPairs() -> int itemid table iteminfo :: Iterator function that returns information about an item in the players inventory each time it is called

PrintJoinUsage() -> nil :: prints how to use /join to the chatarea

PrintLeaveUsage() -> nil :: prints how to use /leave to the chatarea

PrintPurchaseTransaction(string name, int quantity, totalvalue, totalcost) -> nil :: Print a sale summery message to the chat log

PrintTransactionTable() -> nil :: print pending transactions.

ProcessEvent(string eventtype, data) -> nil :: Processes various events. Trigger a with RegisterEvent defined event

PurchaseMerchandiseItem(int itemid, int amount, function callback) -> nil :: buy the provided item

PurchaseShipLoadout(function buybackdone_cb(boolean success), loadout) -> nil :: Buys ship presets as stored in ShipPresets table. buybackdone_cb is called on success/failure.

RegisterEvent(object eventhandler, string eventtype) -> nil :: Hook up object to event

RegisterUserCommand(string commandname, func callback(dataarg, {arguments1, ..}), data) -> nil :: hook up object to command

ReinitIconPositions(timer icontimer, int ship, userdata viewport, table iconlist, userdata iconcontainer, table ipcache) -> nil :: Setup icons in a viewport

ReloadInterface() -> nil :: Reloads everything related to the interface that isn't a texture

RentStorage(int storage) -> nil :: Rent storage space at the current station.

RepairShip(int itemid, int x, func cb) -> nil :: Repairs the ship itemid in the station

ReplenishAll(int itemid, func cb) -> nil :: replenish all weapons on provided ship

ReplenishWeapon() -> ?? :: not tested

RequestCharacterStats() -> nil :: no clue

RequestLaunch() -> bool ret :: Launches from the station. Any issues preventing launch are reported via pop-up window. Otherwise, the player's ship undocks.

RequestMissionDetails(int missionid) -> nil :: (Deprecated)Request information about the given mission (aka the info button)

RequestMissionExtendedDescription(string missionid, int stationid) -> bool :: Requests an extended mission description; result is received via the MISSION_QUESTION_OPEN event

RequestMissionList() -> nil :: no clue. maybe used by /updatestation

RequestNewsArticle(int newsindex) -> nil :: ask server for news item(?) fills API_NewsDialog with given news item

RequestNewsHeadlines() -> nil :: ask server for news item list?

RequestNewspostInfo(int id) -> nil :: Request a news item. The result is returned with the UPDATE_NEWS event

RequestOccasionInfo(int id) -> nil :: Request an occassion item (event). The result is returned with the UPDATE_NEWS event

RequestTargetStats() -> int charid :: get character id of target (considreing the name maybe more?)

ResetTutorial() -> nil :: Reset the tutorial flag. the player will have to go through it again after docking.

RunTutorial() -> nil :: launch tutorial

SaveChannels() -> nil :: Save joined channels(?). Kinda useless since trhat's done as soon as you join one

SaveMissionNotes(string notes) -> nil :: Save the provided string to the characters mission notes file. See also: API Index#LoadMissionNotes

SaveShipPresets(int index) -> nil :: Save ship preset(s) and recreate buyback dialog

SaveSystemNotes(string notes, int systemid) -> nil :: save system notes to settings/<charactername>/system<systemid>notes.txt

SaveNavpath({int sectorid1 ..}, string name) -> nil :: Save the provided navroute

SaveShipLoadout(int itemid) -> table preset :: create a preset from the given ships loadout

SectorIDFromLocationStr(string location) -> int sectorid :: Convert a location string into a sectorid.

SelectActiveShip(int itemid) -> nil :: Set the given ship active

SelectCharacter(int charslot) -> nil :: Select character in given slot and enter the game with it

SellInventoryItem(int itemid, int amount) -> nil :: Sell the provided amount of an inventory item from the current station or ship

SendChat(string msg, string dst, string dstparam) -> nil :: Send a message to the provided destination.

SendMissionQuestionResponse(int num) -> nil :: (Deprecated)called by the initial info dialog 1 = accept, 0 = decline

SetChatLogRead() -> nil :: Mark the general chat log as read/displayed

SetChatLogReceiver(table chatcontainer) -> nil :: Point the general chat log to a chat container

SetCurrentChatTab() -> ?? :: does nothing. maybe a leftover from the general/mission chat system

SetHomeStation() -> nil :: set current station as your home station

SetMissionLogRead() -> nil :: Mark the advancement log as read/displayed

SetMissionLogReceiver(table chatcontainer) -> nil :: Point the advancement log to a chat container

SetProximityWarningDistance(int dist) -> nil :: set proximity warning distance ..

SetProximityWarningTimeout(int timeout) -> nil :: Set minimum time between proximity warnings

SetShipPurchaseColor(int color) -> nil :: color of the next ship the player will buy

SetStationLogRead() -> nil :: Mark the station log as read/displayed

SetStationLogReceiver(table chatcontainer) -> nil :: Point the station log to a chat container

SetViewObject(userdata modelview, string meshname, string meshfile, int color) -> nil :: Change the ship in a modelview

SHA1(string text) -> string hash :: generate SHA1 hash of the given string

ShortLocationStr(int sectorid) -> string loc :: string representing the provided sector

ShouldTutorialRun() -> bool tut :: tell if the player has done the tutorial

SplitLocationID(int stationid) -> int sectorid stationidx :: split up a stationid into sectorid and station index

SplitSectorID(int sectorid) -> int systemid sectorh sectorv  :: split up a sectorid into systemid and axis on the system grid

SplitStationID(int stationid) -> int systemidl sectorhv :: :: split up a stationid into sectorid and station index

StartSellInventoryItem(int itemid, function cb) -> nil :: Receive instant price updates for the given item.

StationPlayerAmmoPairs() -> int itemid table ammoinfo :: Iterator function that prints information about ammo based weapons in the players inventory at the current station each time it is called. works like pairs()

StationSellableInventoryPairs() -> int itemid table iteminfo :: Iterator function that prints information about an item in the players inventory at the current station each time it is called. works like pairs()

StationSellItem(userdata button, table item, int quantity, function cb) -> nil :: Sell items with aconfirmation dialog

StrTableStopTutorial() -> nil :: seems to be another serialisation function. similar (the same?) to splickle

SubmitSurvey() -> nil :: does nothing..

SwapAddons(int portid1 itemid1 porid1 itemid2 function cb) -> nil :: Swap two addons equipped to the current ship (crashes client after undocking)

TabCompleteName(string name) -> string completename :: Attempts to fill out name with the best match the client has seen since startup. If TabCompleteName cannot find a match for name it returns nil, otherwise, completename will be a string containing the best match.

UnloadCargo({{int itemid, int quantity} ..}, function cb) -> nil :: Unload cargo items and quantities according to the provided table

UnloadSellCargo({{int itemid, int quantity} ..}, function cb) -> nil :: Unload and sell cargo items and quantities according to the provided table

UnregisterEvent(object, string eventtype) -> nil :: Unregister an object registered with RegisterEvent

UnregisterUserCommand(string command) -> nil :: Unregister a command registered with RegisterUserCommand

UnrentStorage(int storage) -> nil :: Unrent storage space at the current station.

UpdateAllRadarFriendlyStatus() -> nil :: Update the radar with the new status when overriding GetFriendlyStatus

UpdateRadarFriendlyStatus(int nodeid) -> nil :: Update the radar with the new status when overriding GetFriendlyStatus

XMLTagToString() -> nil :: might the reverse of ParseXML

_ERRORMESSAGE(string msg) -> nil :: creates an error message with the provided string. probably more

assert :: [1]

bbhash(string input, int arg2) -> string hash :: Seems to be some kind of hash function

calc_health_color(float health, int alpha, mode) -> string color :: Create an iup color string corresponding to the given health

clearscene() -> nil :: removes al objects from the game world

collectgarbage :: [2]

comma_value(float number) -> string formatted_number :: returns a formatted version of the provided number according to API_Index#SI_unit

console_clear() -> nil :: clear console on the next API_ReloadInterface

console_print(string text) -> nil :: print the given string to the ingame console

debugprint() -> ?? :: does nothing..

declare(string name, value) -> nil :: declare a variable and assign a value

deviceByMode(table arg1, mode) -> table ret :: not sure. possibly to find audio devices by capability

dofile :: [3]

error :: [4]

factionfriendlyness(int standing) -> string name :: get string that represents the given faction standing

factionfriendlynesscolor(int standing) -> string color :: get iup color that represents that given faction standing

factionfriendlynessrange(int standing) -> float range :: get progress within the current faction standing level

fillModesDropdown() -> ? :: no clue. fill some kind of drop down menu(?)

filter_colorcodes(string in) -> string out :: strips colorcodes from the provided string

format_time(int msecs) -> string tstring :: get string representation of the provided time

generalprint(string str) -> nil :: print given string to the chat area via CHAT_MSG_PRINT event. Results is printed in the active channel text color.

hextorgb(string hexcolors) -> string deccolors :: Convert hexadecimal formated color string into a decimal one used by iup

ipairs :: [5]

load :: [6]

loadfile :: [7]

loadscene(string scene) -> ?? :: load a scene(?). don't know how it works though

loadstring :: [8]

log_chat(string str) -> nil :: Writes current time and given string to the errors.log

log_print(string str) -> nil :: Writes string to the errors.log

next :: [9]

oper :: not gonna bother

pairs :: [10]

pcall :: [11]

print(string str) -> nil :: print given string to the chat area

printtable{in} -> nil :: print contents of a table to the console

purchaseprint(string str) -> nil :: print given string to the chat area via CHAT_MSG_CONFIRMATION event.

rawequal :: [12]

rawget :: [13]

rawset :: [14]

require :: [15]

rgbtohex(string deccolor) -> string hexcolor :: Returns string containing escaped hexadecimal version of the in decimal given color

roper :: not gonna bother

sectorprint(string str) -> nil :: print given string to the chat area via CHAT_MSG_SERVER_SECTOR event. Results in white text by default.

select :: [16]

sort_commodities(table a, b) -> bool order :: Sort function for iteminfo tables. See table.sort in the lua reference

sort_sellable_commodities(table a, b) -> bool order :: Sort function for iteminfo tables that prioritizes items in the active ship. See table.sort in the lua reference

storagelocationcompare(int a, b) -> bool order :: Sort function for locationid values. See table.sort in the lua reference

spickle(table intab) -> string :: Converts a table into a string roughly of the format "value","value",{"tablevalue","tablevalue";tablekey="value"};key="value",key="value"

strip_whitespace(string in) -> string out  :: strip whitespace from beginning and end of string

substitute_vars(string in) -> string out  :: replace variables like %target% in input with their corresponding value

tabcomplete :: produces lua error..

testconquered(int sectorid, factionid) -> nil :: test function. sets conquerer of the given sector

tonumber :: [17]

tostring :: [18]

type :: [19]

unpack :: [20]

undeclare(string name) -> nil :: undeclare a variable created with Function_Index#declare

unspickle(string in) -> table outtab :: Converts a spickled string into a table

xpcall :: [21]

Tables

Bitlib :: functions to manipulate the bitwise operations

Buddy :: functions to manipulate the characters buddylist

Duel :: Duel related methods

FactionArticle :: table with faction articles. indices represent factionid. see: Article

FactionColor :: table with faction colors. indices represent factionid

FactionColor_RGB :: table that maps factionid's to colors in RGB format

FactionMonitor :: table with monitoring types. indices represent numeric monitoring types and values, string representations of that type

FactionMonitorStr :: table with monitoring types. values represent numeric monitoring types and indices, string representations of that type

FactionName :: Array with short names of the ingame faction

FactionNameFull :: Array with long names of the ingame faction

FactionStanding :: table for mapping names of standing levels to it#s int value

FriendKeys :: taable friend key related functions

Game :: functions to control a few game features ..

GeneralChatPanel :: table with parts of a chat area. seems to point to PDA or HUD chat panel depending on what is visible(?)

Group :: Group related functions

Guild :: Guild related functions

Gunner :: Gunner related functions for multiplayer ships

HUD :: HUD related functions

Ignore :: Ignorelist related functions

InvManager :: functions to get information about inventory items

lcd ->  :: functions for the Logitech G-series keyboard screens

Keychain :: keychain management

Mentor :: Mentor related functions

MissionLogPanel :: table with parts of the mission log

NavRoute :: functions to manipulate your NavRoute

ShipOrder :: table containing the ordering of ships in lists(?)

ShipPalette :: array that maps palette color values (1-256) to rgb values represented as gvectors

ShipPalette_string :: array that maps palette color values (1-256) to rgb values represented as strings

ShipPresets :: array with properties of ship presets

ShipSkinNames :: array containing livery names

ShipSkinDescriptions :: array containing livery descriptions

Skills :: table to translate skillid's into skill names and back

SystemNames :: Table to translate systemid's into system names and back.

SystemNotes :: System Notes public table. Used for adding notes to the navmap.

TagFuncs :: Text markup callbacks(?)

TCPSocket :: socket class

Thread :: Thread library

Timer :: Timer class

VoiceChat :: voice chat related functions

Vote :: functions to use the voting feature

_generalchatlog :: array with chatlog

_missionlog :: array with mission log

_stationlog :: array with log of visisted stations

chatinfo :: table with display options for each chat event

chatreceiver :: event handler for chat events

command_pretty_names :: table that maps commands to their descriptions

coroutine :: coroutine class

debug :: debugging helpers

gkini :: functions to manipulate the games config file

gkinterface :: interface related functions..

gkmisc :: misc functions ..

gknet :: network related functions

gksound :: audio related functions

gvector :: gvector class. to create and manipulate vectors

ignore_time :: array with with ignored name and period entries

joystick :: functions to change joystick settings

math3d :: functions to do some vector math

math :: standard math library

os :: functions to interface with the operating system

quaternion :: quaternion class. to create and manipulate quats

radar :: functions to query and set radar parameters

string :: string manipulation functions

table :: standard table library

Variables

CLASSTYPE_ADDON -> 2 :: inventory item class of addons

CLASSTYPE_FLAG -> 3 :: inventory item class of flags(?)

CLASSTYPE_GENERIC -> 0 :: inventory item class of generic items

CLASSTYPE_MISSION -> 5 :: inventory item class of missions

CLASSTYPE_SHIP -> 1 :: inventory item class of ships

CLASSTYPE_STORAGE -> 4 :: inventory item class of storage containers (station hold)

Platform -> "Unix", "MacOS", "Windows", "iOS", and "Android" :: string representing the platform the game is running on

SubPlatform -> Windows: "Metro"; Android: "OUYA", "NvidiaShield", "GameStick", "XperiaPlay", "SonyS2", "ASB" (Amazon Fire TV)

SubSubPlatform -> Metro: "ARM" or "x86"; Android: "ARM", "x86", "mips" (x86 is AndroidTV)

VO_VERSION -> 3 :: games major version

_VERSION -> "Lua 5.1" :: lua version

Retrieved from "https://vo-wiki.com/racecar2/index.php?title=API_Index2&oldid=14148"