Skip to main content

ComponentEntry

Struct ComponentEntry 

Source
pub struct ComponentEntry {
    pub key: Identifier,
    codecs: ComponentCodecs,
    ignore_swap_animation: bool,
}
Expand description

Metadata for a registered component type.

Contains the component’s key and all serialization functions needed to read/write the component for network and persistent storage.

Fields§

§key: Identifier

The component’s identifier (e.g., “minecraft:damage”)

§codecs: ComponentCodecs§ignore_swap_animation: bool

Implementations§

Source§

impl ComponentEntry

Source

pub(super) fn implemented( key: Identifier, expected_type_key: DowncastTypeKey, network_reader: NetworkReader, network_writer: NetworkWriter, persistent_codecs: Option<(NbtReader, NbtWriter, fn(&ComponentData) -> Result<i32>, Option<fn(&ComponentData) -> Result<()>>)>, ignore_swap_animation: bool, ) -> Self

Source

pub fn validates(&self, data: &ComponentData) -> bool

Validates that a ComponentData value matches the concrete type for this component.

Returns true if the data is valid for this component type, false otherwise. This prevents plugins from setting wrong types on vanilla components.

Source

pub fn read_network(&self, data: &mut Cursor<&[u8]>) -> Result<ComponentData>

Decodes this component’s network value.

Source

pub fn write_network( &self, data: &ComponentData, writer: &mut Vec<u8>, ) -> Result<()>

Encodes this component’s network value after validating its concrete type.

Source

pub fn read_nbt(&self, tag: BorrowedNbtTag<'_, '_>) -> Option<ComponentData>

Decodes this component’s persistent NBT value.

Source

pub fn write_nbt(&self, data: &ComponentData) -> Result<OwnedNbtTag>

Encodes this component’s persistent NBT value after validating its concrete type.

Source

pub fn validate_persistent_encoding( &self, data: &ComponentData, ) -> Result<OwnedNbtTag>

Checks that a value accepted by the stream codec is also accepted by the persistent codec.

Source

pub fn compute_hash(&self, data: &ComponentData) -> Result<i32>

Computes the vanilla HashOps value through this component’s persistent codec.

Source

pub const fn is_persistent(&self) -> bool

Returns whether vanilla defines this as a persistent component.

Source

pub const fn ignore_swap_animation(&self) -> bool

Returns whether changes to this component are ignored for held-item swap animation.

Source

pub fn read_nbt_owned(&self, tag: &OwnedNbtTag) -> Option<ComponentData>

Decodes an owned NBT value with this component’s registered persistent codec.

Trait Implementations§

Source§

impl Eq for ComponentEntry

Source§

impl PartialEq for ComponentEntry

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
Source§

impl RegistryEntry for ComponentEntry

Source§

fn key(&self) -> &Identifier

Source§

fn try_id(&self) -> Option<usize>

Source§

fn id(&self) -> usize

Panics Read more

Auto Trait Implementations§

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<E> StatValueRegistryEntry for E
where E: RegistryEntry + Send + Sync,

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