isNPC: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
m (Updated with recent version changes.)
Line 1: Line 1:
{{stub|Examples using the new functionality.}}
{{MacroFunction
{{MacroFunction
|name=isNPC
|name=isNPC
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns 1 if the [[Token:Current Token|Current Token]] is a NPC or 0 if it is not.
Returns {{true}} if a [[Token]] is a NPC or {{false}} if it is not.


|usage=
|usage=
Line 9: Line 10:
isNPC()
isNPC()
</source>
</source>
<source lang="mtmacro" line>
isNPC(id)
</source>
'''Parameter'''
{{param|id|The token {{code|id}} of the token which has its NPC status checked, defaults to the [[Current Token]]. {{TrustedParameter}} }}


|example=
|example=
Line 14: Line 20:
[r, if(isNPC()): "Hello I am an NPC"]
[r, if(isNPC()): "Hello I am an NPC"]
</source>
</source>
|also=
[[isPC|isPC()]],
[[setPC|setPC()]],
[[setNPC|setNPC()]]
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 02:45, 31 March 2009

 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)

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

Example

[r, if(isNPC()): "Hello I am an NPC"]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.