Package org.bukkit
Class GameRule<T>
java.lang.Object
org.bukkit.GameRule<T>
- Type Parameters:
T
- type of rule (Boolean or Integer)
public final class GameRule<T> extends Object
GameRules dictate certain behavior within Minecraft itself
For more information please visit the Minecraft Wiki
For more information please visit the Minecraft Wiki
-
Field Summary
Fields Modifier and Type Field Description static GameRule<Boolean>
ANNOUNCE_ADVANCEMENTS
Toggles the announcing of advancements.static GameRule<Boolean>
COMMAND_BLOCK_OUTPUT
Whether command blocks should notify admins when they perform commands.static GameRule<Boolean>
DISABLE_ELYTRA_MOVEMENT_CHECK
Whether the server should skip checking player speed when the player is wearing elytra.static GameRule<Boolean>
DISABLE_RAIDS
Whether pillager raids are enabled or not.static GameRule<Boolean>
DO_DAYLIGHT_CYCLE
Whether time progresses from the current moment.static GameRule<Boolean>
DO_ENTITY_DROPS
Whether entities that are not mobs should have drops.static GameRule<Boolean>
DO_FIRE_TICK
Whether fire should spread and naturally extinguish.static GameRule<Boolean>
DO_IMMEDIATE_RESPAWN
Whether clients will respawn immediately after death or not.static GameRule<Boolean>
DO_INSOMNIA
Whether phantoms will appear without sleeping or not.static GameRule<Boolean>
DO_LIMITED_CRAFTING
Whether players should only be able to craft recipes they've unlocked first.static GameRule<Boolean>
DO_MOB_LOOT
Whether mobs should drop items.static GameRule<Boolean>
DO_MOB_SPAWNING
Whether mobs should naturally spawn.static GameRule<Boolean>
DO_PATROL_SPAWNING
Whether patrols should naturally spawn.static GameRule<Boolean>
DO_TILE_DROPS
Whether blocks should have drops.static GameRule<Boolean>
DO_TRADER_SPAWNING
Whether traders should naturally spawn.static GameRule<Boolean>
DO_WEATHER_CYCLE
Whether the weather will change from the current moment.static GameRule<Boolean>
DROWNING_DAMAGE
Whether drowning damage is enabled or not.static GameRule<Boolean>
FALL_DAMAGE
Whether fall damage is enabled or not.static GameRule<Boolean>
FIRE_DAMAGE
Whether fire damage is enabled or not.static GameRule<Boolean>
FORGIVE_DEAD_PLAYERS
Whether mobs should cease being angry at a player once they die.static GameRule<Boolean>
KEEP_INVENTORY
Whether the player should keep items in their inventory after death.static GameRule<Boolean>
LOG_ADMIN_COMMANDS
Whether to log admin commands to server log.static GameRule<Integer>
MAX_COMMAND_CHAIN_LENGTH
Determines the number at which the chain of command blocks act as a "chain."
This is the maximum amount of command blocks that can be activated in a single tick from a single chain.static GameRule<Integer>
MAX_ENTITY_CRAMMING
The maximum number of other pushable entities a mob or player can push, before taking suffocation damage.static GameRule<Boolean>
MOB_GRIEFING
Whether mobs can pick up items or change blocks.static GameRule<Boolean>
NATURAL_REGENERATION
Whether players can regenerate health naturally through their hunger bar.static GameRule<Integer>
RANDOM_TICK_SPEED
How often a random block tick occurs (such as plant growth, leaf decay, etc.) per chunk section per game tick.static GameRule<Boolean>
REDUCED_DEBUG_INFO
Whether the debug screen shows all or reduced information.static GameRule<Boolean>
SEND_COMMAND_FEEDBACK
Whether the feedback from commands executed by a player should show up in chat.static GameRule<Boolean>
SHOW_DEATH_MESSAGES
Whether a message appears in chat when a player dies.static GameRule<Integer>
SPAWN_RADIUS
The number of blocks outward from the world spawn coordinates that a player will spawn in when first joining a server or when dying without a spawnpoint.static GameRule<Boolean>
SPECTATORS_GENERATE_CHUNKS
Whether players in spectator mode can generate chunks.static GameRule<Boolean>
UNIVERSAL_ANGER
Whether mobs will target all player entities once angered. -
Method Summary
Modifier and Type Method Description boolean
equals(Object obj)
static GameRule<?>
getByName(String rule)
Get aGameRule
by its name.String
getName()
Get the name of this GameRule.Class<T>
getType()
Get the type of this rule.String
toString()
static GameRule<?>[]
values()
Get an immutable collection ofGameRule
s.
-
Field Details
-
ANNOUNCE_ADVANCEMENTS
Toggles the announcing of advancements. -
COMMAND_BLOCK_OUTPUT
Whether command blocks should notify admins when they perform commands. -
DISABLE_ELYTRA_MOVEMENT_CHECK
Whether the server should skip checking player speed when the player is wearing elytra. -
DO_DAYLIGHT_CYCLE
Whether time progresses from the current moment. -
DO_ENTITY_DROPS
Whether entities that are not mobs should have drops. -
DO_FIRE_TICK
Whether fire should spread and naturally extinguish. -
DO_LIMITED_CRAFTING
Whether players should only be able to craft recipes they've unlocked first. -
DO_MOB_LOOT
Whether mobs should drop items. -
DO_MOB_SPAWNING
Whether mobs should naturally spawn. -
DO_TILE_DROPS
Whether blocks should have drops. -
DO_WEATHER_CYCLE
Whether the weather will change from the current moment. -
KEEP_INVENTORY
Whether the player should keep items in their inventory after death. -
LOG_ADMIN_COMMANDS
Whether to log admin commands to server log. -
MOB_GRIEFING
Whether mobs can pick up items or change blocks. -
NATURAL_REGENERATION
Whether players can regenerate health naturally through their hunger bar. -
REDUCED_DEBUG_INFO
Whether the debug screen shows all or reduced information. -
SEND_COMMAND_FEEDBACK
Whether the feedback from commands executed by a player should show up in chat. Also affects the default behavior of whether command blocks store their output text. -
SHOW_DEATH_MESSAGES
Whether a message appears in chat when a player dies. -
SPECTATORS_GENERATE_CHUNKS
Whether players in spectator mode can generate chunks. -
DISABLE_RAIDS
Whether pillager raids are enabled or not. -
DO_INSOMNIA
Whether phantoms will appear without sleeping or not. -
DO_IMMEDIATE_RESPAWN
Whether clients will respawn immediately after death or not. -
DROWNING_DAMAGE
Whether drowning damage is enabled or not. -
FALL_DAMAGE
Whether fall damage is enabled or not. -
FIRE_DAMAGE
Whether fire damage is enabled or not. -
DO_PATROL_SPAWNING
Whether patrols should naturally spawn. -
DO_TRADER_SPAWNING
Whether traders should naturally spawn. -
FORGIVE_DEAD_PLAYERS
Whether mobs should cease being angry at a player once they die. -
UNIVERSAL_ANGER
Whether mobs will target all player entities once angered. -
RANDOM_TICK_SPEED
How often a random block tick occurs (such as plant growth, leaf decay, etc.) per chunk section per game tick. 0 will disable random ticks, higher numbers will increase random ticks. -
SPAWN_RADIUS
The number of blocks outward from the world spawn coordinates that a player will spawn in when first joining a server or when dying without a spawnpoint. -
MAX_ENTITY_CRAMMING
The maximum number of other pushable entities a mob or player can push, before taking suffocation damage.
Setting to 0 disables this rule. -
MAX_COMMAND_CHAIN_LENGTH
Determines the number at which the chain of command blocks act as a "chain."
This is the maximum amount of command blocks that can be activated in a single tick from a single chain.
-
-
Method Details
-
getName
Get the name of this GameRule.- Returns:
- the name of this GameRule
-
getType
Get the type of this rule.- Returns:
- the rule type; Integer or Boolean
-
equals
-
toString
-
getByName
Get aGameRule
by its name.- Parameters:
rule
- the name of the GameRule- Returns:
- the
GameRule
or null if no GameRule matches the given name
-
values
Get an immutable collection ofGameRule
s.- Returns:
- an immutable collection containing all registered GameRules.
-