getTokenMBL: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page GetTokenMBL to getTokenMBL: Converting page titles to lowercase) |
m (Added description; fleshed out the rest of the page) |
||
| Line 2: | Line 2: | ||
{{MacroFunction | {{MacroFunction | ||
|name=getTokenMBL | |name=getTokenMBL | ||
|proposed=false | |||
|trusted=true | |||
|version=1.12 | |version=1.12 | ||
|description= | |description=Gets the Movement Blocking Layer (MBL) shapes for the token specified. | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
getTokenMBL(id) | getTokenMBL(id) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
This function retrieves the MBL found on the given token. The format of the data returned is the same as documented in {{func|getMBL}}. | |||
'''Parameters''' | '''Parameters''' | ||
{{param|id|}} | {{param|id|OPTIONAL: Specifies the token to retrieve MBL from. Defaults to [[Current Token]].}} | ||
|examples= | |||
<syntaxhighlight lang="mtmacro"> | |||
[r:mblData = getTokenMBL()] | |||
</syntaxhighlight> | |||
|also= | |||
[[AI Pathfinding]], {{func|getMBL}}, {{func|setTokenMBL}} | |||
}} | }} | ||
[[Category:Token Function]] | |||
[[Category:MBL Function]] | [[Category:MBL Function]] | ||
Latest revision as of 05:00, 5 June 2023
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(id)This function retrieves the MBL found on the given token. The format of the data returned is the same as documented in getMBL().
Parameters
id- OPTIONAL: Specifies the token to retrieve MBL from. Defaults to Current Token.
Examples
[r:mblData = getTokenMBL()]