Class Battle

Battle handles all battle simulation using discord.js's embed.

Hierarchy

  • BaseBattle
    • Battle

Constructors

constructor

Properties

boss? fighters gameStats i interval logBattle onFighterDead? playerDiedText? round showBattle

Methods

attack getDamageDealt getRemainingHP progressBar reply run setBoss setInterval setOnFighterDead setPlayerDeadText sleep updateEmbed

Constructors

constructor

  • Parameters

    • i: CommandInteraction<CacheType>

      discord.js's CommandInteraction

    • fighters: Fighter[]

      array of Fighter's object

    Returns Battle

Properties

Protected Optional boss

boss?: Fighter

Protected fighters

fighters: Fighter[]

Protected gameStats

gameStats: Map<string, PlayerGameStat> = ...

Protected i

i: CommandInteraction<CacheType>

interval

interval: number = 4000

Time interval to change to next frame (in milliseconds by default is 6000)

logBattle

logBattle: boolean = false

Logs battle to stdout

Optional onFighterDead

onFighterDead?: ((fighter) => void)

Type declaration

    • (fighter): void

    • Parameters

      Returns void

Protected Optional playerDiedText

playerDiedText?: ((fighter) => string)

Type declaration

    • (fighter): string

    • Parameters

      Returns string

Protected round

round: number = 0

showBattle

showBattle: boolean = true

Show battle embed

Methods

Protected attack

getDamageDealt

  • Gets total damage dealt for a particular fighter

    Parameters

    • id: string

    Returns undefined | number

getRemainingHP

  • Get remaining HP for a particular fighter

    Parameters

    • id: string

    Returns undefined | number

Protected progressBar

  • adds progress bar to battleEmbed

    Parameters

    • embed: EmbedBuilder
    • name: string
    • hp: number
    • maxHP: number

    Returns void

Protected reply

  • Parameters

    • options: string | EmbedBuilder

    Returns Promise<void>

run

  • Starts the battle simulation. It will throw error if the array of Fighters is less than 2. This method will return the Fighter object who won the battle.

    Returns Promise<Fighter>

    Fighter

setBoss

  • Change the battle to raid mode. Raid mode only have one opponent that is the boss. If the boss dies, the battle ends.

    Parameters

    • boss: Fighter

      {Fighter} - Boss to be defeated

    Returns Battle

setInterval

  • Sets the battle scene interval.

    Parameters

    • ms: number

      {number} - time in milliseconds

    Returns Battle

setOnFighterDead

  • Executes callback when Fighter dead during battle.

    Parameters

    • cb: ((fighter) => void)
        • (fighter): void

        • Parameters

          Returns void

    Returns void

setPlayerDeadText

  • Changes the discord.js message sent when player dies in the battle.

    Parameters

    • text: ((fighter) => string)
        • (fighter): string

        • Parameters

          Returns string

    Returns void

Protected sleep

  • Returns Promise<unknown>

Protected updateEmbed

  • Updates embed and log if enabled.

    Parameters

    • embed: EmbedBuilder

    Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc