Struct voxelize::Registry

pub struct Registry {
    pub ranges: HashMap<String, UV>,
    pub blocks_by_name: HashMap<String, Block>,
    pub blocks_by_id: HashMap<u32, Block>,
    pub textures: HashSet<String>,
    /* private fields */
}

A collection of blocks to use in a Voxelize server. One server has one registry and one registry only. Once a registry is added to a server, it cannot be changed.

Fields

ranges: HashMap<String, UV>

A map of the UV’s to the block faces on the texture atlas.

blocks_by_name: HashMap<String, Block>

Block records, name -> Block.

blocks_by_id: HashMap<u32, Block>

Block records, id -> Block.

textures: HashSet<String>

List of textures that this registry has. Textures are then applied onto block sides.

Implementations

impl Registry

pub fn new() -> Self

Create a registry instance. By default, the “Air” block is registered at ID of 0.

pub fn generate(&mut self)

Generate the UV coordinates of the blocks. Call this before the server starts!

pub fn register_blocks(&mut self, blocks: &[Block])

Register multiple blocks into this world. The block ID’s are assigned to the length of the blocks at registration.

pub fn register_block(&mut self, block: &Block)

Register a block into this world. The block ID is assigned to the length of the blocks registered.

pub fn get_block_by_name(&self, name: &str) -> &Block

Get a block reference by block name.

pub fn get_block_by_id(&self, id: u32) -> &Block

Get a block reference by block ID.

pub fn get_id_by_name(&self, name: &str) -> u32

Get a block id by block name.

pub fn get_fluiditiy_by_id(&self, id: u32) -> bool

Get block fluidity by id.

pub fn get_fluiditiy_by_name(&self, name: &str) -> bool

Get block fluidity by name.

pub fn get_opacity_by_id(&self, id: u32) -> bool

Get block opacity by id.

pub fn get_opacity_by_name(&self, name: &str) -> bool

Get block opacity by name.

pub fn get_emptiness_by_id(&self, id: u32) -> bool

Get block emptiness by id.

pub fn get_emptiness_by_name(&self, name: &str) -> bool

Get block emptiness by name.

pub fn get_faces_by_id(&self, id: u32) -> &Vec<BlockFace>

Get block faces by id.

pub fn get_faces_by_name(&self, name: &str) -> &Vec<BlockFace>

Get block faces by name.

pub fn get_uv_by_id(&self, id: u32) -> HashMap<String, &UV>

Get block UV by id.

pub fn get_uv_by_name(&self, name: &str) -> HashMap<String, &UV>

Get block UV by name.

pub fn is_air(&self, id: u32) -> bool

Check if block is air by id.

pub fn is_fluid(&self, id: u32) -> bool

Check if block is fluid by id.

pub fn get_type_map(&self, blocks: &[&str]) -> HashMap<String, u32>

Get type map of all blocks.

pub fn check_height(&self, id: u32) -> bool

Logic for checking max height, returning true if id counts as valid max height.

pub fn has_type(&self, id: u32) -> bool

Check if registry contains type.

pub fn get_uv_map(&self, block: &Block) -> HashMap<String, &UV>

Get UV map by block.

Trait Implementations

impl Clone for Registry

fn clone(&self) -> Registry

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Registry

fn default() -> Registry

Returns the “default value” for a type.