GameRule (TridentSDK 0.4-SNAPSHOT API)

java.lang.Object
- java.lang.Enum<GameRule>
- - net.tridentsdk.world.settings.GameRule

All Implemented Interfaces:

Serializable, Comparable<GameRule>
```
public enum GameRule
extends Enum<GameRule>
```
Gamerules are applied on a per-world basis and are options for more advanced/low-level properties of the world such as command blocks, drops, and inventory modifiers
The default value for all game rules is true except for REDUCED_DEBUG_INFO and KEEP_INVENTORY, which are both false by default

Since:

0.4-alpha

Author:

The TridentSDK Team

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class GameRule.Value
Represents a value which can be possessed by the game rule

Nested Classes
Modifier and Type	Class and Description
`static class`	`GameRule.Value` Represents a value which can be possessed by the game rule

Enum Constant Summary

Enum Constants
Enum Constant and Description
`COMMAND_BLOCK_OUTPUT` Whether command blocks should notify admins when they perform commands
`DO_DAYLIGHT_CYCLE` Whether time progresses
`DO_ENTITY_DROPS` Whether entities that are not mobs should have drops
`DO_FIRE_TICK` Whether fire should spread and naturally extinguish
`DO_MOB_LOOT` Whether mobs should drop items
`DO_MOB_SPAWNING` Whether mobs should naturally spawn
`DO_TILE_DROPS` Whether blocks should have drops
`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 creepers, zombies, endermen, ghasts, withers, ender dragons, rabbits, sheep, and villagers should be able to change blocks and whether villagers, zombies, skeletons, and zombie pigmen can pick up items
`NATURAL_REGENERATION` Whether the player can regenerate health naturally if their hunger is full enough (doesn't affect external healing, such as golden apples, the Regeneration effect, etc.)
`RANDOM_TICK_SPEED` How often a random block tick occurs (such as plant growth, leaf decay, etc.) per chunk section per game tick.
`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.
`SHOW_DEATH_MESSAGES` Whether a message appears in chat when a player dies
`SPECTATORS_GENERATE_CHUNKS` Whether players in spectator mode can generate chunks

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`boolEqualToValue(boolean b)` Checks if the argument matches the default value
`GameRule.Value`	`defaultValue()` Obtains the default value of the game rule
`boolean`	`intEqualToValue(int i)` Checks if the argument matches the default value
`String`	`toString()`
`static GameRule`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static GameRule[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - COMMAND_BLOCK_OUTPUT
```
public static final GameRule COMMAND_BLOCK_OUTPUT
```
    Whether command blocks should notify admins when they perform commands
  - DO_DAYLIGHT_CYCLE
```
public static final GameRule DO_DAYLIGHT_CYCLE
```
    Whether time progresses
  - DO_ENTITY_DROPS
```
public static final GameRule DO_ENTITY_DROPS
```
    Whether entities that are not mobs should have drops
  - DO_FIRE_TICK
```
public static final GameRule DO_FIRE_TICK
```
    Whether fire should spread and naturally extinguish
  - DO_MOB_LOOT
```
public static final GameRule DO_MOB_LOOT
```
    Whether mobs should drop items
  - DO_MOB_SPAWNING
```
public static final GameRule DO_MOB_SPAWNING
```
    Whether mobs should naturally spawn
  - DO_TILE_DROPS
```
public static final GameRule DO_TILE_DROPS
```
    Whether blocks should have drops
  - KEEP_INVENTORY
```
public static final GameRule KEEP_INVENTORY
```
    Whether the player should keep items in their inventory after death
  - LOG_ADMIN_COMMANDS
```
public static final GameRule LOG_ADMIN_COMMANDS
```
    Whether to log admin commands to server log
  - MOB_GRIEFING
```
public static final GameRule MOB_GRIEFING
```
    Whether creepers, zombies, endermen, ghasts, withers, ender dragons, rabbits, sheep, and villagers should be able to change blocks and whether villagers, zombies, skeletons, and zombie pigmen can pick up items
  - NATURAL_REGENERATION
```
public static final GameRule NATURAL_REGENERATION
```
    Whether the player can regenerate health naturally if their hunger is full enough (doesn't affect external healing, such as golden apples, the Regeneration effect, etc.)
  - RANDOM_TICK_SPEED
```
public static final GameRule RANDOM_TICK_SPEED
```
    How often a random block tick occurs (such as plant growth, leaf decay, etc.) per chunk section per game tick.
    Default value: 3
    
    0 will disable random ticks, higher numbers will increase random ticks
  - REDUCED_DEBUG_INFO
```
public static final GameRule REDUCED_DEBUG_INFO
```
    Whether the debug screen shows all or reduced information
  - SEND_COMMAND_FEEDBACK
```
public static final GameRule 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
```
public static final GameRule SHOW_DEATH_MESSAGES
```
    Whether a message appears in chat when a player dies
  - SPECTATORS_GENERATE_CHUNKS
```
public static final GameRule SPECTATORS_GENERATE_CHUNKS
```
    Whether players in spectator mode can generate chunks
- Method Detail
  - values
```
public static GameRule[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (GameRule c : GameRule.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static GameRule valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - defaultValue
```
public GameRule.Value defaultValue()
```
    Obtains the default value of the game rule
    
    Returns:
    
    the default value
  - boolEqualToValue
```
public boolean boolEqualToValue(boolean b)
```
    Checks if the argument matches the default value
    
    Parameters:
    
    b - the boolean to check
    
    Returns:
    
    true if it matches, false otherwise
  - intEqualToValue
```
public boolean intEqualToValue(int i)
```
    Checks if the argument matches the default value
    
    Parameters:
    
    i - the integer to check
    
    Returns:
    
    true if it matches, false otherwise
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Enum<GameRule>

Enum GameRule

Nested Class Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

COMMAND_BLOCK_OUTPUT

DO_DAYLIGHT_CYCLE

DO_ENTITY_DROPS

DO_FIRE_TICK

DO_MOB_LOOT

DO_MOB_SPAWNING

DO_TILE_DROPS

KEEP_INVENTORY

LOG_ADMIN_COMMANDS

MOB_GRIEFING

NATURAL_REGENERATION

RANDOM_TICK_SPEED

REDUCED_DEBUG_INFO

SEND_COMMAND_FEEDBACK

SHOW_DEATH_MESSAGES

SPECTATORS_GENERATE_CHUNKS

Method Detail

values

valueOf

defaultValue

boolEqualToValue

intEqualToValue

toString