Package studio.magemonkey.fabled.api.projectile

Class ParticleProjectile

java.lang.Object

org.bukkit.scheduler.BukkitRunnable

studio.magemonkey.fabled.api.projectile.CustomProjectile

studio.magemonkey.fabled.api.projectile.ParticleProjectile

All Implemented Interfaces:

Runnable, org.bukkit.metadata.Metadatable, Followable

public class ParticleProjectile
extends CustomProjectile

A fake projectile that plays particles along its path

Field Summary

Fields

Modifier and Type	Field	Description
protected double	correction
static final String	CORRECTION
static final String	DRAG	Settings key for the drag rate the projectile is subjected to
static final String	GRAVITY	Settings key for the gravity the projectile is subjected to
protected Supplier<org.bukkit.entity.LivingEntity>	homing
static final String	HOMING
static final String	HOMING_DIST
static final String	HOMING_TARGET
static final String	LEGACY_FREQUENCY	Deprecated. unintuitively named, now PERIOD is used instead
protected Consumer<org.bukkit.Location>	onStep
static final String	PERIOD	Settings key for the projectile's period for playing particles
static final String	RADIUS
static final String	REMEMBER
static final String	SPEED	Settings key for the projectile speed
static final String	STEPS	Settings key for the minimum projectile steps per meter
static final String	WALL

Fields inherited from class studio.magemonkey.fabled.api.projectile.CustomProjectile

ally, callback, enemy, settings

Constructor Summary

Constructors

Constructor	Description
ParticleProjectile(org.bukkit.entity.LivingEntity shooter, int level, org.bukkit.Location loc, Settings settings, int lifespan, int distance)	Constructor

Method Summary

Modifier and Type	Method	Description
protected org.bukkit.event.Event	expire()	Handles expiring due to range or leaving loaded chunks
protected double	getCollisionRadius()
org.bukkit.Location	getLocation()	Retrieves the location of the projectile
org.bukkit.Location	getStartLocation()
org.bukkit.util.Vector	getVelocity()
protected org.bukkit.event.Event	hit(org.bukkit.entity.LivingEntity entity)	Handles hitting an entity
protected org.bukkit.event.Event	land()	Handles landing on terrain
protected boolean	landed()
static List<ParticleProjectile>	rain(org.bukkit.entity.LivingEntity shooter, int level, org.bukkit.Location center, Settings settings, double radius, double height, int amount, ProjectileCallback callback, int lifespan, int distance)	Fires a spread of projectiles from the location.
void	run()	Updates the projectiles position and checks for collisions
void	setOnStep(Consumer<org.bukkit.Location> onStep)	Passes the current projectile's location to the consumer every step of the way
void	setVelocity(org.bukkit.util.Vector vel)	Sets the velocity of the projectile
static List<ParticleProjectile>	spread(org.bukkit.entity.LivingEntity shooter, int level, org.bukkit.util.Vector direction, org.bukkit.Location loc, Settings settings, double angle, int amount, ProjectileCallback callback, int lifespan, int distance)	Fires a spread of projectiles from the location.
void	teleport(org.bukkit.Location loc)	Teleports the projectile to a location

Methods inherited from class studio.magemonkey.fabled.api.projectile.CustomProjectile

applyLanded, calcRain, calcSpread, cancel, checkCollision, getMetadata, getShooter, hasMetadata, isTraveling, isValid, removeMetadata, setAllyEnemy, setCallback, setMetadata

Methods inherited from class org.bukkit.scheduler.BukkitRunnable

getTaskId, isCancelled, runTask, runTaskAsynchronously, runTaskLater, runTaskLaterAsynchronously, runTaskTimer, runTaskTimerAsynchronously

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

SPEED

public static final String SPEED

Settings key for the projectile speed

See Also:

• Constant Field Values

STEPS

public static final String STEPS

Settings key for the minimum projectile steps per meter

See Also:

• Constant Field Values

GRAVITY

public static final String GRAVITY

Settings key for the gravity the projectile is subjected to

See Also:

• Constant Field Values

DRAG

public static final String DRAG

Settings key for the drag rate the projectile is subjected to

See Also:

• Constant Field Values

PERIOD

public static final String PERIOD

Settings key for the projectile's period for playing particles

See Also:

• Constant Field Values

HOMING

public static final String HOMING

See Also:

• Constant Field Values

HOMING_TARGET

public static final String HOMING_TARGET

See Also:

• Constant Field Values

HOMING_DIST

public static final String HOMING_DIST

See Also:

• Constant Field Values

REMEMBER

public static final String REMEMBER

See Also:

• Constant Field Values

CORRECTION

public static final String CORRECTION

See Also:

• Constant Field Values

WALL

public static final String WALL

See Also:

• Constant Field Values

RADIUS

public static final String RADIUS

See Also:

• Constant Field Values

LEGACY_FREQUENCY

@Deprecated
public static final String LEGACY_FREQUENCY

Deprecated.

unintuitively named, now PERIOD is used instead

Settings key for the projectile's frequency of playing particles

See Also:

• Constant Field Values

onStep

protected Consumer<org.bukkit.Location> onStep

homing

protected Supplier<org.bukkit.entity.LivingEntity> homing

correction

protected double correction

Constructor Details

ParticleProjectile

public ParticleProjectile(org.bukkit.entity.LivingEntity shooter,
 int level,
 org.bukkit.Location loc,
 Settings settings,
 int lifespan,
 int distance)

Constructor

Parameters:

shooter - entity that shot the projectile

level - level to use for scaling the speed

loc - initial location of the projectile

settings - settings for the projectile

Method Details

getLocation

public org.bukkit.Location getLocation()

Retrieves the location of the projectile

Specified by:

getLocation in interface Followable

Specified by:

getLocation in class CustomProjectile

Returns:

location of the projectile

getStartLocation

public org.bukkit.Location getStartLocation()

expire

protected org.bukkit.event.Event expire()

Handles expiring due to range or leaving loaded chunks

Specified by:

expire in class CustomProjectile

land

protected org.bukkit.event.Event land()

Handles landing on terrain

Specified by:

land in class CustomProjectile

hit

protected org.bukkit.event.Event hit(org.bukkit.entity.LivingEntity entity)

Handles hitting an entity

Specified by:

hit in class CustomProjectile

Parameters:

entity - entity the projectile hit

landed

protected boolean landed()

Specified by:

landed in class CustomProjectile

Returns:

true if passing through a solid block, false otherwise

getCollisionRadius

protected double getCollisionRadius()

Specified by:

getCollisionRadius in class CustomProjectile

Returns:

squared radius for colliding

getVelocity

public org.bukkit.util.Vector getVelocity()

Specified by:

getVelocity in class CustomProjectile

Returns:

velocity of the projectile

teleport

public void teleport(org.bukkit.Location loc)

Teleports the projectile to a location

Parameters:

loc - location to teleport to

setVelocity

public void setVelocity(org.bukkit.util.Vector vel)

Sets the velocity of the projectile

Specified by:

setVelocity in class CustomProjectile

Parameters:

vel - new velocity

setOnStep

public void setOnStep(Consumer<org.bukkit.Location> onStep)

Passes the current projectile's location to the consumer every step of the way

Parameters:

onStep - the consumer the location is passed to

run

public void run()

Updates the projectiles position and checks for collisions

spread

public static List<ParticleProjectile> spread(org.bukkit.entity.LivingEntity shooter,
 int level,
 org.bukkit.util.Vector direction,
 org.bukkit.Location loc,
 Settings settings,
 double angle,
 int amount,
 ProjectileCallback callback,
 int lifespan,
 int distance)

Fires a spread of projectiles from the location.

Parameters:

shooter - entity shooting the projectiles

level - level to use for scaling the speed

direction - the center direction of the spread

loc - location to shoot from

settings - settings to use when firing

angle - angle of the spread

amount - number of projectiles to fire

callback - optional callback for when projectiles hit

lifespan - lifespan of the projectile

distance - distance the projectile can travel

Returns:

list of fired projectiles

rain

public static List<ParticleProjectile> rain(org.bukkit.entity.LivingEntity shooter,
 int level,
 org.bukkit.Location center,
 Settings settings,
 double radius,
 double height,
 int amount,
 ProjectileCallback callback,
 int lifespan,
 int distance)

Fires a spread of projectiles from the location.

Parameters:

shooter - entity shooting the projectiles

level - level to use for scaling the speed

center - the center location to rain on

settings - settings to use when firing

radius - radius of the circle

height - height above the center location

amount - number of projectiles to fire

callback - optional callback for when projectiles hit

lifespan - lifespan of the projectile

distance - distance the projectile can travel

Returns:

list of fired projectiles