Class: FogModifier

Hierarchy

• Handle<fogmodifier>

  ↳ FogModifier

Constructors

constructor

new FogModifier(forWhichPlayer: MapPlayer, whichState: fogstate, centerX: number, centerY: number, radius: number, useSharedVision: boolean, afterUnits: boolean): FogModifier

Parameters:

Name	Type	Description
forWhichPlayer	MapPlayer
whichState	fogstate	Determines what type of fog the area is being modified to.
centerX	number	The x-coordinate where the fog modifier begins.
centerY	number	The y-coordinate where the fog modifier begins.
radius	number	Determines the extent that the fog travels (expanding from the coordinates ( centerx , centery )).
useSharedVision	boolean	Determines whether or not the fog modifier will be applied to allied players with shared vision.
afterUnits	boolean	Will determine whether or not units in that area will be masked by the fog. If it is set to true and the fogstate is masked, it will hide all the units in the fog modifier's radius and mask the area. If set to false, it will only mask the areas that are not visible to the units.

Returns: FogModifier

Defined in: handles/fogmodifier.ts:7

Properties

handle

• Readonly handle: fogmodifier

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/fogmodifier.ts:28

---

start

start(): void

Returns: void

Defined in: handles/fogmodifier.ts:32

---

stop

stop(): void

Returns: void

Defined in: handles/fogmodifier.ts:36

---

fromHandle

static fromHandle(handle: fogmodifier): FogModifier

Parameters:

Name	Type
handle	fogmodifier

Returns: FogModifier

Defined in: handles/fogmodifier.ts:40

---

fromRect

static fromRect(forWhichPlayer: MapPlayer, whichState: fogstate, where: Rectangle, useSharedVision: boolean, afterUnits: boolean): FogModifier

Parameters:

Name	Type
forWhichPlayer	MapPlayer
whichState	fogstate
where	Rectangle
useSharedVision	boolean
afterUnits	boolean

Returns: FogModifier

Defined in: handles/fogmodifier.ts:44