View source for API Index test

== Functions ==

=== AbbrLocationStr ===
'''Definition:'''<br>
AbbrLocationStr(int sectorid) -> string name
<br>
'''Description:''' <br>
Get abbreviated sector name for sectorid
<br>
'''Arguments:'''<br>
''sectorid'' [[sectorid]]
<br>
'''Returns:'''<br>
''name'' shortened sector name
<br>

=== AbortMission ===
'''Definition:'''<br>
AbortMission(int itemid) -> nil
<br>
'''Description:''' <br>
Abort a mission
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of mission (optional)
<br>

=== AccomplishmentTemplate ===
'''Definition:'''<br>
AccomplishmentTemplate(function cb(string desc)) -> userdate box
<br>
'''Description:''' <br>
Create box with accomplishment icons (targetinfo dialog). see: [[AccomplishmentTemplate]]
<br>
'''Arguments:'''<br>
''cb'' function to call when clicking<br>
''desc'' description of clicked accomplishment
<br>
'''Returns:'''<br>
''box'' [[AccomplishmentTemplate]]
<br>

=== AccomplishmentTemplate2 ===
'''Definition:'''<br>
AccomplishmentTemplate2(function cb(string desc, int type, level)) -> userdate box
<br>
'''Description:''' <br>
Create list with accomplishment icons (pda playerinfo dialog). see: [[AccomplishmentTemplate]]
<br>
'''Arguments:'''<br>
''cb'' function to call when clicking icons<br>
''desc'' description of clicked accomplishment<br>
''type'' type of clicked accomplishment<br>
''level'' level of clicked accomplishment
<br>
'''Returns:'''<br>
''box'' [[AccomplishmentTemplate]]
<br>

=== Article ===
'''Definition:'''<br>
Article(string ''word'') -> string ''out''
<br>
'''Description:'''<br>
prepends the appropriate article to the string ''word''
<br>
'''Arguments:'''<br>
''word'' string to prepend an article to.
<br>
'''Returns:'''<br>
''out'' the string with an article prepended.
<br>

=== CanUseAddon ===
'''Definition:''' <br>
CanUseAddon(int ''itemid'') -> bool ''ret1'', {string l1 ..}
<br>
'''Description:'''<br>
check if the player can equip the addon ''itemid''
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of addon to check
<br>
'''Returns:'''<br>
''ret1'' can use<br>
''l1'' license requirements of the item at the current station (1-5) (only returned for local addons and if the player is docked with a station)<br>

=== CanUseMerchandise ===
'''Definition:''' <br>
CanUseMerchandise(table ''iteminfo'') -> bool ''ret1'', {string l1 ..}
<br>
'''Description:'''<br>
check if the player can use the item ''iteminfo''
<br>
'''Arguments:'''<br>
''iteminfo'' iteminfo of item to check
<br>
'''Returns:'''<br>
''ret1'' can use<br>
''l1'' license requirements of the item<br>
<br>

=== CancelPurchaseShipLoadout ===
'''Definition:'''<br>
CancelPurchaseShipLoadout() -> nil
<br>
'''Description:'''<br>
Interrupt purchase of ship loadout
<br>

=== ChatLogTemplate  ===
'''Definition:'''<br>
ChatLogTemplate(string bg, string scrolledbg, function updatecb, string editbg, bool clickable) -> table container
<br>
'''Description:'''<br>
Create rudimentary chet container. See [[ChatLogTemplate]]
<br>
'''Arguments:'''<br>
''bg'' [[iupcolor]] of background<br>
''scrolledbg'' [[iupcolor]] of background when scrolled up<br>
''updatecb'' function called whenever contents of the container changes<br>
''editbg'' image for background of entry<br>
''clickable'' if true the container will respond to mouse clicks
<br>
'''Returns:'''<br>
''container'' [[ChatLogTemplate]]
<br>

=== CheckCharProximity ===
'''Definition:'''<br>
CheckCharProximity() -> bool inrange
<br>
'''Description:'''<br>
stub
<br>
'''Returns:'''<br>
''inrange'' always false
<br>

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

=== CheckStorageAndUnloadCargo ===
'''Definition:'''
CheckStorageAndUnloadCargo({{int itemid, int quantity} ..}, function cb) -> nil
<br>
'''Description:'''<br>
Unload cargo items and quantities according to the provided table also checks station storage and pops up a dialog if not enough available
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of cargo item<br>
''quantity'' amount of this cargo to unload<br>
''cb'' optional function to call on success
<br>

=== ClearGeneralChatLog ===
'''Definition:'''<br>
ClearGeneralChatLog() -> nil
<br>
'''Description:'''<br>
clears general chat log..
<br>

=== ClearLastShipLoadout ===
'''Definition:'''<br>
ClearLastShipLoadout() -> nil
<br>
'''Description:''' <br>
clear last shiploadout. prevents client from asking to rebuy ship after destruction
<br>

=== ClearMissionChatLog ===
'''Definition:'''<br>
ClearMissionChatLog() -> nil
<br>
'''Description:''' <br>
clears mission log..
<br>

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

=== ClearStationChatLog ===
'''Definition:'''<br>
ClearStationChatLog() -> nil
<br>
'''Description:'''<br>
clears station log (bar)..
<br>

=== ConfigureMultipleWeaponGroups ===
'''Definition:'''<br>
ConfigureMultipleWeaponGroups({table group1key1, table group1key2 ... table group1key6, table group2key1, table group2key2...}, function cb) -> nil
<br>
'''Description:'''<br>
configures weapon groups according to given tables.
<br>
'''Arguments:'''<br>
''group*key*'' Each table represents one group key. Key 1-6 map to the primary trigger, 7-12 secondary and 13-18 tertiary.  Each index in the tables represents a port. Weapon ports start at index 2. Valid values for each port are nil or true.<br>
''cb'' function to call on completition (optional)
<br>

=== ConfigureWeaponGroup ===
'''Definition:'''<br>
ConfigureWeaponGroup(int id, table port_ids, function cb) -> nil
<br>
'''Description:'''<br>
Configures one weapon group
<br>
'''Arguments:'''<br>
''id'' is number of group. 0-5 primary, 6-11 secondary and 12-17 tertiary trigger<br>
''ports_ids'' is list of ports active for that group (2-numweaponports)<br>
''cb'' function to call on completition (optional)
<br>

=== ConnectAddon ===
'''Definition:'''<br>
ConnectAddon(int portid, int itemid, function cb) -> bool canconnect
<br>
'''Description:'''<br>
Attaches the addon ''itemid'' to the active ship in port ''portid''
<br>
'''Arguments:'''<br>
''portid'' [[portid]] of the the port<br>
''itemid'' itemid of the addon<br>
''cb'' function to call on completition (optional)
<br>
'''Returns:'''<br>
''canconnect'' returns true if the player is docked and has an active ship otherwise nil
<br>

=== CreateBig3DViewMenu ===
'''Definition:'''<br>
CreateBig3DViewMenu() -> userdata dialog
<br>
'''Description:'''<br>
Create [[API_Index#Big3DViewDialog|Big3DViewDialog]] a [[Big3DViewDialog]]
<br>
'''Returns:'''<br>
''dialog'' [[Big3DViewDialog]]
<br>

=== CreateCancelLoadoutMenu ===
'''Definition:'''<br>
CreateCancelLoadoutMenu() -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with button and message. See [[MessageDialog]]<br>
<br>
'''Returns:'''<br>
''dialog'' [[MessageDialog]]
<br>

=== CreateCapShipChatTab ===
'''Definition:'''<br>
CreateCapShipChatTab() -> userdata box
<br>
'''Description:'''<br>
Create box with "Ship Com" tab. See [[ChatLogTemplate]]
<br>
'''Returns:'''<br>
''box'' box with "Ship Com" tab
<br>

=== CreateCapShipFactionInfo ===
'''Definition:'''<br>
CreateCapShipFactionInfo() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[CapShipFactionInfo]]
<br>

=== CreateCapShipPDATab ===
'''Definition:'''<br>
CreateCapShipPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[CapShipTabPDA]]
<br>

=== CreateCapShipRepairTab ===
'''Definition:'''<br>
CreateCapShipRepairTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[CapShipRepairTab]]
<br>

=== CreateCapShipShiplessChatTab ===
'''Definition:'''<br>
CreateCapShipShiplessChatTab() -> userdata box
<br>
'''Description:'''<br>
Create box with "Ship Com" tab. See [[ChatLogTemplate]]
<br>
'''Returns:'''<br>
''box'' box with "Ship Com" tab
<br>

=== CreateCapShipShiplessFactionInfo ===
'''Definition:'''<br>
CreateCapShipShiplessFactionInfo() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[CapShipShiplessFactionInfo]]
<br>

=== CreateCapShipShiplessPDATab ===
'''Definition:'''<br>
CreateCapShipShiplessPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[CapShipShiplessTabPDA]]
<br>

=== CreateCapShipShiplessTacticalTab ===
'''Definition:'''<br>
CreateCapShipShiplessTacticalTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[CapShipShiplessTacticalTab]]
<br>

=== CreateCapShipTacticalTab ===
'''Definition:'''<br>
CreateCapShipTacticalTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[CapShipTacticalTab]]
<br>

=== CreateCapShipTurretTab ===
'''Definition:'''<br>
CreateCapShipTurretTab() -> userdata box, button
<br>
'''Description:'''<br>
Create [[CapShipTurretTab]] and the select button
<br>
'''Returns:'''<br>
''box'' [[CapShipTurretTab]]<br>
''button'' select button
<br>

=== CreateCharCreateFailedMenu ===
'''Definition:'''<br>
CreateCharCreateFailedMenu() -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with button and message. See [[MessageDialog]]<br>
The created variant pops up [[API_Index#CharCreateDialog|CharCreateDialog]] after clicking the button
<br>
'''Returns:'''<br>
''dialog'' [[MessageDialog]]
<br>

=== CreateCharCreateMenu ===
'''Definition:'''<br>
CreateCharCreateMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[CharCreateDialog]]
<br>

=== CreateCharSelectFailedMenu ===
'''Definition:'''<br>
CreateCharSelectFailedMenu() -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with button and message. See [[MessageDialog]]<br>
The created variant pops up [[API_Index#CharSelectDialog|CharSelectDialog]] after clicking the button
<br>
'''Returns:'''<br>
''dialog'' [[MessageDialog]]
<br>

=== CreateCharSelectMenu ===
'''Definition:'''<br>
CreateCharSelectMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[CharSelectDialog]]
<br>

=== CreateCharacter ===
'''Definition:'''<br>
CreateCharacter(int name, int nation) -> nil
<br>
'''Description:'''<br>
Creates the character of the given nation
<br>
'''Arguments:'''<br>
''name'' name of character<br>
''nation'' nation of character
<br>

=== CreateCharacterPDATab ===
'''Definition:'''<br>
CreateCharacterPDATab() -> userdata box, tab1, tab2, tab3
<br>
'''Returns:'''<br>
''box'' [[PDACharacterTab]]<br>
''tab1'' [[PDACharacterStatsTab]]<br>
''tab2'' [[PDACharacterFactionTab]]<br>
''tab3'' [[PDACharacterAccomTab]]
<br>

=== CreateCommPDATab ===
'''Definition:'''<br>
CreateCommPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PDACommTab]]
<br>

=== CreateConnectingMenu ===
'''Definition:'''<br>
CreateConnectingMenu() -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with button and message. See [[MessageDialog]]<br>
The created variant logs out after clicking the button
<br>
'''Returns:'''<br>
''dialog'' [[MessageDialog]]
<br>

=== CreateCreditsDialog ===
'''Definition:'''<br>
CreateCreditsDialog(userdata parent) -> userdata dialog
<br>
'''Description:'''<br>
Create credits dialog
<br>
'''Arguments:'''<br>
''parent'' dialog to show on clicking "Close"
<br>
'''Returns:'''<br>
''dialog'' credits dialog
<br>

=== CreateEULAMenu ===
'''Definition:'''<br>
CreateEULAMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[EULADialog]]
<br>

=== CreateInvalidAmountMenu ===
'''Definition:'''<br>
CreateInvalidAmountMenu() -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with button and message. See [[msgdlgtemplate1]]
<br>
'''Returns:'''<br>
''dialog'' [[msgdlgtemplate1]]
<br>

=== CreateInventoryPDATab ===
'''Definition:'''<br>
CreateInventoryPDATab() -> userdata dialog, tab1, tab2
<br>
'''Returns:'''<br>
''dialog'' [[PDAInventoryTab]]<br>
''tab1'' [[PDAInventoryInventoryTab]]<br>
''tab2'' [[PDAInventoryJettisonTab]]
<br>

=== CreateKilledByPDATab ===
'''Definition:'''<br>
CreateKilledByPDATab() -> userdata box
<br>
'''Returns:'''<br>
''dialog'' [[KilledByPDATab]]
<br>

=== CreateKilledPDATab ===
'''Definition:'''<br>
CreateKilledPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[KilledPDATab]]
<br>

=== CreateLoadingMenu ===
'''Definition:'''<br>
CreateLoadingMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[LoadingDialog]]
<br>

=== CreateLoginDialog ===
'''Definition:'''<br>
CreateLoginDialog() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[LoginDialog]]
<br>

=== CreateLoginHelpDialog ===
'''Definition:'''<br>
CreateLoginHelpDialog(userdata parent) -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with help text for the login screen and a close button
<br>
'''Arguments:'''<br>
''parent'' dialog to show on clicking close
<br>
'''Returns:'''<br>
''dialog'' login help dialog
<br>

=== CreateLowGridPowerDialog ===
'''Definition:'''<br>
CreateLowGridPowerDialog() -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with low grid power error
<br>
'''Returns:'''<br>
''dialog'' low grid power dialog
<br>

=== CreateMissionAbortMenu ===
'''Definition:'''<br>
CreateMissionAbortMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[MissionAbortDialog]]
<br>

=== CreateMissionPromptMenu ===
'''Definition:'''<br>
CreateMissionPromptMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[MissionPromptDialog]]
<br>

=== CreateMissionsPDATab ===
'''Definition:'''<br>
CreateMissionsPDATab() -> userdata box, tab1, tab2, tab3, tab4, infobutton
<br>
'''Returns:'''<br>
''box'' [[PDAMissionsTab]]<br>
''tab1'' [[PDAMissionNotesTab]]<br>
''tab2'' [[PDAMissionAdvancementTab]]<br>
''tab3'' [[PDAMissionLogTab]]<br>
''tab4'' [[PDAMissionBoardTab]]<br>
''infobutton'' [[PDAMissionBoardTabInfoButton]]
<br>

=== CreateNavigationPDATab ===
'''Definition:'''<br>
CreateNavigationPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PDAShipNavigationTab]]
<br>

=== CreateNearbyShipsPDATab ===
'''Definition:'''<br>
CreateNearbyShipsPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PDASensorNearbyTab]]
<br>

=== CreateNewsMenu ===
'''Definition:'''<br>
CreateNewsMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[NewsDialog]]
<br>

=== CreateNotEnoughStorageMenu ===
'''Definition:'''<br>
CreateNotEnoughStorageMenu() -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with button and message. See [[msgdlgtemplate1]]
<br>
'''Returns:'''<br>
''dialog'' [[msgdlgtemplate1]]
<br>

=== CreateNotificationMenu ===
'''Definition:'''<br>
CreateNotificationMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[NotificationDialog]]
<br>

=== CreateOptionsMenu ===
'''Definition:'''<br>
CreateOptionsMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[OptionsDialog]]
<br>

=== CreatePDA ===
'''Definition:'''<br>
CreatePDA() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[PDADialog]]
<br>

=== CreatePDATab1 ===
'''Definition:'''<br>
CreatePDATab1() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PDATab1]]
<br>

=== CreatePVPTab ===
'''Definition:'''<br>
CreatePVPTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PVPTab]]
<br>

=== CreateQuantityPurchaseMenu ===
'''Definition:'''<br>
CreateQuantityPurchaseMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[API_Index#SellItemDialog]]
<br>

=== CreateSensorPDATab ===
'''Definition:'''<br>
CreateSensorPDATab() -> userdata box, tab1, tab2, tab3, tab4, tab5
<br>
'''Returns:'''<br>
''box'' [[PDASensorTab]]<br>
''tab1'' [[PDASensorNearbyTab]]<br>
''tab2'' [[PDAKilledTab]]<br>
''tab3'' [[PDAKilledByTab]]<br>
''tab4'' [[PDAStationVisitsTab]]<br>
''tab5'' [[PVPTab]]
<br>

=== CreateShipCargoPDATab ===
'''Definition:'''<br>
CreateShipCargoPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PDAInventoryJettisonTab]]
<br>

=== CreateShipPDATab ===
'''Definition:'''<br>
CreateShipPDATab() -> userdata box, tab1
<br>
'''Returns:'''<br>
''box'' [[PDAShipTab]]<br>
''tab1'' [[PDAShipNavigationTab]]
<br>

=== CreateStation ===
'''Definition:'''<br>
CreateStation() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[StationDialog]]
<br>

=== CreateStationBlankTab ===
'''Definition:'''<br>
CreateStationBlankTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationBlankTab]]
<br>

=== CreateStationChatTab ===
'''Definition:'''<br>
CreateStationChatTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationChatTab]]
<br>

=== CreateStationCommerceTab ===
'''Definition:'''<br>
CreateStationCommerceTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationCommerceTab]]
<br>

=== CreateStationCommoditiesBuyTab ===
'''Definition:'''<br>
CreateStationCommoditiesBuyTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationCommoditiesBuyTab]]
<br>

=== CreateStationCommoditiesLoadTab ===
'''Definition:'''<br>
CreateStationCommoditiesLoadTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationCommoditiesLoadTab]]
<br>

=== CreateStationCommoditiesSellTab ===
'''Definition:'''<br>
CreateStationCommoditiesSellTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationCommoditiesSellTab]]
<br>

=== CreateStationCommoditiesTab ===
'''Definition:'''<br>
CreateStationCommoditiesTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationCommerceCommoditiesTab]]
<br>

=== CreateStationEquipmentBuyTab ===
'''Definition:'''<br>
CreateStationEquipmentBuyTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationEquipmentBuyTab]]
<br>

=== CreateStationEquipmentManageTab ===
'''Definition:'''<br>
CreateStationEquipmentManageTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationEquipmentManageTab]]
<br>

=== CreateStationEquipmentSellTab ===
'''Definition:'''<br>
CreateStationEquipmentSellTab() -> userdata box
<br>
'''Description:'''<br>
Unused. Creates old equipment sell tab.
<br>
'''Returns:'''<br>
''box'' [[OldStationEquipmentSellTab]]
<br>

=== CreateStationEquipmentTab ===
'''Definition:'''<br>
CreateStationEquipmentTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationEquipmentTab]]
<br>

=== CreateStationFactionInfo ===
'''Definition:'''<br>
CreateStationFactionInfo() -> userdata dialog
<br>
'''Description:'''<br>
Create [[StationFactionInfo]]
<br>
'''Returns:'''<br>
''dialog'' [[StationFactionInfo]]
<br>

=== CreateStationHelpMenu ===
'''Definition:'''<br>
CreateStationHelpMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[StationHelpDialog]]
<br>

=== CreateStationMissionBuyTab ===
'''Definition:'''<br>
CreateStationMissionBuyTab() -> userdata box, button
<br>
'''Returns:'''<br>
''box'' [[PDAMissionBoardTab]]<br>
''button'' info button in box
<br>

=== CreateStationPDATab ===
'''Definition:'''<br>
CreateStationPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationTabPDA]]
<br>

=== CreateStationPortConfigTab ===
'''Definition:'''<br>
CreateStationPortConfigTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationEquipmentManagePortConfigTab]]
<br>

=== CreateStationShipPurchaseTab ===
'''Definition:'''<br>
CreateStationShipPurchaseTab() -> userdata box, button
<br>
'''Returns:'''<br>
''box'' [[StationEquipmentBuyShipTab]]<br>
''button'' buy button in box
<br>

=== CreateStationShipSelectionTab ===
'''Definition:'''<br>
CreateStationShipSelectionTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationEquipmentManageShipSelectionTab]]
<br>

=== CreateStationShipStatusTab ===
'''Definition:'''<br>
CreateStationShipStatusTab() -> userdata box
<br>
'''Description:'''<br>
Unused. Creates old ship status tab.
<br>
'''Returns:'''<br>
''box'' [[StationEquipmentManageShipStatusTab]]
<br>

=== CreateStationVisitsPDATab ===
'''Definition:'''<br>
CreateStationVisitsPDATab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationVisitsTab]]
<br>

=== CreateStationWelcomeTab ===
'''Definition:'''<br>
CreateStationWelcomeTab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[StationCommerceWelcomeTab]]
<br>

=== CreateStorageRentalDialog ===
'''Definition:'''<br>
CreateStorageRentalDialog() -> userdata dialog
<br>
'''Description:'''<br>
Create storage rental dialog
<br>
'''Returns:'''<br>
''dialog'' [[StorageRentalDialog]]
<br>

=== CreateSurveyMenu ===
'''Definition:'''<br>
CreateSurveyMenu() -> userdata dialog
<br>
'''Returns:'''<br>
''dialog'' [[SurveyDialog]]
<br>

=== CreateTargetInfo ===
'''Definition:'''<br>
CreateTargetInfo() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PDATargetInfo]]
<br>

=== CreateVoiceChatOptions ===
'''Definition:'''<br>
CreateVoiceChatOptions() -> userdata dialog
<br>
'''Description:'''<br>
Create Voicechat options dialog
<br>
'''Returns:'''<br>
''dialog'' [[VoiceChatOptions]]
<br>

=== DeleteCharacter ===
'''Definition:'''<br>
DeleteCharacter(int slot) -> nil
<br>
'''Description:'''<br>
Deletes the character in the character slot ''slot''
<br>
'''Arguments:'''<br>
''slot'' which character to delete
<br>

=== DisableNPCProximityWarning ===
'''Definition:'''<br>
DisableNPCProximityWarning() -> nil
<br>
'''Description:'''<br>
Disable proximity warnings for NPC
<br>

=== DisableOneOffProximityWarning ===
'''Definition:'''<br>
DisableOneOffProximityWarning() -> nil
<br>
'''Description:'''<br>
Disable one off proximity warning. Trigger proximity warning more than once for the same ship.
<br>

=== DisablePlayerProximityWarning ===
'''Definition:'''<br>
DisablePlayerProximityWarning() -> nil
<br>
'''Description:'''<br>
Disable proximity warnings for players
<br>

=== DisableProximityWarning ===
'''Definition:'''<br>
DisableProximityWarning() -> nil
<br>
'''Description:'''<br>
disable the proximity warning ...
<br>

=== DisconnectAddon ===
'''Definition:'''<br>
DisconnectAddon(int ''itemid'') -> bool ret1
<br>
'''Description:'''<br>
detaches the addon ''itemid'' and stores it in the station<br>
Note: detached items will likely have a different itemid in the station
<br>
'''Arguments:'''<br>
''itemid'' id of the item to detach 
<br>
'''Returns:'''<br>
''ret1'' returns true if the player is docked and has an active ship otherwise nil
<br>

=== DisconnectAllAddons ===
'''Definition:'''
DisconnectAllAddons() -> nil
<br>
'''Description:'''<br>
Detach all addons from the active ship and store them in the current station
<br>

=== EnableNPCProximityWarning ===
'''Definition:'''<br>
EnableNPCProximityWarning() -> nil
<br>
'''Description:'''<br>
Enable proximity warnings for NPC
<br>

=== EnableOneOffProximityWarning ===
'''Definition:'''<br>
EnableOneOffProximityWarning() -> nil
<br>
'''Description:'''<br>
Enable one off proximity warning. Trigger proximity warning only once for the same ship.
<br>

=== EnablePlayerProximityWarning ===
'''Definition:'''<br>
EnablePlayerProximityWarning() -> nil
<br>
'''Description:'''<br>
Enable proximity warnings for players
<br>

=== EnableProximityWarning ===
'''Definition:'''<br>
DisableProximityWarning() -> nil
<br>
'''Description:'''<br>
enable the proximity warning ...
<br>

=== EnableVoiceChat ===
'''Definition:'''<br>
EnableVoiceChat(bool enable) -> nil
<br>
'''Description:'''<br>
Toggle Voice chat
<br>
'''Arguments:'''<br>
''enable'' enable voice chat if true
<br>

=== FactionStandingTemplate ===
'''Definition:'''<br>
FactionStandingTemplate(function cb, frame, filler, string expand) -> userdata container
<br>
'''Description:'''<br>
Creates a container with a list of faction standings of a character. Details: [[FactionStandingTemplate]]
<br>
'''Arguments:'''<br>
''cb'' called on clicking an item in the list. [[factionid]] of selected item is passed to it<br>
''frame'' iup.*frame function<br>
''filler'' iup.*filler function<br>
''expand'' iup expand parameter that is applied to the container
<br>
'''Returns:'''<br>
''container''  [[FactionStandingTemplate]]
<br>

=== FactionStandingWithInfoTemplate ===
'''Definition:'''<br>
FactionStandingWithInfoTemplate() -> userdata container
<br>
'''Description:'''<br>
Wrapper around [[API_Index#FactionStandingTemplate|FactionStandingTemplate]] that adds faction descriptions to the list.
<br>
'''Returns:'''<br>
''container'' [[FactionStandingWithInfoTemplate]]
<br>

=== FadeControl ===
'''Definition:'''<br>
FadeControl(userdata control, int timetofade, float startalpha, endalpha, function cb, ...) -> nil
<br>
'''Description:'''<br>
Fade an iup control by modifying its alpha field. Usually a label.
<br>
'''Arguments:'''<br>
''control'' iup control to fade<br>
''timetofade'' time to fade in seconds<br>
''startalpha'' alpha value before fading (0-1)<br>
''endalpha'' alpha value after fading(0-1)<br>
''cb'' function to call when done<br>
''...'' arguments to pass to ''cb''
<br>

=== FadeLookup ===
'''Definition:'''<br>
FadeLookup(userdata control) -> table fi
<br>
'''Description:'''<br>
Get a fade info table of a control that is currently being faded.
<br>
'''Arguments:'''<br>
''control'' faded iup control
<br>
'''Returns'''<br>
''fi'' fade info table or nil if the given control isn't currently being faded<br>
''fi.timetofade'' time to fade in seconds<br>
''fi.startalpha'' alpha value before fading (0-1)<br>
''fi.endalpha'' alpha value after fading(0-1)<br>
''fi.endfunc'' function to call when done<br>
''fi.endfuncargs'' table with arguments for ''fi.endfunc''<br>
''fi.counter'' elapsed fade time<br>
''fi.control'' control that is being faded
<br>

=== FadeStop ===
'''Definition:'''<br>
FadeStop(userdata control) -> nil
<br>
'''Description:'''<br>
Stop fading a control
<br>
'''Arguments:'''<br>
''control'' control that is being faded
<br>

=== FillInObjectInfo ===
'''Definition:'''<br>
FillInObjectInfo(string name, desc) -> nil
<br>
'''Description:'''<br>
Put given name and description into the character info dialog
<br>
'''Arguments:'''<br>
''name'' object name<br>
''desc'' object description
<br>

=== FillInPlayerInfo ===
'''Definition:'''<br>
FillInPlayerInfo(int charid) -> nil
<br>
'''Description:'''<br>
Fill character info dialog with info of given character
<br>
'''Arguments:'''<br>
''charid'' [[charid]]
<br>

=== FindAndReplaceTags ===
'''Definition:'''<br>
FindAndReplaceTags(string text, table matches) -> string ret1
<br>
'''Description:'''<br>
Replaces all occurances of with &lt; and &gt; enclosed substrings in ''text'' with matching values from the provided table
<br>
'''Arguments:'''<br>
''test'' string to replace tags in<br>
''matches'' table with tags/replacement pairs
<br>
'''Returns:'''<br>
''ret1'': converted text
<br>

=== FindAndReplaceTagsCB ===
'''Definition:'''<br>
FindAndReplaceTagsCB(string text, function cb) -> string ret1
<br>
'''Description:'''<br>
Pass each occurances of with &lt; and &gt; enclosed substrings in ''text'' to ''cb'' and replace them with the return value
<br>
'''Arguments:'''<br>
''test'' string to replace tags in<br>
''cb'' called with the content of each tag as argument
<br>
'''Returns:'''<br>
''ret1'': converted text
<br>

=== ForEachBuddy ===
'''Definition:'''<br>
ForEachBuddy(function func(string name, bool isonline, int sectorid)) -> nil
<br>
'''Description:'''<br>
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
<br>
'''Arguments:'''<br>
''func'' gets called for each buddy<br>
''name'' name of the buddy<br>
''isonline'' true if the player is online else false<br>
''sectorid'' location of player as [[sectorid]] 
<br>

=== ForEachPlayer ===
'''Definition:'''<br>
ForEachPlayer(function func(int charid)) -> nil
<br>
'''Description:'''<br>
calls ''func'' with the character id of each player in the sector. that includes bots and the sector thingy itself
<br>
This function is called by the toplist when you open it.
<br>
'''Arguments:'''<br>
''func'' gets called for each buddy<br>
''ncharid'' character id <br>
<br>

=== ForgiveKiller ===
'''Definition:'''<br>
ForgiveKiller(bool forgive) -> nil
<br>
'''Description:'''<br>
Forgive the last killer.
<br>
'''Arguments:'''<br>
''forgive'' if true forgive the last killer if not don't
<br>

=== GeneratePlayerDiedMessage ===
'''Definition:'''<br>
GeneratePlayerDiedMessage(string name1, name2, int weapon) -> string msg
<br>
'''Description:'''<br>
generate appropiate kill message for the arguments.
<br>
'''Arguments:'''<br>
''name1'' character that died<br>
''name2'' character that killed name1<br>
''weapon'' [[weaponid]] of weapon with which the kill was made(?)
<br>
'''Returns:'''<br>
''msg'' kill message
<br>

=== GetAccomplishmentBigSize ===
'''Definition:'''<br>
GetAccomplishmentBigSize(int type, level) -> string bigsize
<br>
'''Description:'''<br>
Get size of accomplishment medal
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''bigsize'' iup size string of medal
<br>

=== GetAccomplishmentBigTexture ===
'''Definition:'''<br>
GetAccomplishmentBigTexture(int type, level) -> string tex
<br>
'''Description:'''<br>
Get texture of accomplishment medal
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''tex'' filename of medal texture
<br>

=== GetAccomplishmentBigUV ===
'''Definition:'''<br>
GetAccomplishmentBigUV(int type, level) -> string uv
<br>
'''Description:'''<br>
Get uv mapping of accomplishment medal
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''uv'' iup uv mapping of medal texture
<br>

=== GetAccomplishmentCategory ===
'''Definition:'''<br>
GetAccomplishmentCategory(int type, level) -> string category
<br>
'''Description:'''<br>
Get category of accomplishment
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''category'' accomplishment category
<br>

=== GetAccomplishmentDescription ===
'''Definition:'''<br>
GetAccomplishmentDescription(int type, level) -> string desc
<br>
'''Description:'''<br>
Get description of accomplishment
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''desc'' accomplishment description
<br>

=== GetAccomplishmentLevels ===
'''Definition:'''<br>
GetAccomplishmentLevels(int accomid) -> int curlevel int reqlevel
<br>
'''Description:'''<br>
returns the current and the required level for the selected accomplishment
<br>
'''Arguments:'''<br>
''accomid'' id of the accomplishment
<br>
'''Returns:'''<br>
''curlevel'' current level of the accomplishment<br>
''reqlevel'' what is required to get the accomplishment<br>
<br>

=== GetAccomplishmentName ===
'''Definition:'''<br>
GetAccomplishmentName(int type, level) -> string name
<br>
'''Description:'''<br>
Get name of accomplishment
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''name'' name of accomplishment
<br>

=== GetAccomplishmentSize ===
'''Definition:'''<br>
GetAccomplishmentSize(int type, level) -> string size
<br>
'''Description:'''<br>
Get size of accomplishment badge
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''size'' iup size of badge
<br>

=== GetAccomplishmentTexture ===
'''Definition:'''<br>
GetAccomplishmentTexture(int type, level) -> string tex
<br>
'''Description:'''<br>
Get texture of accomplishment badge
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''tex'' filename of badge texture
<br>

=== GetAccomplishmentTitle ===
'''Definition:'''<br>
GetAccomplishmentTitle(int type, level) -> string title
<br>
'''Description:'''<br>
Get title of accomplishment
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''title'' accomplishment title
<br>

=== GetAccomplishmentType ===
'''Definition:'''<br>
GetAccomplishmentType(int accomindex, char) -> int accomplishmenttype int accomplishmentlevel
<br>
'''Description:'''<br>
returns some numbers..
<br>
'''Arguments:'''<br>
''accomindex'' index of the accomplishment<br>
''char'' [[charid]] of character whose accomplishment to look up
<br>
'''Returns:'''<br>
''accomplishmenttype'' type of accomplishment<br>
''accomplishmentlevel'' what level the accomplishment is, starting at 1.<br>
<br>

=== GetAccomplishmentUV ===
'''Definition:'''<br>
GetAccomplishmentUV(int type, level) -> string uv
<br>
'''Description:'''<br>
Get uv mapping of accomplishment badge
<br>
'''Arguments:'''<br>
''type'' accomplishment type<br>
''level'' accomplishment level
<br>
'''Returns:'''<br>
''uv'' iup uv mapping of badge
<br>

=== GetActiveChatChannel ===
'''Definition:'''<br>
GetActiveChatChannel() -> int channel
<br>
'''Description:'''<br>
returns the active channel
<br>
'''Returns:'''<br>
''channel'' active chat channel
<br>

=== GetActiveMissionInfo ===
'''Definition:'''<br>
GetActiveMissionInfo(int num) -> string mname table mmsg int itemid
<br>
'''Description:'''<br>
Get information about the selcted active mission
<br>
'''Arguments:'''<br>
''num'' index of active mission (always 1)
<br>
'''Returns:'''<br>
''mname'' string containing name of active mission<br>
''mmsg'' array where each index contains a mission log entry + optional interface elements and their properties<br>
''itemid'' itemid of the mission
<br>

=== GetActiveShipCargoCount ===
'''Definition:'''<br>
GetActiveShipCargoCount() -> int cargocount
<br>
'''Description:'''<br>
returns amount of cargo in the ship
<br>
'''Returns:'''<br>
''cargocount'' amount of cargo in the ship
<br>

=== GetActiveShipEnergy ===
'''Definition:'''<br>
GetActiveShipEnergy() -> float eng fraction
<br>
'''Description:'''<br>
returns the energy level of the active ship
<br>
'''Returns:'''<br>
''eng'' energy level in game units 0 .. maxcapacacity <br>
''fraction'' energy level as float from 0.0-1.0
<br>

=== GetActiveShipGridPowerAndUsage ===
'''Definition:'''<br>
GetActiveShipGridPowerAndUsage() -> int power usage
<br>
'''Description:'''<br>
returns the energy grid power and usage of the current ship..
<br>
'''Returns:'''<br>
''power'' energy grid power<br>
''fraction'' power usage
<br>

=== GetActiveShipHealth ===
'''Definition:'''<br>
GetActiveShipHealth() -> int d1 d2 d3 d4 d5 d6 dmg max 
<br>
'''Description:'''<br>
returns information about the active ships health
<br>
'''Returns:'''<br>
''d?'' damage to subsection 0 = no damage<br>
''dmg'' accumulated damage of subsections<br>
''max'' max health of ship
<br>

=== GetActiveShipID ===
'''Definition:'''<br>
GetActiveShipID() -> int itemid
<br>
'''Description:'''<br>
returns itemid of active ship
<br>
'''Returns:'''<br>
''itemid'' item id of active ship
<br>

[[Category:Functions]]

=== GetActiveShipItemIDAtPort ===
'''Definition:'''<br>
GetActiveShipItemIDAtPort(int portid) -> int itemid
<br>
'''Description:'''<br>
returns itemid of addon in selected port
<br>
'''Arguments:'''<br>
''portid'' [[portid]]
<br>
'''Returns:'''<br>
''itemid'' itemid of addon in port
<br>

=== GetActiveShipMass ===
'''Definition:'''<br>
GetActiveShipMass() -> int mass
<br>
'''Description:'''<br>
returns mass of active ship
<br>
'''Returns:'''<br>
''mass'' mass of active ship
<br>

=== GetActiveShipMaxCargo ===
'''Definition:'''<br>
GetActiveShipMaxCargo() -> int cargo
<br>
'''Description:'''<br>
returns amount of cargo space of the active ship in cu
<br>
'''Returns:'''<br>
''cargo'' cargospace
<br>

=== GetActiveShipMaxSpeed ===
'''Definition:'''<br>
GetActiveShipMaxSpeed() -> int speed
<br>
'''Description:'''<br>
returns max nonturbo speed of active ship
<br>
'''Returns:'''<br>
''speed'' ...
<br>

=== GetActiveShipName ===
'''Definition:'''<br>
GetActiveShipName() -> string name
<br>
'''Description:'''<br>
returns a string with the active ships name
<br>
'''Returns:'''<br>
''name'' ... 
<br>

=== GetActiveShipNumAddonPorts ===
'''Definition:'''<br>
GetActiveShipNumAddonPorts() -> int ports
<br>
'''Description:'''<br>
returns number of ports in active ship
<br>
'''Returns:'''<br>
''ports'' number of ports, including engine and battery 
<br>

=== GetActiveShipPortIDOfItem ===
'''Definition:'''<br>
GetActiveShipPortIDOfItem(int itemid) -> int portid
<br>
'''Description:'''<br>
returns [[portid]] of the given addon in active ship
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of an addon
<br>
'''Returns:'''<br>
''portid'' [[portid]] of port the addon is in or nil if addon is not on the ship or invalid
<br>

=== GetActiveShipPortInfo ===
'''Definition:'''<br>
GetActiveShipPortInfo(int portid) -> table portinfo
<br>
'''Description:'''<br>
returns information about the given port
<br>
'''Arguments:'''<br>
''portid'' [[portid]]
<br>
'''Returns:'''<br>
''portinfo'' table with port info <br>
fields include:<br>
type: int holding the type of port<br>
name string describing port<br>
position: vector with port position on ship<br>
orientation: quaternion holding orientation of port<br>
<br>

=== GetActiveShipSelectedWeaponGroupIDs ===
'''Definition:'''<br>
GetActiveShipSelectedWeaponGroupIDs() -> int id1 id2 id3
<br>
'''Description:'''<br>
returns ids of the selected weapon groups ...
<br>
'''Returns:'''<br>
''id?'' id's of weapon groups. Probably mapping to those key buttons.
<br>

=== GetActiveShipSpeed ===
'''Definition:'''<br>
GetActiveShipSpeed() -> int speed
<br>
'''Description:'''<br>
returns current speed of active ship
<br>
'''Returns:'''<br>
''speed'' ...
<br>

=== GetActiveShipWeaponGroup ===
'''Definition:'''<br>
GetActiveShipWeaponGroup(int id) -> table group
<br>
'''Description:'''<br>
return which ports are enabled in the provided group
<br>
'''Arguments:'''<br>
''id'' id of weapon group correspondents to group key[0-5] + (trigger group[0-2] * 6)
<br>
'''Returns:'''<br>
''port'' table where the indexes are the port ids and values bools that are true when the port is active
<br>

=== GetAddonItemInfo ===
'''Definition:'''<br>
GetAddonItemInfo(int itemid) -> int current maximum
<br>
'''Description:'''<br>
Returns current and maximum ammo if itemid is a weapon with ammo, or current/maximum armor if itemid is a ship.
<br>
'''Arguments:'''<br>
''itemid'' itemid of an addon or ship.
<br>
'''Returns:'''<br>
''current'' Current ammo/armor, or -1.<br>
''maximum'' Maximum ammo/armor, or -1.
<br>

=== GetAvailableMissionInfo ===
'''Definition:'''<br>
GetAvailableMissionInfo(int midx) -> {int itemtype, string name, bool active, int category, string icon, string desc}
<br>
'''Description:'''<br>
Returns information about the mission with the given index.
<br>
'''Arguments:'''<br>
''midx'' index of mission in missionlist (1 based)
<br>
'''Returns:'''<br>
''itemtype'' no idea<br>
''name'' name of mission<br>
''active'' is this mission active<br>
''category'' mission category<br>
''icon'' path to icon<br>
''desc'' mission description
<br>

=== GetBarPatrons ===
'''Definition:'''<br>
GetBarPatrons() -> {[charid1], [charid2]...}
<br>
'''Description:'''<br>
get people in the current station bar
<br>
'''Returns:'''<br>
''charid?'' index of returned table are charids of characters in the bar
<br>

=== GetBestPriceInfoOfItem ===
'''Definition:'''<br>
GetBestPriceInfoOfItem(int item) -> int price, station
<br>
'''Description:'''<br>
Get highest sell price of a cargo item in the active ship in the currentsystem
<br>
'''Arguments:'''<br>
''item''  [[itemid]] of cargo item
<br>
'''Returns:'''<br>
''price'' highest price in system<br>
''station'' [[locationid]] of station with highest price
<br>

=== GetBotSightedInfoForSector ===
'''Definition:'''<br>
GetBotSightedInfoForSector(int sectorid) -> string botinfo
<br>
'''Description:'''<br>
returns bot ihnfo text for the given sector
<br>
'''Arguments:'''<br>
''sectorid''   [[sectorid]]
<br>
'''Returns:'''<br>
''botinfo'' string with bots in given sector or an empty string
<br>

=== GetBuddyInfo ===
'''Definition:'''<br>
GetBuddyInfo(int char) -> string name, bool isonline, int sectorid
<br>
'''Description:'''<br>
Get name, online status and location of a buddy
<br>
'''Arguments:'''<br>
''char'' [[charid]] of a buddy
<br>
'''Returns:'''<br>
''name'' name of buddy<br>
''isonline'' online status<br>
''sectorid'' [[sectorid]] of location of buddy 
<br>

=== GetCargoValue ===
'''Definition:'''<br>
GetCargoValue() -> int value, price
<br>
'''Description:'''<br>
Get value and buy price of the cargo and equipped addons on the active ship at the current station
<br>
'''Returns:'''<br>
''value'' value of cargo and addons<br>
''price'' buy price of cargo and addons at the current station 
<br>

=== GetCharacterDescription ===
'''Definition:'''<br>
GetCharacterDescription(int charid) -> string desc
<br>
'''Description:'''<br>
Get the character description of a character
<br>
'''Arguments:'''<br>
''charid'' [[charid]] of a character
<br>
'''Returns:'''<br>
''desc'' character description
<br>

=== GetCharacterID ===
'''Definition:'''<br>
GetCharacterID(int nodeid) -> int charid
<br>
'''Description:'''<br>
returns character id of the provided node id
<br>
'''Arguments:'''<br>
''nodeid'' node id of one of the characters in the sector
<br>
'''Returns:'''<br>
''charid'' character id of the given node if a valid nodeid is valid otherwise the players charid
<br>

=== GetCharacterIDByName ===
'''Definition:'''<br>
GetCharacterIDByName(string name) -> int charid
<br>
'''Description:'''<br>
get character id by name
<br>
'''Arguments:'''<br>
''name'' name of a character
<br>
'''Returns:'''<br>
''charid'' a character id or nil
<br>

=== GetCharacterInfo ===
'''Definition:'''<br>
GetCharacterInfo(int cslot) -> string name faction int money kills deaths loc home cl ll hl tl ml
<br>
'''Description:'''<br>
Get information about your characters
<br>
'''Arguments:'''<br>
''cslot'' a character slot (1-6)
<br>
'''Returns:'''<br>
''name''<br>
''faction''<br>
''money''<br>
''kills'' all kills<br>
''deaths''<br>
''loc'' [[sectorid]] of current location<br>
''home'' [[sectorid]] of characters homestation<br>
''cl'' combat level<br>
''ll'' light weapon level<br>
''hl'' heavy weapon level<br>
''tl'' trade level<br>
''ml'' mining level
<br>

=== GetCharacterKillDeaths ===
'''Definition:'''<br>
GetCharacterKillDeaths(int charid) -> int kills deaths pks
<br>
'''Description:'''<br>
get info about kills and deaths. returns your own info if no charid given or a lua error if an invalid one ...
<br>
'''Arguments:'''<br>
''charid'' character id or nil
<br>
'''Returns:'''<br>
''kills'' total kills
''deaths'' total deaths
''pks'' player kills
<br>

=== GetChatLogReadState ===
'''Definition:'''
GetChatLogReadState() -> bool read
<br>
'''Description:'''<br>
Tell if the general chat log was displayed. [[API_Index#SetChatLogRead|SetChatLogRead]] was called since the last line was added to the log.
<br>
'''Returns:'''<br>
''read'' true if the log was displayed
<br>

=== GetConqueredSectorsInSystem ===
'''Definition:'''<br>
GetConqueredSectorsInSystem(int systemid) -> table sectors
<br>
'''Description:'''<br>
Get table with conquered sectors in the given system
<br>
'''Arguments:'''<br>
''systemid'' [[systemid]]
<br>
'''Returns:'''<br>
''sectors'' table with [[sectorid]]-[[factionid]] mappings or nil if no conquered sectors exist in system
<br>

=== GetConqueredStatus ===
'''Definition:'''<br>
GetConqueredStatus(int sectorid) -> int faction
<br>
'''Description:'''<br>
Get faction that conquered the given sector
<br>
'''Arguments:'''<br>
''sectorid'' [[sectorid]]
<br>
'''Returns:'''<br>
''faction'' [[factionid]] or nil if sector is unconquered
<br>

=== GetCurrentChatTab ===
'''Definition:'''
GetCurrentChatTab() -> int tab
<br>
'''Description:'''<br>
Unused. Get The current chat tab (general chat or mission chat)
<br>
'''Returns:'''<br>
''tab'' 1 = general, 2 = mission
<br>

=== GetCurrentSectorid ===
'''Definition:'''
GetCurrentSectorid() -> int sectorid
<br>
'''Description:'''<br>
get current sector id
<br>
'''Returns:'''<br>
''sectorid'' [[sectorid]] of current sector
<br>

=== GetCurrentStationType ===
'''Definition:'''
GetCurrentStationType() -> int type
<br>
'''Description:'''<br>
return the current station type..
<br>
'''Returns:'''<br>
''type'' current station type. seems be usually 0 except when docked to a capship then 1
<br>

=== GetCurrentSystemid ===
'''Definition:'''
GetCurrentSystemid() -> int systemid
<br>
'''Description:'''<br>
get current system id..
<br>
'''Returns:'''<br>
''systemid'' id of current system
<br>

=== GetEULA ===
'''Definition:'''
GetEULA() -> string eula
<br>
'''Description:'''<br>
return eula
<br>
'''Returns:'''<br>
''eula'' string containing the eula
<br>

=== GetFactionInfo ===
'''Definition:'''
GetFactionInfo(int faction) -> string info
<br>
'''Description:'''<br>
get faction info text for the provided faction 
<br>
'''Arguments:'''<br>
''faction'' id of a faction
<br>
'''Returns:'''<br>
''info'' string containing faction info
<br>

=== GetFinishedMissionInfo ===
'''Definition:'''
GetFinishedMissionInfo() -> string name table msg int itemid
<br>
'''Description:'''<br>
see GetActiveMissionInfo
<br>

=== GetFriendlyStatus ===
'''Definition:'''
GetFriendlyStatus(int char) -> int fstatus
<br>
'''Description:'''<br>
get friendlyness of a character
<br>
'''Arguments:'''<br>
''char'' [[nodeid]]
<br>
'''Returns:'''<br>
''fstatus'' Returns 0 to 3. Target is friendly if 3, unfriendly otherwise
<br>

=== GetFullPath ===
'''Definition:'''
GetFullPath(int sector, table navroute) -> table fullpath
<br>
'''Description:'''<br>
Get the full path, including wormhole sectors, from ''sector'' along ''navroute''
<br>
'''Arguments:'''<br>
''sector'' [[sectorid]] of starting sectors<br>
''navroute'' list of sectorids
<br>
'''Returns:'''<br>
''fullpath'' ''navroute'' plus sectorids of wormhole sectors
<br>

=== GetGeneralChatLog ===
'''Definition:'''
GetGeneralChatLog() -> table log
<br>
'''Description:'''<br>
returns the chatlog
<br>
'''Returns:'''<br>
''log'' table containing chatlog
<br>

=== GetGroupMemberID ===
'''Definition:'''
GetGroupMemberID(int index) -> int charid
<br>
'''Description:'''<br>
get charid of group member with given index
<br>
'''Arguments:'''<br>
''index'' group member index (1-8)
<br>
'''Returns:'''<br>
''charid'' character id
<br>

=== GetGroupMemberLocation ===
'''Definition:'''
GetGroupMemberLocation(int charid) -> int loc
<br>
'''Description:'''<br>
get location of a groupmember
<br>
'''Arguments:'''<br>
''charid'' character ids of a groupmember
<br>
'''Returns:'''<br>
''loc'' [[sectorid]] of groupmember or 0 for yourself
<br>

=== GetGroupOwnerID ===
'''Definition:'''
GetGroupOwnerID() -> int charid
<br>
'''Description:'''<br>
get charid of group owner
<br>
'''Returns:'''<br>
''charid'' character id
<br>

=== GetGuildAcronym ===
'''Definition:'''<br>
GetGuildAcronym() -> string acronym
<br>
'''Description:'''<br>
get your guilds acronym
<br>
'''Returns:'''<br>
''acronym'' string containing guild acronym
<br>

=== GetGuildBalance ===
'''Definition:'''<br>
GetGuildBalance() -> int balance
<br>
'''Description:'''<br>
get amount of money in guild bank
<br>
'''Returns:'''<br>
''balance'' money in bank
<br>

=== GetGuildBankPrivileges ===
'''Definition:'''<br>
GetGuildBankPrivileges() -> table deposit withdraw logview
<br>
'''Description:'''<br>
get your guilds bank privileges as three tables. they contain the ranks carrying each privilege.<br>
see [API_Index#Guild]
<br>
'''Returns:'''<br>
''deposit'' table with ranks that can deposit money<br>
''withdraw'' table with ranks that can withdraw money<br>
''logview'' table with ranks that can view the transfer log<br>
<br>

=== GetGuildBankWithdrawalLimits ===
'''Definition:'''<br>
GetGuildBankWithdrawalLimits() -> int ret1 ret2 ret3
<br>
'''Description:'''<br>
get withdrawal limits? returns three numbers
<br>
'''Returns:'''<br>
''ret1''<br>
''ret4''<br>
''ret3''
<br>

=== GetGuildMOTD ===
'''Definition:'''<br>
GetGuildMOTD() -> string motd
<br>
'''Description:'''<br>
get your guilds message of the day
<br>
'''Returns:'''<br>
''motd'' string containing the motd
<br>

=== GetGuildMemberInfo ===
'''Definition:'''
GetGuildMemberInfo(int index) -> int charid rank string name 
<br>
'''Description:'''<br>
get information about the guildmember of the given index
<br>
'''Arguments:'''<br>
''index'' index of online guildmembers 1-n
<br>
'''Returns:'''<br>
''charid'' character id<br>
''rank'' rank: 0=member, 1=lieutenant, 2=council member, 3=council member and lieutenant, 4=commander<br>
''name'' name of member<br>
<br>

=== GetGuildMemberInfoByCharID ===
'''Definition:'''
GetGuildMemberInfoByCharID(int charid) -> int charid rank string name 
<br>
'''Description:'''<br>
get information about the guildmember
<br>
'''Arguments:'''<br>
''charid'' charid of online guildmember
<br>
'''Returns:'''<br>
''charid'' character id<br>
''rank'' rank: 0=member, 1=lieutenant, 2=council member, 3=council member and lieutenant, 4=commander<br>
''name'' name of member
<br>

=== GetGuildName ===
'''Definition:'''
GetGuildName() -> string name
<br>
'''Description:'''<br>
get guild name
<br>
'''Returns:'''<br>
''name'' string containing guild name
<br>

=== GetGuildTag ===
'''Definition:'''
GetGuildTag(int charid) -> string tag
<br>
'''Description:'''<br>
get guild tag of self or another character.
<br>
'''Arguments:'''<br>
''charid'' character id or nil to get self's guild tag.
<br>
'''Returns:'''<br>
''tag'' string containing guild tag or empty string if character not known or not in a guild.
<br>

=== GetHomeStation ===
'''Definition:'''
GetHomeStation() -> int sectorid
<br>
'''Description:'''<br>
get sectorid of home station
<br>
'''Returns:'''<br>
''sectorid'' [[sectorid]] of home station  
<br>

=== GetInventoryItemClassSubType ===
'''Definition:'''
GetInventoryItemClassSubType(int itemid) -> int subtype
<br>
'''Description:'''<br>
get subclass of an item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''subtype'' sub type of item<br>
known types:<br>
0 = light weapon or ship<br>
1 = heavy weapon<br>
3 = engine<br>
4 = battery<br>
10 = trade goods
<br>

=== GetInventoryItemClassType ===
'''Definition:'''
GetInventoryItemClassType(int itemid) -> int type
<br>
'''Description:'''<br>
get class of an item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''type'' class of item. you can use those CLASSTYPE_* constants to identify types
<br>

=== GetInventoryItemContainerID ===
'''Definition:'''
GetInventoryItemContainerID(int itemid) -> int container
<br>
'''Description:'''<br>
get container of item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''container'' itemid of container of or null if it's not in one (a ship)
<br>

=== GetInventoryItemExtendedDesc ===
'''Definition:'''
GetInventoryItemExtendedDesc(int itemid) -> string desc
<br>
'''Description:'''<br>
get description of item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''desc'' item description text.
<br>

=== GetInventoryItemIcon ===
'''Definition:'''
GetInventoryItemIcon(int itemid) -> string path
<br>
'''Description:'''<br>
get path to icon of inventory item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''path'' path to icon
<br>

=== GetInventoryItemInfo ===
'''Definition:'''
GetInventoryItemInfo(int itemid) -> string ipath name int quant float mass string sdesc desc1 desc2 int container class subtype
<br>
'''Description:'''<br>
get most info about inventory item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''ipath'' icon path<br> 
''name'' name or item<br>
''quant'' amount of items<br> 
''mass'' per item mass as float in tons<br> 
''sdesc'' short description<br> 
''desc1'' long description<br> 
''desc2'' long description again, sometimes omitted don't know what's the difference<br> 
''container'' itemid of container this item is in<br> 
''class'' type of item (see GetInventoryItemClassType)<br> 
''subtype'' subtype of item (see GetInventoryItemClassSubType)
<br>

=== GetInventoryItemLocation ===
'''Definition:'''
GetInventoryItemLocation(int itemid) -> int stationid
<br>
'''Description:'''<br>
get location of an inventory item
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of an inventory item
<br>
'''Returns:'''<br>
''stationid'' [[stationid]] or nil if itemid is invalid
<br>

=== GetInventoryItemLongDesc ===
'''Definition:'''
GetInventoryItemLongDesc(int itemid) -> string desc
<br>
'''Description:'''<br>
get long description of an inventory item
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of an inventory item
<br>
'''Returns:'''<br>
''desc'' long description of an inventory item
<br>

=== GetInventoryItemMass ===
'''Definition:'''
GetInventoryItemMass(int itemid) -> float mass
<br>
'''Description:'''<br>
get mass of inventory item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''path'' mass of item as float in tons
<br>

=== GetInventoryItemName ===
'''Definition:'''
GetInventoryItemName(int itemid) -> string name
<br>
'''Description:'''<br>
get name of inventory item
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''name'' name
<br>

=== GetInventoryItemQuantity ===
'''Definition:'''
GetInventoryItemQuantity(int itemid) -> int quant
<br>
'''Description:'''<br>
get quantity of inventory item..
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''quant'' quantity
<br>

=== GetInventoryItemType ===
'''Definition:'''
GetInventoryItemType(int itemid) -> int type
<br>
'''Description:'''<br>
get item type
<br>
'''Arguments:'''<br>
''itemid'' inventory item
<br>
'''Returns:'''<br>
''type'' type
<br>

=== GetInventoryItemUnitCost ===
'''Definition:'''
GetInventoryItemUnitCost(int itemid) -> int cost
<br>
'''Description:'''<br>
get price paid for the given item(?)
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of an inventory item
<br>
'''Returns:'''<br>
''cost'' price of item
<br>

=== GetInventoryItemVolume ===
'''Definition:'''
GetInventoryItemVolume(int itemid) -> int volume
<br>
'''Description:'''<br>
get per unit volume of item in cu
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of an inventory item
<br>
'''Returns:'''<br>
''volume'' volume in cu
<br>

=== GetItemFullDesc ===
'''Definition:'''
GetItemFullDesc(table item) -> string desc
<br>
'''Description:'''<br>
get full description of an inventory item
<br>
'''Arguments:'''<br>
''item'' [[iteminfo]] table
<br>
'''Returns:'''<br>
''desc'' full description of item
<br>

=== GetItemPartialDesc ===
'''Definition:'''
GetItemPartialDesc(table item) -> string desc
<br>
'''Description:'''<br>
get partial description of an inventory item
<br>
'''Arguments:'''<br>
''item'' [[iteminfo]] table
<br>
'''Returns:'''<br>
''desc'' partial description of item
<br>

=== GetJoinedChannels ===
'''Definition:'''
GetJoinedChannels() -> table channels
<br>
'''Description:'''<br>
get array with currently joined channels
<br>
'''Returns:'''<br>
''channels'' array with joined channels
<br>

=== GetLastAggressor ===
'''Definition:'''
GetLastAggressor(int itemid) -> int nodeid ret1
<br>
'''Description:'''<br>
get node id of last aggressor and some number
<br>
'''Returns:'''<br>
''nodeid'' node id of last aggressor
''ret1'' no clue
<br>

=== GetLastPrivateSpeaker ===
'''Definition:'''
GetLastPrivateSpeaker() -> string name
<br>
'''Description:'''<br>
get name of last character that pmed you
<br>
'''Returns:'''<br>
''name'' last messager
<br>

=== GetLastShipLoadout ===
'''Definition:'''
GetLastShipLoadout() -> {groups = {1 = group1 .. 18 = group18}, int ship, ports= {1 = port1 ..}, int shipcolor}
<br>
'''Description:'''<br>
get last ship loadout, color and weapon groups. this function only works in space
<br>
'''Returns:'''<br>
''groups'' table containing the weapon group setup
''group?'' group information. array indices correspondent to ports, is the value of an index set to true the port is enabled
''ship'' type of ship
''ports'' array indices correspondent to ports, value of index is the type of addon
''shipcolor'' ship color 1-255(?)
<br>

=== GetLastShipLoadoutPurchaseCost ===
'''Definition:'''
GetLastShipLoadoutPurchaseCost() -> int cost
<br>
'''Description:'''<br>
what you payed for your last ship(?)
<br>
'''Returns:'''<br>
''cost''
<br>

=== GetLicenseLevel ===
'''Definition:'''
GetLicenseLevel(int type, int charid) -> int level
<br>
'''Description:'''<br>
get the level of the provided license.  returns your own level if charid is not given.
<br>
'''Arguments:'''<br>
''type'' type of license (1-5)<br>
''charid'' character id or nil
<br>
'''Returns:'''<br>
''level'' license level or 0 if invalid type given
<br>

=== GetLicenseRequirement ===
'''Definition:'''
GetLicenseRequirement(int level) -> int xp
<br>
'''Description:'''<br>
get xp required for given level
<br>
'''Arguments:'''<br>
''level'' license level
<br>
'''Returns:'''<br>
''xp''
<br>

=== GetListOfSeenNames ===
'''Definition:'''
GetListOfSeenNames() -> table names
<br>
'''Description:'''<br>
get table with names of characters that have been in the same sector as the player or have sent messages 
<br>
'''Returns:'''<br>
''names'' table with names of characters
<br>

=== GetMaxRadarDistance ===
'''Definition:'''
GetMaxRadarDistance() -> int dist
<br>
'''Description:'''<br>
get current(?) max radar range
<br>
'''Returns:'''<br>
''dist'' max radar range
<br>

=== GetMinJumpDistance ===
'''Definition:'''
GetMinJumpDistance() -> int dist
<br>
'''Description:'''<br>
get minimum distance from large objects to jump
<br>
'''Returns:'''<br>
''dist'' min jump distance
<br>

=== GetMissionChatLog ===
'''Definition:'''
GetMissionChatLog() -> {bool updated, string 1.. }
<br>
'''Description:'''<br>
get advancement log
<br>
'''Returns:'''<br>
''1-n'' advancement log
''updated'' no clue
<br>

=== GetMissionLogReadState ===
'''Definition:'''
GetMissiontLogReadState() -> bool read
<br>
'''Description:'''<br>
Tell if the mission chat/advanmcement log was displayed. [[API_Index#SetMissionLogRead|SetMissionLogRead]] was called since the last line was added to the log.
<br>
'''Returns:'''<br>
''read'' true if the log was displayed
<br>

=== GetMissionTimers ===
'''Definition:'''
GetMissionTimers() -> int time
<br>
'''Description:'''<br>
get time left on the current mission. may have some functionality for multiple missions
<br>
'''Returns:'''<br>
''time'' time left on this timer in 1000th seconds
<br>

=== GetMoney ===
'''Definition:'''
GetMoney() -> int money
<br>
'''Description:'''<br>
get how many credits you own
<br>
'''Returns:'''<br>
''money''
<br>

=== GetNationKills ===
'''Definition:'''
GetNationKills(int nation) -> int kills
<br>
'''Description:'''<br>
get number of player kills for the given nation
<br>
'''Arguments:'''<br>
''nation'' id of nation (1-3)
<br>
'''Returns:'''<br>
''kills'' number of player kills or 0 if invalid nation
<br>

=== GetNewsHeadline ===
'''Definition:'''
GetNewsHeadline(int index) -> string title int time ret1 
<br>
'''Description:'''<br>
get headline, post time and some number
<br>
'''Arguments:'''<br>
''index'' index of headline newest is 1 
<br>
'''Returns:'''<br>
''title'' the headline
''time'' post date in unix time
''ret1'' no clue, always 1
<br>

=== GetNumAccomplishments ===
'''Definition:'''
GetNumAccomplishments(int charid) -> int accomplishments
<br>
'''Description:'''<br>
get number of accomplishments for the given character
<br>
'''Arguments:'''<br>
''charid'' [[charid]] of a character
<br>
'''Returns:'''<br>
''accomplishments'' number of accomplishments 
<br>

=== GetNumActiveMissions ===
'''Definition:'''
GetNumActiveMissions() -> int missions
<br>
'''Description:'''<br>
get number of active missions.
<br>
'''Returns:'''<br>
''missions'' number of active missions
<br>

=== GetNumAvailableMissions ===
'''Definition:'''
GetNumAvailableMissions() -> int missions
<br>
'''Description:'''<br>
get number of available missions
<br>
'''Returns:'''<br>
''missions'' 
<br>

=== GetNumCharacters ===
'''Definition:'''
GetNumCharacters() -> int chars
<br>
'''Description:'''<br>
get number of characters you have defined
<br>
'''Returns:'''<br>
''chars''
<br>

=== GetNumCompletedMissions ===
'''Definition:'''
GetNumCompletedMissions() -> int missions
<br>
'''Description:'''<br>
get number of completed missions
<br>
'''Returns:'''<br>
''missions''
<br>

=== GetNumFinishedMissions ===
'''Definition:'''
GetNumFinishedMissions() -> int missions
<br>
'''Description:'''<br>
get number of finished missions. as displayed in the mission log panel
<br>
'''Returns:'''<br>
''missions''
<br>

=== GetNumGroupMembers ===
'''Definition:'''
GetNumCharacters() -> int chars
<br>
'''Description:'''<br>
get number of characters in your group
<br>
'''Returns:'''<br>
''chars'' number of characters in your group or 0 if player is not in group
<br>

=== GetNumGuildMembers ===
'''Definition:'''
GetNumGuildMembers() -> int numchars
<br>
'''Description:'''<br>
get number of online guildmembers 
<br>
'''Returns:'''<br>
''chars'' number of guildmembers currently online or 0 if player is not in a guild
<br>

=== GetNumNewsHeadlines ===
'''Definition:'''
GetNumNewsHeadlines() -> int num
<br>
'''Description:'''<br>
get number of news headlines.. 
<br>
'''Returns:'''<br>
''num''
<br>

=== GetNumStationDesiredItems ===
'''Definition:'''
GetNumStationDesiredItems() -> int num
<br>
'''Description:'''<br>
Get number of items this station desires. The names of the items can then be fetched with [[API Index#GetStationDesiredItem|GetStationDesiredItem]].
<br>
'''Returns:'''<br>
''num'' The number of items the station wants.
<br>

=== GetNumStationMerch ===
'''Definition:'''
GetNumStationMerch() -> int num
<br>
'''Description:'''<br>
get number of addons, ships an cargo this station sells
<br>
'''Returns:'''<br>
''num'' 
<br>

=== GetNumStationTurrets ===
'''Definition:'''
GetNumStationTurrets() -> int num
<br>
'''Description:'''<br>
get number of turrets on this station or ship
<br>
'''Returns:'''<br>
''num'' number of turrets attached to this station or ship. 0 if not docked
<br>

=== GetNumTips ===
'''Definition:'''
GetNumTips() -> int num
<br>
'''Description:'''<br>
get size of load screen tips pool
<br>
'''Returns:'''<br>
''num'' 
<br>

=== GetParentHealth ===
'''Definition:'''
GetParentHealth() -> float ret1 ret2
<br>
'''Description:'''<br>
get health of object this one is attached to (turret to capship). untested!
<br>
'''Returns:'''<br>
''ret1'' health in percent(?)
''ret2'' health as float (1-0)(?)
<br>

=== GetPlayerDistance ===
'''Definition:'''
GetPlayerDistance(int charid) -> float distance
<br>
'''Description:'''<br>
get distance to another character
<br>
'''Arguments:'''<br>
''charid'' character id of another character in this sector
<br>
'''Returns:'''<br>
''distance'' distance to character in m
<br>

=== GetPlayerFaction ===
'''Definition:'''
GetPlayerFaction(int charid) -> int factionid
<br>
'''Description:'''<br>
get nation of a player
<br>
'''Arguments:'''<br>
''charid'' character id or nil
<br>
'''Returns:'''<br>
''factionid'' number representing the faction (1-13, 99)
<br>

=== GetPlayerFactionStanding ===
'''Definition:'''
GetPlayerFactionStanding(int factionid, charid) -> int standing
<br>
'''Description:'''<br>
get a players standing with a faction
<br>
'''Arguments:'''<br>
''factionid'' a number representing a faction. All faction numbers, 1-13, will work for other players. [[factionid]]<br>
''charid'' [[charid]] of a player (in the current sector?). nil is equivalent of own id.
<br>
'''Returns:'''<br>
''standing'' number representing faction standing 0-65535, (0 in-game being -1000, 32768 in-game being 0 and 65535 being 1000 in-game)
<br>

=== GetPlayerHealth ===
'''Definition:'''
GetPlayerHealth(int charid) -> float health
<br>
'''Description:'''<br>
get health of provided character
<br>
'''Arguments:'''<br>
''charid'' character id
<br>
'''Returns:'''<br>
''health'' health of character in percent or -1 if character is not in the current sector
<br>

=== GetPlayerName ===
'''Definition:'''
GetPlayerName([int charid]) -> string name
<br>
'''Description:'''<br>
get name of character
<br>
'''Arguments:'''<br>
''charid'' character id

if charid is not passed in, the function returns the player name of the user.

<br>
'''Returns:'''<br>
''name''
<br>

=== GetPlayerNodeID ===
'''Definition:'''
GetPlayerNodeID(int charid) -> int nodeid
<br>
'''Description:'''<br>
get [[nodeid]] of a character in the sector
<br>
'''Arguments:'''<br>
''charid'' character id
<br>
'''Returns:'''<br>
''nodeid'' [[nodeid]] or nil if charid is invalid
<br>

=== GetPrimaryShipIDOfPlayer ===
'''Definition:'''
GetPrimaryShipIDOfPlayer(int charid) -> int shipid
<br>
'''Description:'''<br>
get shipid of a character (= objectid?)
<br>
'''Arguments:'''<br>
''charid'' character id
<br>
'''Returns:'''<br>
''shipid''
<br>

=== GetPrimaryShipNameOfPlayer ===
'''Definition:'''
GetPrimaryShipNameOfPlayer(int charid) -> string name
<br>
'''Description:'''<br>
get ship name (type) of provided character
<br>
'''Arguments:'''<br>
''charid'' character id
<br>
'''Returns:'''<br>
''name''
<br>

=== GetProfitColor ===
'''Definition:'''
GetProfitColor(int price, cost) -> string color
<br>
'''Description:'''<br>
get color depending on the given prices
<br>
'''Arguments:'''<br>
''price'' sell price<br>
''cost'' buy price 
<br>
'''Returns:'''<br>
''color'' iup color string
<br>

=== GetProfitHexColor ===
'''Definition:'''
GetProfitHexColor(int price, cost) -> string color
<br>
'''Description:'''<br>
get color in hex format depending on the given prices
<br>
'''Arguments:'''<br>
''price'' sell price<br>
''cost'' buy price
<br>
'''Returns:'''<br>
''color'' hex color string. format: "rrggbb"
<br>

=== GetProximityWarningDistance ===
'''Definition:'''
GetProximityWarningDistance() -> int dist
<br>
'''Description:'''<br>
get proxy warnign distance<br>
Note: even returns the distance when proxy warning is disabled
<br>
'''Returns:'''<br>
''dist'' proxy distance.
<br>

=== GetProximityWarningTimeout ===
'''Definition:'''<br>
GetProximityWarningTimeout() -> int timeout
<br>
'''Description:''' <br>
Get minimum time between proximity warnings
<br>
'''Returns:'''<br>
''timeout'' minimum time between proximity warnings in msecs
<br>

=== GetSectorAlignment ===
'''Definition:'''
GetSectorAlignment() -> int alignment
<br>
'''Description:'''<br>
returns the alignment of the current sector<br>
<br>
'''Returns:'''<br>
''alignment'' int representing alignment of the current sector. see: [[FactionName]]
<br>

=== GetSectorMonitoredStatus ===
'''Definition:'''
GetSectorMonitoredStatus() -> int monitor
<br>
'''Description:'''<br>
returns the monitor status of the current sector (Unmonitored, Guarded ...) see: [[FactionMonitor]] and [[FactionMonitorStr]] <br>
<br>
'''Returns:'''<br>
''monitor'' monitor status 
<br>

=== GetShipAmmoPrices ===
'''Definition:'''
GetShipAmmoPrices(int ship) -> table prices
<br>
'''Description:'''<br>
get cost of ship ammo
<br>
'''Arguments:'''<br>
''ship'' [[itemid]] of a ship
<br>
'''Returns:'''<br>
''prices'' weapon itemid ammo price pairs<br>
''prices.allammoprice'' cost of reloading all weapons<br>
''prices.allammoquantity'' amoutn of ammo to reload
<br>

=== GetShipCargoCount ===
'''Definition:'''
GetShipCargoCount(int itemid) -> int num
<br>
'''Description:'''<br>
get amount of cargo in the ship
<br>
'''Arguments:'''<br>
''itemid'' item id of a ship
<br>
'''Returns:'''<br>
''num'' amount of argo in ship in cu
<br>

=== GetShipInventory ===
'''Definition:'''
GetShipInventory(int itemid) -> {cargo = {int cargoitemid ..}, addons = {int addonitemid ..}}
<br>
'''Description:'''<br>
get itemids of items attached to a ship
<br>
'''Arguments:'''<br>
''itemid'' item id of a ship
<br>
'''Returns:'''<br>
''cargo'' array with cargo items<br>
''addons'' array with addons<br>
''cargoitemid'' itemids of cargo items<br>
''addonitemid'' itemids of addons
<br>

=== GetShipList ===
'''Definition:'''
GetShipList() -> {int itemid ..}
<br>
'''Description:'''<br>
get list of your ships in the current station. produces error when called outside station..
<br>
'''Returns:'''<br>
''itemid'' itemid of a ship
<br>

=== GetShipMaxCargo ===
'''Definition:'''
GetShipMaxCargo(int itemid) -> int cargo
<br>
'''Description:'''<br>
get amount of cargo the given ship can hold
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of a ship
<br>
'''Returns:'''<br>
''cargo'' cargo in cu
<br>

=== GetShipMeshInfo ===
'''Definition:'''
GetShipMeshInfo(int itemid) -> string id model int color
<br>
'''Description:'''<br>
get mesh information about equipment in your inventory. if an invalid itemid is given the info about the current ship is returned
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of one of your ships or nil
<br>
'''Returns:'''<br>
''id'' of the ship<br>
''model'' filename of the model(?)<br>
''color'' [[colorid]] of the item see [[API Index#ShipPalette|ShipPalette]]
<br>

=== GetShipPortIDOfItem ===
'''Definition:'''
GetShipPortIDOfItem(int itemid1, int itemid2) -> int portid
<br>
'''Description:'''<br>
get port of weapon in one of your ships
<br>
'''Arguments:'''<br>
''itemid1'' itemid of one of your ships<br>
''itemid2'' itemid of a weapon or nil
<br>
'''Returns:'''<br>
''portid'' port of a wweapon or first free port if itemid2 is nil
<br>

=== GetShipPurchaseColor ===
'''Definition:'''
GetShipPurchaseColor() -> int color
<br>
'''Description:'''<br>
get selected color from the color picker
<br>
'''Returns:'''<br>
''colorid'' number representing color (0-255)
<br>

=== GetSkillLevel ===
'''Definition:'''
GetSkillLevel(int licenseid) -> int current next
<br>
'''Description:'''<br>
get current and required xp for next level or provided skill
<br>
'''Arguments:'''<br>
''licenseid'' type of license (1-5)
<br>
'''Returns:'''<br>
''current'' current xp
''next'' xp required for next level
<br>

=== GetSkirmishInfo ===
'''Definition:'''<br>
GetSkirmishInfo() -> int crew1 crew2 init1 init2 string name1 name2 bool active
<br>
'''Description:'''<br>
returns crew info for skirmish missions
<br>
'''Returns:'''<br>
''crew1'' crew members left for side 1 (top bar)<br>
''crew2'' crew members left for side 2 (bottom bar)<br>
''init1'' initial crew strength for side 1<br>
''init2'' initial crew strength for side 2<br>
''name1'' name of side 1<br>
''name2'' name of side 2<br>
''active'' true if mission active(?)
<br>

=== GetStartingSectors ===
'''Definition:'''<br>
GetStartingSectors(int factionid) -> table sectors
<br>
'''Description:'''<br>
get list of starting sectors for the given faction
<br>
'''Arguments:'''<br>
''factionid'' [[factionid]]
<br>
'''Returns:'''<br>
''sectors'' table with [[sectorid]]s of the starting sectors or 0 if the faction has none
<br>

=== GetStationAddonList ===
'''Definition:'''
GetStationAddonList() -> {int itemid ..}
<br>
'''Description:'''<br>
get array with your addons in the station hold
<br>
'''Returns:'''<br>
''itemid'' [[itemid]] of one of your addons 
<br>

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

=== GetStationCargoList ===
'''Definition:'''
GetStationCargoList() -> {int itemid ..}
<br>
'''Description:'''<br>
get list of cargo items in the current station. produces error when called outside station..
<br>
'''Returns:'''<br>
''itemid'' itemid of a trade item
<br>

=== GetStationChatLog ===
'''Definition:'''
GetStationChatLog() -> {string msg ..}
<br>
'''Description:'''<br>
get table with messages in the station chat
<br>
'''Returns:'''<br>
''msg'' chat message
<br>

=== GetStationCurrentCargo ===
'''Definition:'''
GetStationCurrentCargo() -> int cargo
<br>
'''Description:'''<br>
get amount of cargo currently in this station. including cargo, equipment, ships ..
<br>
'''Returns:'''<br>
''cargo'' amount of cargo in cu
<br>

=== GetStationDesiredItem ===
'''Definition:'''
GetStationDesiredItem(int index) -> string ditem
<br>
'''Description:'''<br>
Get the string name of an item that this station desires. The index ranges from 1 to [[API Index#GetNumStationDesiredItems|GetNumStationDesiredItems()]].
<br>
'''Arguments:'''<br>
''index'' index in list of strings
<br>
'''Returns:'''<br>
''ditems'' desired item
<br>

=== GetStationFaction ===
'''Definition:'''
GetStationFaction(int stationid) -> int factionid
<br>
'''Description:'''<br>
get faction of the given station
<br>
'''Arguments:'''<br>
''stationid'' [[stationid]]
<br>
'''Returns:'''<br>
''factionid'' [[factionid]] or 0 if stationid invalid
<br>

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

=== GetStationLocation ===
'''Definition:'''
GetStationLocation() -> int stationid
<br>
'''Description:'''<br>
get the [[stationid]] of the current station 
<br>
'''Returns:'''<br>
''stationid'' [[stationid]] or nil if not docked to a station 
<br>

=== GetStationLogReadState ===
'''Definition:'''
GetStationLogReadState() -> bool read
<br>
'''Description:'''<br>
Tell if the stationlog/bar was displayed. [[API_Index#SetStationLogRead|SetStationLogRead]] was called since the last line was added to the log.
<br>
'''Returns:'''<br>
''read'' true if the log was displayed
<br>

=== GetStationMaxCargo ===
'''Definition:'''
GetStationMaxCargo() -> int cargo
<br>
'''Description:'''<br>
return amount of cargo this station can hold.
<br>
'''Returns:'''<br>
''cargo'' amount of cargo in cu
''purchaseable max'' 
''purchaseincrement''
''purchase price''
''mincargo''
''rent''
<br>

=== GetStationMerchInfo ===
'''Definition:'''
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 }
<br>
'''Description:'''<br>
get info about items this station sells
<br>
'''Arguments:'''<br>
''merchid'' id of sold items (1-n), where n = GetNumStationMerch()
<br>

=== GetStationMerchInfoByID ===
'''Definition:'''
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 }
<br>
'''Description:'''<br>
get info about items this station sells by itemid
<br>
'''Arguments:'''<br>
''itemid'' itemid of sold items 
<br>

=== GetStationMerchPriceByID ===
'''Definition:'''
GetStationMerchInfoByID(int itemid) -> int price
<br>
'''Description:'''<br>
get price of an item this station sells
<br>
'''Arguments:'''<br>
''itemid'' itemid of sold items
<br>
'''Returns:'''<br>
''price'' price of an item or 0 if this item isn't sold
<br>

=== GetStationName ===
'''Definition:'''
GetStationName(int stationid) -> string name
<br>
'''Description:'''<br>
Get the name of a station. If the provided stationid is invalid the function produces a lua error.
<br>
'''Arguments:'''<br>
* ''stationid'' [[stationid]] or nil for the current station
<br>
'''Returns:'''<br>
* ''name'' Long name of the current station if no argument is given, otherwise the sector name and coordinates of a station.
<br>

=== GetStationSellableInventoryInfoByID ===
'''Definition:'''
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 }
<br>
'''Description:'''<br>
get sellable inventory info by id ...
<br>

=== GetStationSellableInventoryPriceByID ===
'''Definition:'''
GetStationSellableInventoryPriceByID(int itemid, int quantity) -> int value, unitprice
<br>
'''Description:'''<br>
Get value of inventory items and price per unit in the current station
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of an inventory item in the current station<br>
''quantity'' number of units of this item (optional)
<br>
'''Returns:'''<br>
''value'' value of item(s)<br>
''unitprice'' price per unit 
<br>

=== GetStationShipList ===
'''Definition:'''
GetStationShipList(int itemid) -> {int itemid1 ..}
<br>
'''Description:'''<br>
get array of your ships in the current station
<br>
'''Returns:'''<br>
''itemid?'' itemid of ship in the current station 
<br>

=== GetStationTurretInfo ===
'''Definition:'''
GetStationTurretInfo(int turretid) -> {int objectid, int nodeid, float armorpercent, int itemid}
<br>
'''Description:'''<br>
get information about a stations or ships turrets
<br>
'''Arguments:'''<br>
''turretid''' id of a turret
<br>
'''Returns:'''<br>
''objectid''<br>
''nodeid''<br>
''armorpercent'' armor level<br>
''itemid''
<br>

=== GetStationType ===
'''Definition:'''
GetStationType() -> string stype
<br>
'''Description:'''<br>
get station type
<br>
'''Returns:'''<br>
''stype'' station type. returns "frigate" when docked to a cruiser otherwise nil
<br>

=== GetStorageItemInfo ===
'''Definition:'''
GetStorageItemInfo() -> ??
<br>
'''Description:'''<br>
no clue. can't make it return anything
<br>

=== GetStorageLocationSector ===
'''Definition:'''
GetStorageLocationSector(int arg1) -> int ret1
<br>
'''Description:'''<br>
returns some number when fed with an itemid
<br>

=== GetSurveyChoices ===
'''Definition:'''
GetSurveyChoices() -> {}
<br>
'''Description:'''<br>
returns an empty table!
<br>

=== GetSurveyQuestion ===
'''Definition:'''
GetSurveyQuestion() -> string ret1
<br>
'''Description:'''<br>
returns an empty string!
<br>
'''Returns:'''<br>
''ret1'' an empty string!
<br>

=== GetSystemID ===
'''Definition:'''
GetSystemID(int sectorid) -> int systemid
<br>
'''Description:'''<br>
get systemid of the given sector. lua error on nil
<br>
'''Arguments:'''<br>
''sectorid'' [[sectorid]]
<br>
'''Returns:'''<br>
''systemid'' [[systemid]]
<br>

=== GetTargetDistance ===
'''Definition:'''
GetTargetDistance() -> float dist
<br>
'''Description:'''<br>
get distance to target
<br>
'''Returns:'''<br>
''dist'' distance to target in m
<br>

=== GetTargetFriendlyStatus ===
'''Definition:'''
GetTargetFriendlyStatus() -> int fstatus
<br>
'''Description:'''<br>
get friendlyness of target
<br>
'''Returns:'''<br>
''fstatus'' Returns 0 to 3. Target is friendly if 3, unfriendly otherwise
<br>

=== GetTargetInfo ===
'''Definition:'''
GetTargetInfo() -> string name float health dist int factionid string guild ship
<br>
'''Description:'''<br>
get info about target
<br>
'''Returns:'''<br>
''name''<br>
''health'' health in percent<br>
''dist'' distance in m<br>
''factionid'' faction of target<br>
''guild'' guild tag of target<br>
''ship'' name of targets ship
<br>

=== GetTip ===
'''Definition:'''
GetTip(int tipid) -> string tip
<br>
'''Description:'''<br>
get loading screen with given index
<br>
'''Arguments:'''<br>
''tipid'' tip id (1-n)
<br>
'''Returns:'''<br>
''tip'' loading screen tip
<br>

=== GetTurretNamesByStationType ===
'''Definition:'''
GetTurretNamesByStationType(string stype) -> {string tur1 ..}
<br>
'''Description:'''<br>
get turret name of provided station type
<br>
'''Arguments:'''<br>
''stype'' station type
<br>
'''Returns:'''<br>
''tur1'' turret name (2-n)(?)
<br>

=== GetTutorialLevel ===
'''Definition:'''
GetTutorialLevel() -> int num
<br>
'''Description:'''<br>
return if the player has done the tutorial(?)
<br>
'''Returns:'''<br>
''num'' 0 if tutorial wasn'T done -1 if it was, I think ...
<br>

=== GetUserName ===
'''Definition:'''
GetUserName() -> string Name
<br>
'''Description:'''<br>
Returns the username.
<br>
'''Returns:'''<br>
'''Name''' <test:username> or <dev:username> if you are on the test or dev server, otherwise <username>.
<br>

=== GiveMoney ===
'''Definition:'''
GiveMoney(string char, int amount) -> nil
<br>
'''Description:'''<br>
transfer money to a character
<br>
'''Arguments:'''<br>
''char'' name of a character within the sector<br>
''amount'' amount of money to transfer
<br>


=== HasActiveShip ===
'''Definition:'''
HasActiveShip() -> bool aship
<br>
'''Description:'''<br>
return true if the player has an active ship
<br>
'''Returns:'''<br>
''aship'' true if the player has an activer ship otherwise false
<br>

=== HasLastShipLoadout ===
'''Definition:'''
HasLastShipLoadout() -> bool loadout
<br>
'''Description:'''<br>
return true if the player has a last ship loadout saved. (see ClearLastShipLoadout)
<br>
'''Returns:'''<br>
''loadout'' true if the player has a last shiploadout saved otherwise false
<br>

=== HelpCharAccom ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpCharFaction ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpCharGuild ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpCharInventory ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpCharStats ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpCommoditiesAction ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpGridPower ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpIgnore ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpLargeAddonsAction ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpOtherAddonsAction ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAAdvancementLog ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAJettison ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAKilledByList ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAKilledList ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAMissionLog ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAMissionNotes ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDANearbyShips ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAPVPList ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpPDAStationVisitsList ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpSellAction ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpSellAddons ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpSellCommodities ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpShipAmmo ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpShipCargo ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpShipEquip ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpShipGroup ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpShipPurchase ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpShipSelect ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpShipStatus ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpSmallAddonsAction ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpStationAddonEquip ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpStationAddonGroups ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpStationBuddies ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpStationMission ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpStationNav ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpStationNews ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpStationWelcome ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpSystemNotes ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HelpVoiceChat ===
'''Description:'''<br>
[[helpfunc]]
<br>

=== HideAllDialogs ===
'''Definition:'''
HideAllDialogs() -> nil
<br>
'''Description:'''<br>
Hide all dialogs that were shown with [[API_Index#ShowDialog|ShowDialog]] or [[API_Index#PopupDialog|PopupDialog]]
<br>

=== HideDialog ===
'''Definition:'''
HideDialog(userdata dialog) -> nil
<br>
'''Description:'''<br>
Hide a dialog that was shown with [[API_Index#ShowDialog|ShowDialog]] or [[API_Index#PopupDialog|PopupDialog]]
<br>
'''Arguments:'''<br>
''dialog'' a currently shown dialog
<br>

=== HideTooltip ===
'''Definition:'''
HideTooltip() -> nil
<br>
'''Description:'''<br>
Hide [[API_Index#ToolTip|ToolTip]], the tooltip dialog
<br>

=== IsConnected ===
'''Definition:'''
IsConnected() -> bool connected
<br>
'''Description:'''<br>
return true if the player is connected to the game
<br>
'''Returns:'''<br>
''connected'' true if the player is connected otherwise false
<br>

=== IsEnemy ===
'''Definition:'''
IsEnemy(charid) -> bool enemy
<br>
'''Description:'''<br>
Part of the base radar functionality. Used in conjunction with GetFriendlyStatus. 
<br>
'''Returns:'''<br>
''enemy'' returns true if someone is an enemy, otherwise false. Totally unreliable.
<br>

=== IsGroupMember ===
'''Definition:'''
IsGroupMember(int charid) -> bool grmember
<br>
'''Description:'''<br>
tell if the provided character is a group member
<br>
'''Arguments:'''<br>
''charid'' character id
<br>
'''Returns:'''<br>
''grmember'' true if character is a groupmember false if not or you aren't member of a group
<br>

=== IsGuildMember ===
'''Definition:'''
IsGuildMember(int charid) -> bool guildmember
<br>
'''Description:'''<br>
tell if the provided character is a guild member
<br>
'''Arguments:'''<br>
''charid'' character id
<br>
'''Returns:'''<br>
''gumember'' true if character is a guildmember false if not or you aren't member of a guild
<br>

=== IsInDuel ===
'''Definition:'''
IsInDuel() -> bool duel
<br>
'''Description:'''<br>
Returns true if the player is in a duel
<br>
'''Returns:'''<br>
''duel'' true if dueling
<br>

=== IsNPCProximityWarningEnabled ===
'''Definition:'''<br>
IsNPCProximityWarningEnabled() -> bool state
<br>
'''Description:'''<br>
Get NPC proximity warning state
<br>
'''Returns:'''<br>
''state'' proximity warning state. true if enabled.
<br>

=== IsOneOffProximityWarningEnabled ===
'''Definition:'''<br>
IsOneOffProximityWarningEnabled() -> bool state
<br>
'''Description:'''<br>
Get one off proximity warning state
<br>
'''Returns:'''<br>
''state'' proximity warning state. true if enabled
<br>

=== IsPlayerProximityWarningEnabled ===
'''Definition:'''<br>
IsPlayerProximityWarningEnabled() -> bool state
<br>
'''Description:'''<br>
Get Player proximity warning state
<br>
'''Returns:'''<br>
''state'' proximity warning state. true if enabled.
<br>

=== IsPlayerRequestingBuddy ===
'''Definition:'''
IsPlayerRequestingBuddy(string name) -> bool req
<br>
'''Description:'''<br>
Tell if the given player is requesting to become a buddy
<br>
'''Arguments:'''<br>
''name'' player name
<br>
'''Returns:'''<br>
''req'' true if player is requesting to become a buddy
<br>

=== IsPlayerRequestingDuel ===
'''Definition:'''
IsPlayerRequestingDuel(string name) -> bool req
<br>
'''Description:'''<br>
Tell if the given player is requesting a duel
<br>
'''Arguments:'''<br>
''name'' player name
<br>
'''Returns:'''<br>
''req'' true if player is requesting a duel
<br>

=== IsPlayerRequestingGroupInvite ===
'''Definition:'''
IsPlayerRequestingGroupInvite(string name) -> bool req
<br>
'''Description:'''<br>
Tell if the given player has sent a group invite
<br>
'''Arguments:'''<br>
''name'' player name
<br>
'''Returns:'''<br>
''req'' true if invited by player
<br>

=== IsProximityWarningEnabled ===
'''Definition:'''
IsProximityWarningEnabled() -> bool isproxy
<br>
'''Description:'''<br>
tell if proximity warning is enabled
<br>
'''Returns:'''<br>
''isproxy'' true if proximity warning is enabled otherwise false
<br>

=== IsStormPresent ===
'''Definition:'''
IsStormPresent() -> bool isstorm
<br>
'''Description:'''<br>
tell if there's a storm in the current sector
<br>
'''Returns:'''<br>
''isstorm'' true if storm is present otherwise false
<br>

=== IsTrainingSector ===
'''Definition:'''
IsTrainingSector(int sectorid) -> bool tsector
<br>
'''Description:'''<br>
tell if the given sector is a training sector.
<br>
'''Arguments:'''<br>
''sectorid'' [sectorid]. if nil the current sector id is used
<br>
'''Returns:'''<br>
''tsector'' true if the given sector is a training sector
<br>

=== IsTransactionInProgress ===
'''Definition:'''
IsTransactionInProgress() -> bool trans
<br>
'''Description:'''<br>
tell if a transaction is in progress (like selling a ship, items ..)
<br>
'''Returns:'''<br>
''trans'' true if transaction in progress
<br>

=== IsVoiceChatEnabled ===
'''Definition:'''
IsVoiceChatEnabled() -> bool vc
<br>
'''Description:'''<br>
tell if voice chat is enabled
<br>
'''Returns:'''<br>
''vc'' true if voice chat is enabled
<br>

=== JettisonAll ===
'''Definition:'''
JettisonAll() -> nil
<br>
'''Description:'''<br>
Jettison all of your ships cargo
<br>

=== JettisonMultiple ===
'''Definition:'''
JettisonMultiple{item1 = {int id, int quantity} ..} -> nil
<br>
'''Description:'''<br>
Jettison cargo items and quantitiss according to the provided table 
<br>
'''Arguments:'''<br>
''item1'' table containing quantity and itemid of cargo to jettison
''id'' itemid of cargo item
''quantity'' amount of this cargo to jettison
<br>

=== JettisonSingle ===
'''Definition:'''
JettisonSingle(int itemid, int quantity) -> nil
<br>
'''Description:'''<br>
Jettison provided type and amount of cargo 
<br>
'''Arguments:'''<br>
''itemid'' itemid of cargo item
''quantity'' amount of cargo to jettison
<br>

=== JoinChannel ===
'''Definition:'''
JoinChannel{channelid1 ..} -> nil
<br>
'''Description:'''<br>
join the provided channels without leaving existing channels
<br>
'''Arguments:'''<br>
''channelid1'' channel number (1 - 2^32) the last index is the active channel
<br>

=== LeaveChannel ===
'''Definition:'''
LeaveChannel{channelid1 ..} -> nil
<br>
'''Description:'''<br>
leave the provided channels
<br>
'''Arguments:'''<br>
''channelid1'' channel number (1 - 2^32)
<br>

=== ListChannels ===
'''Definition:'''
ListChannels() -> nil
<br>
'''Description:'''<br>
print list of currently joined channels and usage info to the chatarea
<br>

=== LoadCargo ===
'''Definition:'''
LoadCargo({{int itemid, int quantity} ..}, function cb) -> nil
<br>
'''Description:'''<br>
Load cargo items and quantitiss according to the provided table 
<br>
'''Arguments:'''<br>
''itemid'' itemid of cargo item<br>
''quantity'' amount of this cargo to load<br>
''cb'' optional function to call on success
<br>

=== LoadChannels ===
'''Definition:'''
LoadChannels() -> nil
<br>
'''Description:'''<br>
restore chat channels from config file(?)
<br>

=== LoadMissionNotes ===
'''Definition:'''
LoadMissionNotes() -> string notes
<br>
'''Description:'''<br>
read and return players notes from playernotes.txt. See also: [[Function_Index#SaveMissionNotes]] 
<br>
'''Returns:'''<br>
''notes'' mission notes text
<br>

=== LoadNavpath ===
'''Definition:'''
LoadNavpath(string navpath) -> {int sectorid1 ..}
<br>
'''Description:'''<br>
load navroute by name and return array with hops
<br>
'''Returns:'''<br>
''sectorid1'' [[sectorid]] of a hop on this navroute first index is first hop (1-n)
<br>

=== LoadShipPresets ===
'''Definition:'''
LoadShipPresets() -> nil
<br>
'''Description:'''<br>
read ship presets from config file and setup buyback dialog
<br>

=== LoadSystemNotes ===
'''Definition:'''
LoadSystemNotes(int systemid) -> string notes
<br>
'''Description:'''<br>
load system notes from settings/<charactername>/system<systemid>notes.txt
<br>
'''Arguments:'''<br>
''sectorid'' [[systemid]]
<br>
'''Returns:'''<br>
''notes'' string with system notes
<br>

=== LocationStr ===
'''Definition:'''
LocationStr(int sectorid) -> string sname
<br>
'''Description:'''<br>
translate a sectorid into a sector name. error if no argument provided
<br>
'''Arguments:'''<br>
''sectorid'' [[sectorid]]
<br>
'''Returns:'''<br>
''sname'' sector name
<br>

=== Login ===
'''Definition:'''
Login(string username, string password) -> nil
<br>
'''Description:'''<br>
Login to the game. crashes game when arguments are missing...
<br>
'''Arguments:'''<br>
''username'' vendetta account name<br>
''password'' password 
<br>

=== Logout ===
'''Definition:'''
Logout() -> nil
<br>
'''Description:'''<br>
Inititate logout sequence.
<br>

=== MakeBotName ===
'''Definition:'''
MakeBotName(string nameset, int seed) -> string name
<br>
'''Description:'''<br>
Generate a name fromthe given nameset and optional random seed
<br>
'''Arguments:'''<br>
''nameset'' [[nameset]] from which to generate a name<br>
''seed'' optional random seed<br>
<br>
'''Returns:'''<br>
''name'' a random name based on the nameset
<br>

=== MakeBuyBackQuestionDlg ===
'''Definition:'''
MakeBuyBackQuestionDlg() -> userdata dialog
<br>
'''Description:'''<br>
Create the buyback dialog
<br>
'''Returns:'''<br>
''dialog'' buyback dialog
<br>

=== NPlural ===
'''Definition:'''
NPlural(string arg1, string arg2) -> string pstring
<br>
'''Description:'''<br>
concaterates the two provided strings together and pluralizes the result
<br>
'''Arguments:'''<br>
''arg1'' first substring<br>
''arg2'' second substring<br>
<br>
'''Returns:'''<br>
''pstring'' concaterated and pluralized string
<br>

=== OnIdle ===
'''Definition:'''
OnIdle(float delta) -> nil
<br>
'''Description:'''<br>
Idle handler
<br>
'''Arguments:'''<br>
''delta'' seconds since last call(?)
<br>

=== OpenAlarm ===
'''Definition:'''
OpenAlarm(string title, text, buttontext) -> nil
<br>
'''Description:'''<br>
Show [[API_index#ConfirmationDialog|ConfirmationDialog]] with the given message
<br>
'''Arguments:'''<br>
''title'' title text<br>
''text'' body text<br>
''buttontext'' text on button
<br>

=== OverlapPrevention ===
'''Definition:'''
OverlapPrevention(table ip) -> bool overlap
<br>
'''Description:'''<br>
Adjust icon positions in a viewport so that they don't overlap
<br>
'''Arguments:'''<br>
''ip'' table with viewport dimensions and icon positions<br>
''ip.icon_positions'' table with [[icon_postions]]<br>
''ip.width'' width of viewport<br>
''ip.height'' height of viewport
<br>
'''Returns:'''<br>
''overlap'' true if icons overlapped
<br>

=== ParseXML ===
'''Definition:'''
ParseXML(string xmlstring) -> {dom}
<br>
'''Description:'''<br>
returns the provided string as a collection of substrings and nodes as subtables ..see example
<br>
'''Arguments:'''<br>
''xmlstring'' string containing xml tags
<br>
'''Returns:'''<br>
''dom'' table with xml nodes and substrings
<br>

=== PlayerInStation ===
'''Definition:'''
PlayerInStation() -> bool instation
<br>
'''Description:'''<br>
tell if the player is in a station or capship
<br>
'''Returns:'''<br>
''instation'' true if the player is in a station otherwise false
<br>

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

=== PopupDialog ===
'''Definition:'''
PopupDialog(userdata dialog, int x, y) -> nil
<br>
'''Description:'''<br>
Wrapper around [[iup#Popup|iup.Popup]] that allows the dialog to be closed with [[API_Index#HideDialog|HideDialog]] or [[API_Index#HideAllDialogs|HideAllDialogs]]
<br>
'''Arguments:'''<br>
''dialog'' dialog to show<br>
''x'' horizontal position<br>
''y'' vertical position
<br>

=== PrintJoinUsage ===
'''Definition:'''
PrintJoinUsage() -> nil
<br>
'''Description:'''<br>
prints how to use /join to the chatarea
<br>

=== PrintLeaveUsage ===
'''Definition:'''
PrintLeaveUsage() -> nil
<br>
'''Description:'''<br>
prints how to use /leave to the chatarea
<br>

=== PrintPurchaseTransaction ===
'''Definition:'''
PrintPurchaseTransaction(string name, int quantity, totalvalue, totalcost) -> nil
<br>
'''Description:'''<br>
Print a sale summery message to the chat log
<br>
'''Arguments:'''<br>
''name'' sold item<br>
''quantity'' number items sold<br>
''totalvalue'' value of items<br>
''totalcost'' price of items<br>
<br>

=== PrintTransactionTable ===
'''Definition:'''
PrintTransactionTable() -> nil
<br>
'''Description:'''<br>
print pending transactions.
<br>
'''Returns:'''<br>
{[x]={trackback="...(tail call): ?", wantcount=0, count=0}}
for current transactions, otherwise returns nil.
<br>

=== ProcessEvent ===
'''Definition:'''
ProcessEvent(string eventtype, ...) -> nil
<br>
'''Description:'''<br>
Processes various events. Trigger a with [[API_RegisterEvent|RegisterEvent]] defined event.
<br>
'''Arguments:'''<br>
''eventtype'' [[eventtype]]<br>
''...'' variable number of arguments depending on event.
<br>

=== PurchaseMerchandiseItem ===
'''Definition:'''
PurchaseMerchandiseItem(int itemid, int amount, func callback) -> nil
<br>
'''Description:'''<br>
buy the provided item
<br>
'''Arguments:'''<br>
''itemid'' itemid of cargo merch item<br>
''amount'' number of items to purchase<br>
''callback'' function that gets called when transaction is finished, callback is called with no arguments in case of success or with numeric errorcode in case of failure
<br>

=== PurchaseShipLoadout ===
'''Definition:'''
PurchaseShipLoadout(function buybackdone_cb(boolean success), loadout) -> nil
<br>
'''Description:'''<br>
Buys ship presets as stored in [[ShipPresets]] table. Also sets weapon groups.<br>
<br>
'''Arguments:'''<br>
''buybackdone_cb(boolean success)'' callback function that gets called when transation finished, takes one argument which is true in case of success false otherwise.<br>
''loadout'' loadout as stored in [[ShipPresets]] table.<br>
<br>

=== RegisterEvent ===
'''Definition:'''
RegisterEvent(object eventhandler, string eventtype) -> nil
<br>
'''Description:'''<br>
Hook up object to event. The object is a function or a table with a method called OnEvent or the name of the event. See [[Eventtype#Introduction|Event Intro]]
<br>
'''Arguments:'''<br>
''eventhandler'' object or function to register with event<br>
''eventtype'' [[eventtype]]
<br>

=== RegisterUserCommand ===
'''Definition:'''
RegisterUserCommand(string commandname, func callback(dataarg, {arguments1, ..}), data) -> nil
<br>
'''Description:'''<br>
hook up object to command
<br>
'''Arguments:'''<br>
''commandname'' string containing the command<br>
''callback'' function accepting two arguments to run when command is executed<br>
''dataarg'' see ''data''<br>
''arguments1'' arguments of the command (Note: if there are no arguments the table is nil not an empty table.)<br>
''data'' data to pass callback
<br>

=== ReinitIconPositions ===
'''Definition:'''
ReinitIconPositions(timer icontimer, int ship, userdata viewport, table iconlist, userdata iconcontainer, table ipcache) -> nil
<br>
'''Description:'''<br>
Setup icons in a viewport
<br>
'''Arguments:'''<br>
''icontimer'' timer for overlap prevention animation<br>
''ship'' [[itemid]] of ship to use<br>
''viewport'' target viewport<br>
''iconlist'' table to [[portdata]] to [[portid]]s<br>
''iconcontainer'' target box<br>
''ipcache'' table that maps [[icon_positions]] to ship types that acts as a cache<br> 
<br>

=== ReloadInterface ===
'''Definition:'''
ReloadInterface() -> nil
<br>
'''Description:'''<br>
Reloads everything related to the interface that isn't a texture. This means VO lua scripts as well as scripts in the /plugins directory.
<br>

=== RentStorage ===
'''Definition:'''
RentStorage(int storage) -> nil
<br>
'''Description:'''<br>
Rent storage space at the current station.
<br>
'''Arguments:'''<br>
''storage'' amount of space to rent. value is rounded up to a multiple of 10K
<br>

=== RepairShip ===
==== Definition ====
RepairShip(int itemid, int x, func cb) -> nil

==== Description ====
Repairs the ship itemid in the station. Tested with active ship id. The cb is a callback function which is called after the ship is repaired.

x is unknown, but a value of 1 seems to work.

See also [[API_ReplenishWeapon]] and [[API_ReplenishAll]].

==== Arguments ====
* ''itemid'' [[itemid]] of ship
* ''x'' unknown, number 1 seems to work
* ''cb'' function to be called once the transaction is complete


[[Category:Functions]]

=== ReplenishAll ===
'''Definition:'''
ReplenishAll(int itemid, func cb) -> nil
<br>
'''Description:'''<br>
replenish all weapons on provided ship
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of ship<br>
''cb'' function to be called once the transaction is complete
<br>

=== ReplenishWeapon ===
==== Definition ====
ReplenishWeapon(int itemid, int x, func cb) -> nil

==== Description ====
Repairs the ship if [[itemid]] is a ship. Not tested on weapon IDs yet.
The meaning of x is unknown. 1 seems to work as a value.

See also [[API_ReplenishAll]] and [[API_RepairShip]].

==== Arguments ====
* ''itemid'' [[itemid]] of ship or possibly weapon
* ''x'' unknown, number 1 seems to work
* ''cb'' function to be called once the transaction is complete


[[Category:Functions]]

=== RequestCharacterStats ===
'''Definition:'''
RequestCharacterStats() -> nil
<br>
'''Description:'''<br>
no clue
<br>

=== RequestLaunch ===
'''Definition:'''
RequestLaunch() -> bool ret
<br>
'''Description:'''<br>
Launches from the station. Any issues preventing launch are reported via pop-up window. Otherwise, the player's ship undocks. 
<br>
'''Returns:'''<br>
''ret'' always true (?)
<br>

=== RequestMissionDetails ===
'''Definition:'''
RequestMissionDetails(int missionid) -> nil
<br>
'''Description:'''<br>
Request information about the given mission (aka the info button) and pop up [[API_Index#MissionPromptDialog]] if id is valid
<br>
'''Arguments:'''<br>
''missionid'' mission id (1-n)
<br>

=== RequestMissionList ===
'''Definition:'''
RequestMissionList() -> nil
<br>
'''Description:'''<br>
no clue. maybe used by /updatestation
<br>

=== RequestNewsArticle ===
'''Definition:'''
RequestNewsArticle(int newsindex) -> nil
<br>
'''Description:'''<br>
ask server for news item(?)<br>
fills [[API_Index#NewsDialog]] with given news item
<br>
'''Arguments:'''<br>
''newsindex'' index of news item, newest first
<br>

=== RequestNewsHeadlines ===
'''Definition:'''
RequestNewsHeadlines() -> nil
<br>
'''Description:'''<br>
ask server for news item list?
<br>

=== RequestTargetStats ===
'''Definition:'''
RequestTargetStats() -> int charid
<br>
'''Description:'''<br>
get character id of target (considreing the name maybe more?)
<br>
'''Returns:'''<br>
''charid'' character id of torgat or yours if no target selected
<br>

=== ResetTutorial ===
'''Definition:'''
ResetTutorial() -> nil
<br>
'''Description:'''<br>
Reset the tutorial flag. the player will have to go through it again after docking.
<br>

=== RunTutorial ===
'''Definition:'''
RunTutorial() -> nil
<br>
'''Description:'''<br>
launch tutorial
<br>

=== SHA1 ===
'''Definition:'''
SHA1(string text) -> string hash
<br>
'''Description:'''<br>
generate SHA1 hash of the given string
<br>
'''Arguments:'''<br>
''text'' text to hash
<br>
'''Returns:'''<br>
''hash'' hash of text
<br>

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

=== SaveMissionNotes ===
'''Definition:'''
SaveMissionNotes(string notes) -> nil
<br>
'''Description:'''<br>
Save the provided string to the characters mission notes file. See also: [[API Index#LoadMissionNotes]]
<br>
'''Arguments:'''<br>
''notes'' text to be saved in the notes file
<br>

=== SaveNavpath ===
'''Definition:'''
SaveNavpath({int sectorid1 ..}, string name) -> nil
<br>
'''Description:'''<br>
Save the provided navroute
<br>
'''Arguments:'''<br>
''sectorid1'' [[sectorid]] of each hop<br>
''name'' name of this route
<br>

=== SaveShipLoadout ===
'''Definition:'''
SaveShipLoadout() -> ??
<br>
'''Description:'''<br>
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
<br>

=== SaveShipPresets ===
'''Definition:'''
SaveShipPresets(int index) -> nil
<br>
'''Description:'''<br>
Save ship preset(s) and recreate buyback dialog
<br>
'''Arguments:'''<br>
''index'' ship preset to save if omitted all presets are save
<br>

=== SaveSystemNotes ===
'''Definition:'''
SaveSystemNotes(string notes, int systemid) -> nil
<br>
'''Description:'''<br>
save system notes to settings/<charactername>/system<systemid>notes.txt<br>
Numbers longer then 14 digits shouldn't be used for systemid.<br>
<br>
'''Arguments:'''<br>
''notes'' Notes to save. Normally a spickled version of an [[API Index#SystemNotes]] entry, but it accepts anything<br>
''sectorid'' [[systemid]]
<br><br>
'''Notes:'''<br>
using numbers with more then 14 digits causes systemid to be saved in scientific notation ie. 1e+016<br>
with first number rounded to 13 decimal places, which means that<br>
using systemid of 123456789012345 or 123456789012346 causes the file to be named:<br>
system1.2345678901235e+014notes.txt<br>

=== SectorIDFromLocationStr ===
'''Definition:'''
SectorIDFromLocationStr(string location) -> int sectorid
<br>
'''Description:'''<br>
Convert a location string into a [[sectorid]].
For two word system names only first word must be specified, otherwise it doesn't work (e.g. Geira rather than Geira Rutilus).
<br>
'''Arguments:'''<br>
''location'' location string. output of [[API_Index#ShortLocationStr]]
<br>
'''Returns:'''<br>
''sectorid'' [[sectorid]]
<br>

=== SelectActiveShip ===
'''Definition:'''
SelectActiveShip(int itemid) -> nil
<br>
'''Description:'''<br>
Set the given ship active
<br>
'''Arguments:'''<br>
''itemid'' itemid of  ship in the current station
<br>

=== SelectCharacter ===
'''Definition:'''
SelectCharacter(int charslot) -> nil
<br>
'''Description:'''<br>
Select characteri in given slot and enter the game with it (only "works" when you haven'T one selected yet)
<br>
'''Arguments:'''<br>
''charslot'' a character slot (1-5)
<br>

=== SellInventoryItem ===
'''Definition:'''
SellInventoryItem(int itemid, int amount) -> nil
<br>
'''Description:'''<br>
Sell the provided amount of an inventory item from the current station or ship when docked to a station
<br>
'''Arguments:'''<br>
''itemid'' itemid of an item at the current station<br>
''amount'' how many to sell
<br>

=== SendChat ===
'''Definition:'''
SendChat(string msg, string dst, string dstparam) -> nil
<br>
'''Description:'''<br>
Send a message to the provided destination.
<br>
'''Arguments:'''<br>
''msg'' the message<br>
''dst'' destination<br>
known destinations:<br>
"SAY" sector chat<br>
"SECTOR" sector chat<br>
"STATION" station chat<br>
"PRIVATE" private chat. requires char parameter<br>
"CHANNEL" chat chat<br>
"SYSTEM" system chat<br>
"GROUP" group chat<br>
"GUILD" guild chat<br>
"MISSION" mission chat. to activate reply buttons in the mission log send numbers. where 1 correspondends to the top most button<br>
''dstparam'' if dst = PRIVATE, the player to send the message, if dst = CHANNEL the channel to send the message (nil for current channel)
<br>

=== SendMissionQuestionResponse ===
'''Definition:'''
SendMissionQuestionResponse(int num) -> nil
<br>
'''Description:'''<br>
called by the initial info dialog 1 = accept, 0 = decline
<br>
'''Arguments:'''<br>
''num'' 1 or 0 
<br>

=== SetChatLogRead ===
'''Definition:'''
SetChatLogRead() -> nil
<br>
'''Description:'''<br>
Mark the general chat log as read/displayed
<br>

=== SetChatLogReceiver ===
'''Definition:'''
SetChatLogReceiver(table chatcontainer) -> nil
<br>
'''Description:'''<br>
Point the general chat log to a chat container
<br>

=== SetCurrentChatTab ===
'''Definition:'''
SetCurrentChatTab() -> ??
<br>
'''Description:'''<br>
does nothing. maybe a leftover from the general/mission chat system
<br>

=== SetHomeStation ===
'''Definition:'''
SetHomeStation() -> nil
<br>
'''Description:'''<br>
set current station as your home station
<br>

=== SetMissionLogRead ===
'''Definition:'''
SetMissionLogRead() -> nil
<br>
'''Description:'''<br>
Mark the advancement log as read/displayed
<br>

=== SetMissionLogReceiver ===
'''Definition:'''
SetMissionLogReceiver(table chatcontainer) -> nil
<br>
'''Description:'''<br>
Point the advancement log to a chat container
<br>

=== SetProximityWarningDistance ===
'''Definition:'''
SetProximityWarningDistance(int dist) -> nil
<br>
'''Description:'''<br>
set proximity warning distance ..
<br>
'''Arguments:'''<br>
''dist'' proximity distance
<br>

=== SetProximityWarningTimeout ===
'''Definition:'''<br>
SetProximityWarningTimeout(int timeout) -> nil
<br>
'''Description:'''<br>
Set minimum time between proximity warnings
<br>
'''Arguments:'''<br>
''timeout'' minimum time between proximity warnings in msecs
<br>

=== SetShipPurchaseColor ===
'''Definition:'''
SetShipPurchaseColor(int color) -> nil
<br>
'''Description:'''<br>
color of the next ship the player will buy
<br>
'''Arguments:'''<br>
''color'' color value (0-255)
<br>

=== SetStationLogRead ===
'''Definition:'''
SetStationLogRead() -> nil
<br>
'''Description:'''<br>
Mark the station log as read/displayed
<br>

=== SetStationLogReceiver ===
'''Definition:'''
SetStationLogReceiver(table chatcontainer) -> nil
<br>
'''Description:'''<br>
Point the station log to a chat container
<br>

=== SetViewObject ===
'''Definition:'''
SetViewObject(userdata modelview, string meshname, string meshfile, int color) -> nil
<br>
'''Description:'''<br>
Change the ship in a modelview
<br>
'''Arguments:'''<br>
''modelview'' [[iup#modelview|modelview]] to change<br>
''meshname'' mesh name of ship<br>
''meshfile'' filename of mesh<br>
''color'' [[colorid]]
<br>

=== ShortLocationStr ===
'''Definition:'''
ShortLocationStr(int sectorid) -> string loc
<br>
'''Description:'''<br>
string representing the provided sector
<br>
'''Arguments:'''<br>
''sectorid'' [[sectorid]]
<br>
'''Returns:'''<br>
''loc'' short sector description
<br>

=== ShouldTutorialRun ===
'''Definition:'''
ShouldTutorialRun() -> bool tut
<br>
'''Description:'''<br>
tell if the player has done the tutorial
<br>
'''Returns:'''<br>
''tut'' true if the player still has to do the tutorial otherwise false
<br>

=== ShowDialog ===
'''Definition:'''
ShowDialog(userdata dialog, int x, y) -> nil
<br>
'''Description:'''<br>
Wrapper around [[iup#Show|iup.Show]] that allows the dialog to be closed with [[API_Index#HideDialog|HideDialog]] or [[API_Index#HideAllDialogs|HideAllDialogs]]
<br>
'''Arguments:'''<br>
''dialog'' dialog to show<br>
''x'' horizontal position (optional)<br>
''y'' vertical position (optional)
<br>

=== ShowTooltip ===
'''Definition:'''
ShowTooltip(int x, y, string text) -> nil
<br>
'''Description:'''<br>
Show the [[API_Index#ToolTip|ToolTip]] the tooltip dialog with the given text
<br>
'''Arguments:'''<br>
''x'' horizontal position<br>
''y'' vertical position<br>
''text'' text in tooltip
<br>

=== SplitSectorID ===
'''Definition:'''
SplitSectorID(int sectorid) -> int systemid sectorh sectorv 
<br>
'''Description:'''<br>
split up a sectorid into systemid and axis on the system grid 
<br>
'''Arguments:'''<br>
''sectorid'' [[sectorid]]
<br>
'''Returns:'''<br>
''systemid''<br>
''sectorh'' horizonatal axis<br>
''sectorv'' vertical axis
<br>

=== SplitStationID ===
'''Definition:'''
SplitStationID(int stationid) -> int systemidl sectorhv
<br>
'''Description:'''<br>
split up a stationid into systemid -1 and sector in system. this may be totally wrong
<br>
'''Arguments:'''<br>
''stationid'' a stationid
<br>
'''Returns:'''<br>
''systemidl'' systemid - 1<br>
''secttorhv'' sector in system
<br>

=== StartSellInventoryItem ===
'''Definition:'''
StartSellInventoryItem(int itemid, function cb) -> nil
<br>
'''Description:'''<br>
Receive instant price updates for the given item.
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of inventory item for which to receive instant price updates. Pass 0 to disable updates.
''cb'' function to call on success
<br>

=== StationPlayerAmmoPairs ===
'''Definition:'''
StationPlayerAmmoPairs() -> int itemid table ammoinfo
<br>
'''Description:'''<br>
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()
<br>
'''Returns:'''<br>
''itemid'' [[itemid]]<br>
''iteminfo'' [[ammoinfo]]
<br>

=== StationSellItem ===
'''Definition:'''
StationSellItem(userdata button, table item, int quantity, function cb) -> nil
<br>
'''Description:'''<br>
Sell items with aconfirmation dialog
<br>
'''Arguments:'''<br>
''button'' button that clalled this function. it will be activated if sale failed<br>
''item'' [[iteminfo]]<br>
''quantity'' how many units to sell
''cb'' optional function to call when done. an error code is passed to it
<br>

=== StationSellableInventoryPairs ===
'''Definition:'''
StationSellableInventoryPairs() -> int itemid table iteminfo
<br>
'''Description:'''<br>
Iterator function that prints information about an item in the players inventory at the current station each time it is called. works like pairs()
<br>
'''Returns:'''<br>
''itemid'' [[itemid]]<br>
''iteminfo'' [[iteminfo]]
<br>

=== StopTutorial ===
'''Definition:'''
StopTutorial() -> nil
<br>
'''Description:'''<br>
does nothing..
<br>

=== StrTable ===
'''Definition:'''
StopTutorial() -> nil
<br>
'''Description:'''<br>
seems to be another serialisation function. similar (the same?) to splickle
<br>

=== SubmitSurvey ===
'''Definition:'''
SubmitSurvey() -> nil
<br>
'''Description:'''<br>
does nothing..
<br>

=== SwapAddons ===
'''Definition:'''
SwapAddons(int portid1 itemid1 porid1 itemid2 function cb) -> nil
<br>
'''Description:'''<br>
Swap two addons equipped to the current ship (crashes client after undocking)
<br>
'''Arguments:'''<br>
''portid1'' port of first item<br>
''itemid1'' itemid of addon that is supposed to go into port with id portid1<br>
''portid2'' port of second item<br>
''itemid2'' itemid of addon that is supposed to go into port with id portid2<br>
''cb'' function to call on success
<br>

=== TabCompleteName ===
'''Definition:'''
TabCompleteName(string name) -> string completename
<br>
'''Description:'''<br>
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.
<br>
'''Arguments:'''<br>
''name'' name to be completed
<br>
'''Returns:'''<br>
''completename'' completed name
<br>

=== TutorialEnd ===
'''Definition:'''
TutorialEnd() -> nil
<br>
'''Description:'''<br>
finish up the tutorial
<br>

=== TutorialPart1 ===
'''Definition:'''
TutorialPart1() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart10 ===
'''Definition:'''
TutorialPart10() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart11 ===
'''Definition:'''
TutorialPart11() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart12 ===
'''Definition:'''
TutorialPart12() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart13 ===
'''Definition:'''
TutorialPart13() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart2 ===
'''Definition:'''
TutorialPart2() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart3 ===
'''Definition:'''
TutorialPart3() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart4 ===
'''Definition:'''
TutorialPart4() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart5 ===
'''Definition:'''
TutorialPart5() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart6 ===
'''Definition:'''
TutorialPart6() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart7 ===
'''Definition:'''
TutorialPart7() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart8 ===
'''Definition:'''
TutorialPart8() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== TutorialPart9 ===
'''Definition:'''
TutorialPart9() -> nil
<br>
'''Description:'''<br>
Launch a tutorial segment
<br>

=== UnloadCargo ===
'''Definition:'''
UnloadCargo({{int itemid, int quantity} ..}, function cb) -> nil
<br>
'''Description:'''<br>
Unload cargo items and quantities according to the provided table 
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of cargo item<br>
''quantity'' amount of this cargo to unload<br>
''cb'' optional function to call on success
<br>

=== UnloadSellCargo ===
'''Definition:'''
UnloadSellCargo({{int itemid, int quantity} ..}, function cb) -> nil
<br>
'''Description:'''<br>
Unload and sell cargo items and quantities according to the provided table 
<br>
'''Arguments:'''<br>
''itemid'' itemid of cargo item<br>
''quantity'' amount of this cargo to unload and sell<br>
''cb'' optional function to call on success
<br>

=== UnregisterEvent ===
'''Definition:'''
UnregisterEvent(object, string eventtype) -> nil
<br>
'''Description:'''<br>
Unregister an object registered with [[API_RegisterEvent|RegisterEvent]]
<br>
'''Arguments:'''<br>
''eventhandler'' object to unregister<br>
''eventtype'' [[eventtype]]
<br>

=== UnregisterUserCommand ===
'''Definition:'''
UnregisterUserCommand(string command) -> nil
<br>
'''Description:'''<br>
Unregister a command registered with [[API Index#RegisterUserCommand|RegisterUserCommand]]
<br>
'''Arguments:'''<br>
''command'' command to unregister
<br>

=== UnrentStorage ===
'''Definition:'''
UnrentStorage(int storage) -> nil
<br>
'''Description:'''<br>
Unrent storage space at the current station.
<br>
'''Arguments:'''<br>
''storage'' amount of space to unrent. value is rounded down to multiple of 10K
<br>

=== UpdateFade ===
'''Definition:'''
UpdateFade(float delta) -> nil
<br>
'''Description:'''<br>
Do a fade step on controls registered with [[API_index#FadeControl|FadeControl]]
<br>
'''Arguments:'''<br>
''delta'' time since last update
<br>

=== XMLTagToString ===
'''Definition:'''
XMLTagToString() -> nil
<br>
'''Description:'''<br>
might the reverse of ParseXML
<br>

=== _ERRORMESSAGE ===
'''Definition:'''
_ERRORMESSAGE(string msg) -> nil
<br>
'''Description:'''<br>
creates an error message with the provided string. probably more
<br>
'''Arguments:'''<br>
''msg'' a message
<br>

=== assert ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== bbhash ===
'''Definition:'''
bbhash(string input, int arg2) -> string hash
<br>
'''Description:'''<br>
Seems to be some kind of hash function
<br>
'''Arguments:'''<br>
''input'' string from which to generate hash<br>
''arg2'' initializer(?)
<br>
'''Returns:'''<br>
''hash'' generated hash
<br>

=== calc_health_color ===
'''Definition:'''
calc_health_color(float health, int alpha, mode) -> string color
<br>
'''Description:'''<br>
Create an iup color string corresponding to the given health
<br>
'''Arguments:'''<br>
''health'' health (0-100)<br>
''alpha'' optional alpha value (0-255)<br>
''mode'' optional premultiply mode "*" or "&"
<br>
'''Returns:'''<br>
''color'' iup color string. format: "RRR GGG BBB AAA M"
<br>

=== chatareatemplate ===
'''Definition:'''
chatareatemplate(string statontabname, bool expanded) -> table container
<br>
'''Description:'''<br>
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
<br>
'''Arguments:'''<br>
''stationtabnaem'' "Station", "ShipCom" or nil. determines which maximized chat container to show on clicking the maximize button and whether to show the station log<br>
''expanded'' create a maximized chat container
<br>
'''Returns:'''<br>
''container'' chat container<br>
''container.area'' the chat area box<br>
''container.chatlog'' [[ChatLogTemplate]] for the general chat<br>
''container.missionlog'' [[ChatLogTemplate]] for the mission log<br>
''container.stationlog'' optional [[ChatLogTemplate]] for the station log<br>
''container.setup'' setup the chatarea
<br>

=== chatareatemplate2 ===
'''Definition:'''
chatareatemplate2(bool maximized, string maxbutton) -> userdata box
<br>
'''Description:'''<br>
create a chatarea control. wrapper around [[API_Index#ChatLogTemplate|ChatLogTemplate]]
<br>
'''Arguments:'''<br>
''maximized'' create maximized control<br>
''maxbutton'' text on maximize button(optional)
<br>
'''Returns:'''<br>
''box'' [[chataretemplate2]]
<br>

=== clear_accomlistbox ===
'''Definition:'''
clear_accomlistbox(userdata control, table itemlist) -> int selection
<br>
'''Description:'''<br>
Clear an accomplishment list control. See: [[API_index#AccomplishmentTemplate|AccomplishmentTemplate]]
<br>
'''Arguments:'''<br>
''control'' accomplishment list to clear<br>
''itemlist'' list of accomplishment list items. return value of [[API_Index#fill_accomlistbox|fill_accomlistbox]]
<br>
'''Returns:'''<br>
''selection'' index of selected item
<br>

=== clear_listbox ===
'''Definition:'''
clear_listbox(userdata control, table itemlist) -> int selection
<br>
'''Description:'''<br>
Clear a list control
<br>
'''Arguments:'''<br>
''control'' list to clear<br>
''itemlist'' list of list items. return value of [[API_Index#fill_listbox|fill_listbox]]
<br>
'''Returns:'''<br>
''selection'' index of selected item
<br>

=== clearscene ===
'''Definition:'''
clearscene() -> nil
<br>
'''Description:'''<br>
removes al objects from the game world
<br>

=== collectgarbage ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== comma_value ===
'''Definition:'''
comma_value(float number) -> string formatted_number
<br>
'''Description:'''<br>
returns a formatted version of the provided number according to [[API_Index#SI_unit]]
<br>
'''Arguments:'''<br>
''number'': unformatted number
<br>
'''Returns:'''<br>
''formatted_number'' formatted number
<br>

=== console_clear ===
'''Definition:'''
console_clear() -> nil
<br>
'''Description:'''<br>
clear console on the next [[API_Index#ReloadInterface]]
<br>

=== console_print ===
'''Definition:'''
console_print(string text) -> nil
<br>
'''Description:'''<br>
print the given string to the ingame console
<br>
'''Arguments:'''<br>
''text'' string to print
<br>

=== create_char_guild_tab ===
'''Definition:'''<br>
create_char_guild_tab(bool sub) -> userdata box
<br>
'''Description:'''<br>
Create guild tab
<br>
'''Arguments:'''<br>
''sub'' create as a sub tab
<br>
'''Returns:'''<br>
''box'' [[CharGuildTab]]
<br>

=== create_char_inventory_tab ===
'''Definition:'''<br>
create_char_guild_tab(bool expand_local_branches, show_prices, showsellbutton) -> userdata box, tree
<br>
'''Description:'''<br>
Create inventory tab
<br>
'''Arguments:'''<br>
''expand_local_branches'' expand the "Local Inventory" branch by default<br>
''show_prices'' show item prices while docked to station<br>
''showsellbutton'' show a sell button. the sell button is inactive unless ''show_pricess'' is set
<br>
'''Returns:'''<br>
''box'' [[CharInventoryTab]]<br>
''tree'' the tree control in the tab
<br>

=== create_jettison_tab ===
'''Definition:'''<br>
create_jettison_tab() -> userdata box
<br>
'''Returns:'''<br>
''box'' [[PDAInventoryJettisonTab]]
<br>

=== create_ship_group_template ===
'''Definition:'''<br>
create_ship_group_template(table iconlist, bool sub) -> userdata box
<br>
'''Description:'''<br>
Create weapon groups tab
<br>
'''Arguments:'''<br>
''iconlist'' list of [[portdata]]<br>
''sub'' create as a sub tab
<br>
'''Returns:'''<br>
''box'' [[GroupsTab]]
<br>

=== debugprint ===
'''Definition:'''
debugprint() -> ??
<br>
'''Description:'''<br>
does nothing..
<br>

=== declare ===
'''Definition:'''
declare(string name, value) -> nil
<br>
'''Description:'''<br>
declare a variable and assign a value
<br>
'''Arguments:'''<br>
''name'' name of the variable<br>
''value'' it's value. can be any type
<br>

=== deviceByMode ===
'''Definition:'''
deviceByMode(table arg1, mode) -> table ret
<br>
'''Description:'''<br>
not sure. possibly to find audio devices by capability
<br>

=== dofile ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== error ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== factioncontroltemplate3 ===
'''Definition:'''
factioncontroltemplate3(userdata frame, function cb, float font) -> userdata container
<br>
'''Description:'''<br>
Create a fancy progressbar/faction standing indicator
<br>
'''Arguments:'''<br>
''frame'' iup frame to use for progressbar<br>
''cb'' optional function to call on click<br>
''font'' optional font size. see [[Font]]
<br>
'''Returns:'''<br>
''container'' [[factioncontroltemplate3]]
<br>

=== factionfriendlyness ===
'''Definition:'''
factionfriendlyness(int standing) -> string name
<br>
'''Description:'''<br>
get string that represents the given faction standing 
<br>
'''Arguments:'''<br>
''standing'' standing (0-65535)
<br>
'''Returns:'''<br>
''name'' standing as string
<br>

=== factionfriendlynesscolor ===
'''Definition:'''
factionfriendlynesscolor(int standing) -> string color
<br>
'''Description:'''<br>
get iup color that represents that given faction standing 
<br>
'''Arguments:'''<br>
''standing'' standing (0-65535)
<br>
'''Returns:'''<br>
''color'' iup color string
<br>

=== factionfriendlynessrange ===
'''Definition:'''
factionfriendlynessrange(int standing) -> float range
<br>
'''Description:'''<br>
get progress within the current faction standing level 
<br>
'''Arguments:'''<br>
''standing'' standing (0-65535)
<br>
'''Returns:'''<br>
''float'' progress within faction standing level
<br>

=== fillModesDropdown ===
'''Definition:'''
fillModesDropdown() -> ?
<br>
'''Description:'''<br>
no clue. fill some kind of drop down menu(?)
<br>

=== fill_accomlistbox ===
'''Definition:'''
fill_accomlistbox(userdata control, table itemlist, function setup_cb, click_cb) -> table dialoglist
<br>
'''Description:'''<br>
fill an accomplishement listbox with [[accomlistsubdialog]]s according to given values. normally called from [[API_Index#AccomplishmentTemplate2|AccomplishmentTemplate2]]
<br>
'''Arguments:'''<br>
''control'' iup list to fill<br>
''itemlist'' [[fill_accomlistbox#itemlist|itemlist]]<br>
''setup_cb'' function called for each item in ''itemlist''. see: [[fill_accomlistbox#setup_cb|setup_cb]]<br>
''click_cb'' function to after clicking on an item
<br>
'''Returns:'''<br>
''dialoglist'' list of [[accomlistsubdialog]]
<br>

=== fill_listbox ===
'''Definition:'''
fill_listbox(userdata control, table itemlist, int curselindex, function setup_cb, bool show_quantity, show_price) -> table dialoglist
<br>
'''Description:'''<br>
fill a listbox with [[listsubdialog]]s according to given values
<br>
'''Arguments:'''<br>
''control'' iup list to fill<br>
''itemlist'' list of [[iteminfo]]<br>
''curselindex'' index of current selection
''setup_cb'' function called for each item in ''itemlist''. see: [[fill_listbox#setup_cb|setup_cb]]<br>
''click_cb'' function to after clicking on an item<br>
''show_quantity'' show item quantity in list<br>
''show_price'' show item price in list
<br>
'''Returns:'''<br>
''dialoglist'' list of [[listsubdialog]]
<br>

=== filter_colorcodes ===
'''Definition:'''
filter_colorcodes(string in) -> string out
<br>
'''Description:'''<br>
strips colorcodes from the provided string
<br>
'''Arguments:'''<br>
''in'' inputstring
<br>
'''Returns:'''<br>
''out'' outputstring
<br>

=== format_time ===
'''Definition:'''
format_time(int msecs) -> string tstring
<br>
'''Description:'''<br>
get string representation of the provided time
<br>
'''Arguments:'''<br>
''msecs'' time in microseconds
<br>
'''Returns:'''<br>
''tstring'' time string
<br>

=== generalprint ===
'''Definition:'''<br>
generalprint(string str) -> nil
<br>
'''Description:'''<br>
print given string to the chat area via CHAT_MSG_PRINT event. Results is printed in the active channel text color.
<br>
'''Arguments:'''<br>
''str'' string to print
<br>

=== get_itemdlg ===
'''Definition:'''<br>
get_itemdlg(bool showquantity, showprice) -> table dialog
<br>
'''Description:'''<br>
Get a new [[listsubdialog]] or recycle one from the cache
<br>
'''Arguments:'''<br>
''showquantity'' show quantity in dialog<br>
''showprice'' show price
<br>
'''Returns:'''<br>
''dialog'' [[listsubdialog]]
<br>

=== get_jettisonitemdlg ===
'''Definition:'''<br>
get_jettisonitemdlg(int itemid) -> userdata dialog
<br>
'''Description:'''<br>
Get a new [[jettisonlistsubdialog]] or recycle one from the cache
<br>
'''Arguments:'''<br>
''itemid'' [[itemid]] of item to show in dialog
<br>
'''Returns:'''<br>
''dialog'' [[jettisonlistsubdialog]]
<br>

=== getheight ===
'''Definition:'''<br>
getheight(userdata control) -> int height
<br>
'''Description:'''<br>
Get height of an iup control
<br>
'''Arguments:'''<br>
''control'' iup control
<br>
'''Returns:'''<br>
''height'' height of control
<br>

=== getwidth ===
'''Definition:'''<br>
getwidth(userdata control) -> int width
<br>
'''Description:'''<br>
Get width of an iup control
<br>
'''Arguments:'''<br>
''control'' iup control
<br>
'''Returns:'''<br>
''width'' width of control
<br>

=== guildaccessdialogtemplate ===
'''Definition:'''<br>
guildaccessdialogtemplate() -> userdata dialog
<br>
'''Description:'''<br>
create guild access dialog
<br>
'''Returns:'''<br>
''''dialog'' guild access dialog
<br>

=== guildactivitylogdialogtemplate ===
'''Definition:'''<br>
guildactivitylogdialogtemplate() -> userdata dialog
<br>
'''Description:'''<br>
create guild activity dialog
<br>
'''Returns:'''<br>
''dialog'' [[guildactivitydialog]]
<br>

=== guildbanklogdialogtemplate ===
'''Definition:'''<br>
guildbanklogdialogtemplate() -> userdata dialog
<br>
'''Description:'''<br>
create guild bank dialog
<br>
'''Returns:'''<br>
''dialog'' [[guildactivitydialog]]
<br>

=== hextorgb ===
'''Definition:'''
hextorgb(string hexcolors) -> string deccolors
<br>
'''Description:'''<br>
Convert hexadecimal formated color string into a decimal one used by [[iup]]
<br>
'''Arguments:'''<br>
''hexcolors'' hexadecimal color string
<br>
'''Returns:'''<br>
''deccolors'' decimal color string
<br>

=== ipairs ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== listpromptdlgtemplate ===
'''Definition:'''<br>
listpromptdlgtemplate(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with two buttons, a title and a listbox
<br>
'''Arguments:'''<br>
''msg'' message to display in the dialog<br>
''ltitle'' left button title<br>
''lcb'' left button callback<br>
''rtitle'' right button title<br>
''rcb'' right button callback
<br>
'''Returns:'''<br>
''dialog'' [[listpromptdlgtemplate]]
<br>

=== load ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== loadfile ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== loadscene ===
'''Definition:'''
loadscene(string scene) -> ??
<br>
'''Description:'''<br>
loads a background station for the login dialog. 
<br>
'''Arguments:'''<br>
''scene'' filename of a scene
<br>

=== loadstring ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== log_chat ===
'''Definition:'''<br>
log_chat(string str) -> nil
<br>
'''Description:'''<br>
Writes current time and given string to the errors.log
<br>
'''Arguments:'''<br>
''str'' string to write to log
<br>

=== log_print ===
'''Definition:'''
log_print(string str) -> nil
<br>
'''Description:'''<br>
Writes string to the errors.log
<br>
'''Arguments:'''<br>
''str'' string to write to log
<br>

=== msgdlgtemplate1 ===
'''Definition:'''<br>
msgdlgtemplate1(string msg, buttontext, function button_cb, string size, posx, posy, bgcolor) -> userdata dialog
<br>
'''Description:'''<br>
Create fullscreen dialog with button and message
<br>
'''Arguments:'''<br>
''msg'' dialog message<br>
''buttontext'' text on button<br>
''button_cb'' function called on button click<br>
''size'' iup size string<br>
''posx'' iup size string<br>
''posy'' iup size string<br>
''bgcolor'' iup color string
<br>
'''Returns:'''<br>
''dialog'' [[msgdlgtemplate1]]
<br>

=== msgdlgtemplate1a ===
'''Definition:'''<br>
msgdlgtemplate1a(string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog
<br>
'''Description:'''<br>
Create a dialog and optionally disable input to the background except to the given control.
Note: if a control is given display the dialog with :show_all() if not use [[API_Index#ShowDialog|ShowDialog]] or :show()
<br>
'''Arguments:'''<br>
''msg'' dialog message<br>
''size'' iup size of dialog<br>
''posx'' iup horizontal position<br>
''posy'' iup vertical position<br>
''control'' control to unmask<br>
''bgcolor'' iup background color
<br>
'''Returns:'''<br>
''dialog'' message dialog
<br>

=== msgdlgtemplate1aDone ===
'''Definition:'''<br>
msgdlgtemplate1aDone(function button_cb, string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog
<br>
'''Description:'''<br>
Same as [[API_Index#msgdlgtemplate1a|msgdlgtemplate1a]] but with a "Close" button
<br>
'''Arguments:'''<br>
''nutton_cb'' function called on clicking "Close"<br>
''msg'' dialog message<br>
''size'' iup size of dialog<br>
''posx'' iup horizontal position<br>
''posy'' iup vertical position<br>
''control'' control to unmask<br>
''bgcolor'' iup background color
<br>
'''Returns:'''<br>
''dialog'' message dialog
<br>

=== msgdlgtemplate1aNext ===
'''Definition:'''<br>
msgdlgtemplate1aNext(function button_cb, string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog
<br>
'''Description:'''<br>
Same as [[API_Index#msgdlgtemplate1a|msgdlgtemplate1a]] but with a "Next" button
<br>
'''Arguments:'''<br>
''nutton_cb'' function called on clicking "Next"<br>
''msg'' dialog message<br>
''size'' iup size of dialog<br>
''posx'' iup horizontal position<br>
''posy'' iup vertical position<br>
''control'' control to unmask<br>
''bgcolor'' iup background color
<br>
'''Returns:'''<br>
''dialog'' message dialog
<br>

=== msgdlgtemplate2 ===
'''Definition:'''<br>
msgdlgtemplate2(string msg, ltitle, function lcb, string rtitle, function rcb, string bgcolor, alignment) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with two buttons and a message
<br>
'''Arguments:'''<br>
''msg'' message to display in the dialog<br>
''ltitle'' left button title<br>
''lcb'' left button callback<br>
''rtitle'' right button title<br>
''rcb'' right button callback<br>
''bgcolor'' iup color of background<br>
''alignment'' iup alignment of ''msg''
<br>
'''Returns:'''<br>
''dialog'' [[msgdlgtemplate2]]
<br>

=== msgdlgtemplate2withcheck ===
'''Definition:'''<br>
msgdlgtemplate2withcheck(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with two buttons, a checkbox and a message
<br>
'''Arguments:'''<br>
''msg'' message to display in the dialog<br>
''ltitle'' left button title<br>
''lcb'' left button callback<br>
''rtitle'' right button title<br>
''rcb'' right button callback
<br>
'''Returns:'''<br>
''dialog'' [[msgdlgtemplate2withcheck]]
<br>

=== msgpromptdlgtemplate2 ===
'''Definition:'''<br>
msgpromptdlgtemplate2(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with two buttons, an entry field and a message
<br>
'''Arguments:'''<br>
''msg'' message to display in the dialog<br>
''ltitle'' left button title<br>
''lcb'' left button callback<br>
''rtitle'' right button title<br>
''rcb'' right button callback
<br>
'''Returns:'''<br>
''dialog'' [[msgpromptdlgtemplate2]]
<br>

=== msgpromptdlgtemplate2lines ===
'''Definition:'''<br>
msgpromptdlgtemplate2lines(string msg, msg2, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with two buttons, two entry fields and two messages
<br>
'''Arguments:'''<br>
''msg'' message to display in the dialog<br>
''msg2'' second message<br>
''ltitle'' left button title<br>
''lcb'' left button callback<br>
''rtitle'' right button title<br>
''rcb'' right button callback
<br>
'''Returns:'''<br>
''dialog'' [[msgpromptdlgtemplate2lines]]
<br>


=== multidlgtemplate1 ===
'''Definition:'''<br>
multidlgtemplate1(string msg, msg2, buttontitle, function cb) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with a button and two messages (one in a [[iup#multiline|multiline]] control) 
<br>
'''Arguments:'''<br>
''msg'' message to display in the dialog<br>
''msg2'' second message. shown in a multiline control<br>
''buttontitle'' right button title<br>
''cb'' right button callback
<br>
'''Returns:'''<br>
''dialog'' [[multidlgtemplate1]]
<br>

=== multidlgtemplate2 ===
'''Definition:'''<br>
multidlgtemplate2(string msg, msg2, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with two buttons and two messages (one in a [[iup#multiline|multiline]] control) 
<br>
'''Arguments:'''<br>
''msg'' message to display in the dialog<br>
''msg2'' second message. shown in a multiline control<br>
''ltitle'' left button title<br>
''lcb'' left button callback<br>
''rtitle'' right button title<br>
''rcb'' right button callback
<br>
'''Returns:'''<br>
''dialog'' [[multidlgtemplate2]]
<br>

=== multilistdlgtemplate ===
'''Definition:'''<br>
multilistdlgtemplate(string msg, msg2, table tbl, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
<br>
'''Description:'''<br>
Create a fullscreen dialog with two buttons, a dialog title, a dropdown menu, a title for the dropdown menu and a listbox
<br>
'''Arguments:'''<br>
''msg'' dialog title<br>
''msg2'' listbox title<br>
''tbl'' unused<br>
''ltitle'' left button title<br>
''lcb'' left button callback<br>
''rtitle'' right button title<br>
''rcb'' right button callback
<br>
'''Returns:'''<br>
''dialog'' [[multilistdlgtemplate]]
<br>

=== navmenu_template ===
'''Definition:'''
navmenu_template(bool showjumpbutton, function close_cb, bool issubsub) -> userdata container, distancetext, jumpbutton, zoombutton, undolastbutton 
<br>
'''Description:'''<br>
Create a control with a navmenu description box and some control buttons
<br>
'''Arguments:'''<br>
''showjumpbutton'' show the jump button if true<br>
''close_cb'' function to call after clicking the jump button while the player is able to jump<br>
''issubsub'' create a sub sub tab
<br>
'''Returns:'''<br>
''container'' [[navmenu_template]]<br>
''distancetext'' distance label<br>
''jumpbutton'' jump button or nil<br>
''zoombutton'' zoom button<br>
''undolastbutton'' undo button
<br>

=== next ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== oper ===
'''Definition:'''
<br>
'''Description:'''<br>
not gonna bother
<br>

=== pairs ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== pcall ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== print ===
'''Definition:'''<br>
print(string str) -> nil
<br>
'''Description:'''<br>
print given string to the chat area
<br>
'''Arguments:'''<br>
''str'' string to print
<br>

=== printtable ===
'''Definition:'''
printtable{in} -> nil
<br>
'''Description:'''<br>
print contents of a table to the console
<br>
'''Arguments:'''<br>
''in'' table to print
<br>

=== purchaseprint ===
'''Definition:'''<br>
purchaseprint(string str) -> nil
<br>
'''Description:'''<br>
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.
<br>
'''Arguments:'''<br>
''str'' string to print
<br>

=== rawequal ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== rawget ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== rawset ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== require ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== rgbtohex ===
'''Definition:'''<br>
rgbtohex(string deccolor) -> string hexcolor
<br>
'''Description:'''<br>
Returns string containing escaped hexadecimal version of the in decimal given color
<br>
'''Arguments:'''<br>
''deccolor'' string with color in decimal format (format: "r g b")
<br>
'''Returns:'''<br>
''hexcolor'' string starting with ascii code 127 followed by the color in hexadecimal format. (format: '\127RRGGBB') on failure it returns your input value
<br>

=== roper ===
'''Definition:'''
<br>
'''Description:'''<br>
not gonna bother
<br>

=== sectorprint ===
'''Definition:'''<br>
sectorprint(string str) -> nil
<br>
'''Description:'''<br>
print given string to the chat area via CHAT_MSG_SERVER_SECTOR event. Results in white text by default.
<br>
'''Arguments:'''<br>
''str'' string to print
<br>

=== select ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== setup_accomrow ===
'''Definition:'''<br>
setup_accomrow(int index, table itemlist, userdata subdlg, function click_cb) -> int newindex
<br>
'''Description:''' <br>
Initializes a list item in an accomplishment list. (used as setup_cb argument of [[API_Index#fill_accomlistbox|fill_accomlistbox]])
<br>
'''Arguments:'''<br>
''index'' position within itemlist<br>
''itemlist'' see [[Fill_accomlistbox#itemlist|itemlist]]<br>
''subdialog'' an itemlist dialog<br>
''click_cb'' function called after clicking on '''subdialog'''
<br>
'''Returns:'''<br>
''newindex'' position within itemlist + items consumed
<br>

=== singletab_template ===
'''Definition:'''<br>
singletab_template(string title, userdata contents) -> userdata tab
<br>
'''Description:''' <br>
Wrap a control into a tab like frame
<br>
'''Arguments:'''<br>
''title'' tab title<br>
''contents'' iup control
<br><br>
'''Returns:'''<br>
''tab'' tabbified control
<br>

=== sort_commodities ===
'''Definition:'''<br>
sort_commodities(table a, b) -> bool order
<br>
'''Description:''' <br>
Sort function for [[iteminfo]] tables. See table.sort in the lua reference
<br>
'''Arguments:'''<br>
''a'' [[iteminfo]]<br>
''b'' [[iteminfo]]
<br>
'''Returns:'''<br>
''order'' sort order
<br>

=== sort_sellable_commodities ===
'''Definition:'''<br>
sort_sellable_commodities(table a, b) -> bool order
<br>
'''Description:''' <br>
Sort function for [[iteminfo]] tables that prioritizes items in the active ship. See table.sort in the lua reference
<br><br>
'''Arguments:'''<br>
''a'' [[iteminfo]]<br>
''b'' [[iteminfo]]
<br>
'''Returns:'''<br>
''order'' sort order
<br>

=== spickle ===
'''Definition:'''
spickle(table intab) -> string
<br>
'''Description:'''<br>
Converts a table into a string roughly of the format "value","value",{"tablevalue","tablevalue";tablekey="value"};key="value",key="value"
<br>
'''Arguments:'''<br>
''intab'' input table
<br>
'''Returns:'''<br>
The spickled string
<br>

=== storagelocationcompare ===
'''Definition:'''<br>
storagelocationcompare(int a, b) -> bool order
<br>
'''Description:''' <br>
Sort function for [[locationid]] values. See table.sort in the lua reference
<br>
'''Arguments:'''<br>
''a'' [[locationid]]<br>
''b'' [[locationid]]
<br>
'''Returns:'''<br>
''order'' sort order
<br>

=== store_itemdlg ===
'''Definition:'''<br>
store_itemdlg(userdata dlg) -> nil
<br>
'''Description:''' <br>
Store a reference to an itemlist subdialog in the item dialog cache
<br>
'''Arguments:'''<br>
''dlg'' itemlist sub dialog
<br>

=== store_jettisonitemdlg ===
'''Definition:'''<br>
store_jettisonitemdlg(userdata dlg) -> nil
<br>
'''Description:''' <br>
Store a reference to an jettisonlist subdialog in the jettison dialog cache
<br>
'''Arguments:'''<br>
''dlg'' jettisonlist sub dialog
<br>

=== strip_whitespace ===
'''Definition:'''
strip_whitespace(string in) -> string out 
<br>
'''Description:'''<br>
strip whitespace from beginning and end of string
<br>
'''Arguments:'''<br>
''int'' input string
<br>
'''Returns:'''<br>
''out'' output string
<br>

=== substitute_vars ===
'''Definition:'''
substitute_vars(string in) -> string out 
<br>
'''Description:'''<br>
replace variables like %target% in input with their corresponding value
<br>
'''Arguments:'''<br>
''int'' input string
<br>
'''Returns:'''<br>
''out'' output string
<br>

=== tabcomplete ===
'''Definition:'''
<br>
'''Description:'''<br>
produces lua error..
<br>

=== testconquered ===
'''Definition:'''<br>
testconquered(int sectorid, factionid) -> nil
<br>
'''Description:'''<br>
test function. sets conquerer of the given sector
<br>
'''Arguments:'''<br>
''sectorid'' [[sectorid]]<br>
''factionid'' [[factionid]]
<br>

=== testsurvey ===
'''Definition:'''<br>
testsurvey() -> nil
<br>
'''Description:''' <br>
Test function for the survey feature
<br>

=== tonumber ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== tostring ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== type ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== undeclare ===
'''Definition:'''
undeclare(string name) -> nil
<br>
'''Description:'''<br>
undeclare a variable created with [[Function_Index#declare]]
<br>
'''Arguments:'''<br>
''name'' name of a variable
<br>

=== unpack ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>

=== unspickle ===
'''Definition:'''
unspickle(string in) ->  table outtab
<br>
'''Description:'''<br>
Converts a spickled string into a table
<br>
'''Arguments:'''<br>
''in'' input string
<br>
'''Returns:'''<br>
''outtab'' The unspickled table
<br>

=== xpcall ===
'''Definition:'''
<br>
'''Description:'''<br>
[http://www.lua.org/manual/5.0/manual.html#5.1]
<br>


== Tables ==

=== Bitlib ===
'''Description'''<br>
functions to manipulate the bitwise operations

'''Details'''<br>
[[Bitlib]]

=== Buddy ===
'''Description'''<br>
functions to manipulate the characters buddylist

'''Details'''<br>
[[Buddy]]

=== CapShipLog ===
'''Description'''<br>
table with parts of a cap ship chat area.

'''Details'''<br>
[[CapShipLog]]

=== CapShipShiplessLog ===
'''Description'''<br>
table with parts of a cap ship chat area. variant for players without ships.

'''Details'''<br>
[[CapShipShiplessLog]]

=== Duel ===
'''Description'''<br>
Duel related methods

'''Details'''<br>
[[Duel]]

=== FactionArticle ===
'''Description'''<br>
table with faction articles. indices represent [[factionid]]. see: [[API_Article|Article]]

'''Details'''<br>
[[FactionArticle]]

=== FactionColor ===
'''Description'''<br>
table with faction colors. indices represent [[factionid]]

'''Details'''<br>
[[FactionColor]]

=== FactionColor_RGB ===
'''Description'''<br>
table that maps [[factionid]]'s to colors in RGB format

'''Details'''<br>
[[FactionColor_RGB]]

=== FactionMonitor ===
'''Description'''<br>
table with monitoring types. indices represent numeric monitoring types and values, string representations of that type

'''Details'''<br>
[[FactionMonitor]]

=== FactionMonitorStr ===
'''Description'''<br>
table with monitoring types. values represent numeric monitoring types and indices, string representations of that type

'''Details'''<br>
[[FactionMonitorStr]]

=== FactionName ===
'''Description'''<br>
Array with short names of the ingame faction

'''Details'''<br>
[[FactionName]]

=== FactionNameFull ===
'''Description'''<br>
Array with long names of the ingame faction

'''Details'''<br>
[[FactionNameFull]]

=== FactionStanding ===
'''Description'''<br>
table for mapping names of standing levels to it#s int value

'''Details'''<br>
[[FactionStanding]]

=== Font ===
'''Description'''<br>
table that maps font names to sizes

'''Details'''<br>
[[Font]]

=== Font1 ===
'''Description'''<br>
table that maps font names to sizes

'''Details'''<br>
[[Font1]]

=== Font2 ===
'''Description'''<br>
table that maps font names to sizes

'''Details'''<br>
[[Font2]]

=== Game ===
'''Description'''<br>
functions to control a few game features ..

'''Details'''<br>
[[Game]]

=== GeneralChatPanel ===
'''Description'''<br>
table with parts of a chat area.

'''Details'''<br>
[[GeneralChatPanel]]

=== Group ===
'''Description'''<br>
Group related functions

'''Details'''<br>
[[Group]]

=== Guild ===
'''Description'''<br>
Guild related functions

'''Details'''<br>
[[Guild]]

=== Gunner ===
'''Description'''<br>
Gunner related functions for multiplayer ships

'''Details'''<br>
[[Gunner]]

=== HUD ===
'''Description'''<br>
table with HUD all hud releted functions and parts

'''Details'''<br>
[[HUD]]

=== Ignore ===
'''Description'''<br>
Ignorelist related functions

'''Details'''<br>
[[Ignore]]

=== InterfaceManager ===
'''Description'''<br>
table with event handler for some interface related events and function initialize the interface

'''Details'''<br>
[[InterfaceManager]]

=== InvManager ===
'''Description'''<br>
functions to get information about inventory items

'''Details'''<br>
[[InvManager]]

=== ListColors ===
'''Description'''<br>
colors for list widgets

'''Details'''<br>
[[ListColors]]

=== Mentor ===
'''Description'''<br>
Mentor related functions

'''Details'''<br>
[[Mentor]]

=== MissionLogPanel ===
'''Description'''<br>
table with parts of the mission log

'''Details'''<br>
[[MissionLogPanel]]

=== NavRoute ===
'''Description'''<br>
functions to manipulate your NavRoute

'''Details'''<br>
[[NavRoute]]

=== ShipOrder ===
'''Description'''<br>
table containing the ordering of ships in lists(?)

'''Details'''<br>
[[ShipOrder]]

=== ShipPalette ===
'''Description'''<br>
array that maps palette color values to rgb values

'''Details'''<br>
[[ShipPalette]]

=== ShipPalette_string ===
'''Description'''<br>
array that maps palette color values to string representations of rgb values

'''Details'''<br>
[[ShipPalette_string]]

=== ShipPresets ===
'''Description'''<br>
array with properties of ship presets

'''Details'''<br>
[[ShipPresets]]

=== Skills ===
'''Description'''<br>
table to translate skillid's into skill names and back

'''Details'''<br>
[[Skills]]

=== StationLog ===
'''Description'''<br>
table with parts of a stations chat area.

'''Details'''<br>
[[StationLog]]

=== StationLogPanel ===
'''Description'''<br>
table with parts of a chat area

'''Details'''<br>
[[StationLogPanel]]

=== SystemNames ===
'''Description'''<br>
Table to translate systemid's into system names and back. 

'''Details'''<br>
[[SystemNames]]

=== SystemNotes ===
'''Description'''<br>
System Notes public table. Used for adding notes to the navmap.

'''Details'''<br>
[[SystemNotes]]

=== TCPSocket ===
'''Description'''<br>
socket class

'''Details'''<br>
[[TCPSocket]]

=== TagFuncs ===
'''Description'''<br>
Text markup callbacks(?)

'''Details'''<br>
[[TagFuncs]]

=== Thread ===
'''Description'''<br>
Thread library

'''Details'''<br>
[[Thread]]

=== Timer ===
'''Description'''<br>
Timer class

'''Details'''<br>
[[Timer]]

=== VoiceChat ===
'''Description'''<br>
voice chat related functions

'''Details'''<br>
[[VoiceChat]]

=== Vote ===
'''Description'''<br>
functions to use the voting feature

'''Details'''<br>
[[Vote]]

=== _generalchatlog ===
'''Description'''<br>
array with chatlog

'''Details'''<br>
[[_generalchatlog]]

=== _missionlog ===
'''Description'''<br>
array with mission log

'''Details'''<br>
[[_missionlog]]

=== _stationlog ===
'''Description'''<br>
array with log of visisted stations

'''Details'''<br>
[[_stationlog]]

=== accomthing ===
'''Description'''<br>
no clue

'''Details'''<br>
[[accomthing]]

=== chatinfo ===
'''Description'''<br>
table with display options for each chat event

'''Details'''<br>
[[chatinfo]]

=== chatreceiver ===
'''Description'''<br>
event handler for chat events

'''Details'''<br>
[[chatreceiver]]

=== command_pretty_names ===
'''Description'''<br>
table that maps commands to their descriptions

'''Details'''<br>
[[command_pretty_names]]

=== coroutine ===
'''Description'''<br>
coroutine class

'''Details'''<br>
[[coroutine]]

=== debug ===
'''Description'''<br>
debugging helpers

'''Details'''<br>
[[debug]]

=== gkini ===
'''Description'''<br>
functions to manipulate the games config file

'''Details'''<br>
[[gkini]]

=== gkinterface ===
'''Description'''<br>
interface related functions..

'''Details'''<br>
[[gkinterface]]

=== gkmisc ===
'''Description'''<br>
misc functions ..

'''Details'''<br>
[[gkmisc]]

=== gknet ===
'''Description'''<br>
network related functions

'''Details'''<br>
[[gknet]]

=== gksound ===
'''Description'''<br>
audio related functions

'''Details'''<br>
[[gksound]]

=== gvector ===
'''Description'''<br>
gvector class. to create and manipulate vectors

'''Details'''<br>
[[gvector]]

=== ignore_time ===
'''Description'''<br>
array with with ignored name and period entries

'''Details'''<br>
[[ignore_time]]

=== iup ===
'''Description'''<br>
functions related to iup. create and manipulate ui elements

'''Details'''<br>
[[iup]]

=== joystick ===
'''Description'''<br>
functions to change joystick settings

'''Details'''<br>
[[joystick]]

=== math ===
'''Description'''<br>
standard math library

'''Details'''<br>
[[math]]

=== math3d ===
'''Description'''<br>
functions to do some vector math

'''Details'''<br>
[[math3d]]

=== os ===
'''Description'''<br>
functions to interface with the operating system

'''Details'''<br>
[[os]]

=== preset_buttons ===
'''Description'''<br>
table with preset button controls

'''Details'''<br>
[[preset_buttons]]

=== quaternion ===
'''Description'''<br>
quaternion class. to create and manipulate quats

'''Details'''<br>
[[quaternion]]

=== radar ===
'''Description'''<br>
functions to query and set radar parameters

'''Details'''<br>
[[radar]]

=== string ===
'''Description'''<br>
string manipulation functions

'''Details'''<br>
[[string]]

=== table ===
'''Description'''<br>
standard table library

'''Details'''<br>
[[table]]


== Variables ==

=== CLASSTYPE_ADDON ===
'''Description'''<br>
inventory item class of addons<br>
'''Value'''<br>
2

=== CLASSTYPE_FLAG ===
'''Description'''<br>
inventory item class of flags(?)<br>
'''Value'''<br>
3

=== CLASSTYPE_GENERIC ===
'''Description'''<br>
inventory item class of generic items<br>
'''Value'''<br>
0

=== CLASSTYPE_MISSION ===
'''Description'''<br>
inventory item class of missions<br>
'''Value'''<br>
5

=== CLASSTYPE_SHIP ===
'''Description'''<br>
inventory item class of ships<br>
'''Value'''<br>
1

=== CLASSTYPE_STORAGE ===
'''Description'''<br>
inventory item class of storage containers (station hold)<br>
'''Value'''<br>
4

=== ColorChatInput ===
'''Description'''<br>
boolean that controls coloring<br>
'''Value'''<br>

=== DEFAULT_LICENSE_WATCH ===
'''Description'''<br>
license to display in the HUD if not set by player<br>
'''Value'''<br>
2

=== FlashIntensity ===
'''Description'''<br>
alpha value of the bloodflash<br>
'''Value'''<br>
1

=== FontScale ===
'''Description'''<br>
font scaling<br>
'''Value'''<br>
1

=== HUD_SCALE ===
'''Description'''<br>
HUD scaling. set via rHUDxscale cvar. 1 means 640. the higher the resolution the lower the value<br>
'''Value'''<br>
1

=== IMAGE_DIR ===
'''Description'''<br>
subdirectory in the game directory where to look for images (skin option in config.ini)<br>
'''Value'''<br>

=== MAX_ACCOMICON2_COLUMNS ===
'''Description'''<br>
number of ribbons per column to show in pda accomplishments tab(?)<br>
'''Value'''<br>
4

=== MAX_ACCOMICONS ===
'''Description'''<br>
number of ribbons to show in char info(?)<br>
'''Value'''<br>
20

=== MAX_ACCOMICON_COLUMNS ===
'''Description'''<br>
number of ribbons per column to show in the char info screen(?)<br>
'''Value'''<br>
5

=== Platform ===
'''Description'''<br>
string representing the platform the game is running on<br>
'''Value'''<br>
"Unix", "MacOS" or "Windows"

=== SI_unit ===
'''Description'''<br>
number format<br>
'''Value'''<br>
1: unformatted 2: xxx xxx,xx 3: xxx,xxx.xx

=== SensorSort ===
'''Description'''<br>
Current sort order of nearby ship list<br>
'''Value'''<br>
1: Name 2: Faction 3: Ship 4: Distance

=== ShowLogoffDialog ===
'''Description'''<br>
show logoff confirmation dialog if true<br>
'''Value'''<br>

=== ShowSetHomeDialog ===
'''Description'''<br>
show homing confirmation dialog if true<br>
'''Value'''<br>

=== SortItems ===
'''Description'''<br>
sort order for lists<br>
'''Value'''<br>
1: Name 2: Price 3: Group>Name>Price 4: Group>Price>Name

=== VO_VERSION ===
'''Description'''<br>
games major version<br>
'''Value'''<br>
3

=== _VERSION ===
'''Description'''<br>
lua version<br>
'''Value'''<br>
"Lua 5.1"

=== defaulttutorialbgcolor ===
'''Description'''<br>
color of the not highlighted parts while the tutorial is active(?)<br>
'''Value'''<br>
"0 0 0 64 *"

=== tabseltextcolor ===
'''Description'''<br>
color of selected tab<br>
'''Value'''<br>
"1 241 255"

=== tabunseltextcolor ===
'''Description'''<br>
color of unselected tab<br>
'''Value'''<br>
"0 185 199"

=== targetshield_percentage_color ===
'''Description'''<br>
color of shield percentage value in the target health bar<br>
'''Value'''<br>
"00e0ff"


== Userdata ==

=== AskForgivenessDialog ===
'''Description'''<br>
the forgive dialog. see [[QuestionDialog]]

=== Big3DViewDialog ===
'''Description'''<br>
dialog that is shown after clicking on the maximize button in the "Ship"->"Buy->"Buy Ship" tab. created with [[API_CreateBig3DViewMenu|CreateBig3DViewMenu]]

=== BuybackQuestionPrompt ===
'''Description'''<br>
dialog that is shown when arriving at the home station after dieing

=== CancelLoadoutPurchaseDialog ===
'''Description'''<br>
"Purchasing ..." dialog that is shown while buying a preset. created with [[API_CreateCancelLoadoutMenu|CreateCancelLoadoutMenu]]

=== CapShipChatArea ===
'''Description'''<br>
vbox with contents the cap ship interface chat area (entry, log, radios ...)

=== CapShipChatTab ===
'''Description'''<br>
vbox with contents of the "Commerce"->"Ship Com" tab

=== CapShipCurrentLocationInfo ===
'''Description'''<br>
label in the top right corner of the cap ship interface with the current system and sector name

=== CapShipDialog ===
'''Description'''<br>
the base dialog of the cap ship interface

=== CapShipFactionInfo ===
'''Description'''<br>
vbox in the cap ship interface with faction information. contains [[CapShipNameLabel]] and [[CapShipNameInfo]]. created with [[API_CreateCapShipFactionInfo|CreateCapShipFactionInfo]]

=== CapShipFactionLabel ===
'''Description'''<br>
label in the cap ship interface with the name of the faction that owns the current cap ship ("a ... ship")

=== CapShipLaunchButton ===
'''Description'''<br>
button in the cap ship interface that launches the ship

=== CapShipNameLabel ===
'''Description'''<br>
label in the cap ship interface with the name of the current cap ship (top right)

=== CapShipOptionsButton ===
'''Description'''<br>
button in the cap ship interface that opens the options dialog

=== CapShipPDACharacterStatsTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Character"->"Statistics" tab 

=== CapShipPDACharacterTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Character" tab 

=== CapShipPDACommTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Comm" tab 

=== CapShipPDAInventoryInventoryTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Inventory"->"Inventory" tab 

=== CapShipPDAInventoryJettisonTab ===
'''Description'''<br>
vbox with contents of the PDAs "Your PDA"->"Inventory"->"Cargo" tab 

=== CapShipPDAInventoryTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Inventory" tab 

=== CapShipPDAMissionAdvancementTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Missions"->"Advancement Logs" tab 

=== CapShipPDAMissionBoardTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Missions"->"Mission Board" tab 

=== CapShipPDAMissionBoardTabInfoButton ===
'''Description'''<br>
button in the cap ship interface "Your PDA"->"Missions"->"Mission Board" tab to request mission info

=== CapShipPDAMissionLogTab ===
'''Description'''<br>
hbox with contents of the cap ship interface "Your PDA"->"Missions"->"Mission Logs" tab 

=== CapShipPDAMissionNotesTab ===
'''Description'''<br>
vbox with contents of the cap ship interface "Your PDA"->"Missions"->"Mission Notes" tab 

=== CapShipPDAMissionsTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Your PDA"->"Missions" tab 

=== CapShipPDASensorNearbyTab ===
'''Description'''<br>
vbox with contents of the cap ship interface "Your PDA"->"Sensor Log"->"Nearby Ships" tab 

=== CapShipPDASensorTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Your PDA"->"Sensor Log" tab 

=== CapShipPDAShipNavigationTab ===
'''Description'''<br>
hbox with contents of the cap ship interface "Your PDA"->"Navigation"->"Navigation" tab 

=== CapShipPDAShipTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Your PDA"->"Navigation" tab 

=== CapShipRepairTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Tactical"->"Repair/Refill" tab. created with [[API_CreateCapShipRepairTab|CreateCapShipRepairTab]]

=== CapShipSecondaryInfo ===
'''Description'''<br>
label with character info (Money, Ship, Licenses ...) displayed in the bottom right of the cap ship interface

=== CapShipShiplessChatArea ===
'''Description'''<br>
vbox with contents of the cap ship interface chat area (entry, log, radios ...)

=== CapShipShiplessChatTab ===
'''Description'''<br>
vbox with contents of the "Commerce"->"Ship Com" tab

=== CapShipShiplessCurrentLocationInfo ===
'''Description'''<br>
label in the top right corner of the cap ship interface with the current system and sector name

=== CapShipShiplessDialog ===
'''Description'''<br>
the base dialog of the cap ship interface

=== CapShipShiplessFactionInfo ===
'''Description'''<br>
vbox in the cap ship interface with faction information. contains [[CapShipShiplessNameLabel]] and [[CapShipShiplessNameInfo]]. created with [[API_CreateCapShipShiplessFactionInfo|CreateCapShipShiplessFactionInfo]]

=== CapShipShiplessFactionLabel ===
'''Description'''<br>
label in the cap ship interface with the name of the faction that owns the current cap ship ("a ... ship")

=== CapShipShiplessLeaveButton ===
'''Description'''<br>
button in the cap ship interface that launches the ship

=== CapShipShiplessNameLabel ===
'''Description'''<br>
label in the cap ship interface with the name of the current cap ship (top right)

=== CapShipShiplessOptionsButton ===
'''Description'''<br>
button in the cap ship interface that opens the options dialog

=== CapShipShiplessPDACharacterStatsTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Character"->"Statistics" tab 

=== CapShipShiplessPDACharacterTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Character" tab 

=== CapShipShiplessPDACommTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Comm" tab 

=== CapShipShiplessPDAInventoryInventoryTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Inventory"->"Inventory" tab 

=== CapShipShiplessPDAInventoryJettisonTab ===
'''Description'''<br>
vbox with contents of the PDAs "Your PDA"->"Inventory"->"Cargo" tab 

=== CapShipShiplessPDAInventoryTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Inventory" tab 

=== CapShipShiplessPDAMissionAdvancementTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Missions"->"Advancement Logs" tab 

=== CapShipShiplessPDAMissionBoardTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Missions"->"Mission Board" tab 

=== CapShipShiplessPDAMissionBoardTabInfoButton ===
'''Description'''<br>
button in the cap ship interface "Your PDA"->"Missions"->"Mission Board" tab to request mission info

=== CapShipShiplessPDAMissionLogTab ===
'''Description'''<br>
hbox with contents of the cap ship interface "Your PDA"->"Missions"->"Mission Logs" tab 

=== CapShipShiplessPDAMissionNotesTab ===
'''Description'''<br>
vbox with contents of the cap ship interface "Your PDA"->"Missions"->"Mission Notes" tab 

=== CapShipShiplessPDAMissionsTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Your PDA"->"Missions" tab 

=== CapShipShiplessPDASensorNearbyTab ===
'''Description'''<br>
vbox with contents of the cap ship interface "Your PDA"->"Sensor Log"->"Nearby Ships" tab 

=== CapShipShiplessPDASensorTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Your PDA"->"Sensor Log" tab 

=== CapShipShiplessPDAShipNavigationTab ===
'''Description'''<br>
hbox with contents of the cap ship interface "Your PDA"->"Navigation"->"Navigation" tab 

=== CapShipShiplessPDAShipTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Your PDA"->"Navigation" tab 

=== CapShipShiplessSecondaryInfo ===
'''Description'''<br>
label with character info (Money, Ship, Licenses ...) displayed in the bottom right of the cap ship interface

=== CapShipShiplessTabPDA ===
'''Description'''<br>
box with contents of the cap ship interface "Your PDA" tab. created with [[API_CreateCapShipShiplessPDATab|CreateCapShipShiplessPDATab]]

=== CapShipShiplessTabs ===
'''Description'''<br>
vbox with contents of the cap ship interface tabs 

=== CapShipShiplessTacticalTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Tactical" tab. created with [[API_CreateCapShipShiplessTacticalTab|CreateCapShipShiplessTacticalTab]]

=== CapShipShiplessTurretTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Tactical"->"Turrets" tab. created with [[API_CreateCapShipShiplessTurretTab|CreateCapShipShiplessTurretTab]]

=== CapShipTabPDA ===
'''Description'''<br>
box with contents of the cap ship interface "Your PDA" tab. created with [[API_CreateCapShipPDATab|CreateCapShipPDATab]]

=== CapShipTabs ===
'''Description'''<br>
vbox with contents of the cap ship interface tabs 

=== CapShipTacticalTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Tactical" tab. created with [[API_CreateCapShipTacticalTab|CreateCapShipTacticalTab]]

=== CapShipTurretTab ===
'''Description'''<br>
frame with contents of the cap ship interface "Tactical"->"Turrets" tab. created with [[API_CreateCapShipTurretTab|CreateCapShipTurretTab]]

=== CharCreateDialog ===
'''Description'''<br>
the character creation dialog

=== CharCreateFailedDialog ===
'''Description'''<br>
error dialog that is shown the character creation failed. created with [[API_CreateCharCreateFailedMenu|CreateCharCreateFailedMenu]]

=== CharDeleteVerifierConfirmButton ===
'''Description'''<br>
continue button in [[CharDeleteVerifierDialog]]

=== CharDeleteVerifierDialog ===
'''Description'''<br>
the verification dialog that shown by the "Delete Character" button

=== CharDeleteVerifierEditbox ===
'''Description'''<br>
entry in [[CharDeleteVerifierDialog]]

=== CharInfoDialog ===
'''Description'''<br>
the character info dialog. opened with k in space. 

=== CharSelectDialog ===
'''Description'''<br>
the character selection dialog.

=== CharSelectFailedDialog ===
'''Description'''<br>
error dialog with title "Character selection failed". created with [[API_CreateCharSelectFailedMenu|CreateCharSelectFailedMenu]]

=== ChatColorOptionsDialog ===
'''Description'''<br>
dialog opened via "Options"->"Interface"->"Chat Color Settings"

=== ConfirmationDialog ===
'''Description'''<br>
dialog with an ok button. no clue where it's used

=== ConnectingDialog ===
'''Description'''<br>
"Connecting..." dialog shown during login. created with [[API_CreateConnectingMenu|CreateConnectingMenu]]

=== CreditsDialog ===
'''Description'''<br>
dialog with credits. opened with the credits button at the log in prompt

=== EULADialog ===
'''Description'''<br>
dialog that with the Eula shown at login

=== HUDHelpMenu ===
'''Description'''<br>
dialog with common keybindings. opened with the F1 key while in space 

=== HUDInterfaceOptionsDialog ===
'''Description'''<br>
dialog with the HUD options, opened with the "HUD Settings" buttons in the Interface options dialog

=== InterfaceOptionsDialog ===
'''Description'''<br>
dialog with the interface options

=== InvalidAmountDialog ===
'''Description'''<br>
error dialog with the text "Invalud Amount". no idea where it's used

=== LoadingDialog ===
'''Description'''<br>
dialog with the loading screen that is shown during sector load

=== LoginHelpDialog ===
'''Description'''<br>
dialog with help text that is shown by the "Help" button in the login screen

=== LowGridPowerDialog ===
'''Description'''<br>
error dialog that is shown when trying to connect an that requires more grid power than the ship can provide

=== MaximizedCapShipChat ===
'''Description'''<br>
dialog with the maximized cap ship chat

=== MaximizedGunnerWaitChat ===
'''Description'''<br>
dialog with the maximized chat log that is shown after accepting an invitation to be a gunner  

=== MaximizedSpaceChat ===
'''Description'''<br>
dialog with the maximized space chat

=== MaximizedStationChat ===
'''Description'''<br>
dialog with the maximized station chat

=== MissionAbortDialog ===
'''Description'''<br>
dialog to confirm abortion of missions 

=== MissionPromptDialog ===
'''Description'''<br>
dialog with mission description and buttons to accept or decline

=== NewsDialog ===
'''Description'''<br>
dialog showing a news article

=== NotEnoughStorageDialog ===
'''Description'''<br>
error dialog that pops when trying to put more than the storage limit into a station

=== NotificationDialog ===
'''Description'''<br>
A borderless iup dialog with a message. It's displayed during non interruptible processes, like launching.

=== OptionsDialog ===
'''Description'''<br>
the Options dialog

=== PDACharacterAccomTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Character"->"Accomplishments" tab 

=== PDACharacterFactionTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Character"->"Faction Standings" tab 

=== PDACharacterStatsTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Character"->"Statistics" tab 

=== PDACharacterTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Character" tab 

=== PDAChatArea ===
'''Description'''<br>
vbox with contents a the PDA chat area (entry, log, radios ...)

=== PDACloseButton ===
'''Description'''<br>
button to close the PDA

=== PDACommTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Comm" tab 

=== PDACurrentLocationInfo ===
'''Description'''<br>
label in the top right corner of the PDA with the current system and sector name

=== PDADialog ===
'''Description'''<br>
the base dialog of the PDA 

=== PDAInventoryInventoryTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Inventory"->"Inventory" tab 

=== PDAInventoryJettisonTab ===
'''Description'''<br>
vbox with contents of the PDAs "Your PDA"->"Inventory"->"Cargo" tab 

=== PDAInventoryTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Inventory" tab 

=== PDAMissionAdvancementTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Missions"->"Advancement Logs" tab 

=== PDAMissionBoardTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Missions"->"Mission Board" tab 

=== PDAMissionBoardTabInfoButton ===
'''Description'''<br>
button in the PDAs "Your PDA"->"Missions"->"Mission Board" tab to request mission info

=== PDAMissionLogTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Missions"->"Mission Logs" tab 

=== PDAMissionNotesTab ===
'''Description'''<br>
vbox with contents of the PDAs "Your PDA"->"Missions"->"Mission Notes" tab 

=== PDAMissionsTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Missions" tab 

=== PDASecondaryInfo ===
'''Description'''<br>
label with character info (Money, Ship, Licenses ...) displayed in the bottom right of the PDA

=== PDASensorNearbyTab ===
'''Description'''<br>
vbox with contents of the PDAs "Your PDA"->"Sensor Log"->"Nearby Ships" tab 

=== PDASensorTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Sensor Log" tab 

=== PDAShipNavigationTab ===
'''Description'''<br>
hbox with contents of the PDAs "Your PDA"->"Navigation"->"Navigation" tab 

=== PDAShipTab ===
'''Description'''<br>
frame with contents of the PDAs "Your PDA"->"Navigation" tab 

=== PDATab1 ===
'''Description'''<br>
not sure

=== PDATabs ===
'''Description'''<br>
vbox with contents of the PDAs "Your PDA" tab 

=== PDATargetInfo ===
'''Description'''<br>
vbox with contents of the target info in the top right of the PDA (name, health, faction ...)

=== QuestionDialog ===
'''Description'''<br>
A dialog with two buttons and a message

=== QuestionWithCheckDialog ===
'''Description'''<br>
A dialog with two buttons, check box and a message

=== SellItemDialog ===
'''Description'''<br>
dialog that pops up after clicking on the "Sell Selected" button

=== StationChatArea ===
'''Description'''<br>
vbox with contents a stations chat area (entry, log, radios ...)

=== StationChatTab ===
'''Description'''<br>
vbox with contents of the "Commerce"->"The Bar" tab

=== StationCommerceCommoditiesTab ===
'''Description'''<br>
vbox with contents of the "Commerce"->"Commodities" tab

=== StationCommerceTab ===
'''Description'''<br>
frame with contents of the "Commerce" tab

=== StationCommerceWelcomeTab ===
'''Description'''<br>
vbox with contents of the "Commerce"->"Welcome" tab

=== StationCommoditiesBuyTab ===
'''Description'''<br>
frame with contents of the "Commerce"->"Commodities"->"Buy" tab

=== StationCommoditiesLoadTab ===
'''Description'''<br>
vbox with contents of the "Commerce"->"Load/Unload" tab

=== StationCommoditiesSellTab ===
'''Description'''<br>
vbox with contents of the "Commerce"->"Commodities"->"Sell" tab

=== StationCurrentLocationInfo ===
'''Description'''<br>
label in the top right corner of the station dialog with the current system and sector name

=== StationDialog ===
'''Description'''<br>
the base dialog of the station interface

=== StationEquipmentBuyLargeTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Buy"->"Large" tab

=== StationEquipmentBuyOtherPurchaseButton ===
'''Description'''<br>
"Purchase Selected" button in the "Ship"->"Buy"->"Other" tab

=== StationEquipmentBuyOtherTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Buy"->"Other" tab

=== StationEquipmentBuyShipPurchaseButton ===
'''Description'''<br>
"Purchase Selected" button in the "Ship"->"Buy"->"Buy Ship" tab

=== StationEquipmentBuyShipTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Buy"->"Buy Ship" tab

=== StationEquipmentBuySmallPurchaseButton ===
'''Description'''<br>
"Purchase Selected" button in the "Ship"->"Buy"->"Small Addons" tab

=== StationEquipmentBuySmallTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Buy"->"Small Addons" tab

=== StationEquipmentBuyTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Buy" tab

=== StationEquipmentManagePortConfigTab ===
'''Description'''<br>
hbox with contents of the "Ship"->"Manage"->"Configure Ship" tab

=== StationEquipmentManageShipSelectionTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Manage"->"Select Ship" tab

=== StationEquipmentManageTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Manage" tab

=== StationEquipmentSellTab ===
'''Description'''<br>
frame with contents of the "Ship"->"Sell" tab

=== StationEquipmentTab ===
'''Description'''<br>
frame with contents of the "Ship" tab

=== StationFactionInfo ===
'''Description'''<br>
vbox in the station window with faction information. contains [[StationNameLabel]] and [[StationNameInfo]]. created with [[API_CreateStationFactionInfo|CreateStationFactionInfo]]

=== StationFactionLabel ===
'''Description'''<br>
label in the station window with the name of the faction that owns the current station ("a ... station")

=== StationHelpDialog ===
'''Description'''<br>
dialog shown via help buttons that contains a help text

=== StationHomeButton ===
'''Description'''<br>
button in the station window that sets the current station as home station

=== StationLaunchButton ===
'''Description'''<br>
button in the station window that launches the ship

=== StationNameLabel ===
'''Description'''<br>
label in the station window with the name of the current station (top right)

=== StationOptionsButton ===
'''Description'''<br>
button in the station window that opens the options dialog

=== StationPDACharacterStatsTab ===
'''Description'''<br>
hbox with contents of the "Your PDA"->"Character"->"Statistics" tab

=== StationPDACharacterTab ===
'''Description'''<br>
frame with contents of the "Your PDA"->"Character" tab

=== StationPDACommTab ===
'''Description'''<br>
frame with contents of the "Your PDA"->"Comm" tab

=== StationPDAInventoryInventoryTab ===
'''Description'''<br>
hbox with contents of the "Your PDA"->"Inventory"->"Inventory" tab

=== StationPDAInventoryJettisonTab ===
'''Description'''<br>
vbox with contents of the "Your PDA"->"Inventory"->"Cargo" tab

=== StationPDAInventoryTab ===
'''Description'''<br>
frame with contents of the "Your PDA"->"Inventory" tab

=== StationPDAMissionAdvancementTab ===
'''Description'''<br>
hbox with contents of the "Your PDA"->"Missions"->"Advancement Logs" tab

=== StationPDAMissionBoardTab ===
'''Description'''<br>
frame with contents of the "Your PDA"->"Missions"->"Mission Board" tab

=== StationPDAMissionBoardTabInfoButton ===
'''Description'''<br>
info button displayed in the "Your PDA"->"Missions"->"Mission Board" tab

=== StationPDAMissionLogTab ===
'''Description'''<br>
hbox with contents of the "Your PDA"->"Missions"->"Mission Logs" tab

=== StationPDAMissionNotesTab ===
'''Description'''<br>
vbox with contents of the "Your PDA"->"Missions"->"Mission Notes" tab

=== StationPDAMissionsTab ===
'''Description'''<br>
frame with contents of the "Your PDA"->"Missions" tab

=== StationPDASensorNearbyTab ===
'''Description'''<br>
vbox with contents of the "Your PDA"->"Sensor Log"->"Nearby Ships" tab

=== StationPDASensorTab ===
'''Description'''<br>
frame with contents of the "Your PDA"->"Sensor Log" tab

=== StationPDAShipNavigationTab ===
'''Description'''<br>
hbox with contents of the "Your PDA"->"Navigation"->"Navigation" tab

=== StationPDAShipTab ===
'''Description'''<br>
frame with contents of the "Your PDA"->"Navigation" tab

=== StationSecondaryInfo ===
'''Description'''<br>
label with character info (Money, Ship, Licenses ...) displayed in the

=== StationTabPDA ===
'''Description'''<br>
frame with contents of the "You PDA" tab

=== StationTabs ===
'''Description'''<br>
vbox housing the main station tabs ("Commerce", "Ship" and "You PDA")

=== StorageRentalDialog ===
'''Description'''<br>
dialog for renting station storage

=== SurveyDialog ===
'''Description'''<br>
A survey dialog. probably unused

=== ToolTip ===
'''Description'''<br>
dialog with the current/last tooltip

=== VoiceChatOptions ===
'''Description'''<br>
dialog with voice chat options

=== shipcargolabel ===
'''Description'''<br>
label in the "Load/Unload" tab with number of cu and mass of cargo on the ship<br>

=== target_health_percentages ===
'''Description'''<br>
label on top of the target health bar with health and shield strength in percent<br>