Record Class CutsceneProgressPayload

java.lang.Object
java.lang.Record
net.ixdarklord.coolcatcanvas.internal.cutscene.CutsceneProgressPayload
Record Components:
keyframe - the keyframe's index, or -1 when this is about a marker
marker - the marker's id, when this is about one
All Implemented Interfaces:
net.minecraft.network.protocol.common.custom.CustomPacketPayload
public record CutsceneProgressPayload(net.minecraft.resources.Identifier id, int keyframe, Optional<net.minecraft.resources.Identifier> marker) extends Record implements net.minecraft.network.protocol.common.custom.CustomPacketPayload
A client telling the server how far the cutscene it was asked to play has got: a keyframe reached, or a marker passed.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

    net.minecraft.network.protocol.common.custom.CustomPacketPayload.FallbackProvider<B>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<T>, net.minecraft.network.protocol.common.custom.CustomPacketPayload.TypeAndCodec<B,T>

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf, CutsceneProgressPayload>
    STREAM_CODEC
     
    static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<CutsceneProgressPayload>
    TYPE
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    CutsceneProgressPayload(net.minecraft.resources.Identifier id, int keyframe, Optional<net.minecraft.resources.Identifier> marker)
    Creates an instance of a CutsceneProgressPayload record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    net.minecraft.resources.Identifier
    id()
    Returns the value of the id record component.
    int
    keyframe()
    Returns the value of the keyframe record component.
    static CutsceneProgressPayload
    keyframe(net.minecraft.resources.Identifier id, int index)
     
    Optional<net.minecraft.resources.Identifier>
    marker()
    Returns the value of the marker record component.
    static CutsceneProgressPayload
    marker(net.minecraft.resources.Identifier id, net.minecraft.resources.Identifier marker)
     
    final String
    toString()
    Returns a string representation of this record class.
    net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<? extends net.minecraft.network.protocol.common.custom.CustomPacketPayload>
    type()
     

    Methods inherited from class Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • TYPE

      public static final net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<CutsceneProgressPayload> TYPE

    • STREAM_CODEC

      public static final net.minecraft.network.codec.StreamCodec<net.minecraft.network.RegistryFriendlyByteBuf, CutsceneProgressPayload> STREAM_CODEC

  • Constructor Details

    • CutsceneProgressPayload

      public CutsceneProgressPayload(net.minecraft.resources.Identifier id, int keyframe, Optional<net.minecraft.resources.Identifier> marker)
      Creates an instance of a CutsceneProgressPayload record class.
      Parameters:
      id - the value for the id record component
      keyframe - the value for the keyframe record component
      marker - the value for the marker record component

  • Method Details

    • keyframe

      public static CutsceneProgressPayload keyframe(net.minecraft.resources.Identifier id, int index)

    • marker

      public static CutsceneProgressPayload marker(net.minecraft.resources.Identifier id, net.minecraft.resources.Identifier marker)

    • type

      public net.minecraft.network.protocol.common.custom.CustomPacketPayload.Type<? extends net.minecraft.network.protocol.common.custom.CustomPacketPayload> type()
      Specified by:
      type in interface net.minecraft.network.protocol.common.custom.CustomPacketPayload

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • id

      public net.minecraft.resources.Identifier id()
      Returns the value of the id record component.
      Returns:
      the value of the id record component

    • keyframe

      public int keyframe()
      Returns the value of the keyframe record component.
      Returns:
      the value of the keyframe record component

    • marker

      public Optional<net.minecraft.resources.Identifier> marker()
      Returns the value of the marker record component.
      Returns:
      the value of the marker record component