UI API
The UI Lua API is the set of functions the Warhammer Online client exposes to UI addons. These pages are written from the Return of Reckoning client itself (WAR.exe) and from the stock interface Lua.
Argument types
These are the type names the client uses in its own Invalid Parameters error messages.
| Type | Meaning |
|---|---|
number |
A Lua number. |
string |
A plain Lua string, such as a window name. |
wstring |
A wide string: L"text" or the result of towstring(). A plain string is rejected.
|
boolean |
true or false. nil is rejected.
|
number-table, string-table, wstring-table, boolean-table |
An array whose values are all of that type. |
lua-object |
Any table. |
UI element functions
ActionButtonGroup
ActionButtonGroupGetIcon · ActionButtonGroupGetId · ActionButtonGroupGetShowing · ActionButtonGroupSetIcon · ActionButtonGroupSetId · ActionButtonGroupSetNumButtons · ActionButtonGroupSetShowing · ActionButtonGroupSetText · ActionButtonGroupSetTimeAbbreviations · ActionButtonGroupSetTimeFormat · ActionButtonGroupSetTimer · ActionButtonGroupSetTintColor
AnimatedImage
AnimatedImageSetPlaySpeed · AnimatedImageSetTexture · AnimatedImageStartAnimation · AnimatedImageStopAnimation
Button
ButtonGetCheckButtonFlag · ButtonGetDisabledFlag · ButtonGetHighlightFlag · ButtonGetPressedFlag · ButtonGetStayDownFlag · ButtonGetText · ButtonGetTextDimensions · ButtonSetCheckButtonFlag · ButtonSetDisabledFlag · ButtonSetHighlightFlag · ButtonSetPressedFlag · ButtonSetStayDownFlag · ButtonSetText · ButtonSetTextColor · ButtonSetTexture · ButtonSetTextureSlice
CircleImage
CircleImageMoveRotationCenter · CircleImageSetFillParams · CircleImageSetRotation · CircleImageSetTexture · CircleImageSetTextureScale · CircleImageSetTextureSlice
ColorPicker
ColorPickerAddColor · ColorPickerAddColorAtPosition · ColorPickerClear · ColorPickerCreateWithColorTable · ColorPickerGetColorAtPoint · ColorPickerGetColorById · ColorPickerGetColorSize · ColorPickerGetColorSpacing · ColorPickerGetCoordinatesForColor · ColorPickerGetTexDims
ComboBox
ComboBoxAddMenuItem · ComboBoxClearMenuItems · ComboBoxExternalOpenMenu · ComboBoxGetDisabledFlag · ComboBoxGetSelectedMenuItem · ComboBoxGetSelectedText · ComboBoxIsMenuOpen · ComboBoxSetDisabledFlag · ComboBoxSetSelectedMenuItem
CooldownDisplay
DynamicImage
DynamicImageClearCustomShader · DynamicImageHasTexture · DynamicImageSetCustomShader · DynamicImageSetRotation · DynamicImageSetTexture · DynamicImageSetTextureDimensions · DynamicImageSetTextureOrientation · DynamicImageSetTextureScale · DynamicImageSetTextureSlice
Label
LabelGetFont · LabelGetIgnoreFormattingTags · LabelGetLinkColor · LabelGetText · LabelGetTextColor · LabelGetTextDimensions · LabelGetWordWrap · LabelSetFont · LabelSetIgnoreFormattingTags · LabelSetLinkColor · LabelSetText · LabelSetTextAlign · LabelSetTextColor · LabelSetWordWrap
ListBox
ListBoxGetDataIndex · ListBoxSetDataTable · ListBoxSetDisplayOrder · ListBoxSetVisibleRowCount
LogDisplay
LogDisplayAddLog · LogDisplayGetFilterColor · LogDisplayGetFilterState · LogDisplayGetFont · LogDisplayGetShowFilterName · LogDisplayGetShowLogName · LogDisplayGetShowTimestamp · LogDisplayGetStringFromCursorPos · LogDisplayGetTextFadeTime · LogDisplayHideFilterSubType · LogDisplayIsScrollbarActive · LogDisplayIsScrolledToBottom · LogDisplayIsScrolledToTop · LogDisplayRemoveLog · LogDisplayResetLineFadeTime · LogDisplayScrollToBottom · LogDisplayScrollToTop · LogDisplaySetEntryLimit · LogDisplaySetFilterColor · LogDisplaySetFilterState · LogDisplaySetFont · LogDisplaySetShowFilterName · LogDisplaySetShowLogName · LogDisplaySetShowTimestamp · LogDisplaySetTextFadeTime · TextLogDisplayShowScrollbar
MapDisplay
PageWindow
PageWindowAddPageBreak · PageWindowAddSplitableWindow · PageWindowClearPageBreaks · PageWindowClearSplitableWindows · PageWindowGetCurrentPage · PageWindowGetNumPages · PageWindowGetNumPagesDisplayed · PageWindowRemovePageBreak · PageWindowRemoveSplitableWindow · PageWindowSetCurrentPage · PageWindowUpdatePages
Scrollbar
HorizontalScrollbarGetLineSize · HorizontalScrollbarGetMaxScrollPosition · HorizontalScrollbarGetPageSize · HorizontalScrollbarGetScrollPosition · HorizontalScrollbarSetLineSize · HorizontalScrollbarSetMaxScrollPosition · HorizontalScrollbarSetPageSize · HorizontalScrollbarSetScrollPosition · VerticalScrollbarGetLineSize · VerticalScrollbarGetMaxScrollPosition · VerticalScrollbarGetPageSize · VerticalScrollbarGetScrollPosition · VerticalScrollbarSetLineSize · VerticalScrollbarSetMaxScrollPosition · VerticalScrollbarSetPageSize · VerticalScrollbarSetScrollPosition
ScrollWindow
HorizontalScrollWindowGetOffset · HorizontalScrollWindowSetOffset · HorizontalScrollWindowUpdateScrollRect · ScrollWindowGetOffset · ScrollWindowSetOffset · ScrollWindowUpdateScrollRect
SliderBar
SliderBarGetCurrentPosition · SliderBarGetDisabledFlag · SliderBarSetCurrentPosition · SliderBarSetDisabledFlag
StatusBar
StatusBarGetCurrentValue · StatusBarGetMaximumValue · StatusBarSetBackgroundTint · StatusBarSetCurrentValue · StatusBarSetForegroundTint · StatusBarSetMaximumValue · StatusBarStopInterpolating
TextEditBox
TextEditBoxGetAllowEditing · TextEditBoxGetFont · TextEditBoxGetHistory · TextEditBoxGetMaxChars · TextEditBoxGetText · TextEditBoxGetTextColor · TextEditBoxInsertText · TextEditBoxSelectAll · TextEditBoxSetAllowEditing · TextEditBoxSetFont · TextEditBoxSetHandleKeyDown · TextEditBoxSetHistory · TextEditBoxSetMaxChars · TextEditBoxSetText · TextEditBoxSetTextColor
TextLog
TextLogAddEntry · TextLogAddFilterType · TextLogAddSingleByteEntry · TextLogClear · TextLogCreate · TextLogDestroy · TextLogGetEnabled · TextLogGetEntry · TextLogGetFilterEnabled · TextLogGetIncrementalSaving · TextLogGetNumEntries · TextLogGetUpdateEventId · TextLogLoadFromFile · TextLogSaveLog · TextLogSetEnabled · TextLogSetEntryLimit · TextLogSetFilterEnabled · TextLogSetIncrementalSaving
Window
DoesWindowExist · ForceProcessAllWindowAnchors · WindowAddAnchor · WindowAssignFocus · WindowClearAnchors · WindowForceProcessAnchors · WindowGameAction · WindowGetAlpha · WindowGetAnchor · WindowGetAnchorCount · WindowGetDimensions · WindowGetFontAlpha · WindowGetGameActionData · WindowGetHandleInput · WindowGetId · WindowGetLayer · WindowGetMovable · WindowGetMoving · WindowGetOffsetFromParent · WindowGetParent · WindowGetPopable · WindowGetResizing · WindowGetScale · WindowGetScreenPosition · WindowGetShowing · WindowGetTabOrder · WindowGetTintColor · WindowIsGameActionLocked · WindowIsSticky · WindowRegisterCoreEventHandler · WindowRegisterEventHandler · WindowResizeOnChildren · WindowRestoreDefaultSettings · WindowSetAlpha · WindowSetDimensions · WindowSetDrawWhenInterfaceHidden · WindowSetFontAlpha · WindowSetGameActionData · WindowSetGameActionTrigger · WindowSetHandleInput · WindowSetId · WindowSetLayer · WindowSetMovable · WindowSetMoving · WindowSetOffsetFromParent · WindowSetParent · WindowSetPopable · WindowSetRelativeScale · WindowSetResizing · WindowSetScale · WindowSetShowing · WindowSetTabOrder · WindowSetTintColor · WindowStartAlphaAnimation · WindowStartPositionAnimation · WindowStartScaleAnimation · WindowStopAlphaAnimation · WindowStopPositionAnimation · WindowStopScaleAnimation · WindowUnregisterCoreEventHandler · WindowUnregisterEventHandler
Game and interface functions
Ability
CancelSpell · GetAbilityActionPointCost · GetAbilityCastTime · GetAbilityCooldown · GetAbilityDescription · GetAbilityRanges · GetAbilityRequirements · GetAbilityUpgradeRank · GetBlockedAbilities · GetDatabaseAbilityData · GetMoralePercentForLevel · GetPlayerMoraleLevel · IsAbilityEnabled · IsAbilityToggledOn · IsTargetValid
Appearance
ApplyPlayerVariation · BarbershopHaveFeaturesChanged · BarbershopResetFeatures · BarbershopSetFeature · BarbershopSubmitFeatures · GetPlayerVariation · IsShowingCloakHeraldry · RevertPlayerVariation · SetPlayerVariation
Auction
BuyAuction · CancelAuction · CreateAuction · SendAuctionSearch
Bindings
AddBinding · RemoveAllBindings · RemoveBinding · RestoreDefaultBindings
Career
GameData.Player.GetAdvanceData · GameData.Player.GetAdvancePointsAvailable · GameData.Player.GetAdvancePointsSpent · GameData.Player.GetRenownRefundCost · GameData.Player.GetSpecialtyRefundCost · RefundRenownPoints · RefundSpecialtyPoints · SetCareerMasteryImages
CharacterSettings
CharacterSettingsClearRunningDefaultUiFlag · CharacterSettingsCreateUiProfile · CharacterSettingsExportUiProfile · CharacterSettingsGetAllUiProfiles · CharacterSettingsGetData · CharacterSettingsGetOtherCharactersUsingProfile · CharacterSettingsHandleDeletedCharacter · CharacterSettingsImportUiProfile · CharacterSettingsRemoveUiProfile · CharacterSettingsRenameUiProfile · CharacterSettingsSetActiveUiProfile · CharacterSettingsSetUiProfileShared
Chat
GetChatChannelNames · GetInputLanguageString · SendChatText · ToggleLanguageState
Crafting
AddCraftingContainer · AddCraftingItem · BuyTradeSkill · GetBonusIsSalvagable · GetCraftingBackPackSlots · GetCraftingData · GetCraftingItemData · GetCultivationInfo · GetSalvagingDifficulty · GetTradeskillIcon · GetTradeSkillLevel · PerformCrafting · RemoveCraftingItem · RequestSalvageItem · SendCloseCrafting · SendInitCrafting · UpdateCraftingStatus
Dye
CanUseDyeItem · DyeMerchantPreview · DyeMerchantPreviewAll · DyePreview · GetDyeMerchantData · GetDyeName · GetDyeTintMasks · RevertAllDyePreview · RevertDyePreview
Effect
GetBuffs · RemoveEffect · RemoveTargetEffect · UseEffect
Game
BuyCareerPackage · ClaimMarketingReward · DestroyItem · GetAbilityData · GetAbilityTable · GetActionIdFromName · GetActionNameFromId · GetActionsForButtonCombination · GetActiveObjectivesData · GetActiveTactics · GetAreaData · GetBindingsForAction · GetButtonName · GetCareerResource · GetChoiceRewardsData · GetCurrentEnhancementItemData · GetEquipmentData · GetExperienceData · GetFlightMasterData · GetGivenRewardsData · GetGroupData · GetGuildMemberData · GetGuildPermissionData · GetInfluenceData · GetInventoryItemData · GetLootRollData · GetMacrosData · GetMapPointData · GetNumGroupmates · GetNumTacticsSlots · GetPlayerEnergy · GetQuestData · GetQuestItemData · GetQuestPointConditions · GetReleventAreaIndex · GetStoreData · GetTacticsSet · GetTargetStatesData · GetTimeUntilAutoRespawn · GetTomeAlertsData · GetTradeItemData · IsPlayerInitialized · PlaySound · ResetMarketingReward · RMTPaidNameChange · SendBugReport · SendSurveyResponse · SetGroupLootMode · SetGroupLootThreshold · SetTrackQuest · SetTrackQuestPin · TakeScreenShot
Group
GetAndClearPartyMemberDirtyFlag · GetAndClearWarbandMemberDirtyFlag · GetBattlegroupMemberData · GetBolsterBuddy · GetGroupMemberStatusData · GetWarbandMemberStatus · IsPlayerMainAssist · IsPlayerSolo · IsWarBandActive
Guild
ConfirmedTransferGuild · GetAllianceMemberCounts · GetAllianceMemberData · GetBannerConfigurationData · GetDatabaseGuildData · GetGuildAdvancementData · GetGuildAppointmentData · GetGuildPollData · GetGuildSignupData · GetGuildTacticsRespecCost · GetHeraldryBestOptions · GetHeraldryConfigurationData · GetHeraldryCost · GetHeraldryResetCost · GetNewbieGuildFlag · GetNumAssignedBearers · GuildGetRewards · GuildRecruitmentProfileGetData · GuildRecruitmentProfileSetData · GuildRecruitmentSearch · ResetGuildHeraldry · RespecGuildTactics · SendBannerConfigurationData · SendGuildAllianceCommand · SendGuildAppointmentData · SendGuildVaultCommand · SendHeraldryConfigurationData · SetGuildHeraldryScene · SetGuildStandardScene
Help
EA_Window_HelpGetEntryData · EA_Window_HelpGetFAQEntryData · EA_Window_HelpGetFAQTopicList · EA_Window_HelpGetHelpTipsList · EA_Window_HelpGetTopicList
Hotbar
GetHotbarCooldown · GetHotbarData · GetHotbarGlowLevels · GetHotbarIcon · GetHotbarName · GetHotbarPage · GetMoraleBarData · GetMoraleCooldown · SetHotbarData · SetHotbarPage · SetMacroData · SetMoraleBarData
Interact
AddSelectedReward · ClearSelectedRewards · GetBuyBackData · GetDesiredInteractAction · GetStoreCategories · InteractGetBaseInteractionData · InteractSelect · PlayInteractSound · RemoveSelectedReward · SelectInfluenceReward · SetDesiredInteractAction · SwitchStoreCategories
Interface
BroadcastEvent · BuildTableFromCSV · ClearCursor · CreateConversationLog · CreateHyperLink · CreateMapInstance · CreateWindow · CreateWindowFromTemplate · DestroyWindow · EnableAlert · GetAdvisorFlag · GetCheckForCircularDependencies · GetIconData · GetLoadLuaDebugLibrary · GetMapIconData · GetScreenResolution · GetStringFormatFromTable · GetStringFromTable · GetTemplateWindowDimensions · GetUseLuaErrorHandling · IsInternalBuild · IsMacClient · IsModifierKey · LoadResources · MapSetMapView · NifDisplaySetTranslation · OpenURL · RegisterEventHandler · RegisterWindowSet · ScaleInterface · SetAdvisorFlag · SetCheckForCircularDependencies · SetCursor · SetHardwareCursor · SetItemDragging · SetLoadLuaDebugLibrary · SetNamesAndTitlesFont · SetPlayerPortraitBackground · SetTargetPortraitBackground · SetTextureImage · Settings.HardwareSupportsPostProc · Settings.SetBrightnessAndGamma · SetUseLuaErrorHandling · StringToWString · UnregisterEventHandler · VideoPlayerIsPlaying · WStringToString
Item
AttachTrophyToLocation · AutoEquipItem · BuyBackpackSlots · BuyBankSlots · GetBankData · GetBonus · GetCurrencyItemData · GetDatabaseItemData · GetEquippedItemVisible · GetInventorySlotStackCount · GetItemStackCount · GetLocationsForTrophies · GetNumBrassPerGold · GetNumBrassPerSilver · GetOverflowData · GetSingleItem · GetTrophyData · RequestEquipTrophy · RequestItemSet · RequestMoveItem · SendCustomizeItemIcon · SendUseItem · SetEquippedItemVisible · TransferBetweenBackpacks · UpgradeEquipment
ItemEnhancement
AddItemEnhancement · BeginItemEnhancement · EndItemEnhancement · FuseItemEnhancements · RemoveItemEnhancement
LCD
LCDBitmapSetImage · LCDButtonPressed · LCDCreateBitmap · LCDCreatePage · LCDCreateProgressBar · LCDCreateStaticText · LCDDestroyPage · LCDGetLocation · LCDGetSize · LCDProgressBarGetProgress · LCDProgressBarSetProgress · LCDRegisterEventHandler · LCDSetButtonHandler · LCDSetLocation · LCDSetSize · LCDShowPage · LCDStaticTextSetText · LCDUnregisterEventHandler · LCDUnsetButtonHandler
LiveEvent
CurrentEventsGetList · CurrentEventsGetTimers · CurrentEventsJumpToEvent · CurrentEventsUpdate · GetLiveEventData · GetLiveEventList · GetLiveEventTasks · SelectEventRewards · SetLiveEventTaskImage
Loot
AssignLootItem · GameData.InteractData.GetClaimWindowList · GameData.InteractData.GetItemLootList · GameData.InteractData.GetLootableItem · GameData.InteractData.GetLootList · GameData.InteractData.IsLootAvailable · ItemContainerLootItem · LootAllItems · LootItem · LootRollOptOut · SelectItemRollChoice · SetGroupAutoLootInRvR · SetGroupNeedMode
Map
GetMapTextPoints · GetOverheadMapZoomLevel · GetZoneIDList · GetZonePairing · GetZoneTier · GetZoneTransitionPoints · MapGetChildMaps · MapGetCoordinatesForPoint · MapGetParentMap · MapGetPlayerLocationMaps · MapGetPointForCoordinates · MapSetPinFilter · MapSetPinGutter · SetOverheadMapZoomLevel
Module
ModuleAddSavedVariable · ModuleInitialize · ModuleLoad · ModuleRemoveSavedVariable · ModuleSetEnabled · ModulesGetData · ModulesInitializeAllEnabled · ModulesLoadFromDirectory · ModulesLoadFromListFile · ModulesSaveSettings
Pet
CommandPet · CommandPetDoAbility · CommandPetToggleAbility
Pregame
CanPlayCinematic · GetAccountData · GetCreditsData · GetServerList · LoadingScreenGetCurrentData · LoadingScreenGetPatchNotesData · NamingConflictRequestNewName · PregameBlockMouseOver · PregameGetCharacterSelectNumPages · PregameGetCharacterSelectPage · PregameGetEULAFileName · PregameGetPreSelectedServerRealm · PregameGetQuickStartLabels · PregameGetRealmLimit · PregameGetROCFileName · PregameGetServerRealmBonuses · PregameHasEULAChanged · PregameHasROCChanged · PregamePlayCinematic · PregameRandomFeatures · PregameSetCharacterSelectPage · PregameSetFeature · PregameSetPreSelectedServerRealm · PregameSetServerRealmBonuses · PregameStopCinematic · SelectServer
PublicQuest
ClearPQLootData · GameData.GetInfluenceRewards · GetPQLootWinners · GetPQTopContributors · GetRewardPools · PQLootItem
Quest
AbandonQuest · GameData.GetQuestRewards · GetDatabaseQuestData · ShareQuest
RvR
BuildSiegeWeapon · CancelKeepUpgrade · DonateToAltar · EnableRRQUpdates · FireAltarAbility · GameData.GetObjectiveData · GetCampaignCityData · GetCampaignPairingData · GetCampaignZoneData · GetCityRatingForCityId · GetFortressStatuses · GetGameDataObjectives · GetKeepData · GetRelicStatuses · GetRRQData · GetSiegePadBuildData · GetSiegeWeaponControlData · GetSiegeWeaponUsersData · GetUnderdogRatings · GetZoneLargestHotspotSize · GetZoneObjectivesData · PurchaseKeepUpgrade · RepairSiegeWeapon · SiegeSetWindDirectionImage
Scenario
GameData.GetScenarioGroupReservations · GameData.GetScenarioPlayerGroups · GameData.GetScenarioPlayers · GetCityInstanceId · GetScenarioQueueData · IsScenarioF2PServer · JoinScenarioGroup · LeaveScenarioGroup
Social
AddTemporaryIgnore · GetAFKFlag · GetBraggingRights · GetFriendsList · GetIgnoreList · GetInspectionBragData · GetInspectionData · GetOpenPartyFullList · GetOpenPartyNotificationList · GetOpenPartyWorldList · GetSearchList · GetSocialPreferenceData · SendHelpMessage · SendMailboxCommand · SendOpenPartySearchRequest · SendOpenPartyWorldSearch · SendPlayerInspectionRequest · SendPlayerSearchRequest · SetBraggingRight · SetBraggingRightsCard · SetOpenPartyWorldInterests · UnsetOpenPartyWorldInterests
StringTable
LoadStringTable · UnloadStringTable
Tactics
ActivateTactics · AddActiveTactic · ClearActiveTactics · RemoveActiveTactic · SaveTacticsSet · SwapActiveTactic
Target
ClearTarget · GetNameForObject · GetUpdatedTargets · SetTargetToSummon · UnitInfo
Time
GetComputerTime · GetEpochTime · GetFirstDayOfWeek · GetGameTime · GetMonthName · GetTimeStamp · GetTodaysDate · GetWeekDayName · GetYearMonthName
Tome
GetChapterName · GetChapterShortName · RemoveTomeAlert · TomeGetAchievementsEntryData · TomeGetAchievementsSubTypeData · TomeGetAchievementsTOC · TomeGetBestiarySpeciesData · TomeGetBestiarySubTypeData · TomeGetBestiaryTOC · TomeGetCardData · TomeGetCardList · TomeGetHistoryAndLoreEntryData · TomeGetHistoryAndLoreTOC · TomeGetHistoryAndLoreZoneData · TomeGetItemRewardData · TomeGetItemRewardsList · TomeGetNoteworthyPersonsEntryData · TomeGetNoteworthyPersonsTOC · TomeGetNoteworthyPersonsZoneData · TomeGetOldWorldArmoryArmorSet · TomeGetOldWorldArmoryTierTOC · TomeGetOldWorldArmoryTOC · TomeGetPlayerTitleData · TomeGetPlayerTitlesAvailiableTypes · TomeGetPlayerTitlesTypeData · TomeGetSigilDisplayInfo · TomeGetSigilEntry · TomeGetSigilTOC · TomeGetTacticCounter · TomeGetTacticCounterRewardData · TomeGetTacticRewardData · TomeGetTacticRewardsList · TomeGetWarJournalAvailiableStorylines · TomeGetWarJournalEntryData · TomeGetWarJournalGlyphEntryForZone · TomeGetWarJournalStorylineData · TomeIsAchievementsEntryUnlocked · TomeIsAchievementsSubTypeUnlocked · TomeIsBestiarySpeciesUnlocked · TomeIsBestiarySubTypeUnlocked · TomeIsHistoryAndLoreEntryUnlocked · TomeIsNoteworthyPersonsEntryUnlocked · TomeIsPlayerTitleUnlocked · TomeIsWarJournalEntryUnlocked · TomeIsWarJournalStorylineUnlocked · TomeSetAchievementsSubTypeImage · TomeSetActivePlayerTitle · TomeSetBestiarySpeciesImage · TomeSetBestiarySubTypeImage · TomeSetWarJournalEntryImage · TomeSetWarJournalGlyphImage
Trade
AcceptTrade · CancelTrade · ChangeTrade · InitiateTrade
WorldObject
AttachWindowToWorldObject · DetachWindowFromWorldObject · ForceUpdateWorldObjectWindow · MoveWindowToWorldObject · WorldToScreen