Show / Hide Table of Contents

Class OccupancyInfo

Contains information about the space that a world object occupies, in the form of a list of block occupancies, that in itself contain information about the position relative to the world objects position, blocktype and occupancy type. More detailed information can be found here: https://github.com/StrangeLoopGames/Eco/wiki/Occupancy-System.

Inheritance
System.Object
OccupancyInfo
Namespace: Eco.Gameplay.Occupancy
Assembly: Eco.Gameplay.dll
Syntax
public class OccupancyInfo : Object

Constructors

OccupancyInfo()

Declaration
public OccupancyInfo()

Fields

Occupancies

Declaration
public List<BlockOccupancy> Occupancies
Field Value
Type Description
System.Collections.Generic.List<BlockOccupancy>

Range

Declaration
public WorldRange Range
Field Value
Type Description
WorldRange

Properties

CenterOffset

Declaration
public Vector3 CenterOffset { get; }
Property Value
Type Description
System.Numerics.Vector3

Dimensions

Declaration
public Vector3i Dimensions { get; }
Property Value
Type Description
Vector3i

Methods

Contains(Vector3i, Quaternion, Vector3, Vector3i)

Checks if object at origin position rotated by rotation and with range extended by extraExtents contains position.

Declaration
public bool Contains(Vector3i origin, Quaternion rotation, Vector3 position, Vector3i extraExtents = null)
Parameters
Type Name Description
Vector3i origin
Quaternion rotation
System.Numerics.Vector3 position
Vector3i extraExtents
Returns
Type Description
System.Boolean

Create(List<BlockOccupancy>)

Declaration
public static OccupancyInfo Create(List<BlockOccupancy> blocks)
Parameters
Type Name Description
System.Collections.Generic.List<BlockOccupancy> blocks
Returns
Type Description
OccupancyInfo

GetBlockPositions(Vector3i, Quaternion)

Returns enumerable of occupancy blocks in world space for specified position and rotation.

Declaration
public IEnumerable<WrappedWorldPosition3i> GetBlockPositions(Vector3i position, Quaternion rotation)
Parameters
Type Name Description
Vector3i position
Quaternion rotation
Returns
Type Description
System.Collections.Generic.IEnumerable<WrappedWorldPosition3i>

GetRange(Vector3i, Quaternion)

Returns WorldRange at origin position and with specified rotation. The range is exclusive.

Declaration
public WorldRange GetRange(Vector3i origin, Quaternion rotation)
Parameters
Type Name Description
Vector3i origin
Quaternion rotation
Returns
Type Description
WorldRange

Extension Methods

TagUtils.TagNames(Object, Boolean)
TagUtils.TagDisplayNames(Object, Boolean)
ClientSetViewExtensions.SetClassOfProperty(Object, Player, String, String, Int32)
TypeTooltipExtensions.UILinkGeneric(Object)
☀
☾
In This Article
Back to top
Copyright (c) Strange Loop Games 2021
☀
☾