WoW:API RunScript: Difference between revisions
Jump to navigation
Jump to search
m (Move page script moved page API RunScript to API RunScript without leaving a redirect) |
|||
| (2 intermediate revisions by one other user not shown) | |||
| Line 6: | Line 6: | ||
== Parameters == | == Parameters == | ||
=== Arguments === | === Arguments === | ||
: | :;script : string - code to be executed | ||
=== Returns === | === Returns === | ||
: | :none | ||
== Example == | == Example == | ||
:To define a function dynamically you could do: | :To define a function dynamically you could do: | ||
< | <pre> | ||
local retExpr = '"Hello " .. UnitName("target")'; | |||
RunScript("function My_GetGreeting() return " .. retExpr .. ";end"); | |||
< | </pre> | ||
=== Result === | |||
:The My_GetGreeting() function will be defined to return Hello followed by the name of your target. | :The My_GetGreeting() function will be defined to return Hello followed by the name of your target. | ||
Latest revision as of 04:47, 15 August 2023
Execute a string as LUA code.
RunScript("script")
Parameters[edit]
Arguments[edit]
- script
- string - code to be executed
Returns[edit]
- none
Example[edit]
- To define a function dynamically you could do:
local retExpr = '"Hello " .. UnitName("target")';
RunScript("function My_GetGreeting() return " .. retExpr .. ";end");
Result[edit]
- The My_GetGreeting() function will be defined to return Hello followed by the name of your target.
Details[edit]
- This function is NOT recommended for general use within addons for a number of reasons:
- 1. It'll do whatever you tell it, that includes calling functions, setting variables, whatever.
- 2. Errors in the script string produce the error popup (at least, they produce the UI_ERROR_MESSAGE event).
- On the other hand, it's invaluable if you need to run code that is input by the player at run-time, or do self-generating code.
See Also[edit]
- The standard Lua function API loadstring, which can overcome all of the problems of RunScript described above.