Genisys  Genisys API 1.9.3
A server software for Minecraft: Pocket Edition with many features
Position Class Reference
Inheritance diagram for Position:
[legend]
Collaboration diagram for Position:
[legend]

Public Member Functions

 __construct ($x=0, $y=0, $z=0, Level $level=null)
 
 add ($x, $y=0, $z=0)
 
 getLevel ()
 
 setLevel (Level $level=null)
 
 isValid ()
 
 getSide ($side, $step=1)
 
 __toString ()
 
 setComponents ($x, $y, $z)
 
 fromObjectAdd (Vector3 $pos, $x, $y, $z)
 
- Public Member Functions inherited from Vector3
 __construct ($x=0, $y=0, $z=0)
 
 getX ()
 
 getY ()
 
 getZ ()
 
 getFloorX ()
 
 getFloorY ()
 
 getFloorZ ()
 
 getRight ()
 
 getUp ()
 
 getForward ()
 
 getSouth ()
 
 getWest ()
 
 add ($x, $y=0, $z=0)
 
 subtract ($x=0, $y=0, $z=0)
 
 multiply ($number)
 
 divide ($number)
 
 ceil ()
 
 floor ()
 
 round ()
 
 abs ()
 
 getSide ($side, $step=1)
 
 distance (Vector3 $pos)
 
 distanceSquared (Vector3 $pos)
 
 maxPlainDistance ($x=0, $z=0)
 
 length ()
 
 lengthSquared ()
 
 normalize ()
 
 dot (Vector3 $v)
 
 cross (Vector3 $v)
 
 equals (Vector3 $v)
 
 getIntermediateWithXValue (Vector3 $v, $x)
 
 getIntermediateWithYValue (Vector3 $v, $y)
 
 getIntermediateWithZValue (Vector3 $v, $z)
 
 setComponents ($x, $y, $z)
 
 fromObjectAdd (Vector3 $pos, $x, $y, $z)
 
 __toString ()
 

Static Public Member Functions

static fromObject (Vector3 $pos, Level $level=null)
 
- Static Public Member Functions inherited from Vector3
static getOppositeSide (int $side)
 
static createRandomDirection (Random $random)
 

Data Fields

 $level = null
 
- Data Fields inherited from Vector3
const SIDE_DOWN = 0
 
const SIDE_UP = 1
 
const SIDE_NORTH = 2
 
const SIDE_SOUTH = 3
 
const SIDE_WEST = 4
 
const SIDE_EAST = 5
 
 $x
 
 $y
 
 $z
 

Constructor & Destructor Documentation

__construct (   $x = 0,
  $y = 0,
  $z = 0,
Level  $level = null 
)
Parameters
int$x
int$y
int$z
Level$level

Member Function Documentation

getLevel ( )

Returns the target Level, or null if the target is not valid. If a reference exists to a Level which is closed, the reference will be destroyed and null will be returned.

Returns
Level|null
getSide (   $side,
  $step = 1 
)

Returns a side Vector

Parameters
int$side
int$step
Returns
Position
Exceptions
LevelException
isValid ( )

Checks if this object has a valid reference to a loaded Level

Returns
bool
setComponents (   $x,
  $y,
  $z 
)
Parameters
$x
$y
$z
Returns
Position
setLevel ( Level  $level = null)

Sets the target Level of the position.

Parameters
Level | null$level
Returns
$this
Exceptions

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