Class WorldPosition2i

Inheritance
System.Object
WorldPosition2i
Implements
System.IComparable
System.IComparable<System.Int32>
System.IEquatable<WorldPosition2i>
Namespace: Eco.Shared.Math
Assembly: Eco.Shared.dll
Syntax
public sealed class WorldPosition2i : ValueType, IComparable, IComparable<int>, IEquatable<WorldPosition2i>

Constructors

WorldPosition2i(Vector3i)

Declaration
public WorldPosition2i(Vector3i vec)
Parameters
Type Name Description
Vector3i vec

WorldPosition2i(Int32, Int32)

Declaration
public WorldPosition2i(int x, int z)
Parameters
Type Name Description
System.Int32 x
System.Int32 z

WorldPosition2i(Int32, Int32, Int32)

Declaration
public WorldPosition2i(int x, int y, int z)
Parameters
Type Name Description
System.Int32 x
System.Int32 y
System.Int32 z

Fields

Invalid

Declaration
public static readonly WorldPosition2i Invalid
Field Value
Type Description
WorldPosition2i

Properties

A2DIndex

Declaration
public int A2DIndex { get; }
Property Value
Type Description
System.Int32

IsValid

Declaration
public bool IsValid { get; }
Property Value
Type Description
System.Boolean

x

Declaration
public int x { get; set; }
Property Value
Type Description
System.Int32

XZ

Declaration
public Vector2i XZ { get; }
Property Value
Type Description
Vector2i

z

Declaration
public int z { get; set; }
Property Value
Type Description
System.Int32

Methods

Add(Direction, Int32)

Declaration
public void Add(Direction val, int count)
Parameters
Type Name Description
Direction val
System.Int32 count

AddX(Int32)

Declaration
public WorldPosition2i AddX(int val)
Parameters
Type Name Description
System.Int32 val
Returns
Type Description
WorldPosition2i

AddZ(Int32)

Declaration
public WorldPosition2i AddZ(int val)
Parameters
Type Name Description
System.Int32 val
Returns
Type Description
WorldPosition2i

CompareTo(Int32)

Declaration
public int CompareTo(int value)
Parameters
Type Name Description
System.Int32 value
Returns
Type Description
System.Int32

CompareTo(Object)

Declaration
public int CompareTo(object value)
Parameters
Type Name Description
System.Object value
Returns
Type Description
System.Int32

Distance(WorldPosition2i, WorldPosition2i)

Declaration
public static float Distance(WorldPosition2i a, WorldPosition2i b)
Parameters
Type Name Description
WorldPosition2i a
WorldPosition2i b
Returns
Type Description
System.Single

DistanceSq(WorldPosition2i, WorldPosition2i)

Declaration
public static int DistanceSq(WorldPosition2i a, WorldPosition2i b)
Parameters
Type Name Description
WorldPosition2i a
WorldPosition2i b
Returns
Type Description
System.Int32

East()

Declaration
public WorldPosition2i East()
Returns
Type Description
WorldPosition2i

Equals(WorldPosition2i)

Declaration
public bool Equals(WorldPosition2i other)
Parameters
Type Name Description
WorldPosition2i other
Returns
Type Description
System.Boolean

Equals(Object)

Declaration
public override bool Equals(object other)
Parameters
Type Name Description
System.Object other
Returns
Type Description
System.Boolean

FromWrapped(Vector2i)

Declaration
public static WorldPosition2i FromWrapped(Vector2i vec)
Parameters
Type Name Description
Vector2i vec
Returns
Type Description
WorldPosition2i

FromWrapped(Int32, Int32)

Declaration
public static WorldPosition2i FromWrapped(int x, int z)
Parameters
Type Name Description
System.Int32 x
System.Int32 z
Returns
Type Description
WorldPosition2i

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Initialize(Vector3i)

Declaration
public static void Initialize(Vector3i worldSize)
Parameters
Type Name Description
Vector3i worldSize

North()

Declaration
public WorldPosition2i North()
Returns
Type Description
WorldPosition2i

South()

Declaration
public WorldPosition2i South()
Returns
Type Description
WorldPosition2i

SpiralOutXZIter(Int32)

Declaration
public IEnumerable<WorldPosition2i> SpiralOutXZIter(int size)
Parameters
Type Name Description
System.Int32 size
Returns
Type Description
System.Collections.Generic.IEnumerable<WorldPosition2i>

StepToInc(WorldPosition2i, Direction)

Declaration
public IEnumerable<WorldPosition2i> StepToInc(WorldPosition2i other, Direction dir)
Parameters
Type Name Description
WorldPosition2i other
Direction dir
Returns
Type Description
System.Collections.Generic.IEnumerable<WorldPosition2i>

ToString()

Declaration
public override string ToString()
Returns
Type Description
System.String

West()

Declaration
public WorldPosition2i West()
Returns
Type Description
WorldPosition2i

WorldXZIter()

Declaration
public static IEnumerable<WorldPosition2i> WorldXZIter()
Returns
Type Description
System.Collections.Generic.IEnumerable<WorldPosition2i>

WrapX(Int32)

Declaration
public static int WrapX(int x)
Parameters
Type Name Description
System.Int32 x
Returns
Type Description
System.Int32

WrapZ(Int32)

Declaration
public static int WrapZ(int z)
Parameters
Type Name Description
System.Int32 z
Returns
Type Description
System.Int32

XZNeighbors()

Declaration
public WorldPosition2i[] XZNeighbors()
Returns
Type Description
WorldPosition2i[]

Operators

Addition(WorldPosition2i, Vector2i)

Declaration
public static WorldPosition2i operator +(WorldPosition2i a, Vector2i b)
Parameters
Type Name Description
WorldPosition2i a
Vector2i b
Returns
Type Description
WorldPosition2i

Equality(WorldPosition2i, WorldPosition2i)

Declaration
public static bool operator ==(WorldPosition2i a, WorldPosition2i b)
Parameters
Type Name Description
WorldPosition2i a
WorldPosition2i b
Returns
Type Description
System.Boolean

Explicit(WorldPosition2i to Vector2)

Declaration
public static explicit operator Vector2(WorldPosition2i w)
Parameters
Type Name Description
WorldPosition2i w
Returns
Type Description
Vector2

Explicit(WorldPosition2i to Vector2i)

Declaration
public static explicit operator Vector2i(WorldPosition2i w)
Parameters
Type Name Description
WorldPosition2i w
Returns
Type Description
Vector2i

Explicit(WorldPosition2i to Int32)

Declaration
public static explicit operator int (WorldPosition2i vec)
Parameters
Type Name Description
WorldPosition2i vec
Returns
Type Description
System.Int32

Explicit(Int32 to WorldPosition2i)

Declaration
public static explicit operator WorldPosition2i(int i)
Parameters
Type Name Description
System.Int32 i
Returns
Type Description
WorldPosition2i

Implicit(Vector2i to WorldPosition2i)

Declaration
public static implicit operator WorldPosition2i(Vector2i vec)
Parameters
Type Name Description
Vector2i vec
Returns
Type Description
WorldPosition2i

Implicit(Vector3i to WorldPosition2i)

Declaration
public static implicit operator WorldPosition2i(Vector3i vec)
Parameters
Type Name Description
Vector3i vec
Returns
Type Description
WorldPosition2i

Inequality(WorldPosition2i, WorldPosition2i)

Declaration
public static bool operator !=(WorldPosition2i a, WorldPosition2i b)
Parameters
Type Name Description
WorldPosition2i a
WorldPosition2i b
Returns
Type Description
System.Boolean

Subtraction(WorldPosition2i, Vector2i)

Declaration
public static WorldPosition2i operator -(WorldPosition2i a, Vector2i b)
Parameters
Type Name Description
WorldPosition2i a
Vector2i b
Returns
Type Description
WorldPosition2i

Subtraction(WorldPosition2i, WorldPosition2i)

Declaration
public static Vector2i operator -(WorldPosition2i a, WorldPosition2i b)
Parameters
Type Name Description
WorldPosition2i a
WorldPosition2i b
Returns
Type Description
Vector2i

Implements

System.IComparable
System.IComparable<>
System.IEquatable<>

Extension Methods