Class EntityType

java.lang.Object

ch.njol.skript.entity.EntityType

org.skriptlang.skript.bukkit.entity.EntityType

All Implemented Interfaces:

YggdrasilSerializable, YggdrasilSerializable.YggdrasilExtendedSerializable, Cloneable

public class EntityType
extends EntityType
implements Cloneable, YggdrasilSerializable.YggdrasilExtendedSerializable

Class that represents x amount of an EntityData

Nested Class Summary

Nested classes/interfaces inherited from interface YggdrasilSerializable

YggdrasilSerializable.YggdrasilExtendedSerializable, YggdrasilSerializable.YggdrasilRobustEnum, YggdrasilSerializable.YggdrasilRobustSerializable

Field Summary

Fields inherited from class EntityType

amount, data

Constructor Summary

Constructors

Constructor	Description
EntityType()	Used for deserialization.
EntityType(EntityData<?> entityData, int amount)	Constructs a new EntityType.

Method Summary

Modifier and Type	Method	Description
EntityType	clone()
void	deserialize(@NotNull Fields fields)	Deserializes this object.
boolean	equals(@Nullable Object obj)
int	getAmount()
EntityData<?>	getData()
int	hashCode()
boolean	isInstance(org.bukkit.entity.Entity entity)	Whether entity is instance of this.
static @Nullable EntityType	parse(String string)	Parses the provided string into a EntityData and stores in a new EntityType.
boolean	sameType(EntityType other)	Whether other has the same EntityData.
Fields	serialize()	Serialises this object.
void	setAmount(int entityAmount)	Sets the amount this corresponds to with getData().
String	toString()
String	toString(int flags)	Returns the string representation of this.

Methods inherited from class EntityType

sameType

Methods inherited from class Object

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

Constructor Details

EntityType

@Internal
public EntityType()

Used for deserialization.

EntityType

public EntityType(EntityData<?> entityData,
 int amount)

Constructs a new EntityType.

Parameters:

entityData - The corresponding EntityData.

amount - The amount of data.

Method Details

parse

@Nullable
public static @Nullable EntityType parse(String string)

Parses the provided string into a EntityData and stores in a new EntityType.

The string allows formats of "number + entity" and "article + entity", but never "article + number + entity" or "number + article + entity". Allowed: - 1 zombie, 3 pigs, 5 endermen - a zombie, a pig, an endermen Not-Allowed: - a 1 zombie, a 3 pigs, an 5 endermen - 1 a zombie, 3 a pigs, 5 an endermen

Parameters:

string - The String to parse.

Returns:

EntityType containing the parsed EntityData and provided amount if present in string or -1 if not present. Otherwise null if the parse failed.

isInstance

public boolean isInstance(org.bukkit.entity.Entity entity)

Whether entity is instance of this.

Overrides:

isInstance in class EntityType

Parameters:

entity - The Entity to check.

Returns:

true if instance of, otherwise false.

See Also:

• EntityData.isInstance(Entity)

toString

public String toString()

Overrides:

toString in class EntityType

toString

public String toString(int flags)

Returns the string representation of this.

Overrides:

toString in class EntityType

Parameters:

flags - The flags to determine singular or plurality.

Returns:

The string representation.

getAmount

public int getAmount()

Overrides:

getAmount in class EntityType

Returns:

The amount of this corresponds to with getData().

setAmount

public void setAmount(int entityAmount)

Sets the amount this corresponds to with getData().

Parameters:

entityAmount - The new amount.

getData

public EntityData<?> getData()

Returns:

The EntityData this corresponds to.

sameType

public boolean sameType(EntityType other)

Whether other has the same EntityData.

Parameters:

other - The other EntityType.

Returns:

true if the EntityDatas are the same, otherwise false.

See Also:

• EntityData.equals(Object)

clone

public EntityType clone()

Overrides:

clone in class EntityType

hashCode

public int hashCode()

Overrides:

hashCode in class EntityType

equals

public boolean equals(@Nullable
 @Nullable Object obj)

Overrides:

equals in class EntityType

serialize

public Fields serialize()
                 throws NotSerializableException

Description copied from interface: YggdrasilSerializable.YggdrasilExtendedSerializable

Serialises this object. Only fields contained in the returned Fields object will be written to stream.

You can use return new Fields(this); to emulate the default behaviour.

Specified by:

serialize in interface YggdrasilSerializable.YggdrasilExtendedSerializable

Returns:

A Fields object containing all fields that should be written to stream

Throws:

NotSerializableException - If this object or one of its fields is not serializable

deserialize

public void deserialize(@NotNull
 @NotNull Fields fields)
                 throws StreamCorruptedException,
NotSerializableException

Description copied from interface: YggdrasilSerializable.YggdrasilExtendedSerializable

Deserializes this object. No fields have been set when this method is called, use fields.setFields(this, yggdrasil) to set all compatible non-transient and non-static fields (and call incompatible/missing field handlers if applicable – this implies that errors will be thrown if the fields object is invalid).

You can use fields.setFields(this); to emulate the default behaviour.

Specified by:

deserialize in interface YggdrasilSerializable.YggdrasilExtendedSerializable

Parameters:

fields - A Fields object containing all fields read from stream

Throws:

StreamCorruptedException - If the Fields object is invalid, i.e. was not written by YggdrasilSerializable.YggdrasilExtendedSerializable.serialize() or Yggdrasil's default serialisation.

NotSerializableException