Triggers/Category Region

From SC2Mapster Wiki
Jump to: navigation, search

Creation

Add Circle To Region

  • Action. Adds a circle to a region.

Add Rectangle To Region

  • Action. Adds a rectangle to a region.

Add Region To Region

  • Action. Adds a region to another region.

Convert Circle To Region

  • Function. Returns a circular region from a center point and a radius.

Convert Rectangle To Region

  • Function. Returns a rectangular region from 4 bound values.

Modification

Height Of Region

  • Function. Returns the height of the specified region.

Attach Region To Unit

  • Action. Attaches a region to a unit.

Unit Attached To Region

  • Function. Returns a unit attached to a region.

Top-Right Of Region Bounds

  • Function. Returns the maximum bounds of a region. For a rectangle region, this is the top-right corner of the rectangle. In the general case, this is a point comprising the right-most X coordinate and the top-most Y coordinate of the region.

Bottom-Left Of Region Bounds

  • Function. Returns the minimum bounds of a region. For a rectangle region, this is the bottom-left corner of the rectangle. In the general case, this is a point comprising the left-most X coordinate and the bottom-most Y coordinate of the region.

Center Of Region

  • Function. Returns the center point of a region.

Random Point In Region

  • Function. Returns a random point in the specified region. For regions with multiple shapes, this is not guaranteed to work.

Move Region

  • Action. Moves a region to a point.

Width Of Region

  • Function. Returns the width of the specified region.

Useful Regions

Empty Region

  • Function. Returns an empty region.

Entire Map

  • Function. Returns the entire map.

Playable Map Area

  • Function. Returns the playable map area.

Set Playable Map Area

  • Action. Sets the playable map area, which is the area within which units are generally confined. The edges of the specified region will be rounded to the nearest even-numbered cell edge. Camera bounds will be automatically adjusted to accomodate the new playable map area. Use the "Set Camera Bounds" action to change the camera bounds.