IOptiGuiApi

interface IOptiGuiApi(source)

The core OptiGUI API.

Functions

Link copied to clipboard
abstract fun addRetexturableScreen(@NotNull screenClass: @NotNull Class<out Screen>)
Marks the given class and all of its subclasses as retexturable.
Link copied to clipboard
@Nullable
abstract fun <T : BlockEntity?> getBlockEntityProcessor(@NotNull type: @NotNull Class<@NotNull T>): @Nullable IBlockEntityProcessor<@NotNull T>
Finds the registered block entity processor for the given block entity class.
Link copied to clipboard
@Nullable
abstract fun getContainerTexture(@NotNull container: @NotNull Identifier): @Nullable Identifier
Returns the container's inventory screen texture.
Link copied to clipboard
@Nullable
abstract fun <T : Entity?> getEntityProcessor(@NotNull type: @NotNull Class<@NotNull T>): @Nullable IEntityProcessor<@NotNull T>
Finds the registered entity processor for the given entity class.
Link copied to clipboard
@NotNull
open fun getImplementation(): @NotNull IOptiGuiApi
Returns the implementation of IOptiGuiApi.
Link copied to clipboard
@NotNull
abstract fun getImplementationModId(): @NotNull String
Returns the ID of the mod, which provides OptiGUI implementation.
Link copied to clipboard
@NotNull
abstract fun getInteractionInspector(): @NotNull IInspector
Returns the implementation of {@see IInspector}.
Link copied to clipboard
@NotNull
abstract fun getInteractor(): @NotNull IInteractor
Returns the implementation of {@see IInteractor}.
Link copied to clipboard
abstract fun isAvailable(): Boolean
Tells whether the OptiGUI implementation is loaded or not.
Link copied to clipboard
abstract fun isScreenRetexturable(@NotNull screen: @NotNull Screen): Boolean
Returns if the screen's texture is allowed to be changed.