essentials.Prefabs.PrefabConstructor Class Reference

A helper object that will keep a list of blocks to-be-constructed in the world More...

Public Member Functions
	PrefabConstructor (IWorld world, IEnumerable< PrefabBlock > buildList)
	Initializes a new instance of the essentials.Prefabs.PrefabConstructor class. More...
PrefabBlock	Peek ()
	Gets the next block to be constructed, if any More...
PrefabBlock	Pop ()
	Pops the next block to be constructed of the queue, if any More...
bool	BuildNext ()
	Pop the next block off the stack and build it in the world More...
void	Construct ()
	Build the entire construct in the world More...
ITask	CreateScheduledTask (TimeSpan placeDelay)
	Helper to create a scheduled task to build the structure over time More...

Properties
bool	Complete [get]
	Has the construction completed More...

Detailed Description

A helper object that will keep a list of blocks to-be-constructed in the world

Constructor & Destructor Documentation

PrefabConstructor()

essentials.Prefabs.PrefabConstructor.PrefabConstructor	(	IWorld	world,
		IEnumerable< PrefabBlock >	buildList
	)

Initializes a new instance of the essentials.Prefabs.PrefabConstructor class.

Parameters

world	World.
buildList	Build list.

        {
            _world = world;
            _enumerator = buildList.GetEnumerator();
            if (!_enumerator.MoveNext())
                _enumerator = null; //There's nothing actually in the enumerator
        }

Member Function Documentation

BuildNext()

bool essentials.Prefabs.PrefabConstructor.BuildNext

(

)

Pop the next block off the stack and build it in the world

Returns

true, if next was built, false otherwise.

Attribute: item.Value.WorldPos].Block = _world.BlockLookup[item.Value.Block.Id

;

        {
            var item = this.Pop();
            if (item.HasValue)
            {
                _world[item.Value.WorldPos].Block = _world.BlockLookup[item.Value.Block.Id];
                return true;
            }
            return false;
        }

Construct()

void essentials.Prefabs.PrefabConstructor.Construct

(

)

Build the entire construct in the world

        {
            while (this.BuildNext())
            { }
        }

CreateScheduledTask()

ITask essentials.Prefabs.PrefabConstructor.CreateScheduledTask

(

TimeSpan

placeDelay

)

Helper to create a scheduled task to build the structure over time

Returns

The scheduled task.

Parameters

placeDelay

Place delay.

        {
            return new RecurringTask(() => {
                return this.BuildNext() ? TaskResult.Continue : TaskResult.Remove;
            }, placeDelay);
        }

Peek()

PrefabBlock essentials.Prefabs.PrefabConstructor.Peek

(

)

Gets the next block to be constructed, if any

        {
            if (_enumerator == null)
                return null;
            return _enumerator.Current;
        }

Pop()

PrefabBlock essentials.Prefabs.PrefabConstructor.Pop

(

)

Pops the next block to be constructed of the queue, if any

        {
            if (_enumerator == null)
                return null;

            var curr = _enumerator.Current;

            if (!_enumerator.MoveNext())
                _enumerator = null;

            return curr;
        }

Property Documentation

Complete

bool essentials.Prefabs.PrefabConstructor.Complete

get

Has the construction completed

true if complete; otherwise, false.

---

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

• essentials/Prefabs/PrefabConstructor.cs