Skip to content

levilamina::registry

The engine's own registries: every block type, every item and every entity the running game has, with the facts a rule needs to pick from them.

A mod that hands out "a random block" or "a random rare item" should not keep a list of names of its own: the game has more than any such list, and the list goes stale with every version. It reads these instead and decides by rules (solid, not technical, of this rarity). A host older than the registry_list slot answers with an error, never with an empty list that would look like a game without content.

Functions

registry::blocks

Rust
1
pub fn blocks() -> Result<Vec<BlockType>>

Every block type.

registry::items

Rust
1
pub fn items() -> Result<Vec<ItemType>>

Every item, each once under its own full name.

registry::entities

Rust
1
pub fn entities() -> Result<Vec<EntityType>>

Every entity the level knows.

EntityType

Rust
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
pub struct EntityType {
    pub name: String,
    #[serde(default)]
    pub spawn_egg: bool,
    #[serde(default)]
    pub summonable: bool,
    /// An experiment has to be on for it to exist.
    #[serde(default)]
    pub experimental: bool,
    /// The engine's actor type number; see [`EntityType::is_monster`] and the others.
    #[serde(default, rename = "type", deserialize_with = "whole")]
    pub type_id: i64,
}

One entity the level knows.

  • Implements: Debug, Clone, PartialEq, serde::Deserialize

EntityType::is_mob

Rust
1
pub fn is_mob(&self) -> bool
  • Return type: bool

EntityType::is_monster

Rust
1
pub fn is_monster(&self) -> bool
  • Return type: bool

EntityType::is_animal

Rust
1
pub fn is_animal(&self) -> bool

A land animal: the animal bit without the water-animal one.

  • Return type: bool

EntityType::is_water_animal

Rust
1
pub fn is_water_animal(&self) -> bool
  • Return type: bool

BlockType

Rust
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
pub struct BlockType {
    pub name: String,
    /// A [`category`] value.
    #[serde(default, deserialize_with = "whole")]
    pub category: i32,
    #[serde(default)]
    pub solid: bool,
    #[serde(default)]
    pub vanilla: bool,
    #[serde(default)]
    pub container: bool,
    /// Gives a redstone signal of its own, as a lever or a button does.
    #[serde(default)]
    pub signal: bool,
    #[serde(default)]
    pub fence: bool,
    #[serde(default)]
    pub rail: bool,
    #[serde(default)]
    pub slab: bool,
    #[serde(default)]
    pub wall: bool,
    #[serde(default)]
    pub crop: bool,
    /// Holds a block entity: a chest, a sign, a spawner, a bed.
    #[serde(default)]
    pub entity: bool,
    /// Bare-hand destroy speed; negative for a block nothing breaks.
    #[serde(default)]
    pub destroy: f64,
    #[serde(default)]
    pub resistance: f64,
    /// The light it emits, 0 to 15.
    #[serde(default, deserialize_with = "whole")]
    pub light: i32,
    /// The localization key.
    #[serde(default)]
    pub description: String,
}

One block type, read from its default state.

  • Implements: Debug, Clone, PartialEq, serde::Deserialize

ItemType

Rust
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
pub struct ItemType {
    pub name: String,
    /// 0 common, 1 uncommon, 2 rare, 3 epic.
    #[serde(default, deserialize_with = "whole")]
    pub rarity: i32,
    #[serde(default, deserialize_with = "whole")]
    pub stack: i32,
    /// A [`category`] value.
    #[serde(default, deserialize_with = "whole")]
    pub category: i32,
    /// Commands do not offer it.
    #[serde(default)]
    pub hidden: bool,
}

One item.

  • Implements: Debug, Clone, PartialEq, serde::Deserialize

Constants

Name Value Description
ALL 0
CONSTRUCTION 1
NATURE 2
EQUIPMENT 3
ITEMS 4
COMMAND_ONLY 5 Reachable by commands only: barriers, command blocks, structure blocks and the like.
UNDEFINED 6