Package net.minecraftforge.client.event
Class RegisterGuiOverlaysEvent
java.lang.Object
net.minecraftforge.eventbus.api.Event
net.minecraftforge.client.event.RegisterGuiOverlaysEvent
- All Implemented Interfaces:
IModBusEvent
public class RegisterGuiOverlaysEvent
extends net.minecraftforge.eventbus.api.Event
implements IModBusEvent
Allows users to register custom
GUI overlays.
This event is not cancellable, and does not have a result.
This event is fired on the mod-specific event bus, only on the logical client.
-
Nested Class Summary
Nested ClassesNested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event
net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate final List<ResourceLocation>private final Map<ResourceLocation,IGuiOverlay> -
Constructor Summary
ConstructorsConstructorDescriptionRegisterGuiOverlaysEvent(Map<ResourceLocation, IGuiOverlay> overlays, List<ResourceLocation> orderedOverlays) -
Method Summary
Modifier and TypeMethodDescriptionprivate voidregister(@NotNull RegisterGuiOverlaysEvent.Ordering ordering, @Nullable ResourceLocation other, @NotNull String id, @NotNull IGuiOverlay overlay) voidregisterAbove(@NotNull ResourceLocation other, @NotNull String id, @NotNull IGuiOverlay overlay) Registers an overlay that renders above another.voidregisterAboveAll(@NotNull String id, @NotNull IGuiOverlay overlay) Registers an overlay that renders above all others.voidregisterBelow(@NotNull ResourceLocation other, @NotNull String id, @NotNull IGuiOverlay overlay) Registers an overlay that renders below another.voidregisterBelowAll(@NotNull String id, @NotNull IGuiOverlay overlay) Registers an overlay that renders below all others.Methods inherited from class net.minecraftforge.eventbus.api.Event
getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult
-
Field Details
-
overlays
-
orderedOverlays
-
-
Constructor Details
-
RegisterGuiOverlaysEvent
@Internal public RegisterGuiOverlaysEvent(Map<ResourceLocation, IGuiOverlay> overlays, List<ResourceLocation> orderedOverlays)
-
-
Method Details
-
registerBelowAll
Registers an overlay that renders below all others.- Parameters:
id- A unique resource id for this overlayoverlay- The overlay
-
registerBelow
public void registerBelow(@NotNull @NotNull ResourceLocation other, @NotNull @NotNull String id, @NotNull @NotNull IGuiOverlay overlay) Registers an overlay that renders below another.- Parameters:
other- The id of the overlay to render below. This must be an overlay you have already registered or avanilla overlay. Do not use other mods' overlays.id- A unique resource id for this overlayoverlay- The overlay
-
registerAbove
public void registerAbove(@NotNull @NotNull ResourceLocation other, @NotNull @NotNull String id, @NotNull @NotNull IGuiOverlay overlay) Registers an overlay that renders above another.- Parameters:
other- The id of the overlay to render above. This must be an overlay you have already registered or avanilla overlay. Do not use other mods' overlays.id- A unique resource id for this overlayoverlay- The overlay
-
registerAboveAll
Registers an overlay that renders above all others.- Parameters:
id- A unique resource id for this overlayoverlay- The overlay
-
register
private void register(@NotNull @NotNull RegisterGuiOverlaysEvent.Ordering ordering, @Nullable @Nullable ResourceLocation other, @NotNull @NotNull String id, @NotNull @NotNull IGuiOverlay overlay)
-