Files
PocketMine-MP/src/event/player/PlayerJoinEvent.php
2022-06-04 17:34:49 +01:00

53 lines
1.6 KiB
PHP

<?php
/*
*
* ____ _ _ __ __ _ __ __ ____
* | _ \ ___ ___| | _____| |_| \/ (_)_ __ ___ | \/ | _ \
* | |_) / _ \ / __| |/ / _ \ __| |\/| | | '_ \ / _ \_____| |\/| | |_) |
* | __/ (_) | (__| < __/ |_| | | | | | | | __/_____| | | | __/
* |_| \___/ \___|_|\_\___|\__|_| |_|_|_| |_|\___| |_| |_|_|
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* @author PocketMine Team
* @link http://www.pocketmine.net/
*
*
*/
declare(strict_types=1);
namespace pocketmine\event\player;
use pocketmine\lang\Translatable;
use pocketmine\player\Player;
/**
* Called when the player spawns in the world after logging in, when they first see the terrain.
*
* Note: A lot of data is sent to the player between login and this event. Disconnecting the player during this event
* will cause this data to be wasted. Prefer disconnecting at login-time if possible to minimize bandwidth wastage.
* @see PlayerLoginEvent
*/
class PlayerJoinEvent extends PlayerEvent{
/** @var string|Translatable */
protected $joinMessage;
public function __construct(Player $player, Translatable|string $joinMessage){
$this->player = $player;
$this->joinMessage = $joinMessage;
}
public function setJoinMessage(Translatable|string $joinMessage) : void{
$this->joinMessage = $joinMessage;
}
public function getJoinMessage() : Translatable|string{
return $this->joinMessage;
}
}