Package net.neoforged.neoforge.client.event

@ParametersAreNonnullByDefault package net.neoforged.neoforge.client.event

Events fired only on the client-side, chiefly related to rendering and user interfaces (screens and input).

Related Packages

Package	Description
net.neoforged.neoforge.client
net.neoforged.neoforge.client.event.lifecycle
net.neoforged.neoforge.client.event.sound	Client-only events relating to sounds.

Class	Description
AddClientReloadListenersEvent	This event allows mods to register client-side reload listeners to the resource manager.
AddSectionGeometryEvent	This event can be used to add static geometry to chunk sections.
AddSectionGeometryEvent.AdditionalSectionRenderer	A rendering callback that will be invoked during chunk meshing.
AddSectionGeometryEvent.SectionRenderingContext
CalculateDetachedCameraDistanceEvent	Fired for hooking the maximum distance from the player to the camera in third-person view.
CalculatePlayerTurnEvent	Fired in invalid reference MouseHandler#turnPlayer() when retrieving the values of mouse sensitivity and cinematic camera, prior to running calculations on these values.
ClientChatEvent	Fired when the client is about to send a chat message to the server.
ClientChatReceivedEvent	Fired when a chat message is received on the client.
ClientChatReceivedEvent.Player	Fired when a player chat message is received on the client.
ClientChatReceivedEvent.System	Fired when a system chat message is received on the client.
ClientPauseChangeEvent	Fired when game pause state is about to change
ClientPauseChangeEvent.Post	Fired when pause is already changed
ClientPauseChangeEvent.Pre	Fired when pause is going to change
ClientPlayerChangeGameTypeEvent	Fired when the client player is notified of a change of GameType from the server.
ClientPlayerNetworkEvent	Fired for different client connectivity events.
ClientPlayerNetworkEvent.Clone	Fired when the client player respawns, creating a new player instance to replace the old player instance.
ClientPlayerNetworkEvent.LoggingIn	Fired when the client player logs in to the server.
ClientPlayerNetworkEvent.LoggingOut	Fired when the client player logs out.
ClientResourceLoadFinishedEvent	Fires after the client has completed loading or reloading its resources successfully.
ClientTickEvent	Base class of the two client tick events.
ClientTickEvent.Post	ClientTickEvent.Post is fired once per client tick, after the client performs work for the current tick.
ClientTickEvent.Pre	ClientTickEvent.Pre is fired once per client tick, before the client performs work for the current tick.
ComputeFovModifierEvent	Fired after the field of vision (FOV) modifier for the player is calculated to allow developers to adjust it further.
ConfigureGpuDeviceEvent	Fired during GpuDevice creation to allow optional features to be enabled.
ConfigureMainRenderTargetEvent	Fired when configuring the main render target during startup.
ContainerScreenEvent	Fired for hooking into AbstractContainerScreen events.
ContainerScreenEvent.Render	Fired every time an AbstractContainerScreen renders.
ContainerScreenEvent.Render.Foreground	Fired after the container screen's foreground layer and elements are drawn, but before rendering the tooltips and the item stack being dragged by the player.
CustomizeGuiOverlayEvent	Fired when an overlay is about to be rendered to the screen to allow the user to modify it.
CustomizeGuiOverlayEvent.BossEventProgress	Fired before a boss health bar is rendered to the screen.
CustomizeGuiOverlayEvent.Chat	Fired before the chat messages overlay is rendered to the screen.
EntityRenderersEvent	Fired for on different events/actions relating to entity renderers.
EntityRenderersEvent.AddLayers	Fired for registering entity renderer layers at the appropriate time, after the entity and player renderers maps have been created.
EntityRenderersEvent.CreateSkullModels	Fired for registering additional skull models.
EntityRenderersEvent.RegisterLayerDefinitions	Fired for registering layer definitions at the appropriate time.
EntityRenderersEvent.RegisterRenderers	Fired for registering entity and block entity renderers at the appropriate time.
ExtractBlockOutlineRenderStateEvent	Fired after the BlockOutlineRenderState is extracted.
ExtractLevelRenderStateEvent	Fired when the LevelRenderer extracts level render state, after all vanilla states have been extracted.
FrameGraphSetupEvent	Fired when the frame graph is set up at the start of level rendering, right before the vanilla frame passes are set up.
GatherEffectScreenTooltipsEvent	This event is called when EffectsInInventory draws the tooltip lines for a hovered MobEffectInstance in an AbstractContainerScreen.
InitializeClientRegistriesEvent	Fired during Minecraft initialization and datagen startup to allow initializing custom client-only "registries".
InputEvent	Fired when an input is detected from the user's input devices.
InputEvent.InteractionKeyMappingTriggered	Fired when a keymapping that by default involves clicking the mouse buttons is triggered.
InputEvent.Key	Fired when a keyboard key input occurs, such as pressing, releasing, or repeating a key.
InputEvent.MouseButton	Fired when a mouse button is pressed/released.
InputEvent.MouseButton.Post	Fired when a mouse button is pressed/released, after processing.
InputEvent.MouseButton.Pre	Fired when a mouse button is pressed/released, before being processed by vanilla.
InputEvent.MouseScrollingEvent	Fired when a mouse scroll wheel is used outside of a screen and a player is loaded, before being processed by vanilla.
ModelEvent	Houses events related to models.
ModelEvent.BakingCompleted	Fired when the ModelManager is notified of the resource manager reloading.
ModelEvent.ModifyBakingResult	Fired while the ModelManager is reloading models, after the model registry is set up, but before it's passed to the BlockModelShaper for caching.
ModelEvent.RegisterLoaders	Allows users to register their own unbaked model loaders for use in block/item models.
ModelEvent.RegisterStandalone	Fired when the ModelDiscovery is notified of dependency discovery of its top models.
MovementInputUpdateEvent	Fired after the player's movement inputs are updated.
PlayerHeartTypeEvent	Fired by Gui.HeartType.forPlayer(net.minecraft.world.entity.player.Player) to allow mods to change the heart sprite which is displayed in the player's health bar.
RecipesReceivedEvent	This event is fired on the client when it has finished receiving recipe data from the server.
RegisterBlockStateModels	Fire to register new types of CustomUnbakedBlockStateModel and CustomBlockModelDefinition.
RegisterClientCommandsEvent	Fired to allow mods to register client commands.
RegisterClientTooltipComponentFactoriesEvent	Allows users to register custom ClientTooltipComponent factories for their TooltipComponent types.
RegisterColorHandlersEvent	Fired for registering block and item color handlers at the appropriate time.
RegisterColorHandlersEvent.Block	Fired for registering block color handlers.
RegisterColorHandlersEvent.ColorResolvers	Allows registration of custom ColorResolver implementations to be used with BlockAndTintGetter.getBlockTint(BlockPos, ColorResolver).
RegisterColorHandlersEvent.ItemTintSources	Fired for registering item color handlers.
RegisterConditionalItemModelPropertyEvent	Event fired when special model renderers are registered.
RegisterDebugEntriesEvent	Event fired when debug entries are registered.
RegisterDimensionSpecialEffectsEvent	Allows users to register custom DimensionSpecialEffects for their dimensions.
RegisterDimensionTransitionScreenEvent	Event for registering screen effects when transitioning across dimensions.
RegisterEntitySpectatorShadersEvent	Allows users to register custom shaders to be used when the player spectates a certain kind of entity.
RegisterGuiLayersEvent	Allows users to register custom layers for GUI rendering.
RegisterGuiLayersEvent.Ordering
RegisterItemDecorationsEvent	Allows users to register custom IItemDecorator to Items.
RegisterItemModelsEvent	Event fired when item models are registered.
RegisterJsonAnimationTypesEvent	Allows registering custom AnimationTargets and interpolation functions for loading JSON entity animation files.
RegisterKeyMappingsEvent	Allows users to register custom key mappings and key mapping categories.
RegisterMenuScreensEvent
RegisterNamedRenderTypesEvent	Allows users to register custom named render types.
RegisterParticleGroupsEvent	Fired for registering additional particle group factories.
RegisterParticleProvidersEvent	Fired for registering particle providers at the appropriate time.
RegisterPictureInPictureRenderersEvent	Event to register custom PictureInPictureRenderers for specialized rendering in UIs.
RegisterPresetEditorsEvent	Event for registering PresetEditor screen factories for world presets.
RegisterRangeSelectItemModelPropertyEvent	Event fired when special model renderers are registered.
RegisterRecipeBookSearchCategoriesEvent	Event to register ExtendedRecipeBookCategory instances for search.
RegisterRenderBuffersEvent	Fired to allow mods to register custom render buffers.
RegisterRenderPipelinesEvent	Fired to allow mods to register custom pipelines.
RegisterSelectItemModelPropertyEvent	Event fired when item model property selectors are registered.
RegisterSpecialBlockModelRendererEvent	Event fired when special block model renderers are created.
RegisterSpecialModelRendererEvent	Event fired when special model renderers are registered.
RegisterSpriteSourcesEvent	Fired to allow mods to register their own SpriteSource codecs.
RegisterTextureAtlasesEvent	Fired for registering texture atlases to the AtlasManager.
RenderArmEvent	Fired before the player's arm is rendered in first person.
RenderBlockScreenEffectEvent	Fired before a block texture will be overlaid on the player's view.
RenderBlockScreenEffectEvent.OverlayType	The type of the block overlay to be rendered.
RenderFrameEvent	Base class of the two render frame events.
RenderFrameEvent.Post	RenderFrameEvent.Post is fired once per frame, after the current frame is rendered via invalid reference GameRenderer#render(float, long, boolean) .
RenderFrameEvent.Pre	RenderFrameEvent.Pre is fired once per frame, before the current frame is rendered via invalid reference GameRenderer#render(float, long, boolean) .
RenderGuiEvent	Fired when the HUD is rendered to the screen.
RenderGuiEvent.Post	Fired after the HUD is rendered to the screen, if the corresponding RenderGuiEvent.Pre is not cancelled.
RenderGuiEvent.Pre	Fired before the HUD is rendered to the screen.
RenderGuiLayerEvent	Fired when a GUI layer is rendered to the screen.
RenderGuiLayerEvent.Post	Fired after a GUI layer is rendered to the screen, if the corresponding RenderGuiLayerEvent.Pre is not cancelled.
RenderGuiLayerEvent.Pre	Fired before a GUI layer is rendered to the screen.
RenderHandEvent	Fired before a hand is rendered in the first person view.
RenderItemInFrameEvent	Fired before an item stack is rendered in an item frame.
RenderLevelStageEvent	Fires at various times during LevelRenderer.renderLevel(com.mojang.blaze3d.resource.GraphicsResourceAllocator, net.minecraft.client.DeltaTracker, boolean, net.minecraft.client.Camera, org.joml.Matrix4f, org.joml.Matrix4f, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, org.joml.Vector4f, boolean) and GameRenderer.renderLevel(net.minecraft.client.DeltaTracker).
RenderLevelStageEvent.AfterEntities	Fired within LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after entities and block entities have been rendered.
RenderLevelStageEvent.AfterLevel	Fired within GameRenderer.renderLevel(net.minecraft.client.DeltaTracker) after LevelRenderer.renderLevel(com.mojang.blaze3d.resource.GraphicsResourceAllocator, net.minecraft.client.DeltaTracker, boolean, net.minecraft.client.Camera, org.joml.Matrix4f, org.joml.Matrix4f, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, org.joml.Vector4f, boolean) is called.
RenderLevelStageEvent.AfterOpaqueBlocks	Fired early in LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after solid and cutout chunk geometry has been rendered.
RenderLevelStageEvent.AfterParticles	Fired at the end of LevelRenderer.addParticlesPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, com.mojang.blaze3d.buffers.GpuBufferSlice) after particles have been rendered.
RenderLevelStageEvent.AfterSky	Fired at the end of LevelRenderer.addSkyPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.Camera, com.mojang.blaze3d.buffers.GpuBufferSlice) after the sky has been rendered.
RenderLevelStageEvent.AfterTranslucentBlocks	Fired within LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after translucent chunk geometry has been rendered.
RenderLevelStageEvent.AfterTripwireBlocks	Fired near the end of LevelRenderer.addMainPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.client.renderer.culling.Frustum, org.joml.Matrix4f, com.mojang.blaze3d.buffers.GpuBufferSlice, boolean, net.minecraft.client.renderer.state.LevelRenderState, net.minecraft.client.DeltaTracker, net.minecraft.util.profiling.ProfilerFiller) after tripwire chunk geometry has been rendered.
RenderLevelStageEvent.AfterWeather	Fired near the end of LevelRenderer.addWeatherPass(com.mojang.blaze3d.framegraph.FrameGraphBuilder, net.minecraft.world.phys.Vec3, com.mojang.blaze3d.buffers.GpuBufferSlice) after weather has been rendered, before world border rendering.
RenderLivingEvent<T extends LivingEntity,S extends LivingEntityRenderState,M extends EntityModel<? super S>>	Fired when a LivingEntity is rendered.
RenderLivingEvent.Post<T extends LivingEntity,S extends LivingEntityRenderState,M extends EntityModel<? super S>>	Fired after an entity is rendered, if the corresponding RenderLivingEvent.Post is not cancelled.
RenderLivingEvent.Pre<T extends LivingEntity,S extends LivingEntityRenderState,M extends EntityModel<? super S>>	Fired before an entity is rendered.
RenderNameTagEvent	This event is fired before an entity renderer renders the nameplate of an entity.
RenderNameTagEvent.CanRender	This event is fired when an entity renderer extracts the render state of an entity relevant to rendering the nametag.
RenderNameTagEvent.DoRender	This event is fired before an entity renderer renders the nameplate of an entity.
RenderPlayerEvent<T extends Avatar & ClientAvatarEntity>	Fired when a player is being rendered.
RenderPlayerEvent.Post<T extends Avatar & ClientAvatarEntity>	Fired after the player is rendered, if the corresponding RenderPlayerEvent.Pre is not cancelled.
RenderPlayerEvent.Pre<T extends Avatar & ClientAvatarEntity>	Fired before the player is rendered.
RenderTooltipEvent	Fired during tooltip rendering.
RenderTooltipEvent.GatherComponents	Fired when a tooltip gathers the TooltipComponents to be rendered, before any text wrapping or processing.
RenderTooltipEvent.Pre	Fired before the tooltip is rendered.
RenderTooltipEvent.Texture	Fired when the textures for the tooltip background are determined.
ScreenEvent	Fired on different events/actions when a Screen is active and visible.
ScreenEvent.CharacterTyped	Fired when a keyboard key corresponding to a character is typed.
ScreenEvent.CharacterTyped.Post	Fired after the character input is handled, if not handled by the screen and the corresponding ScreenEvent.CharacterTyped.Pre is not cancelled.
ScreenEvent.CharacterTyped.Pre	Fired before the character input is handled by the screen.
ScreenEvent.Closing	Fired before a Screen is closed.
ScreenEvent.Init	Fired when a screen is being initialized.
ScreenEvent.Init.Post	Fired after the screen's overridable initialization method is called.
ScreenEvent.Init.Pre	Fired before the screen's overridable initialization method is fired.
ScreenEvent.KeyInput	Fired whenever a keyboard key is pressed or released.
ScreenEvent.KeyPressed	Fired when a keyboard key is pressed.
ScreenEvent.KeyPressed.Post	Fired after the key press is handled, if not handled by the screen and the corresponding ScreenEvent.KeyPressed.Pre is not cancelled.
ScreenEvent.KeyPressed.Pre	Fired before the key press is handled by the screen.
ScreenEvent.KeyReleased	Fired when a keyboard key is released.
ScreenEvent.KeyReleased.Post	Fired after the key release is handled, if not handled by the screen and the corresponding ScreenEvent.KeyReleased.Pre is not cancelled.
ScreenEvent.KeyReleased.Pre	Fired before the key release is handled by the screen.
ScreenEvent.MouseButtonPressed	Fired when a mouse button is pressed.
ScreenEvent.MouseButtonPressed.Post	This event is fired after the mouse click is handled, if the corresponding ScreenEvent.MouseButtonPressed.Pre was not cancelled.
ScreenEvent.MouseButtonPressed.Post.Result
ScreenEvent.MouseButtonPressed.Pre	Fired before the mouse click is handled by the screen.
ScreenEvent.MouseButtonReleased	Fired when a mouse button is released.
ScreenEvent.MouseButtonReleased.Post	This event is fired after the mouse release is handled, if the corresponding ScreenEvent.MouseButtonReleased.Pre was not cancelled.
ScreenEvent.MouseButtonReleased.Post.Result
ScreenEvent.MouseButtonReleased.Pre	Fired before the mouse release is handled by the screen.
ScreenEvent.MouseDragged	Fired when the mouse was dragged while a button is being held down.
ScreenEvent.MouseDragged.Post	Fired after the mouse drag is handled, if not handled by the screen and the corresponding ScreenEvent.MouseDragged.Pre is not cancelled.
ScreenEvent.MouseDragged.Pre	Fired before the mouse drag is handled by the screen.
ScreenEvent.MouseInput	Fired whenever an action is performed by the mouse.
ScreenEvent.MouseScrolled	Fired when the mouse was dragged while a button is being held down.
ScreenEvent.MouseScrolled.Post	Fired after the mouse scroll is handled, if not handled by the screen and the corresponding ScreenEvent.MouseScrolled.Pre is not cancelled.
ScreenEvent.MouseScrolled.Pre	Fired before the mouse scroll is handled by the screen.
ScreenEvent.Opening	Fired before any Screen is opened, to allow changing it or preventing it from being opened.
ScreenEvent.Render	Fired when a screen is being drawn.
ScreenEvent.Render.Background	Fired after the screen's renderBackground and before its render method.
ScreenEvent.Render.Post	Fired after the screen is drawn.
ScreenEvent.Render.Pre	Fired before the screen is drawn.
ScreenEvent.RenderInventoryMobEffects	Fired ahead of rendering any active mob effects in the EffectsInInventory held by a AbstractContainerScreen.
ScreenshotEvent	Fired when a screenshot is taken, but before it is written to disk.
SelectMusicEvent	Fired when the MusicManager checks what situational music should be used.
TextureAtlasStitchedEvent	Fired after a texture atlas is stitched together and all textures therein have been loaded.
ToastAddEvent	Fired when the client queues a Toast message to be shown onscreen.
ViewportEvent	Fired for hooking into the entity view rendering in GameRenderer.
ViewportEvent.ComputeCameraAngles	Fired to allow altering the angles of the player's camera.
ViewportEvent.ComputeFogColor	Fired for customizing the color of the fog visible to the player.
ViewportEvent.ComputeFov	Fired for altering the raw field of view (FOV).
ViewportEvent.RenderFog	Fired for rendering custom fog.