getGMNotes: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
No edit summary
 
(7 intermediate revisions by 4 users not shown)
Line 3: Line 3:
|trusted=true
|trusted=true
|version=1.3b48
|version=1.3b48
|description=Returns the [[Token:GM notes|GM notes]] from the [[Token:Current Token|Current Token]].
|description=Returns the [[Introduction to Tokens|GM notes]] from the [[Current Token]].


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getGMNotes()
getGMNotes()
</source>
getGMNotes(id)
getGMNotes(id, mapname)
</syntaxhighlight>
 
'''Parameter'''
{{param|id|The token {{code|id}} of the token to get the GM notes from. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
 
 
|changes=
{{change|1.5.4|Added {{code|id}} and {{code|mapname}} parameter options.}}
}}
 
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Latest revision as of 18:35, 20 April 2023

getGMNotes() Function

 Note: This function can only be used in a Trusted Macro

Introduced in version 1.3b48
Returns the GM notes from the Current Token.

Usage

getGMNotes()
getGMNotes(id)
getGMNotes(id, mapname)

Parameter

  • id - The token id of the token to get the GM notes from.

     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.


Version Changes

  • 1.5.4 - Added id and mapname parameter options.


}}