Contents
- Description
- Field Summary
- Constructor Summary
- Method Summary
- Constructor Details
- Method Details
- getComponentType()
- defaults()
- clone()
- toString()
- hashCode()
- equals(Object)
- showEntityMarkers()
- armorItemsPreferredPickupLocation()
- weaponAndToolItemsPreferredPickupLocation()
- usableItemsItemsPreferredPickupLocation()
- solidBlockItemsPreferredPickupLocation()
- miscItemsPreferredPickupLocation()
- creativeSettings()
- hideHelmet()
- hideCuirass()
- hideGauntlets()
- hidePants()
- voiceSettings()
Record Class PlayerSettings
java.lang.Object
java.lang.Record
com.hypixel.hytale.server.core.modules.entity.player.PlayerSettings
- Record Components:
showEntityMarkers- Whether to show entity markers to the player.armorItemsPreferredPickupLocation- The player's preferred item pickup location for armor items.weaponAndToolItemsPreferredPickupLocation- The player's preferred item pickup location for weapon and tool items.usableItemsItemsPreferredPickupLocation- The player's preferred item pickup location for usable items.solidBlockItemsPreferredPickupLocation- The player's preferred item pickup location for solid block items.miscItemsPreferredPickupLocation- The player's preferred item pickup location for misc items.creativeSettings- The creative mode settings for the player.hideHelmet- Whether to hide the player's helmet from other players.hideCuirass- Whether to hide the player's cuirass from other players.hideGauntlets- Whether to hide the player's gauntlets from other players.hidePants- Whether to hide the player's pants from other players.
- All Implemented Interfaces:
Component<EntityStore>, Cloneable
public record PlayerSettings(boolean showEntityMarkers, PickupLocation armorItemsPreferredPickupLocation, PickupLocation weaponAndToolItemsPreferredPickupLocation, PickupLocation usableItemsItemsPreferredPickupLocation, PickupLocation solidBlockItemsPreferredPickupLocation, PickupLocation miscItemsPreferredPickupLocation, PlayerCreativeSettings creativeSettings, boolean hideHelmet, boolean hideCuirass, boolean hideGauntlets, boolean hidePants, PlayerVoiceSettings voiceSettings)
extends Record
implements Component<EntityStore>
An entity component that represents the settings for a player entity.
-
Field Summary
Fields inherited from interface Component
EMPTY_ARRAY -
Constructor Summary
ConstructorsConstructorDescriptionPlayerSettings(boolean showEntityMarkers, PickupLocation armorItemsPreferredPickupLocation, PickupLocation weaponAndToolItemsPreferredPickupLocation, PickupLocation usableItemsItemsPreferredPickupLocation, PickupLocation solidBlockItemsPreferredPickupLocation, PickupLocation miscItemsPreferredPickupLocation, PlayerCreativeSettings creativeSettings, boolean hideHelmet, boolean hideCuirass, boolean hideGauntlets, boolean hidePants, PlayerVoiceSettings voiceSettings) Creates an instance of aPlayerSettingsrecord class. -
Method Summary
Modifier and TypeMethodDescriptionReturns the value of thearmorItemsPreferredPickupLocationrecord component.clone()Returns the value of thecreativeSettingsrecord component.static PlayerSettingsdefaults()final booleanIndicates whether some other object is "equal to" this one.static ComponentType<EntityStore, PlayerSettings> final inthashCode()Returns a hash code value for this object.booleanReturns the value of thehideCuirassrecord component.booleanReturns the value of thehideGauntletsrecord component.booleanReturns the value of thehideHelmetrecord component.booleanReturns the value of thehidePantsrecord component.Returns the value of themiscItemsPreferredPickupLocationrecord component.booleanReturns the value of theshowEntityMarkersrecord component.Returns the value of thesolidBlockItemsPreferredPickupLocationrecord component.final StringtoString()Returns a string representation of this record class.Returns the value of theusableItemsItemsPreferredPickupLocationrecord component.Returns the value of thevoiceSettingsrecord component.Returns the value of theweaponAndToolItemsPreferredPickupLocationrecord component.Methods inherited from interface Component
cloneSerializable
-
Constructor Details
-
PlayerSettings
public PlayerSettings(boolean showEntityMarkers, PickupLocation armorItemsPreferredPickupLocation, PickupLocation weaponAndToolItemsPreferredPickupLocation, PickupLocation usableItemsItemsPreferredPickupLocation, PickupLocation solidBlockItemsPreferredPickupLocation, PickupLocation miscItemsPreferredPickupLocation, PlayerCreativeSettings creativeSettings, boolean hideHelmet, boolean hideCuirass, boolean hideGauntlets, boolean hidePants, PlayerVoiceSettings voiceSettings) Creates an instance of aPlayerSettingsrecord class.- Parameters:
showEntityMarkers- the value for theshowEntityMarkersrecord componentarmorItemsPreferredPickupLocation- the value for thearmorItemsPreferredPickupLocationrecord componentweaponAndToolItemsPreferredPickupLocation- the value for theweaponAndToolItemsPreferredPickupLocationrecord componentusableItemsItemsPreferredPickupLocation- the value for theusableItemsItemsPreferredPickupLocationrecord componentsolidBlockItemsPreferredPickupLocation- the value for thesolidBlockItemsPreferredPickupLocationrecord componentmiscItemsPreferredPickupLocation- the value for themiscItemsPreferredPickupLocationrecord componentcreativeSettings- the value for thecreativeSettingsrecord componenthideHelmet- the value for thehideHelmetrecord componenthideCuirass- the value for thehideCuirassrecord componenthideGauntlets- the value for thehideGauntletsrecord componenthidePants- the value for thehidePantsrecord componentvoiceSettings- the value for thevoiceSettingsrecord component
-
-
Method Details
-
getComponentType
- Returns:
- the component type for the
PlayerSettingscomponent.
-
defaults
- Returns:
- the default player settings instance.
-
clone
- Specified by:
clonein interfaceComponent<EntityStore>- Returns:
- a clone instance of the original component instance.
-
toString
-
hashCode
-
equals
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 withObjects::equals(Object,Object); primitive components are compared with thecomparemethod from their corresponding wrapper classes. -
showEntityMarkers
public boolean showEntityMarkers()Returns the value of theshowEntityMarkersrecord component.- Returns:
- the value of the
showEntityMarkersrecord component
-
armorItemsPreferredPickupLocation
Returns the value of thearmorItemsPreferredPickupLocationrecord component.- Returns:
- the value of the
armorItemsPreferredPickupLocationrecord component
-
weaponAndToolItemsPreferredPickupLocation
Returns the value of theweaponAndToolItemsPreferredPickupLocationrecord component.- Returns:
- the value of the
weaponAndToolItemsPreferredPickupLocationrecord component
-
usableItemsItemsPreferredPickupLocation
Returns the value of theusableItemsItemsPreferredPickupLocationrecord component.- Returns:
- the value of the
usableItemsItemsPreferredPickupLocationrecord component
-
solidBlockItemsPreferredPickupLocation
Returns the value of thesolidBlockItemsPreferredPickupLocationrecord component.- Returns:
- the value of the
solidBlockItemsPreferredPickupLocationrecord component
-
miscItemsPreferredPickupLocation
Returns the value of themiscItemsPreferredPickupLocationrecord component.- Returns:
- the value of the
miscItemsPreferredPickupLocationrecord component
-
creativeSettings
Returns the value of thecreativeSettingsrecord component.- Returns:
- the value of the
creativeSettingsrecord component
-
hideHelmet
public boolean hideHelmet()Returns the value of thehideHelmetrecord component.- Returns:
- the value of the
hideHelmetrecord component
-
hideCuirass
public boolean hideCuirass()Returns the value of thehideCuirassrecord component.- Returns:
- the value of the
hideCuirassrecord component
-
hideGauntlets
public boolean hideGauntlets()Returns the value of thehideGauntletsrecord component.- Returns:
- the value of the
hideGauntletsrecord component
-
hidePants
-
voiceSettings
Returns the value of thevoiceSettingsrecord component.- Returns:
- the value of the
voiceSettingsrecord component
-