程序包 net.minecraftforge.client.event

类 RegisterGuiOverlaysEvent

java.lang.Object

net.minecraftforge.eventbus.api.Event

net.minecraftforge.client.event.RegisterGuiOverlaysEvent

所有已实现的接口:

net.minecraftforge.fml.event.IModBusEvent

public class RegisterGuiOverlaysEvent
extends net.minecraftforge.eventbus.api.Event
implements net.minecraftforge.fml.event.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.

嵌套类概要

嵌套类

修饰符和类型	类	说明
private static enum	RegisterGuiOverlaysEvent.Ordering

从类继承的嵌套类/接口 net.minecraftforge.eventbus.api.Event

net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result

字段概要

字段

修饰符和类型	字段	说明
private final List<ResourceLocation>	orderedOverlays
private final Map<ResourceLocation,IGuiOverlay>	overlays

构造器概要

构造器

构造器	说明
RegisterGuiOverlaysEvent(Map<ResourceLocation,IGuiOverlay> overlays, List<ResourceLocation> orderedOverlays)

方法概要

修饰符和类型	方法	说明
private void	register(@NotNull RegisterGuiOverlaysEvent.Ordering ordering, @Nullable ResourceLocation other, @NotNull String id, @NotNull IGuiOverlay overlay)
void	registerAbove(@NotNull ResourceLocation other, @NotNull String id, @NotNull IGuiOverlay overlay)	Registers an overlay that renders above another.
void	registerAboveAll(@NotNull String id, @NotNull IGuiOverlay overlay)	Registers an overlay that renders above all others.
void	registerBelow(@NotNull ResourceLocation other, @NotNull String id, @NotNull IGuiOverlay overlay)	Registers an overlay that renders below another.
void	registerBelowAll(@NotNull String id, @NotNull IGuiOverlay overlay)	Registers an overlay that renders below all others.

从类继承的方法 net.minecraftforge.eventbus.api.Event

getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

overlays

private final Map<ResourceLocation,IGuiOverlay> overlays

orderedOverlays

private final List<ResourceLocation> orderedOverlays

构造器详细资料

RegisterGuiOverlaysEvent

@Internal
public RegisterGuiOverlaysEvent(Map<ResourceLocation,IGuiOverlay> overlays,
 List<ResourceLocation> orderedOverlays)

方法详细资料

registerBelowAll

public void registerBelowAll(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull IGuiOverlay overlay)

Registers an overlay that renders below all others.

参数:

id - A unique resource id for this overlay

overlay - 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.

参数:

other - The id of the overlay to render below. This must be an overlay you have already registered or a vanilla overlay. Do not use other mods' overlays.

id - A unique resource id for this overlay

overlay - 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.

参数:

other - The id of the overlay to render above. This must be an overlay you have already registered or a vanilla overlay. Do not use other mods' overlays.

id - A unique resource id for this overlay

overlay - The overlay

registerAboveAll

public void registerAboveAll(@NotNull
 @NotNull String id,
 @NotNull
 @NotNull IGuiOverlay overlay)

Registers an overlay that renders above all others.

参数:

id - A unique resource id for this overlay

overlay - The overlay

register

private void register(@NotNull
 @NotNull RegisterGuiOverlaysEvent.Ordering ordering,
 @Nullable
 @Nullable ResourceLocation other,
 @NotNull
 @NotNull String id,
 @NotNull
 @NotNull IGuiOverlay overlay)