api/org.kryptonmc.api.world.rule/GameRule

GameRule

@CataloguedBy(catalogue = GameRules::class)
interface GameRule<V> : Translatable

A rule dictating how a specific aspect of the game functions.

Parameters

V

the type of the value

Types

Link copied to clipboard
object Companion
Link copied to clipboard
@ApiStatus.Internal
interface Factory

Functions

Link copied to clipboard
@NotNull
abstract fun translationKey(): @NotNull String

Properties

Link copied to clipboard
@get:JvmName(name = "defaultValue")
abstract val defaultValue: V

The default value of this rule.

Link copied to clipboard
@get:JvmName(name = "name")
abstract val name: String

The name of this rule.