Class Force

No Self In File

Hierarchy

Handle<force>
- Force

Index

Constructors

Properties

Accessors

Methods

addPlayer clear destroy enumAllies enumEnemies enumPlayers enumPlayersCounted for getPlayers hasPlayer removePlayer fromHandle getObject initFromHandle

Constructors

constructor

new Force(): Force
Returns Force
Overrides Handle.constructor
- Defined in w3ts/handles/force.ts:8

Properties

`Readonly` handle

handle: force

Accessors

id

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

Methods

addPlayer

addPlayer(whichPlayer: MapPlayer): void
Parameters
- whichPlayer: MapPlayer
Returns void
- Defined in w3ts/handles/force.ts:16

clear

clear(): void
Returns void
- Defined in w3ts/handles/force.ts:20

destroy

destroy(): void
Returns void
- Defined in w3ts/handles/force.ts:24

enumAllies

enumAllies(whichPlayer: MapPlayer, filter: boolexpr): void
Parameters
- whichPlayer: MapPlayer
- filter: boolexpr
Returns void
- Defined in w3ts/handles/force.ts:28

enumEnemies

enumEnemies(whichPlayer: MapPlayer, filter: boolexpr): void
Parameters
- whichPlayer: MapPlayer
- filter: boolexpr
Returns void
- Defined in w3ts/handles/force.ts:32

enumPlayers

enumPlayers(filter: boolexpr): void
Parameters
- filter: boolexpr
Returns void
- Defined in w3ts/handles/force.ts:36

enumPlayersCounted

enumPlayersCounted(filter: boolexpr, countLimit: number): void
Parameters
- filter: boolexpr
- countLimit: number
Returns void
- Defined in w3ts/handles/force.ts:40

for

for(callback: (() => void)): void
Parameters
- callback: (() => void)
  - - (): void
    - Returns void
Returns void
- Defined in w3ts/handles/force.ts:44

getPlayers

getPlayers(): MapPlayer[]
Returns all player handles belonging to this force

Returns MapPlayer[]
- Defined in w3ts/handles/force.ts:51

hasPlayer

hasPlayer(whichPlayer: MapPlayer): boolean
Parameters
- whichPlayer: MapPlayer
Returns boolean
- Defined in w3ts/handles/force.ts:59

removePlayer

removePlayer(whichPlayer: MapPlayer): void
Parameters
- whichPlayer: MapPlayer
Returns void
- Defined in w3ts/handles/force.ts:63

`Static` fromHandle

fromHandle(handle: force): Force
Parameters
- handle: force
Returns Force
- Defined in w3ts/handles/force.ts:67

`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