Record Class CatchUpPolicy

java.lang.Object
java.lang.Record
fr.robie.machineengine.api.machine.CatchUpPolicy
Record Components:
maxTicks - most unloaded ticks that are caught up; 0 means none (frozen in time)
public record CatchUpPolicy(long maxTicks) extends Record
What a machine does about the time it spent unloaded (D4, ARCHITECTURE.md ยง18).

  • Field Details

    • NONE

      public static final CatchUpPolicy NONE
      Frozen in time while unloaded: resumes exactly where it stopped. The default.

  • Constructor Details

    • CatchUpPolicy

      public CatchUpPolicy(long maxTicks)
      Creates an instance of a CatchUpPolicy record class.
      Parameters:
      maxTicks - the value for the maxTicks record component

  • Method Details

    • bounded

      @NotNull public static @NotNull CatchUpPolicy bounded(long maxTicks)
      On load, MachineBehavior.catchUp(MachineContext, long) receives the ticks spent unloaded, capped at maxTicks. The behavior must work in one step, with its own storages only.

    • catchesUp

      public boolean catchesUp()

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

    • maxTicks

      public long maxTicks()
      Returns the value of the maxTicks record component.
      Returns:
      the value of the maxTicks record component