getTokenMBL

 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 token id or 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()]

See Also

AI Pathfinding, getMBL(), setTokenMBL()