rewrote customvotes plugin

This commit is contained in:
kremsy 2014-02-07 22:57:39 +01:00 committed by Steffen Schröder
parent 9a4a2599e7
commit 47b7d13a2b
2 changed files with 171 additions and 78 deletions

View File

@ -2,6 +2,7 @@
namespace ManiaControl\Maps; namespace ManiaControl\Maps;
use CustomVotesPlugin;
use FML\Controls\Control; use FML\Controls\Control;
use FML\Controls\Frame; use FML\Controls\Frame;
use FML\Controls\Gauge; use FML\Controls\Gauge;
@ -36,12 +37,14 @@ class MapList implements ManialinkPageAnswerListener, CallbackListener {
const ACTION_UPDATE_MAP = 'MapList.UpdateMap'; const ACTION_UPDATE_MAP = 'MapList.UpdateMap';
const ACTION_ERASE_MAP = 'MapList.EraseMap'; const ACTION_ERASE_MAP = 'MapList.EraseMap';
const ACTION_SWITCH_MAP = 'MapList.SwitchMap'; const ACTION_SWITCH_MAP = 'MapList.SwitchMap';
const ACTION_START_SWITCH_VOTE = 'MapList.StartMapSwitchVote';
const ACTION_QUEUED_MAP = 'MapList.QueueMap'; const ACTION_QUEUED_MAP = 'MapList.QueueMap';
const ACTION_UNQUEUE_MAP = 'MapList.UnQueueMap'; const ACTION_UNQUEUE_MAP = 'MapList.UnQueueMap';
const ACTION_CHECK_UPDATE = 'MapList.CheckUpdate'; const ACTION_CHECK_UPDATE = 'MapList.CheckUpdate';
const ACTION_CLEAR_MAPQUEUE = 'MapList.ClearMapQueue'; const ACTION_CLEAR_MAPQUEUE = 'MapList.ClearMapQueue';
const MAX_MAPS_PER_PAGE = 15; const MAX_MAPS_PER_PAGE = 15;
const DEFAULT_KARMA_PLUGIN = 'KarmaPlugin'; const DEFAULT_KARMA_PLUGIN = 'KarmaPlugin';
const DEFAULT_CUSTOM_VOTE_PLUGIN = 'CustomVotesPlugin';
/** /**
* Private Properties * Private Properties
@ -316,10 +319,23 @@ class MapList implements ManialinkPageAnswerListener, CallbackListener {
$confirmFrame = $this->buildConfirmFrame($maniaLink, $y, $id, $map->uid); $confirmFrame = $this->buildConfirmFrame($maniaLink, $y, $id, $map->uid);
$script->addToggle($eraseLabel, $confirmFrame); $script->addToggle($eraseLabel, $confirmFrame);
$script->addTooltip($eraseLabel, $descriptionLabel, array(Script::OPTION_TOOLTIP_TEXT => 'Remove Map: $<' . $map->name . '$>')); $script->addTooltip($eraseLabel, $descriptionLabel, array(Script::OPTION_TOOLTIP_TEXT => 'Remove Map: $<' . $map->name . '$>'));
} }
if ($this->maniaControl->authenticationManager->checkPermission($player, MapManager::SETTING_PERMISSION_ADD_MAP)) { //Switch Map Voting
if ($this->maniaControl->pluginManager->isPluginActive(self::DEFAULT_CUSTOM_VOTE_PLUGIN)) {
$switchLabel = new Label_Button();
$mapFrame->add($switchLabel);
$switchLabel->setX($width / 2 - 10);
$switchLabel->setZ(0.2);
$switchLabel->setSize(3, 3);
$switchLabel->setTextSize(2);
$switchLabel->setText('»');
$switchLabel->setTextColor('0f0');
$switchLabel->setAction(self::ACTION_START_SWITCH_VOTE . '.' . ($id - 1) . '.' . $map->uid);
$script->addTooltip($switchLabel, $descriptionLabel, array(Script::OPTION_TOOLTIP_TEXT => 'Start Map-Switch vote: $<' . $map->name . '$>'));
} else if ($this->maniaControl->authenticationManager->checkPermission($player, MapManager::SETTING_PERMISSION_ADD_MAP)) {
// Switch to map // Switch to map
$switchLabel = new Label_Button(); $switchLabel = new Label_Button();
$mapFrame->add($switchLabel); $mapFrame->add($switchLabel);
@ -334,7 +350,6 @@ class MapList implements ManialinkPageAnswerListener, CallbackListener {
$script->addToggle($switchLabel, $confirmFrame); $script->addToggle($switchLabel, $confirmFrame);
$script->addTooltip($switchLabel, $descriptionLabel, array(Script::OPTION_TOOLTIP_TEXT => 'Switch Directly to Map: $<' . $map->name . '$>')); $script->addTooltip($switchLabel, $descriptionLabel, array(Script::OPTION_TOOLTIP_TEXT => 'Switch Directly to Map: $<' . $map->name . '$>'));
} }
// Display Karma bar // Display Karma bar
@ -508,6 +523,25 @@ class MapList implements ManialinkPageAnswerListener, CallbackListener {
$this->playerCloseWidget($player); $this->playerCloseWidget($player);
break; break;
case self::ACTION_START_SWITCH_VOTE:
/** @var $votesPlugin CustomVotesPlugin */
$votesPlugin = $this->maniaControl->pluginManager->getPlugin(self::DEFAULT_CUSTOM_VOTE_PLUGIN);
$mapList = $this->maniaControl->mapManager->getMaps();
$map = $mapList[$mapId];
/** @var Map $map */
$votesPlugin->defineVote('switchmap', "Goto " . $map->name, true);
$votesPlugin->startVote($player, 'switchmap', function ($result) use (&$votesPlugin, &$map) {
$this->maniaControl->chat->sendInformation('$sVote Successfully -> Map switched!');
$votesPlugin->undefineVote('switchmap');
try {
$this->maniaControl->client->jumpToMapIndex($map->index);
} catch(\Exception $e) {
$this->maniaControl->chat->sendError("Error while Switching Map");
}
});
break;
case self::ACTION_QUEUED_MAP: case self::ACTION_QUEUED_MAP:
$this->maniaControl->mapManager->mapQueue->addMapToMapQueue($callback[1][1], $actionArray[2]); $this->maniaControl->mapManager->mapQueue->addMapToMapQueue($callback[1][1], $actionArray[2]);
break; break;

View File

@ -59,8 +59,6 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
const MLID_WIDGET = 'CustomVotesPlugin.WidgetId'; const MLID_WIDGET = 'CustomVotesPlugin.WidgetId';
const MLID_ICON = 'CustomVotesPlugin.IconWidgetId'; const MLID_ICON = 'CustomVotesPlugin.IconWidgetId';
const VOTE_FOR_ACTION = '1';
const VOTE_AGAINST_ACTION = '-1';
const ACTION_POSITIVE_VOTE = 'CustomVotesPlugin.PositiveVote'; const ACTION_POSITIVE_VOTE = 'CustomVotesPlugin.PositiveVote';
const ACTION_NEGATIVE_VOTE = 'CustomVotesPlugin.NegativeVote'; const ACTION_NEGATIVE_VOTE = 'CustomVotesPlugin.NegativeVote';
@ -76,14 +74,8 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
private $maniaControl = null; private $maniaControl = null;
private $voteCommands = array(); private $voteCommands = array();
private $voteMenuItems = array(); private $voteMenuItems = array();
/** @var CurrentVote $currentVote */
private $currentVote = null; private $currentVote = null;
private $currentVoteExpireTime = 0;
private $playersVoted = array();
private $playersVotedPositiv = 0;
private $currentNeededRatio = 0;
private $currentNeededPlayerRatio = 0;
/** @var Player $voter */
private $voter = null;
/** /**
* Prepares the Plugin * Prepares the Plugin
@ -132,11 +124,11 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
$this->maniaControl->settingManager->initSetting($this, self::SETTING_VOTE_TIME, 60); $this->maniaControl->settingManager->initSetting($this, self::SETTING_VOTE_TIME, 60);
//Define Votes //Define Votes
$this->defineVote("teambalance", "Team Balance"); $this->defineVote("teambalance", "Vote for Team Balance");
$this->defineVote("skipmap", "Skip Map"); $this->defineVote("skipmap", "Vote for Skip Map");
$this->defineVote("nextmap", "Skip Map"); $this->defineVote("nextmap", "Vote for Skip Map");
$this->defineVote("restartmap", "Restart Map"); $this->defineVote("restartmap", "Vote for Restart Map");
$this->defineVote("pausegame", "Pause Game"); $this->defineVote("pausegame", "Vote for Pause Game");
/* Disable Standard Votes */ /* Disable Standard Votes */
$array["Command"] = VoteRatio::COMMAND_BAN; $array["Command"] = VoteRatio::COMMAND_BAN;
@ -238,7 +230,7 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
/** /**
* Handle ManiaControl OnInit callback * Handle ManiaControl OnInit callback
* *
* @param array $callback * @internal param array $callback
*/ */
private function constructMenu() { private function constructMenu() {
// Menu RestartMap // Menu RestartMap
@ -301,7 +293,13 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
$voteName = $callback[1]; $voteName = $callback[1];
$voteResult = $callback[2]; $voteResult = $callback[2];
if ($voteResult >= $this->currentNeededRatio) { if ($voteResult >= $this->currentVote->neededRatio) {
// Call Closure if one exists
if (is_callable($this->currentVote->function)) {
call_user_func($this->currentVote->function, $voteResult);
return;
}
switch($voteName) { switch($voteName) {
case 'teambalance': case 'teambalance':
$this->maniaControl->client->autoTeamBalance(); $this->maniaControl->client->autoTeamBalance();
@ -349,22 +347,36 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
/** /**
* Defines a Vote * Defines a Vote
* *
* @param $voteIndex
* @param $voteName * @param $voteName
* @param bool $idBased
* @param $neededRatio
*/ */
public function defineVote($voteIndex, $voteName, $neededRatio = -1) { public function defineVote($voteIndex, $voteName, $idBased = false, $neededRatio = -1) {
if ($neededRatio == -1) { if ($neededRatio == -1) {
$neededRatio = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DEFAULT_RATIO); $neededRatio = $this->maniaControl->settingManager->getSetting($this, self::SETTING_DEFAULT_RATIO);
} }
$this->voteCommands[$voteIndex] = array("Index" => $voteIndex, "Name" => $voteName, "Ratio" => $neededRatio); $this->voteCommands[$voteIndex] = new VoteCommand($voteIndex, $voteName, $idBased, $neededRatio);
} }
/**
* Undefines a Vote
*
* @param $voteIndex
*/
public function undefineVote($voteIndex) {
unset($this->voteCommands[$voteIndex]);
}
/** /**
* Starts a vote * Starts a vote
* *
* @param \ManiaControl\Players\Player $player * @param \ManiaControl\Players\Player $player
* @param $voteIndex * @param $voteIndex
* @param $action
*/ */
public function startVote(Player $player, $voteIndex) { public function startVote(Player $player, $voteIndex, $function = null) {
//Player is muted //Player is muted
if ($this->maniaControl->playerManager->playerActions->isPlayerMuted($player)) { if ($this->maniaControl->playerManager->playerActions->isPlayerMuted($player)) {
$this->maniaControl->chat->sendError('Muted Players are not allowed to start a vote.', $player->login); $this->maniaControl->chat->sendError('Muted Players are not allowed to start a vote.', $player->login);
@ -384,25 +396,21 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
} }
//A vote is currently running //A vote is currently running
if ($this->currentVote != null) { if (isset($this->currentVote)) {
$this->maniaControl->chat->sendError('There is currently another vote running.', $player->login); $this->maniaControl->chat->sendError('There is currently another vote running.', $player->login);
return; return;
} }
$this->currentNeededPlayerRatio = floatval($this->maniaControl->settingManager->getSetting($this, self::SETTING_DEFAULT_PLAYER_RATIO));
$this->currentNeededRatio = floatval($this->maniaControl->settingManager->getSetting($this, self::SETTING_DEFAULT_RATIO));
$maxTime = $this->maniaControl->settingManager->getSetting($this, self::SETTING_VOTE_TIME); $maxTime = $this->maniaControl->settingManager->getSetting($this, self::SETTING_VOTE_TIME);
$this->currentVote = $this->voteCommands[$voteIndex]; $this->currentVote = $this->voteCommands[$voteIndex];
$this->currentVoteExpireTime = time() + $maxTime;
$this->playersVoted[$player->login] = self::VOTE_FOR_ACTION; $this->currentVote = new CurrentVote($this->voteCommands[$voteIndex], $player, time() + $maxTime);
$this->playersVotedPositiv++; $this->currentVote->neededRatio = floatval($this->maniaControl->settingManager->getSetting($this, self::SETTING_DEFAULT_RATIO));
$this->currentVote->neededPlayerRatio = floatval($this->maniaControl->settingManager->getSetting($this, self::SETTING_DEFAULT_PLAYER_RATIO));
$this->currentVote->function = $function;
$this->voter = $player; $this->maniaControl->chat->sendSuccess('$<' . $player->nickname . '$>$s started a $<' . $this->currentVote->voteCommand->name . '$>!');
$this->maniaControl->chat->sendSuccess('$<' . $player->nickname . '$>$s started a $<' . $this->currentVote['Name'] . '$> vote!');
} }
/** /**
@ -416,15 +424,7 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
return; return;
} }
if (isset($this->playersVoted[$player->login])) { $this->currentVote->votePositive($player->login);
if ($this->playersVoted[$player->login] == self::VOTE_AGAINST_ACTION) {
$this->playersVoted[$player->login] = self::VOTE_FOR_ACTION;
$this->playersVotedPositiv++;
}
} else {
$this->playersVoted[$player->login] = self::VOTE_FOR_ACTION;
$this->playersVotedPositiv++;
}
} }
/** /**
@ -438,14 +438,7 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
return; return;
} }
if (isset($this->playersVoted[$player->login])) { $this->currentVote->voteNegative($player->login);
if ($this->playersVoted[$player->login] == self::VOTE_FOR_ACTION) {
$this->playersVoted[$player->login] = self::VOTE_AGAINST_ACTION;
$this->playersVotedPositiv--;
}
} else {
$this->playersVoted[$player->login] = self::VOTE_AGAINST_ACTION;
}
} }
/** /**
@ -454,22 +447,22 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
* @param $time * @param $time
*/ */
public function handle1Second($time) { public function handle1Second($time) {
if ($this->currentVote == null) { if (!isset($this->currentVote)) {
return; return;
} }
$votePercentage = $this->playersVotedPositiv / count($this->playersVoted); $votePercentage = $this->currentVote->positiveVotes / $this->currentVote->getVoteCount();
$timeUntilExpire = $this->currentVoteExpireTime - time(); $timeUntilExpire = $this->currentVote->expireTime - time();
$this->showVoteWidget($timeUntilExpire, $votePercentage); $this->showVoteWidget($timeUntilExpire, $votePercentage);
$playerCount = count($this->maniaControl->playerManager->getPlayers()); $playerCount = count($this->maniaControl->playerManager->getPlayers());
$playersVoteRatio = (100 / $playerCount * count($this->playersVoted)) / 100; $playersVoteRatio = (100 / $playerCount * $this->currentVote->getVoteCount()) / 100;
//Check if vote is over //Check if vote is over
if ($timeUntilExpire <= 0 || (($playersVoteRatio >= $this->currentNeededPlayerRatio) && (($votePercentage >= $this->currentNeededRatio) || ($votePercentage <= 1 - $this->currentNeededRatio)))) { if ($timeUntilExpire <= 0 || (($playersVoteRatio >= $this->currentVote->neededPlayerRatio) && (($votePercentage >= $this->currentVote->neededRatio) || ($votePercentage <= 1 - $this->currentVote->neededRatio)))) {
// Trigger callback // Trigger callback
$this->maniaControl->callbackManager->triggerCallback(self::CB_CUSTOM_VOTE_FINISHED, array(self::CB_CUSTOM_VOTE_FINISHED, $this->currentVote["Index"], $votePercentage)); $this->maniaControl->callbackManager->triggerCallback(self::CB_CUSTOM_VOTE_FINISHED, array(self::CB_CUSTOM_VOTE_FINISHED, $this->currentVote->voteCommand->index, $votePercentage));
//reset vote //reset vote
$this->destroyVote(); $this->destroyVote();
@ -484,12 +477,7 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
$manialinkText = $emptyManialink->render()->saveXML(); $manialinkText = $emptyManialink->render()->saveXML();
$this->maniaControl->manialinkManager->sendManialink($manialinkText); $this->maniaControl->manialinkManager->sendManialink($manialinkText);
$this->currentNeededPlayerRatio = 0; unset($this->currentVote);
$this->currentNeededRatio = 0;
$this->playersVotedPositiv = 0;
$this->playersVoted = null;
$this->currentVote = null;
$this->voter = null;
} }
/** /**
@ -533,7 +521,7 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
$label->setAlign(Control::CENTER, Control::CENTER); $label->setAlign(Control::CENTER, Control::CENTER);
$label->setSize($width - 5, $height); $label->setSize($width - 5, $height);
$label->setTextSize(1.3); $label->setTextSize(1.3);
$label->setText('$sVote for ' . $this->currentVote["Name"]); $label->setText('$s ' . $this->currentVote->voteCommand->name);
//Started by nick //Started by nick
$label = new Label_Text(); $label = new Label_Text();
@ -543,10 +531,9 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
$label->setSize($width - 5, 2); $label->setSize($width - 5, 2);
$label->setTextSize(1); $label->setTextSize(1);
$label->setTextColor("F80"); $label->setTextColor("F80");
$label->setText('$sStarted by ' . $this->voter->nickname); $label->setText('$sStarted by ' . $this->currentVote->voter->nickname);
//Time Gauge
//Time Gaunge
$timeGauge = new Gauge(); $timeGauge = new Gauge();
$frame->add($timeGauge); $frame->add($timeGauge);
$timeGauge->setY(1.5); $timeGauge->setY(1.5);
@ -584,7 +571,7 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
$voteLabel->setSize($width * 0.65, 12); $voteLabel->setSize($width * 0.65, 12);
$voteLabel->setStyle($labelStyle); $voteLabel->setStyle($labelStyle);
$voteLabel->setTextSize(1); $voteLabel->setTextSize(1);
$voteLabel->setText(' ' . round($votePercentage * 100.) . '% (' . count($this->playersVoted) . ')'); $voteLabel->setText(' ' . round($votePercentage * 100.) . '% (' . $this->currentVote->getVoteCount() . ')');
$quad = new Quad_BgsPlayerCard(); $quad = new Quad_BgsPlayerCard();
@ -775,3 +762,75 @@ class CustomVotesPlugin implements CommandListener, CallbackListener, ManialinkP
return 'Plugin offers your Custom Votes like Restart, Skip, Balance...'; return 'Plugin offers your Custom Votes like Restart, Skip, Balance...';
} }
} }
/**
* Vote Command Structure
*/
class VoteCommand {
public $index;
public $name;
public $neededRatio;
public $idBased;
public function __construct($index, $name, $idBased, $neededRatio) {
$this->index = $index;
$this->name = $name;
$this->idBased = $idBased;
$this->neededRatio = $neededRatio;
}
}
/**
* Current Vote Structure
*/
class CurrentVote {
const VOTE_FOR_ACTION = '1';
const VOTE_AGAINST_ACTION = '-1';
public $voteCommand = null;
public $expireTime = 0;
public $positiveVotes = 0;
public $neededRatio = 0;
public $neededPlayerRatio = 0;
public $voter = null;
public $map = null;
public $player = null;
public $function = null;
private $playersVoted = array();
public function __construct(VoteCommand $voteCommand, Player $voter, $expireTime) {
$this->expireTime = $expireTime;
$this->voteCommand = $voteCommand;
$this->voter = $voter;
$this->votePositive($voter->login);
}
public function votePositive($login) {
if (isset($this->playersVoted[$login])) {
if ($this->playersVoted[$login] == self::VOTE_AGAINST_ACTION) {
$this->playersVoted[$login] = self::VOTE_FOR_ACTION;
$this->positiveVotes++;
}
} else {
$this->playersVoted[$login] = self::VOTE_FOR_ACTION;
$this->positiveVotes++;
}
}
public function voteNegative($login) {
if (isset($this->playersVoted[$login])) {
if ($this->playersVoted[$login] == self::VOTE_FOR_ACTION) {
$this->playersVoted[$login] = self::VOTE_AGAINST_ACTION;
$this->positiveVotes--;
}
} else {
$this->playersVoted[$login] = self::VOTE_AGAINST_ACTION;
}
}
public function getVoteCount() {
return count($this->playersVoted);
}
}