Struct voxelize::World

pub struct World {
    pub id: String,
    pub name: String,
    pub started: bool,
    /* private fields */
}

A voxelize world.

Fields

id: String

ID of the world, generated from nanoid!().

name: String

Name of the world, used for connection.

started: bool

Whether if the world has started.

Implementations

impl World

pub fn new(name: &str, config: &WorldConfig) -> Self

Create a new voxelize world.

pub fn ecs(&self) -> &ECSWorld

Get a reference to the ECS world..

pub fn ecs_mut(&mut self) -> &mut ECSWorld

Get a mutable reference to the ECS world.

pub fn add<T: Component>(&mut self, e: Entity, c: T)

Insert a component into an entity.

pub fn remove<T: Component>(&mut self, e: Entity)

Remove a component type from an entity.

pub fn read_resource<T: Resource>(&self) -> Fetch<'_, T>

Read an ECS resource generically.

pub fn write_resource<T: Resource>(&mut self) -> FetchMut<'_, T>

Write an ECS resource generically.

pub fn read_component<T: Component>(&self) -> ReadStorage<'_, T>

Read an ECS component storage.

pub fn write_component<T: Component>(&mut self) -> WriteStorage<'_, T>

Write an ECS component storage.

pub fn get_id(&self, entity: Entity) -> String

Get an ID from IDComp from an entity

pub fn add_transport(&mut self, id: &str, addr: &Recipient<EncodedMessage>)

Add a transport address to this world.

pub fn remove_transport(&mut self, id: &str)

Remove a transport address from this world.

pub fn add_client(
    &mut self,
    id: &str,
    username: &str,
    addr: &Recipient<EncodedMessage>
)

Add a client to the world by an ID and an Actix actor address.

pub fn remove_client(&mut self, id: &str)

Remove a client from the world by endpoint.

pub fn set_dispatcher(&mut self, dispatch: ModifyDispatch)

pub fn set_client_modifier(&mut self, modifier: CustomFunction<Entity>)

pub fn set_client_parser(&mut self, parser: ClientParser)

pub fn set_method_handle(&mut self, method: &str, handle: CustomFunction<Value>)

pub fn set_transport_handle(&mut self, handle: CustomFunction<Value>)

pub fn generate_init_message(&self, id: &str) -> Message

pub fn on_request(&mut self, client_id: &str, data: Message)

Handler for protobuf requests from clients.

pub fn broadcast(&mut self, data: Message, filter: ClientFilter)

Broadcast a protobuf message to a subset or all of the clients in the world.

pub fn send(&self, addr: &Recipient<EncodedMessage>, data: &Message)

Send a direct message to an endpoint

pub fn config(&self) -> Fetch<'_, WorldConfig>

Access to the world’s config.

pub fn clients(&self) -> Fetch<'_, Clients>

Access all clients in the ECS world.

pub fn clients_mut(&mut self) -> FetchMut<'_, Clients>

Access a mutable clients map in the ECS world.

pub fn entities(&self) -> Fetch<'_, Entities>

Access all entities metadata save-load manager.

pub fn entities_mut(&mut self) -> FetchMut<'_, Entities>

Access a mutable entities metadata save-load manager.

pub fn registry(&self) -> Fetch<'_, Registry>

Access the registry in the ECS world.

pub fn chunks(&self) -> Fetch<'_, Chunks>

Access chunks management in the ECS world.

pub fn chunks_mut(&mut self) -> FetchMut<'_, Chunks>

Access a mutable chunk manager in the ECS world.

pub fn physics(&self) -> Fetch<'_, Physics>

Access physics management in the ECS world.

pub fn physics_mut(&mut self) -> FetchMut<'_, Physics>

Access a mutable physics manager in the ECS world.

pub fn events(&self) -> Fetch<'_, Events>

Access the event queue in the ECS world.

pub fn events_mut(&mut self) -> FetchMut<'_, Events>

Access the mutable events queue in the ECS world.

pub fn search(&self) -> Fetch<'_, Search>

Access the search tree in the ECS world.

pub fn search_mut(&mut self) -> FetchMut<'_, Search>

Access the mutable search tree in the ECS world.

pub fn terrain(&self) -> Fetch<'_, SeededTerrain>

Access the terrain of the ECS world.

pub fn terrain_mut(&mut self) -> FetchMut<'_, SeededTerrain>

Access a mutable terrain of the ECS world.

pub fn pipeline(&self) -> Fetch<'_, Pipeline>

Access pipeline management in the ECS world.

pub fn pipeline_mut(&mut self) -> FetchMut<'_, Pipeline>

Access a mutable pipeline management in the ECS world.

pub fn create_entity(&mut self, id: &str, etype: &str) -> EntityBuilder<'_>

Create a basic entity ready to be added more.

pub fn spawn_entity(
    &mut self,
    etype: &str,
    position: &Vec3<f32>
) -> Option<Entity>

Spawn an entity of type at a location.

pub fn is_empty(&self) -> bool

Check if this world is empty.

pub fn prepare(&mut self)

Prepare to start.

pub fn tick(&mut self)

Tick of the world, run every 16ms.

Trait Implementations

impl Default for World

fn default() -> World

Returns the “default value” for a type.