getTokenMBL: Difference between revisions
Jump to navigation
Jump to search
m (Added description; fleshed out the rest of the page) |
No edit summary |
||
| (One intermediate revision by the same user not shown) | |||
| Line 8: | Line 8: | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
getTokenMBL( | getTokenMBL(tokenRef) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
| Line 14: | Line 14: | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|tokenRef|OPTIONAL: Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token to retrieve MBL from. Defaults to [[Current Token]].}} | ||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|examples= | |examples= | ||
<syntaxhighlight lang="mtmacro"> | <syntaxhighlight lang="mtmacro"> | ||
Latest revision as of 23:59, 14 May 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
getTokenMBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.12
Gets the Movement Blocking Layer (MBL) shapes for the token specified.
Usage
getTokenMBL(tokenRef)This function retrieves the MBL found on the given token. The format of the data returned is the same as documented in getMBL().
Parameters
tokenRef- OPTIONAL: Either the tokenidor Token Name of the token to retrieve MBL from. Defaults to Current Token.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Examples
[r:mblData = getTokenMBL()]