Class: Point#

Hierarchy#

Handle<location>
↳ Point

Constructors#

constructor#

new Point(x: number, y: number): Point

Creates a new location handle. Generally, raw coordinates should be used instead.

Parameters:#

Name	Type	Description
`x`	number
`y`	number

Returns: Point

_{Defined in: handles/point.ts:5}

Properties#

handle#

• Readonly handle: location

_{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}

x#

x(): number

Returns: number

_{Defined in: handles/point.ts:19}

x(value: number): void

Parameters:#

Name	Type
`value`	number

Returns: void

_{Defined in: handles/point.ts:23}

y#

y(): number

Returns: number

_{Defined in: handles/point.ts:27}

y(value: number): void

Parameters:#

Name	Type
`value`	number

Returns: void

_{Defined in: handles/point.ts:31}

z#

z(): number

This function is asynchronous. The values it returns are not guaranteed synchronous between each player. If you attempt to use it in a synchronous manner, it may cause a desync.

note Reasons for returning different values might be terrain-deformations caused by spells/abilities and different graphic settings. Other reasons could be the rendering state of destructables and visibility differences.

async

Returns: number

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

Methods#

destroy#

destroy(): void

Returns: void

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

setPosition#

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

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: void

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

fromHandle#

static fromHandle(handle: location): Point

Parameters:#

Name	Type
`handle`	location

Returns: Point

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