isPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Updated with recent version changes.)
No edit summary
Line 8: Line 8:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
isPC()
isPC()
</source>
<source lang="mtmacro" line>
isPC(id)
isPC(id)
isPC(id, mapname)
</source>
</source>
'''Parameter'''
'''Parameter'''
{{param|id|The token {{code|id}} of the token which has its PC status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|id|The token {{code|id}} of the token which has its PC status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}


|example=
|example=
Line 27: Line 27:
|changes=
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
{{change|1.3b51|Added {{code|id}} parameter option.}}
{{change|1.5.4|Added {{code|mapname}} parameter option.}}


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

Revision as of 19:34, 15 August 2019

isPC() Function

Introduced in version 1.3b48
Returns true(1) if a Token is a PC or false(0) if it is not.

Usage

isPC()
isPC(id)
isPC(id, mapname)

Parameter

  • id - The token id of the token which has its PC status checked, 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.

Example

[r, if(isPC()): "Hello I am a PC"]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.