impersonate: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
impersonate(id) | impersonate(id) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|id|The id or name of the token to impersonate.}} | {{param|id|The id or name of the token to impersonate.}} | ||
| Line 16: | Line 16: | ||
|example= | |example= | ||
Calling {{func|impersonate}} in a macro will cause the output to be as if from that token. The last call to {{func|impersonate}} in a macro sets the "speaker" for the output of the whole macro. | Calling {{func|impersonate}} in a macro will cause the output to be as if from that token. The last call to {{func|impersonate}} in a macro sets the "speaker" for the output of the whole macro. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: impersonate("Hero")]Hi!<br> | [h: impersonate("Hero")]Hi!<br> | ||
Nice weather, eh?<br> | Nice weather, eh?<br> | ||
Seen any dragons? | Seen any dragons? | ||
</ | </syntaxhighlight> | ||
Output: | Output: | ||
[[File: | [[File:Func_impersonate_example1.png]] | ||
Latest revision as of 16:23, 15 March 2023
impersonate() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.7.0
• Last checked for compatibility with version 1.7.0
Impersonate changes the impersonated token for the client running the function, replacing any current impersonation. Rather than being used like switchToken() to aid in macro execution, this function is the same as right-clicking a token and selecting 'Impersonate'. The function does not set the Current Token. Use switchToken() for that.
Usage
impersonate(id)Parameters
id- The id or name of the token to impersonate.
Example
Calling impersonate() in a macro will cause the output to be as if from that token. The last call to impersonate() in a macro sets the "speaker" for the output of the whole macro.
[h: impersonate("Hero")]Hi!<br>
Nice weather, eh?<br>
Seen any dragons?Output:
See Also
Version Changes
- 1.7.0 - Introduced.