Class LocationEventValue

java.lang.Object

ua.mcchickenstudio.opencreative.coding.values.EventValue

ua.mcchickenstudio.opencreative.coding.values.LocationEventValue

All Implemented Interfaces:

ExtensionContent

Direct Known Subclasses:

BedEventValue, BlockAboveValue, BlockBeneathValue, BlockLocationValue, EntityLocationValue, EyeLocationValue, HumanLastDeathLocationValue, PlayerCompassTargetValue, TargetBlockValue, TargetFluidValue, WorldSpawnValue

public abstract class LocationEventValue
extends EventValue

LocationEventValue

This class represents an event value, that returns location, or null.

Constructor Summary

Constructors

Constructor	Description
LocationEventValue(@NotNull String id, @NotNull org.bukkit.inventory.ItemStack displayIcon, @NotNull MenusCategory category)

Method Summary

Modifier and Type	Method	Description
abstract @Nullable org.bukkit.Location	getLocation(@NotNull ActionsHandler handler, @NotNull Action action, @Nullable org.bukkit.entity.Entity entity)	Returns a location that can be got from player, event, action, or null.
final @Nullable Object	getValue(@NotNull ActionsHandler handler, @NotNull Action action, @Nullable org.bukkit.entity.Entity entity)	Returns a value that will be set instead of event value name tag item.

Methods inherited from class EventValue

equals, getCategory, getDisplayIcon, getID, getLocaleName, getName, hashCode

Modifier and Type	Method	Description
boolean	equals(Object obj)
@NotNull MenusCategory	getCategory()	Returns a category, that event value belongs to.
@NotNull org.bukkit.inventory.ItemStack	getDisplayIcon()	Returns an icon that will be used in event values menus.
final @NotNull String	getID()	Returns id of event value, that will be used to find it in registry.
@NotNull String	getLocaleName()	Returns localized name of event value, that will be used in menus.
@NotNull String	getName()	Returns name of event value for displaying in registry by converting id.
int	hashCode()

Methods inherited from class Object

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

Methods inherited from interface ExtensionContent

getDescription, getExtensionId

Modifier and Type	Method	Description
@NotNull String	getDescription()	Returns description of extension content.
@NotNull String	getExtensionId()	Returns lower-cased simple id of extension.

Constructor Details

LocationEventValue

public LocationEventValue(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull org.bukkit.inventory.ItemStack displayIcon,
 @NotNull
 @NotNull MenusCategory category)

Method Details

getLocation

@Nullable
public abstract @Nullable org.bukkit.Location getLocation(@NotNull
 @NotNull ActionsHandler handler,
 @NotNull
 @NotNull Action action,
 @Nullable
 @Nullable org.bukkit.entity.Entity entity)

Returns a location that can be got from player, event, action, or null.

Returns:

location, or null.

getValue

@Nullable
public final @Nullable Object getValue(@NotNull
 @NotNull ActionsHandler handler,
 @NotNull
 @NotNull Action action,
 @Nullable
 @Nullable org.bukkit.entity.Entity entity)

Description copied from class: EventValue

Returns a value that will be set instead of event value name tag item.

Specified by:

getValue in class EventValue

Parameters:

handler - handler of action to get value.

action - action to get value.

entity - entity to get value, can be null.

Returns:

string, number, boolean, item, location, vector, or null.