Open main menu
Home
Random
Log in
Settings
About AddOn Studio
Disclaimers
AddOn Studio
Search
Editing
WildStar:UI API
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
{{\|uiapi}} For WildStar [[UI]] development base APIs are divided into [[Lua]] UI Libraries, like {{\|api||Apollo}} and {{\|api||GameLib}}, and are the base APIs for WildStar AddOn development. This page lists UI functions for Apollo and others provided in the core client API. For functions and modules provided by [[w:c:wildstaronline:Carbine|Carbine]] default [[AddOn]]s, see [[\AddOn API]]. : Note: The most recent API "documentation" can be found within [[\Houston/]] it self. It is located within the help menu. == Reference == Global API functions for WildStar in Lua. See also: * [[\API types]] - variable value types, used here as parameters and return values. * [[\API events]] - global event types, for events not shown as member of another type here. * [[AddOn Studio Wiki:How to edit API pages|How to edit API pages]] - please read if you're contributing documentation Function names can be prefixed with the following tags, see [[AddOn Studio Wiki:API notation and conventions|API notation and conventions]]: * DEPRECATED - is no longer to be used, and likely will be removed in future * REMOVED - was removed from the API. should be moved to [[:Category:UI API/Removed Functions|Removed Functions]]. Calling functions via macro or command line: /eval Apollo.SetConsoleVariable("lod.renderTargetScale", .75) /eval local x=GameLib.GetRealmName(); Print(x) <div class="ApiList"><!-- do not remove --> === [[\API Global|Global]] === These are in the global namespace. :{{\|id|API|BuybackItemFromVendor}}(idItem) :{{\|id|API|BuyItemFromVendor}}(idItem, 1) :{{\|id|API|Camp}}() :{{\|id|API|CancelExit}}() :{{\|id|API|Chat_PostDatachronMsg}}(idCreature, sText) :{{\|id|API|Cinematics_Cancel}}(self.param) :{{\|id|API|Cinematics_Play}}(self.param) :{{\|id|API|Creature_GetName}}(idCreature) :{{\|id|API|Event_CancelAuctionhouse}}() - fires the {{api|EVENT|CancelAuctionhouse}} event :{{\|id|API|Event_CancelBanking}}() - fires the {{api|EVENT|CancelBanking}} event :{{\|id|API|Event_CancelCityDirections}}() - fires the {{api|EVENT|CancelCityDirections}} event :{{\|id|API|Event_CancelCommodities}}() - fires the {{api|EVENT|CancelCommodities}} event :{{\|id|API|Event_CancelConverting}}() - fires the {{api|EVENT|CancelConverting}} event :{{\|id|API|Event_CancelCrafting}}() - fires the {{api|EVENT|CancelCrafting}} event :{{\|id|API|Event_CancelDyeWindow}}() - fires the {{api|EVENT|CancelDyeWindow}} event :{{\|id|API|Event_CancelEngravingStation}}() - fires the {{api|EVENT|CancelEngravingStation}} event :{{\|id|API|Event_CancelExperimentation}}() - fires the {{api|EVENT|CancelExperimentation}} event :{{\|id|API|Event_CancelGuildBank}}() - fires the {{api|EVENT|CancelGuildBank}} event :{{\|id|API|Event_CancelGuildRegistration}}() - fires the {{api|EVENT|CancelGuildRegistration}} event :{{\|id|API|Event_CancelHousingMannequin}}() - fires the {{api|EVENT|CancelHousingMannequin}} event :{{\|id|API|Event_CancelMail}}() - fires the {{api|EVENT|CancelMail}} event :{{\|id|API|Event_CancelSettlerHub}}() - fires the {{api|EVENT|CancelSettlerHub}} event :{{\|id|API|Event_CancelTaxiVendor}}() - fires the {{api|EVENT|CancelTaxiVendor}} event :{{\|id|API|Event_CancelTradeskillTraining}}() - fires the {{api|EVENT|CancelTradeskillTraining}} event :{{\|id|API|Event_CancelTraining}}() - fires the {{api|EVENT|CancelTraining}} event :{{\|id|API|Event_CancelVending}}() - fires the {{api|EVENT|CancelVending}} event :{{\|id|API|Event_CancelWarpartyBank}}() - fires the {{api|EVENT|CancelWarpartyBank}} event :{{\|id|API|Event_CloseBankWindow}}() - fires the {{api|EVENT|CloseBankWindow}} event :{{\|id|API|Event_CloseCraftingWindow}}() - fires the {{api|EVENT|CloseCraftingWindow}} event :{{\|id|API|Event_CloseTradeskillTrainerWindow}}() - fires the {{api|EVENT|CloseTradeskillTrainerWindow}} event :{{\|id|API|Event_CloseVendorWindow}}() - fires the {{api|EVENT|CloseVendorWindow}} event :{{\|id|API|Event_FireGenericEvent}}(sEventName) - fires an event by event name :{{\|id|API|Event_HideQuestLog}}() - fires the {{api|EVENT|HideQuestLog}} event :{{\|id|API|Event_ShowQuestLog}}() - fires the {{api|EVENT|ShowQuestLog}} event :{{\|id|API|Event_ShowTutorial}}() - fires the {{api|EVENT|ShowTutorial}} event :{{\|id|API|Event_ToggleAchievementWindow}}() - fires the {{api|EVENT|ToggleMailWindow}} event :{{\|id|API|Event_ToggleCodex}}() - fires the {{api|EVENT|ToggleMailWindow}} event :{{\|id|API|Event_ToggleMailWindow}}() - fires the {{api|EVENT|ToggleMailWindow}} event :{{\|id|API|Event_ToggleQuestLog}}() - fires the {{api|EVENT|ToggleQuestLog}} event :{{\|id|API|ExitGame}}() :{{\|id|API|ExitNow}}() :{{\|id|API|GetAbilitiesWindow}}() :{{\|id|API|GetCharacterWindow}}() :{{\|id|API|GetConColor}}() :{{\|id|API|GetCurrentSubZoneName}}() :{{\|id|API|GetCurrentZoneName}}() :{{\|id|API|GetDeathPenalty}}() :{{\|id|API|GetDemoTimeRemaining}}() :{{\|id|API|GetDemoType}}() :{{\|id|API|GetElderPoints}}() :{{\|id|API|GetForceRezTime}}() :{{\|id|API|GetGameFloat}}() :{{\|id|API|GetGameInt}}() :{{\|id|API|GetGameString}}() :{{\|id|API|GetItemInfo}}() :{{\|id|API|GetMapTrackedUnitData}}() :{{\|id|API|GetMouseOverUnit}}() :{{\|id|API|GetNthResolution}}() :{{\|id|API|GetPeriodicElderPoints}}() :{{\|id|API|GetQuestItem}}() :{{\|id|API|GetQuestItemCount}}() :{{\|id|API|GetResolutionCount}}() :{{\|id|API|GetRestXp}}() :{{\|id|API|GetRestXpKillCreaturePool}}() :{{\|id|API|GetRezCost}}() :{{\|id|API|GetRezIsDead}}() :{{\|id|API|GetRezOptionAcceptCasterRez}}() :{{\|id|API|GetRezOptionExitInstance}}() :{{\|id|API|GetRezOptionHolocrypt}}() :{{\|id|API|GetRezOptionWakeHere}}() :{{\|id|API|GetUnit}}() :{{\|id|API|GetWakeHereTime}}() :{{\|id|API|GetXp}}() :{{\|id|API|GetXpPercentToNextLevel}}() :{{\|id|API|GetXpToCurrentLevel}}() :{{\|id|API|GetXpToNextLevel}}() :{{\|id|API|Interaction_Result}}() :{{\|id|API|InvokeOptionsScreen}}() :{{\|id|API|IsActionBarSetVisible}}() :{{\|id|API|IsDemo}}() :{{\|id|API|IsGameValid}}() :{{\|id|API|IsInGame}}() :{{\|id|API|IsInVehicle}}() :{{\|id|API|IsRechargeVendor}}() :{{\|id|API|IsRepairVendor}}() :{{\|id|API|NextQuestItem}}() :{{\|id|API|Pet_GetStance}}() :{{\|id|API|Pet_GetValidStances}}() :{{\|id|API|Pet_SetStance}}() :{{\|id|API|PlayerTicket_GetErrorTypeList}}() :{{\|id|API|PlayerTicket_GetSubtype}}() :{{\|id|API|PlayerTicketDialog_Report}}() :{{\|id|API|PreviousQuestItem}}() :{{\|id|API|Print}}() :{{\|id|API|RechargeItemVendor}}() :{{\|id|API|RepairAllItemsVendor}}() :{{\|id|API|RepairItemVendor}}() :{{\|id|API|ReportError}}() :{{\|id|API|RequestReloadUI}}() :{{\|id|API|SellItemToVendor}}() :{{\|id|API|SellItemToVendorById}}() :{{\|id|API|SetQuestItem}}() :{{\|id|API|ShowInventory}}() :{{\|id|API|String_GetString}}() :{{\|id|API|String_GetWeaselString}}() :{{\|id|API|ToggleAbilitiesWindow}}() :{{\|id|API|ToggleCharacterWindow}}() :{{\|id|API|ToggleInventory}}() :{{\|id|API|ToggleTradeSkillsInventory}}() === [[\API AbilityBook|AbilityBook]] === === [[\API AccountItemLib|AccountItemLib]] === === [[\API AchievementsLib|AchievementsLib]] === === [[\API ActionSetLib|ActionSetLib]] === === [[\API Apollo|Apollo]] === :{{\|id|API|Apollo|AddAddonErrorText}}(tAddon, sMessage) - adds error message to AddOn's Apollo error log :{{\|id|API|Apollo|AlertAppWindow}}() :{{\|id|API|Apollo|AssetFileSizeString}}(sFilename) returns (string) :{{\|id|API|Apollo|AssetFileTimeString}}(sFilename) returns (string) :{{\|id|API|Apollo|BeginClickStick}}(wndSource,sType,sSprite,nData) :{{\|id|API|Apollo|BeginDragDrop}}(wndSource,sType,sSprite,nData) :{{\|id|API|Apollo|CloseEscapableWindows}}() returns (boolean) - true on success :{{\|id|API|Apollo|CreateTimer}}(sTimerName,nInterval,bContinuous) :{{\|id|API|Apollo|DisableAddon}}(sName) :{{\|id|API|Apollo|DoesSpriteExist}}() :{{\|id|API|Apollo|DPF}}(sMarker) - runs the caller's DebugPrintF on the buffer of the caller :{{\|id|API|Apollo|FindWindowByName}}(sName) returns (Window) - gets window by name :{{\|id|API|Apollo|FormatNumber}}() :{{\|id|API|Apollo|GetAddon}}(sName) returns (table) - gets AddOn instance, or nil if none :{{\|id|API|Apollo|GetAddonInfo}}() :{{\|id|API|Apollo|GetAPIVersion}}() :{{\|id|API|Apollo|GetAssetFolder}}() returns (string) - gets the asset root folder :{{\|id|API|Apollo|GetConsoleVariable}}(sVar) returns (any) - get [[\CVar]] sVar. can be nil :{{\|id|API|Apollo|GetDisplaySize}}() :{{\|id|API|Apollo|GetGameFonts}}() returns (table) - gets list of fonts as: index, name, face, size :{{\|id|API|Apollo|GetMaxResolutionWidth}}() :{{\|id|API|Apollo|GetMetaKeysDown}}() :{{\|id|API|Apollo|GetMinResolutionWidth}}() :{{\|id|API|Apollo|GetMouse}}() :{{\|id|API|Apollo|GetMouseTargetWindow}}() :{{\|id|API|Apollo|GetObjectSize}}(pObject) - get size of Object pObject :{{\|id|API|Apollo|GetPackage}}(sName) returns (table) - as: bAddon, nVersion, strLoadError, strName, tPackage :{{\|id|API|Apollo|GetScreenSize}}() returns (width,height) - gets screen width and height :{{\|id|API|Apollo|GetStrata}}() :{{\|id|API|Apollo|GetString}}(sCheck) returns (string) - get localized string string or stringID :{{\|id|API|Apollo|GetTextWidth}}() :{{\|id|API|Apollo|GetTickCount}}() returns (number) - gets the tick count :{{\|id|API|Apollo|GetWindowsInStratum}}() :{{\|id|API|Apollo|IsAltKeyDown}}() returns (boolean) - is alt is down :{{\|id|API|Apollo|IsCapsLockOn}}() :{{\|id|API|Apollo|IsControlKeyDown}}() returns (boolean) - is ctrl is down :{{\|id|API|Apollo|IsShiftKeyDown}}() returns (boolean) - is shift is down :{{\|id|API|Apollo|IsSpriteLoaded}}() :{{\|id|API|Apollo|IsWindowSubclassRegistered}}() :{{\|id|API|Apollo|LinkAddon}}(pModuleToLink,nHandlerRef) - runs pModuleToLink's AddPodInfo :{{\|id|API|Apollo|LoadAnimations}}(sFile) returns (boolean) - loads XML sFile animation. returns success :{{\|id|API|Apollo|LoadForm}}(sFile,sForm,wndParent,tHandler) returns (window) - load window from specified file :{{\|id|API|Apollo|LoadGlobalAnchors}}(sFile) :{{\|id|API|Apollo|LoadSprites}}(sFile,sDoc) - loads XML sFile and sDoc animation :{{\|id|API|Apollo|NoOp}}() returns (number) - returns 0 and does nothing :{{\|id|API|Apollo|ParseInput}}(sInput) returns (string) - process input, such as slash command, etc :{{\|id|API|Apollo|RegisterAddon}}(nEventHandler,sLoad,sSave,sRestore) :{{\|id|API|Apollo|RegisterEventHandler}}(sEventName,sFunction,tHandler) - map an event to a handler :{{\|id|API|Apollo|RegisterPackage}}(tPackage,sName,nVersion,tDependents) :{{\|id|API|Apollo|RegisterSlashCommand}}(sCommand,sFunction,tHandler) - map a [[\Slash command|command]] to a handler :{{\|id|API|Apollo|RegisterTimerHandler}}(sTimerName,sFunction,tHandler) :{{\|id|API|Apollo|RegisterWindowSubclass}}() :{{\|id|API|Apollo|RemoveEventHandler}}(sEventName,tHandler) :{{\|id|API|Apollo|ResetConsoleVariable}}(sVar) :{{\|id|API|Apollo|SetConsoleVariable}}(sVar,pMD) - set a console variable :{{\|id|API|Apollo|SetCursor}}(pCursor) :{{\|id|API|Apollo|SetGlobalAnchor}}(sName,fPoint,nOffset,bOverwrite) :{{\|id|API|Apollo|SetMaxResolutionWidth}}() :{{\|id|API|Apollo|SetMinResolutionWidth}}() :{{\|id|API|Apollo|SetNavTextAnchor}}() :{{\|id|API|Apollo|StartTimer}}(sTimerName) - starts the named timer sTimerName :{{\|id|API|Apollo|StopTimer}}(sTimerName) - stops the named timer sTimerName :{{\|id|API|Apollo|SuspendAddon}}(nId) :{{\|id|API|Apollo|UnlinkAddon}}() ==== Enums ==== :{{\|id|API|Apollo|AddonLoadStatus}} [Loading, Loaded, LoadingError] :{{\|id|API|Apollo|DragDropCancelReason}} [EscapeKey, DroppedOnNothing, ClickedOnNothing, ClickedOnWorld, WindowMove] :{{\|id|API|Apollo|DragDropQueryResult}} [PassOn, Ignore, Accept, Invalid] ==== Events ==== :{{\|id|APIE|Apollo|DragDropSysBegin}}(wndSource,sType,iData) :{{\|id|APIE|Apollo|DragDropSysEnd}}(sType,iData) :{{\|id|APIE|Apollo|LuaError}}(tAddon,sError,bCanIgnore) :{{\|id|APIE|Apollo|ModuleLoaded}}() :{{\|id|APIE|Apollo|ModuleRestore}}() :{{\|id|APIE|Apollo|SaveModules}}() :{{\|id|APIE|Apollo|SystemKeyDown}}(iKey) :{{\|id|APIE|Apollo|TextMessage}}(iType,sMessage) === [[\API AttributeMilestonesLib|AttributeMilestonesLib]] === === [[\API ChallengesLib|ChallengesLib]] === === [[\API CharacterScreenLib|CharacterScreenLib]] === === [[\API ChatSystemLib|ChatSystemLib]] === :{{\|id|API|ChatSystemLib|Command}}() :{{\|id|API|ChatSystemLib|CreateChannel}}() - Currently has no implementation :{{\|id|API|ChatSystemLib|GetChannels}}() :{{\|id|API|ChatSystemLib|GetCommands}}() :{{\|id|API|ChatSystemLib|GetEmotes}}() :{{\|id|API|ChatSystemLib|GetInputTypeForString}}(sText) returns (table) - eType, nChannel, sChatType, sCommand, sAbbrev, sArgs, bCommandSet :{{\|id|API|ChatSystemLib|JoinChannel}}() - Currently has no implementation :{{\|id|API|ChatSystemLib|LeaveChannel}}() - Currently has no implementation :{{\|id|API|ChatSystemLib|PostOnChannel}}() :{{\|id|API|ChatSystemLib|PrepareInfractionReport}}() :{{\|id|API|ChatSystemLib|SendInfractionReport}}() :{{\|id|API|ChatSystemLib|SendOnChannel}}() :{{\|id|API|ChatSystemLib|SendOnChannel}}(nChannelNumber,sText) :{{\|id|API|ChatSystemLib|SplitInput}}() === [[\API CombatFloater|CombatFloater]] === === [[\API CombatFloaters|CombatFloaters]] === === [[\API CommunicatorLib|CommunicatorLib]] === === [[\API CraftingLib|CraftingLib]] === === [[\API CREDDExchangeLib|CREDDExchangeLib]] === === [[\API CSIsLib|CSIsLib]] === === [[\API CustomerSurveyLib|CustomerSurveyLib]] === === [[\API DatacubeLib|DatacubeLib]] === === [[\API DemoSummary|DemoSummary]] === === [[\API GameLib|GameLib]] === :{{\|id|API|GameLib|AcceptDuel}}() :{{\|id|API|GameLib|AreAnyItemsNew}}() :{{\|id|API|GameLib|AreQuestUnitCalloutsVisible}}() :{{\|id|API|GameLib|AssignMasterLoot}}() :{{\|id|API|GameLib|BuyBankBagSlot}}() :{{\|id|API|GameLib|CanDisembarkVehicle}}() :{{\|id|API|GameLib|CanDye}}() :{{\|id|API|GameLib|CanEditKeySet}}(nKeySet) returns (boolean) - true if nKeySet is NOT any of the default 3 input key sets :{{\|id|API|GameLib|CanRepairAll}}() :{{\|id|API|GameLib|CanVacuum}}() returns (boolean) :{{\|id|API|GameLib|Cheat_MakeMeLevel50}}() :{{\|id|API|GameLib|ClearAllTargetMarkers}}() :{{\|id|API|GameLib|ClearCityDirection}}() :{{\|id|API|GameLib|CodeEnumGenericError}}() :{{\|id|API|GameLib|DeclineDuel}}() :{{\|id|API|GameLib|DisableTutorialType}}() :{{\|id|API|GameLib|Disembark}}() :{{\|id|API|GameLib|DoAnyItemsBeginQuest}}() :{{\|id|API|GameLib|DragDropDataToItemLocation}}(nData) returns (table) - {eType, nBagIndex, nBagSlot} :{{\|id|API|GameLib|DyeItems}}() :{{\|id|API|GameLib|ForfeitDuel}}() :{{\|id|API|GameLib|GetAbilityPoints}}() :{{\|id|API|GameLib|GetAccountRealmCharacter}}() :{{\|id|API|GameLib|GetAllTutorials}}() :{{\|id|API|GameLib|GetAllZoneCompletionMapZones}}() :{{\|id|API|GameLib|GetAttributePoints}}() :{{\|id|API|GameLib|GetAvailableTargetMarkers}}() :{{\|id|API|GameLib|GetBindPoint}}() :{{\|id|API|GameLib|GetCCStateStunTimeRemaining}}() :{{\|id|API|GameLib|GetCharacterList}}() returns (table) - a counter as an integer and a character name list entry as a string :{{\|id|API|GameLib|GetCharInputKeySet}}(nCharIndex) returns (table) - Gets the key bindings specified by nCharIndex. Returns nil if a wait is needed for the server to reply for the key binding list. (as of 6697 can crash client) :{{\|id|API|GameLib|GetClassInnateAbility}}() :{{\|id|API|GameLib|GetClassInnateAbilitySpells}}() :{{\|id|API|GameLib|GetClassName}}() returns (string) - Gets localized class name corresponding to nId from DbFileTable_Class_GetByID, or nil if none :{{\|id|API|GameLib|GetControlledUnit}}() returns (unit) - or nil if none :{{\|id|API|GameLib|GetCostumeCount}}() :{{\|id|API|GameLib|GetCostumeIndex}}() :{{\|id|API|GameLib|GetCostumeItem}}() :{{\|id|API|GameLib|GetCostumeItemIcon}}(self.nCurrentCostume, idx) :{{\|id|API|GameLib|GetCostumeUnlockLevel}}() :{{\|id|API|GameLib|GetCredits}}() :{{\|id|API|GameLib|GetCurrentClassInnateAbilityIndex}}() :{{\|id|API|GameLib|GetCurrentClassInnateAbilitySpell}}() :{{\|id|API|GameLib|GetCurrentWorldId}}() :{{\|id|API|GameLib|GetCurrentZoneId}}() :{{\|id|API|GameLib|GetCurrentZoneMap}}() :{{\|id|API|GameLib|GetCurrentZonePvpRules}}() :{{\|id|API|GameLib|GetCurrInputKeySet}}() returns (number) :{{\|id|API|GameLib|GetDefaultRecallCommand}}() :{{\|id|API|GameLib|GetDuelOpponent}}(unitPlayer) :{{\|id|API|GameLib|GetDuelState}}() :{{\|id|API|GameLib|GetDyeCost}}() :{{\|id|API|GameLib|GetDyeUnlockLevel}}() :{{\|id|API|GameLib|GetEmptyInventorySlots}}() :{{\|id|API|GameLib|GetErrorCategories}}() :{{\|id|API|GameLib|GetFrameRate}}()*10)*0.1 :{{\|id|API|GameLib|GetGadgetAbility}}() :{{\|id|API|GameLib|GetGameCommand}}() :{{\|id|API|GameLib|GetGameExitInfo}}() :{{\|id|API|GameLib|GetGameTime}}() returns (number) - game client 'up time' in seconds, fractional milliseconds :{{\|id|API|GameLib|GetGearScore}}() :{{\|id|API|GameLib|GetGuildHolomarkDistance}}() :{{\|id|API|GameLib|GetGuildHolomarkVisible}}(GameLib.GuildHolomark.Left) :{{\|id|API|GameLib|GetInputActionCategories}}() returns (table) - list of {id, strName} action categories :{{\|id|API|GameLib|GetInputActionNameByEnum}}() :{{\|id|API|GameLib|GetInputKeyNameText}}(tCurrInput) returns (string) - Gets input key's name for a tCurrInput ({eDevice = GameLib.CodeEnumInputDevice.None, nCode, nModifier}), or "<Unbound>" if none :{{\|id|API|GameLib|GetInputKeySet}}(nInputSet) returns (table) - Gets key bindings specified by nInputSet. Returns nil if a wait is needed for the server to reply for the key binding list :{{\|id|API|GameLib|GetInstanceSettings}}() :{{\|id|API|GameLib|GetInteractiveUnit}}() returns (number) - Gets closest interactive unit id :{{\|id|API|GameLib|GetKeyBinding}}(CastObjectiveAbility) :{{\|id|API|GameLib|GetKeyBindingByEnum}}(eInputAction) :{{\|id|API|GameLib|GetKeyBindings}}() returns (table) - Gets a list of the current key bindings as: arInputs, idAction, idCategory, nDisplayIndex, strAction, strActionLocalized :{{\|id|API|GameLib|GetKnownDyes}}() :{{\|id|API|GameLib|GetLevelUpFanfareDuration}}() :{{\|id|API|GameLib|GetLevelUpUnlock}}() :{{\|id|API|GameLib|GetLevelUpUnlockTypes}}() :{{\|id|API|GameLib|GetLocalTime}}() returns (table) - as: nYear, nMonth, nDay, nDayOfWeek, nHour, nMinute, nSecond, strFormattedTime :{{\|id|API|GameLib|GetLootRolls}}() :{{\|id|API|GameLib|GetMasterLoot}}() :{{\|id|API|GameLib|GetNextBankBagCost}}() :{{\|id|API|GameLib|GetNumBankBagSlots}}() :{{\|id|API|GameLib|GetNumClassInnateAbilitySpells}}() :{{\|id|API|GameLib|GetPendingLevelUpUnlocks}}() returns (table) :{{\|id|API|GameLib|GetPendingRemovalWarningRemaining}}() :{{\|id|API|GameLib|GetPendingTutorials}}() :{{\|id|API|GameLib|GetPlayerCurrency}}(nType, eGroupType) returns ([[\API TYPE money|money]]) - gets currency data for current player :{{\|id|API|GameLib|GetPlayerGenericVehicleUnit}}() :{{\|id|API|GameLib|GetPlayerLevel}}() :{{\|id|API|GameLib|GetPlayerMoney}}() - "Deprecated" :{{\|id|API|GameLib|GetPlayerMountUnit}}() returns (unit) - gets the players mount unit, else 1, and nil if none :{{\|id|API|GameLib|GetPlayerPets}}() :{{\|id|API|GameLib|GetPlayerTaxiUnit}}() returns (unit) - gets the taxi that the player is currently on, else 1 and nil if null :{{\|id|API|GameLib|GetPlayerUnit}}() returns ([[\API TYPE unit|unit]]) - gets current player :{{\|id|API|GameLib|GetPlayerUnitByName}}() :{{\|id|API|GameLib|GetPlayerVehicleUnit}}() returns (unit) - gets the players vehicle unit, else 1 and nil if none :{{\|id|API|GameLib|GetPvpFlagInfo}}() :{{\|id|API|GameLib|GetPvpGraveyards}}() returns (table) - (not implemented) returns as: infoId and available of Graveyard :{{\|id|API|GameLib|GetRealmName}}() returns (string) :{{\|id|API|GameLib|GetRepairAllCost}}() :{{\|id|API|GameLib|GetReputationInfo}}() :{{\|id|API|GameLib|GetReputationLevels}}() :{{\|id|API|GameLib|GetServerTime}}() returns (table) - as: nYear, nMonth, nDay, nDayOfWeek, nHour, nMinute, nSecond, strFormattedTime :{{\|id|API|GameLib|GetShortcutMount}}() :{{\|id|API|GameLib|GetShortcutPotion}}() :{{\|id|API|GameLib|GetSpell}}(wndControl:GetAbilityTierId()) :{{\|id|API|GameLib|GetSpellThresholdTimePrcntDone}}() :{{\|id|API|GameLib|GetSpellThresholdTimePrcntLeft}}() :{{\|id|API|GameLib|GetStuckCooldowns}}() :{{\|id|API|GameLib|GetTargetMarkerIcon}}() :{{\|id|API|GameLib|GetTargetUnit}}() returns (unit) - gets the target unit, else 0 if none :{{\|id|API|GameLib|GetTeleportIlliumSpell}}():GetBaseSpellId() :{{\|id|API|GameLib|GetTeleportThaydSpell}}():GetBaseSpellId() :{{\|id|API|GameLib|GetTextTypeMaxLength}}(GameLib.CodeEnumUserText.GuildName) :{{\|id|API|GameLib|GetTickCount}}() returns (number) - Gets tick count truncated to integer :{{\|id|API|GameLib|GetTotalAbilityPoints}}() :{{\|id|API|GameLib|GetTotalInventorySlots}}() :{{\|id|API|GameLib|GetTutorial}}(nTutorialId) :{{\|id|API|GameLib|GetTutorialLayouts}}() :{{\|id|API|GameLib|GetTutorialPopupContext}}() :{{\|id|API|GameLib|GetTutorialsForCategory}}() :{{\|id|API|GameLib|GetTutorialVisibilityFlags}}() :{{\|id|API|GameLib|GetUnitById}}() :{{\|id|API|GameLib|GetUnitScreenPosition}}() :{{\|id|API|GameLib|GetUnlocksForLevel}}(nSpecificLevel, nSystem, true) :{{\|id|API|GameLib|GetVersionInfo}}() :{{\|id|API|GameLib|GetWorldCompletionPercent}}() :{{\|id|API|GameLib|GetWorldDifficulty}}() :{{\|id|API|GameLib|GetWorldGameMode}}() :{{\|id|API|GameLib|GetWorldTimeOfDay}}() returns (number) - realm time from 0 to return/3600=24 wrapping. not real time :{{\|id|API|GameLib|GetWorldTooltipContainer}}() :{{\|id|API|GameLib|GetXpBonusData}}(nWho) returns (table) - Gets description of xp bonus as: ? :{{\|id|API|GameLib|GetZoneCompletion}}() :{{\|id|API|GameLib|GetZoneCompletionTypes}}() :{{\|id|API|GameLib|GetZoneExplorationPercent}}() :{{\|id|API|GameLib|HasBindPoint}}() :{{\|id|API|GameLib|HasTutorialSound}}(nTutorialId, nPassedPage) :{{\|id|API|GameLib|InitiateDuel}}() :{{\|id|API|GameLib|IsCharacterLoaded}}() returns (boolean) :{{\|id|API|GameLib|IsControlledUnit}}(unit) returns (boolean) - check if unit is a controlled unit :{{\|id|API|GameLib|IsCostumeSlotVisible}}() :{{\|id|API|GameLib|IsCurrentInnateAbilityActive}}() :{{\|id|API|GameLib|IsIgnoringDuelRequests}}() :{{\|id|API|GameLib|IsInLocation}}() :{{\|id|API|GameLib|IsInWorldZone}}(idSubZone) :{{\|id|API|GameLib|IsKeyBindable}}(nCode, eModifier) :{{\|id|API|GameLib|IsLevelUpUnlockViewed}}() :{{\|id|API|GameLib|IsMouseLockOn}}() :{{\|id|API|GameLib|IsNeedRollAllowed}}(tCurrentElement.nLootId) :{{\|id|API|GameLib|IsOverdriveActive}}() :{{\|id|API|GameLib|IsPvpFlagged}}() :{{\|id|API|GameLib|IsPvpServer}}() :{{\|id|API|GameLib|IsSpellSurgeActive}}() :{{\|id|API|GameLib|IsTextValid}}(strInfo, GameLib.CodeEnumUserText.GuildInfoMessage, GameLib.CodeEnumUserTextFilterClass.Strict) :{{\|id|API|GameLib|IsTutorialCategoryVisible}}(nType) :{{\|id|API|GameLib|IsTutorialNoPageAlert}}(nTutorialId) :{{\|id|API|GameLib|IsTutorialViewed}}() :{{\|id|API|GameLib|IsZoneInZone}}() :{{\|id|API|GameLib|ItemLocationToDragDropData}}(nLocationType,nBagIndex,nBagSlot) returns (number) :{{\|id|API|GameLib|LeavePendingRemovalInstance}}() :{{\|id|API|GameLib|MarkCityDirection}}(wndHandler:GetData() :{{\|id|API|GameLib|MarkLevelUpUnlockViewed}}() :{{\|id|API|GameLib|MarkTutorialViewed}}(tEntry.id, true) :{{\|id|API|GameLib|OnClosedInstanceSettings}}() :{{\|id|API|GameLib|PassOnLoot}}(self.wndMain:GetData() :{{\|id|API|GameLib|PauseGameActionInput}}(bPaused) :{{\|id|API|GameLib|PlayTutorialSound}}() :{{\|id|API|GameLib|RecallShardBind}}() - (not implemented) bind should receive an id of a shard location :{{\|id|API|GameLib|RecallShardGetInfo}}() returns (bExists,bCanUse,strLocation,idLocation,fCooldown) :{{\|id|API|GameLib|RecallShardUse}}() - (not implemented) :{{\|id|API|GameLib|ReportBug}}(tSub.nId, self.unitSelected, self.idQuest, self.wndReportBug:FindChild("Description"):GetText()) :{{\|id|API|GameLib|ResetAttributePoints}}() :{{\|id|API|GameLib|ResetLevelUpUnlocks}}() :{{\|id|API|GameLib|ResetSingleInstance}}() :{{\|id|API|GameLib|ResetTutorials}}() :{{\|id|API|GameLib|RollOnLoot}}(self.wndMain:GetData()) :{{\|id|API|GameLib|SearchRelationshipStatusByCharacterName}}() :{{\|id|API|GameLib|SetCostumeIndex}}() :{{\|id|API|GameLib|SetCostumeItem}}(self.nCurrentCostume, wndControl:GetData(), uItemToImprint:GetInventoryId()) :{{\|id|API|GameLib|SetCostumeSlotVisible}}() :{{\|id|API|GameLib|SetCurrentClassInnateAbilityIndex}}(wndHandler:GetData()) :{{\|id|API|GameLib|SetCurrInputKeySet}}(nInputSet) returns (boolean) - Updates InputSet specified by nInputSet. Returns false if a wait is needed for the server to reply for the key binding list. :{{\|id|API|GameLib|SetDefaultRecallCommand}}(GameLib.CodeEnumRecallCommand.House) :{{\|id|API|GameLib|SetIgnoreDuelRequests}}() :{{\|id|API|GameLib|SetInstanceSettings}}(eDifficulty, self.wndMain:GetRadioSel("InstanceSettings_LocalRadioGroup_Rallying")) :{{\|id|API|GameLib|SetKeyBindings}}(tInputTable) - Runs the SaveInputKeySet after updating the key bindings table :{{\|id|API|GameLib|SetMouseLock}}() :{{\|id|API|GameLib|SetSharedChallengePreference}}() :{{\|id|API|GameLib|SetShortcutMount}}(tSelectedSpellObj:GetId()) :{{\|id|API|GameLib|SetShortcutPotion}}(tSelectedPotion:GetItemId()) :{{\|id|API|GameLib|SetTargetUnit}}(unit) :{{\|id|API|GameLib|SetWorldTooltipContainer}}() :{{\|id|API|GameLib|ShowGuildHolomark}}() :{{\|id|API|GameLib|ShowUI}}() :{{\|id|API|GameLib|SpendAttributePoints}}() :{{\|id|API|GameLib|StopTutorialSound}}() :{{\|id|API|GameLib|SupportStuck}}() :{{\|id|API|GameLib|TogglePvpFlags}}() :{{\|id|API|GameLib|ToggleQuestUnitCallouts}}() :{{\|id|API|GameLib|ToggleTutorialVisibilityFlags}}(entry.wnd:FindChild("MiddleLevelViewBtn"):GetData()) :{{\|id|API|GameLib|UIExitCinematics}}() :{{\|id|API|GameLib|UIStartCinematics}}() :{{\|id|API|GameLib|WhiteOutFadeIn}}() :{{\|id|API|GameLib|WhiteOutFadeOut}}() :{{\|id|API|GameLib|WorldLocToScreenPoint}}() ==== Enums ==== :{{\|id|API|GameLib|CityDirectionType}} [Mailbox,Bank,AuctionHouse,CommodityMarket, AbilityVendor, Tradeskill, General, HousingNpc, Transport] :{{\|id|API|GameLib|CodeEnumAddonSaveLevel}} [General,Account,Realm,Character] :{{\|id|API|GameLib|CodeEnumClass}} [Warrior,Engineer,Esper,Medic, Stalker, Spellslinger] :{{\|id|API|GameLib|CodeEnumCombatResult}} [Avoid,Critical,Hit,NeedsTelegraphEvaluation, OutsideTelegraph, OutsideTelegraphInvalid, InsideTelegraph, NeedsHitResultCalc] :{{\|id|API|GameLib|CodeEnumConfirmButtonType}} [SendMail,CommitTrade,DeleteItem,SalvageItem] :{{\|id|API|GameLib|CodeEnumDamageType}} [Physical,Tech,Magic,Heal, HealShields, Fall, Suffocate] :{{\|id|API|GameLib|CodeEnumDuelState}} [None,Pending,WaitingToAccept,Dueling] :{{\|id|API|GameLib|CodeEnumEquippedItems}} [Chest,Legs,Head,Shoulder, Feet, Hands, WeaponTool, WeaponAttachment, System, Augment, Implant, Gadget, Shields, WeaponPrimary, Bag0, Bag1, Bag2, Bag3, BankBag0, BankBag1, BankBag2, BankBag3, BankBag4] :{{\|id|API|GameLib|CodeEnumExitEvent}} [None,Camp,Quit] :{{\|id|API|GameLib|CodeEnumGameCommandType}} [GadgetAbility,DefaultAttack,ClassInnateAbility, ActivateTarget, FollowTarget, Sprint, ToggleWalk, Dismount, Vacuum, PathAction, ToggleScannerBot, DashForward, DashBackward, DashLeft, DashRight, PathAction2, Interact, GoToBind, GoToHouse, EscapeHouse, GoToWarplot, WarplotBossTokenUI, SummonMount, UsePotion, GoToIllium, GoToThayd] :{{\|id|API|GameLib|CodeEnumGenericError}} [Ok,Params,PlayerBusy,UnknownTargetUnit, TargetFaction, DbFailure, Item_BadId, Reserved02, Reserved03, Reserved04, Vendor_StackSize, Vendor_SoldOut, Vendor_UnknownItem, Vendor_FailedPreReq, Vendor_NotAVendor, Vendor_TooFar, Vendor_BadItemRec, Vendor_NotEnoughToFillQuantity, Vendor_NotEnoughCash, Vendor_UniqueConstraint, Vendor_ItemLocked, Vendor_IWontBuyThat, Vendor_NoQuantity, Vendor_BagIsNotEmpty, Item_OverFlowChestCreated, Item_InventoryFull, Item_UnknownItem, Item_QuestViolation, Item_Unique, Item_NotValidforSlot, Item_Locked, Item_AlreadyEquipped, Item_NotEquipped, Item_BagMustBeEmpty, Item_CannotFindBag, Item_BagToSmall, Item_CantPutBagInItself, Item_WrongRace, Item_WrongClass, Item_FailedProficiency, Item_LevelToLow, Embark_PlayerAlreadyinSeat, Embark_PlayerUnableToEmbark, Embark_InvalidVehicleUnit, Embark_NoSplineForTaxi, Embark_VehicleIsBroken, Embark_InvalidSeat, Embark_SeatTaken, Embark_SeatEmpty, Embark_NotInRange, Embark_CannotDoWhileOnTaxi, Mail_CannotFindPlayer, Mail_FailedToCreate, Vendor_CuratorOnlyBuysRelics, Vendor_CannotBuyRelics, Player_CantDoWhileDead, Vendor_NoBuyer, Vendor_NoVendor, Vendor_Buyer_NoActionCC, Vendor_Vendor_NoActionCC, Vendor_Vendor_Disposition, Player_CannotWhileInCombat, Mail_Busy, Mail_MailBoxOutOfRange, Mail_NoAttachment, Mail_InsufficientFunds, Mail_InvalidInventorySlot, Mail_UniqueExists, Mail_CannotDelete, Mail_DoesNotExist, Item_CannotBeSalvaged, Conversion_BadConversionRec, Conversion_CannotRemoveSource, Conversion_CannotAddTarget, Faction_NotEnoughRep, Item_NoItems, Craft_TierTooLow, Craft_MissingMaterials, Craft_IncompleteCircuit, Craft_SocketNotModdable, Craft_DuplicateChip, DisEmbark_PlayerNotInWorld, Item_NeedsRepair, Craft_TooManyAdditives, Item_SlotDisabled, Matching_NoRoleSelected, Instance_NotFound, Auction_NotReady, Auction_CannotFillOrder, Mail_CannotTransferItem, Mail_InvalidText, Mail_CanNotHaveCoDAndGift, Auction_TooManyOrders, Auction_OrderTooBig, Auction_NotFound, Auction_BidTooLow, Auction_OwnItem, Auction_BidTooHigh, Auction_AlreadyHasBid, Mail_InvalidDeliverySpeed, Housing_InvalidDecorPlacement, Instance_LimitExceeded, Craft_UnknownSchematic, Craft_MicrochipInvalidSocket, Craft_MicrochipInvalidSlot, Craft_FailChanceTooHigh, Instance_EncounterInProgress, Instance_Full, Housing_CrateFull, TargetBusy, Mail_CannotReturn, Mail_CannotMailSelf, Faction_AtMax, Housing_MaxDecor, Auction_ItemAuctionDisabled, Auction_CommodityDisabled, Mail_CannotMailTrialAccount, MissingEntitlement, Instance_TransferPending, Instance_InvalidDestination, Instance_NotInGroup, Instance_DifferentSavedInstance, Instance_InstanceInUse, Item_WrongFaction, Instance_WrongLevel] :{{\|id|API|GameLib|CodeEnumInputAction}} [Nothing,Options,CharacterPanel,Inventory, QuestLog, Communicator, Escape, Shift, Control, Select, MouseInteract, Interact, HostileInteract, TargetSelf, TargetParty1, TargetParty2, TargetParty3, TargetParty4, TargetNextEnemy, TargetPreviousEnemy, TargetNextFriend, TargetPreviousFriend, AssistTarget, MoveForward, MoveBackward, StrafeLeft, StrafeRight, TurnLeft, TurnRight, PitchUp, PitchDown, MouseTurn, SprintModifier, VacuumLoot, PathAction, Jump, Dismount, ToggleSit, ToggleWalk, ToggleAutoRun, CameraUp, CameraDown, CameraLeft, CameraRight, CameraIn, CameraOut, MouseLook, CastObjectiveAbility, LimitedActionSet1, LimitedActionSet2, LimitedActionSet3, LimitedActionSet4, LimitedActionSet5, LimitedActionSet6, LimitedActionSet7, LimitedActionSet8, CastGadgetAbility, CastPathAbility, ActionBar0_Unused1, ActionBar0_Unused2, ActionBar1_Slot1, ActionBar1_Slot2, ActionBar1_Slot3, ActionBar1_Slot4, ActionBar1_Slot5, ActionBar1_Slot6, ActionBar1_Slot7, ActionBar1_Slot8, ActionBar1_Slot9, ActionBar1_Slot10, ActionBar1_Slot11, ActionBar1_Slot12, ActionBar2_Slot1, ActionBar2_Slot2, ActionBar2_Slot3, ActionBar2_Slot4, ActionBar2_Slot5, ActionBar2_Slot6, ActionBar2_Slot7, ActionBar2_Slot8, ActionBar2_Slot9, ActionBar2_Slot10, ActionBar2_Slot11, ActionBar2_Slot12, ActionBar3_Slot1, ActionBar3_Slot2, ActionBar3_Slot3, ActionBar3_Slot4, ActionBar3_Slot5, ActionBar3_Slot6, ActionBar3_Slot7, ActionBar3_Slot8, ActionBar3_Slot9, ActionBar3_Slot10, ActionBar3_Slot11, ActionBar3_Slot12, Unused1, Unused2, Unused3, Unused4, Unused5, Unused6, SetStance1, SetStance2, SetStance3, Unused7, Unused20, Unused11, ToggleInterface, ToggleFramerate, Unused21, Unused23, Unused22, WorldMap, LimitedActionSetBuilder, Unused8, Unused9, ExplicitMouseLook, ToggleWeapons, LeftMouseHold, RightMouseHold, CenterMouseHold, CastInnateAbility, MarkingMenuLeftClick, MarkingMenuLeftHold, MarkingMenuRightClick, MarkingMenuRightHold, HUDShowQuests, ToggleCameraAngle, ToggleScannerBot, Codex, PathAction2, FloatingActionBar_Slot1, FloatingActionBar_Slot2, FloatingActionBar_Slot3, FloatingActionBar_Slot4, FloatingActionBar_Slot5, FloatingActionBar_Slot6, ScaleRampedMotion, ScaleRampedRotation, BrakeRampedMotion, BrakeRampedRotation, MoveDown, GroupFinder, CastMiscSpell, SetTargetMark1, SetTargetMark2, SetTargetMark3, SetTargetMark4, SetTargetMark5, SetTargetMark6, SetTargetMark7, SetTargetMark8, DashForward, DashBackward, DashLeft, DashRight, Unused12, Unused13, ChatReply, ChatReWhisper, Unused14, Unused15, Unused16, Unused17, Unused18, Unused19, TargetNearestEnemy, TargetNearestFriend, Achievements, AuctionListings, Challenges, Unused10, FriendsList, Lore, Mail, Path, Reputation, Social, Tradeskills, DirectionalDash, PrimaryPetActionBar_Slot1, PrimaryPetActionBar_Slot2, PrimaryPetActionBar_Slot3, PrimaryPetActionBar_Slot4, PrimaryPetActionBar_Slot5, PrimaryPetActionBar_Slot6, GhostModeMap, Mount, UsePotion, Guild] :{{\|id|API|GameLib|CodeEnumInputDevice}} [None,Keyboard,Mouse] :{{\|id|API|GameLib|CodeEnumInputEventType}} [Raw,Click,Hold,DoubleClick, DoubleHold, Rapid] :{{\|id|API|GameLib|CodeEnumInputModifier}} [Shift,Control,Alt] :{{\|id|API|GameLib|CodeEnumInputModifierScancode}} [LeftShift,LeftCtrl,LeftAlt,RightShift, RightCtrl, RightAlt] :{{\|id|API|GameLib|CodeEnumInputMouse}} [Left,Right,Middle,X1, X2, WheelUp, WheelDown] :{{\|id|API|GameLib|CodeEnumInputSets}} [Default1,Default2,Default3,Account, Character, Count] :{{\|id|API|GameLib|CodeEnumItemSlots}} [Chest,Legs,Head,Shoulder, Feet, Hands, Tool, Weapon, Shields, Gadget, Attachment, System, Augment, Implant] :{{\|id|API|GameLib|CodeEnumMapObjectType}} [Unit,Object,PathObjective,QuestObjective] :{{\|id|API|GameLib|CodeEnumMapOverlayType}} [Unit,Object,PathObjective,QuestObjective] :{{\|id|API|GameLib|CodeEnumMissType}} [Dodge] :{{\|id|API|GameLib|CodeEnumPetStance}} [Assist,Stay,Passive,Defensive, Aggressive] :{{\|id|API|GameLib|CodeEnumRace}} [Human,Granok,Aurin,Draken, Mechari, Mordesh, Chua] :{{\|id|API|GameLib|CodeEnumRecallCommand}} [BindPoint,House,Warplot,Illium, Thayd] :{{\|id|API|GameLib|CodeEnumStoryPanel}} [Default,Low,Center,FullScreen, Whiteout, Urgent, FullScreenBlackNoFlash, Informational] :{{\|id|API|GameLib|CodeEnumStoryPanelStyle}} [Default,Paper,Electronic,Eldan, Arcane, Natural, Exile, Dominion] :{{\|id|API|GameLib|CodeEnumTutorial}} [Crafting_UI_Tutorial,Special_Ability_Chips,Tradeskill_Codex_Tutorial, Crafting_Components_Tutorial, Crafting_Station_Tutorial, Basic_Salvaging_Tutorial, QuestCommunicatorGiven, QuestAccepted, QuestAchieved, QuestBotched, QuestCommunicatorReceived, ChallengeUnlocked, ChallengeCompleted, ChallengeRewardPanel, AchievementCompleted, Telegraphs, NewBindpoint, Path_MissionComplete, Path_EpisodeComplete, Soldier_MissionUnlock, Soldier_TowerDefense, Soldier_Assassinate, Soldier_SWAT, Soldier_Demolition, Soldier_Rescue, Explorer_MissionUnlock, Explorer_Vista, Explorer_ClaimTerritory, Explorer_Door, Explorer_ScavengerHunt, Explorer_PowerMap, Scientist_FieldStudy, Settler_MissionUnlock, Settler_Infrastructure, Settler_DepotActivate, Codex, CharacterPanel, AbilityWindow, Death, Hazards, PublicEventStart, GalacticArchive_NewEntry, Soldier_StopTheThieves, Soldier_WhackAMole, Farmer_Powershrooms, General_Quest_SpellShortcut, CoordinateCrafting, CombatBuff, General_Social, QuestCommunicatorMissed, MailMenu, CSI_PressAndHold, CSI_RapidTapping, CSI_PrecisionTapping, CSI_Memory, CSI_KeyPad, CSI_Metronome, QuestCommunicatorDeclined, General_Lore, GroupFinderMenu, Renown, AMPs, Reputation, Housing_Landscape, Housing_House, Housing_Crate, Housing_Vendor, Housing_Room, General_CREDD, General_AccountServices] :{{\|id|API|GameLib|CodeEnumTutorialAnchor}} [None,Codex,Abilities,Character, Mail, GalacticArchive, Social, GroupFinder, Challenge, Datachron, Inventory, AbilityBar, MiniMap, QuestTracker, HUDAlert, PressAndHold, RapidTapping, PrecisionTapping, Memory, Keypad, Metronome, ShieldBar, InnateAbility, DashMeter, SprintMeter, HealthBar, BuffFrame, ClassResource, QuestCommunicatorReceived, DatachronBody, Recall 31:31 :{{\|id|API|GameLib|CodeEnumTutorialCategory}} [General,Beginner,Combat,PVP, Housing, Challenges, PublicEvents, Adventures, Path_Soldier, Path_Settler, Path_Scientist, Path_Explorer, Class_Warrior, Class_Esper, Class_Spellslinger, Class_Stalker, Class_Medic, Class_Engineer, Class_Charmer, Tradeskill_Outfitter, Tradeskill_Tailor, Tradeskill_Architect, Tradeskill_Miner, Tradeskill_Augmentor, Tradeskill_Survivalist, Tradeskill_Farmer, Tradeskill_Weaponsmith, Tradeskill_Armorer] :{{\|id|API|GameLib|CodeEnumUserText}} [CharacterName,ScientistScanbotName,GuildName, GuildRankName, GuildBankTabName, HousingResidenceName, Chat, MailSubject, MailBody, ChatCustomChannelName, ReadyCheck, FriendshipNote, ChatCustomChannelPassword, GuildMessageOfTheDay, GuildMemberNote, GuildRercuitDescription, GuildInfoMessage, FriendshipAccountName, FriendshipAccountPrivateNote, FriendshipAccountPublicNote, FriendshipAccountEmail, FriendshipInviteNote] :{{\|id|API|GameLib|CodeEnumUserTextFilterClass}} [Strict,Standard,Low] :{{\|id|API|GameLib|CodeEnumVital}} [Invalid,Health,Breath,ShieldCapacity, KineticCell, Resource0, Resource1, Resource2, Resource3, Resource4, Resource5, Resource6, StalkerA, StalkerB, StalkerC, Mana, Resource7, MedicCore, SpellSurge, InterruptArmor, Absorption, PublicResource0, PublicResource1, PublicResource2, Volatility] :{{\|id|API|GameLib|CodeEnumWhoResult}} [OK,Partial,UnderCooldown] :{{\|id|API|GameLib|CodeEnumZoneCompletionType}} [EpisodeQuest,TaskQuest,Challenge,TaxiNode, Datacube, Tale, Journal] :{{\|id|API|GameLib|CodeEnumZonePvpRules}} [None,ExileStronghold,DominionStronghold,Sanctuary, Pvp, ExilePVPStronghold, DominionPVPStronghold] :{{\|id|API|GameLib|DuelStateDuelState}} [None,WaitingToAccept,Pending,Dueling] :{{\|id|API|GameLib|GuildHolomark}} [Left,Right,Back] :{{\|id|API|GameLib|LevelUpUnlock}} [Builder_NewTierPoint,Builder_LASSlot2,Character_GearSlot_Shield, WorldMapNewZone_Deradune, WorldMapAdventure_Astrovoid, Character_GearSlot_Implants, GroupFinder_Dungeons, Character_CostumeSlot6, Builder_AMPPoint, Customization_Mount, WorldMapNewZone_Ellevar, Inventory_Salvage, Character_GearSlot_Gloves, GroupFinder_Warplots, WorldMapNewZone_Malgrave, Builder_LASSlot8, Builder_LASSlot7, Builder_LASSlot4, Builder_AbilityTier2, WorldMapDungeon_Stormtalon, WorldMapAdventure_Galeras, Character_GearSlot_Shoulders, WorldMapDungeon_KelVoreth, GroupFinder_Arenas, Character_GearSlot_Gadgets, Customization_Scanbot, WorldMapNewZone_Grimvault, Character_CostumeSlot2, WorldMapNewZone_Wilderrun, Character_CostumeSlot4, WorldMapAdventure_Whitevale, Character_GearSlot_Helm, WorldMapNewZone_Farside, WorldMapNewZone_Algoroc, Builder_LASSlot6, WorldMapNewZone_NorthernWilds, Builder_AbilityTier8, WorldMapNewZone_EverstarGrove, WorldMapNewZone_Whitevale, Character_GearSlot_WeaponAttachment, GroupFinder_General, WorldMapDungeon_Skullcano, WorldMapNewZone_CrimsonIsle, WorldMapCapital_Illium, Builder_LASSlot5, Builder_AbilityTier5, Character_GearSlot_SupportSystem, WorldMapAdventure_Hycrest, Character_CostumeSlot3, WorldMapNewZone_LevianBay, Builder_AbilityTier6, WorldMapNewZone_Celestion, WorldMapNewZone_Auroria, WorldMapAdventure_NorthernWilds, Builder_AbilityTier4, WorldMapNewZone_Galeras, Builder_AbilityTier3, Character_CostumeSystem, WorldMapCapital_Thayd, Builder_LASSlot3, WorldMapAdventure_Malgrave, Builder_AMPSystem, Character_CostumeSlot5, Builder_TierPointSystem, Builder_AbilityTier7, WorldMapDungeon_SwordMaiden, GroupFinder_Adventures, Character_GearSlot_RaidKey] :{{\|id|API|GameLib|LevelUpUnlockSystem}} [Path,Level] :{{\|id|API|GameLib|LevelUpUnlockType}} [Dungeon_New,Raid_40,Adventure_New, Content_Capital, Content_Feature, Class_LAS_Slot, General_Expanded_Feature, Class_Feature, Class_Attribute, Path_ScanBot, Path_Spell, Path_Title, Gear_Slot, Path_Quest, Social_Feature, Class_Improvement, Raid_20, Path_Item, Class_Tier, Class_Ability, PvP_Battleground, General_Feature, Content_Zone, PvP_Feature] :{{\|id|API|GameLib|MapZone}} [PublicEventIslandStage2,LevianBay,Thayd,Ellevar, halonring, Grimvault, Galeras, LevianBayStarComm1, EasternGrimvault, HalonRingIsland2, Malgrave, LevianBayStarComm3, WesternGrimvault, NorthernGrimvault, EverstarGrove, EternityIslands, Celestion, CrimsonIsle, Auroria, Illium, NorthernWilds, Wilderrun, LevianBayStarComm2, HalonRingIsland3, Whitevale, Algoroc, Deradune] :{{\|id|API|GameLib|SharedChallengePreference}} [AutoAccept,Prompt,AutoReject] :{{\|id|API|GameLib|SupportStuckAction}} [RecallBind,RecallDeath,RecallHouse] === [[\API GenericDialog|GenericDialog]] === :{{\|id|API|GenericDialog|AbortRetryCancel}}() :{{\|id|API|GenericDialog|ColorPicker}}(node.fontColor, CombatFloaterConfig_Options_FontColor_ColorPickerCallback, data) :{{\|id|API|GenericDialog|OkCancel}}() :{{\|id|API|GenericDialog|SetModal}}() :{{\|id|API|GenericDialog|SimpleMessage}}() :{{\|id|API|GenericDialog|SliderBarDialog}}() :{{\|id|API|GenericDialog|SpinnerDialog}}() :{{\|id|API|GenericDialog|TextInput}}() :{{\|id|API|GenericDialog|YesNoCancel}}() === [[\API GroupLib|GroupLib]] === :{{\|id|API|GroupLib|AcceptInvite}}(sMessage) - Accept invite with optional message :{{\|id|API|GroupLib|AcceptMentoring}}() :{{\|id|API|GroupLib|AcceptRequest}}() :{{\|id|API|GroupLib|AmILeader}}() returns (boolean) - Is this unit the leader :{{\|id|API|GroupLib|Bag_GetItemByGuid}}(nGuid) returns (table) - (missing function) Item from group bag specified by nGuid :{{\|id|API|GroupLib|Bag_GetLoot}}() returns (table) - (missing function) Group loot list of: index, LootItem :{{\|id|API|GroupLib|Bag_GetSharedItems}}() returns (table) - (missing function) itemId, icon, name, nStack, ownerName, guid :{{\|id|API|GroupLib|Bag_ShareItem}}(nInventoryId) - (missing function) Share item by nInventoryId :{{\|id|API|GroupLib|Bag_VoteForItem}}(nIdItem,eVote) - (missing function) Vote on bag item nIdItem with eVote :{{\|id|API|GroupLib|CancelMentoring}}() :{{\|id|API|GroupLib|CanLeave}}() :{{\|id|API|GroupLib|CloseMentoringAOIDialog}}() :{{\|id|API|GroupLib|CloseMentoringDialog}}() :{{\|id|API|GroupLib|ConvertToRaid}}() :{{\|id|API|GroupLib|CreateGroup}}() - (missing function) :{{\|id|API|GroupLib|DeclineInvite}}() :{{\|id|API|GroupLib|DenyInvite}}(sMessage) - Deny invite with optional message :{{\|id|API|GroupLib|DenyRequest}}() :{{\|id|API|GroupLib|DisbandGroup}}(sMessage) - Request group disband with optional message :{{\|id|API|GroupLib|GetGroupMaxSize}}() returns (number) :{{\|id|API|GroupLib|GetGroupMember}}(nGroupIndex) returns table - Gets member record for ones based nGroupIndex, else nil :{{\|id|API|GroupLib|GetInstanceDifficulty}}() :{{\|id|API|GroupLib|GetInstanceGameMode}}() :{{\|id|API|GroupLib|GetInvite}}() :{{\|id|API|GroupLib|GetInviteReceivedString}}() returns (string) :{{\|id|API|GroupLib|GetJoinRequestMethod}}() :{{\|id|API|GroupLib|GetLootDistribution}}() returns (number) :{{\|id|API|GroupLib|GetLootRules}}() :{{\|id|API|GroupLib|GetLootThreshold}}() returns (number) :{{\|id|API|GroupLib|GetMemberCount}}() returns (number) :{{\|id|API|GroupLib|GetMemberQuests}}() :{{\|id|API|GroupLib|GetMentoringList}}() :{{\|id|API|GroupLib|GetReferralMethod}}() :{{\|id|API|GroupLib|GetUnitForGroupMember}}(nGroupIndex) returns ([[\API TYPE unit|unit]]) - Unit data for ones based nGroupIndex :{{\|id|API|GroupLib|GotoGroupInstance}}() :{{\|id|API|GroupLib|Group_GetMemberQuests}}(nIndex) - (missing function) :{{\|id|API|GroupLib|Group_RequestQuest}}(unitId,questId) - (missing function) :{{\|id|API|GroupLib|InGroup}}() - Does a lua_pushboolean of InGroup :{{\|id|API|GroupLib|InInstance}}() :{{\|id|API|GroupLib|InInstanceWithMember}}() :{{\|id|API|GroupLib|InRaid}}() :{{\|id|API|GroupLib|Invite}}(sPlayerName,sRealmName,sMessage) - Invite player with optional message :{{\|id|API|GroupLib|IsMemberInGroupInstance}}() :{{\|id|API|GroupLib|Join}}() :{{\|id|API|GroupLib|JoinWorldZonePhase}}() :{{\|id|API|GroupLib|Kick}}(nGroupIndex,sMessage) - Kick player with optional message :{{\|id|API|GroupLib|LeaveGroup}}(sMessage) - Leave or deny incoming invite with optional message :{{\|id|API|GroupLib|LeaveWorldZonePhase}}() :{{\|id|API|GroupLib|Promote}}(nGroupIndex) - Promote player :{{\|id|API|GroupLib|ReadyCheck}}() :{{\|id|API|GroupLib|RequestQuest}}() :{{\|id|API|GroupLib|RequestToJoin}}(nGroupId) - Request to join specified by nGroupId :{{\|id|API|GroupLib|SetCanMark}}() :{{\|id|API|GroupLib|SetInstanceDifficulty}}() :{{\|id|API|GroupLib|SetInstanceGameMode}}() :{{\|id|API|GroupLib|SetInvitePermission}}() :{{\|id|API|GroupLib|SetJoinRequestMethod}}() :{{\|id|API|GroupLib|SetKickPermission}}() :{{\|id|API|GroupLib|SetLootDistribution}}(eLootDist) :{{\|id|API|GroupLib|SetLootRules}}() :{{\|id|API|GroupLib|SetLootThreshold}}(eThresh) :{{\|id|API|GroupLib|SetMainAssist}}() :{{\|id|API|GroupLib|SetMainTank}}() :{{\|id|API|GroupLib|SetRaidAssistant}}() :{{\|id|API|GroupLib|SetReady}}() :{{\|id|API|GroupLib|SetReferralMethod}}() :{{\|id|API|GroupLib|SetRoleDPS}}() :{{\|id|API|GroupLib|SetRoleHealer}}() :{{\|id|API|GroupLib|SetRoleLocked}}() :{{\|id|API|GroupLib|SetRoleTank}}() :{{\|id|API|GroupLib|SwapOrder}}() ==== Enums ==== :{{\|id|API|GroupLib|ActionResult}} [LeaveSuccess,LeaveFailed,DisbandSuccess,DisbandFailed,KickSuccess, KickFailed, PromoteSuccess, PromoteFailed, FlagsSuccess, FlagsFailed, MemberFlagsSuccess, MemberFlagsFailed, NotInGroup, ChangeSettingsFailed, ChangeSettingsSuccess, MentoringInvalidMentor, MentoringInvalidMentee, InvalidGroup, MentoringSelf, ReadyCheckFailed, MentoringNotAllowed, MarkingNotPermitted, InvalidMarkIndex, InvalidMarkTarget, MentoringInCombat, MentoringLowestLevel, MentoringNoAction] :{{\|id|API|GroupLib|ActionResult}} [OrderInvalidMember,OrderFailedLeader,AlreadyInGroupInstance] :{{\|id|API|GroupLib|CodeEnumLootThreshoold}} [Average,Good,Excellent,Superb,Exquisite, Phenomenal, Extraordinary, Legendary, Inferior] :{{\|id|API|GroupLib|Difficulty}} [Normal,Veteran] :{{\|id|API|GroupLib|GameMode}} [Normal,SpeedRun,CompletionRun,Nightmare] :{{\|id|API|GroupLib|HarvestLootRule}} [RoundRobin,FirstTagger] :{{\|id|API|GroupLib|InvitationMethod}} [Open,Neutral,Closed] :{{\|id|API|GroupLib|LeaveReason}} [Leave,Kick,Disbanded] :{{\|id|API|GroupLib|LootRule}} [FreeForAll,RoundRobin,NeedBeforeGreed,Master] :{{\|id|API|GroupLib|LootThreshold}} [Average,Good,Excellent,Superb,Exquisite, Phenomenal, Extraordinary, Legendary, Inferior] :{{\|id|API|GroupLib|RemoveReason}} [Left,Kicked,Disconnected,Disband,RemovedByServer, VoteKicked] :{{\|id|API|GroupLib|Result}} [ExpiredInvitee,ServerControlled,GroupNotFound,NotAcceptingRequests,Busy, SentToLeader, LeaderOffline, WrongFaction, Ok, PlayerAlreadyGrouped, InviteExpired, AlreadyHasPendingInvite, InviteSuccessful, NoPermission, InviteOtherExpired, AlreadyInvitedYou, InvitorNoPermission, ExpriedInvitee] :{{\|id|API|GroupLib|Result}} [Ok,PlayerNotFound,PlayerAlreadyGrouped,InviteExpired,RealmNotFound, AlreadyHasPendingInvite, InviteSuccessful, NoPermission, InviteOtherExpired, AlreadyInvitedYou, InvitorNoPermission] :{{\|id|API|GroupLib|Result}} [RoleFull,NoInvitingSelf] :{{\|id|API|GroupLib|Result}} [Sent,Accepted,Declined,NoPermissions,Grouped, Pending, ExpiredInviter, ExpriedInvitee, IsInvited, InvitedYou, Full] ==== Events ==== :{{\|id|APIE|GroupLib|Group_AcceptInvite}}() :{{\|id|APIE|GroupLib|Group_Changed}}() :{{\|id|APIE|GroupLib|Group_DeclineInvite}}() :{{\|id|APIE|GroupLib|Group_Disbanded}}(nReason,nGroupMemberId,nGroupActorIndex) - Output of a group leave or if group empties and disbands :{{\|id|APIE|GroupLib|Group_Invite_Declined}}(tTableRef) - Outputs the refused invitation to a group invite :{{\|id|APIE|GroupLib|Group_Invite_Result}}(nTableRef) :{{\|id|APIE|GroupLib|Group_Invited}}(nTableRef) :{{\|id|APIE|GroupLib|Group_Other_Joined}}(nTableRef) :{{\|id|APIE|GroupLib|Group_Other_Left}}(nTableRef) :{{\|id|APIE|GroupLib|Group_Other_Promoted}}(tTableRef) - Outputs the promotion of a group member :{{\|id|APIE|GroupLib|Group_Player_Joined}}() :{{\|id|APIE|GroupLib|Group_Player_Left}}() :{{\|id|APIE|GroupLib|Group_Player_Promoted}}() :{{\|id|APIE|GroupLib|Group_QuestList}}(unitId,nTableRef) === [[\API GuildLib|GuildLib]] === This library contains functions and enumerations having to do with guilds and arena teams. :{{\|id|API|GuildLib|Accept}}() :{{\|id|API|GuildLib|Create}}() :{{\|id|API|GuildLib|Decline}}() :{{\|id|API|GuildLib|GetBankWithdrawLimits}}() :{{\|id|API|GuildLib|GetBannerBackgroundIcons}}() :{{\|id|API|GuildLib|GetBannerForegroundIcons}}() :{{\|id|API|GuildLib|GetBannerScanLines}}() :{{\|id|API|GuildLib|GetCreateCost}}() :{{\|id|API|GuildLib|GetDyes}}() :{{\|id|API|GuildLib|GetGuilds}}() :{{\|id|API|GuildLib|GetHolomarkModifyCost}}() :{{\|id|API|GuildLib|GetMinimumLevel}}() :{{\|id|API|GuildLib|GetPermissions}}() :{{\|id|API|GuildLib|IsLoading}}() ==== Enums ==== :{{\|id|API|GuildLib|CodeEnumGuildEventType}} [Achievement,PerkUnlock,PerkActivate,MemberAdded,MemberRemoved, MemberRankChanged, MessageOfTheDay, BankMoney, ItemRepair, BankTab] :{{\|id|API|GuildLib|Perk}} [BankTab5,BankTab2,BankTab3,BankTab4,BankTab1, Tier6Unlock, Tier2Unlock, Tier5Unlock, Tier3Unlock, Tier4Unlock] === [[\API HazardsLib|HazardsLib]] === === [[\API HousingLib|HousingLib]] === === [[\API ICCommLib|ICCommLib]] === === [[\API MacrosLib|MacrosLib]] === === [[\API MailSystemLib|MailSystemLib]] === === [[\API MarketplaceLib|MarketplaceLib]] === :{{\|id|API|MarketplaceLib|GetAuctionableCategories}}() :{{\|id|API|MarketplaceLib|GetAuctionableFamilies}}() :{{\|id|API|MarketplaceLib|GetAuctionableItems}}() :{{\|id|API|MarketplaceLib|GetAuctionableTypes}}() :{{\|id|API|MarketplaceLib|GetCommodityCategories}}() :{{\|id|API|MarketplaceLib|GetCommodityFamilies}}() :{{\|id|API|MarketplaceLib|GetCommodityItems }}() :{{\|id|API|MarketplaceLib|GetCommodityTypes}}() :{{\|id|API|MarketplaceLib|GetItemAuctionCost}}() :{{\|id|API|MarketplaceLib|GetItemProperties}}() :{{\|id|API|MarketplaceLib|PostItemAuction}}() :{{\|id|API|MarketplaceLib|RequestCommodityInfo}}() :{{\|id|API|MarketplaceLib|RequestItemAuctionsByCategory}}() :{{\|id|API|MarketplaceLib|RequestItemAuctionsByFamily}}(nFamilyID, nPage, tMarketplaceLib.AuctionSort [, bReverseSort, tFilters, unknown, unknown, tPropertySort] ) :{{\|id|API|MarketplaceLib|RequestItemAuctionsByItems}}() :{{\|id|API|MarketplaceLib|RequestItemAuctionsByType}}() :{{\|id|API|MarketplaceLib|RequestOwnedCommodityOrders}}() :{{\|id|API|MarketplaceLib|RequestOwnedItemAuctions}}() :{{\|id|API|MarketplaceLib|SearchAuctionableItems}}() === [[\API MessageManagerLib|MessageManagerLib]] === === [[\API OptionsScreen|OptionsScreen]] === === [[\API P2PTrading|P2PTrading]] === === [[\API PetCustomizationLib|PetCustomizationLib]] === === [[\API PlayerPathLib|PlayerPathLib]] === === [[\API PreGameLib|PreGameLib]] === === [[\API PublicEventsLib|PublicEventsLib]] === === [[\API QuestLib|QuestLib]] === === [[\API RealmSelectScreenLib|RealmSelectScreenLib]] === === [[\API Sound|Sound]] === === [[\API StorefrontLib|StorefrontLib]] === === [[\API Tooltip|Tooltip]] === :{{\|id|API|Tooltip|GenerateSpellTooltipForm}}() :{{\|id|API|Tooltip|GenerateUnitTooltipForm}}() :{{\|id|API|Tooltip|GetBuffTooltipForm}}() :{{\|id|API|Tooltip|GetHousingBuffTooltipForm}}() :{{\|id|API|Tooltip|GetItemTooltipForm}}() :{{\|id|API|Tooltip|GetSpellTooltipForm}}() </div><!-- do not remove -->
Summary:
Please note that all contributions to AddOn Studio are considered to be released under the Creative Commons Attribution-NonCommercial-ShareAlike (see
AddOn Studio Wiki:Copyrights
for details).
Submissions must be written by you, or copied from a public domain or similar free resource (see
AddOn Studio Wiki:Copyrights
for details).
Cancel
Editing help
(opens in new window)
Templates used on this page:
Template:Api
(
edit
)
Template:Editlink
(
edit
)
Template:WildStar/api
(
edit
)
Template:WildStar/devnav
(
edit
)
Template:WildStar/id
(
edit
)
Template:WildStar/uiapi
(
edit
)
Template:\
(
edit
)