Interface IProximity

Namespace

Uncreated.Warfare.Proximity

Assembly

Uncreated.Warfare.dll

Defines an object that can test points to see if they're contained in the proximity.

public interface IProximity : IShapeVolume, ICloneable

Inherited Members

IShapeVolume.containsPoint(Vector3)

IShapeVolume.worldBounds

IShapeVolume.internalVolume

IShapeVolume.surfaceArea

ICloneable.Clone()

Extension Methods

ProximityExtensions.AttachTo(IProximity, Transform)

ProximityExtensions.GetNearestPointOnBorder(IProximity, in Vector3)

Remarks

Also implements SDG.Framework.Utilities.IShapeVolume. Any components implementing this interface should destroy themselves in Dispose().

Properties

Area

The 2D area of the shape when looking down.

float Area { get; }

Property Value

float

Methods

TestPoint(in Vector2)

Check if a position is within the proximity while ignoring Y position.

bool TestPoint(in Vector2 position)

Parameters

position Vector2

Returns

bool

TestPoint(in Vector3)

Check if a position is within the proximity.

bool TestPoint(in Vector3 position)

Parameters

position Vector3

Returns

bool