Record Class EntityEffect.RunFunction

java.lang.Object

java.lang.Record

net.minestom.server.item.enchant.EntityEffect.RunFunction

All Implemented Interfaces:

Enchantment.Effect, EntityEffect, LocationEffect

Enclosing interface:

EntityEffect

public static record EntityEffect.RunFunction(String function)
extends Record
implements EntityEffect, LocationEffect

Nested Class Summary

Nested classes/interfaces inherited from interface EntityEffect

EntityEffect.AllOf, EntityEffect.ApplyPotionEffect, EntityEffect.ChangeItemDamage, EntityEffect.DamageEntity, EntityEffect.Explode, EntityEffect.Ignite, EntityEffect.PlaySound, EntityEffect.ReplaceBlock, EntityEffect.ReplaceDisc, EntityEffect.RunFunction, EntityEffect.SetBlockProperties, EntityEffect.SpawnParticles, EntityEffect.SummonEntity

Nested classes/interfaces inherited from interface LocationEffect

LocationEffect.AllOf

Field Summary

Fields

Modifier and Type	Field	Description
static final StructCodec<EntityEffect.RunFunction>	CODEC

Constructor Summary

Constructors

Constructor	Description
RunFunction(String function)	Creates an instance of a RunFunction record class.

Method Summary

Modifier and Type	Method	Description
StructCodec<EntityEffect.RunFunction>	codec()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
String	function()	Returns the value of the function 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 Object

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

Field Details

CODEC

public static final StructCodec<EntityEffect.RunFunction> CODEC

Constructor Details

RunFunction

public RunFunction(String function)

Creates an instance of a RunFunction record class.

Parameters:

function - the value for the function record component

Method Details

codec

public StructCodec<EntityEffect.RunFunction> codec()

Specified by:

codec in interface EntityEffect

Specified by:

codec in interface LocationEffect

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 Objects::equals(Object,Object).

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.

function

public String function()

Returns the value of the function record component.

Returns:

the value of the function record component