Struct voxelize::World

pub struct World {
    pub id: String,
    pub name: String,
    pub started: bool,
    pub preloading: bool,
    pub preload_progress: f32,
    /* 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.

preloading: bool

Whether if the world is preloading.

preload_progress: f32

The progress of preloading.

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 set_dispatcher<F: Fn() -> DispatcherBuilder<'static, 'static> + 'static>( &mut self, dispatch: F )

pub fn set_client_modifier<F: Fn(&mut World, Entity) + 'static>( &mut self, modifier: F )

pub fn set_client_parser<F: Fn(&mut World, &str, Entity) + 'static>( &mut self, parser: F )

pub fn set_method_handle<F: Fn(&mut World, &str, &str) + 'static>( &mut self, method: &str, handle: F )

pub fn set_event_handle<F: Fn(&mut World, &str, &str) + 'static>( &mut self, event: &str, handle: F )

pub fn set_transport_handle<F: Fn(&mut World, Value) + 'static>( &mut self, handle: F )

pub fn set_command_handle<F: Fn(&mut World, &str, &str) + 'static>( &mut self, handle: F )

pub fn set_entity_loader<F: Fn(&mut World, MetadataComp) -> EntityBuilder<'_> + 'static>( &mut self, etype: &str, loader: F )

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 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 chunk_interest(&self) -> Fetch<'_, ChunkInterests>

Access the chunk interests manager in the ECS world.

pub fn chunk_interest_mut(&mut self) -> FetchMut<'_, ChunkInterests>

Access the mutable chunk interest 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 stats(&self) -> Fetch<'_, Stats>

Access the stats manager in the ECS world.

pub fn stats_mut(&mut self) -> FetchMut<'_, Stats>

Access the mutable stats manager in 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 mesher(&self) -> Fetch<'_, Mesher>

Access the mesher in the ECS world.

pub fn mesher_mut(&mut self) -> FetchMut<'_, Mesher>

Access a mutable mesher in the ECS world.

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

Create a basic entity ready to be added more.

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

Create a basic entity ready to be added more.

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

Create a basic entity ready to be added more.

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

Spawn an entity of type at a location.

pub fn revive_entity( &mut self, id: &str, etype: &str, metadata: MetadataComp ) -> Option<Entity>

pub fn populate_entity( &mut self, ent: Entity, id: &str, etype: &str, metadata: MetadataComp )

pub fn is_empty(&self) -> bool

Check if this world is empty.