import AbilityConsumable from 'roguelike/app/entities/consumables/AbilityConsumable.js'

public class | source

AbilityConsumable

Extends:

Entity → Item → Consumable → AbilityConsumable

Constructor Summary

Public Constructor
public	constructor(ability: , name: )

Method Summary

Public Methods
public	getFriendlyDescription(): string
public	getName(): *
public	getRange(): *
public	getUseMessage(dungeon: , creature: ): string
public	isTargetCreature(): *
public	isTargetted(): *
public	toString(): *
public	use(dungeon: , creature: , optionalTargetTile: *)

Inherited Summary

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

From class Item
public	isTargetted(): boolean

From class Consumable
public	getRange(): number
public	isTargetted(): boolean
public	isUseable(): boolean
public	use(dungeon: , creature: )

Public Constructors

public constructor(ability: , name: ) source

Override:

Entity#constructor

Params:

Name	Type	Attribute	Description
ability	*
name	*

Public Methods

public getFriendlyDescription(): string source

Override:

Entity#getFriendlyDescription

Return:

string

public getName(): * source

Override:

Entity#getName

Return:

public getRange(): * source

Override:

Consumable#getRange

Return:

public getUseMessage(dungeon: , creature: ): string source

Params:

Name	Type	Attribute	Description
dungeon	*
creature	*

Return:

string

public isTargetCreature(): * source

Return:

public isTargetted(): * source

Override:

Consumable#isTargetted

Return:

public toString(): * source

Override:

Entity#toString

Return:

public use(dungeon: , creature: , optionalTargetTile: *) source

Override:

Consumable#use

Params:

Name	Type	Attribute	Description
dungeon	*
creature	*
optionalTargetTile	*

AbilityConsumable

Extends:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(ability: *, name: *) source

Override:

Params:

Public Methods

public getFriendlyDescription(): string source

Override:

Return:

public getName(): * source

Override:

Return:

public getRange(): * source

Override:

Return:

public getUseMessage(dungeon: *, creature: *): string source

Params:

Return:

public isTargetCreature(): * source

Return:

public isTargetted(): * source

Override:

Return:

public toString(): * source

Override:

Return:

public use(dungeon: *, creature: *, optionalTargetTile: *) source

Override:

Params:

public constructor(ability: , name: ) source

public getUseMessage(dungeon: , creature: ): string source

public use(dungeon: , creature: , optionalTargetTile: *) source