SelectedArea | Tiled Scripting API

An interface through which the currently selected area can be modified.

Can be accessed through TileMap.selectedArea.

Instead of directly modifying the selected area, it could be preferable to get the region of this area, modify that region, and then assign it back. The necessary methods have been added to the region type with Tiled 1.8.

Hierarchy

SelectedArea

Index

Properties

boundingRect

Methods

Properties

Readonly boundingRect

boundingRect: rect

Bounding rectangle of the selected area.

Methods

add

add(rect: rect): void
add(region: region): void

Adds the given rectangle to the selected area.
Adds the given region to the selected area.

get

get(): region

Returns the selected region.

intersect

intersect(rect: rect): void
intersect(region: region): void

Sets the selected area to the intersection of the current selected area and the given rectangle.
Sets the selected area to the intersection of the current selected area and the given region.

set

set(rect: rect): void
set(region: region): void

Sets the selected area to the given rectangle.
Sets the selected area to the given region.

subtract

subtract(rect: rect): void
subtract(region: region): void

Subtracts the given rectangle from the selected area.
Subtracts the given region from the selected area.