Record Class FlagReturnedInBase

java.lang.Object

java.lang.Record

dev.zwazel.internal.message.data.flag.FlagReturnedInBase

Record Components:

flagId - The ID of the flag that got returned in the base.

All Implemented Interfaces:

MessageData

public record FlagReturnedInBase(long flagId)
extends Record
implements MessageData

Represents the message data for when a flag is returned in the base. Received when a flag is returned in the base. This could happen when a player of the same team as the flag's team collects the dropped flag, thus returning it to the base. Or when the enemy team captures the flag and returns it to their base, scoring a point.

Constructor Summary

Constructors

Constructor	Description
FlagReturnedInBase(long flagId)	Creates an instance of a FlagReturnedInBase record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
long	flagId()	Returns the value of the flagId record component.
final int	hashCode()	Returns a hash code value for this object.
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

Methods inherited from interface dev.zwazel.internal.message.MessageData

applyBeforeSend, applyOnAddingToQueue, applyOnReceive, isUnique

Constructor Details

FlagReturnedInBase

public FlagReturnedInBase(long flagId)

Creates an instance of a FlagReturnedInBase record class.

Parameters:

flagId - the value for the flagId 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. All components in this record class are compared with the compare method from their corresponding wrapper classes.

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.

flagId

public long flagId()

Returns the value of the flagId record component.

Returns:

the value of the flagId record component