Package ch.njol.skript.entity
Class ThrownPotionData
java.lang.Object
ch.njol.skript.entity.EntityData<org.bukkit.entity.ThrownPotion>
ch.njol.skript.entity.ThrownPotionData
- All Implemented Interfaces:
SyntaxElement
,YggdrasilSerializable
,YggdrasilSerializable.YggdrasilExtendedSerializable
-
Nested Class Summary
Nested classes/interfaces inherited from interface ch.njol.yggdrasil.YggdrasilSerializable
YggdrasilSerializable.YggdrasilExtendedSerializable, YggdrasilSerializable.YggdrasilRobustEnum, YggdrasilSerializable.YggdrasilRobustSerializable
-
Field Summary
Fields inherited from class ch.njol.skript.entity.EntityData
LANGUAGE_NODE, m_adult, m_age_pattern, m_baby, matchedPattern, serializer, WORLD_1_17_CONSUMER, WORLD_1_17_CONSUMER_METHOD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected boolean
Deprecated, for removal: This API element is subject to removal in a future version.protected boolean
equals_i
(EntityData<?> obj) Internal helper forEntityData.equals(Object)
to compare the specific data of thisEntityData
with another.@NotNull EntityData
Returns a more general version of thisEntityData
with specific data removed.Class
<? extends org.bukkit.entity.ThrownPotion> getType()
protected int
Internal method used byEntityData.hashCode()
to include subclass-specific fields in the hash calculation for thisEntityData
.protected boolean
init
(Literal<?>[] exprs, int matchedPattern, SkriptParser.ParseResult parseResult) Initializes thisEntityData
from the matched pattern and its associated literals.protected boolean
init
(@Nullable Class<? extends org.bukkit.entity.ThrownPotion> c, @Nullable org.bukkit.entity.ThrownPotion e) Initializes thisEntityData
from either an entity class or a specificEntity
.boolean
isSupertypeOf
(EntityData<?> e) Determines whether thisEntityData
is a supertype of the givenentityData
.protected boolean
match
(org.bukkit.entity.ThrownPotion entity) Determines whether the givenEntity
matches thisEntityData
data.void
set
(org.bukkit.entity.ThrownPotion entity) Applies thisEntityData
to a newly spawnedEntity
.@Nullable org.bukkit.entity.ThrownPotion
Spawn this entity data at a location.toString
(int flags) Methods inherited from class ch.njol.skript.entity.EntityData
canSpawn, create, create, create, deserialize, equals, fromClass, fromEntity, getAgeAdjective, getAll, getAll, getAll, getInfo, getInfo, getName, getSyntaxTypeName, hashCode, init, isBaby, isInstance, isPlural, onRegistrationStop, parse, parseWithoutIndefiniteArticle, register, register, serialize, spawn, spawn, spawn, toString, toString, toString, toString, toString
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser, preInit
-
Constructor Details
-
ThrownPotionData
public ThrownPotionData()
-
-
Method Details
-
init
protected boolean init(Literal<?>[] exprs, int matchedPattern, SkriptParser.ParseResult parseResult) Description copied from class:EntityData
Initializes thisEntityData
from the matched pattern and its associated literals.This is used when parsing entity data from user-written patterns such as "a saddled pig".
- Specified by:
init
in classEntityData<org.bukkit.entity.ThrownPotion>
- Parameters:
exprs
- An array ofLiteral
expressions from the matched pattern, in the order they appear. If an optional value was omitted by the user, it will still be present in the array with a value ofnull
.matchedPattern
- The index of the pattern which matched.parseResult
- Additional information from the parser.- Returns:
true
if initialization was successful, otherwisefalse
.
-
init
protected boolean init(@Nullable @Nullable Class<? extends org.bukkit.entity.ThrownPotion> c, @Nullable @Nullable org.bukkit.entity.ThrownPotion e) Description copied from class:EntityData
Initializes thisEntityData
from either an entity class or a specificEntity
.Example usage:
spawn a pig at location(0, 0, 0): set {_entity} to event-entity spawn {_entity} at location(0, 0, 0)
- Specified by:
init
in classEntityData<org.bukkit.entity.ThrownPotion>
- Parameters:
c
- An entity's class, e.g. Playere
- An actual entity, or null to get an entity data for an entity class- Returns:
true
if initialization was successful, otherwisefalse
.
-
match
protected boolean match(org.bukkit.entity.ThrownPotion entity) Description copied from class:EntityData
Determines whether the givenEntity
matches thisEntityData
data.For example:
spawn a pig at location(0, 0, 0): set {_entity} to event-entity if {_entity} is a pig: # will pass if {_entity} is a saddled pig: # will not pass
- Specified by:
match
in classEntityData<org.bukkit.entity.ThrownPotion>
- Parameters:
entity
- TheEntity
to match.- Returns:
true
if the entity matches, otherwisefalse
.
-
spawn
@Nullable public @Nullable org.bukkit.entity.ThrownPotion spawn(org.bukkit.Location location, @Nullable @Nullable Consumer<org.bukkit.entity.ThrownPotion> consumer) Description copied from class:EntityData
Spawn this entity data at a location. The consumer allows for modification to the entity before it actually gets spawned.- Overrides:
spawn
in classEntityData<org.bukkit.entity.ThrownPotion>
- Parameters:
location
- TheLocation
to spawn the entity at.consumer
- AConsumer
to apply the entity changes to.- Returns:
- The Entity object that is spawned.
-
set
public void set(org.bukkit.entity.ThrownPotion entity) Description copied from class:EntityData
Applies thisEntityData
to a newly spawnedEntity
.This is used during entity spawning to set additional data, such as a saddled pig.
- Specified by:
set
in classEntityData<org.bukkit.entity.ThrownPotion>
- Parameters:
entity
- The spawned entity.
-
getType
Description copied from class:EntityData
- Specified by:
getType
in classEntityData<org.bukkit.entity.ThrownPotion>
- Returns:
- The entity's
Class
, such asPig.class
.
-
getSuperType
Description copied from class:EntityData
Returns a more general version of thisEntityData
with specific data removed.For example, calling this on
"a saddled pig"
would return"a pig"
. This is typically used to obtain the base entity type without any modifiers or traits.- Specified by:
getSuperType
in classEntityData<org.bukkit.entity.ThrownPotion>
- Returns:
- A generalized
EntityData
representing the base entity type.
-
isSupertypeOf
Description copied from class:EntityData
Determines whether thisEntityData
is a supertype of the givenentityData
.This is used to check whether the current entity data represents a broader category than another. For example:
if a zombie is a monster: # passes: "monster" is a supertype of "zombie" if a monster is a zombie: # fails: "zombie" is not a supertype of "monster"
- Specified by:
isSupertypeOf
in classEntityData<org.bukkit.entity.ThrownPotion>
- Parameters:
e
- TheEntityData
to compare against.- Returns:
true
if this is a supertype of the given entity data, otherwisefalse
.
-
toString
- Overrides:
toString
in classEntityData<org.bukkit.entity.ThrownPotion>
-
deserialize
Deprecated, for removal: This API element is subject to removal in a future version.- Overrides:
deserialize
in classEntityData<org.bukkit.entity.ThrownPotion>
-
equals_i
Description copied from class:EntityData
Internal helper forEntityData.equals(Object)
to compare the specific data of thisEntityData
with another.- Specified by:
equals_i
in classEntityData<org.bukkit.entity.ThrownPotion>
- Parameters:
obj
- TheEntityData
to compare with.- Returns:
true
if the data is considered equal, otherwisefalse
.
-
hashCode_i
protected int hashCode_i()Description copied from class:EntityData
Internal method used byEntityData.hashCode()
to include subclass-specific fields in the hash calculation for thisEntityData
.- Specified by:
hashCode_i
in classEntityData<org.bukkit.entity.ThrownPotion>
- Returns:
- A hash code representing subclass-specific data.
-