Skip to content
This repository was archived by the owner on Dec 16, 2022. It is now read-only.

Conversation

@sciwhiz12
Copy link
Contributor

@sciwhiz12 sciwhiz12 commented Nov 17, 2020

This PR adds documentation for the Forge client-only events, under net.minecraftforge.client.event.

Most of this will be taken from the event_docs branch of my fork of MinecraftForge/MinecraftForge. Although that branch is based off an old version of Forge, most if not all of its contents can be transferred cleanly (though documentation for new events since that branch's last update will need to be written anew).

Client events

Screen-related events

  • GuiContainerEvent
    • DrawForeground extends GuiContainerEvent
    • DrawBackground extends GuiContainerEvent
  • GuiOpenEvent
  • GuiScreenEvent
    • InitGuiEvent extends GuiScreenEvent
      • Pre extends InitGuiEvent
      • Post extends InitGuiEvent
    • DrawScreenEvent extends GuiScreenEvent
      • Pre extends DrawScreenEvent
      • Post extends DrawScreenEvent
    • BackgroundDrawnEvent extends GuiScreenEvent
      • Pre extends BackgroundDrawnEvent
      • Post extends BackgroundDrawnEvent
    • PotionShiftEvent extends GuiScreenEvent
    • MouseInputEvent extends GuiScreenEvent
    • MouseClickedEvent extends MouseInputEvent
      • Pre extends MouseClickedEvent
      • Post extends MouseClickedEvent
    • MouseReleasedEvent extends MouseInputEvent
      • Pre extends MouseReleasedEvent
      • Post extends MouseReleasedEvent
    • MouseDragEvent extends MouseInputEvent
      • Pre extends MouseDragEvent
      • Post extends MouseDragEvent
    • MouseScrollEvent extends MouseInputEvent
      • Pre extends MouseScrollEvent
      • Post extends MouseScrollEvent
    • KeyboardKeyEvent extends GuiScreenEvent
    • KeyboardKeyPressedEvent extends KeyboardKeyEvent
      • Pre extends KeyboardKeyPressedEvent
      • Post extends KeyboardKeyPressedEvent
    • KeyboardKeyReleasedEvent extends KeyboardKeyEvent
      • Pre extends KeyboardKeyReleasedEvent
      • Post extends KeyboardKeyReleasedEvent
    • KeyboardCharTypedEvent extends GuiScreenEvent
      • Pre extends KeyboardCharTypedEvent
      • Post extends KeyboardCharTypedEvent

Sound-related events

  • PlaySoundEvent extends SoundEvent
  • PlaySoundSourceEvent extends SourceSourceEvent
  • PlayStreamingSourceEvent extends SourceSourceEvent
  • SoundEvent
    • SoundSourceEvent extends SoundEvent
  • SoundLoadEvent extends SoundEvent, implements IModBusEvent
  • SoundSetupEvent extends SoundEvent

Rendering events

  • DrawHighlightEvent
    • HighlightBlock extends DrawHighlightEvent
    • HighlightEntity extends DrawHighlightEvent
  • EntityViewRenderEvent
    • FogEvent extends EntityViewRenderEvent
    • FogDensity extends FogEvent
    • RenderFogEvent extends FogEvent
    • FogColors extends FogEvent
    • CameraSetup extends EntityViewRenderEvent
    • FOVModifier extends EntityViewRenderEvent
  • FOVUpdateEvent
  • RenderBlockOverlayEvent
    • enum OverlayType
  • RenderGameOverlayEvent
    • enum ElementType
    • Pre extends RenderGameOverlayEvent
    • Post extends RenderGameOverlayEvent
    • BossInfo extends Pre
    • Text extends Pre
    • Chat extends Pre
  • RenderHandEvent
  • RenderItemInFrameEvent
  • RenderLivingEvent
    • Pre extends RenderLivingEvent
    • Post extends RenderLivingEvent
  • RenderNameplateEvent
  • RenderPlayerEvent extends PlayerEvent
    • Pre extends RenderPlayerEvent
    • Post extends RenderPlayerEvent
  • RenderTooltipEvent
    • Pre extends RenderTooltipEvent
    • Post extends RenderTooltipEvent
    • PostBackground extends Post
    • PostText extends Post
    • Color extends RenderTooltipEvent
  • RenderWorldLastEvent

Setup and registry events

  • ColorHandlerEvent implements IModBusEvent
    • Block extends ColorHandlerEvent
    • Item extends ColorHandlerEvent
  • ModelBakeEvent implements IModBusEvent
  • ModelRegistryEvent implements IModBusEvent
  • ParticleFactoryRegisterEvent implements IModBusEvent
  • RecipesUpdatedEvent
  • TextureStitchEvent implements IModBusEvent

Misc. events

  • ClientChatEvent
  • ClientChatReceivedEvent
  • ClientPlayerNetworkEvent
    • LoggedInEvent extends ClientPlayerNetworkEvent
    • LoggedOutEvent extends ClientPlayerNetworkEvent
    • RespawnEvent extends ClientPlayerNetworkEvent
  • ClientPlayerChangeGameModeEvent
  • InputEvent
    • RawMouseEvent extends InputEvent
    • MouseInputEvent extends InputEvent
    • MouseScrollEvent extends InputEvent
    • KeyInputEvent extends InputEvent
    • ClickInputEvent extends InputEvent
  • InputUpdateEvent
  • ScreenshotEvent

@sciwhiz12 sciwhiz12 added the documentation This is an improvement or addition to the documentation. label Nov 17, 2020
@sciwhiz12 sciwhiz12 self-assigned this Nov 17, 2020
@dpeter99 dpeter99 self-requested a review December 5, 2020 10:27
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation This is an improvement or addition to the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant