impersonate

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(tokenRef)

Parameters

• tokenRef - Either the token id or Token Name of the token to impersonate.

Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.

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

hasImpersonated(), getImpersonated(), getImpersonatedName(), switchToken()

Version Changes

• 1.7.0 - Introduced.