Class: Region#

Hierarchy#

Handle<region>
↳ Region

Constructors#

constructor#

new Region(): Region

Returns: Region

_{Defined in: handles/region.ts:8}

Properties#

handle#

• Readonly handle: region

_{Inherited from: Handle.handle
Defined in: handles/handle.ts:6}

Accessors#

id#

id(): number

Get the unique ID of the handle. The ID is recycled once you destroy the object.

Returns: number

The unique ID of a handle object.

_{Defined in: handles/handle.ts:18}

Methods#

addCell#

addCell(x: number, y: number): void

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: void

_{Defined in: handles/region.ts:18}

addCellPoint#

addCellPoint(whichPoint: Point): void

Parameters:#

Name	Type
`whichPoint`	Point

Returns: void

_{Defined in: handles/region.ts:22}

addRect#

addRect(r: Rectangle): void

Parameters:#

Name	Type
`r`	Rectangle

Returns: void

_{Defined in: handles/region.ts:26}

clearCell#

clearCell(x: number, y: number): void

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: void

_{Defined in: handles/region.ts:30}

clearCellPoint#

clearCellPoint(whichPoint: Point): void

Parameters:#

Name	Type
`whichPoint`	Point

Returns: void

_{Defined in: handles/region.ts:34}

clearRect#

clearRect(r: Rectangle): void

Parameters:#

Name	Type
`r`	Rectangle

Returns: void

_{Defined in: handles/region.ts:38}

containsCoords#

containsCoords(x: number, y: number): boolean

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: boolean

_{Defined in: handles/region.ts:42}

containsPoint#

containsPoint(whichPoint: Point): void

Parameters:#

Name	Type
`whichPoint`	Point

Returns: void

_{Defined in: handles/region.ts:46}

containsUnit#

containsUnit(whichUnit: Unit): boolean

Parameters:#

Name	Type
`whichUnit`	Unit

Returns: boolean

_{Defined in: handles/region.ts:50}

destroy#

destroy(): void

Returns: void

_{Defined in: handles/region.ts:54}

fromHandle#

static fromHandle(handle: region): Region

Parameters:#

Name	Type
`handle`	region

Returns: Region

_{Defined in: handles/region.ts:58}