Record Class TutorialStep

java.lang.Object
java.lang.Record
com.csse3200.game.components.screens.TutorialStep
Record Components:
title - Short heading for the step.
description - Explanatory body text for the step.
clip - Optional animated clip associated with this step; may be null.

public record TutorialStep(String title, String description, TutorialClip clip) extends Record
Represents a single page in the Tutorial flow.

A TutorialStep consists of a title, descriptive text, and an optional animated clip (see TutorialClip) to illustrate the concept.

  • Constructor Details

    • TutorialStep

      public TutorialStep(String title, String description, TutorialClip clip)
      Creates a tutorial step with optional animation.
      Parameters:
      title - step title (non-null, non-empty recommended)
      description - step description (non-null, non-empty recommended)
      clip - optional animated clip; may be null if no media is shown
  • Method Details

    • title

      public String title()
      Returns the value of the title record component.
      Returns:
      the value of the title record component
    • description

      public String description()
      Returns the value of the description record component.
      Returns:
      the value of the description record component
    • clip

      public TutorialClip clip()
      Returns the value of the clip record component.
      Returns:
      the value of the clip record component
    • 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. All components in this record class are compared with Objects::equals(Object,Object).
      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.