isPC: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(8 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
= | {{MacroFunction | ||
|name=isPC | |||
|version=1.3b48 | |||
|description= | |||
Returns {{true}} if a [[Token]] is a PC or {{false}} if it is 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.}} | |||
|example= | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
[ | [r, if(isPC()): "Hello I am a PC"] | ||
</ | </syntaxhighlight> | ||
|also= | |||
[[setPC|setPC()]], | |||
[[isNPC|isNPC()]], | |||
[[setNPC|setNPC()]] | |||
= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
[ | {{change|1.5.4|Added {{code|mapname}} parameter option.}} | ||
}} | |||
[[Category:Token Function]] |
Latest revision as of 05:24, 8 March 2023
isPC() Function
• Introduced in version 1.3b48
Usage
isPC()
isPC(id)
isPC(id, mapname)
Parameter
id
- The tokenid
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.