Overview

Namespaces

  • Budabot
    • Core
      • Modules
    • User
      • Modules
  • None
  • Tyrence
    • Modules

Classes

  • AccessLevel
  • Budabot\Core\AccessManager
  • Budabot\Core\AdminManager
  • Budabot\Core\AOChat
  • Budabot\Core\AOChatPacket
  • Budabot\Core\AOChatQueue
  • Budabot\Core\AOExtMsg
  • Budabot\Core\AsyncHttp
  • Budabot\Core\AutoInject
  • Budabot\Core\BotRunner
  • Budabot\Core\Budabot
  • Budabot\Core\BuddylistManager
  • Budabot\Core\CacheManager
  • Budabot\Core\CacheResult
  • Budabot\Core\ClassLoader
  • Budabot\Core\ColorSettingHandler
  • Budabot\Core\CommandAlias
  • Budabot\Core\CommandManager
  • Budabot\Core\ConfigFile
  • Budabot\Core\DB
  • Budabot\Core\DBRow
  • Budabot\Core\EventLoop
  • Budabot\Core\EventManager
  • Budabot\Core\GuildChannelCommandReply
  • Budabot\Core\GuildManager
  • Budabot\Core\HelpManager
  • Budabot\Core\Http
  • Budabot\Core\HttpRequest
  • Budabot\Core\LegacyLogger
  • Budabot\Core\LimitsController
  • Budabot\Core\LoggerWrapper
  • Budabot\Core\MMDBParser
  • Budabot\Core\Modules\AdminController
  • Budabot\Core\Modules\AliasController
  • Budabot\Core\Modules\AltInfo
  • Budabot\Core\Modules\AltsController
  • Budabot\Core\Modules\BanController
  • Budabot\Core\Modules\BuddylistController
  • Budabot\Core\Modules\ColorsController
  • Budabot\Core\Modules\CommandlistController
  • Budabot\Core\Modules\CommandSearchController
  • Budabot\Core\Modules\ConfigController
  • Budabot\Core\Modules\EventlistController
  • Budabot\Core\Modules\HelpController
  • Budabot\Core\Modules\LogsController
  • Budabot\Core\Modules\PlayerLookupController
  • Budabot\Core\Modules\ProfileCommandReply
  • Budabot\Core\Modules\ProfileController
  • Budabot\Core\Modules\SettingsController
  • Budabot\Core\Modules\SQLController
  • Budabot\Core\Modules\SystemController
  • Budabot\Core\Modules\UsageController
  • Budabot\Core\Modules\WhitelistController
  • Budabot\Core\NumberSettingHandler
  • Budabot\Core\OptionsSettingHandler
  • Budabot\Core\PlayerHistory
  • Budabot\Core\PlayerHistoryManager
  • Budabot\Core\PlayerManager
  • Budabot\Core\Preferences
  • Budabot\Core\PrivateChannelCommandReply
  • Budabot\Core\PrivateMessageCommandReply
  • Budabot\Core\Registry
  • Budabot\Core\SettingHandler
  • Budabot\Core\SettingManager
  • Budabot\Core\SettingObject
  • Budabot\Core\SocketManager
  • Budabot\Core\SocketNotifier
  • Budabot\Core\SubcommandManager
  • Budabot\Core\Text
  • Budabot\Core\TextSettingHandler
  • Budabot\Core\Timer
  • Budabot\Core\TimerEvent
  • Budabot\Core\TimeSettingHandler
  • Budabot\Core\Util
  • Budabot\Core\xml
  • Budabot\User\Modules\AlienArmorController
  • Budabot\User\Modules\AlienBioController
  • Budabot\User\Modules\AlienMiscController
  • Budabot\User\Modules\AOSpeakController
  • Budabot\User\Modules\AOUController
  • Budabot\User\Modules\AXPController
  • Budabot\User\Modules\BankController
  • Budabot\User\Modules\BosslootController
  • Budabot\User\Modules\BroadcastController
  • Budabot\User\Modules\BuffPerksController
  • Budabot\User\Modules\CacheController
  • Budabot\User\Modules\ChatAssistController
  • Budabot\User\Modules\ChatCheckController
  • Budabot\User\Modules\ChatLeaderController
  • Budabot\User\Modules\ChatRallyController
  • Budabot\User\Modules\ChatSayController
  • Budabot\User\Modules\ChatTopicController
  • Budabot\User\Modules\CityWaveController
  • Budabot\User\Modules\CloakController
  • Budabot\User\Modules\ClusterController
  • Budabot\User\Modules\CountdownController
  • Budabot\User\Modules\DevController
  • Budabot\User\Modules\DingController
  • Budabot\User\Modules\EventsController
  • Budabot\User\Modules\FightController
  • Budabot\User\Modules\FindOrgController
  • Budabot\User\Modules\FindPlayerController
  • Budabot\User\Modules\FunController
  • Budabot\User\Modules\GitController
  • Budabot\User\Modules\GuideController
  • Budabot\User\Modules\GuildController
  • Budabot\User\Modules\HelpbotController
  • Budabot\User\Modules\HtmlDecodeController
  • Budabot\User\Modules\ImplantController
  • Budabot\User\Modules\ImplantDesignerController
  • Budabot\User\Modules\InactiveMemberController
  • Budabot\User\Modules\ItemsController
  • Budabot\User\Modules\KillOnSightController
  • Budabot\User\Modules\LevelController
  • Budabot\User\Modules\LinksController
  • Budabot\User\Modules\LootListsController
  • Budabot\User\Modules\MdbController
  • Budabot\User\Modules\MessageInfoCommandReply
  • Budabot\User\Modules\MockCommandReply
  • Budabot\User\Modules\NanoController
  • Budabot\User\Modules\NewsController
  • Budabot\User\Modules\NotesController
  • Budabot\User\Modules\OnlineController
  • Budabot\User\Modules\OrgHistoryController
  • Budabot\User\Modules\OrglistController
  • Budabot\User\Modules\OrgMembersController
  • Budabot\User\Modules\OSController
  • Budabot\User\Modules\PlayerHistoryController
  • Budabot\User\Modules\PlayfieldController
  • Budabot\User\Modules\PocketbossController
  • Budabot\User\Modules\PremadeImplantController
  • Budabot\User\Modules\PrivateChannelController
  • Budabot\User\Modules\QuoteController
  • Budabot\User\Modules\RaffleController
  • Budabot\User\Modules\RaidController
  • Budabot\User\Modules\RandomController
  • Budabot\User\Modules\RecipeController
  • Budabot\User\Modules\RelayController
  • Budabot\User\Modules\ReputationController
  • Budabot\User\Modules\ResearchController
  • Budabot\User\Modules\RunAsController
  • Budabot\User\Modules\SendTellController
  • Budabot\User\Modules\ShoppingController
  • Budabot\User\Modules\SilenceController
  • Budabot\User\Modules\SkillsController
  • Budabot\User\Modules\SpiritsController
  • Budabot\User\Modules\StopwatchController
  • Budabot\User\Modules\Teamspeak3
  • Budabot\User\Modules\TeamspeakController
  • Budabot\User\Modules\TestController
  • Budabot\User\Modules\TimeController
  • Budabot\User\Modules\TimerController
  • Budabot\User\Modules\TimezoneController
  • Budabot\User\Modules\TowerController
  • Budabot\User\Modules\TrackerController
  • Budabot\User\Modules\TrickleController
  • Budabot\User\Modules\UnixtimeController
  • Budabot\User\Modules\VoteController
  • Budabot\User\Modules\WeatherController
  • Budabot\User\Modules\WhatBuffsController
  • Budabot\User\Modules\WhereisController
  • Budabot\User\Modules\WhoisController
  • Budabot\User\Modules\WhoisOrgController
  • Budabot\User\Modules\WhompahController
  • Command
  • DefaultStatus
  • DefineCommand
  • Description
  • Event
  • HandlesCommand
  • Help
  • Inject
  • Instance
  • Intoptions
  • Matches
  • Options
  • Setting
  • Setup
  • Type
  • Tyrence\Modules\DemoResponseCommandReply
  • Tyrence\Modules\SameChannelResponseController
  • Visibility

Interfaces

  • Budabot\Core\CommandReply

Exceptions

  • Budabot\Core\InvalidHttpRequest
  • Budabot\Core\SQLException
  • Budabot\Core\StopExecutionException

Functions

  • Budabot\Core\isWindows
  • Budabot\Core\Modules\read_input
  • Overview
  • Namespace
  • Class
  1: <?php
  2: 
  3: namespace Budabot\User\Modules;
  4: 
  5: /**
  6:  * @Instance
  7:  *
  8:  * Commands this controller contains:
  9:  *  @DefineCommand(
 10:  *      command     = 'leader', 
 11:  *      accessLevel = 'all', 
 12:  *      description = 'Sets the Leader of the raid', 
 13:  *      help        = 'leader.txt'
 14:  *  )
 15:  *  @DefineCommand(
 16:  *      command     = 'leader (.+)', 
 17:  *      accessLevel = 'rl', 
 18:  *      description = 'Sets a specific Leader', 
 19:  *      help        = 'leader.txt'
 20:  *  )
 21:  *  @DefineCommand(
 22:  *      command     = 'leaderecho', 
 23:  *      accessLevel = 'rl', 
 24:  *      description = 'Set if the text of the leader will be repeated', 
 25:  *      help        = 'leader.txt'
 26:  *  )
 27:  */
 28: 
 29: class ChatLeaderController {
 30:     
 31:     /** @Inject */
 32:     public $chatBot;
 33:     
 34:     /** @Inject */
 35:     public $settingManager;
 36: 
 37:     /** @Inject */
 38:     public $accessManager;
 39: 
 40:     /**
 41:      * @Setting("leaderecho")
 42:      * @Description("Repeat the text of the leader")
 43:      * @Visibility("edit")
 44:      * @Type("options")
 45:      * @Options("true;false")
 46:      * @Intoptions("1;0")
 47:      */
 48:     public $defaultLeaderecho = '1';
 49: 
 50:     /**
 51:      * @Setting("leaderecho_color")
 52:      * @Description("Color for leader echo")
 53:      * @Visibility("edit")
 54:      * @Type("color")
 55:      */
 56:     public $defaultLeaderechoColor = '<font color=#FFFF00>';
 57: 
 58:     /**
 59:      * Name of the leader character.
 60:      */
 61:     private $leader;
 62: 
 63:     /**
 64:      * This command handler sets the leader of the raid.
 65:      * @HandlesCommand("leader")
 66:      * @Matches("/^leader$/i")
 67:      */
 68:     public function leaderCommand($message, $channel, $sender, $sendto, $args) {
 69:         if ($this->leader == $sender) {
 70:             unset($this->leader);
 71:             $this->chatBot->sendPrivate("Raid Leader cleared.");
 72:         } else {
 73:             $msg = $this->setLeader($sender, $sender);
 74:             if (!empty($msg)) {
 75:                 $sendto->reply($msg);
 76:             }
 77:         }
 78:     }
 79: 
 80:     /**
 81:      * This command handler sets a specific leader.
 82:      * @HandlesCommand("leader (.+)")
 83:      * @Matches("/^leader (.+)$/i")
 84:      */
 85:     public function leaderSetCommand($message, $channel, $sender, $sendto, $args) {
 86:         $msg = $this->setLeader($args[1], $sender);
 87:         if (!empty($msg)) {
 88:             $sendto->reply($msg);
 89:         }
 90:     }
 91:     
 92:     public function setLeader($name, $sender) {
 93:         $name = ucfirst(strtolower($name));
 94:         $uid = $this->chatBot->get_uid($name);
 95:         if (!$uid) {
 96:             $msg = "Character <highlight>{$name}<end> does not exist.";
 97:         } else if (!isset($this->chatBot->chatlist[$name])) {
 98:             $msg = "Character <highlight>{$name}<end> is not in the private channel.";
 99:         } else {
100:             if (!isset($this->leader) || $sender == $this->leader || $this->accessManager->compareCharacterAccessLevels($sender, $this->leader) > 0) {
101:                 $this->leader = $name;
102:                 $this->chatBot->sendPrivate($this->getLeaderStatusText());
103:             } else {
104:                 $msg = "You cannot take Raid Leader from <highlight>{$this->leader}<end>.";
105:             }
106:         }
107:         return $msg;
108:     }
109: 
110:     /**
111:      * This command handler enables leader echoing in private channel.
112:      * @HandlesCommand("leaderecho")
113:      * @Matches("/^leaderecho on$/i")
114:      */
115:     public function leaderechoOnCommand($message, $channel, $sender, $sendto, $args) {
116:         if ($this->checkLeaderAccess($sender)) {
117:             $this->settingManager->save("leaderecho", "1");
118:             $this->chatBot->sendPrivate("Leader echo has been " . $this->getEchoStatusText());
119:         } else {
120:             $sendto->reply("You must be Raid Leader to use this command.");
121:         }
122:     }
123: 
124:     /**
125:      * This command handler disables leader echoing in private channel.
126:      * @HandlesCommand("leaderecho")
127:      * @Matches("/^leaderecho off$/i")
128:      */
129:     public function leaderechoOffCommand($message, $channel, $sender, $sendto, $args) {
130:         if ($this->checkLeaderAccess($sender)) {
131:             $this->settingManager->save("leaderecho", "0");
132:             $this->chatBot->sendPrivate("Leader echo has been " . $this->getEchoStatusText());
133:         } else {
134:             $sendto->reply("You must be Raid Leader to use this command.");
135:         }
136:     }
137: 
138:     /**
139:      * This command handler shows current echoing state.
140:      * @HandlesCommand("leaderecho")
141:      * @Matches("/^leaderecho$/i")
142:      */
143:     public function leaderechoCommand($message, $channel, $sender, $sendto, $args) {
144:         if ($this->checkLeaderAccess($sender)) {
145:             $this->chatBot->sendPrivate("Leader echo is currently " . $this->getEchoStatusText());
146:         } else {
147:             $sendto->reply("You must be Raid Leader to use this command.");
148:         }
149:     }
150: 
151:     /**
152:      * @Event("priv")
153:      * @Description("Repeats what the leader says in the color of leaderecho_color setting")
154:      */
155:     public function privEvent($eventObj) {
156:         if ($this->settingManager->get("leaderecho") == 1 && $this->leader == $eventObj->sender && $eventObj->message[0] != $this->settingManager->get("symbol")) {
157:             $msg = $this->settingManager->get("leaderecho_color") . $eventObj->message . "<end>";
158:             $this->chatBot->sendPrivate($msg);
159:         }
160:     }
161: 
162:     /**
163:      * @Event("leavePriv")
164:      * @Description("Removes leader when the leader leaves the channel")
165:      */
166:     public function leavePrivEvent($eventObj) {
167:         if ($this->leader == $eventObj->sender) {
168:             unset($this->leader);
169:             $msg = "Raid Leader cleared.";
170:             $this->chatBot->sendPrivate($msg);
171:         }
172:     }
173: 
174:     /**
175:      * Returns echo's status message based on 'leaderecho' setting.
176:      */
177:     private function getEchoStatusText() {
178:         if ($this->settingManager->get("leaderecho") == 1) {
179:             $status = "<green>Enabled<end>";
180:         } else {
181:             $status = "<red>Disabled<end>";
182:         }
183:         return $status;
184:     }
185: 
186:     /**
187:      * Returns current leader and echo's current status.
188:      */
189:     private function getLeaderStatusText() {
190:         $cmd = $this->settingManager->get("leaderecho") == 1? "off": "on";
191:         $status = $this->getEchoStatusText();
192:         $msg = "{$this->leader} is now Raid Leader. Leader echo is currently {$status}. You can change it with <symbol>leaderecho {$cmd}";
193:         return $msg;
194:     }
195:     
196:     public function getLeader() {
197:         return $this->leader;
198:     }
199: 
200:     public function checkLeaderAccess($sender) {
201:         if (empty($this->leader)) {
202:             return true;
203:         } else if ($this->leader == $sender) {
204:             return true;
205:         } else if ($this->accessManager->checkAccess($sender, "moderator")) {
206:             return true;
207:         } else {
208:             return false;
209:         }
210:     }
211: }
212: 
Budabot 4 Docs API documentation generated by ApiGen