Function Index: Difference between revisions
No edit summary |
No edit summary |
||
Line 2: | Line 2: | ||
=== AbortMission === | === AbortMission === | ||
'''Definition:''' AbortMission()<br> | '''Definition:'''<br> | ||
AbortMission() -> ?? | |||
<br><br> | |||
'''Description:''' <br> | |||
Abort the currently running mission. | |||
<br><br> | |||
'''Arguments:''' | |||
<br><br> | |||
'''Returns:''' | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
'''Description:''' | === Article === | ||
'''Arguments:''' | '''Definition:'''<br> | ||
'''Returns:''' -<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> | <br> | ||
=== | === CanUseMerchandise === | ||
'''Definition:''' | '''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> | |||
'''Description:''' | === ClearMissionChatLog === | ||
'''Definition:''' | |||
<br><br> | |||
'''Description:''' | |||
<br><br> | |||
'''Arguments:''' | |||
<br><br> | |||
'''Returns:''' | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
'''Arguments:''' ''' | === 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 === | ||
<br> | '''Definition:''' | ||
<br><br> | |||
'''Description:'''<br> | |||
does nothing... | |||
<br><br> | |||
'''Arguments:''' | |||
<br><br> | |||
'''Returns:''' | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
=== | === ConfigureMultipleWeaponGroups === | ||
'''Definition:''' | '''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> | |||
'''Arguments:''' ''' | === ConfigureWeaponGroup === | ||
''' | '''Definition:''' | ||
<br><br> | |||
'''Description:''' | |||
<br><br> | |||
'''Arguments:''' | |||
<br><br> | |||
'''Returns:''' | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
=== ConnectAddon === | |||
'''Definition:''' | |||
<br><br> | |||
'''Description:''' | |||
<br><br> | |||
'''Arguments:''' | |||
<br><br> | |||
'''Returns:''' | |||
<br><br> | |||
'''Example:''' | |||
<br><br> | |||
"GetStationSellableInventoryInfoByID"<br> | "GetStationSellableInventoryInfoByID"<br> |
Revision as of 05:08, 27 June 2007
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:
Description:
Arguments:
Returns:
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"