Table of Contents

Struct ChunkVector

Namespace
Game.Core.Coordinates
Assembly
Game.Core.Coordinates.dll
public struct ChunkVector : IVector<ChunkVector, ChunkDirection, ChunkAxis>, IDirectionComposableVector<ChunkVector, ChunkDirection>, IAxisComposableVector<ChunkVector, ChunkAxis>, IVector<ChunkVector>, IConvertibleToWorldVector, IConvertibleToGlobalPosition<GlobalChunkTransform, GlobalChunkCoordinate>
Implements
Extension Methods

Constructors

ChunkVector(int, int, short)

public ChunkVector(int x, int y, short z)

Parameters

x int
y int
z short

ChunkVector(int2, int)

public ChunkVector(int2 xy, int z)

Parameters

xy int2
z int

ChunkVector(int3)

public ChunkVector(int3 xyz)

Parameters

xyz int3

Fields

Down

public static readonly ChunkVector Down

Field Value

ChunkVector

East

public static readonly ChunkVector East

Field Value

ChunkVector

North

public static readonly ChunkVector North

Field Value

ChunkVector

One

public static readonly ChunkVector One

Field Value

ChunkVector

South

public static readonly ChunkVector South

Field Value

ChunkVector

Up

public static readonly ChunkVector Up

Field Value

ChunkVector

West

public static readonly ChunkVector West

Field Value

ChunkVector

Zero

public static readonly ChunkVector Zero

Field Value

ChunkVector

x

public int x

Field Value

int

y

public int y

Field Value

int

z

public short z

Field Value

short

Methods

Add(ChunkDirection, int)

[Pure]
public readonly ChunkVector Add(ChunkDirection direction, int scalar)

Parameters

direction ChunkDirection
scalar int

Returns

ChunkVector

Add(ChunkVector)

[Pure]
public readonly ChunkVector Add(ChunkVector other)

Parameters

other ChunkVector

Returns

ChunkVector

ByAxis(ChunkAxis)

public static ChunkVector ByAxis(ChunkAxis axis)

Parameters

axis ChunkAxis

Returns

ChunkVector

ByDirection(ChunkDirection)

public static ChunkVector ByDirection(ChunkDirection direction)

Parameters

direction ChunkDirection

Returns

ChunkVector

ByScaledAxis(ChunkAxis, int)

[Pure]
public readonly ChunkVector ByScaledAxis(ChunkAxis axis, int scalar)

Parameters

axis ChunkAxis
scalar int

Returns

ChunkVector

ByScaledDirection(ChunkDirection, uint)

[Pure]
public readonly ChunkVector ByScaledDirection(ChunkDirection direction, uint scalar)

Parameters

direction ChunkDirection
scalar uint

Returns

ChunkVector

Divide(int)

[Pure]
public readonly ChunkVector Divide(int scalar)

Parameters

scalar int

Returns

ChunkVector

Equals(ChunkVector)

[Pure]
public readonly bool Equals(ChunkVector other)

Parameters

other ChunkVector

Returns

bool

Equals(object)

[Pure]
public override readonly bool Equals(object obj)

Parameters

obj object

Returns

bool

GetHashCode()

[Pure]
public override readonly int GetHashCode()

Returns

int

HasComponent(ChunkAxis, out int)

[Pure]
public readonly bool HasComponent(ChunkAxis axis, out int scalar)

Parameters

axis ChunkAxis
scalar int

Returns

bool

IsStandardBasisScalar(out ChunkDirection, out uint)

[Pure]
public readonly bool IsStandardBasisScalar(out ChunkDirection direction, out uint scalar)

Parameters

direction ChunkDirection
scalar uint

Returns

bool

IsStandardBasisScalar(out ChunkVector, out uint)

[Pure]
public readonly bool IsStandardBasisScalar(out ChunkVector vector, out uint scalar)

Parameters

vector ChunkVector
scalar uint

Returns

bool

IsStandardBasisScalarMultiple(out ChunkAxis, out int)

[Pure]
public readonly bool IsStandardBasisScalarMultiple(out ChunkAxis axis, out int scalar)

Parameters

axis ChunkAxis
scalar int

Returns

bool

MirrorOver(ChunkAxis)

[Pure]
public readonly ChunkVector MirrorOver(ChunkAxis axis)

Parameters

axis ChunkAxis

Returns

ChunkVector

Multiply(int)

[Pure]
public readonly ChunkVector Multiply(int scalar)

Parameters

scalar int

Returns

ChunkVector

Rotate(GridRotation)

[Pure]
public readonly ChunkVector Rotate(GridRotation rotation)

Parameters

rotation GridRotation

Returns

ChunkVector

Subtract(ChunkDirection, int)

[Pure]
public readonly ChunkVector Subtract(ChunkDirection direction, int scalar)

Parameters

direction ChunkDirection
scalar int

Returns

ChunkVector

Subtract(ChunkVector)

[Pure]
public readonly ChunkVector Subtract(ChunkVector other)

Parameters

other ChunkVector

Returns

ChunkVector

ToGlobal(in GlobalChunkTransform)

[Pure]
public GlobalChunkCoordinate ToGlobal(in GlobalChunkTransform transform)

Parameters

transform GlobalChunkTransform

Returns

GlobalChunkCoordinate

ToString()

[Pure]
public override readonly string ToString()

Returns

string

ToTileVector()

public readonly TileVector ToTileVector()

Returns

TileVector

ToWorld()

[Pure]
public readonly WorldVector ToWorld()

Returns

WorldVector

To_IC(GridRotation)

[Pure]
public readonly IslandChunkCoordinate To_IC(GridRotation islandRotation)

Parameters

islandRotation GridRotation

Returns

IslandChunkCoordinate

Operators

operator +(ChunkVector, ChunkVector)

public static ChunkVector operator +(ChunkVector lhs, ChunkVector rhs)

Parameters

lhs ChunkVector
rhs ChunkVector

Returns

ChunkVector

operator /(ChunkVector, int)

public static ChunkVector operator /(ChunkVector lhs, int rhs)

Parameters

lhs ChunkVector
rhs int

Returns

ChunkVector

operator ==(ChunkVector, ChunkVector)

public static bool operator ==(ChunkVector lhs, ChunkVector rhs)

Parameters

lhs ChunkVector
rhs ChunkVector

Returns

bool

explicit operator int3(ChunkVector)

public static explicit operator int3(ChunkVector v)

Parameters

v ChunkVector

Returns

int3

implicit operator ChunkVector(ChunkDirection)

public static implicit operator ChunkVector(ChunkDirection direction)

Parameters

direction ChunkDirection

Returns

ChunkVector

operator !=(ChunkVector, ChunkVector)

public static bool operator !=(ChunkVector lhs, ChunkVector rhs)

Parameters

lhs ChunkVector
rhs ChunkVector

Returns

bool

operator *(ChunkVector, int)

public static ChunkVector operator *(ChunkVector lhs, int rhs)

Parameters

lhs ChunkVector
rhs int

Returns

ChunkVector

operator *(int, ChunkVector)

public static ChunkVector operator *(int lhs, ChunkVector rhs)

Parameters

lhs int
rhs ChunkVector

Returns

ChunkVector

operator -(ChunkVector, ChunkVector)

public static ChunkVector operator -(ChunkVector lhs, ChunkVector rhs)

Parameters

lhs ChunkVector
rhs ChunkVector

Returns

ChunkVector

operator -(ChunkVector)

public static ChunkVector operator -(ChunkVector val)

Parameters

val ChunkVector

Returns

ChunkVector

operator +(ChunkVector)

public static ChunkVector operator +(ChunkVector val)

Parameters

val ChunkVector

Returns

ChunkVector