import Creature from 'roguelike/app/entities/creatures/Creature.js'

public class | source

Creature

Extends:

Entity → Creature

Direct Subclass:

Archer, Bigfoot, BlackVoidSphere, ClunkyNinetiesCellPhone, Cow, Crier, DustBunny, DustMite, Ent, FireSprite, FlyingSerpent, MongolianHorseArcher, PlayableCharacter, Skeleton, SlingshotImp, Witch, Wyrm

Indirect Subclass:

Fighter, Miner, Rogue, Wizard

Constructor Summary

Public Constructor
public	constructor()

Method Summary

Public Methods
public	addAbility(ability: Ability) Adds an Ability to the Creature's list of Abilities.
public	addItem(item: Item, backpackOnly: boolean) Adds an item to the creature's inventory, optionally equipping it if there's room
public	applyBuff(dungeon: Dungeon, buff: Buff) Puts a Buff onto the creature.
public	canActThisTimestep(): boolean Tells whether the Creature may act on the current timestep.
public	canAddItem(item: Item, backpackOnly: boolean): boolean Checks to see if the creature's backpack can hold another item
public	canOccupy(tile: *): Boolean
public	canOccupyNow(tile: ):
public	canSee(dungeon: , tile: ): Boolean Determines if the Creature can see the given tile and what's on it.
public	canUseItems(): boolean Tells whether the creature can pickup and use items.
public	die(-: Dungeon) Kills this creature, removing it from the Dungeon
public	executeMove(dungeon: , move: )
public	getAbilities(): Array<Ability> Gets a list of the Creature's abilities
public	getAbility(index: number): Ability Gets the creature's Ability at the given index
public	getAbilityIndex(param: function(): Ability): number Gets the index of a creature's Ability
public	getArmor(): *
public	getBaseHP(): number Get's the Creature's maximum allowed hitpoints
public	getBaseMana(): number Get's the Creature's maximum allowed mana
public	getBuffs(): Array<Buff> Gets a list of the Creature's Buffs.
public	getClosestEnemy(dungeon: ):
public	getCurrentHP(): number Get's the Creature's current hitpoints
public	getCurrentMana(): number Get's the Creature's current mana
public	getDamageReduction(type: string): number Get's the amount that damage of the given type is reduced by the creature's defenses.
public	getFaction(): string
public	getInventory(): * Gets the creature's inventory
public	getMeleeWeapon(): *
public	getNextMove(dungeon: *): Move \| Promise
public	getRangedWeapon(): *
public	getSpeed(): number
public	getStrategy(): *
public	getTimeToNextMove(): number Gets the number of timesteps until this Creature's next move.
public	getVisibleCreatures(dungeon: ):
public	getVisibleEnemies(dungeon: ):
public	getVisibleTiles(dungeon: ):
public	getVisionRadius(): number
public	hasSeen(tile: ):
public	heal(dungeon: Dungeon, amount: number) Restores the Creature's hitpoints by a given amount. The Creature cannot go above it's hitpoint maximum in this way
public	isDead(): boolean Tells whether the Creature is dead.
public	isEnemy(other: ):
public	isFlying(): boolean
public	modifyMana(-: number) Modifies the Creature's current mana by the given amount. Mana cannot go below zero or above the Creature's base mana value
public	observeMove(dungeon: , actor: , move: *)
public	onDeath() An optional death handler for this Creature.
public	receiveDamage(dungeon: Dungeon, amount: number, type: string): number Applies a given amount of typed damage to the creature, minus the creature's damage reduction
public	setArmor(armor: *)
public	setMeleeWeapon(weapon: *)
public	setRangedWeapon(weapon: *)
public	setStrategy(strategy: *)
public	takeItems(dungeon: Dungeon) Takes items from the Creature's current tile and attempts to add each one to it's Inventory in sequence
public	timestep(dungeon: *)
public	visionObsuredBy(tile: ):

Inherited Summary

From class Entity
public	getFriendlyDescription()
public	getId(): *
public	getName(): *
public	isEquipable(): boolean
public	toString(): *

Public Constructors

public constructor() source

Override:

Entity#constructor

Public Methods

public addAbility(ability: Ability) source

Adds an Ability to the Creature's list of Abilities.

Params:

Name	Type	Attribute	Description
ability	Ability		The new ability

public addItem(item: Item, backpackOnly: boolean) source

Adds an item to the creature's inventory, optionally equipping it if there's room

Params:

Name	Type	Attribute	Description
item	Item		The Item to add
backpackOnly	boolean	optional default: false	Prohibits automatically equipping the item

public applyBuff(dungeon: Dungeon, buff: Buff) source

Puts a Buff onto the creature. The Buff will have a chance to apply it's effects each timestep (including the current one) until it ends or is removed

Params:

Name	Type	Attribute	Description
dungeon	Dungeon		The Dungeon the creature is in
buff	Buff		The Buff to apply

public canActThisTimestep(): boolean source

Tells whether the Creature may act on the current timestep.

Return:

boolean

true if the Creature's wait time til it's next move is 0; false otherwise

public canAddItem(item: Item, backpackOnly: boolean): boolean source

Checks to see if the creature's backpack can hold another item

Params:

Name	Type	Attribute	Description
item	Item		The Item to add
backpackOnly	boolean	optional default: false	If true, only checks for an empty backpack slot

Return:

boolean

public canOccupy(tile: *): Boolean source

Params:

Name	Type	Attribute	Description
tile	*

Return:

Boolean

true if the Creature could occupy the tile; false otherwise

public canOccupyNow(tile: ): source

Params:

Name	Type	Attribute	Description
tile	*

Return:

public canSee(dungeon: , tile: ): Boolean source

Determines if the Creature can see the given tile and what's on it.

Params:

Name	Type	Attribute	Description
dungeon	*
tile	*

Return:

Boolean

true if the Creature can see the tile; false otherwise

public canUseItems(): boolean source

Tells whether the creature can pickup and use items. By default, players can use items and enemies cannot.

Return:

boolean

public die(-: Dungeon) source

Kills this creature, removing it from the Dungeon

Params:

Name	Type	Attribute	Description
-	Dungeon		The Dungeon this Creature is in

public executeMove(dungeon: , move: ) source

Params:

Name	Type	Attribute	Description
dungeon	*
move	*

public getAbilities(): Array<Ability> source

Gets a list of the Creature's abilities

Return:

Array<Ability>

public getAbility(index: number): Ability source

Gets the creature's Ability at the given index

Params:

Name	Type	Attribute	Description
index	number

Return:

Ability

public getAbilityIndex(param: function(): Ability): number source

Gets the index of a creature's Ability

Params:

Name	Type	Attribute	Description
param	function(): Ability		An ability constructor

Return:

number

An integer index if an instance of the given class is found; -1 otherwise

public getArmor(): * source

Return:

public getBaseHP(): number source

Get's the Creature's maximum allowed hitpoints

Return:

number

A positive integer

public getBaseMana(): number source

Get's the Creature's maximum allowed mana

Return:

number

A positive integer

public getBuffs(): Array<Buff> source

Gets a list of the Creature's Buffs.

Return:

Array<Buff>

The Creature's Buffs

public getClosestEnemy(dungeon: ): source

Params:

Name	Type	Attribute	Description
dungeon	*

Return:

public getCurrentHP(): number source

Get's the Creature's current hitpoints

Return:

number

A non-negative integer

public getCurrentMana(): number source

Get's the Creature's current mana

Return:

number

A non-negative integer

public getDamageReduction(type: string): number source

Get's the amount that damage of the given type is reduced by the creature's defenses. Damage reduction is subtracted from incoming damage. Damage reduction typically comes from Armor

Params:

Name	Type	Attribute	Description
type	string		A member of DamageTypes

Return:

number

A non-negative integer

public getFaction(): string source

Return:

string

public getInventory(): * source

Gets the creature's inventory

Return:

Inventory

public getMeleeWeapon(): * source

Return:

public getNextMove(dungeon: *): Move | Promise source

Params:

Name	Type	Attribute	Description
dungeon	*

Return:

Move | Promise

A Move or a Promise for a Move

public getRangedWeapon(): * source

Return:

public getSpeed(): number source

Return:

number

public getStrategy(): * source

Return:

public getTimeToNextMove(): number source

Gets the number of timesteps until this Creature's next move.

Return:

number

public getVisibleCreatures(dungeon: ): source

Params:

Name	Type	Attribute	Description
dungeon	*

Return:

public getVisibleEnemies(dungeon: ): source

Params:

Name	Type	Attribute	Description
dungeon	*

Return:

public getVisibleTiles(dungeon: ): source

Params:

Name	Type	Attribute	Description
dungeon	*

Return:

public getVisionRadius(): number source

Return:

number

public hasSeen(tile: ): source

Params:

Name	Type	Attribute	Description
tile	*

Return:

public heal(dungeon: Dungeon, amount: number) source

Restores the Creature's hitpoints by a given amount. The Creature cannot go above it's hitpoint maximum in this way

Params:

Name	Type	Attribute	Description
dungeon	Dungeon		The creature's current Dungeon
amount	number		The amount of damage to restore

public isDead(): boolean source

Tells whether the Creature is dead. If the Creature is dead it will no longer be in a Dungeon.

Return:

boolean

true if the Creature has died; false otherwise

public isEnemy(other: ): source

Params:

Name	Type	Attribute	Description
other	*

Return:

public isFlying(): boolean source

Return:

boolean

public modifyMana(-: number) source

Modifies the Creature's current mana by the given amount. Mana cannot go below zero or above the Creature's base mana value

Params:

Name	Type	Attribute	Description
-	number		An integer to add to the Creature's current mana. Negative numbers are allowed

public observeMove(dungeon: , actor: , move: *) source

Params:

Name	Type	Attribute	Description
dungeon	*
actor	*
move	*

public onDeath() source

An optional death handler for this Creature. Called when the Creature dies

public receiveDamage(dungeon: Dungeon, amount: number, type: string): number source

Applies a given amount of typed damage to the creature, minus the creature's damage reduction

Params:

Name	Type	Attribute	Description
dungeon	Dungeon		The creature's current Dungeon
amount	number		The amount of damage
type	string		A member of DamageTypes

Return:

number

The amount of damage received. If the creature has no reduction for the given type, then this will be the same as the input amount

public setArmor(armor: *) source

Params:

Name	Type	Attribute	Description
armor	*

public setMeleeWeapon(weapon: *) source

Params:

Name	Type	Attribute	Description
weapon	*

public setRangedWeapon(weapon: *) source

Params:

Name	Type	Attribute	Description
weapon	*

public setStrategy(strategy: *) source

Params:

Name	Type	Attribute	Description
strategy	*

public takeItems(dungeon: Dungeon) source

Takes items from the Creature's current tile and attempts to add each one to it's Inventory in sequence

Params:

Name	Type	Attribute	Description
dungeon	Dungeon		The Dungeon the creature is in

public timestep(dungeon: *) source

Params:

Name	Type	Attribute	Description
dungeon	*

public visionObsuredBy(tile: ): source

Params:

Name	Type	Attribute	Description
tile	*

Creature

Extends:

Direct Subclass:

Indirect Subclass:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor() source

Override:

Public Methods

public addAbility(ability: Ability) source

Params:

public addItem(item: Item, backpackOnly: boolean) source

Params:

public applyBuff(dungeon: Dungeon, buff: Buff) source

Params:

public canActThisTimestep(): boolean source

Return:

public canAddItem(item: Item, backpackOnly: boolean): boolean source

Params:

Return:

public canOccupy(tile: *): Boolean source

Params:

Return:

public canOccupyNow(tile: *): * source

Params:

Return:

public canSee(dungeon: *, tile: *): Boolean source

Params:

Return:

public canUseItems(): boolean source

Return:

public die(-: Dungeon) source

Params:

public executeMove(dungeon: *, move: *) source

Params:

public getAbilities(): Array<Ability> source

Return:

public getAbility(index: number): Ability source

Params:

Return:

public getAbilityIndex(param: function(): Ability): number source

Params:

Return:

public getArmor(): * source

Return:

public getBaseHP(): number source

Return:

public getBaseMana(): number source

Return:

public getBuffs(): Array<Buff> source

Return:

public getClosestEnemy(dungeon: *): * source

Params:

Return:

public getCurrentHP(): number source

Return:

public getCurrentMana(): number source

Return:

public getDamageReduction(type: string): number source

Params:

Return:

public getFaction(): string source

Return:

public getInventory(): * source

Return:

public getMeleeWeapon(): * source

Return:

public getNextMove(dungeon: *): Move | Promise source

Params:

Return:

public getRangedWeapon(): * source

Return:

public getSpeed(): number source

Return:

public getStrategy(): * source

Return:

public getTimeToNextMove(): number source

Return:

public canOccupyNow(tile: ): source

public canSee(dungeon: , tile: ): Boolean source

public executeMove(dungeon: , move: ) source

public getClosestEnemy(dungeon: ): source

public getVisibleCreatures(dungeon: ): source

public getVisibleEnemies(dungeon: ): source

public getVisibleTiles(dungeon: ): source

public hasSeen(tile: ): source

public isEnemy(other: ): source

public observeMove(dungeon: , actor: , move: *) source

public visionObsuredBy(tile: ): source