PocketMine-MP 5.15.1 git-fb9a74e8799c71ed8292cfa53abe7a4c9204629d
pocketmine\network\mcpe\protocol\SetTitlePacket Class Reference
+ Inheritance diagram for pocketmine\network\mcpe\protocol\SetTitlePacket:
+ Collaboration diagram for pocketmine\network\mcpe\protocol\SetTitlePacket:

Public Member Functions

 __get ($name)
 
 __set ($name, $value)
 
 canBeSentBeforeLogin ()
 
 decode (PacketSerializer $in)
 
 encode (PacketSerializer $out)
 
 getName ()
 
 handle (PacketHandlerInterface $handler)
 
 pid ()
 

Static Public Member Functions

static actionBarMessage (string $text)
 
static clearTitle ()
 
static create (int $type, string $text, int $fadeInTime, int $stayTime, int $fadeOutTime, string $xuid, string $platformOnlineId,)
 
static resetTitleOptions ()
 
static setAnimationTimes (int $fadeIn, int $stay, int $fadeOut)
 
static subtitle (string $text)
 
static title (string $text)
 

Public Attributes

int $fadeInTime = 0
 
int $fadeOutTime = 0
 
string $platformOnlineId = ""
 
int $recipientSubId = 0
 
int $senderSubId = 0
 
int $stayTime = 0
 
string $text = ""
 
int $type
 
string $xuid = ""
 
const NETWORK_ID = ProtocolInfo::SET_TITLE_PACKET
 
const PID_MASK = 0x3ff
 
const TYPE_CLEAR_TITLE = 0
 
const TYPE_RESET_TITLE = 1
 
const TYPE_SET_ACTIONBAR_MESSAGE = 4
 
const TYPE_SET_ACTIONBAR_MESSAGE_JSON = 8
 
const TYPE_SET_ANIMATION_TIMES = 5
 
const TYPE_SET_SUBTITLE = 3
 
const TYPE_SET_SUBTITLE_JSON = 7
 
const TYPE_SET_TITLE = 2
 
const TYPE_SET_TITLE_JSON = 6
 

Protected Member Functions

 decodeHeader (PacketSerializer $in)
 
 decodePayload (PacketSerializer $in)
 
 encodeHeader (PacketSerializer $out)
 
 encodePayload (PacketSerializer $out)
 

Detailed Description

Definition at line 19 of file SetTitlePacket.php.

Member Function Documentation

◆ __get()

pocketmine\network\mcpe\protocol\DataPacket::__get (   $name)
inherited
Parameters
string$name
Returns
mixed

Definition at line 105 of file DataPacket.php.

◆ __set()

pocketmine\network\mcpe\protocol\DataPacket::__set (   $name,
  $value 
)
inherited
Parameters
string$name
mixed$value

Definition at line 113 of file DataPacket.php.

◆ actionBarMessage()

static pocketmine\network\mcpe\protocol\SetTitlePacket::actionBarMessage ( string  $text)
static

Definition at line 107 of file SetTitlePacket.php.

◆ canBeSentBeforeLogin()

pocketmine\network\mcpe\protocol\DataPacket::canBeSentBeforeLogin ( )
inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 42 of file DataPacket.php.

◆ clearTitle()

static pocketmine\network\mcpe\protocol\SetTitlePacket::clearTitle ( )
static

Definition at line 111 of file SetTitlePacket.php.

◆ create()

static pocketmine\network\mcpe\protocol\SetTitlePacket::create ( int  $type,
string  $text,
int  $fadeInTime,
int  $stayTime,
int  $fadeOutTime,
string  $xuid,
string  $platformOnlineId 
)
static

@generate-create-func

Definition at line 43 of file SetTitlePacket.php.

◆ decode()

pocketmine\network\mcpe\protocol\DataPacket::decode ( PacketSerializer  $in)
finalinherited
Exceptions
PacketDecodeException

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 49 of file DataPacket.php.

◆ decodeHeader()

pocketmine\network\mcpe\protocol\DataPacket::decodeHeader ( PacketSerializer  $in)
protectedinherited
Exceptions
BinaryDataException
PacketDecodeException

Definition at line 62 of file DataPacket.php.

◆ decodePayload()

pocketmine\network\mcpe\protocol\SetTitlePacket::decodePayload ( PacketSerializer  $in)
protected

Decodes the packet body, without the packet ID or other generic header fields.

Exceptions
PacketDecodeException
BinaryDataException

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 63 of file SetTitlePacket.php.

◆ encode()

pocketmine\network\mcpe\protocol\DataPacket::encode ( PacketSerializer  $out)
finalinherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 82 of file DataPacket.php.

◆ encodeHeader()

pocketmine\network\mcpe\protocol\DataPacket::encodeHeader ( PacketSerializer  $out)
protectedinherited

Definition at line 87 of file DataPacket.php.

◆ encodePayload()

pocketmine\network\mcpe\protocol\SetTitlePacket::encodePayload ( PacketSerializer  $out)
protected

Encodes the packet body, without the packet ID or other generic header fields.

Reimplemented from pocketmine\network\mcpe\protocol\DataPacket.

Definition at line 73 of file SetTitlePacket.php.

◆ getName()

pocketmine\network\mcpe\protocol\DataPacket::getName ( )
inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 38 of file DataPacket.php.

◆ handle()

pocketmine\network\mcpe\protocol\SetTitlePacket::handle ( PacketHandlerInterface  $handler)

Performs handling for this packet. Usually you'll want an appropriately named method in the session handler for this.

This method returns a bool to indicate whether the packet was handled or not. If the packet was unhandled, a debug message will be logged with a hexdump of the packet.

Typically this method returns the return value of the handler in the supplied PacketHandler. See other packets for examples how to implement this.

Returns
bool true if the packet was handled successfully, false if not.
Exceptions
PacketDecodeExceptionif broken data was found in the packet

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 83 of file SetTitlePacket.php.

◆ pid()

pocketmine\network\mcpe\protocol\DataPacket::pid ( )
inherited

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 34 of file DataPacket.php.

◆ resetTitleOptions()

static pocketmine\network\mcpe\protocol\SetTitlePacket::resetTitleOptions ( )
static

Definition at line 115 of file SetTitlePacket.php.

◆ setAnimationTimes()

static pocketmine\network\mcpe\protocol\SetTitlePacket::setAnimationTimes ( int  $fadeIn,
int  $stay,
int  $fadeOut 
)
static

Definition at line 119 of file SetTitlePacket.php.

◆ subtitle()

static pocketmine\network\mcpe\protocol\SetTitlePacket::subtitle ( string  $text)
static

Definition at line 103 of file SetTitlePacket.php.

◆ title()

static pocketmine\network\mcpe\protocol\SetTitlePacket::title ( string  $text)
static

Definition at line 99 of file SetTitlePacket.php.

Member Data Documentation

◆ $fadeInTime

int pocketmine\network\mcpe\protocol\SetTitlePacket::$fadeInTime = 0

Definition at line 34 of file SetTitlePacket.php.

◆ $fadeOutTime

int pocketmine\network\mcpe\protocol\SetTitlePacket::$fadeOutTime = 0

Definition at line 36 of file SetTitlePacket.php.

◆ $platformOnlineId

string pocketmine\network\mcpe\protocol\SetTitlePacket::$platformOnlineId = ""

Definition at line 38 of file SetTitlePacket.php.

◆ $recipientSubId

int pocketmine\network\mcpe\protocol\DataPacket::$recipientSubId = 0
inherited

Definition at line 32 of file DataPacket.php.

◆ $senderSubId

int pocketmine\network\mcpe\protocol\DataPacket::$senderSubId = 0
inherited

Definition at line 31 of file DataPacket.php.

◆ $stayTime

int pocketmine\network\mcpe\protocol\SetTitlePacket::$stayTime = 0

Definition at line 35 of file SetTitlePacket.php.

◆ $text

string pocketmine\network\mcpe\protocol\SetTitlePacket::$text = ""

Definition at line 33 of file SetTitlePacket.php.

◆ $type

int pocketmine\network\mcpe\protocol\SetTitlePacket::$type

Definition at line 32 of file SetTitlePacket.php.

◆ $xuid

string pocketmine\network\mcpe\protocol\SetTitlePacket::$xuid = ""

Definition at line 37 of file SetTitlePacket.php.

◆ NETWORK_ID

const pocketmine\network\mcpe\protocol\SetTitlePacket::NETWORK_ID = ProtocolInfo::SET_TITLE_PACKET

Definition at line 20 of file SetTitlePacket.php.

◆ PID_MASK

const pocketmine\network\mcpe\protocol\DataPacket::PID_MASK = 0x3ff
inherited

Definition at line 25 of file DataPacket.php.

◆ TYPE_CLEAR_TITLE

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_CLEAR_TITLE = 0

Definition at line 22 of file SetTitlePacket.php.

◆ TYPE_RESET_TITLE

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_RESET_TITLE = 1

Definition at line 23 of file SetTitlePacket.php.

◆ TYPE_SET_ACTIONBAR_MESSAGE

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_SET_ACTIONBAR_MESSAGE = 4

Definition at line 26 of file SetTitlePacket.php.

◆ TYPE_SET_ACTIONBAR_MESSAGE_JSON

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_SET_ACTIONBAR_MESSAGE_JSON = 8

Definition at line 30 of file SetTitlePacket.php.

◆ TYPE_SET_ANIMATION_TIMES

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_SET_ANIMATION_TIMES = 5

Definition at line 27 of file SetTitlePacket.php.

◆ TYPE_SET_SUBTITLE

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_SET_SUBTITLE = 3

Definition at line 25 of file SetTitlePacket.php.

◆ TYPE_SET_SUBTITLE_JSON

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_SET_SUBTITLE_JSON = 7

Definition at line 29 of file SetTitlePacket.php.

◆ TYPE_SET_TITLE

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_SET_TITLE = 2

Definition at line 24 of file SetTitlePacket.php.

◆ TYPE_SET_TITLE_JSON

const pocketmine\network\mcpe\protocol\SetTitlePacket::TYPE_SET_TITLE_JSON = 6

Definition at line 28 of file SetTitlePacket.php.


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