Navigation menu
Personal tools
Not logged in
Talk
Contributions
Create account
Log in
Namespaces
WoW
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
WoW:World of Warcraft 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!
=== System === :{{id|API|ConsoleExec}}("command") - Execute a console command. :{{id|API|DetectWowMouse}}() - Attempts to detect the world of warcraft MMO mouse. :{{id|API|GetBuildInfo}}() - Returns information about current client build. :{{id|API|geterrorhandler}}() - Returns the currently set error handler. :{{id|API|GetCurrentKeyBoardFocus}}() - Returns the [editbox] widget currently handling keyboard events. :{{id|API|GetExistingLocales}}() - Returns a list of installed language packs. :{{id|API|GetFramerate}}() - Returns the current framerate (full precision) :{{id|API|GetGameTime}}() - Returns the time in-game. :{{id|API|GetLocale}}() - Returns client locale, example 'enUS'. :{{id|API|GetCursorPosition}}() - Returns the cursor's position on the screen. :{{id|API|GetNetStats}}() - Get bandwidth and latency network information. :{{id|API|GetRealmName}}() - returns the name of the server a user is logged in to :{{id|API|GetScreenHeight}}() - Returns the height of the window in pixels. :{{id|API|GetScreenWidth}}() - Returns the width of the window in pixels. :UI {{id|API|GetText}}() - Used to localize some client text. :{{id|API|GetTime}}() - Returns the system uptime in seconds (millisecond precision). :{{id|API|IsAltKeyDown}}() - Returns true if the alt key is currently depressed. :{{id|API|InCinematic}}() :{{id|API|IsControlKeyDown}}() - Returns true if the control key is currently depressed. :{{id|API|IsDebugBuild}}() :{{id|API|IsDesaturateSupported}}() :{{id|API|IsLeftAltKeyDown}}() - Returns true if the left alt key is currently depressed. :{{id|API|IsLeftControlKeyDown}}() - Returns true if the left control key is currently depressed. :{{id|API|IsLeftShiftKeyDown}}() - Returns true if the left shift key is currently depressed. :{{id|API|IsLinuxClient}}() - Boolean - Returns true if WoW is being run on Linux. :{{id|API|IsLoggedIn}}() - Returns nil before the PLAYER_LOGIN event has fired, 1 afterwards. :{{id|API|IsMacClient}}() - Returns true if WoW is being run on Mac. :{{id|API|IsRightAltKeyDown}}() - Returns true if the right alt key is currently depressed. :{{id|API|IsRightControlKeyDown}}() - Returns true if the right control key is currently depressed. :{{id|API|IsRightShiftKeyDown}}() - Returns true if the right shift key is currently depressed. :{{id|API|IsShiftKeyDown}}() - Returns true if the shift key is currently depressed. :{{id|API|IsStereoVideoAvailable}}() - (added 3.0.8) :{{id|API|IsWindowsClient}}() - Returns true if WoW is being run on Windows. :{{id|API|OpeningCinematic}}() - Shows the opening movie for a player's race :{{id|API|PlayMusic}}() - Plays the specified mp3. :{{id|API|PlaySound}}() - Plays the specified built-in sound effect. :{{id|API|PlaySoundFile}}() - Plays the specified sound file. :HW {{id|API|ReloadUI}}() - Reloads the UI from source files :{{id|API|RepopMe}}() - The "Release Spirit" button. Sends you to the graveyard when dead. :{{id|API|RequestTimePlayed}}() - Request a summary of time played from the server. :{{id|API|RestartGx}}() - Restarts the graphical engine. Needed for things such as resolution changes to take effect. :{{id|API|RunScript}}("script") - Execute "script" as a block of Lua code. :{{id|API|Screenshot}}() - Takes a screenshot. :UI {{id|API|SecondsToTime}} - Converts a number of seconds into a readable days / hours / etc. formatted string. :{{id|API|SetAutoDeclineGuildInvites}}(value) - Set the checkbox option for blocking guild invites (value may be 0 or 1) :{{id|API|seterrorhandler}}(function) - Set the error handler to the given parameter. :{{id|API|StopCinematic}}() :{{id|API|StopMusic}}() - Stops the currently playing mp3. :UI {{id|API|UIParentLoadAddOn}}("AddOnName") - Loads or Reloads the specified AddOn, and pops up an error message if it fails to load for any reason. :UI {{id|API|TakeScreenshot}}() - Takes a screenshot. :UI {{id|API|ERRORMESSAGE}}(value) - Displays the script error dialog with optional text :{{id|API|debuginfo}}() - Output win32 debug text. Freeware debug message viewer: [http://www.sysinternals.com/Utilities/DebugView.html DebugView] (Has no effect on live server.) :UI {{id|API|message}}("text") - Displays a message box with your text message and an "Okay" button.
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)