Members

_sprites

commonLibs/_common/API_CORE/troopAPI.js, line 443

an array of the sprites of the enemies in this troop

localSwitches

commonLibs/_common/API_CORE/troopAPI.js, line 446

any local switches that exist

localVars

commonLibs/_common/API_CORE/troopAPI.js, line 449

any local vars that are set

spriteSet :Spriteset_Battle

commonLibs/_common/API_CORE/troopAPI.js, line 456

the current battle spriteset

Methods

addSpritesToCurrentBattleSet()

commonLibs/_common/API_CORE/troopAPI.js, line 482

add the sprites of this troop to the current battle sprite sheet

despawn() → {MATTIE.troopAPI.RuntimeTroop}

commonLibs/_common/API_CORE/troopAPI.js, line 531

remove the troop from the active battle if it is present

Returns:

MATTIE.troopAPI.RuntimeTroop -

returns itself so that you can chain commands

initialize(troopId,, xOffset,, yOffset,) → {MATTIE.troopAPI.RuntimeTroop}

commonLibs/_common/API_CORE/troopAPI.js, line 436

the initialize method for a runtime troop. This sets up all values we might need.

Parameters:

Name	Type	Description
troopId,	int	the id of the troop this class represents
xOffset,	int	screen x offset for entire troop
yOffset,	int	screen y offset for entire troop

Returns:

MATTIE.troopAPI.RuntimeTroop

removeSpritesFromCurrentBattleSet(troop)

commonLibs/_common/API_CORE/troopAPI.js, line 497

remove all sprites associated with the troop from the current battle

Parameters:

Name	Type	Description
troop	MATTIE.troopAPI.RuntimeTroop

setupTroopId()

commonLibs/_common/API_CORE/troopAPI.js, line 469

generate internal troop id for sorting

spawn() → {MATTIE.troopAPI.RuntimeTroop}

commonLibs/_common/API_CORE/troopAPI.js, line 514

spawn the event into the actual game. Until this is called the event is meaningless

Returns:

MATTIE.troopAPI.RuntimeTroop -

returns itself so that you can initialize and spawn in one line if you would like.

sprites() → {Array.<Sprite_Enemy>}

commonLibs/_common/API_CORE/troopAPI.js, line 464

get all sprites associated with this troop

Returns:

Array.<Sprite_Enemy> -

a list of the enemy sprites