Skip to main content

GameRule

steel_registry::game_rules

Struct GameRule 

Source 
pub struct GameRule<T: GameRuleValueType> {
    key: Identifier,
    category: GameRuleCategory,
    value_type: GameRuleType,
    default_value: T,
    min_value: Option<i32>,
    max_value: Option<i32>,
    codec: GameRuleCodec<T>,
}
Expand description

A typed game rule definition.

Fields§

§key: Identifier§category: GameRuleCategory§value_type: GameRuleType§default_value: T§min_value: Option<i32>§max_value: Option<i32>§codec: GameRuleCodec<T>

Implementations§

Source§

impl<T: GameRuleValueType> GameRule<T>

Source

pub const fn key(&self) -> &Identifier

Source

pub const fn category(&self) -> GameRuleCategory

Source

pub const fn value_type(&self) -> GameRuleType

Source

pub const fn default_value(&self) -> &T

Source

pub const fn min_value(&self) -> Option<i32>

Source

pub const fn max_value(&self) -> Option<i32>

Source

fn validates(&self, value: &T) -> bool

Source§

impl GameRule<bool>

Source

pub const fn boolean( key: Identifier, category: GameRuleCategory, default_value: bool, ) -> Self

Source§

impl GameRule<i32>

Source

pub const fn integer( key: Identifier, category: GameRuleCategory, default_value: i32, min_value: Option<i32>, max_value: Option<i32>, ) -> Self

Trait Implementations§

Source§

impl<T: Debug + GameRuleValueType> Debug for GameRule<T>

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<T: GameRuleValueType> Eq for GameRule<T>

Source§

impl<T: GameRuleValueType> ErasedGameRule for GameRule<T>

Source§

fn key(&self) -> &Identifier

Source§

fn category(&self) -> GameRuleCategory

Source§

fn value_type(&self) -> GameRuleType

Source§

fn min_value(&self) -> Option<i32>

Source§

fn max_value(&self) -> Option<i32>

Source§

fn default_erased_value(&self) -> GameRuleValue

Source§

fn validates_erased_value(&self, value: &GameRuleValue) -> bool

Source§

fn serialize_erased_value(&self, value: &GameRuleValue) -> Value

Source§

fn deserialize_erased_value(&self, value: &Value) -> Option<GameRuleValue>

Source§

fn erased_command_result(&self, value: &GameRuleValue) -> i32

Source§

impl<T: GameRuleValueType> PartialEq for GameRule<T>

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more

Auto Trait Implementations§

§

impl<T> Freeze for GameRule<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for GameRule<T>
where T: RefUnwindSafe,

§

impl<T> Send for GameRule<T>

§

impl<T> Sync for GameRule<T>

§

impl<T> Unpin for GameRule<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for GameRule<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for GameRule<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoShared for T

Source§

fn into_shared(self) -> Arc<Mutex<RawMutex, Self>> ⓘ

Wraps this value in an Arc<SyncMutex<>>
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more