RGB-rogue-like-game/ru.hse.sd.rgb.gamelogic.engines.fight/FightEngine

FightEngine

public final class FightEngine

Class for processing color-based operations such as attacks and updates.

The specific rules for color interactions are defined by:

so-called base colors, which specify which attack the colors can perform
interaction matrix, which defines how much damage one color deals to another upon attacking.

During the game, actual RGB colors are mapped to the base color closest by some internal metric (currently L1). The damage defined by interaction matrix is also multiplied by a coefficient dependent on the distance between the base color and the actual color.

As the only class that is allowed to perform color updates, this class also stores Tickers that govern units' color update periods.

Parameters

baseColors

The list of all base colors and their properties.

interactionMatrix

The matrix that defines damage from one color to another.

Constructors

FightEngine FightEngine(List<BaseColorStats> baseColors, Grid2D<Integer> interactionMatrix)

Types

public interface UnsafeMethods

Methods that must be used instead of their usual FightEngine counterparts if and only if explicitly told to.

Functions

final Unit attack(GameUnit from, GameUnit to)

Calculates and performs an attack from one GameUnit to another.

final Unit attackDirectly(GameUnit to, Integer attack)

Performs an attack on to with attack damage.

final Unit changeMaxHp(HpGameUnit unit, Integer amount)

Unconditionally adds amount to unit's maxHp property.

final Unit changeRGB(GameUnit unit, RGB newRgb)

Unconditionally sets the color of unit to newRgb.

final Unit changeRGB(GameUnit unit, RGBDelta delta)

Unconditionally adds delta to unit's color.

getBaseColorName

final String getBaseColorName(GameUnit unit)

Returns the current base color name for unit.

final Integer newTeamId()

Returns a unique teamId.

final Unit registerUnit(GameUnit unit)

Registers unit in this FightEngine.

final Unit unregisterUnit(GameUnit unit)

Unregisters unit from this FightEngine.

final Unit update(GameUnit unit, ControlParams controlParams)

Performs a color update for unit.