com.pixelmonmod.pixelmon.battles.controller.log

Class BattleLog

java.lang.Object

com.pixelmonmod.pixelmon.battles.controller.log.BattleLog

public class BattleLog
extends java.lang.Object

Logs actions that occur during battles.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BattleLog.BattleTurnLog

Field Summary

Fields

Modifier and Type	Field and Description
protected java.time.Instant	battleStart
protected BattleController	bc
protected BattleLog.BattleTurnLog	currentTurnLog
protected java.util.Map<java.lang.Integer,BattleLog.BattleTurnLog>	logs

Constructor Summary

Constructors

Constructor and Description
BattleLog(BattleController bc) Initializes a battle log.

Method Summary

Modifier and Type	Method and Description
java.util.concurrent.CompletableFuture<java.io.File>	exportLogFile(java.lang.String message, java.lang.Exception exception)
BattleAction	getActionForPokemon(int turn, PixelmonWrapper pw) Gets a specific action for a Pokémon in the battle log.
java.util.List<BattleAction>	getAllActions()
java.lang.String	getFilename()
void	logEvent(BattleAction event) Adds an action to the current turn in the battle log.
void	onCrash(java.lang.Exception exc, java.lang.String error) Logs a crash in the battle log and ends the battle.
void	turnTick(int turn) Moves the log on to the next turn (with the given turn id)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

bc

protected final BattleController bc

battleStart

protected final java.time.Instant battleStart

logs

protected final java.util.Map<java.lang.Integer,BattleLog.BattleTurnLog> logs

currentTurnLog

protected BattleLog.BattleTurnLog currentTurnLog

Constructor Detail

BattleLog

public BattleLog(BattleController bc)

Initializes a battle log.

Parameters:

bc - The battle to log.

Method Detail

logEvent

public void logEvent(BattleAction event)

Adds an action to the current turn in the battle log.

Parameters:

event - The action to add.

getActionForPokemon

@Nullable
public BattleAction getActionForPokemon(int turn,
                                                  PixelmonWrapper pw)

Gets a specific action for a Pokémon in the battle log.

Parameters:

turn - The turn to get an action from.

pw - The Pokémon to get an action for.

Returns:

The Pokémon's action in the specified turn.

turnTick

public void turnTick(int turn)

Moves the log on to the next turn (with the given turn id)

onCrash

public void onCrash(java.lang.Exception exc,
                    java.lang.String error)

Logs a crash in the battle log and ends the battle.

Parameters:

exc - The exception thrown by the battle.

error - The error message from the exception.

getAllActions

public java.util.List<BattleAction> getAllActions()

exportLogFile

public java.util.concurrent.CompletableFuture<java.io.File> exportLogFile(java.lang.String message,
                                                                          java.lang.Exception exception)
                                                                   throws java.lang.Exception

Throws:

java.lang.Exception

getFilename

public java.lang.String getFilename()