Function Index: Difference between revisions

From Vendetta Lua
Jump to navigationJump to search
← Older edit
No edit summary
Redirecting to API Index
 
(117 intermediate revisions by 7 users not shown)
Line 1: Line 1:
== Functions ==
#REDIRECT [[API Index]]
Page moved.


=== AbortMission ===
see [[API_Index]]
'''Definition:'''<br>
AbortMission() -> ??
<br><br>
'''Description:''' <br>
Abort the currently running mission.
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== Article ===
'''Definition:'''<br>
Article(string '''word''') -> string '''ret1'''
<br><br>
'''Description:'''<br>
prepends the appropriate article to the string '''word'''
<br><br>
'''Arguments:''' <br>
'''word''' string to prepend an article to.
<br><br>
'''Returns:''' <br>
'''ret1''' the string with an article prepended.
<br><br>
'''Example''':<br>
Article("apple") -> "an apple"<br>
<br>
 
=== CanUseAddon ===
'''Definition:''' <br>
CanUseAddon(string '''itemid''') -> bool '''ret1''' table '''ret2'''
<br><br>
'''Description:'''<br>
check if the player can equip the addon '''itemid'''
<br><br>
'''Arguments:'''<br>
'''itemid''' itemid of addon to check
<br><br>
'''Returns:'''<br>
'''ret1''' true or false depending on equipability<br>
'''ret1''' license requirements of the item at the current station (only returned for local addons and if the player is docked with the station)<br>
 
'''Example:'''<br>
CanUseAddon(12345) -> true {1, 2, 2, 2, 2}<br>
<br>
 
=== CanUseMerchandise ===
'''Definition:'''
<br><br>
'''Description:'''
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== CancelPurchaseShipLayout ===
'''Definition:'''
<br><br>
'''Description:'''
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== ClearGeneralChatLog ===
'''Definition:'''
<br><br>
'''Description:'''<br>
doesn't seem to do anything ...
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== ClearLastShipLoadout ===
'''Definition:'''<br>
ClearLastShipLoadout() -> nil
<br><br>
'''Description:''' <br>
prevents client from asking to rebuy ship after destruction
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== ClearMissionChatLog ===
'''Definition:'''
<br><br>
'''Description:'''
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== ClearProximityCache ===
'''Definition:'''
<br><br>
'''Description:'''<br>
I guess it clears the proximity cache?
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== ClearStationChatLog ===
'''Definition:'''
<br><br>
'''Description:'''<br>
does nothing...
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== ConfigureMultipleWeaponGroups ===
'''Definition:''' ConfigureMultipleWeaponGroups{table group1key1, table group1key2 ... table group1key6, table group2key1, table group2key2...}
<br><br>
'''Description:'''<br>
configures weapon groups according to given tables
<br><br>
'''Arguments:'''<br>
'''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 ..
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
ConfigureMultipleWeaponGroups
<br><br>
 
 
=== ConfigureWeaponGroup ===
'''Definition:'''
<br><br>
'''Description:'''
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== ConnectAddon ===
'''Definition:'''<br>
ConnectAddon(int portid, int itemid) -> bool ret1
<br><br>
'''Description:'''<br>
Attaches the addon '''itemid''' to the active ship in port '''portid'''
<br><br>
'''Arguments:'''<br>
'''portid''' portid of the the port<br>
1 = battery<br>
2-n = s-ports<br>
n+1-m = l-ports<br>
'''itemid''' itemid of the addon
<br><br>
'''Returns:'''<br>
'''ret1''' returns true if the player is docked and has an active ship otherwise nil
<br><br>
'''Example:'''<br>
ConnectAddon(2, 123) -> true<br>
put the addon 123 into port 2 while the player is docked to a station
<br><br>
 
 
=== CreateCharacter ===
'''Definition:'''<br>
CreateCharacter(int name, int nation) -> nil
<br><br>
'''Description:'''<br>
Creates the character of the given nation
<br><br>
'''Arguments:'''<br>
'''name''' name of character<br>
'''nation''' nation of character
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== DeleteCharacter ===
'''Definition:'''<br>
DeleteCharacter(int slot) -> nil
<br><br>
'''Description:'''<br>
Deletes the character in the character slot '''slot'''
<br><br>
'''Arguments:'''<br>
'''slot''' which character to delete
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== DisableProximityWarning ===
'''Definition:'''<br>
DisableProximityWarning() -> nil
<br><br>
'''Description:'''<br>
disable the proximity warning ...
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== DisconnectAddon ===
'''Definition:'''<br>
DisconnectAddon(int '''itemid''') -> bool ret1
<br><br>
'''Description:'''<br>
detaches the addon '''itemid''' and stores it in the station<br>
Note: detached items will likely have a different itemid in the station
<br><br>
'''Arguments:'''<br>
'''itemid''' id of the item to detach
<br><br>
'''Returns:'''<br>
'''ret1''' returns true if the player is docked and has an active ship otherwise nil
<br><br>
'''Example:'''<br>
DisconnectAddon(123) -> true
remove the item 123 from the active ship while the player is docked to a station
<br><br>
 
 
=== DisconnectAllAddons ===
'''Definition:'''
DisconnectAllAddons() -> nil
<br><br>
'''Description:'''<br>
Detach all addons from the active ship and store them in the current station
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== EnableProximityWarning ===
'''Definition:'''<br>
DisableProximityWarning() -> nil
<br><br>
'''Description:'''<br>
enable the proximity warning ...
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== FindAndReplaceTags ===
'''Definition:'''<br>
FindAndReplaceTags(string text, table matches) -> string ret1
<br><br>
'''Description:'''<br>
Replaces all occurances of with &lt; and &gt; enclosed substrings in '''text''' with matching values form the given table
<br><br>
'''Arguments:'''<br>
'''test''' string to replace tags in<br>
'''matches''' table tags/replacement pairs
<br><br>
'''Returns:'''<br>
'''ret1''': converted text
<br><br>
'''Example:'''<br>
FindAndReplaceTags("hi this is a &lt;br&gt; linebreak", {br="\n"})<br>
-> "hi this is a<br>
linebreak"
<br><br>
 
 
=== FindAndReplaceTagsCB ===
'''Definition:'''
<br><br>
'''Description:'''
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== FindMissionByID ===
'''Definition:'''
<br><br>
'''Description:'''
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== ForEachBuddy ===
'''Definition:'''<br>
ForEachBuddy(function func(string name, bool isonline, int pos)) -> nil
<br><br>
'''Description:'''<br>
calls '''func''' with the name, if the player is online for each of your buddies as well as his position if the player is currently online
<br><br>
'''Arguments:'''<br>
'''func''' gets called for each buddy<br>
'''name''' name of the buddy<br>
'''isonline''' true if the player is online else false<br>
'''pos''' id of sector in which the player is located
<br><br>
'''Returns:'''
<br><br>
'''Example:'''<br>
ForEachBuddy(function (name, isonline, pos) print(name .." "..tostring(isonline).." "..tostring(pos)) end)<br>
prints a list with your buddies and their status
<br><br>
 
=== ForEachPlayer ===
'''Definition:'''<br>
ForEachPlayer(function func(int charid)) -> nil
<br><br>
'''Description:'''<br>
calls '''func''' with the character id of each player in the sector. that includes bots and the sector thingy itself
<br><br>
'''Arguments:'''<br>
'''func''' gets called for each buddy<br>
'''ncharid''' character id <br>
<br><br>
'''Returns:'''
<br><br>
'''Example:'''<br>
ForEachPlayer(function (id) print(id) end)<br>
prints a list with all players in the sector
<br><br>
 
 
=== GetAccomplishmentLevels ===
'''Definition:'''<br>
GetAccomplishmentLevels(int accomid) -> int curlevel int reqlevel
<br><br>
'''Description:'''<br>
returns the current and the required level for the selected accomplishment
<br><br>
'''Arguments:'''<br>
'''accomid''' id of the accomplishment
<br><br>
'''Returns:'''<br>
'''curlevel''' current level of the accomplishment<br>
'''reqlevel''' what is required to get the accomplishment<br>
<br><br>
'''Example:'''
GetAccomplishmentLevels(9) -> 34 50<br>
assuming 9 is busskills this player has 34 kills of the 500 required
<br><br>
 
 
=== GetAccomplishmentType ===
'''Definition:'''<br>
GetAccomplishmentType(int accomid) -> int ret1 int ret2
<br><br>
'''Description:'''<br>
returns some numbers..
<br><br>
'''Arguments:'''<br>
'''accomid''' id of the accomplishment
<br><br>
'''Returns:'''<br>
'''ret1''' same as '''accomid'''?<br>
'''ret2''' some number. possibly if it's of the combat/economic class<br>
<br><br>
'''Example:'''
<br><br>
 
 
=== GetActiveChatChannel ===
'''Definition:'''<br>
GetActiveChatChannel() -> int channel
<br><br>
'''Description:'''<br>
returns the active channel
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''channel''' active chat channel
<br><br>
'''Example:'''
GetActiveChatChannel() -> 1<br>
you are currently in channel 1
<br><br>
 
=== GetActiveMissionInfo ===
'''Definition:'''<br>
GetActiveMissionInfo(int num) -> string mname table mmsg int itemid
<br><br>
'''Description:'''<br>
Get information about the selcted active mission
<br><br>
'''Arguments:'''<br>
'''num''' index of active mission (always 1)
<br><br>
'''Returns:'''<br>
'''mname''' string containing name of active mission<br>
'''mmsg''' array where each index contains a mission log entry + optional interface elements and their properties<br>
'''itemid''' itemid of the mission
<br><br>
'''Example:'''
GetActiveMissionInfo(1) -> "awesome mission" {1={"awesome mission question" 2={0="button" 1="awesome button text" action=1}}} 1234<br>
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
<br><br>
 
 
=== GetActiveShipCargoCount ===
'''Definition:'''<br>
GetActiveChatChannel() -> int cargocount
<br><br>
'''Description:'''<br>
returns amount of cargo in the ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''cargocount''' amount of cargo in the ship
<br><br>
'''Example:'''
<br><br>
 
=== GetActiveShipEnergy ===
'''Definition:'''<br>
GetActiveShipEnergy() -> float eng fraction
<br><br>
'''Description:'''<br>
returns the energy level of the active ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''eng''' energy level in game units 0-<battery capacacity>
'''fraction''' energy level as float from 0.0-1.0
<br><br>
'''Example:'''
GetActiveShipEnergy() -> 150.0 0.5<br>
the battery of this ship is half empty and has a capacity of 300
<br><br>
 
 
=== GetActiveShipHealth ===
'''Definition:'''<br>
GetActiveShipHealth() -> int d1 d2 d3 d4 d5 d6 dmg max
<br><br>
'''Description:'''<br>
returns information about the active ships health
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''d?''' damage to subsection 0 = no damage
'''dmg''' accumulated damage of subsections
'''max''' max health of ship
<br><br>
'''Example:'''
GetActiveShipHealth() -> 500 10 10 0 0 0 520 10000<br>
ship has 500 damagei n frontal region 520 dmg overall and a max health of 10000
<br><br>
 
 
 
=== GetActiveShipID ===
'''Definition:'''<br>
GetActiveShipID() -> int itemid
<br><br>
'''Description:'''<br>
returns itemid of active ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''itemid''' item id of active ship
<br><br>
'''Example:'''
<br><br>
 
 
=== GetActiveShipItemIDAtPort ===
'''Definition:'''<br>
GetActiveShipItemIDAtPort(int portid) -> int itemid
<br><br>
'''Description:'''<br>
returns itemid of addon in selected port
<br><br>
'''Arguments:'''<br>
'''portid''' id of port
<br><br>
'''Returns:'''<br>
'''itemid''' itemid of addon in port
<br><br>
'''Example:'''
GetActiveChatChannel(1) -> 1234<br>
addon in port 1 has itemid 1234
<br><br>
 
 
=== GetActiveShipMass ===
'''Definition:'''<br>
GetActiveShipMass() -> int mass
<br><br>
'''Description:'''<br>
returns mass of active ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''mass''' mass of active ship
<br><br>
'''Example:'''
GetActiveShipMAss() -> 15.0000<br>
ship weights 15000kg
<br><br>
 
 
=== GetActiveShipMaxCargo ===
'''Definition:'''<br>
GetActiveShipMaxCargo() -> int cargo
<br><br>
'''Description:'''<br>
returns amount of cargo space of the active ship in cu
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''cargo''' cargospace
<br><br>
'''Example:'''
<br><br>
 
 
=== GetActiveShipMaxSpeed ===
'''Definition:'''<br>
GetActiveShipMaxSpeed() -> int speed
<br><br>
'''Description:'''<br>
returns max nonturbo speed of active ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''speed''' ...
<br><br>
'''Example:'''
<br><br>
 
 
=== GetActiveShipName ===
'''Definition:'''<br>
GetActiveShipName() -> string name
<br><br>
'''Description:'''<br>
returns a string with the active ships name
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''name''' ...
<br><br>
'''Example:'''
<br><br>
 
 
=== GetActiveShipNumAddonPorts ===
'''Definition:'''<br>
GetActiveShipNumAddonPorts() -> int ports
<br><br>
'''Description:'''<br>
returns number of ports in active ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''ports''' number of ports, including engine and battery
<br><br>
'''Example:'''
GetActiveShipNumAddonPorts() -> 4
this ship has 3 ports
<br><br>
 
 
=== GetActiveShipPortIDOfItem ===
'''Definition:'''<br>
GetActiveShipPortIDOfItem(int itemid) -> int portid
<br><br>
'''Description:'''<br>
returns port if of the given addon in active ship
<br><br>
'''Arguments:'''<br>
'''itemid''' itemid of an addon
<br><br>
'''Returns:'''<br>
'''portid''' portid of selected addon
<br><br>
'''Example:'''
<br><br>
 
=== GetActiveShipPortInfo ===
'''Definition:'''<br>
GetActiveShipPortInfo(int portid) -> table portinfo
<br><br>
'''Description:'''<br>
returns information about the given port
<br><br>
'''Arguments:'''<br>
'''portid''' a port of the active ship
<br><br>
'''Returns:'''<br>
'''portinfo''' table with port info <br>
fields include:<br>
type: int holding the type of port<br>
name string describing port<br>
position: vector with port position on ship<br>
orientation: quaternion holding orientation of port<br>
<br><br>
'''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
<br><br>
 
 
=== GetActiveShipSelectedWeaponGroupIDs ===
'''Definition:'''<br>
GetActiveShipSelectedWeaponGroupIDs() -> int id1 id2 id3
<br><br>
'''Description:'''<br>
returns ids of the selected weapon groups ...
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''id?''' id's of weapon groups. Probably mapping to those key buttons.
<br><br>
'''Example:'''
GetActiveShipSelectedWeaponGroupIDs() -> 0 6 12
default mapping
<br><br>
 
=== GetActiveShipSpeed ===
'''Definition:'''<br>
GetActiveShipSpeed() -> int speed
<br><br>
'''Description:'''<br>
returns current speed of active ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''speed''' ...
<br><br>
'''Example:'''
<br><br>
 
=== GetActiveShipWeaponGroup ===
'''Definition:'''<br>
GetActiveShipWeaponGroup(int id) -> table group
<br><br>
'''Description:'''<br>
return which ports are enabled in the provided group
<br><br>
'''Arguments:'''<br>
'''id''' id of weapon group correspondents to group key[0-5] + (trigger group[0-2] * 6)
<br><br>
'''Returns:'''<br>
'''port''' table where the indexes are the port ids and values bools that are true when the port is active
<br><br>
'''Example:'''<br>
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
<br><br>
 
 
=== GetAddonItemInfo ===
'''Definition:'''<br>
GetAddonItemInfo(int itemid) -> int ret1 ret2
<br><br>
'''Description:'''<br>
returns some numbers ..
<br><br>
'''Arguments:'''<br>
'''itemid''' itemid of an addon(?)
<br><br>
'''Returns:'''<br>
'''ret?''' -1 if a valid itemid is passed to it(?)
<br><br>
'''Example:'''
<br><br>
 
 
=== GetAvailableMissionInfo ===
'''Definition:'''<br>
GetAvailableMissionInfo(int midx) -> {int itemtype, string name, bool active, string icon, string desc}
<br><br>
'''Description:'''<br>
Returns information about the mission with the provided index
<br><br>
'''Arguments:'''<br>
'''midx''' index of mission in missionlist
<br><br>
'''Returns:'''<br>
'''itemtype''' no idea<br>
'''name''' name of mission<br>
'''active''' is this mission active<br>
'''icon''' path to icon<br>
'''desc''' mission description
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetBarPatrons ===
'''Definition:'''<br>
GetBarPatrons() -> {[charid1], [charid2]...}
<br><br>
'''Description:'''<br>
get people in the current station bar
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''charid?''' index of returned table are charids of characters in the bar
<br><br>
'''Example:'''
<br><br>
 
 
=== GetBuddyInfo ===
'''Definition:'''<br>
GetBuddyInfo() -> ???
<br><br>
'''Description:'''<br>
not figured out yet
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetCharacterDescription ===
'''Definition:'''<br>
GetCharacterDescription() -> string desc
<br><br>
'''Description:'''<br>
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.
<br><br>
'''Arguments:'''<br>
???
<br><br>
'''Returns:'''<br>
'''desc''' your character description text whne no argument is provided
<br><br>
'''Example:'''
<br><br>
 
 
=== GetCharacterID ===
'''Definition:'''<br>
GetCharacterID(int nodeid) -> int charid
<br><br>
'''Description:'''<br>
returns character id of the provided node id
<br><br>
'''Arguments:'''<br>
'''nodeid''' node id of one of the characters in the sector
<br><br>
'''Returns:'''<br>
'''charid''' character id of the given node if a valid nodeid is valid otherwise the players charid
<br><br>
'''Example:'''
<br><br>
 
 
=== GetCharacterIDByName ===
'''Definition:'''<br>
GetCharacterIDByName(string name) -> int charid
<br><br>
'''Description:'''<br>
get character id by name
<br><br>
'''Arguments:'''<br>
'''name''' name of a character
<br><br>
'''Returns:'''<br>
'''charid''' a character id or nil
<br><br>
'''Example:'''
<br><br>
 
 
=== GetCharacterInfo ===
'''Definition:'''<br>
GetCharacterInfo(int cslot) -> string name faction int money kills deaths loc home cl ll hl tl ml
<br><br>
'''Description:'''<br>
Get information about your characters
<br><br>
'''Arguments:'''<br>
'''cslot''' a character slot (1-6)
<br><br>
'''Returns:'''<br>
'''name'''<br>
'''faction'''<br>
'''money'''<br>
'''kills''' all kills<br>
'''deaths'''<br>
'''loc''' sector id of current location<br>
'''home''' sector id of characters homestation<br>
'''cl''' combat level<br>
'''ll''' light weapon level<br>
'''hl''' heavy weapon level<br>
'''tl''' trade level<br>
'''ml''' mining level
<br><br>
'''Example:'''<br>
GetCharacterInfo(1) -> "Dude" "Corvus" 10000 10 100 4444 4444 1 1 1 0 0<br>
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
<br><br>
 
 
=== GetCharacterKillDeaths ===
'''Definition:'''<br>
GetCharacterKillDeaths(int charid) -> int kills deaths pks
<br><br>
'''Description:'''<br>
get info about kills and deaths. returns your own info if no charid given or a lua error if an invalid one ...
<br><br>
'''Arguments:'''<br>
'''charid''' character id or nil
<br><br>
'''Returns:'''<br>
'''kills''' total kills
'''deaths''' total deaths
'''pks''' player kills
<br><br>
'''Example:'''
<br><br>
 
 
=== GetCurrentChatTab ===
'''Definition:'''
<br><br>
'''Description:'''<br>
no idea maybe unused. always returns 2 here
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
=== GetCurrentSectorid ===
'''Definition:'''
GetCurrentSectorid() -> int sectorid
<br><br>
'''Description:'''<br>
get current sector id
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''sectorid''' id of current sector
<br><br>
'''Example:'''
<br><br>
 
=== GetCurrentStationType ===
'''Definition:'''
GetCurrentStationType() -> int type
<br><br>
'''Description:'''<br>
return the current station type..
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''type''' current station type. seems be usually 0 except when docked to a capship then 1
<br><br>
'''Example:'''
<br><br>
 
=== GetCurrentSystemid ===
'''Definition:'''
GetCurrentSystemid() -> int systemid
<br><br>
'''Description:'''<br>
get current system id..
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''systemid''' id of current system
<br><br>
'''Example:'''
<br><br>
 
=== GetEULA ===
'''Definition:'''
GetEULA() -> string eula
<br><br>
'''Description:'''<br>
return eula
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''eula''' string containing the eula
<br><br>
'''Example:'''
<br><br>
 
=== GetFactionInfo ===
'''Definition:'''
GetFactionInfo(int faction) -> string info
<br><br>
'''Description:'''<br>
get faction info text for the provided faction
<br><br>
'''Arguments:'''<br>
'''faction''' id of a faction
<br><br>
'''Returns:'''<br>
'''info''' string containing faction info
<br><br>
'''Example:'''
<br><br>
 
=== GetFinishedMissionInfo ===
'''Definition:'''
GetFinishedMissionInfo() -> string name table msg int itemid
<br><br>
'''Description:'''<br>
see GetActiveMissionInfo
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetFullPath ===
'''Definition:'''
<br><br>
'''Description:'''<br>
sounds obvious but it isn't
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetGeneralChatLog ===
'''Definition:'''
GetGeneralChatLog() -> string log
<br><br>
'''Description:'''<br>
returns the chatlog
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''log''' stirng containing chatlog
<br><br>
'''Example:'''
<br><br>
 
 
=== GetGroupMemberID ===
'''Definition:'''
GetGroupMemberID(int index) -> int charid
<br><br>
'''Description:'''<br>
get charid of group member with given index
<br><br>
'''Arguments:'''<br>
'''index''' group member index (1-8)
<br><br>
'''Returns:'''<br>
'''charid''' character id
<br><br>
'''Example:'''
<br><br>
 
 
=== GetGroupMemberLocation ===
'''Definition:'''
GetGroupMemberLocation(int charid) -> int loc
<br><br>
'''Description:'''<br>
get location of a groupmember
<br><br>
'''Arguments:'''<br>
'''charid''' character ids of a groupmember
<br><br>
'''Returns:'''<br>
'''loc''' sectorid of groupmember or 0 for yourself
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetGroupOwnerID ===
'''Definition:'''
GetGroupOwnerID() -> int charid
<br><br>
'''Description:'''<br>
get charid of group owner
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''charid''' character id
<br><br>
'''Example:'''
<br><br>
 
 
 
 
=== GetGuildAcronym ===
'''Definition:'''<br>
GetGuildAcronym() -> string acronym
<br><br>
'''Description:'''<br>
get your guilds acronym
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''acronym''' string containing guild acronym
<br><br>
'''Example:'''
<br><br>
 
 
=== GetGuildMOTD ===
'''Definition:'''<br>
GetGuildMOTD() -> string motd
<br><br>
'''Description:'''<br>
get your guilds message of the day
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''motd''' string containing the motd
<br><br>
'''Example:'''
<br><br>
 
 
=== GetGuildMemberInfo ===
'''Definition:'''
GetGuildMemberInfo(int index) -> int charid ret1 string name
<br><br>
'''Description:'''<br>
get information about the guildmember of the given index
<br><br>
'''Arguments:'''<br>
'''index''' index of online guildmembers 1-n
<br><br>
'''Returns:'''<br>
'''charid''' character id
'''ret1''' maybe the rank?
'''name''' name of member
<br><br>
'''Example:'''
<br><br>
 
 
=== GetGuildMemberInfobyCharID ===
'''Definition:'''
GetGuildMemberInfoByCharID(int charid) -> int charid ret1 string name
<br><br>
'''Description:'''<br>
get information about the guildmember of the given index
<br><br>
'''Arguments:'''<br>
'''charid''' charid of online guildmember
<br><br>
'''Returns:'''<br>
'''charid''' character id
'''ret1''' maybe the rank?
'''name''' name of member
<br><br>
'''Example:'''
<br><br>
 
 
 
 
 
=== GetGuildName ===
'''Definition:'''
GetGuildName() -> string name
<br><br>
'''Description:'''<br>
get guild name
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''name''' string containing guild name
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetGuildTag ===
'''Definition:'''
GetGuildTag(int charid) -> sring tag
<br><br>
'''Description:'''<br>
get guild tag of another character. not 100% sure about this
<br><br>
'''Arguments:'''<br>
'''charid''' character id(?)
<br><br>
'''Returns:'''<br>
'''tag''' string containing guild tag or empty string if character not known
<br><br>
'''Example:'''
<br><br>
 
 
=== GetHomeStation ===
'''Definition:'''
GetHomeStation() -> int sectorid
<br><br>
'''Description:'''<br>
get sector id of home station
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''sectorid''' sectorid of home station 
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemClassSubType ===
'''Definition:'''
GetInventoryItemClassSubType(int itemid) -> int subtype
<br><br>
'''Description:'''<br>
get subclass of an item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''subtype''' sub type of item<br>
known types:<br>
0 = light weapon or ship<br>
1 = heavy weapon<br>
3 = engine<br>
4 = battery<br>
10 = trade goods
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemClassType ===
'''Definition:'''
GetInventoryItemClassType(int itemid) -> int type
<br><br>
'''Description:'''<br>
get class of an item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''type''' type of item<br>
known types:<br>
0 = trade goods<br>
1 = ship<br>
3 = addon
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemContainerID ===
'''Definition:'''
GetInventoryItemContainerID(int itemid) -> int container
<br><br>
'''Description:'''<br>
get container of item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''container''' itemid of container of or null if it's not in one (a ship)
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemExtendedDesc ===
'''Definition:'''
GetInventoryItemExtendedDesc(int itemid) -> string desc
<br><br>
'''Description:'''<br>
get description of item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''desc''' item description text.
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemIcon ===
'''Definition:'''
GetInventoryItemIcon(int itemid) -> string path
<br><br>
'''Description:'''<br>
get path to icon of inventory item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''path''' path to icon
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemInfo ===
'''Definition:'''
GetInventoryItemInfo(int itemid) -> string ipath name int quant float mass string sdesc desc1 desc2 int container class subtype
<br><br>
'''Description:'''<br>
get most info about inventory item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''ipath''' icon path<br>
'''name''' name or item<br>
'''quant''' amount of items<br>
'''mass''' per item mass as float in tons<br>
'''sdesc''' short description<br>
'''desc1''' long description<br>
'''desc2''' long description again, sometimes omitted don't know what's the difference<br>
'''container''' itemid of container this item is in<br>
'''class''' type of item (see GetInventoryItemClassType)<br>
'''subtype''' subtype of item (see GetInventoryItemClassSubType)
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemMass ===
'''Definition:'''
GetInventoryItemMass(int itemid) -> float mass
<br><br>
'''Description:'''<br>
get mass of inventory item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''path''' mass of item as float in tons
<br><br>
'''Example:'''<br>
GetInventoryItemMass(1234) -> 4.000<br>
the mass of item 1234 is 4000kg
<br><br>
 
 
=== GetInventoryItemName ===
'''Definition:'''
GetInventoryItemName(int itemid) -> string name
<br><br>
'''Description:'''<br>
get name of inventory item
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''name''' name
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemQuantity ===
'''Definition:'''
GetInventoryItemQuantity(int itemid) -> int quant
<br><br>
'''Description:'''<br>
get quantity of inventory item..
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''quant''' quantity
<br><br>
'''Example:'''
<br><br>
 
 
=== GetInventoryItemType ===
'''Definition:'''
GetInventoryItemType(int itemid) -> int type
<br><br>
'''Description:'''<br>
get item type
<br><br>
'''Arguments:'''<br>
'''itemid''' inventory item
<br><br>
'''Returns:'''<br>
'''type''' type
<br><br>
'''Example:'''
<br><br>
 
 
=== GetLastAggressor ===
'''Definition:'''
GetLastAggressor(int itemid) -> int nodeid ret1
<br><br>
'''Description:'''<br>
get node id of last aggressor and some number
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''nodeid''' node id of last aggressor
'''ret1''' no clue
<br><br>
'''Example:'''
<br><br>
 
 
=== GetLastPrivateSpeaker ===
'''Definition:'''
GetLastPrivateSpeaker(int itemid) -> string name
<br><br>
'''Description:'''<br>
get name of last character that pmed you
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''name''' last messager
<br><br>
'''Example:'''
<br><br>
 
 
=== GetLastShipLoadout ===
'''Definition:'''
GetLastShipLoadout() -> {groups = {1 = group1 .. 18 = group18}, int ship, ports= {1 = port1 ..}, int shipcolor}
<br><br>
'''Description:'''<br>
get last ship loadout, color and weapon groups. this function only works in space
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''groups''' table containing the weapon group setup
'''group?''' group information. array indices correspondent to ports, is the value of an index set to true the port is enabled
'''ship''' type of ship
'''ports''' array indices correspondent to ports, value of index is the type of addon
'''shipcolor''' ship color 1-255(?)
<br><br>
'''Example:'''
<br><br>
 
 
=== GetLastShipLoadoutPurchaseCost ===
'''Definition:'''
GetLastShipLoadoutPurchaseCost() -> int cost
<br><br>
'''Description:'''<br>
what you payed for your last ship(?)
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''cost'''
<br><br>
'''Example:'''
<br><br>
 
=== GetLicenseLevel ===
'''Definition:'''
GetLicenseLevel(int type) -> int level
<br><br>
'''Description:'''<br>
get the level of the provided license
<br><br>
'''Arguments:'''<be>
'''type''' type of license (1-5)
<br><br>
'''Returns:'''<br>
'''level''' license level or 0 if invalid type given
<br><br>
'''Example:'''
<br><br>
 
 
=== GetLicenseRequirement ===
'''Definition:'''
GetLicenseRequirement(int level) -> int xp
<br><br>
'''Description:'''<br>
get xp required for given level
<br><br>
'''Arguments:'''<be>
'''level''' license level
<br><br>
'''Returns:'''<br>
'''xp'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetMaxRadarDistance ===
'''Definition:'''
GetMaxRadarDistance() -> int dist
<br><br>
'''Description:'''<br>
get current(?) max radar range
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''dist''' max radar range
<br><br>
'''Example:'''
<br><br>
 
 
=== GetMinJumpDistance ===
'''Definition:'''
GetMinJumpDistance() -> int dist
<br><br>
'''Description:'''<br>
get minimum distance from large objects to jump
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''dist''' min jump distance
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetMissionChatLog ===
'''Definition:'''
GetMissionChatLog() -> {bool updated, string 1.. }
<br><br>
'''Description:'''<br>
get advancement log
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''1-n''' advancement log
'''updated''' no clue
<br><br>
'''Example:'''
<br><br>
 
 
=== GetMissionTimers ===
'''Definition:'''
GetMissionTimers() -> int time
<br><br>
'''Description:'''<br>
get time left on the current mission. may have some functionality for multiple missions
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''time''' time left on this timer in 1000th seconds
<br><br>
'''Example:'''
<br><br>
 
 
=== GetMoney ===
'''Definition:'''
GetMoney() -> int money
<br><br>
'''Description:'''<br>
get how many credits you own
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''money'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNationKills ===
'''Definition:'''
GetNationKills(int nation) -> int kills
<br><br>
'''Description:'''<br>
get number of player kills for the given nation
<br><br>
'''Arguments:'''<br>
'''nation''' id of nation (1-3)
<br><br>
'''Returns:'''<br>
'''kills''' number of player kills or 0 if invalid nation
<br><br>
'''Example:'''
<br><br>
 
=== GetNewsHeadline ===
'''Definition:'''
GetNewsHeadline(int index) -> string title int time ret1
<br><br>
'''Description:'''<br>
get headline, post time and some number
<br><br>
'''Arguments:'''<br>
'''index''' index of headline newest is 1
<br><br>
'''Returns:'''<br>
'''title''' the headline
'''time''' post date in unix time
'''ret1''' no clue, always 1
<br><br>
'''Example:'''
<br><br>
 
=== GetNumAccomplishments ===
'''Definition:'''
GetNumAccomplishments(int charid) -> int accomplishments
<br><br>
'''Description:'''<br>
get number of accomplishmeants for given character(?). not well tested, may require caching of the char info
<br><br>
'''Arguments:'''<br>
'''charid''' character id (?)
<br><br>
'''Returns:'''<br>
'''accomplishments''' number of accomplishments
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumAvailableMissions ===
'''Definition:'''
GetNumAvailableMissions() -> int missions
<br><br>
'''Description:'''<br>
get number of available missions
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''missions'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumCharacters ===
'''Definition:'''
GetNumCharacters() -> int chars
<br><br>
'''Description:'''<br>
get number of characters you have defined
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''chars'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumCompletedMissions ===
'''Definition:'''
GetNumCompletedMissions() -> int missions
<br><br>
'''Description:'''<br>
get number of missions you'Ve completed
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''missions'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumGroupMembers ===
'''Definition:'''
GetNumCharacters() -> int chars
<br><br>
'''Description:'''<br>
get number of characters in your group
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''chars''' number of characters in your group or 0 if player is not in group
<br><br>
'''Example:'''
<br><br>
 
=== GetNumGuildMembers ===
'''Definition:'''
GetNumGuidMembers() -> int chars
<br><br>
'''Description:'''<br>
get number of online guildmembers
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''chars''' number of guildmembers currently online or 0 if player is not in a guild
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumNewsHeadlines ===
'''Definition:'''
GetNumNewsHeadlines() -> int num
<br><br>
'''Description:'''<br>
get number of news headlines..
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''num'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumStationAmmo ===
'''Definition:'''
GetNumStationAmmo() -> int ret1
<br><br>
'''Description:'''<br>
returns a number 
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''ret1''' ??
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumStationDesiredItems ===
'''Definition:'''
GetNumStationAmmo() -> int num
<br><br>
'''Description:'''<br>
get number of items this station desires
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''num'''
<br><br>
'''Example:'''
<br><br>
 
=== GetNumStationMerch ===
'''Definition:'''
GetNumStationMerch() -> int num
<br><br>
'''Description:'''<br>
get number of addons, ships an cargo this station sells
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''num'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumStationSellableInventory ===
'''Definition:'''
GetNumStationSellableInventory() -> int num
<br><br>
'''Description:'''<br>
get number of items from your inventory that can be sold at this station
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''num'''
<br><br>
'''Example:'''
<br><br>
 
=== GetNumStationTurrets ===
'''Definition:'''
GetNumStationTurrets() -> int num
<br><br>
'''Description:'''<br>
get number of turrets on this station or ship
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''num''' number of turrets attached to this station or ship. 0 if not docked
<br><br>
'''Example:'''
<br><br>
 
 
=== GetNumTips ===
'''Definition:'''
GetNumTips() -> int num
<br><br>
'''Description:'''<br>
get size of load screen tips pool
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''num'''
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetParentHealth ===
'''Definition:'''
GetParentHealth() -> float ret1 ret2
<br><br>
'''Description:'''<br>
get health of object this one is attached to (turret to capship). untested!
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''ret1''' health in percent(?)
'''ret2''' health as float (1-0)(?)
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetPlayerDistance ===
'''Definition:'''
GetPlayerDistance(int charid) -> float distance
<br><br>
'''Description:'''<br>
get distance to another character
<br><br>
'''Arguments:'''<br>
'''charid''' character id of another character in this sector
<br><br>
'''Returns:'''<br>
'''distance''' distance to character in m
<br><br>
'''Example:'''
<br><br>
 
 
=== GetPlayerFaction ===
'''Definition:'''
GetPlayerFaction(int charid) -> int factionid
<br><br>
'''Description:'''<br>
get nation of a player
<br><br>
'''Arguments:'''<br>
'''charid''' character id or nil
<br><br>
'''Returns:'''<br>
'''factionid''' number representing the faction (1-9)(?)
<br><br>
'''Example:'''
<br><br>
 
=== GetPlayerFactionStanding ===
'''Definition:'''
GetPlayerFactionStanding(int factionid) -> int standing
<br><br>
'''Description:'''<br>
get your standing with provided faction
<br><br>
'''Arguments:'''<br>
'''factionid''' number representing a faction
<br><br>
'''Returns:'''<br>
'''standing''' number representing faction standing 0-65535
<br><br>
'''Example:'''
<br><br>
 
 
=== GetPlayerHealth ===
'''Definition:'''
GetPlayerHealth(int charid) -> float health
<br><br>
'''Description:'''<br>
get health of provided character
<br><br>
'''Arguments:'''<br>
'''charid''' character id
<br><br>
'''Returns:'''<br>
'''health''' health of character in percent
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetPlayerHealth ===
'''Definition:'''
GetPlayerHealth(int charid) -> float health
<br><br>
'''Description:'''<br>
get health of provided character
<br><br>
'''Arguments:'''<br>
'''charid''' character id
<br><br>
'''Returns:'''<br>
'''health''' health of character in percent or -1 if character is not in the current sector
<br><br>
'''Example:'''
<br><br>
 
 
=== GetPlayerName ===
'''Definition:'''
GetPlayerName(int charid) -> string name
<br><br>
'''Description:'''<br>
get name of character
<br><br>
'''Arguments:'''<br>
'''charid''' character id
<br><br>
'''Returns:'''<br>
'''name'''
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetPrimaryShipIDOfPlayer ===
'''Definition:'''
GetPrimaryShipIDOfPlayer(int charid) -> int shipid
<br><br>
'''Description:'''<br>
get shipid of a character (= objectid?)
<br><br>
'''Arguments:'''<br>
'''charid''' character id
<br><br>
'''Returns:'''<br>
'''shipid'''
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetPrimaryShipNameOfPlayer ===
'''Definition:'''
GetPrimaryShipNameOfPlayer(int charid) -> string name
<br><br>
'''Description:'''<br>
get ship name (type) of provided character
<br><br>
'''Arguments:'''<br>
'''charid''' character id
<br><br>
'''Returns:'''<br>
'''name'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetProximityWarningDistance ===
'''Definition:'''
GetProximityWarningDistance() -> int dist
<br><br>
'''Description:'''<br>
get proxy warnign distance<br>
Note: even returns the distance when proxy warning is disabled
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''dist''' proxy distance.
<br><br>
'''Example:'''
<br><br>
 
 
=== GetShipCargoCount ===
'''Definition:'''
GetShipCargoCount(int itemid) -> int num
<br><br>
'''Description:'''<br>
get amount of cargo in the ship
<br><br>
'''Arguments:'''<br>
'''itemid''' item id of a ship
<br><br>
'''Returns:'''<br>
'''num''' amount of argo in ship in cu
<br><br>
'''Example:'''
<br><br>
 
 
=== GetShipInventory ===
'''Definition:'''
GetShipInventory(int itemid) -> {cargo = {int cargoitemid ..}, addons = {int addonitemid ..}}
<br><br>
'''Description:'''<br>
get itemids of items attached to a ship
<br><br>
'''Arguments:'''<br>
'''itemid''' item id of a ship
<br><br>
'''Returns:'''<br>
'''cargo''' array with cargo items<br>
'''addons''' array with addons<br>
'''cargoitemid''' itemids of cargo items
'''addonitemid''' itemids of addons
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetShipList ===
'''Definition:'''
GetShipList() -> {int itemid ..}
<br><br>
'''Description:'''<br>
get list of your ships in the current station. produces error when called outside station..
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''itemid''' itemid of a ship
<br><br>
'''Example:'''
<br><br>
 
 
=== GetShipPortIDOfItem ===
'''Definition:'''
GetShipPortIDOfItem(int itemid1, int itemid2) -> int portid
<br><br>
'''Description:'''<br>
get port of weapon in one of your ships
<br><br>
'''Arguments:'''<br>
'''itemid1''' itemid of one of your ships
'''itemid2''' itemid of a weapon or nil
<br><br>
'''Returns:'''<br>
'''portid''' port of a wweapon or first free port if itemid2 is nil
<br><br>
'''Example:'''
<br><br>
 
=== GetShipPurchaseColor ===
'''Definition:'''
GetShipPurchaseColor() -> int color
<br><br>
'''Description:'''<br>
get selected color from the color picker
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''colorid''' number representing color (0-255)
<br><br>
'''Example:'''
<br><br>
 
 
=== GetSkillLevel ===
'''Definition:'''
GetSkillLevel(int licenseid) -> int current next
<br><br>
'''Description:'''<br>
get current and required xp for next level or provided skill
<br><br>
'''Arguments:'''<br>
'''licenseid''' type of license (1-5)
<br><br>
'''Returns:'''<br>
'''current''' current xp
'''next''' xp required for next level
<br><br>
'''Example:'''
<br><br>
 
 
=== GetStationAmmoInfo ===
'''Definition:'''
GetStationAmmoInfo(int index) -> {bool is_ammorepair, string type, int unitcost, int price, string longdesc, string desc,  bool locallyproduced, int itemid, string icon}
<br><br>
'''Description:'''<br>
get info about ammo based weapons by station inventory index (i think)
<br><br>
'''Arguments:'''<br>
'''index''' index of ammo based weapons in the station, includes weapons on ships
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
=== GetStationAmmoInfoByID ===
'''Definition:'''
GetStationAmmoByID(int itemid) -> {bool is_ammorepair, string type, int unitcost, int price, string longdesc, string desc,  bool locallyproduced, int itemid, string icon}
<br><br>
'''Description:'''<br>
get info about ammo based weapons in the station by item id
<br><br>
'''Arguments:'''<br>
'''itemid''' itemid
<br><br>
'''Returns:'''
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetStationCargoList ===
'''Definition:'''
GetStationCargoList() -> {int itemid ..}
<br><br>
'''Description:'''<br>
get list of cargo items in the current station. produces error when called outside station..
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''itemid''' itemid of a trade item
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetStationChatLog ===
'''Definition:'''
GetStationChatLog() -> {string msg ..}
<br><br>
'''Description:'''<br>
get messages in the station chat
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''msg''' chat message
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetStationDesiredItem ===
'''Definition:'''
GetStationDesiredItem(int index) -> string ditem
<br><br>
'''Description:'''<br>
get item that this station desires ...
<br><br>
'''Arguments:'''<br>
'''index''' index in list of strings
<br><br>
'''Returns:'''<br>
'''ditems''' desired item
<br><br>
'''Example:'''
<br><br>
 
 
 
=== GetStationFaction ===
'''Definition:'''
GetStationFaction() -> int factionid
<br><br>
'''Description:'''<br>
get faction of current station. if an argument is supplied it returns 0 which may suggest that the faction of other stations can be queried too
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''factionid''' daction of current station
<br><br>
'''Example:'''
<br><br>
 
=== GetStationLocation ===
'''Definition:'''
GetStationLocation() -> int ret1
<br><br>
'''Description:'''<br>
returns a number!
<br><br>
'''Arguments:'''
<br><br>
'''Returns:'''<br>
'''ret1'''
<br><br>
'''Example:'''
<br><br>
 
 
 
"GetStationSellableInventoryInfoByID"<br>
"GetStationShipList"<br>
"GetStationTurretInfo"<br>
"GetStorageLocationSector"<br>
"GetSurveyChoices"<br>
"GetSurveyQuestion"<br>
"GetSystemID"<br>
"GetTargetDistance"<br>
"GetTargetFriendlyStatus"<br>
"GetTargetInfo"<br>
"GetTip"<br>
"GiveMoney"<br>
"HasLastShipLoadout"<br>
=== IsConnected() ===
 
'''Returns:''' wheater you are connected to the game
 
"IsEnemy"<br>
"IsStormPresent"<br>
=== 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"<br>
"LeaveChannel"<br>
"ListChannels"<br>
"LoadCargo"<br>
"LoadChannels"<br>
"LoadNavpath"<br>
"Login"<br>
"Logout"<br>
"PlayerInStation"<br>
"PlayerInventoryIterator"<br>
"PrintJoinUsage"<br>
"PrintLeaveUsage"<br>
"ProcessEvent"<br>
"PurchaseMerchandiseItem"<br>
"PurchaseShipLoadout"<br>
"RegisterEvent"<br>
"ReloadInterface"<br>
"ReplenishAll"<br>
"ReplenishWeapon"<br>
"RequestCharacterStats"<br>
"RequestLaunch"<br>
"RequestMissionDetails"<br>
"RequestMissionList"<br>
"RequestNewsArticle"<br>
"RequestTargetStats"<br>
"SaveChannels"<br>
"SaveNavpath"<br>
"SaveShipLoadout"<br>
"SelectActiveShip"<br>
"SelectCharacter"<br>
"SellInventoryItem"<br>
"SendChat"<br>
"SendMissionQuestionResponse"<br>
"SetCurrentChatTab"<br>
"SetHomeStation"<br>
"SetShipPurchaseColor"<br>
"ShortLocationStr"<br>
"SubmitSurvey"<br>
"TabCompleteName"<br>
"UnloadCargo"<br>
"UnloadSellCargo"<br>
"UnregisterEvent"<br>
"clearscene"<br>
"debugprint"<br>
"ipairs"<br>
"loadscene"<br>
"log_print"<br>
"next"<br>
"pairs"<br>
"spickle"<br>
"tonumber"<br>
"tostring"<br>
"type"<br>
"unpack"<br>
"unspickle"<br>
 
== Variables ==
 
"CLASSTYPE_ADDON": 2 <br>
"CLASSTYPE_FLAG": 3<br>
"CLASSTYPE_GENERIC": 0<br>
"CLASSTYPE_MISSION": 5<br>
"CLASSTYPE_SHIP": 1<br>
"CLASSTYPE_STORAGE": 4<br>
"VO_VERSION": 3<br>
"Platform": "Unix"<br>
 
== Tables ==
 
"Buddy"<br>
"Duel"<br>
"FactionName"<br>
"FactionNameFull"<br>
"FactionStanding"<br>
"Game"<br>
"Guild"<br>
"Ignore"<br>
"InvManager"<br>
"Mentor"<br>
"NavRoute"<br>
"Skills"<br>
"Timer"<br>
"Vote"<br>
"coroutine"<br>
"gkini"<br>
"gkinterface"<br>
[["gkmisc"]]<br>
"gvector"<br>
[["iup"]]<br>
"joystick"<br>
"math"<br>
"math3d"<br>
"quaternion"<br>
"radar"<br>
"string"<br>
"table"<br>

Latest revision as of 17:05, 2 February 2008

Redirect to:

Page moved.

see API_Index

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