Struct World 

pub struct World {
    pub dim: String,
}

A dimension (minecraft:overworld): every action whose first field is dim.

Fields

dim: String

Implementations

impl World

pub fn new(dim: impl Into<String>) -> World

pub fn overworld() -> World

pub fn property(&self, pos: BlockPos, name: &str) -> Option<String>

Property name of the block at pos ("energized" → "true").

pub fn set_properties(&self, pos: BlockPos, properties: &str) -> bool

Sets some properties of the block at pos ("energized=true,powered=false"), keeping the rest; false if there’s no block or the state doesn’t take.

impl World

pub fn nbt(&self, pos: impl Arg<BlockPos>) -> Option<String>

A block entity’s data as SNBT.

impl World

pub fn set_nbt(&self, pos: impl Arg<BlockPos>, snbt: impl Arg<String>) -> bool

Merges snbt into a block entity’s data.

impl World

pub fn state(&self, pos: impl Arg<BlockPos>) -> Option<String>

The block state at pos (minecraft:oak_log[axis=y]).

impl World

pub fn set_state( &self, pos: impl Arg<BlockPos>, state: impl Arg<String>, ) -> bool

Sets the block state at pos.

impl World

pub fn info(&self, pos: impl Arg<BlockPos>) -> Option<BlockInfo>

The block’s state.

impl World

pub fn destroy( &self, pos: impl Arg<BlockPos>, drop: impl Arg<bool>, breaker: impl Arg<String>, ) -> bool

Breaks the block (dropping it or not).

impl World

pub fn bonemeal(&self, pos: impl Arg<BlockPos>) -> bool

Applies bone meal to the block.

impl World

pub fn use_item( &self, pos: impl Arg<BlockPos>, face: impl Arg<u8>, item: impl Arg<String>, player: impl Arg<String>, ) -> bool

Uses item on a face of the block, as player would.

impl World

pub fn pour_fluid( &self, pos: impl Arg<BlockPos>, bucket: impl Arg<String>, ) -> bool

Empties a bucket at pos.

impl World

pub fn redstone_power(&self, pos: impl Arg<BlockPos>) -> Option<u8>

The redstone power reaching the block; None without the dimension.

impl World

pub fn redstone_signal(&self, pos: impl Arg<BlockPos>) -> Option<u8>

The strongest signal the block gives out; None if it gives none.

impl World

pub fn set_redstone_output( &self, pos: impl Arg<BlockPos>, level: impl Arg<i32>, ) -> bool

Sets a mod block’s redstone output.

impl World

pub fn inventory_slot( &self, pos: impl Arg<BlockPos>, slot: impl Arg<u32>, ) -> Option<Stack>

A container’s slot.

impl World

pub fn set_inventory_slot( &self, pos: impl Arg<BlockPos>, slot: impl Arg<u32>, item: impl Arg<String>, count: impl Arg<u32>, snbt: impl Arg<String>, ) -> bool

Sets a container’s slot.

impl World

pub fn set_block_tint( &self, pos: impl Arg<BlockPos>, color: impl Arg<i32>, ) -> bool

Tints the block at pos on this client (0xRRGGBB; -1 clears it).

impl World

pub fn spawn_item( &self, pos: impl Arg<Point>, velocity: impl Arg<Point>, item: impl Arg<String>, count: impl Arg<u32>, snbt: impl Arg<String>, ) -> Option<String>

Drops a stack into the world; the item entity’s uuid.

impl World

pub fn spawn_particles( &self, pos: impl Arg<Point>, particle: impl Arg<String>, count: impl Arg<i32>, spread: impl Arg<Point>, speed: impl Arg<f64>, ) -> bool

Spawns count particles around pos.

impl World

pub fn play( &self, pos: impl Arg<Point>, sound: impl Arg<String>, volume: impl Arg<f32>, pitch: impl Arg<f32>, ) -> bool

Plays sound at pos.

impl World

pub fn get_block(&self, pos: impl Arg<BlockPos>) -> Option<String>

The block at pos (minecraft:stone); None without the dimension.

impl World

pub fn set_block( &self, pos: impl Arg<BlockPos>, block: impl Arg<String>, ) -> bool

Sets the block at pos; whether it did.

impl World

pub fn time(&self) -> Option<i64>

The time of day of dim; None without the dimension.

impl World

pub fn set_time(&self, time: impl Arg<i64>) -> bool

Sets the time of day (0 dawn, 6000 noon, 12000 dusk, 18000 midnight).

impl World

pub fn is_raining(&self) -> bool

Whether it rains in dim.

impl World

pub fn set_weather( &self, raining: impl Arg<bool>, duration: impl Arg<i32>, ) -> bool

Starts or stops rain for duration ticks.

impl World

pub fn is_thundering(&self) -> bool

Whether it thunders in dim.

impl World

pub fn set_thunder( &self, thundering: impl Arg<bool>, duration: impl Arg<i32>, ) -> bool

Starts or stops thunder.

impl World

pub fn fill_region( &self, from: impl Arg<BlockPos>, to: impl Arg<BlockPos>, state: impl Arg<String>, ) -> Option<u32>

Fills a box with state; how many blocks changed (None: failed).

impl World

pub fn scan_region( &self, from: impl Arg<BlockPos>, to: impl Arg<BlockPos>, ) -> Vec<PlacedBlock>

The non-air blocks in a box.

impl World

pub fn place_feature( &self, pos: impl Arg<BlockPos>, feature: impl Arg<String>, ) -> bool

Places a configured feature at pos.

impl World

pub fn explode( &self, pos: impl Arg<Point>, power: impl Arg<f32>, fire: impl Arg<bool>, source: impl Arg<String>, ) -> bool

Makes an explosion.

impl World

pub fn entity_count(&self, entity_type: impl Arg<String>) -> Option<u32>

How many entities of entity_type are in dim (None: no such dimension or type).

impl World

pub fn entities_in_box( &self, min: impl Arg<Point>, max: impl Arg<Point>, ) -> Vec<String>

The uuids of the entities in a box.

impl World

pub fn raycast_block( &self, from: impl Arg<Point>, to: impl Arg<Point>, ) -> Option<BlockHit>

The first block a ray hits.

impl World

pub fn raycast_entity( &self, from: impl Arg<Point>, to: impl Arg<Point>, exclude: impl Arg<String>, ) -> Option<String>

The first entity a ray hits: its uuid.

Trait Implementations

impl Clone for World

fn clone(&self) -> World

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for World

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

Formats the value using the given formatter.

impl Eq for World

impl Hash for World

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for World

fn eq(&self, other: &World) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for World