Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
WildStar
Talk
English
Views
Read
Edit
History
More
Search
Navigation
Home
Random page
Help using wiki
Editions
for WoW
for WildStar
for Solar2D
Documentation
for WoW
for WildStar
Reference
WoW
⦁ FrameXML
⦁ AddOns
⦁ API
⦁ WoW Lua
WildStar
⦁ AddOns
⦁ API
⦁ WildStar Lua
Engine
Tools
What links here
Related changes
Special pages
Page information
Site
Recent Changes
Editing
WildStar:UI API
(section)
Jump to navigation
Jump to search
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!
=== [[\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)
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)