Struct ClientInformation

pub struct ClientInformation {
    pub language: String,
    pub view_distance: u8,
    pub chat_visibility: ChatVisibility,
    pub chat_colors: bool,
    pub model_customization: ModelCustomization,
    pub main_hand: HumanoidArm,
    pub text_filtering_enabled: bool,
    pub allows_listing: bool,
    pub particle_status: ParticleStatus,
}

A component that contains some of the “settings” for this client that are sent to the server, such as render distance. This is only present on local players.

Fields

language: String

The locale of the client.

view_distance: u8

The view distance of the client in chunks, same as the render distance in-game.

chat_visibility: ChatVisibility

The types of chat messages the client wants to receive. Note that many servers ignore this.

chat_colors: bool

Whether the messages sent from the server should have colors. Note that many servers ignore this and always send colored messages.

model_customization: ModelCustomization

main_hand: HumanoidArm

text_filtering_enabled: bool

allows_listing: bool

Whether the client should show up as “Anonymous Player” in the server list.

particle_status: ParticleStatus

Trait Implementations

impl AzaleaRead for ClientInformation

fn azalea_read( buf: &mut Cursor<&[u8]>, ) -> Result<ClientInformation, BufReadError>

impl AzaleaWrite for ClientInformation

fn azalea_write(&self, buf: &mut impl Write) -> Result<(), Error>

impl Clone for ClientInformation

fn clone(&self) -> ClientInformation

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for ClientInformation

where ClientInformation: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have [Component<Mutability = Mutable>], while immutable components will instead have [Component<Mutability = Immutable>].

fn register_required_components( requiree: ComponentId, components: &mut ComponentsRegistrator<'_>, required_components: &mut RequiredComponents, inheritance_depth: u16, recursion_check_stack: &mut Vec<ComponentId>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn register_component_hooks(hooks: &mut ComponentHooks)

👎Deprecated since 0.16.0: Use the individual hook methods instead (e.g., Component::on_add, etc.)

Called when registering this component, allowing mutable access to its [ComponentHooks].

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add [ComponentHook] for this [Component] if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert [ComponentHook] for this [Component] if one is defined.

fn on_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace [ComponentHook] for this [Component] if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove [ComponentHook] for this [Component] if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn [ComponentHook] for this [Component] if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given [EntityMapper]. This is used to remap entities in contexts like scenes and entity cloning. When deriving [Component], this is populated by annotating fields containing entities with #[entities]

impl Debug for ClientInformation

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

Formats the value using the given formatter.

impl Default for ClientInformation

fn default() -> ClientInformation

Returns the “default value” for a type.

impl PartialEq for ClientInformation

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ClientInformation

impl StructuralPartialEq for ClientInformation