isNPC: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (10 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples using the new functionality.}} | ||
{{MacroFunction | |||
|name=isNPC | |||
|version=1.3b48 | |||
|description= | |||
Returns {{true}} if a [[Token]] is a NPC or {{false}} if it is not. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
isNPC() | |||
isNPC(tokenRef) | |||
isNPC(tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which has its NPC status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapRef|The Name or ID 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(isNPC()): "Hello I am an NPC"] | ||
</ | </syntaxhighlight> | ||
|also= | |||
[[isPC|isPC()]], | |||
[[setPC|setPC()]], | |||
[[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 23:59, 17 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples using the new functionality.
isNPC() Function
• Introduced in version 1.3b48
Usage
isNPC()
isNPC(tokenRef)
isNPC(tokenRef, mapRef)Parameter
tokenRef- Either the tokenidor Token Name of the token which has its NPC status checked, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapRef- The Name or ID 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.
Example
[r, if(isNPC()): "Hello I am an NPC"]See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.