e560919096
phpdoc improvements
174 lines
3.9 KiB
PHP
174 lines
3.9 KiB
PHP
<?php
|
|
|
|
namespace ManiaControl\Manialinks;
|
|
|
|
use FML\CustomUI;
|
|
use ManiaControl\Callbacks\CallbackListener;
|
|
use ManiaControl\Callbacks\TimerListener;
|
|
use ManiaControl\ManiaControl;
|
|
use ManiaControl\Players\Player;
|
|
use ManiaControl\Players\PlayerManager;
|
|
|
|
/**
|
|
* Class managing the Custom UI in TrackMania
|
|
*
|
|
* @author ManiaControl Team <mail@maniacontrol.com>
|
|
* @copyright 2014 ManiaControl Team
|
|
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
|
|
*/
|
|
class CustomUIManager implements CallbackListener, TimerListener {
|
|
/*
|
|
* Constants
|
|
*/
|
|
const CUSTOMUI_MLID = 'CustomUI.MLID';
|
|
|
|
/*
|
|
* Private properties
|
|
*/
|
|
/** @var ManiaControl $maniaControl */
|
|
private $maniaControl = null;
|
|
/** @var customUI $customUI */
|
|
private $customUI = null;
|
|
private $updateManialink = false;
|
|
|
|
/**
|
|
* Create a custom UI manager instance
|
|
*
|
|
* @param ManiaControl $maniaControl
|
|
*/
|
|
public function __construct(ManiaControl $maniaControl) {
|
|
$this->maniaControl = $maniaControl;
|
|
$this->prepareManialink();
|
|
|
|
// Register for callbacks
|
|
$this->maniaControl->timerManager->registerTimerListening($this, 'handle1Second', 1000);
|
|
$this->maniaControl->callbackManager->registerCallbackListener(PlayerManager::CB_PLAYERCONNECT, $this, 'handlePlayerJoined');
|
|
}
|
|
|
|
/**
|
|
* Create the ManiaLink and CustomUI instances
|
|
*/
|
|
private function prepareManialink() {
|
|
$this->customUI = new CustomUI();
|
|
}
|
|
|
|
/**
|
|
* Handle 1 Second Callback
|
|
*/
|
|
public function handle1Second() {
|
|
if (!$this->updateManialink) {
|
|
return;
|
|
}
|
|
$this->updateManialink = false;
|
|
$this->updateManialink();
|
|
}
|
|
|
|
/**
|
|
* Update the CustomUI Manialink
|
|
*
|
|
* @param Player $player
|
|
*/
|
|
public function updateManialink(Player $player = null) {
|
|
if ($player) {
|
|
$this->maniaControl->manialinkManager->sendManialink($this->customUI, $player);
|
|
return;
|
|
}
|
|
$this->maniaControl->manialinkManager->sendManialink($this->customUI);
|
|
}
|
|
|
|
/**
|
|
* Handle PlayerJoined Callback
|
|
*
|
|
* @param Player $player
|
|
*/
|
|
public function handlePlayerJoined(Player $player) {
|
|
$this->updateManialink($player);
|
|
|
|
//TODO: validate necessity
|
|
//send it again after 500ms
|
|
$this->maniaControl->timerManager->registerOneTimeListening($this, function () use (&$player) {
|
|
$this->updateManialink($player);
|
|
}, 500);
|
|
}
|
|
|
|
/**
|
|
* Set Showing of Notices
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setNoticeVisible($visible) {
|
|
$this->customUI->setNoticeVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
|
|
/**
|
|
* Set Showing of the Challenge Info
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setChallengeInfoVisible($visible) {
|
|
$this->customUI->setChallengeInfoVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
|
|
/**
|
|
* Set Showing of the Net Infos
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setNetInfosVisible($visible) {
|
|
$this->customUI->setNetInfosVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
|
|
/**
|
|
* Set Showing of the Chat
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setChatVisible($visible) {
|
|
$this->customUI->setChatVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
|
|
/**
|
|
* Set Showing of the Checkpoint List
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setCheckpointListVisible($visible) {
|
|
$this->customUI->setCheckpointListVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
|
|
/**
|
|
* Set Showing of Round Scores
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setRoundScoresVisible($visible) {
|
|
$this->customUI->setRoundScoresVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
|
|
/**
|
|
* Set Showing of the Scoretable
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setScoretableVisible($visible) {
|
|
$this->customUI->setScoretableVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
|
|
/**
|
|
* Set Global Showing
|
|
*
|
|
* @param bool $visible
|
|
*/
|
|
public function setGlobalVisible($visible) {
|
|
$this->customUI->setGlobalVisible($visible);
|
|
$this->updateManialink = true;
|
|
}
|
|
}
|