isNPC: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) (Applied Template:MacroFunction) |
No edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples using the new functionality.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=isNPC | |name=isNPC | ||
|version=1.3b48 | |||
|description= | |description= | ||
Returns | Returns {{true}} if a [[Token]] is a NPC or {{false}} if it is not. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
isNPC() | |||
</ | isNPC(id) | ||
isNPC(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token which has its NPC 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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r, if(isNPC()): "Hello I am an NPC"] | [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]] | [[Category:Token Function]] | ||
Latest revision as of 20:14, 15 March 2023
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(id)
isNPC(id, mapname)Parameter
id- The tokenidof the token which has its NPC 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(isNPC()): "Hello I am an NPC"]See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.