Record Class BedRule

java.lang.Object

java.lang.Record

net.minestom.server.world.attribute.BedRule

public record BedRule(BedRule.Rule canSleep, BedRule.Rule canSetSpawn, boolean explodes, @Nullable Component errorMessage)
extends Record

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	BedRule.Rule

Field Summary

Fields

Modifier and Type	Field	Description
static final BedRule	CAN_SLEEP_WHEN_DARK	The default vanilla overworld bed behavior.
static final Codec<BedRule>	CODEC
static final BedRule	EXPLODES	THe default vanilla nether/end bed behavior.

Constructor Summary

Constructors

Constructor	Description
BedRule(BedRule.Rule canSleep, BedRule.Rule canSetSpawn, boolean explodes, @Nullable Component errorMessage)	Creates an instance of a BedRule record class.

Method Summary

Modifier and Type	Method	Description
BedRule.Rule	canSetSpawn()	Returns the value of the canSetSpawn record component.
BedRule.Rule	canSleep()	Returns the value of the canSleep record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
@Nullable Component	errorMessage()	Returns the value of the errorMessage record component.
boolean	explodes()	Returns the value of the explodes record component.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class Object

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

Field Details

CAN_SLEEP_WHEN_DARK

public static final BedRule CAN_SLEEP_WHEN_DARK

The default vanilla overworld bed behavior.

EXPLODES

public static final BedRule EXPLODES

THe default vanilla nether/end bed behavior.

CODEC

public static final Codec<BedRule> CODEC

Constructor Details

BedRule

public BedRule(BedRule.Rule canSleep,
 BedRule.Rule canSetSpawn,
 boolean explodes,
 @Nullable
 @Nullable Component errorMessage)

Creates an instance of a BedRule record class.

Parameters:

canSleep - the value for the canSleep record component

canSetSpawn - the value for the canSetSpawn record component

explodes - the value for the explodes record component

errorMessage - the value for the errorMessage record component

Method Details

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.

canSleep

public BedRule.Rule canSleep()

Returns the value of the canSleep record component.

Returns:

the value of the canSleep record component

canSetSpawn

public BedRule.Rule canSetSpawn()

Returns the value of the canSetSpawn record component.

Returns:

the value of the canSetSpawn record component

explodes

public boolean explodes()

Returns the value of the explodes record component.

Returns:

the value of the explodes record component

errorMessage

@Nullable
public @Nullable Component errorMessage()

Returns the value of the errorMessage record component.

Returns:

the value of the errorMessage record component