Package me.gamercoder215.starcosmetics.api.cosmetics.trail

Interface Trail<T>

Type Parameters:

T - Trail Object Type (Item Trails, Entity Trails, etc.)

All Superinterfaces:

Cosmetic

public interface Trail<T>
extends Cosmetic

Represents a StarCosmetics Trail

Method Summary

Modifier and Type	Method	Description
@NotNull Class<T>	getObjectType()	Fetches the type of the object used in the trail.
@NotNull TrailType	getType()	Fetches the type of this trail.
void	run(@NotNull Entity en, CosmeticLocation<?> loc)	Runs a CosmeticLocation based on this parent.
default void	run(Location l, CosmeticLocation<?> cloc)	Deprecated. use run(Entity, CosmeticLocation)

Methods inherited from interface me.gamercoder215.starcosmetics.api.cosmetics.Cosmetic

getDisplayName, getIcon, getNamespace

Method Details

getObjectType

@NotNull
@NotNull Class<T> getObjectType()

Fetches the type of the object used in the trail.

Returns:

Trail Object Type (Particle, Material, etc)

getType

@NotNull
@NotNull TrailType getType()

Fetches the type of this trail.

Returns:

Trail Type

run

void run(@NotNull
 @NotNull Entity en,
 CosmeticLocation<?> loc)

Runs a CosmeticLocation based on this parent.

Parameters:

en - Entity to use

loc - CosmeticLocation to use

run

@Deprecated
default void run(Location l,
 CosmeticLocation<?> cloc)

Deprecated.

use run(Entity, CosmeticLocation)

Description copied from interface: Cosmetic

Runs a CosmeticLocation based on this parent.

Note: Some implementations of this interface have this method deprecated in favor of the first parameter being Entity or a sub-interface. Casting when running this method is recommended.

Specified by:

run in interface Cosmetic

Parameters:

l - Bukkit Location to use at (not necessary for some Cosmetics)

cloc - CosmeticLocation to input