setPC: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function setPC== {{TrustedOnlyFunction}} Sets if the Token:Current Token is a Token:PC Token or not. If the value is 0 then the Token:Current Token is set to a [[Token:NPC...) |
No edit summary |
||
(11 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{ | {{MacroFunction | ||
|name=setPC | |||
|trusted=true | |||
|version=1.3b48 | |||
|description= | |||
Sets a [[Token]] to a [[Introduction_to_Tokens#Token_Type|PC Token]]. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
setPC() | |||
setPC(id) | |||
setPC(id, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{param|id|The token {{code|id}} of the token which has its PC status set, defaults to the [[Current Token]].}} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
= | |also= | ||
[[isPC|isPC()]], | |||
[ | [[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 23:59, 14 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 of usage.
setPC() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Usage
setPC()
setPC(id)
setPC(id, mapRef)
Parameter
id
- The tokenid
of the token which has its PC status set, defaults to the Current Token.mapRef
- The Name or ID of the map to find the token. Defaults to the current map.
See Also
Version Changes
- 1.3b51 - Added
id
parameter option. - 1.5.4 - Added
mapname
parameter option.