Class WorldDescriptionValue

java.lang.Object

ua.mcchickenstudio.opencreative.coding.values.EventValue

ua.mcchickenstudio.opencreative.coding.values.TextEventValue

ua.mcchickenstudio.opencreative.coding.values.world.WorldDescriptionValue

All Implemented Interfaces:

ExtensionContent

public final class WorldDescriptionValue
extends TextEventValue

Constructor Summary

Constructors

Constructor	Description
WorldDescriptionValue()

Method Summary

Modifier and Type	Method	Description
@NotNull String	getDescription()	Returns description of extension content.
@NotNull String	getExtensionId()	Returns lower-cased simple id of extension.
@Nullable String	getText(@NotNull ActionsHandler handler, @NotNull Action action, @Nullable org.bukkit.entity.Entity entity)	Returns a string that can be got from player, event, action, or null.

Methods inherited from class TextEventValue

getValue

Modifier and Type	Method	Description
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

Constructor Details

WorldDescriptionValue

public WorldDescriptionValue()

Method Details

getText

@Nullable
public @Nullable String getText(@NotNull
 @NotNull ActionsHandler handler,
 @NotNull
 @NotNull Action action,
 @Nullable
 @Nullable org.bukkit.entity.Entity entity)

Description copied from class: TextEventValue

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

Specified by:

getText in class TextEventValue

Returns:

string, or null.

getExtensionId

@NotNull
public @NotNull String getExtensionId()

Description copied from interface: ExtensionContent

Returns lower-cased simple id of extension. Will be used to identify author of content.

ID "default" is reserved for OpenCreative+ developers.

Returns:

id of extension.

getDescription

@NotNull
public @NotNull String getDescription()

Description copied from interface: ExtensionContent

Returns description of extension content. Describes purpose of new additional content.

Returns:

description of content.