Class MapPlayer

No Self In File

Hierarchy

Handle<player>
- MapPlayer

Index

Properties

Accessors

color controller handicap handicapXp id name race slotState solarData startLocation startLocationPoint startLocationX startLocationY team

Properties

`Readonly` handle

handle: player

`Optional` userId

userId?: number

Accessors

color

get color(): playercolor
Returns playercolor
- Defined in w3ts/handles/player.ts:69
set color(color: playercolor): void
base
Parameters
- color: playercolor
Returns void
- Defined in w3ts/handles/player.ts:65

controller

get controller(): mapcontrol
Returns mapcontrol
- Defined in w3ts/handles/player.ts:73

handicap

get handicap(): number
Returns number
- Defined in w3ts/handles/player.ts:77
set handicap(handicap: number): void
Parameters
- handicap: number
Returns void
- Defined in w3ts/handles/player.ts:81

handicapXp

get handicapXp(): number
Returns number
- Defined in w3ts/handles/player.ts:85
set handicapXp(handicap: number): void
Parameters
- handicap: number
Returns void
- Defined in w3ts/handles/player.ts:89

id

get id(): number
Returns number
Overrides Handle.id
- Defined in w3ts/handles/player.ts:93

name

get name(): string
Returns string
- Defined in w3ts/handles/player.ts:97
set name(value: string): void
Parameters
- value: string
Returns void
- Defined in w3ts/handles/player.ts:101

race

get race(): race
Returns race
- Defined in w3ts/handles/player.ts:105

slotState

get slotState(): playerslotstate
Returns playerslotstate
- Defined in w3ts/handles/player.ts:109

solarData

get solarData(): AppPlayerData
Returns AppPlayerData
- Defined in w3ts/handles/player.ts:23
set solarData(obj: { [key: string]: any }): void
Parameters
- obj: { [key: string]: any }
  - [key: string]: any
Returns void
- Defined in w3ts/handles/player.ts:27

startLocation

get startLocation(): number
Returns number
- Defined in w3ts/handles/player.ts:113

startLocationPoint

get startLocationPoint(): location
Returns location
- Defined in w3ts/handles/player.ts:125

startLocationX

get startLocationX(): number
Returns number
- Defined in w3ts/handles/player.ts:117

startLocationY

get startLocationY(): number
Returns number
- Defined in w3ts/handles/player.ts:121

team

get team(): number
Returns number
- Defined in w3ts/handles/player.ts:129

Methods

addGoldState

addGoldState(value: number): void
Parameters
- value: number
Returns void
- Defined in w3ts/handles/player.ts:263

addLumberState

addLumberState(value: number): void
Parameters
- value: number
Returns void
- Defined in w3ts/handles/player.ts:267

addState

addState(whichPlayerState: playerstate, value: number): void
Parameters
- whichPlayerState: playerstate
- value: number
Returns void
- Defined in w3ts/handles/player.ts:287

addTechResearched

addTechResearched(techId: string | number, levels: number): void
Parameters
- techId: string | number
- levels: number
Returns void
- Defined in w3ts/handles/player.ts:137

cacheHeroData

cacheHeroData(): void
Returns void
- Defined in w3ts/handles/player.ts:147

compareAlliance

compareAlliance(otherPlayer: MapPlayer, whichAllianceSetting: alliancetype): boolean
Parameters
- otherPlayer: MapPlayer
- whichAllianceSetting: alliancetype
Returns boolean
- Defined in w3ts/handles/player.ts:151

coordsFogged

coordsFogged(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
- Defined in w3ts/handles/player.ts:155

coordsMasked

coordsMasked(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
- Defined in w3ts/handles/player.ts:159

coordsVisible

coordsVisible(x: number, y: number): boolean
Parameters
- x: number
- y: number
Returns boolean
- Defined in w3ts/handles/player.ts:163

cripple

cripple(toWhichPlayers: Force, flag: boolean): void
Parameters
- toWhichPlayers: Force
- flag: boolean
Returns void
- Defined in w3ts/handles/player.ts:167

displayText

displayText(text: string, duration?: number): void
addons
Parameters
- text: string
- duration: number = 5
Returns void
- Defined in w3ts/handles/player.ts:47

getAllUnits

getAllUnits(): group
Returns group
- Defined in w3ts/handles/player.ts:38

getGold

getGold(): number
Returns number
- Defined in w3ts/handles/player.ts:279

getLumber

getLumber(): number
Returns number
- Defined in w3ts/handles/player.ts:283

getScore

getScore(whichPlayerScore: playerscore): number
Parameters
- whichPlayerScore: playerscore
Returns number
- Defined in w3ts/handles/player.ts:171

getSelectedUnit

getSelectedUnit(): unit
同步获取当前玩家选择的第一个单位

Returns unit
- Defined in w3ts/handles/player.ts:54

getState

getState(whichPlayerState: playerstate): number
Parameters
- whichPlayerState: playerstate
Returns number
- Defined in w3ts/handles/player.ts:175

getStructureCount

getStructureCount(includeIncomplete: boolean): number
Parameters
- includeIncomplete: boolean
Returns number
- Defined in w3ts/handles/player.ts:179

getTaxRate

getTaxRate(otherPlayer: player, whichResource: playerstate): number
Parameters
- otherPlayer: player
- whichResource: playerstate
Returns number
- Defined in w3ts/handles/player.ts:183

getTechCount

getTechCount(techId: string | number, specificonly: boolean): number
Parameters
- techId: string | number
- specificonly: boolean
Returns number
- Defined in w3ts/handles/player.ts:187

getTechMaxAllowed

getTechMaxAllowed(techId: string | number): number
Parameters
- techId: string | number
Returns number
- Defined in w3ts/handles/player.ts:191

getTechResearched

getTechResearched(techId: string | number, specificonly: boolean): boolean
Parameters
- techId: string | number
- specificonly: boolean
Returns boolean
- Defined in w3ts/handles/player.ts:195

getUnitCount

getUnitCount(includeIncomplete: boolean): number
Parameters
- includeIncomplete: boolean
Returns number
- Defined in w3ts/handles/player.ts:199

getUnitCountByType

getUnitCountByType(unitName: string, includeIncomplete: boolean, includeUpgrades: boolean): number
Parameters
- unitName: string
- includeIncomplete: boolean
- includeUpgrades: boolean
Returns number
- Defined in w3ts/handles/player.ts:203

hasGold

hasGold(value: number): boolean
Parameters
- value: number
Returns boolean
- Defined in w3ts/handles/player.ts:271

hasLumber

hasLumber(value: number): boolean
Parameters
- value: number
Returns boolean
- Defined in w3ts/handles/player.ts:275

inForce

inForce(whichForce: Force): boolean
Parameters
- whichForce: Force
Returns boolean
- Defined in w3ts/handles/player.ts:207

isLocalPlayer

isLocalPlayer(): boolean
Returns boolean
- Defined in w3ts/handles/player.ts:31

isObserver

isObserver(): boolean
Returns boolean
- Defined in w3ts/handles/player.ts:211

isPlayerAlly

isPlayerAlly(otherPlayer: MapPlayer): boolean
Parameters
- otherPlayer: MapPlayer
Returns boolean
- Defined in w3ts/handles/player.ts:215

isPlayerEnemy

isPlayerEnemy(otherPlayer: MapPlayer): boolean
Parameters
- otherPlayer: MapPlayer
Returns boolean
- Defined in w3ts/handles/player.ts:219

isRacePrefSet

isRacePrefSet(pref: racepreference): boolean
Parameters
- pref: racepreference
Returns boolean
- Defined in w3ts/handles/player.ts:223

isSelectable

isSelectable(): boolean
Returns boolean
- Defined in w3ts/handles/player.ts:227

pointFogged

pointFogged(whichPoint: Point): boolean
Parameters
- whichPoint: Point
Returns boolean
- Defined in w3ts/handles/player.ts:231

pointMasked

pointMasked(whichPoint: Point): boolean
Parameters
- whichPoint: Point
Returns boolean
- Defined in w3ts/handles/player.ts:235

pointVisible

pointVisible(whichPoint: Point): boolean
Parameters
- whichPoint: Point
Returns boolean
- Defined in w3ts/handles/player.ts:239

remove

remove(gameResult: playergameresult): void
Parameters
- gameResult: playergameresult
Returns void
- Defined in w3ts/handles/player.ts:243

removeAllGuardPositions

removeAllGuardPositions(): void
Returns void
- Defined in w3ts/handles/player.ts:247

setAbilityAvailable

setAbilityAvailable(abilId: string | number, avail: boolean): void
Parameters
- abilId: string | number
- avail: boolean
Returns void
- Defined in w3ts/handles/player.ts:251

setAlliance

setAlliance(otherPlayer: MapPlayer, whichAllianceSetting: alliancetype, value: boolean): void
Parameters
- otherPlayer: MapPlayer
- whichAllianceSetting: alliancetype
- value: boolean
Returns void
- Defined in w3ts/handles/player.ts:255

setOnScoreScreen

setOnScoreScreen(flag: boolean): void
Parameters
- flag: boolean
Returns void
- Defined in w3ts/handles/player.ts:259

setState

setState(whichPlayerState: playerstate, value: number): void
Parameters
- whichPlayerState: playerstate
- value: number
Returns void
- Defined in w3ts/handles/player.ts:291

setTaxRate

setTaxRate(otherPlayer: MapPlayer, whichResource: playerstate, rate: number): void
Parameters
- otherPlayer: MapPlayer
- whichResource: playerstate
- rate: number
Returns void
- Defined in w3ts/handles/player.ts:295

setTechMaxAllowed

setTechMaxAllowed(techId: string | number, maximum: number): void
Parameters
- techId: string | number
- maximum: number
Returns void
- Defined in w3ts/handles/player.ts:299

setTechResearched

setTechResearched(techId: string | number, setToLevel: number): void
Parameters
- techId: string | number
- setToLevel: number
Returns void
- Defined in w3ts/handles/player.ts:303

setUnitsOwner

setUnitsOwner(newOwner: number): void
Parameters
- newOwner: number
Returns void
- Defined in w3ts/handles/player.ts:307

`Static` fromEnum

fromEnum(): MapPlayer
Returns MapPlayer
- Defined in w3ts/handles/player.ts:311

`Static` fromEvent

fromEvent(): MapPlayer
Returns MapPlayer
- Defined in w3ts/handles/player.ts:315

`Static` fromFilter

fromFilter(): MapPlayer
Returns MapPlayer
- Defined in w3ts/handles/player.ts:319

`Static` fromHandle

fromHandle(handle: player): MapPlayer
Parameters
- handle: player
Returns MapPlayer
- Defined in w3ts/handles/player.ts:323

`Static` fromIndex

fromIndex(index: number): MapPlayer
Parameters
- index: number
Returns MapPlayer
- Defined in w3ts/handles/player.ts:332

`Static` fromLocal

fromLocal(): MapPlayer
Returns MapPlayer
- Defined in w3ts/handles/player.ts:336

`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