getMBL

From RPTools Wiki
Revision as of 19:09, 2 May 2021 by Kwvanderlinde (talk | contribs) (Initial documentation for getMBL)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump 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,format)

This function retrieves the MBL found in the given shape.

Parameters

  • shape - A JSON object as described in drawMBL().
  • format - Boolean. Returns a JSON object if false(0), or an JSON array of coordinates if true(1). In either case, the returned shape covers the MBL found in the area.


Example:

[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