isPC: Difference between revisions

Latest revision as of 05:24, 8 March 2023

• Introduced in version 1.3b48

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

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.

[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(id)
+isPC(id, mapname)
+</syntaxhighlight>
+'''Parameter'''
+{{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.}}
-===Usage===
+|example=
-<source lang="mtmacro" line>
+<syntaxhighlight lang="mtmacro" line>
-[h: pc = isPC()]
+[r, if(isPC()): "Hello I am a PC"]
-</source>
+</syntaxhighlight>
+|also=
+[[setPC|setPC()]],
+[[isNPC|isNPC()]],
+[[setNPC|setNPC()]]
-===Examples===
+|changes=
-<source lang="mtmacro" line>
+{{change|1.3b51|Added {{code|id}} parameter option.}}
-[r, if(isPC()): "Hello I am a PC"]
+{{change|1.5.4|Added {{code|mapname}} parameter option.}}
-</source>
+}}
+[[Category:Token Function]]