import UseAbilityMove from 'roguelike/app/entities/creatures/moves/UseAbilityMove.js'

public class | source

UseAbilityMove

Extends:

Move → UseAbilityMove

The move a Creature makes when they use an ability

Constructor Summary

Public Constructor
public	constructor(actorTile: , index: , x: , y: )

Method Summary

Public Methods
public	execute(dungeon: , creature: )
public	getCostMultiplier(): number
public	getIndex(): number Gets the index of the ability to be used
public	getReasonIllegal(dungeon: , creature: ): *
public	getX(): number \| null Gets the x value of the ability target position, if any
public	getY(): number \| null Gets the y value of the ability target position, if any
public	isSeenBy(dungeon: , observer: ): *

Inherited Summary

From class Move
public	execute(dungeon: , creature: )
public	getActorX(): *
public	getActorY(): *
public	getCostMultiplier()
public	getReasonIllegal(dungeon: , creature: )
public	isSeenBy(dungeon: , observer: )

Public Constructors

public constructor(actorTile: , index: , x: , y: ) source

Override:

Move#constructor

Params:

Name	Type	Attribute	Description
actorTile	*
index	*
x	*
y	*

Public Methods

public execute(dungeon: , creature: ) source

Override:

Move#execute

Params:

Name	Type	Attribute	Description
dungeon	*
creature	*

public getCostMultiplier(): number source

Override:

Move#getCostMultiplier

Return:

number

public getIndex(): number source

Gets the index of the ability to be used

Return:

number

A non-negative integer. The position of the ability in the Creature's list

public getReasonIllegal(dungeon: , creature: ): * source

Override:

Move#getReasonIllegal

Params:

Name	Type	Attribute	Description
dungeon	*
creature	*

Return:

public getX(): number | null source

Gets the x value of the ability target position, if any

Return:

number | null

public getY(): number | null source

Gets the y value of the ability target position, if any

Return:

number | null

public isSeenBy(dungeon: , observer: ): * source

Override:

Move#isSeenBy

Params:

Name	Type	Attribute	Description
dungeon	*
observer	*

UseAbilityMove

Extends:

Constructor Summary

Method Summary

Inherited Summary

Public Constructors

public constructor(actorTile: *, index: *, x: *, y: *) source

Override:

Params:

Public Methods

public execute(dungeon: *, creature: *) source

Override:

Params:

public getCostMultiplier(): number source

Override:

Return:

public getIndex(): number source

Return:

public getReasonIllegal(dungeon: *, creature: *): * source

Override:

Params:

Return:

public getX(): number | null source

Return:

public getY(): number | null source

Return:

public isSeenBy(dungeon: *, observer: *): * source

Override:

Params:

Return:

public constructor(actorTile: , index: , x: , y: ) source

public execute(dungeon: , creature: ) source

public getReasonIllegal(dungeon: , creature: ): * source

public isSeenBy(dungeon: , observer: ): * source