js:MTScript: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Removed some extra semicolons where they didn't belong) |
||
| (5 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Experimental}} | {{Experimental}} | ||
Within the javascript environment used by {{code|js.eval}}, {{code|MTScript}} is the entry point for interacting with mtscript variables and macros. | Within the javascript environment used by {{code|js.eval}}, {{code|MTScript}} is the entry point for interacting with mtscript variables and macros. (This is separate from and independent of the JavaScript environment used in {{func|frame5}} and similar panels.) | ||
{{MacroFunction | {{MacroFunction | ||
| Line 10: | Line 10: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.abort() | MTScript.abort() | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|throws}} - AbortFunctionException | * {{code|throws}} - AbortFunctionException | ||
| Line 20: | Line 20: | ||
}} | }} | ||
{{MacroFunction | {{MacroFunction | ||
|name=MTScript.mtsAssert | |name=MTScript.mtsAssert | ||
|trusted=true | |trusted=true | ||
|version=1.10.0 | |version=1.10.0 | ||
| Line 27: | Line 27: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.mtsAssert(check, message, pad=true) | MTScript.mtsAssert(check, message, pad=true) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 48: | Line 48: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.setVariable(variable, value) | MTScript.setVariable(variable, value) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|variable}} - String, Variable name to set. | * {{code|variable}} - String, Variable name to set. | ||
| Line 65: | Line 65: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.getVariable(variable) | MTScript.getVariable(variable) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|variable}} - String, Variable name to get. | * {{code|variable}} - String, Variable name to get. | ||
| Line 75: | Line 75: | ||
{{MacroFunction | {{MacroFunction | ||
|name=MTScript.evalMacro | |name=MTScript.evalMacro | ||
|trusted=true | |trusted=true | ||
|version=1.10.0 | |version=1.10.0 | ||
| Line 82: | Line 82: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.evalMacro(macro) | MTScript.evalMacro(macro) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 94: | Line 94: | ||
{{MacroFunction | {{MacroFunction | ||
|name=MTScript.execMacro | |name=MTScript.execMacro | ||
|trusted=true | |trusted=true | ||
|version=1.10.0 | |version=1.10.0 | ||
| Line 101: | Line 101: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.execMacro(macro) | MTScript.execMacro(macro) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 112: | Line 112: | ||
}} | }} | ||
{{MacroFunction | {{MacroFunction | ||
|name=MTScript.getMTScriptCallingArgs | |name=MTScript.getMTScriptCallingArgs | ||
|trusted=true | |trusted=true | ||
|version=1.10.0 | |version=1.10.0 | ||
| Line 118: | Line 118: | ||
Returns the arguments passed to {{func|js.eval}} as a list. | Returns the arguments passed to {{func|js.eval}} as a list. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.getMTScriptCallingArgs() | MTScript.getMTScriptCallingArgs() | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 135: | Line 135: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="javascript" line> | ||
MTScript.registerMacro(macroName, callable) | MTScript.registerMacro(macroName, callable) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 146: | Line 146: | ||
|example= | |example= | ||
Using {{code|MTScript.registerMacro}}. | Using {{code|MTScript.registerMacro}}. | ||
< | <syntaxhighlight lang="javascript" line> | ||
function yell(str) { | function yell(str) { | ||
MapTool.chat.broadcast(str.toUpperCase()); | MapTool.chat.broadcast(str.toUpperCase()); | ||
| Line 152: | Line 152: | ||
MTScript.registerMacro("yell", yell); | MTScript.registerMacro("yell", yell); | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: js.yell("hello world")] | [h: js.yell("hello world")] | ||
</ | </syntaxhighlight> | ||
'''Output:''' | '''Output:''' | ||
< | <syntaxhighlight> | ||
HELLO WORLD | HELLO WORLD | ||
</ | </syntaxhighlight> | ||
}} | }} | ||
Latest revision as of 05:05, 5 July 2023
This article describes a feature or macro function that is experimental and may be subject to change.
Within the javascript environment used by js.eval, MTScript is the entry point for interacting with mtscript variables and macros. (This is separate from and independent of the JavaScript environment used in frame5() and similar panels.)
MTScript.abort() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Similar to the abort() macro, but accepts no arguments. Immediately halts macro execution with no message.
Usage
MTScript.abort()
Parameters
throws- AbortFunctionException
MTScript.mtsAssert() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Like the assert() macro.
Usage
MTScript.mtsAssert(check, message, pad=true)
Parameters
checkValue to check: iftrue, do nothing.messageMessage to include in the error ifcheckis false.padIf true, wrap the error in a localized error string.throwsAssertFunctionException ifcheckis false.
MTScript.setVariable() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Sets an MTScript variable. Like
{{{1}}}. For use with MTScript.evalMacro.Usage
MTScript.setVariable(variable, value)
Parameters
variable- String, Variable name to set.value- Any javascript object. Value to set.
MTScript.getVariable() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Reads an MTScript variable. Counterpart to
MTScript.setVariable.Usage
MTScript.getVariable(variable)
Parameters
variable- String, Variable name to get.
MTScript.evalMacro() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Run a mtscript macro in the current macro context.
Usage
MTScript.evalMacro(macro)
Parameters
macroString to run as a macro.returnAny mtscript type.
MTScript.execMacro() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Run a mtscript macro in a new macro context. This is similar to
evalMacro, except variables from the previous macro context are unavailable, and changes to mtscript variables from within this macro are discarded when the macro exits.Usage
MTScript.execMacro(macro)
Parameters
macroString to run as a macro.returnAny mtscript type.
MTScript.getMTScriptCallingArgs() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the arguments passed to js.eval() as a list.
Usage
MTScript.getMTScriptCallingArgs()
Parameters
returnlist of arguments passed to the current js.eval() call.
MTScript.registerMacro() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Registers a javascript function as a MT UDF under the js. prefix.
Usage
MTScript.registerMacro(macroName, callable)
Parameters
macroNameName for the new UDF. Note that "js." will be prepended to the name.callableAny javascript callable.
Example
Using
MTScript.registerMacro.
function yell(str) {
MapTool.chat.broadcast(str.toUpperCase());
}
MTScript.registerMacro("yell", yell);
[h: js.yell("hello world")]Output:
HELLO WORLD