Package dev.piglin.piglinworldapi.util

Record Class TeleportUtils.TimedTeleportRecord<M>

java.lang.Object

java.lang.Record

dev.piglin.piglinworldapi.util.TeleportUtils.TimedTeleportRecord<M>

Type Parameters:

M - The additional metadata for your needs

Record Components:

player - The player

destination - The destination

time - Timestamp when the player should

onCancel - Will be executed when the player moves Note: Object is always instanceof Meta but I don't know java

onTeleport - Will be executed when the player should teleport. Note: Object is always instanceof Meta but I don't know java Returns: true = teleport, false = cancel

Enclosing class:

TeleportUtils

public static record TeleportUtils.TimedTeleportRecord<M>(@NotNull org.bukkit.entity.Player player, @NotNull org.bukkit.Location destination, long time, @NotNull Consumer<TeleportUtils.TimedTeleportRecord<Object>> onCancel, @NotNull Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean> onTeleport, M meta)
extends Record

A timed teleport description

Field Summary

Fields

Modifier and Type	Field	Description
static Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean>	ALWAYS_TELEPORT	Always teleport player (for onTeleport)
static Consumer<TeleportUtils.TimedTeleportRecord<Object>>	NOOP	Do nothing when cancelled (for onCancel)

Constructor Summary

Constructors

Constructor	Description
TimedTeleportRecord(@NotNull org.bukkit.entity.Player player, @NotNull org.bukkit.Location destination, long time, @NotNull Consumer<TeleportUtils.TimedTeleportRecord<Object>> onCancel, @NotNull Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean> onTeleport, M meta)	Creates an instance of a TimedTeleportRecord record class.
TimedTeleportRecord(@NotNull org.bukkit.entity.Player player, @NotNull org.bukkit.Location destination, @NotNull Consumer<TeleportUtils.TimedTeleportRecord<Object>> onCancel, @NotNull Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean> onTeleport, M meta)

Method Summary

Modifier and Type	Method	Description
@NotNull org.bukkit.Location	destination()	Returns the value of the destination record component.
boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
int	hashCode()	Returns a hash code value for this object.
M	meta()	Returns the value of the meta record component.
@NotNull Consumer<TeleportUtils.TimedTeleportRecord<Object>>	onCancel()	Returns the value of the onCancel record component.
@NotNull Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean>	onTeleport()	Returns the value of the onTeleport record component.
@NotNull org.bukkit.entity.Player	player()	Returns the value of the player record component.
long	time()	Returns the value of the time record component.
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

Field Details

ALWAYS_TELEPORT

public static final Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean> ALWAYS_TELEPORT

Always teleport player (for onTeleport)

NOOP

public static final Consumer<TeleportUtils.TimedTeleportRecord<Object>> NOOP

Do nothing when cancelled (for onCancel)

Constructor Details

TimedTeleportRecord

public TimedTeleportRecord(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull org.bukkit.Location destination,
 @NotNull
 @NotNull Consumer<TeleportUtils.TimedTeleportRecord<Object>> onCancel,
 @NotNull
 @NotNull Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean> onTeleport,
 @Nullable
 M meta)

TimedTeleportRecord

public TimedTeleportRecord(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull org.bukkit.Location destination,
 long time,
 @NotNull
 @NotNull Consumer<TeleportUtils.TimedTeleportRecord<Object>> onCancel,
 @NotNull
 @NotNull Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean> onTeleport,
 @Nullable
 M meta)

Creates an instance of a TimedTeleportRecord record class.

Parameters:

player - the value for the player record component

destination - the value for the destination record component

time - the value for the time record component

onCancel - the value for the onCancel record component

onTeleport - the value for the onTeleport record component

meta - the value for the meta 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.

player

@NotNull
public @NotNull org.bukkit.entity.Player player()

Returns the value of the player record component.

Returns:

the value of the player record component

destination

@NotNull
public @NotNull org.bukkit.Location destination()

Returns the value of the destination record component.

Returns:

the value of the destination record component

time

public long time()

Returns the value of the time record component.

Returns:

the value of the time record component

onCancel

@NotNull
public @NotNull Consumer<TeleportUtils.TimedTeleportRecord<Object>> onCancel()

Returns the value of the onCancel record component.

Returns:

the value of the onCancel record component

onTeleport

@NotNull
public @NotNull Function<TeleportUtils.TimedTeleportRecord<Object>,Boolean> onTeleport()

Returns the value of the onTeleport record component.

Returns:

the value of the onTeleport record component

meta

@Nullable
public M meta()

Returns the value of the meta record component.

Returns:

the value of the meta record component