getMBL

From RPTools Wiki
Jump to navigationJump to search

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

getMBL() Function

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

Introduced in version 1.9.0
Gets the Movement Blocking Layer (MBL) shapes for the area specified in the shape parameter.

Usage

getMBL(shape)
getMBL(shape,format)

This function retrieves the MBL found in the given shape(s).

Parameters

  • shape - A JSON object or array of JSON objects, as described in drawMBL(). If an array, gets all the MBL within all provided shapes, otherwise just the MBL in the single provided shape.
  • format - OPTIONAL Boolean. Returns a JSON object if false(0), or a JSON array of coordinates if true(1). In either case, the returned shape covers the MBL found in the area. Defaults to false(0)

Examples

[h:rectangle = '{"shape":"rectangle","x":50,"y":50,"w":100,"h":200,"r":45,"fill":1,"thickness":1,"scale":0}']
[r:mblData   = getMBL(rectangle , 0)]

See Also