Function Index
Functions
AbortMission
Definition:
AbortMission() -> ??
Description:
Abort the currently running mission.
Arguments:
Returns:
Example:
Article
Definition:
Article(string word) -> string ret1
Description:
prepends the appropriate article to the string word
Arguments:
word string to prepend an article to.
Returns:
ret1 the string with an article prepended.
Example:
Article("apple") -> "an apple"
CanUseAddon
Definition:
CanUseAddon(string itemid) -> bool ret1 table ret2
Description:
check if the player can equip the addon itemid
Arguments:
itemid itemid of addon to check
Returns:
ret1 true or false depending on equipability
ret1 license requirements of the item at the current station (only returned for local addons and if the player is docked with the station)
Example:
CanUseAddon(12345) -> true {1, 2, 2, 2, 2}
CanUseMerchandise
Definition:
Description:
Arguments:
Returns:
Example:
CancelPurchaseShipLayout
Definition:
Description:
Arguments:
Returns:
Example:
ClearGeneralChatLog
Definition:
Description:
doesn't seem to do anything ...
Arguments:
Returns:
Example:
ClearLastShipLoadout
Definition:
ClearLastShipLoadout() -> nil
Description:
prevents client from asking to rebuy ship after destruction
Arguments:
Returns:
Example:
ClearMissionChatLog
Definition:
Description:
Arguments:
Returns:
Example:
ClearProximityCache
Definition:
Description:
I guess it clears the proximity cache?
Arguments:
Returns:
Example:
ClearStationChatLog
Definition:
Description:
does nothing...
Arguments:
Returns:
Example:
ConfigureMultipleWeaponGroups
Definition: ConfigureMultipleWeaponGroups{table group1key1, table group1key2 ... table group1key6, table group2key1, table group2key2...}
Description:
configures weapon groups according to given tables
Arguments:
group*key* each table seems to represent one group key to which a group of ports can be assigned. Members of the tables contain boolean values where each index represents a port. the first index seems to switch the whole group on or off depending on its value. that kind of works for the first table at least ..
Returns:
Example:
ConfigureMultipleWeaponGroups
ConfigureWeaponGroup
Definition:
Description:
Arguments:
Returns:
Example:
ConnectAddon
Definition:
ConnectAddon(int portid, int itemid) -> bool ret1
Description:
Attaches the addon itemid to the active ship in port portid
Arguments:
portid portid of the the port
1 = battery
2-n = s-ports
n+1-m = l-ports
itemid itemid of the addon
Returns:
ret1 returns true if the player is docked and has an active ship otherwise nil
Example:
ConnectAddon(2, 123) -> true
put the addon 123 into port 2 while the player is docked to a station
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
Returns:
Example:
DeleteCharacter
Definition:
DeleteCharacter(int slot) -> nil
Description:
Deletes the character in the character slot slot
Arguments:
slot which character to delete
Returns:
Example:
DisableProximityWarning
Definition:
DisableProximityWarning() -> nil
Description:
disable the proximity warning ...
Arguments:
Returns:
Example:
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:
DisconnectAddon(123) -> true
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
Arguments:
Returns:
Example:
EnableProximityWarning
Definition:
DisableProximityWarning() -> nil
Description:
enable the proximity warning ...
Arguments:
Returns:
Example:
FindAndReplaceTags
Definition:
FindAndReplaceTags(string text, table matches) -> string ret1
Description:
Replaces all occurances of with < and > enclosed substrings in text with matching values form the given table
Arguments:
test string to replace tags in
matches table tags/replacement pairs
Returns:
ret1: converted text
Example:
FindAndReplaceTags("hi this is a <br> linebreak", {br="\n"})
-> "hi this is a
linebreak"
FindAndReplaceTagsCB
Definition:
Description:
Arguments:
Returns:
Example:
FindMissionByID
Definition:
Description:
Arguments:
Returns:
Example:
ForEachBuddy
Definition:
ForEachBuddy(function func(string name, bool isonline, int pos)) -> 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
pos id of sector in which the player is located
Returns:
Example:
ForEachBuddy(function (name, isonline, pos) print(name .." "..tostring(isonline).." "..tostring(pos)) end)
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
Arguments:
func gets called for each buddy
ncharid character id
Returns:
Example:
ForEachPlayer(function (id) print(id) end)
prints a list with all players in the sector
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:
GetAccomplishmentLevels(9) -> 34 50
assuming 9 is busskills this player has 34 kills of the 500 required
GetAccomplishmentType
Definition:
GetAccomplishmentType(int accomid) -> int ret1 int ret2
Description:
returns some numbers..
Arguments:
accomid id of the accomplishment
Returns:
ret1 same as accomid?
ret2 some number. possibly if it's of the combat/economic class
Example:
GetActiveChatChannel
Definition:
GetActiveChatChannel() -> int channel
Description:
returns the active channel
Arguments:
Returns:
channel active chat channel
Example:
GetActiveChatChannel() -> 1
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:
GetActiveMissionInfo(1) -> "awesome mission" {1={"awesome mission question" 2={0="button" 1="awesome button text" action=1}}} 1234
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:
GetActiveChatChannel() -> int cargocount
Description:
returns amount of cargo in the ship
Arguments:
Returns:
cargocount amount of cargo in the ship
Example:
GetActiveShipEnergy
Definition:
GetActiveShipEnergy() -> float eng fraction
Description:
returns the energy level of the active ship
Arguments:
Returns:
eng energy level in game units 0-<battery capacacity>
fraction energy level as float from 0.0-1.0
Example:
GetActiveShipEnergy() -> 150.0 0.5
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
Arguments:
Returns:
d? damage to subsection 0 = no damage
dmg accumulated damage of subsections
max max health of ship
Example:
GetActiveShipHealth() -> 500 10 10 0 0 0 520 10000
ship has 500 damagei n frontal region 520 dmg overall and a max health of 10000
GetActiveShipID
Definition:
GetActiveShipID() -> int itemid
Description:
returns itemid of active ship
Arguments:
Returns:
itemid item id of active ship
Example:
GetActiveShipItemIDAtPort
Definition:
GetActiveShipItemIDAtPort(int portid) -> int itemid
Description:
returns itemid of addon in selected port
Arguments:
portid id of port
Returns:
itemid itemid of addon in port
Example:
GetActiveChatChannel(1) -> 1234
addon in port 1 has itemid 1234
GetActiveShipMass
Definition:
GetActiveShipMass() -> int mass
Description:
returns mass of active ship
Arguments:
Returns:
mass mass of active ship
Example:
GetActiveShipMAss() -> 15.0000
ship weights 15000kg
GetActiveShipMaxCargo
Definition:
GetActiveShipMaxCargo() -> int cargo
Description:
returns amount of cargo space of the active ship in cu
Arguments:
Returns:
cargo cargospace
Example:
GetActiveShipMaxSpeed
Definition:
GetActiveShipMaxSpeed() -> int speed
Description:
returns max nonturbo speed of active ship
Arguments:
Returns:
speed ...
Example:
GetActiveShipName
Definition:
GetActiveShipName() -> string name
Description:
returns a string with the active ships name
Arguments:
Returns:
name ...
Example:
GetActiveShipNumAddonPorts
Definition:
GetActiveShipNumAddonPorts() -> int ports
Description:
returns number of ports in active ship
Arguments:
Returns:
ports number of ports, including engine and battery
Example:
GetActiveShipNumAddonPorts() -> 4
this ship has 3 ports
GetActiveShipPortIDOfItem
Definition:
GetActiveShipPortIDOfItem(int itemid) -> int portid
Description:
returns port if of the given addon in active ship
Arguments:
itemid itemid of an addon
Returns:
portid portid of selected addon
Example:
GetActiveShipPortInfo
Definition:
GetActiveShipPortInfo(int portid) -> table portinfo
Description:
returns information about the given port
Arguments:
portid a port of the active ship
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:
GetActiveShipPortInfo(1) -> {type=4 name="PowerCell" position=(0, 0, 0) orientation=(0.000 0.000 0.000 1.000)}
portinfo of a ragnaroks battery port
GetActiveShipSelectedWeaponGroupIDs
Definition:
GetActiveShipSelectedWeaponGroupIDs() -> int id1 id2 id3
Description:
returns ids of the selected weapon groups ...
Arguments:
Returns:
id? id's of weapon groups. Probably mapping to those key buttons.
Example:
GetActiveShipSelectedWeaponGroupIDs() -> 0 6 12
default mapping
GetActiveShipSpeed
Definition:
GetActiveShipSpeed() -> int speed
Description:
returns current speed of active ship
Arguments:
Returns:
speed ...
Example:
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:
GetActiveShipWeaponGroup(6) -> {2=true 3=true}
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 ret1 ret2
Description:
returns some numbers ..
Arguments:
itemid itemid of an addon(?)
Returns:
ret? -1 if a valid itemid is passed to it(?)
Example:
GetAvailableMissionInfo
Definition:
GetAvailableMissionInfo(int midx) -> {int itemtype, string name, bool active, string icon, string desc}
Description:
Returns information about the mission with the provided index
Arguments:
midx index of mission in missionlist
Returns:
itemtype no idea
name name of mission
active is this mission active
icon path to icon
desc mission description
Example:
GetBarPatrons
Definition:
GetBarPatrons() -> {[charid1], [charid2]...}
Description:
get people in the current station bar
Arguments:
Returns:
charid? index of returned table are charids of characters in the bar
Example:
GetBuddyInfo
Definition:
GetBuddyInfo() -> ???
Description:
not figured out yet
Arguments:
Returns:
Example:
GetCharacterDescription
Definition:
GetCharacterDescription() -> string desc
Description:
Get the character description for your and possibly other chars. It just returns an empty string when an argument is passed to it, which suggests that it accepts one or more unknown arguments.
Arguments:
???
Returns:
desc your character description text whne no argument is provided
Example:
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
Example:
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
Example:
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 sector id of current location
home sector id of characters homestation
cl combat level
ll light weapon level
hl heavy weapon level
tl trade level
ml mining level
Example:
GetCharacterInfo(1) -> "Dude" "Corvus" 10000 10 100 4444 4444 1 1 1 0 0
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
Example:
GetCurrentChatTab
Definition:
Description:
no idea maybe unused. always returns 2 here
Arguments:
Returns:
Example:
GetCurrentSectorid
Definition:
GetCurrentSectorid() -> int sectorid
Description:
get current sector id
Arguments:
Returns:
sectorid id of current sector
Example:
GetCurrentStationType
Definition:
GetCurrentStationType() -> int type
Description:
return the current station type..
Arguments:
Returns:
type current station type. seems be usually 0 except when docked to a capship then 1
Example:
GetCurrentSystemid
Definition:
GetCurrentSystemid() -> int systemid
Description:
get current system id..
Arguments:
Returns:
systemid id of current system
Example:
GetEULA
Definition:
GetEULA() -> string eula
Description:
return eula
Arguments:
Returns:
eula string containing the eula
Example:
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
Example:
GetFinishedMissionInfo
Definition:
GetFinishedMissionInfo() -> string name table msg int itemid
Description:
see GetActiveMissionInfo
Arguments:
Returns:
Example:
GetFullPath
Definition:
Description:
sounds obvious but it isn't
Arguments:
Returns:
Example:
GetGeneralChatLog
Definition:
GetGeneralChatLog() -> string log
Description:
returns the chatlog
Arguments:
Returns:
log stirng containing chatlog
Example:
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
Example:
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
Example:
GetGroupOwnerID
Definition:
GetGroupOwnerID() -> int charid
Description:
get charid of group owner
Arguments:
Returns:
charid character id
Example:
GetGuildAcronym
Definition:
GetGuildAcronym() -> string acronym
Description:
get your guilds acronym
Arguments:
Returns:
acronym string containing guild acronym
Example:
GetGuildMOTD
Definition:
GetGuildMOTD() -> string motd
Description:
get your guilds message of the day
Arguments:
Returns:
motd string containing the motd
Example:
GetGuildMemberInfo
Definition:
GetGuildMemberInfo(int index) -> int charid ret1 string name
Description:
get information about the guildmember of the given index
Arguments:
index index of online guildmembers 1-n
Returns:
charid character id
ret1 maybe the rank?
name name of member
Example:
GetGuildMemberInfobyCharID
Definition:
GetGuildMemberInfoByCharID(int charid) -> int charid ret1 string name
Description:
get information about the guildmember of the given index
Arguments:
charid charid of online guildmember
Returns:
charid character id
ret1 maybe the rank?
name name of member
Example:
GetGuildName
Definition:
GetGuildName() -> string name
Description:
get guild name
Arguments:
Returns:
name string containing guild name
Example:
GetGuildTag
Definition:
GetGuildTag(int charid) -> sring tag
Description:
get guild tag of another character. not 100% sure about this
Arguments:
charid character id(?)
Returns:
tag string containing guild tag or empty string if character not known
Example:
GetHomeStation
Definition:
GetHomeStation() -> int sectorid
Description:
get sector id of home station
Arguments:
Returns:
sectorid sectorid of home station
Example:
"GetStationSellableInventoryInfoByID"
"GetStationShipList"
"GetStationTurretInfo"
"GetStorageLocationSector"
"GetSurveyChoices"
"GetSurveyQuestion"
"GetSystemID"
"GetTargetDistance"
"GetTargetFriendlyStatus"
"GetTargetInfo"
"GetTip"
"GiveMoney"
"HasLastShipLoadout"
IsConnected()
Returns: wheater you are connected to the game
"IsEnemy"
"IsStormPresent"
JettisonAll()
Jettisons the cargo in your hold.
JettisonMultiple
JettisonMultiple{int itemid = int count; ...}
Same as JettisonSingle() but takes a table of itemid and count pairs as argument
JettisonSingle
JettisonSingle(int itemid, int count)
Jettisons count units of the cargo itemid
Script: jettison junk
"JoinChannel"
"LeaveChannel"
"ListChannels"
"LoadCargo"
"LoadChannels"
"LoadNavpath"
"Login"
"Logout"
"PlayerInStation"
"PlayerInventoryIterator"
"PrintJoinUsage"
"PrintLeaveUsage"
"ProcessEvent"
"PurchaseMerchandiseItem"
"PurchaseShipLoadout"
"RegisterEvent"
"ReloadInterface"
"ReplenishAll"
"ReplenishWeapon"
"RequestCharacterStats"
"RequestLaunch"
"RequestMissionDetails"
"RequestMissionList"
"RequestNewsArticle"
"RequestTargetStats"
"SaveChannels"
"SaveNavpath"
"SaveShipLoadout"
"SelectActiveShip"
"SelectCharacter"
"SellInventoryItem"
"SendChat"
"SendMissionQuestionResponse"
"SetCurrentChatTab"
"SetHomeStation"
"SetShipPurchaseColor"
"ShortLocationStr"
"SubmitSurvey"
"TabCompleteName"
"UnloadCargo"
"UnloadSellCargo"
"UnregisterEvent"
"clearscene"
"debugprint"
"ipairs"
"loadscene"
"log_print"
"next"
"pairs"
"spickle"
"tonumber"
"tostring"
"type"
"unpack"
"unspickle"
Variables
"CLASSTYPE_ADDON": 2
"CLASSTYPE_FLAG": 3
"CLASSTYPE_GENERIC": 0
"CLASSTYPE_MISSION": 5
"CLASSTYPE_SHIP": 1
"CLASSTYPE_STORAGE": 4
"VO_VERSION": 3
"Platform": "Unix"
Tables
"Buddy"
"Duel"
"FactionName"
"FactionNameFull"
"FactionStanding"
"Game"
"Guild"
"Ignore"
"InvManager"
"Mentor"
"NavRoute"
"Skills"
"Timer"
"Vote"
"coroutine"
"gkini"
"gkinterface"
"gkmisc"
"gvector"
"iup"
"joystick"
"math"
"math3d"
"quaternion"
"radar"
"string"
"table"
