|
|
| (134 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><br>
| + | |
| − | '''Description:'''
| + | |
| − | <br><br>
| + | |
| − | '''Arguments:'''
| + | |
| − | <br><br>
| + | |
| − | '''Returns:'''
| + | |
| − | <br><br>
| + | |
| − | '''Example:'''
| + | |
| − | <br><br>
| + | |
| − | | + | |
| − | === DeleteCharacter ===
| + | |
| − | '''Definition:'''
| + | |
| − | <br><br>
| + | |
| − | '''Description:'''
| + | |
| − | <br><br>
| + | |
| − | '''Arguments:'''
| + | |
| − | <br><br>
| + | |
| − | '''Returns:'''
| + | |
| − | <br><br>
| + | |
| − | '''Example:'''
| + | |
| − | <br><br>
| + | |
| − | | + | |
| − | === DisconnectAddon ===
| + | |
| − | '''Definition:'''<br>
| + | |
| − | DisconnectAddon(int '''portid''') -> nil
| + | |
| − | <br><br>
| + | |
| − | '''Description:'''<br>
| + | |
| − | detaches the addon from the with '''portid''' given port (or was that the itemid?) and stores it in the station
| + | |
| − | <br><br>
| + | |
| − | '''Arguments:'''
| + | |
| − | '''portid''' id of the port from which to detach an addon.
| + | |
| − | 1 = battery
| + | |
| − | 1-n = s-ports
| + | |
| − | n+1 - m = l-ports
| + | |
| − | <br><br>
| + | |
| − | '''Returns:'''
| + | |
| − | <br><br>
| + | |
| − | '''Example:'''
| + | |
| − | DisconnectAddon(1) wil store your ships current battery in the station
| + | |
| − | <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>
| + | |
Page moved.
