Struct Direction

Namespace

Gloam.Core.Primitives

Assembly

Gloam.Core.dll

Represents a direction in 2D space using 8-directional movement (cardinal and diagonal directions).

public readonly struct Direction : IEquatable<Direction>

Implements

IEquatable<Direction>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Constructors

Direction(int, int)

public Direction(int x, int y)

Parameters

x int

y int

Fields

All8

public static readonly Direction[] All8

Field Value

Direction[]

East

public static readonly Direction East

Field Value

Direction

North

public static readonly Direction North

Field Value

Direction

NorthEast

public static readonly Direction NorthEast

Field Value

Direction

NorthWest

public static readonly Direction NorthWest

Field Value

Direction

South

public static readonly Direction South

Field Value

Direction

SouthEast

public static readonly Direction SouthEast

Field Value

Direction

SouthWest

public static readonly Direction SouthWest

Field Value

Direction

West

public static readonly Direction West

Field Value

Direction

Properties

X

public int X { get; }

Property Value

int

Y

public int Y { get; }

Property Value

int

Methods

AsVector2()

public Vector2 AsVector2()

Returns

Vector2

Equals(Direction)

Indicates whether the current object is equal to another object of the same type.

public bool Equals(Direction other)

Parameters

other Direction

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; otherwise, false.

Equals(object?)

Indicates whether this instance and a specified object are equal.

public override bool Equals(object? obj)

Parameters

obj object

The object to compare with the current instance.

Returns

bool

true if obj and this instance are the same type and represent the same value; otherwise, false.

GetHashCode()

Returns the hash code for this instance.

public override int GetHashCode()

Returns

int

A 32-bit signed integer that is the hash code for this instance.

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator +(Position, Direction)

public static Position operator +(Position position, Direction direction)

Parameters

position Position

direction Direction

Returns

Position

operator ==(Direction, Direction)

public static bool operator ==(Direction left, Direction right)

Parameters

left Direction

right Direction

Returns

bool

implicit operator Vector2(Direction)

public static implicit operator Vector2(Direction direction)

Parameters

direction Direction

Returns

Vector2

operator !=(Direction, Direction)

public static bool operator !=(Direction left, Direction right)

Parameters

left Direction

right Direction

Returns

bool