isNPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(New page: ==Function isNPC== Returns 1 if the token is a NPC or 0 if it not. ===Usage=== <source lang="mtmacro" line> [h: npc = isNPC()] </source> ===Examples=== <source lang="mtmacro" line> [r,...)
 
No edit summary
 
(10 intermediate revisions by 4 users not shown)
Line 1: Line 1:
==Function isNPC==
{{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.


Returns 1 if the token is a NPC or 0 if it not.
|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.}}


===Usage===
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: npc = isNPC()]
[r, if(isNPC()): "Hello I am an NPC"]
</source>
</syntaxhighlight>


|also=
[[isPC|isPC()]],
[[setPC|setPC()]],
[[setNPC|setNPC()]]


===Examples===
|changes=
<source lang="mtmacro" line>
{{change|1.3b51|Added {{code|id}} parameter option.}}
[r, if(isNPC()): "Hello I am an NPC"]
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
</source>
}}
[[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
Returns true(1) if a Token is a NPC or false(0) if it is not.

Usage

isNPC()
isNPC(id)
isNPC(id, mapname)

Parameter

  • id - The token id 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. 

  • 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

isPC(),

setPC(),

setNPC()

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=isNPC&oldid=16404"