getImpersonated: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
m (Text replacement - "<source" to "<syntaxhighlight")
 
(6 intermediate revisions by 3 users not shown)
Line 5: Line 5:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getImpersonated()
getImpersonated()
getImpersonated(global)
getImpersonated(global)
</source>
</syntaxhighlight>


'''Parameter'''
'''Parameter'''
{{param|global|Whether to return the id of the token impersonated in the current macro context, or the id of the token impersonated through the UI. Defaults to 0 (macro context).}}
{{param|global|If set to {{false}}, returns the id of the token impersonated in the current macro context. If set to {{true}}, returns the token impersonated globally through the UI. Defaults to {{false}} (macro context).}}


|changes=
|changes=
Line 17: Line 17:
{{change|1.7.0|Added parameter "global".}}
{{change|1.7.0|Added parameter "global".}}


|also=
[[getImpersonatedName|getImpersonatedName()]]


}}
}}
[[Category:Token Function]]
[[Category:Token Function]]
[[Category:Impersonation Function]]
[[Category:Impersonation Function]]

Latest revision as of 23:59, 14 March 2023

getImpersonated() Function

Introduced in version 1.3b48
Returns the id of the impersonated token.

Usage

getImpersonated()
getImpersonated(global)

Parameter

  • global - If set to false(0), returns the id of the token impersonated in the current macro context. If set to true(1), returns the token impersonated globally through the UI. Defaults to false(0) (macro context).


See Also

Version Changes

  • 1.3b51 - No longer a trusted function.
  • 1.7.0 - Added parameter "global".