getSightType: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
(Update for 1.7)
Line 3: Line 3:
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns the type of [[Token:sight|sight]] that the [[Current Token]] has.
Returns the type of [[Token:sight|sight]] that the [[Current Token]] has. When no sight type is set, returns an empty string.


|usage=
|usage=
Line 17: Line 17:


|changes=
|changes=
{{change|1.7.0|Now returns an empty string when no sight type is set.
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}



Revision as of 00:06, 16 May 2020

{{MacroFunction |name=getSightType |version=1.3b48 |description= Returns the type of sight that the Current Token has. When no sight type is set, returns an empty string.

|usage=

getSightType()
getSightType(id)
getSightType(mapname)

Parameters

  • id - The id of the token to have the State set. Defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

  • mapname - The name of the map to find the token. Defaults to the current map.

|changes=

  • 1.7.0 - Now returns an empty string when no sight type is set.
  • 1.5.4 - Added id and mapname parameter options.