Package io.github.thebusybiscuit.slimefun4.implementation.items.magical.talismans

Class Talisman

java.lang.Object

io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem

io.github.thebusybiscuit.slimefun4.implementation.items.magical.talismans.Talisman

All Implemented Interfaces:

Placeable

Direct Known Subclasses:

MagicianTalisman

public class Talisman
extends SlimefunItem

Field Summary

Fields

Modifier and Type	Field	Description
protected final boolean	cancel
protected final int	chance
protected final boolean	consumable
protected final PotionEffect[]	effects
protected final String	suffix
protected static final ItemGroup	TALISMANS_ITEMGROUP

Fields inherited from class io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem

addon, disenchantable, enchantable, hidden, recipeOutput, useableInWorkbench

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Talisman(ItemGroup itemGroup, SlimefunItemStack item, ItemStack[] recipe, boolean consumable, boolean cancelEvent, String messageSuffix, int chance, PotionEffect... effects)
	Talisman(SlimefunItemStack item, ItemStack[] recipe, boolean consumable, boolean cancelEvent, String messageSuffix, int chance, PotionEffect... effects)
	Talisman(SlimefunItemStack item, ItemStack[] recipe, boolean consumable, boolean cancelEvent, String messageSuffix, PotionEffect... effects)
	Talisman(SlimefunItemStack item, ItemStack[] recipe, String messageSuffix, int chance, PotionEffect... effects)

Method Summary

Modifier and Type	Method	Description
int	getChance()	This returns the chance of this Talisman activating.
PotionEffect[]	getEffects()
protected final String	getMessageSuffix()
boolean	isConsumable()	This returns whether the Talisman will be consumed upon use.
protected boolean	isEventCancelled()
boolean	isSilent()	This returns whether the Talisman is silent.
void	load()	This method is used for internal purposes only.
void	postRegister()	This method is called after SlimefunItem.register(SlimefunAddon).
void	sendMessage(Player p)	This method sends the given Player the message of this Talisman.
static boolean	trigger(Event e, SlimefunItem item)
static boolean	trigger(Event e, SlimefunItem item, boolean sendMessage)
static boolean	trigger(Event e, SlimefunItemStack stack)
static boolean	trigger(Event e, SlimefunItemStack stack, boolean sendMessage)

Methods inherited from class io.github.thebusybiscuit.slimefun4.api.items.SlimefunItem

addItemHandler, addItemSetting, addOfficialWikipage, callItemHandler, canUse, equals, error, getAddon, getBlockTicker, getById, getByItem, getDrops, getDrops, getHandlers, getId, getItem, getItemGroup, getItemName, getItemSetting, getItemSettings, getOptionalById, getOptionalByItem, getRecipe, getRecipeOutput, getRecipeType, getResearch, getState, getWikipage, hashCode, hasResearch, info, isDisabled, isDisabledIn, isDisenchantable, isEnchantable, isHidden, isItem, isItemStackImmutable, isTicking, isUseableInWorkbench, preRegister, register, sendDeprecationWarning, setHidden, setItemGroup, setRecipe, setRecipeOutput, setRecipeType, setResearch, setUseableInWorkbench, toString, warn

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.thebusybiscuit.slimefun4.core.attributes.Placeable

useVanillaBlockBreaking

Field Details

TALISMANS_ITEMGROUP

protected static final ItemGroup TALISMANS_ITEMGROUP

suffix

protected final String suffix

consumable

protected final boolean consumable

cancel

protected final boolean cancel

effects

protected final PotionEffect[] effects

chance

protected final int chance

Constructor Details

Talisman

@ParametersAreNonnullByDefault
public Talisman(SlimefunItemStack item,
 ItemStack[] recipe,
 boolean consumable,
 boolean cancelEvent,
 @Nullable
 String messageSuffix,
 PotionEffect... effects)

Talisman

@ParametersAreNonnullByDefault
public Talisman(SlimefunItemStack item,
 ItemStack[] recipe,
 @Nullable
 String messageSuffix,
 int chance,
 PotionEffect... effects)

Talisman

@ParametersAreNonnullByDefault
public Talisman(SlimefunItemStack item,
 ItemStack[] recipe,
 boolean consumable,
 boolean cancelEvent,
 @Nullable
 String messageSuffix,
 int chance,
 PotionEffect... effects)

Talisman

@ParametersAreNonnullByDefault
protected Talisman(ItemGroup itemGroup,
 SlimefunItemStack item,
 ItemStack[] recipe,
 boolean consumable,
 boolean cancelEvent,
 @Nullable
 String messageSuffix,
 int chance,
 PotionEffect... effects)

Method Details

isConsumable

public boolean isConsumable()

This returns whether the Talisman will be consumed upon use.

Returns:

Whether this Talisman is consumed on use.

getChance

public int getChance()

This returns the chance of this Talisman activating. The chance will be between 1 and 100.

Returns:

The chance of this Talisman activating.

getEffects

@Nonnull
public PotionEffect[] getEffects()

isEventCancelled

protected boolean isEventCancelled()

postRegister

public void postRegister()

Description copied from class: SlimefunItem

This method is called after SlimefunItem.register(SlimefunAddon). Override this method to add any additional setup that needs to happen after the original registration of this SlimefunItem.

Overrides:

postRegister in class SlimefunItem

load

public void load()

Description copied from class: SlimefunItem

This method is used for internal purposes only.

Overrides:

load in class SlimefunItem

trigger

@ParametersAreNonnullByDefault
public static boolean trigger(Event e,
 SlimefunItemStack stack)

trigger

@ParametersAreNonnullByDefault
public static boolean trigger(Event e,
 SlimefunItemStack stack,
 boolean sendMessage)

trigger

@ParametersAreNonnullByDefault
public static boolean trigger(Event e,
 SlimefunItem item)

trigger

@ParametersAreNonnullByDefault
public static boolean trigger(Event e,
 SlimefunItem item,
 boolean sendMessage)

isSilent

public boolean isSilent()

This returns whether the Talisman is silent. A silent Talisman will not send a message to a Player when activated.

Returns:

Whether this Talisman is silent

getMessageSuffix

@Nullable
protected final String getMessageSuffix()

sendMessage

public void sendMessage(@Nonnull
 Player p)

This method sends the given Player the message of this Talisman. Dependent on the selected config setting, the message will be sent via the actionbar or in the chat window.

Parameters:

p - The Player who shall receive the message