pluginbase.Objects.World.WorldHelpers Class Reference

Static Public Member Functions
static IEnumerable< IWorldBlock >	IterateBlocks (this IWorld world, Segment segment)
	Iterate through blocks on a segment More...
static IEnumerable< IWorldBlock >	IterateBlocks (this IWorld world, Segment segment, Func< IWorldReadonlyBlock, bool > predicate)
	Iterate through blocks on a segment which match the predicate More...
static IWorldBlock	First (this IWorld world, Segment segment, Func< IWorldReadonlyBlock, bool > predicate)
	Find the first matching block on a segment More...
static IWorldBlock	First (this IWorld world, Segment segment, Func< IWorldReadonlyBlock, bool > predicate, int lookAhead)
	First block along a segment, with a specified offset look-ahead More...
static IWorldBlock	BeforeFirst (this IWorld world, Segment segment, Func< IWorldReadonlyBlock, bool > predicate)
	Find the preceeding block to the first matching block on a segment More...
static Vector3i	FindSpace (this IWorld world, Volume searchArea, Func< IWorldReadonlyBlock, bool > predicate)
	find a space which meets the given predicate More...
static Vector3i	FindGroundedSpace (this IWorldReadonly world, Volume searchArea)
	Search for a point where the ground below is solid, and not above (for standing) More...
static IEnumerable< Vector3i >	IterateGroundedSpace (this IWorldReadonly world, Volume search)
	Iterate over all possible grounded space in an area More...

Member Function Documentation

BeforeFirst()

static IWorldBlock pluginbase.Objects.World.WorldHelpers.BeforeFirst ( this IWorld  world, Segment  segment, Func< IWorldReadonlyBlock, bool >  predicate  )

static

Find the preceeding block to the first matching block on a segment

Parameters

world	World
segment	Segment to search on
predicate	Predicate to match blocks on

Returns

The block immediately before the first matching block, or null if none are found

        {
            return First(world, segment, predicate, 1);
        }

FindGroundedSpace()

static Vector3i pluginbase.Objects.World.WorldHelpers.FindGroundedSpace ( this IWorldReadonly  world, Volume  searchArea  )

static

Search for a point where the ground below is solid, and not above (for standing)

Returns

The grounded space.

Parameters

world	World.
searchArea	Search area.

Attribute: point].Solid && world[point - Vector3i.UnitZ

.Solid)

        {
            foreach (Vector3i point in VectorIterators.IterateSpace(searchArea.Point.X, searchArea.Point.Y, searchArea.Point.Z,
                                                                    searchArea.Size.Width, searchArea.Size.Length, searchArea.Size.Height))
            {
                if (!world[point].Solid && world[point - Vector3i.UnitZ].Solid)
                {
                    return point;
                }
            }

            return null;
        }

FindSpace()

static Vector3i pluginbase.Objects.World.WorldHelpers.FindSpace ( this IWorld  world, Volume  searchArea, Func< IWorldReadonlyBlock, bool >  predicate  )

static

find a space which meets the given predicate

Parameters

world	World
searchArea	Area to search
predicate	Predicate to evaluate locations

Returns

First location for which the predicate returns true

Attribute: point

))

        {
            foreach(Vector3i point in VectorIterators.IterateSpace(searchArea.Point.X, searchArea.Point.Y, searchArea.Point.Z, 
                                                                    searchArea.Size.Width, searchArea.Size.Length, searchArea.Size.Height))
            {
                if(predicate(world[point]))
                {
                    return point;
                }
            }

            return null;
        }

First() [1/2]

static IWorldBlock pluginbase.Objects.World.WorldHelpers.First ( this IWorld  world, Segment  segment, Func< IWorldReadonlyBlock, bool >  predicate  )

static

Find the first matching block on a segment

Parameters

world	World
segment	Segment to search on
predicate	Predicate to match blocks on

Returns

The first matching block, or null if none are found

Attribute: block.X, block.Y, block.Z

).FirstOrDefault(x => predicate(x));

        {
            return Voxels.WalkSurfaces(segment).Select(block => world[block.X, block.Y, block.Z]).FirstOrDefault(x => predicate(x));
        }

First() [2/2]

static IWorldBlock pluginbase.Objects.World.WorldHelpers.First ( this IWorld  world, Segment  segment, Func< IWorldReadonlyBlock, bool >  predicate, int  lookAhead  )

static

First block along a segment, with a specified offset look-ahead

Parameters

world	World.
segment	Segment.
predicate	Predicate.
lookAhead	The number of blocks to "look ahead" to match a selected block

Attribute: points[i]

;

Attribute: points[i - lookAhead]

;

Attribute: points[i]

;

Attribute: points[i - lookAhead]

;

        {
            var points = Voxels.WalkSurfaces(segment).ToArray();

            if (lookAhead >= 0)
            {
                // Lookahead is positive
                for (int i=lookAhead; i<points.Length; ++i)
                {
                    var block = world[points[i]];
                    if (predicate(block))
                        return world[points[i - lookAhead]];
                }
            }
            else
            {
                for (int i=0; i<points.Length + lookAhead; ++i)
                {
                    var block = world[points[i]];
                    if (predicate(block))
                        return world[points[i - lookAhead]];
                }
            }

            return null;
        }

IterateBlocks() [1/2]

static IEnumerable<IWorldBlock> pluginbase.Objects.World.WorldHelpers.IterateBlocks ( this IWorld  world, Segment  segment  )

static

Iterate through blocks on a segment

Parameters

world	World
segment	Segment to iterate on

Returns

Enumeration of blocks on the segment

Attribute: block.X, block.Y, block.Z

);

        {
            return Voxels.WalkSurfaces(segment).Select(block => world[block.X, block.Y, block.Z]);
        }

IterateBlocks() [2/2]

static IEnumerable<IWorldBlock> pluginbase.Objects.World.WorldHelpers.IterateBlocks ( this IWorld  world, Segment  segment, Func< IWorldReadonlyBlock, bool >  predicate  )

static

Iterate through blocks on a segment which match the predicate

Parameters

world	World
segment	Segment to iterate on
predicate	Predicate to match blocks on

Returns

Enumeration of blocks on a segment which match the predicate

Attribute: block.X, block.Y, block.Z

).Where(x => predicate(x));

        {
            return Voxels.WalkSurfaces(segment).Select(block => world[block.X, block.Y, block.Z]).Where(x => predicate(x));
        }

IterateGroundedSpace()

static IEnumerable<Vector3i> pluginbase.Objects.World.WorldHelpers.IterateGroundedSpace ( this IWorldReadonly  world, Volume  search  )

static

Iterate over all possible grounded space in an area

Returns

The grounded space.

Parameters

world	World.
search	Search.

Attribute: point].Solid && world[point - Vector3i.UnitZ

.Solid)

        {
            foreach (Vector3i point in VectorIterators.IterateVolume(search))
            {
                if (!world[point].Solid && world[point - Vector3i.UnitZ].Solid)
                    yield return point;
            }
        }

---

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

• pluginbase/Objects/World/WorldHelpers.cs