fCraft.Position Struct Reference

Struct representing a position AND orientation in 3D space. Used to represent players' positions in Minecraft world. Stores X/Y/Z as signed shorts, and R/L as unsigned bytes (8 bytes total). Use Vector3I if you just need X/Y/Z coordinates without orientation. Note that, as a struct, Positions are COPIED when assigned or passed as an argument. More...

Inheritance diagram for fCraft.Position:

Collaboration diagram for fCraft.Position:

Public Member Functions
	Position (short x, short y, short z, byte r, byte l)
	Position (int x, int y, int z)
Position	GetFixed ()
int	DistanceSquaredTo (Position other)
bool	Equals (Position other)
override bool	Equals (object obj)
override int	GetHashCode ()
override string	ToString ()
Vector3I	ToVector3I ()
Vector3I	ToBlockCoords ()

Static Public Member Functions
static bool	operator== (Position a, Position b)
static bool	operator!= (Position a, Position b)
static	operator Vector3I (Position a)

Public Attributes
short	X
short	Y
short	Z
byte	R
byte	L

Static Public Attributes
static readonly Position	Zero = new Position( 0, 0, 0 )
	Position at (0,0,0) with R=0 and L=0.

Properties
bool	IsZero [get]

Detailed Description

Struct representing a position AND orientation in 3D space. Used to represent players' positions in Minecraft world. Stores X/Y/Z as signed shorts, and R/L as unsigned bytes (8 bytes total). Use Vector3I if you just need X/Y/Z coordinates without orientation. Note that, as a struct, Positions are COPIED when assigned or passed as an argument.

Constructor & Destructor Documentation

fCraft.Position.Position	(	short	x,
		short	y,
		short	z,
		byte	r,
		byte	l
	)

fCraft.Position.Position	(	int	x,
		int	y,
		int	z
	)

Member Function Documentation

int fCraft.Position.DistanceSquaredTo

(

Position

other

)

bool fCraft.Position.Equals

(

Position

other

)

override bool fCraft.Position.Equals

(

object

obj

)

Position fCraft.Position.GetFixed

(

)

override int fCraft.Position.GetHashCode

(

)

static fCraft.Position.operator Vector3I ( Position  a )

explicitstatic

static bool fCraft.Position.operator!= ( Position  a, Position  b  )

static

static bool fCraft.Position.operator== ( Position  a, Position  b  )

static

Vector3I fCraft.Position.ToBlockCoords

(

)

override string fCraft.Position.ToString

(

)

Vector3I fCraft.Position.ToVector3I

(

)

Member Data Documentation

byte fCraft.Position.L

byte fCraft.Position.R

short fCraft.Position.X

short fCraft.Position.Y

short fCraft.Position.Z

readonly Position fCraft.Position.Zero = new Position( 0, 0, 0 )

static

Position at (0,0,0) with R=0 and L=0.

Property Documentation

bool fCraft.Position.IsZero

get

---

The documentation for this struct was generated from the following file:

• fCraft/Player/Position.cs