Module technology.sola.engine
Package technology.sola.engine.assets.input

Record Class MouseButtonControlInputCondition

java.lang.Object
java.lang.Record
technology.sola.engine.assets.input.MouseButtonControlInputCondition
Record Components:
button - the MouseButton to check
state - the MouseButtonControlInputCondition.State needed to be considered active
All Implemented Interfaces:
ControlInputCondition<MouseButtonControlInputCondition.State>
@NullMarked public record MouseButtonControlInputCondition(MouseButton button, MouseButtonControlInputCondition.State state) extends Record implements ControlInputCondition<MouseButtonControlInputCondition.State>
MouseButtonInputCondition is a ControlInputCondition to check if a MouseButton is in an active state.

  • Constructor Details

    • MouseButtonControlInputCondition

      public MouseButtonControlInputCondition(MouseButton button, MouseButtonControlInputCondition.State state)
      Creates an instance of a MouseButtonControlInputCondition record class.
      Parameters:
      button - the value for the button record component
      state - the value for the state record component

  • Method Details

    • isActive

      public boolean isActive(KeyboardInput keyboardInput, MouseInput mouseInput)
      Description copied from interface: ControlInputCondition
      Checks the state of the input to see if the condition is active or not.
      Specified by:
      isActive in interface ControlInputCondition<MouseButtonControlInputCondition.State>
      Parameters:
      keyboardInput - the KeyboardInput
      mouseInput - the MouseInput
      Returns:
      true if the condition is active

    • 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.

    • button

      public MouseButton button()
      Returns the value of the button record component.
      Returns:
      the value of the button record component

    • state

      public MouseButtonControlInputCondition.State state()
      Returns the value of the state record component.
      Specified by:
      state in interface ControlInputCondition<MouseButtonControlInputCondition.State>
      Returns:
      the value of the state record component