Struct naia_shared::Manifest

pub struct Manifest<T: EventType, U: ActorType> { /* fields omitted */ }

Contains the shared protocol between Client & Server, with a data that is able to map Event/Actor TypeIds to their representation within specified enums. Also is able to create new Event/Actors using registered Builders, given a specific TypeId.

Implementations

impl<T: EventType, U: ActorType> Manifest<T, U>

pub fn new() -> Self

Create a new Manifest

pub fn register_event(&mut self, event_builder: Box<dyn EventBuilder<T>>)

Register an EventBuilder to handle the creation of Event instances

pub fn get_event_naia_id(&self, type_id: &TypeId) -> u16

Given an Event's TypeId, get a NaiaId (that can be written/read from packets)

pub fn create_event(
    &self,
    naia_id: u16,
    reader: &mut PacketReader<'_>
) -> Option<T>

Creates an Event instance, given a NaiaId and a payload, typically from an incoming packet

pub fn register_actor(&mut self, actor_builder: Box<dyn ActorBuilder<U>>)

Register an ActorBuilder to handle the creation of Actor instances

pub fn get_actor_naia_id(&self, type_id: &TypeId) -> u16

Given an Actor's TypeId, get a NaiaId (that can be written/read from packets)

pub fn create_actor(
    &self,
    naia_id: u16,
    reader: &mut PacketReader<'_>
) -> Option<U>

Creates an Event instance, given a NaiaId and a payload, typically from an incoming packet

pub fn register_pawn(
    &mut self,
    actor_builder: Box<dyn ActorBuilder<U>>,
    event_builder: Box<dyn EventBuilder<T>>
)

Register both an ActorBuilder and an EventBuilder to handle the creation of both as a Pawn & Command, respectively. Pawns & Commands should be used for any player-controlled actor that requires clientside prediction

Trait Implementations

impl<T: Debug + EventType, U: Debug + ActorType> Debug for Manifest<T, U>

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

Formats the value using the given formatter.