Enum Class DayPhase

java.lang.Object
java.lang.Enum<DayPhase>
fr.fidorial.world.time.DayPhase
All Implemented Interfaces:
Serializable, Comparable<DayPhase>, Constable
public enum DayPhase extends Enum<DayPhase>
The four parts of a day, by time of day.
Since:
0.1.0

  • Enum Constant Details

    • DAY

      public static final DayPhase DAY
      From sunrise to sunset.

    • DUSK

      public static final DayPhase DUSK
      From sunset to nightfall.

    • NIGHT

      public static final DayPhase NIGHT
      From nightfall to sunrise.

    • DAWN

      public static final DayPhase DAWN
      From sunrise until the sun is fully up.

  • Method Details

    • values

      public static DayPhase[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static DayPhase valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null

    • at

      public static DayPhase at(int timeOfDay)
      Returns the phase a time of day falls in.
      Parameters:
      timeOfDay - the time of day, any value being wrapped into a single day
      Returns:
      the phase a time of day falls in
      Since:
      0.1.0

    • start

      public int start()
      Returns the first time of day of this phase, inclusive.
      Returns:
      the first time of day of this phase, inclusive
      Since:
      0.1.0

    • end

      public int end()
      Returns the last time of day of this phase, exclusive.
      Returns:
      the last time of day of this phase, exclusive
      Since:
      0.1.0

    • lengthTicks

      public int lengthTicks()
      Returns the length of this phase, in ticks.
      Returns:
      the length of this phase, in ticks
      Since:
      0.1.0

    • daylight

      public boolean daylight()
      Returns true for DAY.
      Returns:
      true for DAY
      Since:
      0.1.0