Record Class EntityEffect.SummonEntity

java.lang.Object

java.lang.Record

net.minestom.server.item.enchant.EntityEffect.SummonEntity

All Implemented Interfaces:

Enchantment.Effect, EntityEffect, LocationEffect

Enclosing interface:

EntityEffect

public static record EntityEffect.SummonEntity(Codec.RawValue entityTypes, boolean joinTeam)
extends Record
implements EntityEffect, LocationEffect

Nested Class Summary

Nested classes/interfaces inherited from interface net.minestom.server.item.enchant.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 net.minestom.server.item.enchant.LocationEffect

LocationEffect.AllOf

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
SummonEntity(Codec.RawValue entityTypes, boolean joinTeam)	Creates an instance of a SummonEntity record class.

Method Summary

Modifier and Type	Method	Description
@NotNull StructCodec<EntityEffect.SummonEntity>	codec()
Codec.RawValue	entityTypes()	Returns the value of the entityTypes record component.
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.
boolean	joinTeam()	Returns the value of the joinTeam 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

Field Details

CODEC

public static final StructCodec<EntityEffect.SummonEntity> CODEC

Constructor Details

SummonEntity

public SummonEntity(@NotNull
 Codec.RawValue entityTypes,
 boolean joinTeam)

Creates an instance of a SummonEntity record class.

Parameters:

entityTypes - the value for the entityTypes record component

joinTeam - the value for the joinTeam record component

Method Details

codec

@NotNull
public @NotNull StructCodec<EntityEffect.SummonEntity> 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

entityTypes

@NotNull
public Codec.RawValue entityTypes()

Returns the value of the entityTypes record component.

Returns:

the value of the entityTypes record component

joinTeam

public boolean joinTeam()

Returns the value of the joinTeam record component.

Returns:

the value of the joinTeam record component