Class: MapPlayer#

Hierarchy#

Handle<player>
↳ MapPlayer

Properties#

handle#

• Readonly handle: player

_{Inherited from: Handle.handle
Defined in: handles/handle.ts:6}

Accessors#

color#

color(): playercolor

Returns: playercolor

_{Defined in: handles/player.ts:20}

color(color: playercolor): void

Parameters:#

Name	Type
`color`	playercolor

Returns: void

_{Defined in: handles/player.ts:16}

controller#

controller(): mapcontrol

Returns: mapcontrol

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

handicap#

handicap(): number

Returns: number

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

handicap(handicap: number): void

Parameters:#

Name	Type
`handicap`	number

Returns: void

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

handicapXp#

handicapXp(): number

Returns: number

_{Defined in: handles/player.ts:36}

handicapXp(handicap: number): void

Parameters:#

Name	Type
`handicap`	number

Returns: void

_{Defined in: handles/player.ts:40}

id#

id(): number

Returns: number

_{Defined in: handles/player.ts:44}

name#

name(): string

Returns: string

_{Defined in: handles/player.ts:48}

name(value: string): void

Parameters:#

Name	Type
`value`	string

Returns: void

_{Defined in: handles/player.ts:52}

race#

race(): race

Returns: race

_{Defined in: handles/player.ts:56}

slotState#

slotState(): playerslotstate

Returns: playerslotstate

_{Defined in: handles/player.ts:60}

startLocation#

startLocation(): number

Returns: number

_{Defined in: handles/player.ts:64}

startLocationPoint#

startLocationPoint(): location

Returns: location

_{Defined in: handles/player.ts:76}

startLocationX#

startLocationX(): number

Returns: number

_{Defined in: handles/player.ts:68}

startLocationY#

startLocationY(): number

Returns: number

_{Defined in: handles/player.ts:72}

team#

team(): number

Returns: number

_{Defined in: handles/player.ts:80}

townHallCount#

townHallCount(): number

Returns: number

_{Defined in: handles/player.ts:84}

Methods#

addTechResearched#

addTechResearched(techId: number, levels: number): void

In upgrades that have multiple levels, it will research the upgrade by the number of levels specified.

Parameters:#

Name	Type	Description
`techId`	number	The four digit rawcode ID of the upgrade.
`levels`	number	The number of levels to add to the current research level of the upgrade.

Returns: void

_{Defined in: handles/player.ts:93}

cacheHeroData#

cacheHeroData(): void

Used to store hero level data for the scorescreen, before units are moved to neutral passive in melee games.

Returns: void

_{Defined in: handles/player.ts:104}

compareAlliance#

compareAlliance(otherPlayer: MapPlayer, whichAllianceSetting: alliancetype): boolean

Parameters:#

Name	Type
`otherPlayer`	MapPlayer
`whichAllianceSetting`	alliancetype

Returns: boolean

_{Defined in: handles/player.ts:108}

coordsFogged#

coordsFogged(x: number, y: number): boolean

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: boolean

_{Defined in: handles/player.ts:112}

coordsMasked#

coordsMasked(x: number, y: number): boolean

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: boolean

_{Defined in: handles/player.ts:116}

coordsVisible#

coordsVisible(x: number, y: number): boolean

Parameters:#

Name	Type
`x`	number
`y`	number

Returns: boolean

_{Defined in: handles/player.ts:120}

cripple#

cripple(toWhichPlayers: Force, flag: boolean): void

Reveals a player's remaining buildings to a force. The black mask over the buildings will be removed as if the territory had been discovered

note his function will not check whether the player has a town hall before revealing.

Parameters:#

Name	Type	Description
`toWhichPlayers`	Force	The players who will see whichPlayer's buildings.
`flag`	boolean	If true, the buildings will be revealed. If false, the buildings will not be revealed. Note that if you set it to false, it will not hide the buildings with a black mask.

Returns: void

_{Defined in: handles/player.ts:132}

decTechResearched#

decTechResearched(techId: number, levels: number): void

Parameters:#

Name	Type
`techId`	number
`levels`	number

Returns: void

_{Defined in: handles/player.ts:97}

getScore#

getScore(whichPlayerScore: playerscore): number

Parameters:#

Name	Type
`whichPlayerScore`	playerscore

Returns: number

_{Defined in: handles/player.ts:136}

getState#

getState(whichPlayerState: playerstate): number

Parameters:#

Name	Type
`whichPlayerState`	playerstate

Returns: number

_{Defined in: handles/player.ts:140}

getStructureCount#

getStructureCount(includeIncomplete: boolean): number

Parameters:#

Name	Type
`includeIncomplete`	boolean

Returns: number

_{Defined in: handles/player.ts:144}

getTaxRate#

getTaxRate(otherPlayer: player, whichResource: playerstate): number

Parameters:#

Name	Type
`otherPlayer`	player
`whichResource`	playerstate

Returns: number

_{Defined in: handles/player.ts:148}

getTechCount#

getTechCount(techId: number, specificonly: boolean): number

Parameters:#

Name	Type
`techId`	number
`specificonly`	boolean

Returns: number

_{Defined in: handles/player.ts:152}

getTechMaxAllowed#

getTechMaxAllowed(techId: number): number

Parameters:#

Name	Type
`techId`	number

Returns: number

_{Defined in: handles/player.ts:156}

getTechResearched#

getTechResearched(techId: number, specificonly: boolean): boolean

Parameters:#

Name	Type
`techId`	number
`specificonly`	boolean

Returns: boolean

_{Defined in: handles/player.ts:160}

getUnitCount#

getUnitCount(includeIncomplete: boolean): number

Parameters:#

Name	Type
`includeIncomplete`	boolean

Returns: number

_{Defined in: handles/player.ts:164}

getUnitCountByType#

getUnitCountByType(unitName: string, includeIncomplete: boolean, includeUpgrades: boolean): number

Parameters:#

Name	Type
`unitName`	string
`includeIncomplete`	boolean
`includeUpgrades`	boolean

Returns: number

_{Defined in: handles/player.ts:168}

inForce#

inForce(whichForce: Force): boolean

Parameters:#

Name	Type
`whichForce`	Force

Returns: boolean

_{Defined in: handles/player.ts:172}

isLocal#

isLocal(): boolean

Returns: boolean

_{Defined in: handles/player.ts:176}

isObserver#

isObserver(): boolean

Returns: boolean

_{Defined in: handles/player.ts:180}

isPlayerAlly#

isPlayerAlly(otherPlayer: MapPlayer): boolean

Parameters:#

Name	Type
`otherPlayer`	MapPlayer

Returns: boolean

_{Defined in: handles/player.ts:184}

isPlayerEnemy#

isPlayerEnemy(otherPlayer: MapPlayer): boolean

Parameters:#

Name	Type
`otherPlayer`	MapPlayer

Returns: boolean

_{Defined in: handles/player.ts:188}

isRacePrefSet#

isRacePrefSet(pref: racepreference): boolean

Parameters:#

Name	Type
`pref`	racepreference

Returns: boolean

_{Defined in: handles/player.ts:192}

isSelectable#

isSelectable(): boolean

Returns: boolean

_{Defined in: handles/player.ts:196}

pointFogged#

pointFogged(whichPoint: Point): boolean

Parameters:#

Name	Type
`whichPoint`	Point

Returns: boolean

_{Defined in: handles/player.ts:200}

pointMasked#

pointMasked(whichPoint: Point): boolean

Parameters:#

Name	Type
`whichPoint`	Point

Returns: boolean

_{Defined in: handles/player.ts:204}

pointVisible#

pointVisible(whichPoint: Point): boolean

Parameters:#

Name	Type
`whichPoint`	Point

Returns: boolean

_{Defined in: handles/player.ts:208}

remove#

remove(gameResult: playergameresult): void

Parameters:#

Name	Type
`gameResult`	playergameresult

Returns: void

_{Defined in: handles/player.ts:212}

removeAllGuardPositions#

removeAllGuardPositions(): void

Returns: void

_{Defined in: handles/player.ts:216}

setAbilityAvailable#

setAbilityAvailable(abilId: number, avail: boolean): void

Parameters:#

Name	Type
`abilId`	number
`avail`	boolean

Returns: void

_{Defined in: handles/player.ts:220}

setAlliance#

setAlliance(otherPlayer: MapPlayer, whichAllianceSetting: alliancetype, value: boolean): void

Parameters:#

Name	Type
`otherPlayer`	MapPlayer
`whichAllianceSetting`	alliancetype
`value`	boolean

Returns: void

_{Defined in: handles/player.ts:224}

setOnScoreScreen#

setOnScoreScreen(flag: boolean): void

Parameters:#

Name	Type
`flag`	boolean

Returns: void

_{Defined in: handles/player.ts:228}

setState#

setState(whichPlayerState: playerstate, value: number): void

Parameters:#

Name	Type
`whichPlayerState`	playerstate
`value`	number

Returns: void

_{Defined in: handles/player.ts:232}

setTaxRate#

setTaxRate(otherPlayer: MapPlayer, whichResource: playerstate, rate: number): void

Parameters:#

Name	Type
`otherPlayer`	MapPlayer
`whichResource`	playerstate
`rate`	number

Returns: void

_{Defined in: handles/player.ts:236}

setTechMaxAllowed#

setTechMaxAllowed(techId: number, maximum: number): void

Parameters:#

Name	Type
`techId`	number
`maximum`	number

Returns: void

_{Defined in: handles/player.ts:240}

setTechResearched#

setTechResearched(techId: number, setToLevel: number): void

Parameters:#

Name	Type
`techId`	number
`setToLevel`	number

Returns: void

_{Defined in: handles/player.ts:244}

setUnitsOwner#

setUnitsOwner(newOwner: number): void

Parameters:#

Name	Type
`newOwner`	number

Returns: void

_{Defined in: handles/player.ts:248}

fromEnum#

static fromEnum(): MapPlayer

Returns: MapPlayer

_{Defined in: handles/player.ts:252}

fromEvent#

static fromEvent(): MapPlayer

Returns: MapPlayer

_{Defined in: handles/player.ts:256}

fromFilter#

static fromFilter(): MapPlayer

Returns: MapPlayer

_{Defined in: handles/player.ts:260}

fromHandle#

static fromHandle(handle: player): MapPlayer

Parameters:#

Name	Type
`handle`	player

Returns: MapPlayer

_{Defined in: handles/player.ts:264}

fromIndex#

static fromIndex(index: number): MapPlayer

Parameters:#

Name	Type
`index`	number

Returns: MapPlayer

_{Defined in: handles/player.ts:268}

fromLocal#

static fromLocal(): MapPlayer

async

Returns: MapPlayer

_{Defined in: handles/player.ts:275}