Record Class PlayerVoiceSettings

java.lang.Object

java.lang.Record

com.hypixel.hytale.server.core.modules.entity.player.PlayerVoiceSettings

Record Components:

voiceChatEnabled - Whether the player has voice chat enabled at all.

voiceInputEnabled - Whether voice input is enabled for this player.

voiceInputMode - The VoiceInputMode used to determine how voice input is captured for this player.

public record PlayerVoiceSettings(boolean voiceChatEnabled, boolean voiceInputEnabled, VoiceInputMode voiceInputMode)
extends Record

Represents the voice-specific settings for a player entity.

Constructor Summary

Constructors

Constructor	Description
PlayerVoiceSettings()
PlayerVoiceSettings(boolean voiceChatEnabled, boolean voiceInputEnabled, VoiceInputMode voiceInputMode)	Creates an instance of a PlayerVoiceSettings record class.

Method Summary

Modifier and Type	Method	Description
static PlayerVoiceSettings	defaults()
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
final String	toString()	Returns a string representation of this record class.
boolean	voiceChatEnabled()	Returns the value of the voiceChatEnabled record component.
boolean	voiceInputEnabled()	Returns the value of the voiceInputEnabled record component.
VoiceInputMode	voiceInputMode()	Returns the value of the voiceInputMode record component.

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

PlayerVoiceSettings

public PlayerVoiceSettings()

PlayerVoiceSettings

public PlayerVoiceSettings(boolean voiceChatEnabled,
 boolean voiceInputEnabled,
 VoiceInputMode voiceInputMode)

Creates an instance of a PlayerVoiceSettings record class.

Parameters:

voiceChatEnabled - the value for the voiceChatEnabled record component

voiceInputEnabled - the value for the voiceInputEnabled record component

voiceInputMode - the value for the voiceInputMode record component

Method Details

defaults

@Nonnull
public static PlayerVoiceSettings defaults()

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.

voiceChatEnabled

public boolean voiceChatEnabled()

Returns the value of the voiceChatEnabled record component.

Returns:

the value of the voiceChatEnabled record component

voiceInputEnabled

public boolean voiceInputEnabled()

Returns the value of the voiceInputEnabled record component.

Returns:

the value of the voiceInputEnabled record component

voiceInputMode

public VoiceInputMode voiceInputMode()

Returns the value of the voiceInputMode record component.

Returns:

the value of the voiceInputMode record component