Package me.keehl.elevators.api.models.settings

Interface IBuilderElevatorSetting<T>

All Superinterfaces:

IElevatorSetting<T>

public interface IBuilderElevatorSetting<T>
extends IElevatorSetting<T>

Method Summary

Modifier and Type	Method	Description
@NotNull IElevatorSetting<T>	addAction(@NotNull java.lang.String action, @NotNull java.lang.String description)	Adds an informational UI action line to this setting's icon/lore.
boolean	canBeEditedIndividually(@NotNull IElevator elevator)	Returns whether this setting supports per-elevator (individual) editing for the given elevator.
T	getGlobalValue(@NotNull IElevatorType apiElevatorType)	Returns the global value of this setting for the given elevator type.
void	onClickGlobal(@NotNull org.bukkit.entity.Player player, @NotNull IElevatorType apiElevatorType, @NotNull java.lang.Runnable returnMethod, @NotNull org.bukkit.event.inventory.InventoryClickEvent clickEvent, T currentValue)	Called when the setting is clicked in a global context, with the current global value already provided.
void	onClickIndividual(@NotNull org.bukkit.entity.Player player, @NotNull IElevator elevator, @NotNull java.lang.Runnable returnMethod, @NotNull org.bukkit.event.inventory.InventoryClickEvent clickEvent, T currentValue)	Called when the setting is clicked in an individual context, with the current individual value already provided.

Methods inherited from interface me.keehl.elevators.api.models.IElevatorSetting

clickGlobal, clickIndividual, createIcon, getIndividualValue, getPlugin, getSettingName, isSettingGlobalOnly, setIndividualValue

Method Detail

canBeEditedIndividually

boolean canBeEditedIndividually(@NotNull
                                @NotNull IElevator elevator)

Description copied from interface: IElevatorSetting

Returns whether this setting supports per-elevator (individual) editing for the given elevator.

If this returns false, the setting is effectively global-only for that elevator.

Specified by:

canBeEditedIndividually in interface IElevatorSetting<T>

Parameters:

elevator - non-null elevator context

Returns:

true if per-elevator editing is supported; otherwise false

onClickGlobal

void onClickGlobal(@NotNull
                   @NotNull org.bukkit.entity.Player player,
                   @NotNull
                   @NotNull IElevatorType apiElevatorType,
                   @NotNull
                   @NotNull java.lang.Runnable returnMethod,
                   @NotNull
                   @NotNull org.bukkit.event.inventory.InventoryClickEvent clickEvent,
                   @NotNull
                   T currentValue)

Description copied from interface: IElevatorSetting

Called when the setting is clicked in a global context, with the current global value already provided.

Specified by:

onClickGlobal in interface IElevatorSetting<T>

Parameters:

player - non-null clicking player

apiElevatorType - non-null elevator type being edited

returnMethod - non-null callback to return to the previous UI

clickEvent - non-null inventory click event

currentValue - current global value

onClickIndividual

void onClickIndividual(@NotNull
                       @NotNull org.bukkit.entity.Player player,
                       @NotNull
                       @NotNull IElevator elevator,
                       @NotNull
                       @NotNull java.lang.Runnable returnMethod,
                       @NotNull
                       @NotNull org.bukkit.event.inventory.InventoryClickEvent clickEvent,
                       @NotNull
                       T currentValue)

Description copied from interface: IElevatorSetting

Called when the setting is clicked in an individual context, with the current individual value already provided.

Specified by:

onClickIndividual in interface IElevatorSetting<T>

Parameters:

player - non-null clicking player

elevator - non-null elevator being edited

returnMethod - non-null callback to return to the previous UI

clickEvent - non-null inventory click event

currentValue - current individual value

getGlobalValue

@NotNull
T getGlobalValue(@NotNull
                 @NotNull IElevatorType apiElevatorType)

Description copied from interface: IElevatorSetting

Returns the global value of this setting for the given elevator type.

Specified by:

getGlobalValue in interface IElevatorSetting<T>

Parameters:

apiElevatorType - non-null elevator type context

Returns:

the global value (implementations should not return null unless explicitly documented)

addAction

@NotNull
@NotNull IElevatorSetting<T> addAction(@NotNull
                                       @NotNull java.lang.String action,
                                       @NotNull
                                       @NotNull java.lang.String description)

Description copied from interface: IElevatorSetting

Adds an informational UI action line to this setting's icon/lore.

This does not change the setting value; it only affects the generated icon lore.

Specified by:

addAction in interface IElevatorSetting<T>

Parameters:

action - non-null action label (e.g., "LEFT-CLICK")

description - non-null action description

Returns:

this setting instance (for chaining)