getImpersonated: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
Line 11: Line 11:


'''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=

Revision as of 12:32, 18 May 2020

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).


Version Changes

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