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:RestrictedEnvironment
(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!
== Available API == : {{api|SecureCmdOptionParse}}("conditionalString") : parses a macro conditional. : {{api|GetShapeshiftForm}}() : returns current shape shift form. : {{api|IsStealthed}}() : returns 1 if the player is stealthed : {{api|UnitExists}}("unit") : returns 1 if the unit exists. : {{api|UnitIsDead}}("unit") : returns 1 if the unit is dead. : {{api|UnitIsGhost}}("unit") : returns 1 if the unit is a ghost. : {{api|UnitPlayerOrPetInParty}}("unit") : returns 1 if the unit is a player or a pet in your party. : {{api|UnitPlayerOrPetInRaid}}("unit") : returns 1 if the unit is a player or a pet in your raid. : {{api|IsRightAltKeyDown}}(), {{api|IsLeftAltKeyDown}}(), {{api|IsAltKeyDown}}() : return 1 if the relevant key is held down. : {{api|IsRightControlKeyDown}}(), {{api|IsLeftControlKeyDown}}(), {{api|IsControlKeyDown}}() : return 1 if the relevant key is held down. : {{api|IsRightShiftKeyDown}}(), {{api|IsLeftShiftKeyDown}}(), {{api|IsShiftKeyDown}}() : return 1 if the relevant key is held down. : {{api|IsModifierKeyDown}}() : returns 1 if any alt, control or shift key is held down. : {{api|IsModifiedClick}}("modifierType") : returns 1 if the associated modifier is held down. : {{api|GetMouseButtonClicked}}() : returns the mouse button responsible for the hardware click. : {{api|GetActionBarPage}}() : returns the current action bar page. : {{api|GetBonusBarOffset}}() : returns the current action bar "bonus" offset (stance-specific bars). : {{api|IsMounted}}() : returns 1 if the player is mounted. : {{api|IsSwimming}}() : returns 1 if the player is swimming. : {{api|IsFlying}}() : returns 1 if the player is flying. : {{api|IsFlyableArea}}() : returns 1 if the player is in a flyable area (Northrend, Outland). : {{api|IsIndoors}}() : returns 1 if the player is indoors. : {{api|IsOutdoors}}() : returns 1 if the player is outdoors. : {{api|GetBindingKey}}("key") : returns the action bound to a key. : {{api|HasAction}}(slot) : returns 1 if an action is placed in the specified action bar slot. : {{api|IsHarmfulSpell}}(slot[, bookType] or "spellName") : returns 1 if the spell can be cast on hostile targets. : {{api|IsHarmfulItem}}(slot[, bookType] or "spellName") : returns 1 if the item can be used on hostile targets. : {{api|IsHelpfulSpell}}(slot[, bookType] or "spellName") : returns 1 if the spell can be cast on friendly targets. : {{api|IsHelpfulItem}}(slot[, bookType] or "spellName") : returns 1 if the item can be used on friendly targets. : {{api|PlayerCanAttack}}("unit") : returns 1 if the player can attack the specified unit. : {{api|PlayerCanAssist}}("unit") : returns 1 if the player can assist the specified unit. : {{api|PlayerIsChanneling}}() : returns 1 if the player is channeling a spell. : {{api|PlayerPetSummary}}() : returns pet creature family and pet name. : {{api|PlayerInCombat}}() : returns 1 if the player or his pet is in combat. : {{api|PlayerInGroup}}() : returns "party" or "raid" if the player is in one of those group types. : {{api|UnitHasVehicleUI}}("unit") : returns 1 if the unit is in a vehicle that provides special UI. : {{api|RegisterStateDriver}}(frame, state, conditional) : registers a [[SecureStateDriver]] for a specific frame. : {{api|GetActionInfo}}(slot) : returns limited information about an action in a specific action slot. === Restricted tables === Only ''restricted'' tables are accessible within the restricted environment -- essentially, the real table instances are kept local to prevent unrestricted access to variables within the restricted environment. Most table functions within the restricted environment have been replaced by restricted table-aware versions, with the exception of the {{api|gsub}} function (use the restricted table-aware {{api|rtgsub}} instead of table lookup functionality is desired). The following table-related functions are usable inside the restricted environment: {| class="darktable" | colspan="7" align="left" style="padding: 0.3em; background: #282828" | '''Restricted Table Library''' |- | width="14%" | rtable.next | width="14%" | rtable.pairs | width="14%" | rtable.ipairs | width="14%" | rtable.unpack | width="14%" | rtable.newtable | width="14%" | rtable.maxn | width="16%" | rtable.insert |- | rtable.remove || rtable.sort || rtable.concat || rtable.wipe || rtable.type || rtable.rtgsub || |- | colspan="7" align="left" style="padding: 0.3em; background: #282828" | '''Table Library''' (restricted-table aware) |- | table.maxn || table.insert || table.remove || table.sort || table.concat || table.wipe || table.new |- | colspan="7" align="left" style="padding: 0.3em; background: #282828" | '''Global API''' |- | newtable || pairs || ipairs || next || unpack || wipe || tinsert |- | tremove || type || rtgsub | colspan="4" | |} Note that as the restricted environment doesn't contain proper function references, table.sort's second argument (comparison function) may not be used from within the restricted environment. === Other functions === The math and string standard library tables are provided in their entirety. The following table lists additional global functions that are also available in the restricted environment {| class="darktable" |- | width="9%" | select | width="9%" | tonumber | width="9%" | tostring | width="9%" | print | width="9%" | format | width="9%" | gmatch | width="9%" | gsub | width="9%" | strbyte | width="9%" | strchar | width="9%" | strconcat | width="9%" | strfind |- | strjoin || strlen || strlower || strmatch || strrep || strrev || strsplit || strsub || strtrim || strupper || abs |- | acos || asin || atan || atan2 || ceil || cos || deg || exp || floor || frexp || ldexp |- | log || log10 || max || min || mod || rad || random || sin || tan || |}
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)