PocketMine-MP 5.15.1 git-5ef247620a7c6301a849b54e5ef1009217729fc8
pocketmine\network\mcpe\protocol\PlaySoundPacket Class Reference
+ Inheritance diagram for pocketmine\network\mcpe\protocol\PlaySoundPacket:
+ Collaboration diagram for pocketmine\network\mcpe\protocol\PlaySoundPacket:

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 create (string $soundName, float $x, float $y, float $z, float $volume, float $pitch)
 

Public Attributes

float $pitch
 
int $recipientSubId = 0
 
int $senderSubId = 0
 
string $soundName
 
float $volume
 
float $x
 
float $y
 
float $z
 
const NETWORK_ID = ProtocolInfo::PLAY_SOUND_PACKET
 
const PID_MASK = 0x3ff
 

Protected Member Functions

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

Detailed Description

Definition at line 20 of file PlaySoundPacket.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.

◆ canBeSentBeforeLogin()

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

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 42 of file DataPacket.php.

◆ create()

static pocketmine\network\mcpe\protocol\PlaySoundPacket::create ( string  $soundName,
float  $x,
float  $y,
float  $z,
float  $volume,
float  $pitch 
)
static

@generate-create-func

Definition at line 33 of file PlaySoundPacket.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\PlaySoundPacket::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 44 of file PlaySoundPacket.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\PlaySoundPacket::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 54 of file PlaySoundPacket.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\PlaySoundPacket::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 61 of file PlaySoundPacket.php.

◆ pid()

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

Implements pocketmine\network\mcpe\protocol\Packet.

Definition at line 34 of file DataPacket.php.

Member Data Documentation

◆ $pitch

float pocketmine\network\mcpe\protocol\PlaySoundPacket::$pitch

Definition at line 28 of file PlaySoundPacket.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.

◆ $soundName

string pocketmine\network\mcpe\protocol\PlaySoundPacket::$soundName

Definition at line 23 of file PlaySoundPacket.php.

◆ $volume

float pocketmine\network\mcpe\protocol\PlaySoundPacket::$volume

Definition at line 27 of file PlaySoundPacket.php.

◆ $x

float pocketmine\network\mcpe\protocol\PlaySoundPacket::$x

Definition at line 24 of file PlaySoundPacket.php.

◆ $y

float pocketmine\network\mcpe\protocol\PlaySoundPacket::$y

Definition at line 25 of file PlaySoundPacket.php.

◆ $z

float pocketmine\network\mcpe\protocol\PlaySoundPacket::$z

Definition at line 26 of file PlaySoundPacket.php.

◆ NETWORK_ID

const pocketmine\network\mcpe\protocol\PlaySoundPacket::NETWORK_ID = ProtocolInfo::PLAY_SOUND_PACKET

Definition at line 21 of file PlaySoundPacket.php.

◆ PID_MASK

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

Definition at line 25 of file DataPacket.php.


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