WildStar:UI API: Difference between revisions

Latest revision as of 06:01, 10 August 2023

Reference e
AddOns UI API UI Form UI XML UI Event WS Lua UI Macro CVars Changes Guides Snippets Categories

→ UI API

For WildStar UI development base APIs are divided into Lua UI Libraries, like Apollo and 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 Carbine default AddOns, see AddOn API.

Note: The most recent API "documentation" can be found within Houston/ it self. It is located within the help menu.

Reference[edit]

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.
How to edit API pages - please read if you're contributing documentation

Function names can be prefixed with the following tags, see 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 Removed Functions.

Calling functions via macro or command line:

/eval Apollo.SetConsoleVariable("lod.renderTargetScale", .75)
/eval local x=GameLib.GetRealmName(); Print(x)

Global[edit]

These are in the global namespace.

BuybackItemFromVendor(idItem)

BuyItemFromVendor(idItem, 1)

Camp()

CancelExit()

Chat_PostDatachronMsg(idCreature, sText)

Cinematics_Cancel(self.param)

Cinematics_Play(self.param)

Creature_GetName(idCreature)

Event_CancelAuctionhouse() - fires the CancelAuctionhouse event

Event_CancelBanking() - fires the CancelBanking event

Event_CancelCityDirections() - fires the CancelCityDirections event

Event_CancelCommodities() - fires the CancelCommodities event

Event_CancelConverting() - fires the CancelConverting event

Event_CancelCrafting() - fires the CancelCrafting event

Event_CancelDyeWindow() - fires the CancelDyeWindow event

Event_CancelEngravingStation() - fires the CancelEngravingStation event

Event_CancelExperimentation() - fires the CancelExperimentation event

Event_CancelGuildBank() - fires the CancelGuildBank event

Event_CancelGuildRegistration() - fires the CancelGuildRegistration event

Event_CancelHousingMannequin() - fires the CancelHousingMannequin event

Event_CancelMail() - fires the CancelMail event

Event_CancelSettlerHub() - fires the CancelSettlerHub event

Event_CancelTaxiVendor() - fires the CancelTaxiVendor event

Event_CancelTradeskillTraining() - fires the CancelTradeskillTraining event

Event_CancelTraining() - fires the CancelTraining event

Event_CancelVending() - fires the CancelVending event

Event_CancelWarpartyBank() - fires the CancelWarpartyBank event

Event_CloseBankWindow() - fires the CloseBankWindow event

Event_CloseCraftingWindow() - fires the CloseCraftingWindow event

Event_CloseTradeskillTrainerWindow() - fires the CloseTradeskillTrainerWindow event

Event_CloseVendorWindow() - fires the CloseVendorWindow event

Event_FireGenericEvent(sEventName) - fires an event by event name

Event_HideQuestLog() - fires the HideQuestLog event

Event_ShowQuestLog() - fires the ShowQuestLog event

Event_ShowTutorial() - fires the ShowTutorial event

Event_ToggleAchievementWindow() - fires the ToggleMailWindow event

Event_ToggleCodex() - fires the ToggleMailWindow event

Event_ToggleMailWindow() - fires the ToggleMailWindow event

Event_ToggleQuestLog() - fires the ToggleQuestLog event

ExitNow()

GetCurrentSubZoneName()

GetCurrentZoneName()

GetDeathPenalty()

GetDemoTimeRemaining()

GetMapTrackedUnitData()

GetMouseOverUnit()

GetNthResolution()

GetPeriodicElderPoints()

GetRestXpKillCreaturePool()

GetRezCost()

GetRezIsDead()

GetRezOptionAcceptCasterRez()

GetRezOptionExitInstance()

GetRezOptionHolocrypt()

GetRezOptionWakeHere()

GetUnit()

GetWakeHereTime()

GetXp()

GetXpPercentToNextLevel()

GetXpToCurrentLevel()

GetXpToNextLevel()

Interaction_Result()

InvokeOptionsScreen()

IsActionBarSetVisible()

IsDemo()

Pet_GetValidStances()

Pet_SetStance()

PlayerTicket_GetErrorTypeList()

PlayerTicket_GetSubtype()

PlayerTicketDialog_Report()

PreviousQuestItem()

Print()

RechargeItemVendor()

RepairAllItemsVendor()

SellItemToVendorById()

SetQuestItem()

ShowInventory()

String_GetString()

String_GetWeaselString()

ToggleAbilitiesWindow()

ToggleCharacterWindow()

ToggleInventory()

ToggleTradeSkillsInventory()

AbilityBook[edit]

AccountItemLib[edit]

AchievementsLib[edit]

ActionSetLib[edit]

Apollo[edit]

.AddAddonErrorText(tAddon, sMessage) - adds error message to AddOn's Apollo error log

.AlertAppWindow()

.AssetFileSizeString(sFilename) returns (string)

.AssetFileTimeString(sFilename) returns (string)

.BeginClickStick(wndSource,sType,sSprite,nData)

.BeginDragDrop(wndSource,sType,sSprite,nData)

.CloseEscapableWindows() returns (boolean) - true on success

.CreateTimer(sTimerName,nInterval,bContinuous)

.DisableAddon(sName)

.DoesSpriteExist()

.DPF(sMarker) - runs the caller's DebugPrintF on the buffer of the caller

.FindWindowByName(sName) returns (Window) - gets window by name

.FormatNumber()

.GetAddon(sName) returns (table) - gets AddOn instance, or nil if none

.GetAddonInfo()

.GetAPIVersion()

.GetAssetFolder() returns (string) - gets the asset root folder

.GetConsoleVariable(sVar) returns (any) - get CVar sVar. can be nil

.GetDisplaySize()

.GetGameFonts() returns (table) - gets list of fonts as: index, name, face, size

.GetMaxResolutionWidth()

.GetMetaKeysDown()

.GetMinResolutionWidth()

.GetMouse()

.GetMouseTargetWindow()

.GetObjectSize(pObject) - get size of Object pObject

.GetPackage(sName) returns (table) - as: bAddon, nVersion, strLoadError, strName, tPackage

.GetScreenSize() returns (width,height) - gets screen width and height

.GetStrata()

.GetString(sCheck) returns (string) - get localized string string or stringID

.GetTextWidth()

.GetTickCount() returns (number) - gets the tick count

.GetWindowsInStratum()

.IsAltKeyDown() returns (boolean) - is alt is down

.IsCapsLockOn()

.IsControlKeyDown() returns (boolean) - is ctrl is down

.IsShiftKeyDown() returns (boolean) - is shift is down

.IsSpriteLoaded()

.IsWindowSubclassRegistered()

.LinkAddon(pModuleToLink,nHandlerRef) - runs pModuleToLink's AddPodInfo

.LoadAnimations(sFile) returns (boolean) - loads XML sFile animation. returns success

.LoadForm(sFile,sForm,wndParent,tHandler) returns (window) - load window from specified file

.LoadGlobalAnchors(sFile)

.LoadSprites(sFile,sDoc) - loads XML sFile and sDoc animation

.NoOp() returns (number) - returns 0 and does nothing

.ParseInput(sInput) returns (string) - process input, such as slash command, etc

.RegisterAddon(nEventHandler,sLoad,sSave,sRestore)

.RegisterEventHandler(sEventName,sFunction,tHandler) - map an event to a handler

.RegisterPackage(tPackage,sName,nVersion,tDependents)

.RegisterSlashCommand(sCommand,sFunction,tHandler) - map a command to a handler

.RegisterTimerHandler(sTimerName,sFunction,tHandler)

.RegisterWindowSubclass()

.RemoveEventHandler(sEventName,tHandler)

.ResetConsoleVariable(sVar)

.SetConsoleVariable(sVar,pMD) - set a console variable

.SetCursor(pCursor)

.SetGlobalAnchor(sName,fPoint,nOffset,bOverwrite)

.SetMaxResolutionWidth()

.SetMinResolutionWidth()

.SetNavTextAnchor()

.StartTimer(sTimerName) - starts the named timer sTimerName

.StopTimer(sTimerName) - stops the named timer sTimerName

.SuspendAddon(nId)

.UnlinkAddon()

Enums[edit]

.AddonLoadStatus [Loading, Loaded, LoadingError]

.DragDropCancelReason [EscapeKey, DroppedOnNothing, ClickedOnNothing, ClickedOnWorld, WindowMove]

.DragDropQueryResult [PassOn, Ignore, Accept, Invalid]

Events[edit]

DragDropSysBegin(wndSource,sType,iData)

DragDropSysEnd(sType,iData)

LuaError(tAddon,sError,bCanIgnore)

ModuleLoaded()

ModuleRestore()

SaveModules()

SystemKeyDown(iKey)

TextMessage(iType,sMessage)

AttributeMilestonesLib[edit]

ChallengesLib[edit]

CharacterScreenLib[edit]

ChatSystemLib[edit]

.Command()

.CreateChannel() - Currently has no implementation

.GetChannels()

.GetCommands()

.GetEmotes()

.GetInputTypeForString(sText) returns (table) - eType, nChannel, sChatType, sCommand, sAbbrev, sArgs, bCommandSet

.JoinChannel() - Currently has no implementation

.LeaveChannel() - Currently has no implementation

.PostOnChannel()

.PrepareInfractionReport()

.SendInfractionReport()

.SendOnChannel()

.SendOnChannel(nChannelNumber,sText)

.SplitInput()

CombatFloater[edit]

CombatFloaters[edit]

CommunicatorLib[edit]

CraftingLib[edit]

CREDDExchangeLib[edit]

CSIsLib[edit]

CustomerSurveyLib[edit]

DatacubeLib[edit]

DemoSummary[edit]

GameLib[edit]

.AcceptDuel()

.AreAnyItemsNew()

.AreQuestUnitCalloutsVisible()

.AssignMasterLoot()

.BuyBankBagSlot()

.CanDisembarkVehicle()

.CanDye()

.CanEditKeySet(nKeySet) returns (boolean) - true if nKeySet is NOT any of the default 3 input key sets

.CanRepairAll()

.CanVacuum() returns (boolean)

.Cheat_MakeMeLevel50()

.ClearAllTargetMarkers()

.ClearCityDirection()

.CodeEnumGenericError()

.DeclineDuel()

.DisableTutorialType()

.Disembark()

.DoAnyItemsBeginQuest()

.DragDropDataToItemLocation(nData) returns (table) - {eType, nBagIndex, nBagSlot}

.DyeItems()

.ForfeitDuel()

.GetAbilityPoints()

.GetAccountRealmCharacter()

.GetAllTutorials()

.GetAllZoneCompletionMapZones()

.GetAttributePoints()

.GetAvailableTargetMarkers()

.GetBindPoint()

.GetCCStateStunTimeRemaining()

.GetCharacterList() returns (table) - a counter as an integer and a character name list entry as a string

.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)

.GetClassInnateAbility()

.GetClassInnateAbilitySpells()

.GetClassName() returns (string) - Gets localized class name corresponding to nId from DbFileTable_Class_GetByID, or nil if none

.GetControlledUnit() returns (unit) - or nil if none

.GetCostumeCount()

.GetCostumeIndex()

.GetCostumeItem()

.GetCostumeItemIcon(self.nCurrentCostume, idx)

.GetCostumeUnlockLevel()

.GetCredits()

.GetCurrentClassInnateAbilityIndex()

.GetCurrentClassInnateAbilitySpell()

.GetCurrentWorldId()

.GetCurrentZoneId()

.GetCurrentZoneMap()

.GetCurrentZonePvpRules()

.GetCurrInputKeySet() returns (number)

.GetDefaultRecallCommand()

.GetDuelOpponent(unitPlayer)

.GetDuelState()

.GetDyeCost()

.GetDyeUnlockLevel()

.GetEmptyInventorySlots()

.GetErrorCategories()

.GetFrameRate()*10)*0.1

.GetGadgetAbility()

.GetGameCommand()

.GetGameExitInfo()

.GetGameTime() returns (number) - game client 'up time' in seconds, fractional milliseconds

.GetGearScore()

.GetGuildHolomarkDistance()

.GetGuildHolomarkVisible(GameLib.GuildHolomark.Left)

.GetInputActionCategories() returns (table) - list of {id, strName} action categories

.GetInputActionNameByEnum()

.GetInputKeyNameText(tCurrInput) returns (string) - Gets input key's name for a tCurrInput ({eDevice = GameLib.CodeEnumInputDevice.None, nCode, nModifier}), or "<Unbound>" if none

.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

.GetInstanceSettings()

.GetInteractiveUnit() returns (number) - Gets closest interactive unit id

.GetKeyBinding(CastObjectiveAbility)

.GetKeyBindingByEnum(eInputAction)

.GetKeyBindings() returns (table) - Gets a list of the current key bindings as: arInputs, idAction, idCategory, nDisplayIndex, strAction, strActionLocalized

.GetKnownDyes()

.GetLevelUpFanfareDuration()

.GetLevelUpUnlock()

.GetLevelUpUnlockTypes()

.GetLocalTime() returns (table) - as: nYear, nMonth, nDay, nDayOfWeek, nHour, nMinute, nSecond, strFormattedTime

.GetLootRolls()

.GetMasterLoot()

.GetNextBankBagCost()

.GetNumBankBagSlots()

.GetNumClassInnateAbilitySpells()

.GetPendingLevelUpUnlocks() returns (table)

.GetPendingRemovalWarningRemaining()

.GetPendingTutorials()

.GetPlayerCurrency(nType, eGroupType) returns (money) - gets currency data for current player

.GetPlayerGenericVehicleUnit()

.GetPlayerLevel()

.GetPlayerMoney() - "Deprecated"

.GetPlayerMountUnit() returns (unit) - gets the players mount unit, else 1, and nil if none

.GetPlayerPets()

.GetPlayerTaxiUnit() returns (unit) - gets the taxi that the player is currently on, else 1 and nil if null

.GetPlayerUnit() returns (unit) - gets current player

.GetPlayerUnitByName()

.GetPlayerVehicleUnit() returns (unit) - gets the players vehicle unit, else 1 and nil if none

.GetPvpFlagInfo()

.GetPvpGraveyards() returns (table) - (not implemented) returns as: infoId and available of Graveyard

.GetRealmName() returns (string)

.GetRepairAllCost()

.GetReputationInfo()

.GetReputationLevels()

.GetServerTime() returns (table) - as: nYear, nMonth, nDay, nDayOfWeek, nHour, nMinute, nSecond, strFormattedTime

.GetShortcutMount()

.GetShortcutPotion()

.GetSpell(wndControl:GetAbilityTierId())

.GetSpellThresholdTimePrcntDone()

.GetSpellThresholdTimePrcntLeft()

.GetStuckCooldowns()

.GetTargetMarkerIcon()

.GetTargetUnit() returns (unit) - gets the target unit, else 0 if none

.GetTeleportIlliumSpell():GetBaseSpellId()

.GetTeleportThaydSpell():GetBaseSpellId()

.GetTextTypeMaxLength(GameLib.CodeEnumUserText.GuildName)

.GetTickCount() returns (number) - Gets tick count truncated to integer

.GetTotalAbilityPoints()

.GetTotalInventorySlots()

.GetTutorial(nTutorialId)

.GetTutorialLayouts()

.GetTutorialPopupContext()

.GetTutorialsForCategory()

.GetTutorialVisibilityFlags()

.GetUnitById()

.GetUnitScreenPosition()

.GetUnlocksForLevel(nSpecificLevel, nSystem, true)

.GetVersionInfo()

.GetWorldCompletionPercent()

.GetWorldDifficulty()

.GetWorldGameMode()

.GetWorldTimeOfDay() returns (number) - realm time from 0 to return/3600=24 wrapping. not real time

.GetWorldTooltipContainer()

.GetXpBonusData(nWho) returns (table) - Gets description of xp bonus as: ?

.GetZoneCompletion()

.GetZoneCompletionTypes()

.GetZoneExplorationPercent()

.HasBindPoint()

.HasTutorialSound(nTutorialId, nPassedPage)

.InitiateDuel()

.IsCharacterLoaded() returns (boolean)

.IsControlledUnit(unit) returns (boolean) - check if unit is a controlled unit

.IsCostumeSlotVisible()

.IsCurrentInnateAbilityActive()

.IsIgnoringDuelRequests()

.IsInLocation()

.IsInWorldZone(idSubZone)

.IsKeyBindable(nCode, eModifier)

.IsLevelUpUnlockViewed()

.IsMouseLockOn()

.IsNeedRollAllowed(tCurrentElement.nLootId)

.IsOverdriveActive()

.IsPvpFlagged()

.IsPvpServer()

.IsSpellSurgeActive()

.IsTextValid(strInfo, GameLib.CodeEnumUserText.GuildInfoMessage, GameLib.CodeEnumUserTextFilterClass.Strict)

.IsTutorialCategoryVisible(nType)

.IsTutorialNoPageAlert(nTutorialId)

.IsTutorialViewed()

.IsZoneInZone()

.ItemLocationToDragDropData(nLocationType,nBagIndex,nBagSlot) returns (number)

.LeavePendingRemovalInstance()

.MarkCityDirection(wndHandler:GetData()

.MarkLevelUpUnlockViewed()

.MarkTutorialViewed(tEntry.id, true)

.OnClosedInstanceSettings()

.PassOnLoot(self.wndMain:GetData()

.PauseGameActionInput(bPaused)

.PlayTutorialSound()

.RecallShardBind() - (not implemented) bind should receive an id of a shard location

.RecallShardGetInfo() returns (bExists,bCanUse,strLocation,idLocation,fCooldown)

.RecallShardUse() - (not implemented)

.ReportBug(tSub.nId, self.unitSelected, self.idQuest, self.wndReportBug:FindChild("Description"):GetText())

.ResetAttributePoints()

.ResetLevelUpUnlocks()

.ResetSingleInstance()

.ResetTutorials()

.RollOnLoot(self.wndMain:GetData())

.SearchRelationshipStatusByCharacterName()

.SetCostumeIndex()

.SetCostumeItem(self.nCurrentCostume, wndControl:GetData(), uItemToImprint:GetInventoryId())

.SetCostumeSlotVisible()

.SetCurrentClassInnateAbilityIndex(wndHandler:GetData())

.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.

.SetDefaultRecallCommand(GameLib.CodeEnumRecallCommand.House)

.SetIgnoreDuelRequests()

.SetInstanceSettings(eDifficulty, self.wndMain:GetRadioSel("InstanceSettings_LocalRadioGroup_Rallying"))

.SetKeyBindings(tInputTable) - Runs the SaveInputKeySet after updating the key bindings table

.SetMouseLock()

.SetSharedChallengePreference()

.SetShortcutMount(tSelectedSpellObj:GetId())

.SetShortcutPotion(tSelectedPotion:GetItemId())

.SetTargetUnit(unit)

.SetWorldTooltipContainer()

.ShowGuildHolomark()

.ShowUI()

.SpendAttributePoints()

.StopTutorialSound()

.SupportStuck()

.TogglePvpFlags()

.ToggleQuestUnitCallouts()

.ToggleTutorialVisibilityFlags(entry.wnd:FindChild("MiddleLevelViewBtn"):GetData())

.WorldLocToScreenPoint()

Enums[edit]

.CityDirectionType [Mailbox,Bank,AuctionHouse,CommodityMarket, AbilityVendor, Tradeskill, General, HousingNpc, Transport]

.CodeEnumAddonSaveLevel [General,Account,Realm,Character]

.CodeEnumClass [Warrior,Engineer,Esper,Medic, Stalker, Spellslinger]

.CodeEnumCombatResult [Avoid,Critical,Hit,NeedsTelegraphEvaluation, OutsideTelegraph, OutsideTelegraphInvalid, InsideTelegraph, NeedsHitResultCalc]

.CodeEnumConfirmButtonType [SendMail,CommitTrade,DeleteItem,SalvageItem]

.CodeEnumDamageType [Physical,Tech,Magic,Heal, HealShields, Fall, Suffocate]

.CodeEnumDuelState [None,Pending,WaitingToAccept,Dueling]

.CodeEnumEquippedItems [Chest,Legs,Head,Shoulder, Feet, Hands, WeaponTool, WeaponAttachment, System, Augment, Implant, Gadget, Shields, WeaponPrimary, Bag0, Bag1, Bag2, Bag3, BankBag0, BankBag1, BankBag2, BankBag3, BankBag4]

.CodeEnumExitEvent [None,Camp,Quit]

.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]

.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]

.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]

.CodeEnumInputDevice [None,Keyboard,Mouse]

.CodeEnumInputEventType [Raw,Click,Hold,DoubleClick, DoubleHold, Rapid]

.CodeEnumInputModifier [Shift,Control,Alt]

.CodeEnumInputModifierScancode [LeftShift,LeftCtrl,LeftAlt,RightShift, RightCtrl, RightAlt]

.CodeEnumInputMouse [Left,Right,Middle,X1, X2, WheelUp, WheelDown]

.CodeEnumInputSets [Default1,Default2,Default3,Account, Character, Count]

.CodeEnumItemSlots [Chest,Legs,Head,Shoulder, Feet, Hands, Tool, Weapon, Shields, Gadget, Attachment, System, Augment, Implant]

.CodeEnumMapObjectType [Unit,Object,PathObjective,QuestObjective]

.CodeEnumMapOverlayType [Unit,Object,PathObjective,QuestObjective]

.CodeEnumMissType [Dodge]

.CodeEnumPetStance [Assist,Stay,Passive,Defensive, Aggressive]

.CodeEnumRace [Human,Granok,Aurin,Draken, Mechari, Mordesh, Chua]

.CodeEnumRecallCommand [BindPoint,House,Warplot,Illium, Thayd]

.CodeEnumStoryPanel [Default,Low,Center,FullScreen, Whiteout, Urgent, FullScreenBlackNoFlash, Informational]

.CodeEnumStoryPanelStyle [Default,Paper,Electronic,Eldan, Arcane, Natural, Exile, Dominion]

.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]

.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

.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]

.CodeEnumUserText [CharacterName,ScientistScanbotName,GuildName, GuildRankName, GuildBankTabName, HousingResidenceName, Chat, MailSubject, MailBody, ChatCustomChannelName, ReadyCheck, FriendshipNote, ChatCustomChannelPassword, GuildMessageOfTheDay, GuildMemberNote, GuildRercuitDescription, GuildInfoMessage, FriendshipAccountName, FriendshipAccountPrivateNote, FriendshipAccountPublicNote, FriendshipAccountEmail, FriendshipInviteNote]

.CodeEnumUserTextFilterClass [Strict,Standard,Low]

.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]

.CodeEnumWhoResult [OK,Partial,UnderCooldown]

.CodeEnumZoneCompletionType [EpisodeQuest,TaskQuest,Challenge,TaxiNode, Datacube, Tale, Journal]

.CodeEnumZonePvpRules [None,ExileStronghold,DominionStronghold,Sanctuary, Pvp, ExilePVPStronghold, DominionPVPStronghold]

.DuelStateDuelState [None,WaitingToAccept,Pending,Dueling]

.GuildHolomark [Left,Right,Back]

.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]

.LevelUpUnlockSystem [Path,Level]

.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]

.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]

.SharedChallengePreference [AutoAccept,Prompt,AutoReject]

.SupportStuckAction [RecallBind,RecallDeath,RecallHouse]

GenericDialog[edit]

.AbortRetryCancel()

.ColorPicker(node.fontColor, CombatFloaterConfig_Options_FontColor_ColorPickerCallback, data)

GroupLib[edit]

.AcceptInvite(sMessage) - Accept invite with optional message

.AcceptMentoring()

.AcceptRequest()

.AmILeader() returns (boolean) - Is this unit the leader

.Bag_GetItemByGuid(nGuid) returns (table) - (missing function) Item from group bag specified by nGuid

.Bag_GetLoot() returns (table) - (missing function) Group loot list of: index, LootItem

.Bag_GetSharedItems() returns (table) - (missing function) itemId, icon, name, nStack, ownerName, guid

.Bag_ShareItem(nInventoryId) - (missing function) Share item by nInventoryId

.Bag_VoteForItem(nIdItem,eVote) - (missing function) Vote on bag item nIdItem with eVote

.CancelMentoring()

.CanLeave()

.CloseMentoringAOIDialog()

.CloseMentoringDialog()

.ConvertToRaid()

.CreateGroup() - (missing function)

.DeclineInvite()

.DenyInvite(sMessage) - Deny invite with optional message

.DenyRequest()

.DisbandGroup(sMessage) - Request group disband with optional message

.GetGroupMaxSize() returns (number)

.GetGroupMember(nGroupIndex) returns table - Gets member record for ones based nGroupIndex, else nil

.GetInstanceDifficulty()

.GetInstanceGameMode()

.GetInvite()

.GetInviteReceivedString() returns (string)

.GetJoinRequestMethod()

.GetLootDistribution() returns (number)

.GetLootRules()

.GetLootThreshold() returns (number)

.GetMemberCount() returns (number)

.GetMemberQuests()

.GetMentoringList()

.GetReferralMethod()

.GetUnitForGroupMember(nGroupIndex) returns (unit) - Unit data for ones based nGroupIndex

.GotoGroupInstance()

.Group_GetMemberQuests(nIndex) - (missing function)

.Group_RequestQuest(unitId,questId) - (missing function)

.InGroup() - Does a lua_pushboolean of InGroup

.InInstance()

.InInstanceWithMember()

.InRaid()

.Invite(sPlayerName,sRealmName,sMessage) - Invite player with optional message

.IsMemberInGroupInstance()

.Join()

.JoinWorldZonePhase()

.Kick(nGroupIndex,sMessage) - Kick player with optional message

.LeaveGroup(sMessage) - Leave or deny incoming invite with optional message

.LeaveWorldZonePhase()

.Promote(nGroupIndex) - Promote player

.ReadyCheck()

.RequestQuest()

.RequestToJoin(nGroupId) - Request to join specified by nGroupId

.SetCanMark()

.SetInstanceDifficulty()

.SetInstanceGameMode()

.SetInvitePermission()

.SetJoinRequestMethod()

.SetKickPermission()

.SetLootDistribution(eLootDist)

.SetLootRules()

.SetLootThreshold(eThresh)

Enums[edit]

.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]

.ActionResult [OrderInvalidMember,OrderFailedLeader,AlreadyInGroupInstance]

.CodeEnumLootThreshoold [Average,Good,Excellent,Superb,Exquisite, Phenomenal, Extraordinary, Legendary, Inferior]

.Difficulty [Normal,Veteran]

.GameMode [Normal,SpeedRun,CompletionRun,Nightmare]

.HarvestLootRule [RoundRobin,FirstTagger]

.InvitationMethod [Open,Neutral,Closed]

.LeaveReason [Leave,Kick,Disbanded]

.LootRule [FreeForAll,RoundRobin,NeedBeforeGreed,Master]

.LootThreshold [Average,Good,Excellent,Superb,Exquisite, Phenomenal, Extraordinary, Legendary, Inferior]

.RemoveReason [Left,Kicked,Disconnected,Disband,RemovedByServer, VoteKicked]

.Result [ExpiredInvitee,ServerControlled,GroupNotFound,NotAcceptingRequests,Busy, SentToLeader, LeaderOffline, WrongFaction, Ok, PlayerAlreadyGrouped, InviteExpired, AlreadyHasPendingInvite, InviteSuccessful, NoPermission, InviteOtherExpired, AlreadyInvitedYou, InvitorNoPermission, ExpriedInvitee]

.Result [Ok,PlayerNotFound,PlayerAlreadyGrouped,InviteExpired,RealmNotFound, AlreadyHasPendingInvite, InviteSuccessful, NoPermission, InviteOtherExpired, AlreadyInvitedYou, InvitorNoPermission]

.Result [RoleFull,NoInvitingSelf]

.Result [Sent,Accepted,Declined,NoPermissions,Grouped, Pending, ExpiredInviter, ExpriedInvitee, IsInvited, InvitedYou, Full]

Events[edit]

Group_AcceptInvite()

Group_Changed()

Group_DeclineInvite()

Group_Disbanded(nReason,nGroupMemberId,nGroupActorIndex) - Output of a group leave or if group empties and disbands

Group_Invite_Declined(tTableRef) - Outputs the refused invitation to a group invite

Group_Invite_Result(nTableRef)

Group_Invited(nTableRef)

Group_Other_Joined(nTableRef)

Group_Other_Left(nTableRef)

Group_Other_Promoted(tTableRef) - Outputs the promotion of a group member

Group_Player_Joined()

Group_Player_Left()

Group_Player_Promoted()

Group_QuestList(unitId,nTableRef)

GuildLib[edit]

This library contains functions and enumerations having to do with guilds and arena teams.

.Accept()

.Create()

.Decline()

.GetBankWithdrawLimits()

.GetBannerBackgroundIcons()

.GetBannerForegroundIcons()

.GetBannerScanLines()

.GetCreateCost()

.GetDyes()

.GetGuilds()

.GetHolomarkModifyCost()

.GetMinimumLevel()

.GetPermissions()

.IsLoading()

Enums[edit]

.CodeEnumGuildEventType [Achievement,PerkUnlock,PerkActivate,MemberAdded,MemberRemoved, MemberRankChanged, MessageOfTheDay, BankMoney, ItemRepair, BankTab]

.Perk [BankTab5,BankTab2,BankTab3,BankTab4,BankTab1, Tier6Unlock, Tier2Unlock, Tier5Unlock, Tier3Unlock, Tier4Unlock]