net.minecraftforge.common.extensions

インタフェース IForgeEffect

既知の実装クラスのリスト:

AbsorptionEffect, AttackDamageEffect, Effect, HealthBoostEffect, InstantEffect

public interface IForgeEffect

メソッドのサマリー

修飾子とタイプ	メソッドと説明
default java.util.List<ItemStack>	getCurativeItems() Get a fresh list of items that can cure this Potion.
default Effect	getEffect()
default int	getGuiSortColor(EffectInstance potionEffect) Used for determining PotionEffect sort order in GUIs.
default void	renderHUDEffect(EffectInstance effect, AbstractGui gui, int x, int y, float z, float alpha) Called to draw the this Potion onto the player's ingame HUD when it's active.
default void	renderInventoryEffect(EffectInstance effect, DisplayEffectsScreen<?> gui, int x, int y, float z) Called to draw the this Potion onto the player's inventory when it's active.
default boolean	shouldRender(EffectInstance effect) If the Potion effect should be displayed in the players inventory
default boolean	shouldRenderHUD(EffectInstance effect) If the Potion effect should be displayed in the player's ingame HUD
default boolean	shouldRenderInvText(EffectInstance effect) If the standard PotionEffect text (name and duration) should be drawn when this potion is active.

メソッドの詳細

getEffect

default Effect getEffect()

shouldRender

default boolean shouldRender(EffectInstance effect)

If the Potion effect should be displayed in the players inventory

パラメータ:

effect - the active PotionEffect

戻り値:

true to display it (default), false to hide it.

shouldRenderInvText

default boolean shouldRenderInvText(EffectInstance effect)

If the standard PotionEffect text (name and duration) should be drawn when this potion is active.

パラメータ:

effect - the active PotionEffect

戻り値:

true to draw the standard text

shouldRenderHUD

default boolean shouldRenderHUD(EffectInstance effect)

If the Potion effect should be displayed in the player's ingame HUD

パラメータ:

effect - the active PotionEffect

戻り値:

true to display it (default), false to hide it.

renderInventoryEffect

default void renderInventoryEffect(EffectInstance effect,
                                   DisplayEffectsScreen<?> gui,
                                   int x,
                                   int y,
                                   float z)

Called to draw the this Potion onto the player's inventory when it's active. This can be used to e.g. render Potion icons from your own texture.

パラメータ:

effect - the active PotionEffect

gui - the gui instance

x - the x coordinate

y - the y coordinate

z - the z level

renderHUDEffect

default void renderHUDEffect(EffectInstance effect,
                             AbstractGui gui,
                             int x,
                             int y,
                             float z,
                             float alpha)

Called to draw the this Potion onto the player's ingame HUD when it's active. This can be used to e.g. render Potion icons from your own texture.

パラメータ:

effect - the active PotionEffect

gui - the gui instance

x - the x coordinate

y - the y coordinate

z - the z level

alpha - the alpha value, blinks when the potion is about to run out

getCurativeItems

default java.util.List<ItemStack> getCurativeItems()

Get a fresh list of items that can cure this Potion. All new PotionEffects created from this Potion will call this to initialize the default curative items

戻り値:

A list of items that can cure this Potion

関連項目:

PotionEffect#getCurativeItems

getGuiSortColor

default int getGuiSortColor(EffectInstance potionEffect)

Used for determining PotionEffect sort order in GUIs. Defaults to the PotionEffect's liquid color.

パラメータ:

potionEffect - the PotionEffect instance containing the potion

戻り値:

a value used to sort PotionEffects in GUIs