Struct Vec2iStruct

Namespace

Vintagestory.API.MathTools

Assembly

VintagestoryAPI.dll

Represents a vector of 2 ints. Go bug Tyron if you need more utility methods in this class.

[ProtoContract]
public struct Vec2iStruct : IEquatable<Vec2iStruct>

Implements

IEquatable<Vec2iStruct>

Inherited Members

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods

ObjectHandleExtensions.ToGcHandle(object)

ObjectHandleExtensions.ToIntPtr(object)

Constructors

Vec2iStruct()

public Vec2iStruct()

Vec2iStruct(int, int)

public Vec2iStruct(int x, int y)

Parameters

x int

y int

Vec2iStruct(Vec3d)

public Vec2iStruct(Vec3d pos)

Parameters

pos Vec3d

Fields

X

[ProtoMember(1)]
public int X

Field Value

int

Y

[ProtoMember(2)]
public int Y

Field Value

int

Properties

this[int]

public int this[int index] { get; set; }

Parameters

index int

Property Value

int

ToInChunkIndex

Will always return a number in the range 0..1023, no matter what the value of X and Y

public int ToInChunkIndex { get; }

Property Value

int

Methods

Add(int, int)

public Vec2iStruct Add(int dx, int dy)

Parameters

dx int

dy int

Returns

Vec2iStruct

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.

Equals(Vec2iStruct)

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

public bool Equals(Vec2iStruct other)

Parameters

other Vec2iStruct

An object to compare with this object.

Returns

bool

true if the current object is equal to the other parameter; 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.

ManhattanDistance(int, int)

public int ManhattanDistance(int x, int y)

Parameters

x int

y int

Returns

int

ManhattanDistance(Vec2i)

public int ManhattanDistance(Vec2i point)

Parameters

point Vec2i

Returns

int

ManhattenDistance(int, int)

[Obsolete("Use the correctly-spelled ManhattanDistance instead")]
public int ManhattenDistance(int x, int y)

Parameters

x int

y int

Returns

int

ManhattenDistance(Vec2i)

[Obsolete("Use the correctly-spelled ManhattanDistance instead")]
public int ManhattenDistance(Vec2i point)

Parameters

point Vec2i

Returns

int

Set(int, int)

public Vec2iStruct Set(int x, int y)

Parameters

x int

y int

Returns

Vec2iStruct

Set(Vec2i)

public Vec2iStruct Set(Vec2i vec)

Parameters

vec Vec2i

Returns

Vec2iStruct

ToChunkIndex()

27 lowest bits for X Coordinate, then 27 bits for Z coordinate

public ulong ToChunkIndex()

Returns

ulong

ToString()

Returns the fully qualified type name of this instance.

public override string ToString()

Returns

string

The fully qualified type name.

Operators

operator +(Vec2iStruct, int)

public static Vec2iStruct operator +(Vec2iStruct left, int right)

Parameters

left Vec2iStruct

right int

Returns

Vec2iStruct

operator +(Vec2iStruct, Vec2iStruct)

public static Vec2iStruct operator +(Vec2iStruct left, Vec2iStruct right)

Parameters

left Vec2iStruct

right Vec2iStruct

Returns

Vec2iStruct

operator /(Vec2iStruct, int)

public static Vec2iStruct operator /(Vec2iStruct left, int right)

Parameters

left Vec2iStruct

right int

Returns

Vec2iStruct

operator /(Vec2iStruct, float)

public static Vec2iStruct operator /(Vec2iStruct left, float right)

Parameters

left Vec2iStruct

right float

Returns

Vec2iStruct

operator ==(Vec2iStruct, Vec2iStruct)

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

Parameters

left Vec2iStruct

right Vec2iStruct

Returns

bool

operator !=(Vec2iStruct, Vec2iStruct)

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

Parameters

left Vec2iStruct

right Vec2iStruct

Returns

bool

operator *(double, Vec2iStruct)

public static Vec2iStruct operator *(double left, Vec2iStruct right)

Parameters

left double

right Vec2iStruct

Returns

Vec2iStruct

operator *(int, Vec2iStruct)

public static Vec2iStruct operator *(int left, Vec2iStruct right)

Parameters

left int

right Vec2iStruct

Returns

Vec2iStruct

operator *(Vec2iStruct, double)

public static Vec2iStruct operator *(Vec2iStruct left, double right)

Parameters

left Vec2iStruct

right double

Returns

Vec2iStruct

operator *(Vec2iStruct, int)

public static Vec2iStruct operator *(Vec2iStruct left, int right)

Parameters

left Vec2iStruct

right int

Returns

Vec2iStruct

operator *(Vec2iStruct, Vec2iStruct)

public static double operator *(Vec2iStruct left, Vec2iStruct right)

Parameters

left Vec2iStruct

right Vec2iStruct

Returns

double

operator -(int, Vec2iStruct)

public static Vec2iStruct operator -(int left, Vec2iStruct right)

Parameters

left int

right Vec2iStruct

Returns

Vec2iStruct

operator -(Vec2iStruct, int)

public static Vec2iStruct operator -(Vec2iStruct left, int right)

Parameters

left Vec2iStruct

right int

Returns

Vec2iStruct

operator -(Vec2iStruct, Vec2iStruct)

public static Vec2iStruct operator -(Vec2iStruct left, Vec2iStruct right)

Parameters

left Vec2iStruct

right Vec2iStruct

Returns

Vec2iStruct