me.devnatan.inventoryframework.component

Interface ComponentBuilder<S extends ComponentBuilder<S,C>,C extends IFContext>

Type Parameters:

S - The reference of the component builder itself used as return type for method chaining.

All Known Subinterfaces:

ItemComponentBuilder<Self,Context>

public interface ComponentBuilder<S extends ComponentBuilder<S,C>,C extends IFContext>

Builder base for any Component implementation.

Method Summary

Modifier and Type	Method and Description
S	cancelOnClick() Determines whether an actor's click interaction event under this component should be canceled.
S	closeOnClick() Closes the current container when an actor interacts with this component.
S	copy() Returns a copy of this component builder.
S	displayIf(java.util.function.BooleanSupplier displayCondition) Only shows the component if a given condition is satisfied.
S	displayIf(java.util.function.Predicate<C> displayCondition) Only shows the component if a given condition is satisfied.
S	hideIf(java.util.function.BooleanSupplier condition) Hides the component if a given condition is satisfied.
S	hideIf(java.util.function.Predicate<C> condition) Hides the component if a given condition is satisfied.
S	referencedBy(@NotNull Ref<Component> reference) Assigns a reference to this component.
S	updateOnClick() Updates the current context when a player clicks on this component.
S	updateOnStateChange(@NotNull State<?> state) Listens for value updates in the specified state.
S	updateOnStateChange(@NotNull State<?> state, State<?>... states) Listens for value updates in any of the specified states.
S	watch(State<?>... states) Deprecated. Use updateOnStateChange(State) instead.
S	withData(@NotNull java.lang.String key, java.lang.Object value) Adds a new user-defined property to this component.
S	withExternallyManaged(boolean isExternallyManaged) This is an internal inventory-framework API that should not be used from outside of this library.

Method Detail

referencedBy

S referencedBy(@NotNull
               @NotNull Ref<Component> reference)

Assigns a reference to this component.

Parameters:

reference - Component reference key.

Returns:

This component builder.

See Also:

Refs API on Wiki

withData

S withData(@NotNull
           @NotNull java.lang.String key,
           java.lang.Object value)

Adds a new user-defined property to this component.

User-defined properties can be used to persist data that can be retrieved later even after several actions applied to that component.

An example of user-defined data persistence is for post-moving identification of a component inside the container, you can define a data in this item and as soon as the actor moves it the data will remain there, and you can use it any way you want.

Parameters:

key - The property key.

value - The property value.

Returns:

This component builder.

cancelOnClick

S cancelOnClick()

Determines whether an actor's click interaction event under this component should be canceled.

This method is a shortcut to:

 onClick(click -> click.setCancelled(!click.isCancelled());
 

Returns:

This component builder.

closeOnClick

S closeOnClick()

Closes the current container when an actor interacts with this component.

This function was created to support actions during closing to simplify code readability, it executes something and then closes or vice versa.

 closeOnClick().onClick(click -> ...)
 

This method is a shortcut to:

 onClick(IFContext::close);
 

Returns:

This component builder.

watch

@Deprecated
 @ApiStatus.ScheduledForRemoval(inVersion="3.2.0")
S watch(State<?>... states)

Deprecated. Use updateOnStateChange(State) instead.

Watches one or more states.

When any of the states provided as parameters are modified, the item generated from this builder will be updated.

Parameters:

states - The state to watch.

Returns:

This component builder.

updateOnStateChange

S updateOnStateChange(@NotNull
                      @NotNull State<?> state)

Listens for value updates in the specified state.

Everytime the value of the given state updates, this component will be updated as well.

Parameters:

state - The state to listen changes to.

Returns:

This component builder.

updateOnStateChange

S updateOnStateChange(@NotNull
                      @NotNull State<?> state,
                      State<?>... states)

Listens for value updates in any of the specified states.

Everytime the value ANY of the given state updates, this component will be updated as well.

Parameters:

state - The state to listen changes to.

states - Other states to listen changes to.

Returns:

This component builder.

copy

S copy()

Returns a copy of this component builder.

Returns:

A copy of this component builder.

withExternallyManaged

@ApiStatus.Internal
S withExternallyManaged(boolean isExternallyManaged)

This is an internal inventory-framework API that should not be used from outside of this library. No compatibility guarantees are provided.

updateOnClick

@ApiStatus.Experimental
S updateOnClick()

Updates the current context when a player clicks on this component.

This API is experimental and is not subject to the general compatibility guarantees such API may be changed or may be removed completely in any further release.

Returns:

This component builder.

displayIf

S displayIf(java.util.function.BooleanSupplier displayCondition)

Only shows the component if a given condition is satisfied.

Parameters:

displayCondition - Component display condition.

Returns:

This component builder.

See Also:

hideIf(BooleanSupplier)

displayIf

S displayIf(java.util.function.Predicate<C> displayCondition)

Only shows the component if a given condition is satisfied.

Parameters:

displayCondition - Component display condition.

Returns:

This component builder.

See Also:

hideIf(Predicate)

hideIf

S hideIf(java.util.function.BooleanSupplier condition)

Hides the component if a given condition is satisfied.

Parameters:

condition - Condition to hide the component.

Returns:

This component builder.

See Also:

displayIf(BooleanSupplier)

hideIf

S hideIf(java.util.function.Predicate<C> condition)

Hides the component if a given condition is satisfied.

Parameters:

condition - Condition to hide the component.

Returns:

This component builder.

See Also:

displayIf(Predicate)