Record Class BedRule

java.lang.Object
java.lang.Record
fr.fidorial.world.environment.BedRule
public record BedRule(BedRule.AccessCondition sleepAllowed, BedRule.AccessCondition spawnAllowed, boolean destroysOnUse, boolean destroysOnLeave, Optional<Component> failureMessage) extends Record
Controls whether beds can be used to sleep or set a spawn point in a dimension.
Since:
0.1.0

  • Constructor Details

    • BedRule

      public BedRule(BedRule.AccessCondition sleepAllowed, BedRule.AccessCondition spawnAllowed, boolean destroysOnUse, boolean destroysOnLeave, Optional<Component> failureMessage)
      Creates an instance of a BedRule record class.
      Parameters:
      sleepAllowed - the value for the sleepAllowed record component
      spawnAllowed - the value for the spawnAllowed record component
      destroysOnUse - the value for the destroysOnUse record component
      destroysOnLeave - the value for the destroysOnLeave record component
      failureMessage - the value for the failureMessage record component

  • Method Details

    • alwaysAllowed

      public static BedRule alwaysAllowed()
      Allows beds to always be used to sleep and set a spawn point.
      Returns:
      bed rule
      Since:
      0.1.0

    • allowedAtNight

      public static BedRule allowedAtNight()
      Allows beds to only be used to sleep and set a spawn point when its nighttime.
      Returns:
      bed rule
      Since:
      0.1.0

    • allowedAtNight

      public static BedRule allowedAtNight(Component reason)
      Allows beds to only be used to sleep and set a spawn point when its nighttime.
      Parameters:
      reason - the reason shown to the player for why sleep is not allowed
      Returns:
      bed rule
      Since:
      0.1.0

    • neverAllowed

      public static BedRule neverAllowed()
      Forbids beds from ever being used to sleep or set a spawn point; attempting to use one destroys it immediately.
      Returns:
      bed rule
      Since:
      0.1.0

    • destroyedOnLeave

      public static BedRule destroyedOnLeave()
      Allows sleeping at night but never setting a spawn point; the bed is destroyed once the player leaves it (e.g. straw beds).
      Returns:
      bed rule
      Since:
      0.1.0

    • destroyedOnLeave

      public static BedRule destroyedOnLeave(Component reason)
      Same as destroyedOnLeave(), with a message shown when sleep is refused outside the allowed window.
      Parameters:
      reason - the reason shown to the player for why sleep is not allowed
      Returns:
      bed rule
      Since:
      0.1.0

    • 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. Reference components are compared with Objects::equals(Object,Object); primitive components 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.

    • sleepAllowed

      public BedRule.AccessCondition sleepAllowed()
      Returns the value of the sleepAllowed record component.
      Returns:
      the value of the sleepAllowed record component

    • spawnAllowed

      public BedRule.AccessCondition spawnAllowed()
      Returns the value of the spawnAllowed record component.
      Returns:
      the value of the spawnAllowed record component

    • destroysOnUse

      public boolean destroysOnUse()
      Returns the value of the destroysOnUse record component.
      Returns:
      the value of the destroysOnUse record component

    • destroysOnLeave

      public boolean destroysOnLeave()
      Returns the value of the destroysOnLeave record component.
      Returns:
      the value of the destroysOnLeave record component

    • failureMessage

      public Optional<Component> failureMessage()
      Returns the value of the failureMessage record component.
      Returns:
      the value of the failureMessage record component