net.minecraft.world

Class GameRules

java.lang.Object

net.minecraft.world.GameRules

public class GameRules
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static interface	GameRules.Acceptor<T extends GameRules.Rule<T>>
static class	GameRules.BooleanRule
static class	GameRules.Category
static class	GameRules.IntRule
static class	GameRules.Key<T extends GameRules.Rule<T>>
static class	GameRules.Rule<T extends GameRules.Rule<T>>
static class	GameRules.Type<T extends GameRules.Rule<T>>
static interface	GameRules.Visitor A visitor used to visit all game rules.

Field Summary

Fields

Modifier and Type	Field and Description
static GameRules.Key<GameRules.BooleanRule>	ANNOUNCE_ADVANCEMENTS A game rule which regulates whether a player's advancements should be announced in chat.
static GameRules.Key<GameRules.BooleanRule>	COMMAND_BLOCK_OUTPUT
static GameRules.Key<GameRules.BooleanRule>	DISABLE_ELYTRA_MOVEMENT_CHECK
static GameRules.Key<GameRules.BooleanRule>	DISABLE_RAIDS A game rule which regulates whether raids should occur.
static GameRules.Key<GameRules.BooleanRule>	DO_DAYLIGHT_CYCLE
static GameRules.Key<GameRules.BooleanRule>	DO_ENTITY_DROPS
static GameRules.Key<GameRules.BooleanRule>	DO_FIRE_TICK
static GameRules.Key<GameRules.BooleanRule>	DO_IMMEDIATE_RESPAWN A game rule which regulates whether a player should immediately respawn upon death.
static GameRules.Key<GameRules.BooleanRule>	DO_INSOMNIA
static GameRules.Key<GameRules.BooleanRule>	DO_LIMITED_CRAFTING
static GameRules.Key<GameRules.BooleanRule>	DO_MOB_GRIEFING A game rule which regulates whether mobs can modify the world.
static GameRules.Key<GameRules.BooleanRule>	DO_MOB_LOOT A game rule which regulates whether mobs should drop loot on death.
static GameRules.Key<GameRules.BooleanRule>	DO_MOB_SPAWNING A game rule which regulates whether mobs can spawn naturally.
static GameRules.Key<GameRules.BooleanRule>	DO_PATROL_SPAWNING
static GameRules.Key<GameRules.BooleanRule>	DO_TILE_DROPS A game rule which regulates whether blocks should drop their items when broken.
static GameRules.Key<GameRules.BooleanRule>	DO_TRADER_SPAWNING
static GameRules.Key<GameRules.BooleanRule>	DO_WEATHER_CYCLE
static GameRules.Key<GameRules.BooleanRule>	DROWNING_DAMAGE
static GameRules.Key<GameRules.BooleanRule>	FALL_DAMAGE
static GameRules.Key<GameRules.BooleanRule>	FIRE_DAMAGE
static GameRules.Key<GameRules.BooleanRule>	FORGIVE_DEAD_PLAYERS
static GameRules.Key<GameRules.BooleanRule>	KEEP_INVENTORY A game rule which regulates whether player inventories should be persist through respawning.
static GameRules.Key<GameRules.BooleanRule>	LOG_ADMIN_COMMANDS
private static Logger	LOGGER
static GameRules.Key<GameRules.IntRule>	MAX_COMMAND_CHAIN_LENGTH
static GameRules.Key<GameRules.IntRule>	MAX_ENTITY_CRAMMING A game rule which regulates the number of entities that can be crammed into a block space before they incur cramming damage.
static GameRules.Key<GameRules.BooleanRule>	NATURAL_REGENERATION
static GameRules.Key<GameRules.IntRule>	RANDOM_TICK_SPEED
static GameRules.Key<GameRules.BooleanRule>	REDUCED_DEBUG_INFO A game rule which regulates whether clients' debug HUDs show reduced information.
private static Map<GameRules.Key<?>,GameRules.Type<?>>	RULE_TYPES
private Map<GameRules.Key<?>,GameRules.Rule<?>>	rules
static GameRules.Key<GameRules.BooleanRule>	SEND_COMMAND_FEEDBACK
static GameRules.Key<GameRules.BooleanRule>	SHOW_DEATH_MESSAGES
static GameRules.Key<GameRules.IntRule>	SPAWN_RADIUS
static GameRules.Key<GameRules.BooleanRule>	SPECTATORS_GENERATE_CHUNKS
static GameRules.Key<GameRules.BooleanRule>	UNIVERSAL_ANGER

Constructor Summary

Constructors

Modifier	Constructor and Description
	GameRules()
	GameRules(com.mojang.serialization.DynamicLike<?> dynamicLike)
private	GameRules(Map<GameRules.Key<?>,GameRules.Rule<?>> rules)

Method Summary

Modifier and Type	Method and Description
static void	accept(GameRules.Visitor visitor) Make the visitor visit all registered game rules.
private static <T extends GameRules.Rule<T>> void	accept(GameRules.Visitor consumer, GameRules.Key<?> key, GameRules.Type<?> type)
GameRules	copy()
<T extends GameRules.Rule<T>> T	get(GameRules.Key<T> key)
boolean	getBoolean(GameRules.Key<GameRules.BooleanRule> rule)
int	getInt(GameRules.Key<GameRules.IntRule> rule)
private void	load(com.mojang.serialization.DynamicLike<?> dynamicLike)
private static <T extends GameRules.Rule<T>> GameRules.Key<T>	register(String name, GameRules.Category category, GameRules.Type<T> type)
void	setAllValues(GameRules rules, MinecraftServer server)
private <T extends GameRules.Rule<T>> void	setValue(GameRules.Key<T> key, GameRules rules, MinecraftServer server)
CompoundTag	toNbt()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOGGER

private static final Logger LOGGER

RULE_TYPES

private static final Map<GameRules.Key<?>,GameRules.Type<?>> RULE_TYPES

DO_FIRE_TICK

public static final GameRules.Key<GameRules.BooleanRule> DO_FIRE_TICK

DO_MOB_GRIEFING

public static final GameRules.Key<GameRules.BooleanRule> DO_MOB_GRIEFING

A game rule which regulates whether mobs can modify the world.

Generally one is expected to test this rule before an entity modifies the world.

In vanilla, this includes:

• Whether creeper explosions destroy blocks
• Whether a zombie can break down a door
• Whether a wither killing an entity will place or drop a wither rose

KEEP_INVENTORY

public static final GameRules.Key<GameRules.BooleanRule> KEEP_INVENTORY

A game rule which regulates whether player inventories should be persist through respawning.

DO_MOB_SPAWNING

public static final GameRules.Key<GameRules.BooleanRule> DO_MOB_SPAWNING

A game rule which regulates whether mobs can spawn naturally.

DO_MOB_LOOT

public static final GameRules.Key<GameRules.BooleanRule> DO_MOB_LOOT

A game rule which regulates whether mobs should drop loot on death.

DO_TILE_DROPS

public static final GameRules.Key<GameRules.BooleanRule> DO_TILE_DROPS

A game rule which regulates whether blocks should drop their items when broken.

DO_ENTITY_DROPS

public static final GameRules.Key<GameRules.BooleanRule> DO_ENTITY_DROPS

COMMAND_BLOCK_OUTPUT

public static final GameRules.Key<GameRules.BooleanRule> COMMAND_BLOCK_OUTPUT

NATURAL_REGENERATION

public static final GameRules.Key<GameRules.BooleanRule> NATURAL_REGENERATION

DO_DAYLIGHT_CYCLE

public static final GameRules.Key<GameRules.BooleanRule> DO_DAYLIGHT_CYCLE

LOG_ADMIN_COMMANDS

public static final GameRules.Key<GameRules.BooleanRule> LOG_ADMIN_COMMANDS

SHOW_DEATH_MESSAGES

public static final GameRules.Key<GameRules.BooleanRule> SHOW_DEATH_MESSAGES

RANDOM_TICK_SPEED

public static final GameRules.Key<GameRules.IntRule> RANDOM_TICK_SPEED

SEND_COMMAND_FEEDBACK

public static final GameRules.Key<GameRules.BooleanRule> SEND_COMMAND_FEEDBACK

REDUCED_DEBUG_INFO

public static final GameRules.Key<GameRules.BooleanRule> REDUCED_DEBUG_INFO

A game rule which regulates whether clients' debug HUDs show reduced information.

When the value of this rule is changed, all connected clients will be notified to update their display. In vanilla, this includes the visibility of coordinates on the clients' debug HUDs.

SPECTATORS_GENERATE_CHUNKS

public static final GameRules.Key<GameRules.BooleanRule> SPECTATORS_GENERATE_CHUNKS

SPAWN_RADIUS

public static final GameRules.Key<GameRules.IntRule> SPAWN_RADIUS

DISABLE_ELYTRA_MOVEMENT_CHECK

public static final GameRules.Key<GameRules.BooleanRule> DISABLE_ELYTRA_MOVEMENT_CHECK

MAX_ENTITY_CRAMMING

public static final GameRules.Key<GameRules.IntRule> MAX_ENTITY_CRAMMING

A game rule which regulates the number of entities that can be crammed into a block space before they incur cramming damage.

DO_WEATHER_CYCLE

public static final GameRules.Key<GameRules.BooleanRule> DO_WEATHER_CYCLE

DO_LIMITED_CRAFTING

public static final GameRules.Key<GameRules.BooleanRule> DO_LIMITED_CRAFTING

MAX_COMMAND_CHAIN_LENGTH

public static final GameRules.Key<GameRules.IntRule> MAX_COMMAND_CHAIN_LENGTH

ANNOUNCE_ADVANCEMENTS

public static final GameRules.Key<GameRules.BooleanRule> ANNOUNCE_ADVANCEMENTS

A game rule which regulates whether a player's advancements should be announced in chat.

DISABLE_RAIDS

public static final GameRules.Key<GameRules.BooleanRule> DISABLE_RAIDS

A game rule which regulates whether raids should occur.

If this rule is set to true while raids are occurring, the raids will be stopped.

DO_INSOMNIA

public static final GameRules.Key<GameRules.BooleanRule> DO_INSOMNIA

DO_IMMEDIATE_RESPAWN

public static final GameRules.Key<GameRules.BooleanRule> DO_IMMEDIATE_RESPAWN

A game rule which regulates whether a player should immediately respawn upon death.

DROWNING_DAMAGE

public static final GameRules.Key<GameRules.BooleanRule> DROWNING_DAMAGE

FALL_DAMAGE

public static final GameRules.Key<GameRules.BooleanRule> FALL_DAMAGE

FIRE_DAMAGE

public static final GameRules.Key<GameRules.BooleanRule> FIRE_DAMAGE

DO_PATROL_SPAWNING

public static final GameRules.Key<GameRules.BooleanRule> DO_PATROL_SPAWNING

DO_TRADER_SPAWNING

public static final GameRules.Key<GameRules.BooleanRule> DO_TRADER_SPAWNING

FORGIVE_DEAD_PLAYERS

public static final GameRules.Key<GameRules.BooleanRule> FORGIVE_DEAD_PLAYERS

UNIVERSAL_ANGER

public static final GameRules.Key<GameRules.BooleanRule> UNIVERSAL_ANGER

rules

private final Map<GameRules.Key<?>,GameRules.Rule<?>> rules

Constructor Detail

GameRules

public GameRules(com.mojang.serialization.DynamicLike<?> dynamicLike)

GameRules

public GameRules()

GameRules

private GameRules(Map<GameRules.Key<?>,GameRules.Rule<?>> rules)

Method Detail

register

private static <T extends GameRules.Rule<T>> GameRules.Key<T> register(String name,
                                                                       GameRules.Category category,
                                                                       GameRules.Type<T> type)

get

public <T extends GameRules.Rule<T>> T get(GameRules.Key<T> key)

toNbt

public CompoundTag toNbt()

load

private void load(com.mojang.serialization.DynamicLike<?> dynamicLike)

copy

public GameRules copy()

accept

public static void accept(GameRules.Visitor visitor)

Make the visitor visit all registered game rules.

The visitation involves calling both GameRules.Visitor.visit(GameRules.Key, GameRules.Type) and visitX for every game rule, where X is the current rule's concrete type such as a boolean.

accept

private static <T extends GameRules.Rule<T>> void accept(GameRules.Visitor consumer,
                                                         GameRules.Key<?> key,
                                                         GameRules.Type<?> type)

setAllValues

@Environment(value=CLIENT)
public void setAllValues(GameRules rules,
                                                    @Nullable
                                                    MinecraftServer server)

setValue

@Environment(value=CLIENT)
private <T extends GameRules.Rule<T>> void setValue(GameRules.Key<T> key,
                                                                               GameRules rules,
                                                                               @Nullable
                                                                               MinecraftServer server)

getBoolean

public boolean getBoolean(GameRules.Key<GameRules.BooleanRule> rule)

getInt

public int getInt(GameRules.Key<GameRules.IntRule> rule)