Class: WeatherEffect#

Hierarchy#

Handle<weathereffect>
↳ WeatherEffect

Constructors#

constructor#

new WeatherEffect(where: Rectangle, effectID: number): WeatherEffect

Adds a weather effect.

note To understand more about weather effects nature, I advise to read Ammorth's article about weather effects: http://www.wc3c.net/showthread.php?t=91176.

note To get an idea on how to add your own weather effects, you may read CryoniC's article about custom weather effects: http://www.wc3c.net/showthread.php?t=67949.

Parameters:#

Name	Type	Description
`where`	Rectangle	The rect to apply the WeatherEffect to.
`effectID`	number	Which effect to apply.

Returns: WeatherEffect

_{Defined in: handles/weathereffect.ts:6}

Properties#

handle#

• Readonly handle: weathereffect

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

destroy#

destroy(): void

Returns: void

_{Defined in: handles/weathereffect.ts:24}

enable#

enable(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

_{Defined in: handles/weathereffect.ts:28}

fromHandle#

static fromHandle(handle: weathereffect): WeatherEffect

Parameters:#

Name	Type
`handle`	weathereffect

Returns: WeatherEffect

_{Defined in: handles/weathereffect.ts:32}