Class FogModifier

No Self In File

Hierarchy

Handle<fogmodifier>
- FogModifier

Index

Constructors

Properties

Accessors

Methods

destroy start stop fromHandle fromRect getObject initFromHandle

Constructors

constructor

new FogModifier(forWhichPlayer: MapPlayer, whichState: fogstate, centerX: number, centerY: number, radius: number, useSharedVision: boolean, afterUnits: boolean): FogModifier
Parameters
- forWhichPlayer: MapPlayer
- whichState: fogstate
- centerX: number
- centerY: number
- radius: number
- useSharedVision: boolean
- afterUnits: boolean
Returns FogModifier
Overrides Handle.constructor
- Defined in w3ts/handles/fogmodifier.ts:9

Properties

`Readonly` handle

handle: fogmodifier

Accessors

id

get id(): number
Returns number
Inherited from Handle.id
- Defined in w3ts/handles/handle.ts:15

Methods

destroy

destroy(): void
Returns void
- Defined in w3ts/handles/fogmodifier.ts:17

start

start(): void
Returns void
- Defined in w3ts/handles/fogmodifier.ts:21

stop

stop(): void
Returns void
- Defined in w3ts/handles/fogmodifier.ts:25

`Static` fromHandle

fromHandle(handle: fogmodifier): FogModifier
Parameters
- handle: fogmodifier
Returns FogModifier
- Defined in w3ts/handles/fogmodifier.ts:29

`Static` fromRect

fromRect(forWhichPlayer: MapPlayer, whichState: fogstate, where: Rectangle, useSharedVision: boolean, afterUnits: boolean): FogModifier
Parameters
- forWhichPlayer: MapPlayer
- whichState: fogstate
- where: Rectangle
- useSharedVision: boolean
- afterUnits: boolean
Returns FogModifier
- Defined in w3ts/handles/fogmodifier.ts:33

`Static` `Protected` getObject

getObject(handle: handle): any
Parameters
- handle: handle
Returns any
Inherited from Handle.getObject
- Defined in w3ts/handles/handle.ts:23

`Static` initFromHandle

initFromHandle(): boolean
Returns boolean
Inherited from Handle.initFromHandle
- Defined in w3ts/handles/handle.ts:19