Package net.neoforged.neoforge.client.event

Class RenderHandEvent

java.lang.Object
net.neoforged.bus.api.Event
net.neoforged.neoforge.client.event.RenderHandEvent
All Implemented Interfaces:
net.neoforged.bus.api.ICancellableEvent
public class RenderHandEvent extends net.neoforged.bus.api.Event implements net.neoforged.bus.api.ICancellableEvent
Fired before a hand is rendered in the first person view.

This event is cancellable, and does not

invalid reference 
have a result
. If this event is cancelled, then the hand will not be rendered.

This event is fired on the main Forge event bus, only on the logical client.

See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final float
    equipProgress
     
    private final net.minecraft.world.InteractionHand
    hand
     
    private final float
    interpolatedPitch
     
    private final net.minecraft.client.renderer.MultiBufferSource
    multiBufferSource
     
    private final int
    packedLight
     
    private final float
    partialTick
     
    private final com.mojang.blaze3d.vertex.PoseStack
    poseStack
     
    private final net.minecraft.world.item.ItemStack
    stack
     
    private final float
    swingProgress
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    RenderHandEvent(net.minecraft.world.InteractionHand hand, com.mojang.blaze3d.vertex.PoseStack poseStack, net.minecraft.client.renderer.MultiBufferSource multiBufferSource, int packedLight, float partialTick, float interpolatedPitch, float swingProgress, float equipProgress, net.minecraft.world.item.ItemStack stack)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    float
    getEquipProgress()
    Returns the progress of the equip animation, from 0.0 to 1.0.
    net.minecraft.world.InteractionHand
    getHand()
    Returns the hand being rendered.
    float
    getInterpolatedPitch()
    Returns the interpolated pitch of the player entity.
    net.minecraft.world.item.ItemStack
    getItemStack()
    Returns the item stack to be rendered.
    net.minecraft.client.renderer.MultiBufferSource
    getMultiBufferSource()
    Returns the source of rendering buffers.
    int
    getPackedLight()
    Returns the amount of packed (sky and block) light for rendering.
    float
    getPartialTick()
    Returns the partial tick.
    com.mojang.blaze3d.vertex.PoseStack
    getPoseStack()
    Returns the pose stack used for rendering.
    float
    getSwingProgress()
    Returns the swing progress of the hand being rendered.

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface net.neoforged.bus.api.ICancellableEvent

    isCanceled, setCanceled

  • Field Details

    • hand

      private final net.minecraft.world.InteractionHand hand

    • poseStack

      private final com.mojang.blaze3d.vertex.PoseStack poseStack

    • multiBufferSource

      private final net.minecraft.client.renderer.MultiBufferSource multiBufferSource

    • packedLight

      private final int packedLight

    • partialTick

      private final float partialTick

    • interpolatedPitch

      private final float interpolatedPitch

    • swingProgress

      private final float swingProgress

    • equipProgress

      private final float equipProgress

    • stack

      private final net.minecraft.world.item.ItemStack stack

  • Constructor Details

    • RenderHandEvent

      @Internal public RenderHandEvent(net.minecraft.world.InteractionHand hand, com.mojang.blaze3d.vertex.PoseStack poseStack, net.minecraft.client.renderer.MultiBufferSource multiBufferSource, int packedLight, float partialTick, float interpolatedPitch, float swingProgress, float equipProgress, net.minecraft.world.item.ItemStack stack)

  • Method Details

    • getHand

      public net.minecraft.world.InteractionHand getHand()
      Returns the hand being rendered.
      Returns:
      the hand being rendered

    • getPoseStack

      public com.mojang.blaze3d.vertex.PoseStack getPoseStack()
      Returns the pose stack used for rendering.
      Returns:
      the pose stack used for rendering

    • getMultiBufferSource

      public net.minecraft.client.renderer.MultiBufferSource getMultiBufferSource()
      Returns the source of rendering buffers.
      Returns:
      the source of rendering buffers

    • getPackedLight

      public int getPackedLight()
      Returns the amount of packed (sky and block) light for rendering.
      Returns:
      the amount of packed (sky and block) light for rendering
      See Also:
      • LightTexture

    • getPartialTick

      public float getPartialTick()
      Returns the partial tick.
      Returns:
      the partial tick

    • getInterpolatedPitch

      public float getInterpolatedPitch()
      Returns the interpolated pitch of the player entity.
      Returns:
      the interpolated pitch of the player entity

    • getSwingProgress

      public float getSwingProgress()
      Returns the swing progress of the hand being rendered.
      Returns:
      the swing progress of the hand being rendered

    • getEquipProgress

      public float getEquipProgress()
      Returns the progress of the equip animation, from 0.0 to 1.0.
      Returns:
      the progress of the equip animation, from 0.0 to 1.0

    • getItemStack

      public net.minecraft.world.item.ItemStack getItemStack()
      Returns the item stack to be rendered.
      Returns:
      the item stack to be rendered