Class TeamBattle

TeamBattle handles team battle simulation

Hierarchy

BaseBattle
- TeamBattle

Index

Constructors

Properties

fighters gameStats i interval logBattle playerDiedText? round showBattle teamA teamB

Methods

attack getDamageDealt getRemainingHP progressBar reply run setInterval setPlayerDeadText sleep updateEmbed

Constructors

constructor

new TeamBattle(i, teamA, teamB): TeamBattle
Parameters
- i: CommandInteraction<CacheType>
  
  Discord.js CommandInteraction
- teamA: Team
  
  team
- teamB: Team
  
  team
Returns TeamBattle
Overrides BaseBattle.constructor
- Defined in TeamBatle.ts:25

Properties

`Protected` fighters

fighters: Fighter[]

`Protected` gameStats

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

`Protected` i

i: CommandInteraction<CacheType>

interval

interval: number = 1000

logBattle

logBattle: boolean = false

Logs battle to stdout

`Protected` `Optional` playerDiedText

playerDiedText?: ((fighter) => string)

Type declaration

- (fighter): string
- Parameters
  - fighter: Fighter
  Returns string

`Protected` round

round: number = 0

showBattle

showBattle: boolean = true

Show battle embed

`Private` teamA

teamA: Team

`Private` teamB

teamB: Team

Methods

`Protected` attack

attack(p1, p2): EmbedBuilder
Parameters
- p1: Fighter
- p2: Fighter
Returns EmbedBuilder
Inherited from BaseBattle.attack
- Defined in BaseBattle.ts:85

getDamageDealt

getDamageDealt(id): undefined | number
Gets total damage dealt for a particular fighter
Parameters
- id: string
Returns undefined | number
Inherited from BaseBattle.getDamageDealt
- Defined in BaseBattle.ts:150

getRemainingHP

getRemainingHP(id): undefined | number
Get remaining HP for a particular fighter
Parameters
- id: string
Returns undefined | number
Inherited from BaseBattle.getRemainingHP
- Defined in BaseBattle.ts:157

`Protected` progressBar

progressBar(embed, name, hp, maxHP): void
adds progress bar to battleEmbed
Parameters
- embed: EmbedBuilder
- name: string
- hp: number
- maxHP: number
Returns void
Inherited from BaseBattle.progressBar
- Defined in BaseBattle.ts:69

`Protected` reply

reply(options): Promise<void>
Parameters
- options: string | EmbedBuilder
Returns Promise<void>
Inherited from BaseBattle.reply
- Defined in BaseBattle.ts:52

run

run(): Promise<Team>
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<Team>
Team
- Defined in TeamBatle.ts:40

setInterval

setInterval(ms): TeamBattle
Sets the battle scene interval.
Parameters
- ms: number
  
  {number} - time in milliseconds
Returns TeamBattle
Inherited from BaseBattle.setInterval
- Defined in BaseBattle.ts:174

setPlayerDeadText

setPlayerDeadText(text): void
Changes the discord.js message sent when player dies in the battle.
Parameters
- text: ((fighter) => string)
  - - (fighter): string
    - Parameters
      
      fighter: Fighter
      
      Returns string
Returns void
Inherited from BaseBattle.setPlayerDeadText
- Defined in BaseBattle.ts:165

`Protected` sleep

sleep(): Promise<unknown>
Returns Promise<unknown>
Inherited from BaseBattle.sleep
- Defined in BaseBattle.ts:34

`Protected` updateEmbed

updateEmbed(embed): Promise<void>
Updates embed and log if enabled.
Parameters
- embed: EmbedBuilder
Returns Promise<void>
Inherited from BaseBattle.updateEmbed
- Defined in BaseBattle.ts:193

Generated using TypeDoc