Package nz.ac.vuw.ecs.swen225.gp22.domain

Record Class Entity.Action

java.lang.Object

java.lang.Record

nz.ac.vuw.ecs.swen225.gp22.domain.Entity.Action

Record Components:

id - ID of the entity this action belongs to.

moveVector - Amount the entity moved by in this action.

oldDir - Direction entity was facing before action.

newDir - Direction entity is facing after action.

interaction - The interaction, if any that happened this action.

Enclosing class:

Entity<S extends Observable<S>>

public static record Entity.Action(int id, Maze.Point moveVector, Entity.Direction oldDir, Entity.Direction newDir, Entity.Action.Interaction interaction)
extends Record

A record used to store an action taken. This will be used to revert actions when replaying a game.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final record	Entity.Action.Interaction	Represents an interaction with a tile that happened in the action.

Constructor Summary

Constructors

Constructor	Description
Action(int id, Maze.Point moveVector, Entity.Direction oldDir, Entity.Direction newDir, Entity.Action.Interaction interaction)	Creates an instance of a Action record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
int	id()	Returns the value of the id record component.
Entity.Action.Interaction	interaction()	Returns the value of the interaction record component.
Maze.Point	moveVector()	Returns the value of the moveVector record component.
Entity.Direction	newDir()	Returns the value of the newDir record component.
Entity.Direction	oldDir()	Returns the value of the oldDir record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Action

public Action(int id,
 Maze.Point moveVector,
 Entity.Direction oldDir,
 Entity.Direction newDir,
 Entity.Action.Interaction interaction)

Creates an instance of a Action record class.

Parameters:

id - the value for the id record component

moveVector - the value for the moveVector record component

oldDir - the value for the oldDir record component

newDir - the value for the newDir record component

interaction - the value for the interaction record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

id

public int id()

Returns the value of the id record component.

Returns:

the value of the id record component

moveVector

public Maze.Point moveVector()

Returns the value of the moveVector record component.

Returns:

the value of the moveVector record component

oldDir

public Entity.Direction oldDir()

Returns the value of the oldDir record component.

Returns:

the value of the oldDir record component

newDir

public Entity.Direction newDir()

Returns the value of the newDir record component.

Returns:

the value of the newDir record component

interaction

public Entity.Action.Interaction interaction()

Returns the value of the interaction record component.

Returns:

the value of the interaction record component