API Index
WARNING: This index is is mostly based on guesswork and experimentation. A lot of entries may be incomplete or inaccurate.
Somewhat out of date. See API_Index2 for current descriptions.
Functions
AbbrLocationStr
Definition:
AbbrLocationStr(int sectorid) -> string name
Description:
Get abbreviated sector name for sectorid
Arguments:
sectorid sectorid
Returns:
name shortened sector name
Example:
<source lang="lua">AbbrLocationStr(5000) -> "Sed H9"</source>
AbortMission
Definition:
AbortMission(int itemid) -> nil
Description:
Abort a mission
Arguments:
itemid itemid of mission (optional)
AccomplishmentTemplate
Definition:
AccomplishmentTemplate(function cb(string desc)) -> userdate box
Description:
Create box with accomplishment icons (targetinfo dialog). see: AccomplishmentTemplate
Arguments:
cb function to call when clicking
desc description of clicked accomplishment
Returns:
box AccomplishmentTemplate
AccomplishmentTemplate2
Definition:
AccomplishmentTemplate2(function cb(string desc, int type, level)) -> userdate box
Description:
Create list with accomplishment icons (pda playerinfo dialog). see: AccomplishmentTemplate
Arguments:
cb function to call when clicking icons
desc description of clicked accomplishment
type type of clicked accomplishment
level level of clicked accomplishment
Returns:
box AccomplishmentTemplate
Article
Definition:
Article(string word) -> string out
Description:
prepends the appropriate article to the string word
Arguments:
word string to prepend an article to.
Returns:
out the string with an article prepended.
Example:
<source lang="lua">Article("apple") -> "an apple"</source>
CanUseAddon
Definition:
CanUseAddon(int itemid) -> bool ret1, {string l1 ..}
Description:
check if the player can equip the addon itemid
Arguments:
itemid itemid of addon to check
Returns:
ret1 can use
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)
Example:
<source lang="lua">CanUseAddon(12345) -> true {1, 2, 2, 2, 2}</source>
CanUseMerchandise
Definition:
CanUseMerchandise(table iteminfo) -> bool ret1, {string l1 ..}
Description:
check if the player can use the item iteminfo
Arguments:
iteminfo iteminfo of item to check
Returns:
ret1 can use
l1 license requirements of the item
CancelPurchaseShipLoadout
Definition:
CancelPurchaseShipLoadout() -> nil
Description:
Interrupt purchase of ship loadout
ChatLogTemplate
Definition:
ChatLogTemplate(string bg, string scrolledbg, function updatecb, string editbg, bool clickable) -> table container
Description:
Create rudimentary chet container. See ChatLogTemplate
Arguments:
bg iupcolor of background
scrolledbg iupcolor of background when scrolled up
updatecb function called whenever contents of the container changes
editbg image for background of entry
clickable if true the container will respond to mouse clicks
Returns:
container ChatLogTemplate
CheckCharProximity
Definition:
CheckCharProximity(int dist, charid) -> bool inrange
Description:
Tell if a character at a given distance is within proximity range. The function only returns true once for every character in radar proximity range. Any further checks will return false until the character leaves the range.
Arguments:
dist distance of character
charid charid
Returns:
inrange true if a character is within proximity range and hasn't left it since the last check
CheckProximityWarning
Definition:
CheckProximityWarning() -> nil
Description:
Trigger the PROXIMITY_ALERT event if a character, that hasn't been before, is within proximity range
CheckStorageAndUnloadCargo
Definition:
CheckStorageAndUnloadCargo({{int itemid, int quantity} ..}, function cb) -> nil
Description:
Unload cargo items and quantities according to the provided table also checks station storage and pops up a dialog if not enough available
Arguments:
itemid itemid of cargo item
quantity amount of this cargo to unload
cb optional function to call on success
Example:
<source lang="lua">CheckStorageAndUnloadCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}</source>
unload 2 units of the cargo with the itemid 1234 and 3 with the id 1235
ClearGeneralChatLog
Definition:
ClearGeneralChatLog() -> nil
Description:
clears general chat log..
ClearLastShipLoadout
Definition:
ClearLastShipLoadout() -> nil
Description:
clear last shiploadout. prevents client from asking to rebuy ship after destruction
ClearMissionChatLog
Definition:
ClearMissionChatLog() -> nil
Description:
clears mission log..
ClearProximityCache
Definition:
ClearProximityCache() -> nil
Description:
Clear list of characters in proximity range. Stops CheckCharProximity and CheckProximityWarning from ignoring them.
ClearStationChatLog
Definition:
ClearStationChatLog() -> nil
Description:
clears station log (bar)..
ConfigureMultipleWeaponGroups
Definition:
ConfigureMultipleWeaponGroups({table group1key1, table group1key2 ... table group1key6, table group2key1, table group2key2...}, function cb) -> nil
Description:
configures weapon groups according to given tables.
Arguments:
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.
cb function to call on completition (optional)
Example:
<source lang=lua>
-- enable port 1 for the primary trigger and port 2 for the secondary
-- index 1 is the power cell port
ConfigureMultipleWeaponGroups{[1]={nil, true, nil}, [2]={nil, nil, true}}
</source>
ConfigureWeaponGroup
Definition:
ConfigureWeaponGroup(int id, table port_ids, function cb) -> nil
Description:
Configures one weapon group
Arguments:
id is number of group. 0-5 primary, 6-11 secondary and 12-17 tertiary trigger
ports_ids is list of ports active for that group (2-numweaponports)
cb function to call on completition (optional)
Example:
<source lang=lua>
-- enable port 1 and 2 for the primary trigger
ConfigureWeaponGroup(0, {2,3})
</source>
ConnectAddon
Definition:
ConnectAddon(int portid, int itemid, function cb) -> bool canconnect
Description:
Attaches the addon itemid to the active ship in port portid
Arguments:
portid portid of the the port
itemid itemid of the addon
cb function to call on completition (optional)
Returns:
canconnect returns true if the player is docked and has an active ship otherwise nil
Example:
<source lang="lua">
-- put the addon 123 into port 2 while the player is docked to a station
ConnectAddon(2, 123) -> true
</source>
CreateBig3DViewMenu
Definition:
CreateBig3DViewMenu() -> userdata dialog
Description:
Create Big3DViewDialog a Big3DViewDialog
Returns:
dialog Big3DViewDialog
CreateCancelLoadoutMenu
Definition:
CreateCancelLoadoutMenu() -> userdata dialog
Description:
Create fullscreen dialog with button and message. See MessageDialog
Returns:
dialog MessageDialog
CreateCapShipChatTab
Definition:
CreateCapShipChatTab() -> userdata box
Description:
Create box with "Ship Com" tab. See ChatLogTemplate
Returns:
box box with "Ship Com" tab
CreateCapShipFactionInfo
Definition:
CreateCapShipFactionInfo() -> userdata box
Returns:
box CapShipFactionInfo
CreateCapShipPDATab
Definition:
CreateCapShipPDATab() -> userdata box
Returns:
box CapShipTabPDA
CreateCapShipRepairTab
Definition:
CreateCapShipRepairTab() -> userdata box
Returns:
box CapShipRepairTab
CreateCapShipTacticalTab
Definition:
CreateCapShipTacticalTab() -> userdata box
Returns:
box CapShipTacticalTab
CreateCapShipTurretTab
Definition:
CreateCapShipTurretTab() -> userdata box, button
Description:
Create CapShipTurretTab and the select button
Returns:
box CapShipTurretTab
button select button
CreateCharCreateFailedMenu
Definition:
CreateCharCreateFailedMenu() -> userdata dialog
Description:
Create fullscreen dialog with button and message. See MessageDialog
The created variant pops up CharCreateDialog after clicking the button
Returns:
dialog MessageDialog
CreateCharCreateMenu
Definition:
CreateCharCreateMenu() -> userdata dialog
Returns:
dialog CharCreateDialog
CreateCharSelectFailedMenu
Definition:
CreateCharSelectFailedMenu() -> userdata dialog
Description:
Create fullscreen dialog with button and message. See MessageDialog
The created variant pops up CharSelectDialog after clicking the button
Returns:
dialog MessageDialog
CreateCharSelectMenu
Definition:
CreateCharSelectMenu() -> userdata dialog
Returns:
dialog CharSelectDialog
CreateCharacter
Definition:
CreateCharacter(int name, int nation) -> nil
Description:
Creates the character of the given nation
Arguments:
name name of character
nation nation of character
CreateCharacterPDATab
Definition:
CreateCharacterPDATab() -> userdata box, tab1, tab2, tab3
Returns:
box PDACharacterTab
tab1 PDACharacterStatsTab
tab2 PDACharacterFactionTab
tab3 PDACharacterAccomTab
CreateCommPDATab
Definition:
CreateCommPDATab() -> userdata box
Returns:
box PDACommTab
CreateConnectingMenu
Definition:
CreateConnectingMenu() -> userdata dialog
Description:
Create fullscreen dialog with button and message. See MessageDialog
The created variant logs out after clicking the button
Returns:
dialog MessageDialog
CreateCreditsDialog
Definition:
CreateCreditsDialog(userdata parent) -> userdata dialog
Description:
Create credits dialog
Arguments:
parent dialog to show on clicking "Close"
Returns:
dialog credits dialog
CreateEULAMenu
Definition:
CreateEULAMenu() -> userdata dialog
Returns:
dialog EULADialog
CreateInvalidAmountMenu
Definition:
CreateInvalidAmountMenu() -> userdata dialog
Description:
Create fullscreen dialog with button and message. See msgdlgtemplate1
Returns:
dialog msgdlgtemplate1
CreateInventoryPDATab
Definition:
CreateInventoryPDATab() -> userdata dialog, tab1, tab2
Returns:
dialog PDAInventoryTab
tab1 PDAInventoryInventoryTab
tab2 PDAInventoryJettisonTab
CreateKilledByPDATab
Definition:
CreateKilledByPDATab() -> userdata box
Returns:
dialog KilledByPDATab
CreateKilledPDATab
Definition:
CreateKilledPDATab() -> userdata box
Returns:
box KilledPDATab
CreateLoadingMenu
Definition:
CreateLoadingMenu() -> userdata dialog
Returns:
dialog LoadingDialog
CreateLoginDialog
Definition:
CreateLoginDialog() -> userdata dialog
Returns:
dialog LoginDialog
CreateLoginHelpDialog
Definition:
CreateLoginHelpDialog(userdata parent) -> userdata dialog
Description:
Create fullscreen dialog with help text for the login screen and a close button
Arguments:
parent dialog to show on clicking close
Returns:
dialog login help dialog
CreateLowGridPowerDialog
Definition:
CreateLowGridPowerDialog() -> userdata dialog
Description:
Create fullscreen dialog with low grid power error
Returns:
dialog low grid power dialog
CreateMissionAbortMenu
Definition:
CreateMissionAbortMenu() -> userdata dialog
Returns:
dialog MissionAbortDialog
CreateMissionPromptMenu
Definition:
CreateMissionPromptMenu() -> userdata dialog
Returns:
dialog MissionPromptDialog
CreateMissionsPDATab
Definition:
CreateMissionsPDATab() -> userdata box, tab1, tab2, tab3, tab4, infobutton
Returns:
box PDAMissionsTab
tab1 PDAMissionNotesTab
tab2 PDAMissionAdvancementTab
tab3 PDAMissionLogTab
tab4 PDAMissionBoardTab
infobutton PDAMissionBoardTabInfoButton
Definition:
CreateNavigationPDATab() -> userdata box
Returns:
box PDAShipNavigationTab
CreateNearbyShipsPDATab
Definition:
CreateNearbyShipsPDATab() -> userdata box
Returns:
box PDASensorNearbyTab
CreateNewsMenu
Definition:
CreateNewsMenu() -> userdata dialog
Returns:
dialog NewsDialog
CreateNotEnoughStorageMenu
Definition:
CreateNotEnoughStorageMenu() -> userdata dialog
Description:
Create fullscreen dialog with button and message. See msgdlgtemplate1
Returns:
dialog msgdlgtemplate1
CreateNotificationMenu
Definition:
CreateNotificationMenu() -> userdata dialog
Returns:
dialog NotificationDialog
CreateOptionsMenu
Definition:
CreateOptionsMenu() -> userdata dialog
Returns:
dialog OptionsDialog
CreatePDA
Definition:
CreatePDA() -> userdata dialog
Returns:
dialog PDADialog
CreatePDATab1
Definition:
CreatePDATab1() -> userdata box
Returns:
box PDATab1
CreatePVPTab
Definition:
CreatePVPTab() -> userdata box
Returns:
box PVPTab
CreateQuantityPurchaseMenu
Definition:
CreateQuantityPurchaseMenu() -> userdata dialog
Returns:
dialog API_Index#SellItemDialog
CreateSensorPDATab
Definition:
CreateSensorPDATab() -> userdata box, tab1, tab2, tab3, tab4, tab5
Returns:
box PDASensorTab
tab1 PDASensorNearbyTab
tab2 PDAKilledTab
tab3 PDAKilledByTab
tab4 PDAStationVisitsTab
tab5 PVPTab
CreateShipCargoPDATab
Definition:
CreateShipCargoPDATab() -> userdata box
Returns:
box PDAInventoryJettisonTab
CreateShipPDATab
Definition:
CreateShipPDATab() -> userdata box, tab1
Returns:
box PDAShipTab
tab1 PDAShipNavigationTab
CreateStation
Definition:
CreateStation() -> userdata dialog
Returns:
dialog StationDialog
CreateStationBlankTab
Definition:
CreateStationBlankTab() -> userdata box
Returns:
box StationBlankTab
CreateStationChatTab
Definition:
CreateStationChatTab() -> userdata box
Returns:
box StationChatTab
CreateStationCommerceTab
Definition:
CreateStationCommerceTab() -> userdata box
Returns:
box StationCommerceTab
CreateStationCommoditiesBuyTab
Definition:
CreateStationCommoditiesBuyTab() -> userdata box
Returns:
box StationCommoditiesBuyTab
CreateStationCommoditiesLoadTab
Definition:
CreateStationCommoditiesLoadTab() -> userdata box
Returns:
box StationCommoditiesLoadTab
CreateStationCommoditiesSellTab
Definition:
CreateStationCommoditiesSellTab() -> userdata box
Returns:
box StationCommoditiesSellTab
CreateStationCommoditiesTab
Definition:
CreateStationCommoditiesTab() -> userdata box
Returns:
box StationCommerceCommoditiesTab
CreateStationEquipmentBuyTab
Definition:
CreateStationEquipmentBuyTab() -> userdata box
Returns:
box StationEquipmentBuyTab
CreateStationEquipmentManageTab
Definition:
CreateStationEquipmentManageTab() -> userdata box
Returns:
box StationEquipmentManageTab
CreateStationEquipmentSellTab
Definition:
CreateStationEquipmentSellTab() -> userdata box
Description:
Unused. Creates old equipment sell tab.
Returns:
box OldStationEquipmentSellTab
CreateStationEquipmentTab
Definition:
CreateStationEquipmentTab() -> userdata box
Returns:
box StationEquipmentTab
CreateStationFactionInfo
Definition:
CreateStationFactionInfo() -> userdata dialog
Description:
Create StationFactionInfo
Returns:
dialog StationFactionInfo
CreateStationHelpMenu
Definition:
CreateStationHelpMenu() -> userdata dialog
Returns:
dialog StationHelpDialog
CreateStationMissionBuyTab
Definition:
CreateStationMissionBuyTab() -> userdata box, button
Returns:
box PDAMissionBoardTab
button info button in box
CreateStationPDATab
Definition:
CreateStationPDATab() -> userdata box
Returns:
box StationTabPDA
CreateStationPortConfigTab
Definition:
CreateStationPortConfigTab() -> userdata box
Returns:
box StationEquipmentManagePortConfigTab
CreateStationShipPurchaseTab
Definition:
CreateStationShipPurchaseTab() -> userdata box, button
Returns:
box StationEquipmentBuyShipTab
button buy button in box
CreateStationShipSelectionTab
Definition:
CreateStationShipSelectionTab() -> userdata box
Returns:
box StationEquipmentManageShipSelectionTab
CreateStationShipStatusTab
Definition:
CreateStationShipStatusTab() -> userdata box
Description:
Unused. Creates old ship status tab.
Returns:
box StationEquipmentManageShipStatusTab
CreateStationVisitsPDATab
Definition:
CreateStationVisitsPDATab() -> userdata box
Returns:
box StationVisitsTab
CreateStationWelcomeTab
Definition:
CreateStationWelcomeTab() -> userdata box
Returns:
box StationCommerceWelcomeTab
CreateStorageRentalDialog
Definition:
CreateStorageRentalDialog() -> userdata dialog
Description:
Create storage rental dialog
Returns:
dialog StorageRentalDialog
CreateSurveyMenu
Definition:
CreateSurveyMenu() -> userdata dialog
Returns:
dialog SurveyDialog
CreateTargetInfo
Definition:
CreateTargetInfo() -> userdata box
Returns:
box PDATargetInfo
CreateVoiceChatOptions
Definition:
CreateVoiceChatOptions() -> userdata dialog
Description:
Create Voicechat options dialog
Returns:
dialog VoiceChatOptions
DeleteCharacter
Definition:
DeleteCharacter(int slot) -> nil
Description:
Deletes the character in the character slot slot
Arguments:
slot which character to delete
DisableProximityWarning
Definition:
DisableProximityWarning() -> nil
Description:
disable the proximity warning ...
DisconnectAddon
Definition:
DisconnectAddon(int itemid) -> bool ret1
Description:
detaches the addon itemid and stores it in the station
Note: detached items will likely have a different itemid in the station
Arguments:
itemid id of the item to detach
Returns:
ret1 returns true if the player is docked and has an active ship otherwise nil
Example:
<source lang="lua">DisconnectAddon(123) -> true</source>
remove the item 123 from the active ship while the player is docked to a station
DisconnectAllAddons
Definition:
DisconnectAllAddons() -> nil
Description:
Detach all addons from the active ship and store them in the current station
EnableProximityWarning
Definition:
DisableProximityWarning() -> nil
Description:
enable the proximity warning ...
EnableVoiceChat
Definition:
EnableVoiceChat(bool enable) -> nil
Description:
Toggle Voice chat
Arguments:
enable enable voice chat if true
FactionStandingTemplate
Definition:
FactionStandingTemplate(function cb, frame, filler, string expand) -> userdata container
Description:
Creates a container with a list of faction standings of a character. Details: FactionStandingTemplate
Arguments:
cb called on clicking an item in the list. factionid of selected item is passed to it
frame iup.*frame function
filler iup.*filler function
expand iup expand parameter that is applied to the container
Returns:
container FactionStandingTemplate
FactionStandingWithInfoTemplate
Definition:
FactionStandingWithInfoTemplate() -> userdata container
Description:
Wrapper around FactionStandingTemplate that adds faction descriptions to the list.
Returns:
container FactionStandingWithInfoTemplate
FadeControl
Definition:
FadeControl(userdata control, int timetofade, float startalpha, endalpha, function cb, ...) -> nil
Description:
Fade an iup control by modifying its alpha field. Usually a label.
Arguments:
control iup control to fade
timetofade time to fade in seconds
startalpha alpha value before fading (0-1)
endalpha alpha value after fading(0-1)
cb function to call when done
... arguments to pass to cb
Example:
<source lang="lua">
-- shows a dialog with a label that will fade away on clicking "Fade"
-- clicking on "Stop" interrupts the process
local d, label, fadebutton, stopbutton label = iup.label{title="Fade me!"}
local function fadebutton_cb() local function fade_cb() label.alpha = "255" -- reset the alpha when done end FadeControl(label, 5, 1, 0, fade_cb) -- fade for 5 seconds from full to zero alpha end
local function stopbutton_cb()
local fadeinfo = FadeLookup(label) -- get the fade info table for the label
if fadeinfo then -- check if the control is still being faded print("Fading was stopped after "..tostring(fadeinfo.counter).." seconds") -- print elapsed time end
FadeStop(label) -- interrupt fading label.alpha = "255" -- reset alpha end
fadebutton = iup.button{title="Fade", action=fadebutton_cb}
stopbutton = iup.button{title="Stop", action=stopbutton_cb}
d = iup.dialog{iup.vbox{label, fadebutton, stopbutton}}
d:show()
</source>
FadeLookup
Definition:
FadeLookup(userdata control) -> table fi
Description:
Get a fade info table of a control that is currently being faded.
Arguments:
control faded iup control
Returns
fi fade info table or nil if the given control isn't currently being faded
fi.timetofade time to fade in seconds
fi.startalpha alpha value before fading (0-1)
fi.endalpha alpha value after fading(0-1)
fi.endfunc function to call when done
fi.endfuncargs table with arguments for fi.endfunc
fi.counter elapsed fade time
fi.control control that is being faded
Example:
see Fadecontrol
FadeStop
Definition:
FadeStop(userdata control) -> nil
Description:
Stop fading a control
Arguments:
control control that is being faded
Example:
see Fadecontrol
FillInObjectInfo
Definition:
FillInObjectInfo(string name, desc) -> nil
Description:
Put given name and description into the character info dialog
Arguments:
name object name
desc object description
FillInPlayerInfo
Definition:
FillInPlayerInfo(int charid) -> nil
Description:
Fill character info dialog with info of given character
Arguments:
charid charid
FindAndReplaceTags
Definition:
FindAndReplaceTags(string text, table matches) -> string ret1
Description:
Replaces all occurances of with < and > enclosed substrings in text with matching values from the provided table
Arguments:
test string to replace tags in
matches table with tags/replacement pairs
Returns:
ret1: converted text
Example:
<source lang="lua">FindAndReplaceTags("hi this is a
linebreak", {br="\n"})
-> "hi this is a
linebreak"</source>
FindAndReplaceTagsCB
Definition:
FindAndReplaceTagsCB(string text, function cb) -> string ret1
Description:
Pass each occurances of with < and > enclosed substrings in text to cb and replace them with the return value
Arguments:
test string to replace tags in
cb called with the content of each tag as argument
Returns:
ret1: converted text
Example:
<source lang="lua">
local function find_cb(t)
if t == "br" then
return "\n"
end
end
FindAndReplaceTags("hi this is a
linebreak", find_cb)
-> "hi this is a
linebreak"</source>
ForEachBuddy
Definition:
ForEachBuddy(function func(string name, bool isonline, int sectorid)) -> nil
Description:
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
Arguments:
func gets called for each buddy
name name of the buddy
isonline true if the player is online else false
sectorid location of player as sectorid
Example:
<source lang="lua">ForEachBuddy(function (name, isonline, pos) print(name .." "..tostring(isonline).." "..tostring(pos)) end)</source>
prints a list with your buddies and their status
ForEachPlayer
Definition:
ForEachPlayer(function func(int charid)) -> nil
Description:
calls func with the character id of each player in the sector. that includes bots and the sector thingy itself
This function is called by the toplist when you open it.
Arguments:
func gets called for each buddy
ncharid character id
Example:
<source lang="lua">ForEachPlayer(function (id) print(id) end)</source>
prints a list with all players in the sector
ForgiveKiller
Definition:
ForgiveKiller(bool forgive) -> nil
Description:
Forgive the last killer.
Arguments:
forgive if true forgive the last killer if not don't
GeneratePlayerDiedMessage
Definition:
GeneratePlayerDiedMessage(string name1, name2, int weapon) -> string msg
Description:
generate appropiate kill message for the arguments.
Arguments:
name1 character that died
name2 character that killed name1
weapon weaponid of weapon with which the kill was made(?)
Returns:
msg kill message
Example:
<source lang="lua">
GeneratePlayerDiedMessage("foo", "bar", 0) -> "bar destroyed foo"
GeneratePlayerDiedMessage("foo", "foo", 0) -> "foo is having issues"
</source>
GetAccomplishmentBigSize
Definition:
GetAccomplishmentBigSize(int type, level) -> string bigsize
Description:
Get size of accomplishment medal
Arguments:
type accomplishment type
level accomplishment level
Returns:
bigsize iup size string of medal
GetAccomplishmentBigTexture
Definition:
GetAccomplishmentBigTexture(int type, level) -> string tex
Description:
Get texture of accomplishment medal
Arguments:
type accomplishment type
level accomplishment level
Returns:
tex filename of medal texture
GetAccomplishmentBigUV
Definition:
GetAccomplishmentBigUV(int type, level) -> string uv
Description:
Get uv mapping of accomplishment medal
Arguments:
type accomplishment type
level accomplishment level
Returns:
uv iup uv mapping of medal texture
GetAccomplishmentCategory
Definition:
GetAccomplishmentCategory(int type, level) -> string category
Description:
Get category of accomplishment
Arguments:
type accomplishment type
level accomplishment level
Returns:
category accomplishment category
GetAccomplishmentDescription
Definition:
GetAccomplishmentDescription(int type, level) -> string desc
Description:
Get description of accomplishment
Arguments:
type accomplishment type
level accomplishment level
Returns:
desc accomplishment description
GetAccomplishmentLevels
Definition:
GetAccomplishmentLevels(int accomid) -> int curlevel int reqlevel
Description:
returns the current and the required level for the selected accomplishment
Arguments:
accomid id of the accomplishment
Returns:
curlevel current level of the accomplishment
reqlevel what is required to get the accomplishment
Example:
<source lang="lua">GetAccomplishmentLevels(9) -> 34 50</source>
assuming 9 is buskills this player has 34 kills of the 50 required
GetAccomplishmentName
Definition:
GetAccomplishmentName(int type, level) -> string name
Description:
Get name of accomplishment
Arguments:
type accomplishment type
level accomplishment level
Returns:
name name of accomplishment
GetAccomplishmentSize
Definition:
GetAccomplishmentSize(int type, level) -> string size
Description:
Get size of accomplishment badge
Arguments:
type accomplishment type
level accomplishment level
Returns:
size iup size of badge
GetAccomplishmentTexture
Definition:
GetAccomplishmentTexture(int type, level) -> string tex
Description:
Get texture of accomplishment badge
Arguments:
type accomplishment type
level accomplishment level
Returns:
tex filename of badge texture
GetAccomplishmentTitle
Definition:
GetAccomplishmentTitle(int type, level) -> string title
Description:
Get title of accomplishment
Arguments:
type accomplishment type
level accomplishment level
Returns:
title accomplishment title
GetAccomplishmentType
Definition:
GetAccomplishmentType(int accomindex, char) -> int accomplishmenttype int accomplishmentlevel
Description:
returns some numbers..
Arguments:
accomindex index of the accomplishment
char charid of character whose accomplishment to look up
Returns:
accomplishmenttype type of accomplishment
accomplishmentlevel what level the accomplishment is, starting at 1.
Example:
<source lang="lua">local accomtype, accomlevel = GetAccomplishmentType(accomindex)
local description = GetAccomplishmentDescription(accomtype, accomlevel)</source>
GetAccomplishmentUV
Definition:
GetAccomplishmentUV(int type, level) -> string uv
Description:
Get uv mapping of accomplishment badge
Arguments:
type accomplishment type
level accomplishment level
Returns:
uv iup uv mapping of badge
GetActiveChatChannel
Definition:
GetActiveChatChannel() -> int channel
Description:
returns the active channel
Returns:
channel active chat channel
Example:
<source lang="lua">GetActiveChatChannel() -> 1</source>
you are currently in channel 1
GetActiveMissionInfo
Definition:
GetActiveMissionInfo(int num) -> string mname table mmsg int itemid
Description:
Get information about the selcted active mission
Arguments:
num index of active mission (always 1)
Returns:
mname string containing name of active mission
mmsg array where each index contains a mission log entry + optional interface elements and their properties
itemid itemid of the mission
Example:
<source lang="lua">GetActiveMissionInfo(1) -> "awesome mission" {1={"awesome mission question" 2={0="button" 1="awesome button text" action=1}}} 1234</source>
The active mission is called "awesome mission" and the first mission log entry contains the text "awesome mission question" with a button labaled "awesome button text" which triggers the action 1. item id for this mission is 1234
GetActiveShipCargoCount
Definition:
GetActiveShipCargoCount() -> int cargocount
Description:
returns amount of cargo in the ship
Returns:
cargocount amount of cargo in the ship
GetActiveShipEnergy
Definition:
GetActiveShipEnergy() -> float eng fraction
Description:
returns the energy level of the active ship
Returns:
eng energy level in game units 0 .. maxcapacacity
fraction energy level as float from 0.0-1.0
Example:
<source lang="lua">GetActiveShipEnergy() -> 150.0 0.5</source>
the battery of this ship is half empty and has a capacity of 300
GetActiveShipHealth
Definition:
GetActiveShipHealth() -> int d1 d2 d3 d4 d5 d6 dmg max
Description:
returns information about the active ships health
Returns:
d? damage to subsection 0 = no damage
dmg accumulated damage of subsections
max max health of ship
Example:
<source lang="lua">GetActiveShipHealth() -> 500 10 10 0 0 0 520 10000</source>
ship has 500 damagei n frontal region 520 dmg overall and a max health of 10000
GetActiveShipGridPowerAndUsage
Definition:
GetActiveShipGridPowerAndUsage() -> int power usage
Description:
returns the energy grid power and usage of the current ship..
Returns:
power energy grid power
fraction power usage
Example:
<source lang="lua">GetActiveShipGridPowerAndUsage() -> 20 12</source>
the ships power grid has a capacity of 20 and 12 are currently used
GetActiveShipID
Definition:
GetActiveShipID() -> int itemid
Description:
returns itemid of active ship
Returns:
itemid item id of active ship
GetActiveShipItemIDAtPort
Definition:
GetActiveShipItemIDAtPort(int portid) -> int itemid
Description:
returns itemid of addon in selected port
Arguments:
portid portid
Returns:
itemid itemid of addon in port
Example:
<source lang="lua">GetActiveShipItemIDAtPort(1) -> 1234</source>
addon in port 1 has itemid 1234
GetActiveShipMass
Definition:
GetActiveShipMass() -> int mass
Description:
returns mass of active ship
Returns:
mass mass of active ship
Example:
<source lang="lua">GetActiveShipMAss() -> 15.0000</source>
ship weights 15000kg
GetActiveShipMaxCargo
Definition:
GetActiveShipMaxCargo() -> int cargo
Description:
returns amount of cargo space of the active ship in cu
Returns:
cargo cargospace
GetActiveShipMaxSpeed
Definition:
GetActiveShipMaxSpeed() -> int speed
Description:
returns max nonturbo speed of active ship
Returns:
speed ...
GetActiveShipName
Definition:
GetActiveShipName() -> string name
Description:
returns a string with the active ships name
Returns:
name ...
GetActiveShipNumAddonPorts
Definition:
GetActiveShipNumAddonPorts() -> int ports
Description:
returns number of ports in active ship
Returns:
ports number of ports, including engine and battery
Example:
<source lang="lua">GetActiveShipNumAddonPorts() -> 4</source>
this ship has 3 ports
GetActiveShipPortIDOfItem
Definition:
GetActiveShipPortIDOfItem(int itemid) -> int portid
Description:
returns portid of the given addon in active ship
Arguments:
itemid itemid of an addon
Returns:
portid portid of port the addon is in or nil if addon is not on the ship or invalid
Example:
<source lang="lua">GetActiveShipPortIDOfItem(1234) -> 3</source>
GetActiveShipPortInfo
Definition:
GetActiveShipPortInfo(int portid) -> table portinfo
Description:
returns information about the given port
Arguments:
portid portid
Returns:
portinfo table with port info
fields include:
type: int holding the type of port
name string describing port
position: vector with port position on ship
orientation: quaternion holding orientation of port
Example:
<source lang="lua">GetActiveShipPortInfo(1) -> {type=4 name="PowerCell" position=(0, 0, 0) orientation=(0.000 0.000 0.000 1.000)}</source>
portinfo of a ragnaroks battery port
GetActiveShipSelectedWeaponGroupIDs
Definition:
GetActiveShipSelectedWeaponGroupIDs() -> int id1 id2 id3
Description:
returns ids of the selected weapon groups ...
Returns:
id? id's of weapon groups. Probably mapping to those key buttons.
Example:
<source lang="lua">GetActiveShipSelectedWeaponGroupIDs() -> 0 6 12</source>
default mapping
GetActiveShipSpeed
Definition:
GetActiveShipSpeed() -> int speed
Description:
returns current speed of active ship
Returns:
speed ...
GetActiveShipWeaponGroup
Definition:
GetActiveShipWeaponGroup(int id) -> table group
Description:
return which ports are enabled in the provided group
Arguments:
id id of weapon group correspondents to group key[0-5] + (trigger group[0-2] * 6)
Returns:
port table where the indexes are the port ids and values bools that are true when the port is active
Example:
<source lang="lua">GetActiveShipWeaponGroup(6) -> {2=true 3=true}</source>
6 -> 6 % 6 = 1 R 0 thus 6 represents first group key and and second trigger group. port 2 and 3 are active for example this could be the 2 s ports on a vult
GetAddonItemInfo
Definition:
GetAddonItemInfo(int itemid) -> int current maximum
Description:
Returns current and maximum ammo if itemid is a weapon with ammo, or current/maximum armor if itemid is a ship.
Arguments:
itemid itemid of an addon or ship.
Returns:
current Current ammo/armor, or -1.
maximum Maximum ammo/armor, or -1.
GetAvailableMissionInfo
Definition:
GetAvailableMissionInfo(int midx) -> {int itemtype, string name, bool active, int category, string icon, string desc}
Description:
Returns information about the mission with the given index.
Arguments:
midx index of mission in missionlist (1 based)
Returns:
itemtype no idea
name name of mission
active is this mission active
category mission category
icon path to icon
desc mission description
GetBarPatrons
Definition:
GetBarPatrons() -> {[charid1], [charid2]...}
Description:
get people in the current station bar
Returns:
charid? index of returned table are charids of characters in the bar
GetBestPriceInfoOfItem
Definition:
GetBestPriceInfoOfItem(int item) -> int price, station
Description:
Get highest sell price of a cargo item in the active ship in the currentsystem
Arguments:
item itemid of cargo item
Returns:
price highest price in system
station locationid of station with highest price
Example:
<source lang="lua">
-- print best prices in system for all cargo items in the ship
for _,item in ipairs(GetShipInventory(GetActiveShipID()).cargo) do
local price, station = GetBestPriceInfoOfItem(item)
print(GetInventoryItemName(item).." "..tostring(price).."c at "..LocationStr(math.floor(station / 100)))
end
</source>
GetBotSightedInfoForSector
Definition:
GetBotSightedInfoForSector(int sectorid) -> string botinfo
Description:
returns bot ihnfo text for the given sector
Arguments:
sectorid sectorid
Returns:
botinfo string with bots in given sector or an empty string
GetBuddyInfo
Definition:
GetBuddyInfo(int char) -> string name, bool isonline, int sectorid
Description:
Get name, online status and location of a buddy
Arguments:
char charid of a buddy
Returns:
name name of buddy
isonline online status
sectorid sectorid of location of buddy
GetCargoValue
Definition:
GetCargoValue() -> int value, price
Description:
Get value and buy price of the cargo and equipped addons on the active ship at the current station
Returns:
value value of cargo and addons
price buy price of cargo and addons at the current station
GetCharacterDescription
Definition:
GetCharacterDescription(int charid) -> string desc
Description:
Get the character description of a character
Arguments:
charid charid of a character
Returns:
desc character description
GetCharacterID
Definition:
GetCharacterID(int nodeid) -> int charid
Description:
returns character id of the provided node id
Arguments:
nodeid node id of one of the characters in the sector
Returns:
charid character id of the given node if a valid nodeid is valid otherwise the players charid
GetCharacterIDByName
Definition:
GetCharacterIDByName(string name) -> int charid
Description:
get character id by name
Arguments:
name name of a character
Returns:
charid a character id or nil
GetCharacterInfo
Definition:
GetCharacterInfo(int cslot) -> string name faction int money kills deaths loc home cl ll hl tl ml
Description:
Get information about your characters
Arguments:
cslot a character slot (1-6)
Returns:
name
faction
money
kills all kills
deaths
loc sectorid of current location
home sectorid of characters homestation
cl combat level
ll light weapon level
hl heavy weapon level
tl trade level
ml mining level
Example:
<source lang="lua">GetCharacterInfo(1) -> "Dude" "Corvus" 10000 10 100 4444 4444 1 1 1 0 0
</source>
This players first character is called "Dude" is of the "Corvus" faction has 10000c killed 10 things died 100 times is in sector 4444, homed in 4444 and has level 1/1/1/0/0
GetCharacterKillDeaths
Definition:
GetCharacterKillDeaths(int charid) -> int kills deaths pks
Description:
get info about kills and deaths. returns your own info if no charid given or a lua error if an invalid one ...
Arguments:
charid character id or nil
Returns:
kills total kills
deaths total deaths
pks player kills
GetChatLogReadState
Definition:
GetChatLogReadState() -> bool read
Description:
Tell if the general chat log was displayed. SetChatLogRead was called since the last line was added to the log.
Returns:
read true if the log was displayed
GetCurrentChatTab
Definition:
GetCurrentChatTab() -> int tab
Description:
Unused. Get The current chat tab (general chat or mission chat)
Returns:
tab 1 = general, 2 = mission
GetCurrentSectorid
Definition:
GetCurrentSectorid() -> int sectorid
Description:
get current sector id
Returns:
sectorid sectorid of current sector
GetCurrentStationType
Definition:
GetCurrentStationType() -> int type
Description:
return the current station type..
Returns:
type current station type. seems be usually 0 except when docked to a capship then 1
GetCurrentSystemid
Definition:
GetCurrentSystemid() -> int systemid
Description:
get current system id..
Returns:
systemid id of current system
GetEULA
Definition:
GetEULA() -> string eula
Description:
return eula
Returns:
eula string containing the eula
GetFactionInfo
Definition:
GetFactionInfo(int faction) -> string info
Description:
get faction info text for the provided faction
Arguments:
faction id of a faction
Returns:
info string containing faction info
GetFinishedMissionInfo
Definition:
GetFinishedMissionInfo() -> string name table msg int itemid
Description:
see GetActiveMissionInfo
GetFriendlyStatus
Definition:
GetFriendlyStatus(int char) -> int fstatus
Description:
get friendlyness of a character
Arguments:
char nodeid
Returns:
fstatus Returns 0 to 3. Target is friendly if 3, unfriendly otherwise
GetFullPath
Definition:
GetFullPath(int sector, table navroute) -> table fullpath
Description:
Get the full path, including wormhole sectors, from sector along navroute
Arguments:
sector sectorid of starting sectors
navroute list of sectorids
Returns:
fullpath navroute plus sectorids of wormhole sectors
Example:
<source lang="lua">
-- get full path from Sol a1 to betheshee a1 via sol b1
-- the function adds some duplicate entries
GetFullPath(1, {2, 257}) -> {1, 2, 2, 226, 351, 257}
</source>
GetGeneralChatLog
Definition:
GetGeneralChatLog() -> table log
Description:
returns the chatlog
Returns:
log table containing chatlog
GetGroupMemberID
Definition:
GetGroupMemberID(int index) -> int charid
Description:
get charid of group member with given index
Arguments:
index group member index (1-8)
Returns:
charid character id
GetGroupMemberLocation
Definition:
GetGroupMemberLocation(int charid) -> int loc
Description:
get location of a groupmember
Arguments:
charid character ids of a groupmember
Returns:
loc sectorid of groupmember or 0 for yourself
GetGroupOwnerID
Definition:
GetGroupOwnerID() -> int charid
Description:
get charid of group owner
Returns:
charid character id
GetGuildAcronym
Definition:
GetGuildAcronym() -> string acronym
Description:
get your guilds acronym
Returns:
acronym string containing guild acronym
GetGuildBalance
Definition:
GetGuildBalance() -> int balance
Description:
get amount of money in guild bank
Returns:
balance money in bank
GetGuildBankPrivileges
Definition:
GetGuildBankPrivileges() -> table deposit withdraw logview
Description:
get your guilds bank privileges as three tables. they contain the ranks carrying each privilege.
see [API_Index#Guild]
Returns:
deposit table with ranks that can deposit money
withdraw table with ranks that can withdraw money
logview table with ranks that can view the transfer log
GetGuildBankWithdrawalLimits
Definition:
GetGuildBankWithdrawalLimits() -> int ret1 ret2 ret3
Description:
get withdrawal limits? returns three numbers
Returns:
ret1
ret4
ret3
GetGuildMOTD
Definition:
GetGuildMOTD() -> string motd
Description:
get your guilds message of the day
Returns:
motd string containing the motd
GetGuildMemberInfo
Definition:
GetGuildMemberInfo(int index) -> int charid rank string name
Description:
get information about the guildmember of the given index
Arguments:
index index of online guildmembers 1-n
Returns:
charid character id
rank rank: 0=member, 1=lieutenant, 2=council member, 3=council member and lieutenant, 4=commander
name name of member
Example:
<source lang="lua">
for i=1,GetNumGuildMembers()do
local id, rank, name = GetGuildMemberInfo(i)
print("guild member: "..name)
end</source>
GetGuildMemberInfoByCharID
Definition:
GetGuildMemberInfoByCharID(int charid) -> int charid rank string name
Description:
get information about the guildmember
Arguments:
charid charid of online guildmember
Returns:
charid character id
rank rank: 0=member, 1=lieutenant, 2=council member, 3=council member and lieutenant, 4=commander
name name of member
Example:
<source lang="lua">local charid,rank,charname = GetGuildMemberInfoByCharID(GetCharacterID())</source>
GetGuildName
Definition:
GetGuildName() -> string name
Description:
get guild name
Returns:
name string containing guild name
GetGuildTag
Definition:
GetGuildTag(int charid) -> string tag
Description:
get guild tag of self or another character.
Arguments:
charid character id or nil to get self's guild tag.
Returns:
tag string containing guild tag or empty string if character not known or not in a guild.
Example:
local guildtag = GetGuildTag()
if guildtag ~= "" then
print('['..guildtag..'] You are a member of the guild '..(GetGuildName() or guildtag)..'\n')
else
print('Not a member of a guild.\n')
end</source>
GetHomeStation
Definition:
GetHomeStation() -> int sectorid
Description:
get sectorid of home station
Returns:
sectorid sectorid of home station
GetInventoryItemClassSubType
Definition:
GetInventoryItemClassSubType(int itemid) -> int subtype
Description:
get subclass of an item
Arguments:
itemid inventory item
Returns:
subtype sub type of item
known types:
0 = light weapon or ship
1 = heavy weapon
3 = engine
4 = battery
10 = trade goods
GetInventoryItemClassType
Definition:
GetInventoryItemClassType(int itemid) -> int type
Description:
get class of an item
Arguments:
itemid inventory item
Returns:
type class of item. you can use those CLASSTYPE_* constants to identify types
GetInventoryItemContainerID
Definition:
GetInventoryItemContainerID(int itemid) -> int container
Description:
get container of item
Arguments:
itemid inventory item
Returns:
container itemid of container of or null if it's not in one (a ship)
GetInventoryItemExtendedDesc
Definition:
GetInventoryItemExtendedDesc(int itemid) -> string desc
Description:
get description of item
Arguments:
itemid inventory item
Returns:
desc item description text.
GetInventoryItemIcon
Definition:
GetInventoryItemIcon(int itemid) -> string path
Description:
get path to icon of inventory item
Arguments:
itemid inventory item
Returns:
path path to icon
GetInventoryItemInfo
Definition:
GetInventoryItemInfo(int itemid) -> string ipath name int quant float mass string sdesc desc1 desc2 int container class subtype
Description:
get most info about inventory item
Arguments:
itemid inventory item
Returns:
ipath icon path
name name or item
quant amount of items
mass per item mass as float in tons
sdesc short description
desc1 long description
desc2 long description again, sometimes omitted don't know what's the difference
container itemid of container this item is in
class type of item (see GetInventoryItemClassType)
subtype subtype of item (see GetInventoryItemClassSubType)
GetInventoryItemLocation
Definition:
GetInventoryItemLocation(int itemid) -> int stationid
Description:
get location of an inventory item
Arguments:
itemid itemid of an inventory item
Returns:
stationid stationid or nil if itemid is invalid
Example:
<source lang="lua">ShortLocationStr(SplitStationID(GetInventoryItemLocation(1234))) -> "Dau L-10"</source>
get the stationid of the item 1234
get the sectorid part of that stationid
print out the sectors name
GetInventoryItemLongDesc
Definition:
GetInventoryItemLongDesc(int itemid) -> string desc
Description:
get long description of an inventory item
Arguments:
itemid itemid of an inventory item
Returns:
desc long description of an inventory item
Example:
<source lang="lua">GetInventoryItemLongDesc(1234) ->
"Damage: 1100|Velocity: 190m/s|Energy: 30/blast|Delay: 0.4s|Mass: 1000 kg| \
Volume (as cargo): 1 cu|Good auto-targeting||KC-Cannon housing with PR-11 plasma cells"</source>
GetInventoryItemMass
Definition:
GetInventoryItemMass(int itemid) -> float mass
Description:
get mass of inventory item
Arguments:
itemid inventory item
Returns:
path mass of item as float in tons
Example:
<source lang="lua">GetInventoryItemMass(1234) -> 4.000</source>
the mass of item 1234 is 4000kg
GetInventoryItemName
Definition:
GetInventoryItemName(int itemid) -> string name
Description:
get name of inventory item
Arguments:
itemid inventory item
Returns:
name name
GetInventoryItemQuantity
Definition:
GetInventoryItemQuantity(int itemid) -> int quant
Description:
get quantity of inventory item..
Arguments:
itemid inventory item
Returns:
quant quantity
GetInventoryItemType
Definition:
GetInventoryItemType(int itemid) -> int type
Description:
get item type
Arguments:
itemid inventory item
Returns:
type type
GetInventoryItemUnitCost
Definition:
GetInventoryItemUnitCost(int itemid) -> int cost
Description:
get price paid for the given item(?)
Arguments:
itemid itemid of an inventory item
Returns:
cost price of item
GetInventoryItemVolume
Definition:
GetInventoryItemVolume(int itemid) -> int volume
Description:
get per unit volume of item in cu
Arguments:
itemid itemid of an inventory item
Returns:
volume volume in cu
GetItemFullDesc
Definition:
GetItemFullDesc(table item) -> string desc
Description:
get full description of an inventory item
Arguments:
item iteminfo table
Returns:
desc full description of item
GetItemPartialDesc
Definition:
GetItemPartialDesc(table item) -> string desc
Description:
get partial description of an inventory item
Arguments:
item iteminfo table
Returns:
desc partial description of item
GetLastAggressor
Definition:
GetLastAggressor(int itemid) -> int nodeid ret1
Description:
get node id of last aggressor and some number
Returns:
nodeid node id of last aggressor
ret1 no clue
GetJoinedChannels
Definition:
GetJoinedChannels() -> table channels
Description:
get array with currently joined channels
Returns:
channels array with joined channels
GetLastPrivateSpeaker
Definition:
GetLastPrivateSpeaker(int itemid) -> string name
Description:
get name of last character that pmed you
Returns:
name last messager
GetLastShipLoadout
Definition:
GetLastShipLoadout() -> {groups = {1 = group1 .. 18 = group18}, int ship, ports= {1 = port1 ..}, int shipcolor}
Description:
get last ship loadout, color and weapon groups. this function only works in space
Returns:
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(?)
GetLastShipLoadoutPurchaseCost
Definition:
GetLastShipLoadoutPurchaseCost() -> int cost
Description:
what you payed for your last ship(?)
Returns:
cost
GetLicenseLevel
Definition:
GetLicenseLevel(int type) -> int level
Description:
get the level of the provided license
Arguments:
type type of license (1-5)
Returns:
level license level or 0 if invalid type given
GetLicenseRequirement
Definition:
GetLicenseRequirement(int level) -> int xp
Description:
get xp required for given level
Arguments:
level license level
Returns:
xp
GetListOfSeenNames
Definition:
GetListOfSeenNames() -> table names
Description:
get table with names of characters that have been in the same sector as the player or have sent messages
Returns:
names table with names of characters
GetMaxRadarDistance
Definition:
GetMaxRadarDistance() -> int dist
Description:
get current(?) max radar range
Returns:
dist max radar range
GetMinJumpDistance
Definition:
GetMinJumpDistance() -> int dist
Description:
get minimum distance from large objects to jump
Returns:
dist min jump distance
GetMissionChatLog
Definition:
GetMissionChatLog() -> {bool updated, string 1.. }
Description:
get advancement log
Returns:
1-n advancement log
updated no clue
GetMissionLogReadState
Definition:
GetMissiontLogReadState() -> bool read
Description:
Tell if the mission chat/advanmcement log was displayed. SetMissionLogRead was called since the last line was added to the log.
Returns:
read true if the log was displayed
GetMissionTimers
Definition:
GetMissionTimers() -> int time
Description:
get time left on the current mission. may have some functionality for multiple missions
Returns:
time time left on this timer in 1000th seconds
GetMoney
Definition:
GetMoney() -> int money
Description:
get how many credits you own
Returns:
money
GetNationKills
Definition:
GetNationKills(int nation) -> int kills
Description:
get number of player kills for the given nation
Arguments:
nation id of nation (1-3)
Returns:
kills number of player kills or 0 if invalid nation
GetNewsHeadline
Definition:
GetNewsHeadline(int index) -> string title int time ret1
Description:
get headline, post time and some number
Arguments:
index index of headline newest is 1
Returns:
title the headline
time post date in unix time
ret1 no clue, always 1
GetNumAccomplishments
Definition:
GetNumAccomplishments(int charid) -> int accomplishments
Description:
get number of accomplishments for the given character
Arguments:
charid charid of a character
Returns:
accomplishments number of accomplishments
GetNumActiveMissions
Definition:
GetNumActiveMissions() -> int missions
Description:
get number of active missions.
Returns:
missions number of active missions
GetNumAvailableMissions
Definition:
GetNumAvailableMissions() -> int missions
Description:
get number of available missions
Returns:
missions
GetNumCharacters
Definition:
GetNumCharacters() -> int chars
Description:
get number of characters you have defined
Returns:
chars
GetNumCompletedMissions
Definition:
GetNumCompletedMissions() -> int missions
Description:
get number of completed missions
Returns:
missions
GetNumFinishedMissions
Definition:
GetNumFinishedMissions() -> int missions
Description:
get number of finished missions. as displayed in the mission log panel
Returns:
missions
GetNumGroupMembers
Definition:
GetNumCharacters() -> int chars
Description:
get number of characters in your group
Returns:
chars number of characters in your group or 0 if player is not in group
GetNumGuildMembers
Definition:
GetNumGuildMembers() -> int numchars
Description:
get number of online guildmembers
Returns:
chars number of guildmembers currently online or 0 if player is not in a guild
Example:
<source lang="lua">
for i=1,GetNumGuildMembers() do
local id, rank, name = GetGuildMemberInfo(i)
print("member: "..name)
end</source>
GetNumNewsHeadlines
Definition:
GetNumNewsHeadlines() -> int num
Description:
get number of news headlines..
Returns:
num
GetNumStationDesiredItems
Definition:
GetNumStationDesiredItems() -> int num
Description:
Get number of items this station desires. The names of the items can then be fetched with GetStationDesiredItem.
Returns:
num The number of items the station wants.
Example:
<source lang="lua">
for i = 1, GetNumStationDesiredItems(), 1 do
print("This station wants: "..GetStationDesiredItem(i))
done
</source>
GetNumStationMerch
Definition:
GetNumStationMerch() -> int num
Description:
get number of addons, ships an cargo this station sells
Returns:
num
GetNumStationTurrets
Definition:
GetNumStationTurrets() -> int num
Description:
get number of turrets on this station or ship
Returns:
num number of turrets attached to this station or ship. 0 if not docked
GetNumTips
Definition:
GetNumTips() -> int num
Description:
get size of load screen tips pool
Returns:
num
GetParentHealth
Definition:
GetParentHealth() -> float ret1 ret2
Description:
get health of object this one is attached to (turret to capship). untested!
Returns:
ret1 health in percent(?)
ret2 health as float (1-0)(?)
GetPlayerDistance
Definition:
GetPlayerDistance(int charid) -> float distance
Description:
get distance to another character
Arguments:
charid character id of another character in this sector
Returns:
distance distance to character in m
GetPlayerFaction
Definition:
GetPlayerFaction(int charid) -> int factionid
Description:
get nation of a player
Arguments:
charid character id or nil
Returns:
factionid number representing the faction (1-13, 99)
GetPlayerFactionStanding
Definition:
GetPlayerFactionStanding(int factionid, charid) -> int standing
Description:
get a players standing with a faction
Arguments:
factionid a number representing a faction. Only 1 to 3 work for other players. factionid
charid charid of a player (in the current sector?). nil is equivalent of own id.
Returns:
standing number representing faction standing 0-65535, (0 in-game being -1000, 32768 in-game being 0 and 65535 being 1000 in-game)
Example:
If the player's Itani Faction Standing was 0:
<source lang="lua">print( GetPlayerFactionStanding(1) ) -> "32768"</source>
Or used in conjunction with GetPlayerFaction:
<source lang="lua">print( GetPlayerFactionStanding( GetPlayerFaction(charid) )
-> "Will return the players faction standing of the faction that charid belongs to." )</source>
GetPlayerHealth
Definition:
GetPlayerHealth(int charid) -> float health
Description:
get health of provided character
Arguments:
charid character id
Returns:
health health of character in percent or -1 if character is not in the current sector
GetPlayerName
Definition:
GetPlayerName(int charid) -> string name
Description:
get name of character
Arguments:
charid character id
Returns:
name
GetPlayerNodeID
Definition:
GetPlayerNodeID(int charid) -> int nodeid
Description:
get nodeid of a character in the sector
Arguments:
charid character id
Returns:
nodeid nodeid or nil if charid is invalid
GetPrimaryShipIDOfPlayer
Definition:
GetPrimaryShipIDOfPlayer(int charid) -> int shipid
Description:
get shipid of a character (= objectid?)
Arguments:
charid character id
Returns:
shipid
GetPrimaryShipNameOfPlayer
Definition:
GetPrimaryShipNameOfPlayer(int charid) -> string name
Description:
get ship name (type) of provided character
Arguments:
charid character id
Returns:
name
GetProfitColor
Definition:
GetProfitColor(int price, cost) -> string color
Description:
get color depending on the given prices
Arguments:
price sell price
cost buy price
Returns:
color iup color string
GetProfitHexColor
Definition:
GetProfitHexColor(int price, cost) -> string color
Description:
get color in hex format depending on the given prices
Arguments:
price sell price
cost buy price
Returns:
color hex color string. format: "rrggbb"
GetProximityWarningDistance
Definition:
GetProximityWarningDistance() -> int dist
Description:
get proxy warnign distance
Note: even returns the distance when proxy warning is disabled
Returns:
dist proxy distance.
GetSectorAlignment
Definition:
GetSectorAlignment() -> int alignment
Description:
returns the alignment of the current sector
Returns:
alignment int representing alignment of the current sector. see: FactionName
GetSectorMonitoredStatus
Definition:
GetSectorMonitoredStatus() -> int monitor
Description:
returns the monitor status of the current sector (Unmonitored, Guarded ...) see: FactionMonitor and FactionMonitorStr
Returns:
monitor monitor status
GetShipAmmoPrices
Definition:
GetShipAmmoPrices(int ship) -> table prices
Description:
get cost of ship ammo
Arguments:
ship itemid of a ship
Returns:
prices weapon itemid ammo price pairs
prices.allammoprice cost of reloading all weapons
prices.allammoquantity amoutn of ammo to reload
GetShipCargoCount
Definition:
GetShipCargoCount(int itemid) -> int num
Description:
get amount of cargo in the ship
Arguments:
itemid item id of a ship
Returns:
num amount of argo in ship in cu
GetShipInventory
Definition:
GetShipInventory(int itemid) -> {cargo = {int cargoitemid ..}, addons = {int addonitemid ..}}
Description:
get itemids of items attached to a ship
Arguments:
itemid item id of a ship
Returns:
cargo array with cargo items
addons array with addons
cargoitemid itemids of cargo items
addonitemid itemids of addons
GetShipList
Definition:
GetShipList() -> {int itemid ..}
Description:
get list of your ships in the current station. produces error when called outside station..
Returns:
itemid itemid of a ship
GetShipMaxCargo
Definition:
GetShipMaxCargo(int itemid) -> int cargo
Description:
get amount of cargo the given ship can hold
Arguments:
itemid itemid of a ship
Returns:
cargo cargo in cu
GetShipMeshInfo
Definition:
GetShipMeshInfo(int itemid) -> string id model int color
Description:
get mesh information about equipment in your inventory. if an invalid itemid is given the info about the current ship is returned
Arguments:
itemid itemid of one of your ships or nil
Returns:
id of the ship
model filename of the model(?)
color colorid of the item see ShipPalette
Example:
<source lang="lua">GetShipMeshInfo(1234) -> "ship_generic_behemoth" "gaf/ship_generic_behemoth.dfs" 166</source>
GetShipPortIDOfItem
Definition:
GetShipPortIDOfItem(int itemid1, int itemid2) -> int portid
Description:
get port of weapon in one of your ships
Arguments:
itemid1 itemid of one of your ships
itemid2 itemid of a weapon or nil
Returns:
portid port of a wweapon or first free port if itemid2 is nil
GetShipPurchaseColor
Definition:
GetShipPurchaseColor() -> int color
Description:
get selected color from the color picker
Returns:
colorid number representing color (0-255)
GetSkillLevel
Definition:
GetSkillLevel(int licenseid) -> int current next
Description:
get current and required xp for next level or provided skill
Arguments:
licenseid type of license (1-5)
Returns:
current current xp
next xp required for next level
GetSkirmishInfo
Definition:
GetSkirmishInfo() -> int crew1 crew2 init1 init2 string name1 name2 bool active
Description:
returns crew info for skirmish missions
Returns:
crew1 crew members left for side 1 (top bar)
crew2 crew members left for side 2 (bottom bar)
init1 initial crew strength for side 1
init2 initial crew strength for side 2
name1 name of side 1
name2 name of side 2
active true if mission active(?)
GetStationAddonList
Definition:
GetStationAddonList() -> {int itemid ..}
Description:
get array with your addons in the station hold
Returns:
itemid itemid of one of your addons
GetStationAmmoInfoByID
Definition:
GetStationAmmoByID(int itemid) -> {bool is_ammorepair, string type, int unitcost, int price, string longdesc, string desc, bool locallyproduced, int itemid, string icon}
Description:
get info about ammo based weapons in the station by item id
Arguments:
itemid itemid
GetStationCargoList
Definition:
GetStationCargoList() -> {int itemid ..}
Description:
get list of cargo items in the current station. produces error when called outside station..
Returns:
itemid itemid of a trade item
GetStationChatLog
Definition:
GetStationChatLog() -> {string msg ..}
Description:
get table with messages in the station chat
Returns:
msg chat message
GetStationCurrentCargo
Definition:
GetStationCurrentCargo() -> int cargo
Description:
get amount of cargo currently in this station. including cargo, equipment, ships ..
Returns:
cargo amount of cargo in cu
GetStationDesiredItem
Definition:
GetStationDesiredItem(int index) -> string ditem
Description:
Get the string name of an item that this station desires. The index ranges from 1 to GetNumStationDesiredItems().
Arguments:
index index in list of strings
Returns:
ditems desired item
GetStationFaction
Definition:
GetStationFaction(int stationid) -> int factionid
Description:
get faction of the given station
Arguments:
stationid stationid
Returns:
factionid factionid or 0 if stationid invalid
GetStationFactionAppraisalModifier
Definition:
GetStationFactionAppraisalModifier() -> float modifier
Description:
Returns a number that seems to affect the price of storage space. depends on faction standing or something
Returns:
modifier
GetStationLocation
Definition:
GetStationLocation() -> int stationid
Description:
get the stationid of the current station
Returns:
stationid stationid or nil if not docked to a station
GetStationLogReadState
Definition:
GetStationLogReadState() -> bool read
Description:
Tell if the stationlog/bar was displayed. SetStationLogRead was called since the last line was added to the log.
Returns:
read true if the log was displayed
GetStationMaxCargo
Definition:
GetStationMaxCargo() -> int cargo
Description:
return amount of cargo this station can hold.
Returns:
cargo amount of cargo in cu
purchaseable max
purchaseincrement
purchase price
mincargo
rent
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 }
Description:
get info about items this station sells
Arguments:
merchid id of sold items (1-n), where n = GetNumStationMerch()
Example:
<source lang="lua">
for item = 1, GetNumStationMerch() do
local haveitem = GetStationMerchInfo(item);
console_print("Station has item: ".. haveitem.name);
end
</source>
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 }
Description:
get info about items this station sells by itemid
Arguments:
itemid itemid of sold items
GetStationMerchPriceByID
Definition:
GetStationMerchInfoByID(int itemid) -> int price
Description:
get price of an item this station sells
Arguments:
itemid itemid of sold items
Returns:
price price of an item or 0 if this item isn't sold
GetStationName
Definition:
GetStationName(int stationid) -> string name
Description:
Get the name of a station. If the provided stationid is invalid the function produces a lua error.
Arguments:
- stationid stationid or nil for the current station
Returns:
- name Long name of the current station if no argument is given, otherwise the sector name and coordinates of a station.
Example:
<source lang="lua">
GetStationName(200*256+1) --returns "Sol II H-13" (200 is the sectorid for Sol II, H-13)
GetStationName() -- returns "SkyCommand" when in the station at Sol II, H-13
</source>
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 }
Description:
get sellable inventory info by id ...
GetStationSellableInventoryPriceByID
Definition:
GetStationSellableInventoryPriceByID(int itemid, int quantity) -> int value, unitprice
Description:
Get value of inventory items and price per unit in the current station
Arguments:
itemid itemid of an inventory item in the current station
quantity number of units of this item (optional)
Returns:
value value of item(s)
unitprice price per unit
Example:
<source lang="lua">
GetStationSellableInventoryPriceByID(1234, 2) -> 2000, 1400
-- Two units of item 1234 are worth 2000c. The station sells a unit for 1400c.
</source>
GetStationShipList
Definition:
GetStationShipList(int itemid) -> {int itemid1 ..}
Description:
get array of your ships in the current station
Returns:
itemid? itemid of ship in the current station
GetStationTurretInfo
Definition:
GetStationTurretInfo(int turretid) -> {int objectid, int nodeid, float armorpercent, int itemid}
Description:
get information about a stations or ships turrets
Arguments:
turretid' id of a turret
Returns:
objectid
nodeid
armorpercent armor level
itemid
GetStationType
Definition:
GetStationType() -> string stype
Description:
get station type
Returns:
stype station type. returns "frigate" when docked to a cruiser otherwise nil
GetStorageItemInfo
Definition:
GetStorageItemInfo() -> ??
Description:
no clue. can't make it return anything
GetStorageLocationSector
Definition:
GetStorageLocationSector(int arg1) -> int ret1
Description:
returns some number when fed with an itemid
GetSurveyChoices
Definition:
GetSurveyChoices() -> {}
Description:
returns an empty table!
GetSurveyQuestion
Definition:
GetSurveyQuestion() -> string ret1
Description:
returns an empty string!
Returns:
ret1 an empty string!
GetSystemID
Definition:
GetSystemID(int sectorid) -> int systemid
Description:
get systemid of the given sector. lua error on nil
Arguments:
sectorid sectorid
Returns:
systemid systemid
GetTargetDistance
Definition:
GetTargetDistance() -> float dist
Description:
get distance to target
Returns:
dist distance to target in m
GetTargetFriendlyStatus
Definition:
GetTargetFriendlyStatus() -> int fstatus
Description:
get friendlyness of target
Returns:
fstatus Returns 0 to 3. Target is friendly if 3, unfriendly otherwise
GetTargetInfo
Definition:
GetTargetInfo() -> string name float health dist int factionid string guild ship
Description:
get info about target
Returns:
name
health health in percent
dist distance in m
factionid faction of target
guild guild tag of target
ship name of targets ship
GetTip
Definition:
GetTip(int tipid) -> string tip
Description:
get loading screen with given index
Arguments:
tipid tip id (1-n)
Returns:
tip loading screen tip
GetTurretNamesByStationType
Definition:
GetTurretNamesByStationType(string stype) -> {string tur1 ..}
Description:
get turret name of provided station type
Arguments:
stype station type
Returns:
tur1 turret name (2-n)(?)
Example:
<source lang="lua">GetTurretNameByStationType("frigate") -> {2 = "LeftAft", 3 = "Left Front", 4 = "Left Lower Fin" ..}</source>
GetTutorialLevel
Definition:
GetTutorialLevel() -> int num
Description:
return if the player has done the tutorial(?)
Returns:
num 0 if tutorial wasn'T done -1 if it was, I think ...
GetUserName
Definition:
GetUserName() -> string Name
Description:
Returns the username.
Returns:
Name <test:username> or <dev:username> if you are on the test or dev server, otherwise <username>.
GiveMoney
Definition:
GiveMoney(string char, int amount) -> nil
Description:
transfer money to a character
Arguments:
char name of a character within the sector
amount amount of money to transfer
HasActiveShip
Definition:
HasActiveShip() -> bool aship
Description:
return true if the player has an active ship
Returns:
aship true if the player has an activer ship otherwise false
HasLastShipLoadout
Definition:
HasLastShipLoadout() -> bool loadout
Description:
return true if the player has a last ship loadout saved. (see ClearLastShipLoadout)
Returns:
loadout true if the player has a last shiploadout saved otherwise false
HelpCharAccom
Description:
helpfunc
HelpCharFaction
Description:
helpfunc
HelpCharGuild
Description:
helpfunc
HelpCharInventory
Description:
helpfunc
HelpCharStats
Description:
helpfunc
HelpCommoditiesAction
Description:
helpfunc
HelpGridPower
Description:
helpfunc
HelpIgnore
Description:
helpfunc
HelpLargeAddonsAction
Description:
helpfunc
HelpOtherAddonsAction
Description:
helpfunc
HelpPDAAdvancementLog
Description:
helpfunc
HelpPDAJettison
Description:
helpfunc
HelpPDAKilledByList
Description:
helpfunc
HelpPDAKilledList
Description:
helpfunc
HelpPDAMissionLog
Description:
helpfunc
HelpPDAMissionNotes
Description:
helpfunc
HelpPDANearbyShips
Description:
helpfunc
HelpPDAPVPList
Description:
helpfunc
HelpPDAStationVisitsList
Description:
helpfunc
HelpSellAction
Description:
helpfunc
HelpSellAddons
Description:
helpfunc
HelpSellCommodities
Description:
helpfunc
HelpShipAmmo
Description:
helpfunc
HelpShipCargo
Description:
helpfunc
HelpShipEquip
Description:
helpfunc
HelpShipGroup
Description:
helpfunc
HelpShipPurchase
Description:
helpfunc
HelpShipSelect
Description:
helpfunc
HelpShipStatus
Description:
helpfunc
HelpSmallAddonsAction
Description:
helpfunc
HelpStationAddonEquip
Description:
helpfunc
HelpStationAddonGroups
Description:
helpfunc
HelpStationBuddies
Description:
helpfunc
HelpStationMission
Description:
helpfunc
Description:
helpfunc
HelpStationNews
Description:
helpfunc
HelpStationWelcome
Description:
helpfunc
HelpSystemNotes
Description:
helpfunc
HelpVoiceChat
Description:
helpfunc
HideAllDialogs
Definition:
HideAllDialogs() -> nil
Description:
Hide all dialogs that were shown with ShowDialog or PopupDialog
HideDialog
Definition:
HideDialog(userdata dialog) -> nil
Description:
Hide a dialog that was shown with ShowDialog or PopupDialog
Arguments:
dialog a currently shown dialog
HideTooltip
Definition:
HideTooltip() -> nil
Description:
Hide ToolTip, the tooltip dialog
IsConnected
Definition:
IsConnected() -> bool connected
Description:
return true if the player is connected to the game
Returns:
connected true if the player is connected otherwise false
IsEnemy
Definition:
IsEnemy(charid) -> bool enemy
Description:
Part of the base radar functionality. Used in conjunction with GetFriendlyStatus.
Returns:
enemy returns true if someone is an enemy, otherwise false. Totally unreliable.
IsGroupMember
Definition:
IsGroupMember(int charid) -> bool grmember
Description:
tell if the provided character is a group member
Arguments:
charid character id
Returns:
grmember true if character is a groupmember false if not or you aren't member of a group
IsGuildMember
Definition:
IsGuildMember(int charid) -> bool guildmember
Description:
tell if the provided character is a guild member
Arguments:
charid character id
Returns:
gumember true if character is a guildmember false if not or you aren't member of a guild
IsInDuel
Definition:
IsInDuel() -> bool duel
Description:
Returns true if the player is in a duel
Returns:
duel true if dueling
IsPlayerRequestingBuddy
Definition:
IsPlayerRequestingBuddy(string name) -> bool req
Description:
Tell if the given player is requesting to become a buddy
Arguments:
name player name
Returns:
req true if player is requesting to become a buddy
IsPlayerRequestingDuel
Definition:
IsPlayerRequestingDuel(string name) -> bool req
Description:
Tell if the given player is requesting a duel
Arguments:
name player name
Returns:
req true if player is requesting a duel
IsPlayerRequestingGroupInvite
Definition:
IsPlayerRequestingGroupInvite(string name) -> bool req
Description:
Tell if the given player has sent a group invite
Arguments:
name player name
Returns:
req true if invited by player
IsProximityWarningEnabled
Definition:
IsProximityWarningEnabled() -> bool isproxy
Description:
tell if proximity warning is enabled
Returns:
isproxy true if proximity warning is enabled otherwise false
IsStormPresent
Definition:
IsStormPresent() -> bool isstorm
Description:
tell if there's a storm in the current sector
Returns:
isstorm true if storm is present otherwise false
IsTransactionInProgress
Definition:
IsTransactionInProgress() -> bool trans
Description:
tell if a transaction is in progress (like selling a ship, items ..)
Returns:
trans true if transaction in progress
IsVoiceChatEnabled
Definition:
IsVoiceChatEnabled() -> bool vc
Description:
tell if voice chat is enabled
Returns:
vc true if voice chat is enabled
JettisonAll
Definition:
JettisonAll() -> nil
Description:
Jettison all of your ships cargo
JettisonMultiple
Definition:
JettisonMultiple{item1 = {int id, int quantity} ..} -> nil
Description:
Jettison cargo items and quantitiss according to the provided table
Arguments:
item1 table containing quantity and itemid of cargo to jettison
id itemid of cargo item
quantity amount of this cargo to jettison
Example:
<source lang="lua">JettisonMultiple{{id=1234, quantity=2}, {id=1235, quantity=3}}</source>
jettison 2 untis of the cargo with the itemid 1234 and 3 with the id 1235
JettisonSingle
Definition:
JettisonSingle(int itemid, int quantity) -> nil
Description:
Jettison provided type and amount of cargo
Arguments:
itemid itemid of cargo item
quantity amount of cargo to jettison
Example:
<source lang="lua">JettisonMultiple(1234, 2)</source>
jettison 2 units of the cargo with the itemid 1234
JoinChannel
Definition:
JoinChannel{channelid1 ..} -> nil
Description:
join the provided channels without leaving existing channels
Arguments:
channelid1 channel number (1 - 2^32) the last index is the active channel
LeaveChannel
Definition:
LeaveChannel{channelid1 ..} -> nil
Description:
leave the provided channels
Arguments:
channelid1 channel number (1 - 2^32)
ListChannels
Definition:
ListChannels() -> nil
Description:
print list of currently joined channels and usage info to the chatarea
LoadCargo
Definition:
LoadCargo({{int itemid, int quantity} ..}, function cb) -> nil
Description:
Load cargo items and quantitiss according to the provided table
Arguments:
itemid itemid of cargo item
quantity amount of this cargo to load
cb optional function to call on success
Example:
<source lang="lua">LoadCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}</source>
load 2 units of the cargo with the itemid 1234 and 3 with the id 1235
LoadChannels
Definition:
LoadChannels() -> nil
Description:
restore chat channels from config file(?)
LoadMissionNotes
Definition:
LoadMissionNotes() -> string notes
Description:
read and return players notes from playernotes.txt. See also: Function_Index#SaveMissionNotes
Returns:
notes mission notes text
Definition:
LoadNavpath(string navpath) -> {int sectorid1 ..}
Description:
load navroute by name and return array with hops
Returns:
sectorid1 sectorid of a hop on this navroute first index is first hop (1-n)
LoadShipPresets
Definition:
LoadShipPresets() -> nil
Description:
read ship presets from config file and setup buyback dialog
LoadSystemNotes
Definition:
LoadSystemNotes(int systemid) -> string notes
Description:
load system notes from settings/<charactername>/system<systemid>notes.txt
Arguments:
sectorid systemid
Returns:
notes string with system notes
LocationStr
Definition:
LocationStr(int sectorid) -> string sname
Description:
translate a sectorid into a sector name. error if no argument provided
Arguments:
sectorid sectorid
Returns:
sname sector name
Example:
<source lang="lua">LocationStr(5000) -> "Sedina System, Sector H-9"</source>
Login
Definition:
Login(string username, string password) -> nil
Description:
Login to the game. crashes game when arguments are missing...
Arguments:
username vendetta account name
password password
Logout
Definition:
Logout() -> nil
Description:
Inititate logout sequence.
MakeBotName
Definition:
MakeBotName(string nameset, int seed) -> string name
Description:
Generate a name fromthe given nameset and optional random seed
Arguments:
nameset nameset from which to generate a name
seed optional random seed
Returns:
name a random name based on the nameset
MakeBuyBackQuestionDlg
Definition:
MakeBuyBackQuestionDlg() -> userdata dialog
Description:
Create the buyback dialog
Returns:
dialog buyback dialog
NPlural
Definition:
NPlural(string arg1, string arg2) -> string pstring
Description:
concaterates the two provided strings together and pluralizes the result
Arguments:
arg1 first substring
arg2 second substring
Returns:
pstring concaterated and pluralized string
Example:
<source lang="lua">NPlural("Serco", "Cookie") -> "Serco Cookies"</source>
MakeBuyBackQuestionDlg
Definition:
MakeBuyBackQuestionDlg() -> userdata dialog
Description:
Create the buyback dialog
Returns:
dialog buyback dialog
OnIdle
Definition:
OnIdle(float delta) -> nil
Description:
Idle handler
Arguments:
delta seconds since last call(?)
OpenAlarm
Definition:
OpenAlarm(string title, text, buttontext) -> nil
Description:
Show ConfirmationDialog with the given message
Arguments:
title title text
text body text
buttontext text on button
OverlapPrevention
Definition:
OverlapPrevention(table ip) -> bool overlap
Description:
Adjust icon positions in a viewport so that they don't overlap
Arguments:
ip table with viewport dimensions and icon positions
ip.icon_positions table with icon_postions
ip.width width of viewport
ip.height height of viewport
Returns:
overlap true if icons overlapped
ParseXML
Definition:
ParseXML(string xmlstring) -> {dom}
Description:
returns the provided string as a collection of substrings and nodes as subtables ..see example
Arguments:
xmlstring string containing xml tags
Returns:
dom table with xml nodes and substrings
Example:
<source lang="lua">ParseXML("a <xml>test</xml>woohoo<tag>subtext<bla>subsubtext</bla></tag>") ->
{"a ", {"test", "xml"}, "woohoo", {"subtext", {"subsubtext", "bla" }, "tag"}}</source>
PlayerInStation
Definition:
PlayerInStation() -> bool instation
Description:
tell if the player is in a station or capship
Returns:
instation true if the player is in a station otherwise false
PlayerInventoryPairs
Definition:
PlayerInventoryPairs() -> int itemid table iteminfo
Description:
Iterator function that returns information about an item in the players inventory each time it is called. works like pairs()
Returns:
itemid itemid
iteminfo inventory iteminfo
Example:
<source lang="lua">for i,v in PlayInventoryPairs() do console_print(i) printtable(v) end</source>
prints the info of every item in the players inventory to the console
PopupDialog
Definition:
PopupDialog(userdata dialog, int x, y) -> nil
Description:
Wrapper around iup.Popup that allows the dialog to be closed with HideDialog or HideAllDialogs
Arguments:
dialog dialog to show
x horizontal position
y vertical position
PrintJoinUsage
Definition:
PrintJoinUsage() -> nil
Description:
prints how to use /join to the chatarea
PrintLeaveUsage
Definition:
PrintLeaveUsage() -> nil
Description:
prints how to use /leave to the chatarea
PrintPurchaseTransaction
Definition:
PrintPurchaseTransaction(string name, int quantity, totalvalue, totalcost) -> nil
Description:
Print a sale summery message to the chat log
Arguments:
name sold item
quantity number items sold
totalvalue value of items
totalcost price of items
Example:
<source lang="lua">
-- prints "100x of Stuff sold for a total amount of 1000c (profit of 1c)" to the chat log
PrintPurchaseTransaction("Stuff", 100, 1000, 999)
</source>
PrintTransactionTable
Definition:
PrintTransactionTable() -> nil
Description:
print pending transactions.
Returns:
{[x]={trackback="...(tail call): ?", wantcount=0, count=0}}
for current transactions, otherwise returns nil.
ProcessEvent
Definition:
ProcessEvent(string eventtype, data) -> nil
Description:
Processes various events. Trigger a with Function_Index#RegisterEvent defined event
Arguments:
eventtype eventtype
data varies depending on eventtype. Sometimes it's a table, sometimes it's a string.
PurchaseMerchandiseItem
Definition:
PurchaseMerchandiseItem(int itemid, int amount, func callback) -> nil
Description:
buy the provided item
Arguments:
itemid itemid of cargo merch item
amount number of items to purchase
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
PurchaseShipLoadout
Definition:
PurchaseShipLoadout(func arg1) -> ??
Description:
no clue takes function as first argument
RegisterEvent
Definition:
RegisterEvent(object eventhandler, string eventtype) -> nil
Description:
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 Event Intro
Arguments:
eventhandler object to register with event
eventtype eventtype
Example:
see Event Intro
RegisterUserCommand
Definition:
RegisterUserCommand(string commandname, func callback(dataarg, {arguments1, ..}), data) -> nil
Description:
hook up object to command
Arguments:
commandname string containing the command
callback function accepting two arguments to run when command is executed
dataarg see data
arguments1 arguments of the command (Note: if there are no arguments the table is nil not an empty table.)
data data to pass callback
Example:
<source lang="lua">
-- function to call when the command is entered
local function printfunc(data, args)
-- data contains the third parameter of RegisterUserCommand local str = tostring(data) -- if the command was entered without parameters args is nil otherwise a table containing the parameters if args then str = str..tostring(args[1]) end print(str)
end
RegisterUserCommand("printsomething", printfunc, "test")</source>
Registers the command "printsomething" that calls a function that prints the text "test" and the first argument appended
ReinitIconPositions
Definition:
ReinitIconPositions(timer icontimer, int ship, userdata viewport, table iconlist, userdata iconcontainer, table ipcache) -> nil
Description:
Setup icons in a viewport
Arguments:
icontimer timer for overlap prevention animation
ship itemid of ship to use
viewport target viewport
iconlist table to portdata to portids
iconcontainer target box
ipcache table that maps icon_positions to ship types that acts as a cache
ReloadInterface
Definition:
ReloadInterface() -> nil
Description:
Reloads everything related to the interface that isn't a texture. This means VO lua scripts as well as scripts in the /plugins directory.
RentStorage
Definition:
RentStorage(int storage) -> nil
Description:
Rent storage space at the current station.
Arguments:
storage amount of space to rent. value is rounded up to a multiple of 10K
RepairShip
Definition:
RepairShip() -> ??
Description:
not tested
ReplenishAll
Definition:
ReplenishAll(int itemid, func cb) -> nil
Description:
replenish all weapons on provided ship
Arguments:
itemid itemid of ship
cb function to be called once the transaction is complete
ReplenishWeapon
Definition:
ReplenishWeapon() -> ??
Description:
not tested
RequestCharacterStats
Definition:
RequestCharacterStats() -> nil
Description:
no clue
RequestLaunch
Definition:
RequestLaunch() -> bool ret
Description:
Launches from the station. Any issues preventing launch are reported via pop-up window. Otherwise, the player's ship undocks.
Returns:
ret always true (?)
RequestMissionDetails
Definition:
RequestMissionDetails(int missionid) -> nil
Description:
Request information about the given mission (aka the info button) and pop up API_Index#MissionPromptDialog if id is valid
Arguments:
missionid mission id (1-n)
RequestMissionList
Definition:
RequestMissionList() -> nil
Description:
no clue. maybe used by /updatestation
RequestNewsArticle
Definition:
RequestNewsArticle(int newsindex) -> nil
Description:
ask server for news item(?)
fills API_Index#NewsDialog with given news item
Arguments:
newsindex index of news item, newest first
RequestNewsHeadlines
Definition:
RequestNewsHeadlines() -> nil
Description:
ask server for news item list?
RequestTargetStats
Definition:
RequestTargetStats() -> int charid
Description:
get character id of target (considreing the name maybe more?)
Returns:
charid character id of torgat or yours if no target selected
ResetTutorial
Definition:
ResetTutorial() -> nil
Description:
Reset the tutorial flag. the player will have to go through it again after docking.
RunTutorial
Definition:
RunTutorial() -> nil
Description:
launch tutorial
SaveChannels
Definition:
SaveChannels() -> nil
Description:
Save joined channels(?). Kinda useless since trhat's done as soon as you join one
SaveMissionNotes
Definition:
SaveMissionNotes(string notes) -> nil
Description:
Save the provided string to the characters mission notes file. See also: API Index#LoadMissionNotes
Arguments:
notes text to be saved in the notes file
SaveShipPresets
Definition:
SaveShipPresets(int index) -> nil
Description:
Save ship preset(s) and recreate buyback dialog
Arguments:
index ship preset to save if omitted all presets are save
SaveSystemNotes
Definition:
SaveSystemNotes(string notes, int systemid) -> nil
Description:
save system notes to settings/<charactername>/system<systemid>notes.txt
Arguments:
notes Notes to save. Normally a spickled version of an API Index#SystemNotes entry, but it accepts anything
sectorid systemid
Definition:
SaveNavpath({int sectorid1 ..}, string name) -> nil
Description:
Save the provided navroute
Arguments:
sectorid1 sectorid of each hop
name name of this route
Example:
<source lang="lua">SaveNavpath({5000, 5001, 5002}, "sedina") -> nil</source>
a route that hops around in sedina called "sedina"
SaveShipLoadout
Definition:
SaveShipLoadout() -> ??
Description:
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
SectorIDFromLocationStr
Definition:
SectorIDFromLocationStr(string location) -> int sectorid
Description:
Convert a location string into a sectorid.
Arguments:
location location string. output of API_Index#ShortLocationStr
Returns:
sectorid sectorid
Example:
<source lang="lua">SectorIDFromLocationStr("Sedina H-9") -> 5000</source>
SelectActiveShip
Definition:
SelectActiveShip(int itemid) -> nil
Description:
Set the given ship active
Arguments:
itemid itemid of ship in the current station
SelectCharacter
Definition:
SelectCharacter(int charslot) -> nil
Description:
Select characteri in given slot and enter the game with it (only "works" when you haven'T one selected yet)
Arguments:
charslot a character slot (1-5)
SellInventoryItem
Definition:
SellInventoryItem(int itemid, int amount) -> nil
Description:
Sell the provided amount of an inventory item from the current station or ship when docked to a station
Arguments:
itemid itemid of an item at the current station
amount how many to sell
Example:
SendChat
Definition:
SendChat(string msg, string dst, string dstparam) -> nil
Description:
Send a message to the provided destination.
Arguments:
msg the message
dst destination
known destinations:
"SAY" sector chat
"SECTOR" sector chat
"STATION" station chat
"PRIVATE" private chat. requires char parameter
"CHANNEL" chat chat
"SYSTEM" system chat
"GROUP" group chat
"GUILD" guild chat
"MISSION" mission chat. to activate reply buttons in the mission log send numbers. where 1 correspondends to the top most button
dstparam if dst = PRIVATE, the player to send the message, if dst = CHANNEL the channel to send the message (nil for current channel)
Example:
<source lang="lua">SendChat("Hi", "PRIVATE", "dude") -> nil</source>
send the message "Hi" to player dude
SendMissionQuestionResponse
Definition:
SendMissionQuestionResponse(int num) -> nil
Description:
called by the initial info dialog 1 = accept, 0 = decline
Arguments:
num 1 or 0
SetChatLogRead
Definition:
SetChatLogRead() -> nil
Description:
Mark the general chat log as read/displayed
SetChatLogReceiver
Definition:
SetChatLogReceiver(table chatcontainer) -> nil
Description:
Point the general chat log to a chat container
Example:
see ChatLogTemplate Example
SetCurrentChatTab
Definition:
SetCurrentChatTab() -> ??
Description:
does nothing. maybe a leftover from the general/mission chat system
SetHomeStation
Definition:
SetHomeStation() -> nil
Description:
set current station as your home station
SetMissionLogRead
Definition:
SetMissionLogRead() -> nil
Description:
Mark the advancement log as read/displayed
SetMissionLogReceiver
Definition:
SetMissionLogReceiver(table chatcontainer) -> nil
Description:
Point the advancement log to a chat container
Example:
see ChatLogTemplate Example
SetProximityWarningDistance
Definition:
SetProximityWarningDistance(int dist) -> nil
Description:
set proximity warning distance ..
Arguments:
dist proximity distance
SetShipPurchaseColor
Definition:
SetShipPurchaseColor(int color) -> nil
Description:
color of the next ship the player will buy
Arguments:
color color value (0-255)
SetStationLogRead
Definition:
SetStationLogRead() -> nil
Description:
Mark the station log as read/displayed
SetStationLogReceiver
Definition:
SetStationLogReceiver(table chatcontainer) -> nil
Description:
Point the station log to a chat container
Example:
see ChatLogTemplate Example
SetViewObject
Definition:
SetViewObject(userdata modelview, string meshname, string meshfile, int color) -> nil
Description:
Change the ship in a modelview
Arguments:
modelview modelview to change
meshname mesh name of ship
meshfile filename of mesh
color colorid
SHA1
Definition:
SHA1(string text) -> string hash
Description:
generate SHA1 hash of the given string
Arguments:
text text to hash
Returns:
hash hash of text
Example:
<source lang="lua">SHA1("hi there!") -> "a903cda4b5b93d3204af0fd6b7b92d24af1923a5"</source>
ShortLocationStr
Definition:
ShortLocationStr(int sectorid) -> string loc
Description:
string representing the provided sector
Arguments:
sectorid sectorid
Returns:
loc short sector description
Example:
<source lang="lua">ShortLocationStr(5000) -> "Sedina H-9"</source>
ShouldTutorialRun
Definition:
ShouldTutorialRun() -> bool tut
Description:
tell if the player has done the tutorial
Returns:
tut true if the player still has to do the tutorial otherwise false
ShowDialog
Definition:
ShowDialog(userdata dialog, int x, y) -> nil
Description:
Wrapper around iup.Show that allows the dialog to be closed with HideDialog or HideAllDialogs
Arguments:
dialog dialog to show
x horizontal position (optional)
y vertical position (optional)
ShowTooltip
Definition:
ShowTooltip(int x, y, string text) -> nil
Description:
Show the ToolTip the tooltip dialog with the given text
Arguments:
x horizontal position
y vertical position
text text in tooltip
SplitSectorID
Definition:
SplitSectorID(int sectorid) -> int systemid sectorh sectorv
Description:
split up a sectorid into systemid and axis on the system grid
Arguments:
sectorid sectorid
Returns:
systemid
sectorh horizonatal axis
sectorv vertical axis
Example:
<source lang="lua">SplitSectorID(5000) -> 20 8 9</source>
Sedina h9
SplitStationID
Definition:
SplitStationID(int stationid) -> int systemidl sectorhv
Description:
split up a stationid into systemid -1 and sector in system. this may be totally wrong
Arguments:
stationid a stationid
Returns:
systemidl systemid - 1
secttorhv sector in system
StartSellInventoryItem
Definition:
StartSellInventoryItem(int itemid, function cb) -> nil
Description:
Receive instant price updates for the given item.
Arguments:
itemid itemid of inventory item for which to receive instant price updates. Pass 0 to disable updates.
cb function to call on success
StationPlayerAmmoPairs
Definition:
StationPlayerAmmoPairs() -> int itemid table ammoinfo
Description:
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()
Returns:
itemid itemid
iteminfo ammoinfo
Example:
<source lang="lua">for i,v in StationPlayerAmmoPairs() do console_print(i) printtable(v) end</source>
prints the ammo info of every ammo based weapon at the current station
StationSellableInventoryPairs
Definition:
StationSellableInventoryPairs() -> int itemid table iteminfo
Description:
Iterator function that prints information about an item in the players inventory at the current station each time it is called. works like pairs()
Returns:
itemid itemid
iteminfo iteminfo
Example:
<source lang="lua">for i,v in StationSellableInventoryPairs() do console_print(i) printtable(v) end</source>
prints the item info of every inventory item at the current station to the console
StationSellItem
Definition:
StationSellItem(userdata button, table item, int quantity, function cb) -> nil
Description:
Sell items with aconfirmation dialog
Arguments:
button button that clalled this function. it will be activated if sale failed
item iteminfo
quantity how many units to sell
cb optional function to call when done. an error code is passed to it
StopTutorial
Definition:
StopTutorial() -> nil
Description:
does nothing..
StrTable
Definition:
StopTutorial() -> nil
Description:
seems to be another serialisation function. similar (the same?) to splickle
SubmitSurvey
Definition:
SubmitSurvey() -> nil
Description:
does nothing..
SwapAddons
Definition:
SwapAddons(int portid1 itemid1 porid1 itemid2 function cb) -> nil
Description:
Swap two addons equipped to the current ship (crashes client after undocking)
Arguments:
portid1 port of first item
itemid1 itemid of addon that is supposed to go into port with id portid1
portid2 port of second item
itemid2 itemid of addon that is supposed to go into port with id portid2
cb function to call on success
Example:
assuming 1234 is currently in port 3 and 1235 in port 2 this could be used to swap them
<source lang="lua">SwapAddons(2, 1234, 3, 1235)</source>
TabCompleteName
Definition:
TabCompleteName(string name) -> string completename
Description:
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.
Arguments:
name name to be completed
Returns:
completename completed name
TutorialEnd
Definition:
TutorialEnd() -> nil
Description:
finish up the tutorial
TutorialPart1
Definition:
TutorialPart1() -> nil
Description:
Launch a tutorial segment
TutorialPart2
Definition:
TutorialPart2() -> nil
Description:
Launch a tutorial segment
TutorialPart3
Definition:
TutorialPart3() -> nil
Description:
Launch a tutorial segment
TutorialPart4
Definition:
TutorialPart4() -> nil
Description:
Launch a tutorial segment
TutorialPart5
Definition:
TutorialPart5() -> nil
Description:
Launch a tutorial segment
TutorialPart6
Definition:
TutorialPart6() -> nil
Description:
Launch a tutorial segment
TutorialPart7
Definition:
TutorialPart7() -> nil
Description:
Launch a tutorial segment
TutorialPart8
Definition:
TutorialPart8() -> nil
Description:
Launch a tutorial segment
TutorialPart9
Definition:
TutorialPart9() -> nil
Description:
Launch a tutorial segment
TutorialPart10
Definition:
TutorialPart10() -> nil
Description:
Launch a tutorial segment
TutorialPart11
Definition:
TutorialPart11() -> nil
Description:
Launch a tutorial segment
TutorialPart12
Definition:
TutorialPart12() -> nil
Description:
Launch a tutorial segment
TutorialPart13
Definition:
TutorialPart13() -> nil
Description:
Launch a tutorial segment
UnloadCargo
Definition:
UnloadCargo({{int itemid, int quantity} ..}, function cb) -> nil
Description:
Unload cargo items and quantities according to the provided table
Arguments:
itemid itemid of cargo item
quantity amount of this cargo to unload
cb optional function to call on success
Example:
<source lang="lua">UnloadCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}</source>
unload 2 units of the cargo with the itemid 1234 and 3 with the id 1235
UnloadSellCargo
Definition:
UnloadSellCargo({{int itemid, int quantity} ..}, function cb) -> nil
Description:
Unload and sell cargo items and quantities according to the provided table
Arguments:
itemid itemid of cargo item
quantity amount of this cargo to unload and sell
cb optional function to call on success
Example:
<source lang="lua">UnloadSellCargo{{itemid=1234, quantity=2}, {itemid=1235, quantity=3}}</source>
unload and sell 2 units of the cargo with the itemid 1234 and 3 with the id 1235
UnregisterEvent
Definition:
UnregisterEvent(object, string eventtype) -> nil
Description:
Unregister an object registered with RegisterEvent
Arguments:
eventhandler object to unregister
eventtype eventtype
UnregisterUserCommand
Definition:
UnregisterUserCommand(string command) -> nil
Description:
Unregister a command registered with RegisterUserCommand
Arguments:
command command to unregister
UnrentStorage
Definition:
UnrentStorage(int storage) -> nil
Description:
Unrent storage space at the current station.
Arguments:
storage amount of space to unrent. value is rounded down to multiple of 10K
UpdateFade
Definition:
UpdateFade(float delta) -> nil
Description:
Do a fade step on controls registered with FadeControl
Arguments:
delta time since last update
XMLTagToString
Definition:
XMLTagToString() -> nil
Description:
might the reverse of ParseXML
_ERRORMESSAGE
Definition:
_ERRORMESSAGE(string msg) -> nil
Description:
creates an error message with the provided string. probably more
Arguments:
msg a message
assert
Definition:
Description:
[1]
bbhash
Definition:
bbhash(string input, int arg2) -> string hash
Description:
Seems to be some kind of hash function
Arguments:
input string from which to generate hash
arg2 initializer(?)
Returns:
hash generated hash
calc_health_color
Definition:
calc_health_color(float health, int alpha, mode) -> string color
Description:
Create an iup color string corresponding to the given health
Arguments:
health health (0-100)
alpha optional alpha value (0-255)
mode optional premultiply mode "*" or "&"
Returns:
color iup color string. format: "RRR GGG BBB AAA M"
chatareatemplate
Definition:
chatareatemplate(string statontabname, bool expanded) -> table container
Description:
create old style chatarea that combines general, mission and station log. the container seems to be incompatible with the chatareatemplate2 based maximized chat containers which breaks the maximize button
Arguments:
stationtabnaem "Station", "ShipCom" or nil. determines which maximized chat container to show on clicking the maximize button and whether to show the station log
expanded create a maximized chat container
Returns:
container chat container
container.area the chat area box
container.chatlog ChatLogTemplate for the general chat
container.missionlog ChatLogTemplate for the mission log
container.stationlog optional ChatLogTemplate for the station log
container.setup setup the chatarea
chatareatemplate2
Definition:
chatareatemplate2(bool maximized) -> userdata box
Description:
create a chatarea control. wrapper around ChatLogTemplate
Arguments:
maximized create maximized control
Returns:
box chataretemplate2
clear_accomlistbox
Definition:
clear_accomlistbox(userdata control, table itemlist) -> int selection
Description:
Clear an accomplishment list control. See: AccomplishmentTemplate
Arguments:
control accomplishment list to clear
itemlist list of accomplishment list items. return value of fill_accomlistbox
Returns:
selection index of selected item
clear_listbox
Definition:
clear_listbox(userdata control, table itemlist) -> int selection
Description:
Clear a list control
Arguments:
control list to clear
itemlist list of list items. return value of fill_listbox
Returns:
selection index of selected item
clearscene
Definition:
clearscene() -> nil
Description:
removes al objects from the game world
create_char_guild_tab
Definition:
create_char_guild_tab(bool sub) -> userdata box
Description:
Create guild tab
Arguments:
sub create as a sub tab
Returns:
box CharGuildTab
create_char_inventory_tab
Definition:
create_char_guild_tab(bool expand_local_branches, show_prices, showsellbutton) -> userdata box, tree
Description:
Create inventory tab
Arguments:
expand_local_branches expand the "Local Inventory" branch by default
show_prices show item prices while docked to station
showsellbutton show a sell button. the sell button is inactive unless show_pricess is set
Returns:
box CharInventoryTab
tree the tree control in the tab
create_jettison_tab
Definition:
create_jettison_tab() -> userdata box
Returns:
box PDAInventoryJettisonTab
create_ship_group_template
Definition:
create_ship_group_template(table iconlist, bool sub) -> userdata box
Description:
Create weapon groups tab
Arguments:
iconlist list of portdata
sub create as a sub tab
Returns:
box GroupsTab
collectgarbage
Definition:
Description:
[2]
comma_value
Definition:
comma_value(float number) -> string formatted_number
Description:
returns a formatted version of the provided number according to API_Index#SI_unit
Arguments:
number: unformatted number
Returns:
formatted_number formatted number
Example:
assuming SI_unit is 3:
<source lang="lua">comma_value(1000.00) -> "1,000.00"</source>
console_clear
Definition:
console_clear() -> nil
Description:
clear console on the next API_Index#ReloadInterface
console_print
Definition:
console_print(string text) -> nil
Description:
print the given string to the ingame console
Arguments:
text string to print
debugprint
Definition:
debugprint() -> ??
Description:
does nothing..
declare
Definition:
declare(string name, value) -> nil
Description:
declare a variable and assign a value
Arguments:
name name of the variable
value it's value. can be any type
deviceByMode
Definition:
deviceByMode(table arg1, mode) -> table ret
Description:
not sure. possibly to find audio devices by capability
dofile
Definition:
Description:
[3]
error
Definition:
Description:
[4]
factioncontroltemplate3
Definition:
factioncontroltemplate3(userdata frame, function cb, float font) -> userdata container
Description:
Create a fancy progressbar/faction standing indicator
Arguments:
frame iup frame to use for progressbar
cb optional function to call on click
font optional font size. see Font
Returns:
container factioncontroltemplate3
factionfriendlyness
Definition:
factionfriendlyness(int standing) -> string name
Description:
get string that represents the given faction standing
Arguments:
standing standing (0-65535)
Returns:
name standing as string
Example:
<source lang="lua">
factionfriendlyness(1000) -> "Hate"
</source>
factionfriendlynesscolor
Definition:
factionfriendlynesscolor(int standing) -> string color
Description:
get iup color that represents that given faction standing
Arguments:
standing standing (0-65535)
Returns:
color iup color string
Example:
<source lang="lua">
factionfriendlynesscolor(1000) -> "195 3 0"
</source>
factionfriendlynessrange
Definition:
factionfriendlynessrange(int standing) -> float range
Description:
get progress within the current faction standing level
Arguments:
standing standing (0-65535)
Returns:
float progress within faction standing level
Example:
<source lang="lua">
-- a standing of 7000 is about halfway into "Hate"
factionfriendlynessrange(7000) -> 0.534...
</source>
fill_accomlistbox
Definition:
fill_accomlistbox(userdata control, table itemlist, function setup_cb, click_cb) -> table dialoglist
Description:
fill an accomplishement listbox with accomlistsubdialogs according to given values. normally called from AccomplishmentTemplate2
Arguments:
control iup list to fill
itemlist itemlist
setup_cb function called for each item in itemlist. see: setup_cb
click_cb function to after clicking on an item
Returns:
dialoglist list of accomlistsubdialog
Example:
see: Example
fill_listbox
Definition:
fill_listbox(userdata control, table itemlist, int curselindex, function setup_cb, bool show_quantity, show_price) -> table dialoglist
Description:
fill a listbox with listsubdialogs according to given values
Arguments:
control iup list to fill
itemlist list of iteminfo
curselindex index of current selection
setup_cb function called for each item in itemlist. see: setup_cb
click_cb function to after clicking on an item
show_quantity show item quantity in list
show_price show item price in list
Returns:
dialoglist list of listsubdialog
Example:
see: Example
fillModesDropdown
Definition:
fillModesDropdown() -> ?
Description:
no clue. fill some kind of drop down menu(?)
filter_colorcodes
Definition:
filter_colorcodes(string in) -> string out
Description:
strips colorcodes from the provided string
Arguments:
in inputstring
Returns:
out outputstring
format_time
Definition:
format_time(int msecs) -> string tstring
Description:
get string representation of the provided time
Arguments:
msecs time in microseconds
Returns:
tstring time string
Example:
<source lang="lua">format_time(60001) -> "01:00.001" </source>
generalprint
Definition:
generalprint(string str) -> nil
Description:
print given string to the chat area via CHAT_MSG_PRINT event. Results is printed in the active channel text color.
Arguments:
str string to print
get_itemdlg
Definition:
get_itemdlg(bool showquantity, showprice) -> table dialog
Description:
Get a new listsubdialog or recycle one from the cache
Arguments:
showquantity show quantity in dialog
showprice show price
Returns:
dialog listsubdialog
get_jettisonitemdlg
Definition:
get_jettisonitemdlg(int itemid) -> userdata dialog
Description:
Get a new jettisonlistsubdialog or recycle one from the cache
Arguments:
itemid itemid of item to show in dialog
Returns:
dialog jettisonlistsubdialog
getheight
Definition:
getheight(userdata control) -> int height
Description:
Get height of an iup control
Arguments:
control iup control
Returns:
height height of control
getwidth
Definition:
getwidth(userdata control) -> int width
Description:
Get width of an iup control
Arguments:
control iup control
Returns:
width width of control
guildaccessdialogtemplate
Definition:
guildaccessdialogtemplate() -> userdata dialog
Description:
create guild access dialog
Returns:
''dialog guild access dialog
guildactivitylogdialogtemplate
Definition:
guildactivitylogdialogtemplate() -> userdata dialog
Description:
create guild activity dialog
Returns:
dialog guildactivitydialog
guildbanklogdialogtemplate
Definition:
guildbanklogdialogtemplate() -> userdata dialog
Description:
create guild bank dialog
Returns:
dialog guildactivitydialog
hextorgb
Definition:
hextorgb(string hexcolors) -> string deccolors
Description:
Convert hexadecimal formated color string into a decimal one used by iup
Arguments:
hexcolors hexadecimal color string
Returns:
deccolors decimal color string
Example:
<source lang="lua">hextorgb("ff00ff") -> "255 0 255"</source>
ipairs
Definition:
Description:
[5]
listpromptdlgtemplate
Definition:
listpromptdlgtemplate(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons, a title and a listbox
Arguments:
msg message to display in the dialog
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
Returns:
dialog listpromptdlgtemplate
load
Definition:
Description:
[6]
loadfile
Definition:
Description:
[7]
loadscene
Definition:
loadscene(string scene) -> ??
Description:
load a scene(?). don't know how it works though
Arguments:
scene filename of a scene
loadstring
Definition:
Description:
[8]
log_chat
Definition:
log_chat(string str) -> nil
Description:
Writes current time and given string to the errors.log
Arguments:
str string to write to log
log_print
Definition:
log_print(string str) -> nil
Description:
Writes string to the errors.log
Arguments:
str string to write to log
msgdlgtemplate1
Definition:
msgdlgtemplate1(string msg, buttontext, function button_cb, string size, posx, posy, bgcolor) -> userdata dialog
Description:
Create fullscreen dialog with button and message
Arguments:
msg dialog message
buttontext text on button
button_cb function called on button click
size iup size string
posx iup size string
posy iup size string
bgcolor iup color string
Returns:
dialog msgdlgtemplate1
msgdlgtemplate1a
Definition:
msgdlgtemplate1a(string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog
Description:
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 ShowDialog or :show()
Arguments:
msg dialog message
size iup size of dialog
posx iup horizontal position
posy iup vertical position
control control to unmask
bgcolor iup background color
Returns:
dialog message dialog
Example:
Note: The dialogs in both examples can't be closed without some extra work
<source lang="lua">
-- with unmasked control
-- run from station menu
local d = msgdlgtemplate1aNext("bla", "200x200", 10, 10, StationLaunchButton)
d:show_all()
</source>
<source lang="lua">
-- without unmasked control
local d = msgdlgtemplate1aNext("bla", "200x200", 10, 10)
ShowDialog(d)
</source>
msgdlgtemplate1aDone
Definition:
msgdlgtemplate1aDone(function button_cb, string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog
Description:
Same as msgdlgtemplate1a but with a "Close" button
Arguments:
nutton_cb function called on clicking "Close"
msg dialog message
size iup size of dialog
posx iup horizontal position
posy iup vertical position
control control to unmask
bgcolor iup background color
Returns:
dialog message dialog
Example:
<source lang="lua">
local d
local function button_cb()
HideDialog(d)
end
-- with unmasked control
d = msgdlgtemplate1aDone(button_cb, "bla", "200x200", 10, 10, StationLaunchButton)
d:show_all()
-- without unmasked control
-- local d = msgdlgtemplate1aNext("bla", "200x200", 10, 10)
-- ShowDialog(d)
</source>
msgdlgtemplate1aNext
Definition:
msgdlgtemplate1aNext(function button_cb, string msg, size, posx, posy, userdata control, string bgcolor) -> userdata dialog
Description:
Same as msgdlgtemplate1a but with a "Next" button
Arguments:
nutton_cb function called on clicking "Next"
msg dialog message
size iup size of dialog
posx iup horizontal position
posy iup vertical position
control control to unmask
bgcolor iup background color
Returns:
dialog message dialog
Example:
see msgdlgtemplate1aDone
msgdlgtemplate2
Definition:
msgdlgtemplate2(string msg, ltitle, function lcb, string rtitle, function rcb, string bgcolor, alignment) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons and a message
Arguments:
msg message to display in the dialog
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
bgcolor iup color of background
alignment iup alignment of msg
Returns:
dialog msgdlgtemplate2
msgdlgtemplate2withcheck
Definition:
msgdlgtemplate2withcheck(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons, a checkbox and a message
Arguments:
msg message to display in the dialog
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
Returns:
dialog msgdlgtemplate2withcheck
msgpromptdlgtemplate2
Definition:
msgpromptdlgtemplate2(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons, an entry field and a message
Arguments:
msg message to display in the dialog
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
Returns:
dialog msgpromptdlgtemplate2
msgpromptdlgtemplate2
Definition:
msgpromptdlgtemplate2(string msg, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons, an entry field and a message
Arguments:
msg message to display in the dialog
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
Returns:
dialog msgpromptdlgtemplate2
msgpromptdlgtemplate2lines
Definition:
msgpromptdlgtemplate2lines(string msg, msg2, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons, two entry fields and two messages
Arguments:
msg message to display in the dialog
msg2 second message
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
Returns:
dialog msgpromptdlgtemplate2lines
multidlgtemplate1
Definition:
multidlgtemplate1(string msg, msg2, buttontitle, function cb) -> userdata dialog
Description:
Create a fullscreen dialog with a button and two messages (one in a multiline control)
Arguments:
msg message to display in the dialog
msg2 second message. shown in a multiline control
buttontitle right button title
cb right button callback
Returns:
dialog multidlgtemplate1
multidlgtemplate2
Definition:
multidlgtemplate2(string msg, msg2, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons and two messages (one in a multiline control)
Arguments:
msg message to display in the dialog
msg2 second message. shown in a multiline control
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
Returns:
dialog multidlgtemplate2
multilistdlgtemplate
Definition:
multilistdlgtemplate(string msg, msg2, table tbl, ltitle, function lcb, string rtitle, function rcb) -> userdata dialog
Description:
Create a fullscreen dialog with two buttons, a dialog title, a dropdown menu, a title for the dropdown menu and a listbox
Arguments:
msg dialog title
msg2 listbox title
tbl unused
ltitle left button title
lcb left button callback
rtitle right button title
rcb right button callback
Returns:
dialog multilistdlgtemplate
Definition:
navmenu_template(bool showjumpbutton, function close_cb, bool issubsub) -> userdata container, distancetext, jumpbutton, zoombutton, undolastbutton
Description:
Create a control with a navmenu description box and some control buttons
Arguments:
showjumpbutton show the jump button if true
close_cb function to call after clicking the jump button while the player is able to jump
issubsub create a sub sub tab
Returns:
container navmenu_template
distancetext distance label
'
jumpbutton jump button or nil
zoombutton zoom button
undolastbutton undo button
next
Definition:
Description:
[9]
oper
Definition:
Description:
not gonna bother
pairs
Definition:
Description:
[10]
pcall
Definition:
Description:
[11]
Definition:
print(string str) -> nil
Description:
print given string to the chat area
Arguments:
str string to print
printtable
Definition:
printtable{in} -> nil
Description:
print contents of a table to the console
Arguments:
in table to print
purchaseprint
Definition:
purchaseprint(string str) -> nil
Description:
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.
Arguments:
str string to print
rawequal
Definition:
Description:
[12]
rawget
Definition:
Description:
[13]
rawset
Definition:
Description:
[14]
require
Definition:
Description:
[15]
rgbtohex
Definition:
rgbtohex(string deccolor) -> string hexcolor
Description:
Returns string containing escaped hexadecimal version of the in decimal given color
Arguments:
deccolor string with color in decimal format (format: "r g b")
Returns:
hexcolor string starting with ascii code 127 followed by the color in hexadecimal format. (format: '\127RRGGBB') on failure it returns your input value
Example:
The following prints "hi!" in red to the chat area. The by rgbtohex() returned string is the equivalent of "\127ff0000"
<source lang="lua">print(rgbtohex("255 0 0").."hi!")</source>
roper
Definition:
Description:
not gonna bother
sectorprint
Definition:
sectorprint(string str) -> nil
Description:
print given string to the chat area via CHAT_MSG_SERVER_SECTOR event. Results in white text by default.
Arguments:
str string to print
select
Definition:
Description:
[16]
setup_accomrow
Definition:
setup_accomrow(int index, table itemlist, userdata subdlg, function click_cb) -> int newindex
Description:
Initializes a list item in an accomplishment list. (used as setup_cb argument of fill_accomlistbox)
Arguments:
index position within itemlist
itemlist see itemlist
subdialog an itemlist dialog
click_cb function called after clicking on subdialog
Returns:
newindex position within itemlist + items consumed
singletab_template
Definition:
singletab_template(string title, userdata contents) -> userdata tab
Description:
Wrap a control into a tab like frame
Arguments:
title tab title
contents iup control
Returns:
tab tabbified control
sort_commodities
Definition:
sort_commodities(table a, b) -> bool order
Description:
Sort function for iteminfo tables. See table.sort in the lua reference
Arguments:
a iteminfo
b iteminfo
Returns:
order sort order
sort_sellable_commodities
Definition:
sort_sellable_commodities(table a, b) -> bool order
Description:
Sort function for iteminfo tables that prioritizes items in the active ship. See table.sort in the lua reference
Arguments:
a iteminfo
b iteminfo
Returns:
order sort order
spickle
Definition:
spickle(table intab) -> string
Description:
Converts a table into a string roughly of the format "value","value",{"tablevalue","tablevalue";tablekey="value"};key="value",key="value"
Arguments:
intab input table
Returns:
The spickled string
Example:
Given table blah with index 1 and 3 containing strings, index 2 containing an empty table, key "apple" containing the string "orange", and key fulltable containing a table with two ints and a string
<source lang="lua">spickle(blah) returns "string1",{},"string2";apple="orange",fulltable={3,4,"string3"}</source>
storagelocationcompare
Definition:
storagelocationcompare(int a, b) -> bool order
Description:
Sort function for locationid values. See table.sort in the lua reference
Arguments:
a locationid
b locationid
Returns:
order sort order
store_itemdlg
Definition:
store_itemdlg(userdata dlg) -> nil
Description:
Store a reference to an itemlist subdialog in the item dialog cache
Arguments:
dlg itemlist sub dialog
store_jettisonitemdlg
Definition:
store_jettisonitemdlg(userdata dlg) -> nil
Description:
Store a reference to an jettisonlist subdialog in the jettison dialog cache
Arguments:
dlg jettisonlist sub dialog
strip_whitespace
Definition:
strip_whitespace(string in) -> string out
Description:
strip whitespace from beginning and end of string
Arguments:
int input string
Returns:
out output string
substitute_vars
Definition:
substitute_vars(string in) -> string out
Description:
replace variables like %target% in input with their corresponding value
Arguments:
int input string
Returns:
out output string
tabcomplete
Definition:
Description:
produces lua error..
Example:
testsurvey
Definition:
testsurvey() -> nil
Description:
Test function for the survey feature
tonumber
Definition:
Description:
[17]
Example:
tostring
Definition:
Description:
[18]
Example:
type
Definition:
Description:
[19]
unpack
Definition:
Description:
[20]
Example:
undeclare
Definition:
undeclare(string name) -> nil
Description:
undeclare a variable created with Function_Index#declare
Arguments:
name name of a variable
unspickle
Definition:
unspickle(string in) -> table outtab
Description:
Converts a spickled string into a table
Arguments:
in input string
Returns:
outtab The unspickled table
xpcall
Definition:
Description:
[21]
Tables
Bitlib
Description:
functions to manipulate the bitwise operations
Details:
Bitlib
Buddy
Description:
functions to manipulate the characters buddylist
Details:
Buddy
CapShipLog
Description:
table with parts of a cap ship chat area.
Details:
CapShipLog
Duel
Description:
Duel related methods
Details:
Duel
FactionColor
Description:
table with faction colors. indices represent factionid
Details:
FactionColor
FactionColor_RGB
Description:
table that maps factionid's to colors in RGB format
Details:
FactionColor_RGB
FactionMonitor
Description:
table with monitoring types. indices represent numeric monitoring types and values, string representations of that type
Details:
FactionMontor
FactionMonitorStr
Description:
table with monitoring types. values represent numeric monitoring types and indices, string representations of that type
Details:
FactionMontorStr
FactionName
Description:
Array with short names of the ingame faction
Details:
FactionName
FactionNameFull
Description:
Array with long names of the ingame faction
Details:
FactionNameFull
FactionStanding
Description:
table for mapping names of standing levels to it#s int value
Details:
FactionStanding
Font
Description:
table that maps font names to sizes
Details:
Font
Font1
Description:
table that maps font names to sizes
Details:
Font1
Font2
Description:
table that maps font names to sizes
Details:
Font2
Game
Description:
functions to control a few game features ..
Details:
Game
GeneralChatPanel
Description:
table with parts of a chat area.
seems to point to PDA or HUD chat panel depending on what is visible(?)
Details:
GeneralChatPanel
Group
Description:
Group related functions
Details:
Group
Guild
Description:
Guild related functions
Details:
Guild
HUD
Description:
table with HUD all hud releted functions and parts
Details:
HUD
Ignore
Description:
Ignorelist related functions
Details:
Ignore
InterfaceManager
Description:
table with event handler for some interface related events and function initialize the interface
Details:
InterfaceManager
InvManager
Description:
functions to get information about inventory items
Details:
InvManager
ListColors
Description:
colors for list widgets
Details:
ListColors
Mentor
Description:
Mentor related functions
Details:
Mentor
MissionLogPanel
Description:
table with parts of the mission log
Details:
MissionLogPanel
Description:
functions to manipulate your NavRoute
Details:
NavRoute
ShipOrder
Description:
table containing the ordering of ships in lists(?)
Details:
ShipOrder
ShipPalette
Description:
array that maps palette color values to rgb values
Details:
ShipPalette_strings
Description:
array that maps palette color values to string representations of rgb values
Details:
ShipPalette_string
ShipPresets
Description:
array with properties of ship presets
Details:
ShipPresets
Skills
Description:
table to translate skillid's into skill names and back
Details:
Skills
StationLog
Description:
table with parts of a stations chat area.
Details:
StationLog
StationLogPanel
Description:
table with parts of a chat area.
Details:
StationLogPanel
SystemNames
Description:
Table to translate systemid's into system names and back
Details:
SystemNames
SystemNotes
Description:
System Notes public table. Used for adding notes to the navmap.
Details:
SystemNotes
TagFuncs
Description:
Text markup callbacks(?)
Details:
TagFuncs
TCPSocket
Description:
socket class
Details:
TCPSocket
Thread
Description:
Thread library
Details:
Thread
Timer
Description:
Timer class
Details:
Timer
VoiceChat
Description:
voice chat related functions
Details:
VoiceChat
Vote
Description:
functions to use the voting feature
Details:
Vote
_generalchatlog
Description:
array with log with chatlog
Details:
_generalchatlog
_missionlog
Description:
array with mission log
Details:
_missionlog
_stationlog
Description:
array with log of visisted stations
Details:
_stationlog
accomthing
Description:
no clue
Details:
accomthing
chatinfo
Description:
table with display options for each chat event
Details:
chatinfo
chatreceiver
Description:
event handler for chat events
Details:
chatreceiver
command_pretty_names
Description:
table that maps commands to their descriptions
Details:
command_pretty_names
coroutine
Description:
coroutine class
Details:
coroutine
debug
Description:
debugging helpers
Details:
debug
gkini
Description:
functions to manipulate the games config file
Details:
gkini
gkinterface
Description:
interface related functions..
Details:
gkinterface
gkmisc
Description:
misc functions ..
Details:
gkmisc
gknet
Description:
network related functions
Details:
gknet
gksound
Description:
audio related functions
Details:
gksound
gvector
Description:
gvector class. to create and manipulate vectors
Details:
gvector
ignore_time
Description:
array with with ignored name and period entries
Details:
ignore_time
iup
Description:
functions realted to iup. create and manipulate ui elements
Details:
iup
joystick
Description:
functions to change joystick settings
Details:
joystick
math3d
Description:
functions to do some vector math
Details:
math3d
math
Description:
standard math library
Details:
math
os
Description:
functions to interface with the operating system
Details:
os
quaternion
Description:
quaternion class. to create and manipulate quats
Details:
quaternion
preset_buttons
Description:
table with preset button controls
Details:
preset_buttons
radar
Description:
functions to query and set radar parameters
Details:
radar
string
Description:
string manipulation functions
Details:
string
table
Description:
the standard table library
Details:
table
Variables
CLASSTYPE_ADDON
Description
constant with inventory item class of addons
Value
2
CLASSTYPE_FLAG
Description
constant with inventory item class of flags(?)
Value
3
CLASSTYPE_GENERIC
Description
constant with inventory item class of generic items
Value
0
CLASSTYPE_MISSION
Description
constant with inventory item class of missions
Value
5
CLASSTYPE_SHIP
Description
constant with inventory item class of ships
Value
1
CLASSTYPE_STORAGE
Description
constant with inventory item class of storage containers (station hold)
value
4
ColorChatInput
Description
Boolean that controls coloring
DEFAULT_LICENSE_WATCH
Description
license to display in the HUD if not set by player
Value
2
FlashIntensity
Description
Alpha value of the Bloodflash
Value
1
FontScale
Description
font scaling
Value
1
HUD_SCALE
Description
HUD scaling. set via rHUDxscale cvar. 1 means 640. the higher the resolution the lower the value
Value
1
IMAGE_DIR
Description
subdirectory in the game directory where to look for images (skin option in config.ini)
MAX_ACCOMICON_COLUMNS
Description
number of ribbons per column to show in the char info screen(?)
Value
5
MAX_ACCOMICON2_COLUMNS
Description
number of ribbons per column to show in pda accomplishments tab(?)
Value
4
MAX_ACCOMICONS
Description
number of ribbons to show in char info(?)
Value
20
Platform
Description
Constant with string representing the platform the game is running on
Value
"Unix", "MacOS" or "Windows"
SI_unit
Description
Number format
Value
1: unformatted
2: space as thousands separator, comma as decimal separator
3: comma as thousands separator, point as decimal separator
SensorSort
Description
Current sort order of nearby ship list
Value
1: Name
2: Faction
3: Ship
4: Distance
ShowLogoffDialog
Description
Show logoff confirmation dialog if true
ShowSetHomeDialog
Description
Show homing confirmation dialog if true
SortItems
Description
Sort order for lists
Value
1: Name
2: Price
3: Group>Name>Price
4: Group>Price>Name
VO_VERSION
Description
constant with the games major version.
Value
3
_VERSION
Description
lua version.
Value
"Lua 5.1"
defaulttutorialbgcolor
Description
color of the not highlighted parts while the tutorial is active(?)
Value
"0 0 0 64 *"
lcd
Description
functions for the Logitech G-series keyboard screens
tabseltextcolor
Description
color of unselected tab
Value
"1 241 255"
tabunseltextcolor
Description
text color of unselected tab
Value
"0 185 199"
Userdata
Mostly UI componoents
AskForgivenessDialog
Description
the forgive dialog. see QuestionDialog
Big3DViewDialog
Description
dialog that is shown after clicking on the maximize button in the "Ship"->"Buy->"Buy Ship" tab. created with CreateBig3DViewMenu
Details:
Big3DViewDialog
BuybackQuestionPrompt
Description
dialog that is shown when arriving at the home station after dieing
CancelLoadoutPurchaseDialog
Description
"Purchasing ..." dialog that is shown while buying a preset. created with CreateCancelLoadoutMenu
Details:
MessageDialog
CapShipChatArea
Description
vbox with contents the cap ship interface chat area (entry, log, radios ...)
CapShipChatTab
Description
vbox with contents of the "Commerce"->"Ship Com" tab
StationCurrentLocationInfo
Description
label in the top right corner of the cap ship interface with the current system and sector name
StationDialog
Description
the base dialog of the cap ship interface
CapShipFactionInfo
Description
vbox in the cap ship interface with faction information. contains API_Index#CapShipNameLabel and API_Index#CapShipNameInfo. created with CreateCapShipFactionInfo
Details:
CapShipFactionInfo
CapShipFactionLabel
Description
label in the cap ship interface with the name of the faction that owns the current cap ship ("a ... ship")
CapShipLaunchButton
Description
button in the cap ship interface that launches the ship
CapShipNameLabel
Description
label in the cap ship interface with the name of the current cap ship (top right)
CapShipOptionsButton
Description
button in the cap ship interface that opens the options dialog
CapShipPDACharacterTab
Description
hbox with contents of the PDAs "Your PDA"->"Character"->"Statistics" tab
CapShipPDACharacterTab
Description
frame with contents of the PDAs "Your PDA"->"Character" tab
CapShipPDACommTab
Description
frame with contents of the PDAs "Your PDA"->"Comm" tab
CapShipPDAInventoryInventoryTab
Description
hbox with contents of the PDAs "Your PDA"->"Inventory"->"Inventory" tab
CapShipPDAInventoryJettisonTab
Description
vbox with contents of the PDAs "Your PDA"->"Inventory"->"Cargo" tab
CapShipPDAInventoryTab
Description
frame with contents of the PDAs "Your PDA"->"Inventory" tab
CapShipPDAMissionAdvancementTab
Description
hbox with contents of the PDAs "Your PDA"->"Missions"->"Advancement Logs" tab
CapShipPDAMissionBoardTab
Description
frame with contents of the PDAs "Your PDA"->"Missions"->"Mission Board" tab
CapShipPDAMissionBoardTabInfoButton
Description
button in the cap ship interface "Your PDA"->"Missions"->"Mission Board" tab to request mission info
CapShipPDAMissionLogTab
Description
hbox with contents of the cap ship interface "Your PDA"->"Missions"->"Mission Logs" tab
CapShipPDAMissionNotesTab
Description
vbox with contents of the cap ship interface "Your PDA"->"Missions"->"Mission Notes" tab
CapShipPDAMissionsTab
Description
frame with contents of the cap ship interface "Your PDA"->"Missions" tab
CapShipPDASensorNearbyTab
Description
vbox with contents of the cap ship interface "Your PDA"->"Sensor Log"->"Nearby Ships" tab
CapShipPDASensorTab
Description
frame with contents of the cap ship interface "Your PDA"->"Sensor Log" tab
Description
hbox with contents of the cap ship interface "Your PDA"->"Navigation"->"Navigation" tab
CapShipPDAShipTab
Description
frame with contents of the cap ship interface "Your PDA"->"Navigation" tab
CapShipRepairTab
Description
frame with contents of the cap ship interface "Tactical"->"Repair/Refill" tab. created with CreateCapShipRepairTab
Details:
CapShipRepairTab
CapShipSecondaryInfo
Description
label with character info (Money, Ship, Licenses ...) displayed in the bottom right of the cap ship interface
CapShipTabPDA
Description
box with contents of the cap ship interface "Your PDA" tab. created with CreateCapShipPDATab
Details:
CapShipTabPDA
CapShipTabs
Description
vbox with contents of the cap ship interface tabs
CapShipTacticalTab
Description
frame with contents of the cap ship interface "Tactical" tab. created with CreateCapShipTacticalTab
Details:
CapShipTacticalTab
CapShipTurretTab
Description
frame with contents of the cap ship interface "Tactical"->"Turrets" tab. created with CreateCapShipTurretTab
Details:
CapShipTurretTab
CharCreateDialog
Description
the character creation dialog
CharCreateFailedDialog
Description
error dialog that is shown the character creation failed. created with CreateCharCreateFailedMenu
Details:
MessageDialog
CharDeleteVerifierConfirmButton
Description
continue button in API_Index#CharDeleteVerifierDialog
CharDeleteVerifierDialog
Description
the verification dialog that shown by the "Delete Character" button
CharDeleteVerifierEditbox
Description
entry in API_Index#CharDeleteVerifierDialog
CharInfoDialog
Description
the character info dialog. opened with k in space.
CharSelectDialog
Description
the character selection dialog.
CharSelectFailedDialog
Description
error dialog with title "Character selection failed". created with CreateCharSelectFailedMenu
Details:
MessageDialog
ChatColorOptionsDialog
Description
dialog opened via "Options"->"Interface"->"Chat Color Settings"
ConfirmationDialog
Description
dialog with an ok button. no clue where it's used
ConnectingDialog
Description
"Connecting..." dialog shown during login. created with CreateConnectingMenu
Details:
MessageDialog
CreditsDialog
Description
dialog with credits. opened with the credits button at the log in prompt
EULADialog
Description
dialog that with the Eula shown at login
HUDHelpMenu
Description
dialog with common keybindings. opened with the F1 key while in space
HUDInterfaceOptionsDialog
Description
dialog with the HUD options, opened with the "HUD Settings" buttons in the Interface options dialog
InterfaceOptionsDialog
Description
dialog with the interface options
InvalidAmountDialog
Description
error dialog with the text "Invalud Amount". no idea where it's used
LoadingDialog
Description
dialog with the loading screen that is shown during sector load
LoginHelpDialog
Description
dialog with help text that is shown by the "Help" button in the login screen
LowGridPowerDialog
Description
error dialog that is shown when trying to connect an that requires more grid power than the ship can provide
MaximizedCapShipChat
Description
dialog with the maximized cap ship chat
MaximizedSpaceChat
Description
dialog with the maximized space chat
MaximizedStationChat
Description
dialog with the maximized station chat
MissionAbortDialog
Description
dialog to confirm abortion of missions
MissionPromptDialog
Description
dialog with mission description and buttons to accept or decline
NewsDialog
Description
dialog showing a news article
NotEnoughStorageDialog
Description
error dialog that pops when trying to put more than the storage limit into a station
NotificationDialog
Description
A borderless iup dialog with a message. It's displayed during non interruptible processes, like launching.
Details:
NotificationDialog
OptionsDialog
Description
the Options dialog
PDACharacterAccomTab
Description
hbox with contents of the PDAs "Your PDA"->"Character"->"Accomplishments" tab
PDACharacterFactionTab
Description
hbox with contents of the PDAs "Your PDA"->"Character"->"Faction Standings" tab
PDACharacterStatsTab
Description
hbox with contents of the PDAs "Your PDA"->"Character"->"Statistics" tab
PDACharacterTab
Description
frame with contents of the PDAs "Your PDA"->"Character" tab
PDAChatArea
Description
vbox with contents a the PDA chat area (entry, log, radios ...)
PDACloseButton
Description
button to close the PDA
PDACommTab
Description
frame with contents of the PDAs "Your PDA"->"Comm" tab
PDACurrentLocationInfo
Description
label in the top right corner of the PDA with the current system and sector name
PDADialog
Description
the base dialog of the PDA
PDAInventoryInventoryTab
Description
hbox with contents of the PDAs "Your PDA"->"Inventory"->"Inventory" tab
PDAInventoryJettisonTab
Description
vbox with contents of the PDAs "Your PDA"->"Inventory"->"Cargo" tab
PDAInventoryTab
Description
frame with contents of the PDAs "Your PDA"->"Inventory" tab
PDAMissionAdvancementTab
Description
hbox with contents of the PDAs "Your PDA"->"Missions"->"Advancement Logs" tab
PDAMissionBoardTab
Description
frame with contents of the PDAs "Your PDA"->"Missions"->"Mission Board" tab
PDAMissionBoardTabInfoButton
Description
button in the PDAs "Your PDA"->"Missions"->"Mission Board" tab to request mission info
PDAMissionLogTab
Description
hbox with contents of the PDAs "Your PDA"->"Missions"->"Mission Logs" tab
PDAMissionNotesTab
Description
vbox with contents of the PDAs "Your PDA"->"Missions"->"Mission Notes" tab
PDAMissionsTab
Description
frame with contents of the PDAs "Your PDA"->"Missions" tab
PDASecondaryInfo
Description
label with character info (Money, Ship, Licenses ...) displayed in the bottom right of the PDA
PDASensorNearbyTab
Description
vbox with contents of the PDAs "Your PDA"->"Sensor Log"->"Nearby Ships" tab
PDASensorTab
Description
frame with contents of the PDAs "Your PDA"->"Sensor Log" tab
Description
hbox with contents of the PDAs "Your PDA"->"Navigation"->"Navigation" tab
PDAShipTab
Description
frame with contents of the PDAs "Your PDA"->"Navigation" tab
PDATab1
Description
not sure
PDATabs
Description
vbox with contents of the PDAs "Your PDA" tab
PDATargetInfo
Description
vbox with contents of the target info in the top right of the PDA (name, health, faction ...)
QuestionDialog
Description
A dialog with two buttons and a message
Details:
QuestionDialog
QuestionWithCheckDialog
Description
A dialog with two buttons, check box and a message
SellItemDialog
Description
dialog that pops up after clicking on the "Sell Selected" button
StationChatArea
Description
vbox with contents a stations chat area (entry, log, radios ...)
StationChatTab
Description
vbox with contents of the "Commerce"->"The Bar" tab
StationCommerceCommoditiesTab
Description
vbox with contents of the "Commerce"->"Commodities" tab
StationCommerceTab
Description
frame with contents of the "Commerce" tab
StationCommerceWelcomeTab
Description
vbox with contents of the "Commerce"->"Welcome" tab
StationCommoditiesBuyTab
Description
frame with contents of the "Commerce"->"Commodities"->"Buy" tab
StationCommoditiesLoadTab
Description
vbox with contents of the "Commerce"->"Load/Unload" tab
StationCommoditiesSellTab
Description
vbox with contents of the "Commerce"->"Commodities"->"Sell" tab
StationCurrentLocationInfo
Description
label in the top right corner of the station dialog with the current system and sector name
StationDialog
Description
the base dialog of the station interface
StationEquipmentBuyLargeTab
Description
frame with contents of the "Ship"->"Buy"->"Large" tab
StationEquipmentBuyOtherPurchaseButton
Description
"Purchase Selected" button in the "Ship"->"Buy"->"Other" tab
StationEquipmentBuyOtherTab
Description
frame with contents of the "Ship"->"Buy"->"Other" tab
StationEquipmentBuyShipPurchaseButton
Description
"Purchase Selected" button in the "Ship"->"Buy"->"Buy Ship" tab
StationEquipmentBuyShipTab
Description
frame with contents of the "Ship"->"Buy"->"Buy Ship" tab
StationEquipmentBuySmallPurchaseButton
Description
"Purchase Selected" button in the "Ship"->"Buy"->"Small Addons" tab
StationEquipmentBuySmallTab
Description
frame with contents of the "Ship"->"Buy"->"Small Addons" tab
StationEquipmentBuyTab
Description
frame with contents of the "Ship"->"Buy" tab
StationEquipmentManagePortConfigTab
Description
hbox with contents of the "Ship"->"Manage"->"Configure Ship" tab
StationEquipmentManageShipSelectionTab
Description
frame with contents of the "Ship"->"Manage"->"Select Ship" tab
StationEquipmentManageTab
Description
frame with contents of the "Ship"->"Manage" tab
StationEquipmentSellTab
Description
frame with contents of the "Ship"->"Sell" tab
StationEquipmentTab
Description
frame with contents of the "Ship" tab
StationFactionInfo
Description
vbox in the station window with faction information. contains API_Index#StationNameLabel and API_Index#StationNameInfo. created with CreateStationFactionInfo
Details:
StationFactionInfo
StationFactionLabel
Description
label in the station window with the name of the faction that owns the current station ("a ... station")
StationHelpDialog
Description
dialog shown via help buttons that contains a help text
StationHomeButton
Description
button in the station window that sets the current station as home station
StationLaunchButton
Description
button in the station window that launches the ship
StationNameLabel
Description
label in the station window with the name of the current station (top right)
StationOptionsButton
Description
button in the station window that opens the options dialog
StationPDACharacterStatsTab
Description
hbox with contents of the "Your PDA"->"Character"->"Statistics" tab
StationPDACharacterTab
Description
frame with contents of the "Your PDA"->"Character" tab
StationPDACommTab
Description
frame with contents of the "Your PDA"->"Comm" tab
StationPDAInventoryInventoryTab
Description
hbox with contents of the "Your PDA"->"Inventory"->"Inventory" tab
StationPDAInventoryJettisonTab
Description
vbox with contents of the "Your PDA"->"Inventory"->"Cargo" tab
StationPDAInventoryTab
Description
frame with contents of the "Your PDA"->"Inventory" tab
StationPDAMissionAdvancementTab
Description
hbox with contents of the "Your PDA"->"Missions"->"Advancement Logs" tab
StationPDAMissionBoardTab
Description
frame with contents of the "Your PDA"->"Missions"->"Mission Board" tab
StationPDAMissionBoardTabInfoButton
Description
info button displayed in the "Your PDA"->"Missions"->"Mission Board" tab
StationPDAMissionLogTab
Description
hbox with contents of the "Your PDA"->"Missions"->"Mission Logs" tab
StationPDAMissionNotesTab
Description
vbox with contents of the "Your PDA"->"Missions"->"Mission Notes" tab
StationPDAMissionsTab
Description
frame with contents of the "Your PDA"->"Missions" tab
StationPDASensorNearbyTab
Description
vbox with contents of the "Your PDA"->"Sensor Log"->"Nearby Ships" tab
StationPDASensorTab
Description
frame with contents of the "Your PDA"->"Sensor Log" tab
Description
hbox with contents of the "Your PDA"->"Navigation"->"Navigation" tab
StationPDAShipTab
Description
frame with contents of the "Your PDA"->"Navigation" tab
StationSecondaryInfo
Description
label with character info (Money, Ship, Licenses ...) displayed in the
bottom right of the station interface
StationTabPDA
Description
frame with contents of the "You PDA" tab
StationTabs
Description
vbox housing the main station tabs ("Commerce", "Ship" and "You PDA")
StorageRentalDialog
Description
dialog for renting station storage
SurveyDialog
Description
A survey dialog. probably unused
ToolTip
Description
dialog with the current/last tooltip
VoiceChatOptions
Description
dialog with voice chat options
shipcargolabel
Description
label in the "Load/Unload" tab with number of cu and mass of cargo on the ship
sandbox
ColorName: true
Show3000mNavpoint: true
ShowBarUpdateNotification: false
ShowGroupKillNotification: true
ShowLowGridPowerDialog: true
ShowTooltips: true
UseFontScaling: false
