setTokenMBL: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page setTokenMBL to SetTokenMBL without leaving a redirect: Converting page title to first-letter uppercase) |
m (Added missing description of the shapeArray parameter) |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
{{MacroFunction | {{MacroFunction | ||
|name=setTokenMBL | |name=setTokenMBL | ||
|proposed=false | |||
|trusted=true | |||
|version=1.12 | |version=1.12 | ||
|description= | |description=Stores a shape that acts as MBL onto a token for use by the AI pathing algorithm. | ||
|usage= | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | <syntaxhighlight lang="mtmacro" line> | ||
setTokenMBL( | setTokenMBL(shapeArray, id) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param| | {{param|shapeArray|A [[JSON Array]] of [[JSON Object|JSON objects]], one of the latter for each MBL shape.}} | ||
{{param|id|}} | {{param|id|OPTIONAL: The token to add the BML to. Defaults to [[Current Token]].}} | ||
For a description of the parameters, see {{func|drawMBL}}. | |||
|also= | |||
[[AI Pathfinding]], {{func|drawMBL}}, {{func|eraseMBL}}, {{func|getMBL}} | |||
}} | }} | ||
[[Category:Token Function]] | |||
[[Category:MBL Function]] | [[Category:MBL Function]] | ||
Latest revision as of 23:59, 5 June 2023
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
setTokenMBL() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.12
Stores a shape that acts as MBL onto a token for use by the AI pathing algorithm.
Usage
setTokenMBL(shapeArray, id)Parameters
shapeArray- A JSON Array of JSON objects, one of the latter for each MBL shape.id- OPTIONAL: The token to add the BML to. Defaults to Current Token.
For a description of the parameters, see drawMBL().