isPC: Difference between revisions

Latest revision as of 15:50, 17 May 2024

• Introduced in version 1.3b48

Returns true(1) if a Token is a PC or false(0) if it is not.

isPC()
isPC(tokenRef)
isPC(tokenRef, mapname)

Parameter

tokenRef - Either the token id or Token Name 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.

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.

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

@@ Line 1: / Line 1: @@
-==Function isPC==
+{{MacroFunction
+|name=isPC
+|version=1.3b48
+|description=
+Returns {{true}} if a [[Token]] is a PC or {{false}} if it is not.
-Returns 1 if the [[Token:token|token]] is a PC or 0 if it not.
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+isPC()
+isPC(tokenRef)
+isPC(tokenRef, mapname)
+</syntaxhighlight>
+'''Parameter'''
+{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] 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.}}
+{{Note|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=
+<syntaxhighlight lang="mtmacro" line>
+[r, if(isPC()): "Hello I am a PC"]
+</syntaxhighlight>
-===Usage===
+|also=
-<source lang="mtmacro" line>
+[[setPC|setPC()]],
-[h: pc = isPC()]
+[[isNPC|isNPC()]],
-</source>
+[[setNPC|setNPC()]]
+|changes=
+{{change|1.3b51|Added {{code|id}} parameter option.}}
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
-===Examples===
+}}
-<source lang="mtmacro" line>
+[[Category:Token Function]]
-[r, if(isPC()): "Hello I am a PC"]
-</source>