Position Class Reference

Public Member Functions
	__construct ($x=0, $y=0, $z=0, Level $level=null)
	asPosition ()
	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)
	asVector3 ()
	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 ($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()

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

Parameters

int	$x
int	$y
int	$z
Level	$level

                                                                            {
        $this->x = $x;
        $this->y = $y;
        $this->z = $z;
        $this->level = $level;
    }

Member Function Documentation

__toString()

__toString

(

)

Returns

string

                                {
        return "Position(level=" . ($this->isValid() ? $this->getLevel()->getName() : "null") . ",x=" . $this->x . ",y=" . $this->y . ",z=" . $this->z . ")";
    }

add()

add	(		$x,
			$y = 0,
			$z = 0
	)

Parameters

int | Vector3	$x
int	$y
int	$z

Returns

Position

                                           {
        if($x instanceof Vector3){
            return new Position($this->x + $x->x, $this->y + $x->y, $this->z + $x->z, $this->level);
        }else{
            return new Position($this->x + $x, $this->y + $y, $this->z + $z, $this->level);
        }
    }

asPosition()

asPosition

(

)

Return a Position instance

Returns

Position

                                 : Position{
        return new Position($this->x, $this->y, $this->z, $this->level);
    }

fromObject()

static fromObject ( Vector3  $pos, Level  $level = null  )

static

Parameters

Vector3	$pos
Level | null	$level

Returns

Position

                                                                        {
        return new Position($pos->x, $pos->y, $pos->z, $level);
    }

fromObjectAdd()

fromObjectAdd	(	Vector3	$pos,
			$x,
			$y,
			$z
	)

Parameters

Vector3	$pos
	$x
	$y
	$z

Returns

$this

                                                           {
        if($pos instanceof Position){
            $this->level = $pos->level;
        }
        parent::fromObjectAdd($pos, $x, $y, $z);
        return $this;
    }

getLevel()

getLevel

(

)

Returns

Level

                              {
        if($this->level !== null and $this->level->isClosed()){
            MainLogger::getLogger()->debug("Position was holding a reference to an unloaded Level");
            $this->level = null;
        }

        return $this->level;
    }

getSide()

getSide	(		$side,
			$step = 1
	)

Returns a side Vector

Parameters

int	$side
int	$step

Returns

Position

Exceptions

LevelException

                                             {
        if(!$this->isValid()){
            throw new LevelException("Undefined Level reference");
        }

        return Position::fromObject(parent::getSide($side, $step), $this->level);
    }

isValid()

isValid

(

)

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

Returns

bool

                             {
        return $this->getLevel() instanceof Level;
    }

setComponents()

setComponents	(		$x,
			$y,
			$z
	)

Parameters

$x
$y
$z

Returns

Position

                                             {
        $this->x = $x;
        $this->y = $y;
        $this->z = $z;
        return $this;
    }

setLevel()

setLevel

(

Level

$level = null

)

Sets the target Level of the position.

Parameters

Level | null

$level

Returns

$this

Exceptions

                                                 {
        if($level !== null and $level->isClosed()){
            throw new \InvalidArgumentException("Specified level has been unloaded and cannot be used");
        }

        $this->level = $level;
        return $this;
    }

Field Documentation

$level

$level = null

---

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

• src/pocketmine/level/Position.php