Public Member Functions
	__construct (Vector3 $pos, $text, $title="")

	getText ()

	getTitle ()

	setText ($text)

	setTitle ($title)

	isInvisible ()

	setInvisible ($value=true)

	encode ()

Public Member Functions inherited from Particle
	encode ()

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 ()

Protected Attributes
	$text

	$title

	$entityId

	$invisible = false

Additional Inherited Members
Static Public Member Functions inherited from Vector3
static	getOppositeSide ($side)

static	createRandomDirection (Random $random)

Data Fields inherited from Particle
const	TYPE_BUBBLE = 1

const	TYPE_CRITICAL = 2

const	TYPE_BLOCK_FORCE_FIELD = 3

const	TYPE_SMOKE = 4

const	TYPE_EXPLODE = 5

const	TYPE_EVAPORATION = 6

const	TYPE_FLAME = 7

const	TYPE_LAVA = 8

const	TYPE_LARGE_SMOKE = 9

const	TYPE_REDSTONE = 10

const	TYPE_RISING_RED_DUST = 11

const	TYPE_ITEM_BREAK = 12

const	TYPE_SNOWBALL_POOF = 13

const	TYPE_HUGE_EXPLODE = 14

const	TYPE_HUGE_EXPLODE_SEED = 15

const	TYPE_MOB_FLAME = 16

const	TYPE_HEART = 17

const	TYPE_TERRAIN = 18

const	TYPE_SUSPENDED_TOWN = 19

const	TYPE_TOWN_AURA = 19

const	TYPE_PORTAL = 20

const	TYPE_SPLASH = 21

const	TYPE_WATER_SPLASH = 21

const	TYPE_WATER_WAKE = 22

const	TYPE_DRIP_WATER = 23

const	TYPE_DRIP_LAVA = 24

const	TYPE_FALLING_DUST = 25

const	TYPE_DUST = 25

const	TYPE_MOB_SPELL = 26

const	TYPE_MOB_SPELL_AMBIENT = 27

const	TYPE_MOB_SPELL_INSTANTANEOUS = 28

const	TYPE_INK = 29

const	TYPE_SLIME = 30

const	TYPE_RAIN_SPLASH = 31

const	TYPE_VILLAGER_ANGRY = 32

const	TYPE_VILLAGER_HAPPY = 33

const	TYPE_ENCHANTMENT_TABLE = 34

const	TYPE_TRACKING_EMITTER = 35

const	TYPE_NOTE = 36

const	TYPE_WITCH_SPELL = 37

const	TYPE_CARROT = 38

const	TYPE_END_ROD = 40

const	TYPE_DRAGONS_BREATH = 41

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	(	Vector3	$pos,
			$text,
			$title = `""`
	)

Parameters

Vector3	$pos
int	$text
string	$title

                                                                  {
         parent::__construct($pos->x, $pos->y, $pos->z);
         $this->text = $text;
         $this->title = $title;
     }

Member Function Documentation

◆ encode()

encode ( )

Returns: array

                             {
         $p = [];
 
         if($this->entityId === null){
             $this->entityId = Entity::$entityCount++;
         }else{
             $pk0 = new RemoveEntityPacket();
             $pk0->eid = $this->entityId;
 
             $p[] = $pk0;
         }
 
         if(!$this->invisible){
 
             $pk = new AddPlayerPacket();
             $pk->uuid = UUID::fromRandom();
             $pk->username = $this->title;
             $pk->eid = $this->entityId;
             $pk->x = $this->x;
             $pk->y = $this->y - 0.50;
             $pk->z = $this->z;
             $pk->item = Item::get(Item::AIR);
             $flags = (
                 (1 << Entity::DATA_FLAG_CAN_SHOW_NAMETAG) |
                 (1 << Entity::DATA_FLAG_ALWAYS_SHOW_NAMETAG) |
                 (1 << Entity::DATA_FLAG_IMMOBILE)
             );
             $pk->metadata = [
                 Entity::DATA_FLAGS => [Entity::DATA_TYPE_LONG, $flags],
                 Entity::DATA_NAMETAG => [Entity::DATA_TYPE_STRING, $this->title . ($this->text !== "" ? "\n" . $this->text : "")],
                 Entity::DATA_SCALE => [Entity::DATA_TYPE_FLOAT, 0],
             ];
 
             $p[] = $pk;
         }
 
         return $p;
     }

◆ getText()

getText ( )

Returns: int

                              {
         return $this->text;
     }

◆ getTitle()

getTitle ( )

Returns: string

                               {
         return $this->title;
     }

◆ isInvisible()

isInvisible ( )

Returns: bool

                                  {
         return $this->invisible;
     }

◆ setInvisible()

setInvisible ( $value = true )

Parameters

bool $value

                                                {
         $this->invisible = (bool) $value;
     }

◆ setText()

setText ( $text )

Parameters

$text

                                   {
         $this->text = $text;
     }

◆ setTitle()

setTitle ( $title )

Parameters

$title

                                     {
         $this->title = $title;
     }

Field Documentation

◆ $entityId

$entityId

protected

◆ $invisible

$invisible = false

protected

◆ $text

$text

protected

◆ $title

$title

protected

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

src/pocketmine/level/particle/FloatingTextParticle.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ encode()

◆ getText()

◆ getTitle()

◆ isInvisible()

◆ setInvisible()

◆ setText()

◆ setTitle()

Field Documentation

◆ $entityId

◆ $invisible

◆ $text

◆ $title