454 lines
14 KiB
PHP
454 lines
14 KiB
PHP
<?php
|
|
|
|
namespace MCTeam;
|
|
|
|
use ManiaControl\Commands\CommandListener;
|
|
use ManiaControl\ManiaControl;
|
|
use ManiaControl\Players\Player;
|
|
use ManiaControl\Plugins\Plugin;
|
|
use Maniaplanet\DedicatedServer\Xmlrpc\PlayerStateException;
|
|
use Maniaplanet\DedicatedServer\Xmlrpc\ServerOptionsException;
|
|
use Maniaplanet\DedicatedServer\Xmlrpc\UnknownPlayerException;
|
|
|
|
/**
|
|
* ManiaControl Chat-Message Plugin
|
|
*
|
|
* @author ManiaControl Team <mail@maniacontrol.com>
|
|
* @copyright 2014-2020 ManiaControl Team
|
|
* @license http://www.gnu.org/licenses/ GNU General Public License, Version 3
|
|
*/
|
|
class ChatMessagePlugin implements CommandListener, Plugin {
|
|
/*
|
|
* Constants
|
|
*/
|
|
const PLUGIN_ID = 4;
|
|
const PLUGIN_VERSION = 0.1;
|
|
const PLUGIN_NAME = 'ChatMessagePlugin';
|
|
const PLUGIN_AUTHOR = 'kremsy';
|
|
const SETTING_AFK_FORCE_SPEC = 'AFK command forces spec';
|
|
|
|
/*
|
|
* Private properties
|
|
*/
|
|
/** @var ManiaControl $maniaControl */
|
|
private $maniaControl = null;
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::prepare()
|
|
*/
|
|
public static function prepare(ManiaControl $maniaControl) {
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::getId()
|
|
*/
|
|
public static function getId() {
|
|
return self::PLUGIN_ID;
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::getName()
|
|
*/
|
|
public static function getName() {
|
|
return self::PLUGIN_NAME;
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::getVersion()
|
|
*/
|
|
public static function getVersion() {
|
|
return self::PLUGIN_VERSION;
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::getAuthor()
|
|
*/
|
|
public static function getAuthor() {
|
|
return self::PLUGIN_AUTHOR;
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::getDescription()
|
|
*/
|
|
public static function getDescription() {
|
|
return "Plugin offers various Chat-Commands like /gg /hi /afk /rq...";
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::load()
|
|
*/
|
|
public function load(ManiaControl $maniaControl) {
|
|
$this->maniaControl = $maniaControl;
|
|
|
|
// Chat commands
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('me', $this, 'chat_me', false, 'Can be used to express your feelings/ideas.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('hi', $this, 'chat_hi', false, 'Writes an hello message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener(array('bb', 'bye'), $this, 'chat_bye', false, 'Writes a goodbye message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('thx', $this, 'chat_thx', false, 'Writes a thanks message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('gg', $this, 'chat_gg', false, 'Writes a good game message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('gl', $this, 'chat_gl', false, 'Writes a good luck message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('hf', $this, 'chat_hf', false, 'Writes an have fun message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('glhf', $this, 'chat_glhf', false, 'Writes a good luck, have fun message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('ns', $this, 'chat_ns', false, 'Writes a nice shot message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('n1', $this, 'chat_n1', false, 'Writes a nice one message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('lol', $this, 'chat_lol', false, 'Writes a lol message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('lool', $this, 'chat_lool', false, 'Writes a lool message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('brb', $this, 'chat_brb', false, 'Writes a be right back message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('bgm', $this, 'chat_bgm', false, 'Writes a bad game for me message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('afk', $this, 'chat_afk', false, 'Writes an away from keyboard message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener('wp', $this, 'chat_wp', false, 'Writes an well played message to the chat.');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener(array('bm', 'bootme'), $this, 'chat_bootme', false, 'Gets you away from this server quickly!');
|
|
$this->maniaControl->getCommandManager()->registerCommandListener(array('rq', 'ragequit'), $this, 'chat_ragequit', false, 'Gets you away from this server in rage!');
|
|
//TODO block command listener for muted people
|
|
$this->maniaControl->getSettingManager()->initSetting($this, self::SETTING_AFK_FORCE_SPEC, true);
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @see \ManiaControl\Plugins\Plugin::unload()
|
|
*/
|
|
public function unload() {
|
|
}
|
|
|
|
|
|
/**
|
|
* Builds a chat message starting with the player's nickname, can used to express emotions
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_me(array $chat, Player $player) {
|
|
$message = substr($chat[1][2], 4);
|
|
|
|
$msg = '$<' . $player->nickname . '$>$s$i$fa0 ' . $message;
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Hello Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_hi(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iHello $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iHello All!';
|
|
}
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Bye Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_bye(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iBye $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iI have to go... Bye All!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Thx Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_thx(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iThanks $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iThanks All!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Good Game Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_gg(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[' . $player->getEscapedNickname() . '] $ff0$iGood Game $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[' . $player->getEscapedNickname() . '] $ff0$iGood Game All!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Good Luck Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_gl(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iGood Luck $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iGood Luck All!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Have Fun Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_hf(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[' . $player->getEscapedNickname() . '] $ff0$iHave Fun $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[' . $player->getEscapedNickname() . '] $ff0$iHave Fun All!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Good Luck and Have Fun Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_glhf(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iGood Luck and Have Fun $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iGood Luck and Have Fun All!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Nice Shot Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_ns(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iNice Shot $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iNice Shot!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Nice one Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_n1(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iNice One $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iNice One!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Well Played message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_wp(array $chat, Player $player) {
|
|
$command = explode(" ", $chat[1][2]);
|
|
|
|
if (isset($command[1])) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iWell Played $z$<' . $this->getTarget($command[1]) . '$>$i!';
|
|
} else {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iWell Played!';
|
|
}
|
|
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Lol! Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_lol(array $chat, Player $player) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iLoL!';
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* LooOOooL! Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_lool(array $chat, Player $player) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iLooOOooL!';
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Be right back Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_brb(array $chat, Player $player) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iBe Right Back!';
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Bad game for me Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_bgm(array $chat, Player $player) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iBad Game for me :(';
|
|
$this->sendChat($msg, $player);
|
|
}
|
|
|
|
/**
|
|
* Leave the server with an Bootme Message
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_bootme(array $chat, Player $player) {
|
|
$msg = '$i$ff0 $<' . $player->nickname . '$>$s$39f chooses to boot back to the real world!';
|
|
$this->sendChat($msg, $player, true);
|
|
|
|
$message = '$39F Thanks for Playing, see you around!$z';
|
|
try {
|
|
$this->maniaControl->getClient()->kick($player->login, $message);
|
|
} catch (UnknownPlayerException $exception) {
|
|
$this->maniaControl->getChat()->sendException($exception, $player);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Leave the server with an Ragequit
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_ragequit(array $chat, Player $player) {
|
|
try {
|
|
$message = '$39F Thanks for Playing, please come back soon!$z ';
|
|
$this->maniaControl->getClient()->kick($player->login, $message);
|
|
$msg = '$i$ff0 $<' . $player->nickname . '$>$s$f00 said: "@"#!" and ragequitted!';
|
|
$this->sendChat($msg, $player, true);
|
|
} catch (UnknownPlayerException $e) {
|
|
$this->maniaControl->getChat()->sendError('Error occurred: ' . $e->getMessage(), $player);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Afk Message and force player to spec
|
|
*
|
|
* @param array $chat
|
|
* @param Player $player
|
|
*/
|
|
public function chat_afk(array $chat, Player $player) {
|
|
$msg = '$ff0[$<' . $player->nickname . '$>] $ff0$iAway From Keyboard!';
|
|
$this->sendChat($msg, $player);
|
|
|
|
if (!$this->maniaControl->getSettingManager()->getSettingValue($this, self::SETTING_AFK_FORCE_SPEC)) {
|
|
return;
|
|
}
|
|
if ($player->isSpectator) {
|
|
return;
|
|
}
|
|
|
|
try {
|
|
// Force into spec
|
|
$this->maniaControl->getClient()->forceSpectator($player->login, 3);
|
|
// Free player slot
|
|
$this->maniaControl->getClient()->spectatorReleasePlayerSlot($player->login);
|
|
} catch (UnknownPlayerException $exception) {
|
|
$this->maniaControl->getChat()->sendException($exception, $player);
|
|
} catch (PlayerStateException $exception) {
|
|
} catch (ServerOptionsException $exception) {
|
|
//too many spectators
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks if a Player is in the PlayerList and returns the nickname if he is, can be called per login, pid or nickname or lj for
|
|
* (last joined)
|
|
*
|
|
* @param mixed $login
|
|
* @return mixed
|
|
*/
|
|
private function getTarget($login) {
|
|
$player = null;
|
|
foreach ($this->maniaControl->getPlayerManager()->getPlayers() as $player) {
|
|
if ($login == $player || $login == $player->login || $login == $player->pid || $login == $player->nickname) {
|
|
return $player->nickname;
|
|
}
|
|
}
|
|
|
|
if ($player && strtolower($login) === 'lj') {
|
|
return $player->nickname;
|
|
}
|
|
|
|
//returns the text given if nothing matches
|
|
return $login;
|
|
}
|
|
|
|
/**
|
|
* Checks if the Player is Muted and sends the Chat if he isnt
|
|
*
|
|
* @param $msg
|
|
* @param Player $player
|
|
* @param bool $prefix
|
|
*/
|
|
private function sendChat($msg, Player $player, $prefix = false) {
|
|
if (!$player->isMuted()) {
|
|
$this->maniaControl->getChat()->sendChat($msg, null, $prefix);
|
|
} else {
|
|
$this->maniaControl->getChat()->sendError("You can't use this command because you are muted!", $player);
|
|
}
|
|
}
|
|
}
|