Package org.cha0scollective.wwpg.api

Record Class TickContext

java.lang.Object
java.lang.Record
org.cha0scollective.wwpg.api.TickContext
public record TickContext(long gameTime, double tickSeconds, int substeps) extends Record
Authoritative server electrical timestep. gameTime is the dimension's game tick; tickSeconds is the simulated duration, independent of wall-clock lag. substeps is the PG schedule for this tick. Substep duration is tickSeconds/substeps.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TickContext(long gameTime, double tickSeconds, int substeps)
    Creates an instance of a TickContext record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    long
    gameTime()
    Returns the value of the gameTime record component.
    final int
    hashCode()
    Returns a hash code value for this object.
    double
    startTimeSeconds()
    Absolute simulated time at the start of this tick, for source waveforms.
    int
    substeps()
    Returns the value of the substeps record component.
    double
    substepSeconds()
    Duration of each accepted electrical substep in simulated seconds.
    double
    tickSeconds()
    Returns the value of the tickSeconds record component.
    final String
    toString()
    Returns a string representation of this record class.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • TickContext

      public TickContext(long gameTime, double tickSeconds, int substeps)
      Creates an instance of a TickContext record class.
      Parameters:
      gameTime - the value for the gameTime record component
      tickSeconds - the value for the tickSeconds record component
      substeps - the value for the substeps record component

  • Method Details

    • substepSeconds

      public double substepSeconds()
      Duration of each accepted electrical substep in simulated seconds.

    • startTimeSeconds

      public double startTimeSeconds()
      Absolute simulated time at the start of this tick, for source waveforms.

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

    • gameTime

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

    • tickSeconds

      public double tickSeconds()
      Returns the value of the tickSeconds record component.
      Returns:
      the value of the tickSeconds record component

    • substeps

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