Struct LightData 

pub struct LightData {
    pub sky_light_mask: BitSet,
    pub block_light_mask: BitSet,
    pub empty_sky_light_mask: BitSet,
    pub empty_block_light_mask: BitSet,
    pub sky_light_arrays: PrefixedArray<LightArray>,
    pub block_light_arrays: PrefixedArray<LightArray>,
}

Lighting masks and packed light arrays for a chunk column.

Mask bit zero addresses the section immediately below the world’s minimum height. Subsequent bits address chunk sections from bottom to top, ending with the section immediately above the world’s maximum height. Sky and block arrays are ordered by their corresponding set bits, least-significant bit first. The empty masks identify sections whose light data is all zero.

Encoding and decoding reject a sky or block array count that differs from the number of set bits in its data mask.

Examples

use mcproto_types::{LightData, TypeCodec};

let light = LightData::default();
let mut encoded = Vec::new();
light.encode(&mut encoded)?;
assert_eq!(encoded, [0, 0, 0, 0, 0, 0]);

let mut input = encoded.as_slice();
assert_eq!(LightData::decode(&mut input)?, light);
assert!(input.is_empty());

See the official Light Data protocol documentation.

Fields

sky_light_mask: BitSet

Sections with entries in sky_light_arrays.

block_light_mask: BitSet

Sections with entries in block_light_arrays.

empty_sky_light_mask: BitSet

Sections whose sky light data consists entirely of zeroes.

empty_block_light_mask: BitSet

Sections whose block light data consists entirely of zeroes.

sky_light_arrays: PrefixedArray<LightArray>

One packed array for each set bit in sky_light_mask.

block_light_arrays: PrefixedArray<LightArray>

One packed array for each set bit in block_light_mask.

Implementations

impl LightData

pub fn expected_sky_light_array_count(&self) -> usize

Returns the number of sky light arrays required by the sky mask.

pub fn expected_block_light_array_count(&self) -> usize

Returns the number of block light arrays required by the block mask.

Trait Implementations

impl Clone for LightData

fn clone(&self) -> LightData

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LightData

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

Formats the value using the given formatter.

impl Default for LightData

fn default() -> LightData

Returns the “default value” for a type.

impl Eq for LightData

impl PartialEq for LightData

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LightData

impl TypeCodec for LightData

fn encode(&self, writer: &mut impl Write) -> Result<(), CodecError>

Encodes this value to the writer.

fn decode(reader: &mut impl Read) -> Result<Self, CodecError>

Decodes this value from the reader.