essentials.Prefabs.Prefab Class Reference

A subset of blocks within a world, that creates an existing entity Able to save and load from disk, clone pieces of the world, etc More...

Inheritance diagram for essentials.Prefabs.Prefab:

Public Member Functions
	Prefab (int width, int length, int height, Vector3i center)
	Creates a new instance of a prefab with the given width, length, and height More...
	Prefab (int width, int length, int height)
	Creates a new prefab More...
	Prefab (Size3i size, Vector3i center)
	Creates a new prefab More...
	Prefab (Size3i size)
	Creates a new prefab More...
void	Save (Stream stream)
	Save prefab data to a stream (eg file) More...
void	Clear (ushort id)
	Clear the prefab space with a specific block id More...
void	Clear ()
	Clear the prefab space with empty block (id 0) More...
void	Merge (IReadonlyPrefab src, Vector3i pos)
	Merge one prefab into self More...
Public Member Functions inherited from essentials.Prefabs.IReadonlyPrefab
bool	InBounds (int x, int y, int z)
	Returns whether or not a point is within the bounds of the prefab More...
bool	InBounds (Vector3i pt)
	Returns whether or not a point is within the bounds of the prefab More...

Static Public Member Functions
static Prefab	Load (Stream stream)
	Load prefab data from a data stream More...

Properties
int	Width [get]
	Gets the width of the prefab More...
int	Length [get]
	Gets the lenght of the prefab More...
int	Height [get]
	Gets the height of the prefab More...
Size3i	Size [get]
	Gets the size of the prefab (width, length, height) More...
Vector3i	Center [get]
	Gets the relative center coordinate of the prefab (Not world coord) More...
Properties inherited from essentials.Prefabs.IReadonlyPrefab
int	Width [get]
	The width of the prefab More...
int	Length [get]
	The length of the prefab More...
int	Height [get]
	The height of the prefab More...
Size3i	Size [get]
	The size of the prefab (width, length, height) More...
Vector3i	Center [get]
	The relative center coordinate of the prefab More...

Detailed Description

A subset of blocks within a world, that creates an existing entity Able to save and load from disk, clone pieces of the world, etc

Exists in in its own space (Like a 3D Bitmap)

Constructor & Destructor Documentation

Prefab() [1/4]

essentials.Prefabs.Prefab.Prefab	(	int	width,
		int	length,
		int	height,
		Vector3i	center
	)

Creates a new instance of a prefab with the given width, length, and height

Parameters

width	Width.
length	Length.
height	Height.
center	Center.

Attribute: width*length*height

;

        {
            this.InjectDependencies();

            _width = width;
            _length = length;
            _height = height;
            _center = center;
            _blocks = new ushort[width*length*height];
        }

Prefab() [2/4]

essentials.Prefabs.Prefab.Prefab	(	int	width,
		int	length,
		int	height
	)

Creates a new prefab

Parameters

width	Width.
length	Length.
height	Height.

            :this(width, length, height, Vector3i.Zero)
        {}

Prefab() [3/4]

essentials.Prefabs.Prefab.Prefab	(	Size3i	size,
		Vector3i	center
	)

Creates a new prefab

Parameters

size	Size.
center	Center.

            :this(size.Width, size.Length, size.Height, center)
        {}

Prefab() [4/4]

essentials.Prefabs.Prefab.Prefab

(

Size3i

size

)

Creates a new prefab

Parameters

size

Size.

            :this(size.Width, size.Length, size.Height, Vector3i.Zero)
        {}

Member Function Documentation

Clear() [1/2]

void essentials.Prefabs.Prefab.Clear

(

ushort

id

)

Clear the prefab space with a specific block id

Parameters

id	Identifier.

Attribute: i

= id;

        {
            for (int i=0; i<_blocks.Length; ++i)
            {
                _blocks[i] = id;
            }
        }

Clear() [2/2]

void essentials.Prefabs.Prefab.Clear

(

)

Clear the prefab space with empty block (id 0)

        {
            Clear(0);
        }

Load()

static Prefab essentials.Prefabs.Prefab.Load ( Stream  stream )

static

Load prefab data from a data stream

Parameters

stream

Stream.

Attribute: i

= reader.ReadUInt16();

Attribute: pos

= data;

        {
            var reader = new BinaryReader(stream);
            string magic = reader.ReadString();
            if (magic != MAGIC)
            {
                throw new FileLoadException("Invalid magic");
            }

            byte version = reader.ReadByte();
            if (version != 0)
            {
                throw new FileLoadException("Invalid version");
            }

            int width = reader.ReadInt32();
            int length = reader.ReadInt32();
            int height = reader.ReadInt32();
            int cX = reader.ReadInt32();
            int cY = reader.ReadInt32();
            int cZ = reader.ReadInt32();

            var prefab = new Prefab(width, length, height, new Vector3i(cX,cY,cZ));
            for (int i=0; i<width*length*height; ++i)
            {
                prefab._blocks[i] = reader.ReadUInt16();
            }

            if (stream.Length > stream.Position) //Backwards compat
            {
                //There's metadata!
                int labelCount = reader.ReadInt32();
                for (int i=0; i<labelCount; ++i)
                {
                    Vector3i pos;
                    pos.X = reader.ReadInt32();
                    pos.Y = reader.ReadInt32();
                    pos.Z = reader.ReadInt32();
                    string data = reader.ReadString();
                    prefab._labels[pos] = data;
                }
            }

            return prefab;
        }

Merge()

void essentials.Prefabs.Prefab.Merge	(	IReadonlyPrefab	src,
		Vector3i	pos
	)

Merge one prefab into self

Parameters

src	Source.
pos	Position.

Attribute: myPos] = src[x,y,z

;

        {
            for (int x=0; x<src.Width; ++x)
            {
                for (int y=0; y<src.Length; ++y)
                {
                    for (int z=0; z<src.Height; ++z)
                    {
                        Vector3i myPos = new Vector3i(x,y,z) - src.Center + pos;
                        if (myPos.X >= 0 && myPos.X < _width
                            && myPos.Y >= 0 && myPos.Y < _length
                            && myPos.Z >= 0 && myPos.Z < _height)
                        {
                            this[myPos] = src[x,y,z];
                        }
                    }
                }
            }
        }

Save()

void essentials.Prefabs.Prefab.Save

(

Stream

stream

)

Save prefab data to a stream (eg file)

Parameters

stream

Stream.

Attribute: i

);

        {
            var writer = new BinaryWriter(stream);
            writer.Write(MAGIC);
            writer.Write((byte)0);

            writer.Write(_width);
            writer.Write(_length);
            writer.Write(_height);

            writer.Write(_center.X);
            writer.Write(_center.Y);
            writer.Write(_center.Z);

            for (int i=0; i<_width*_length*_height; ++i)
                writer.Write(_blocks[i]);

            writer.Write((int)this._labels.Count);
            foreach(var label in this._labels)
            {
                writer.Write(label.Key.X);
                writer.Write(label.Key.Y);
                writer.Write(label.Key.Z);
                writer.Write(label.Value);
            }
        }

Property Documentation

Center

Vector3i essentials.Prefabs.Prefab.Center

get

Gets the relative center coordinate of the prefab (Not world coord)

The center.

Height

int essentials.Prefabs.Prefab.Height

get

Gets the height of the prefab

The height.

Length

int essentials.Prefabs.Prefab.Length

get

Gets the lenght of the prefab

The length.

Size

Size3i essentials.Prefabs.Prefab.Size

get

Gets the size of the prefab (width, length, height)

The size.

Width

int essentials.Prefabs.Prefab.Width

get

Gets the width of the prefab

The width.

---

The documentation for this class was generated from the following file:

• essentials/Prefabs/Prefab.cs