Class ChatLeaderController

Namespace: Budabot\User\Modules
Definecommand(:

command = 'leader', accessLevel = 'all', description = 'Sets the Leader of the raid', help = 'leader.txt' )

Definecommand(:

command = 'leader (.+)', accessLevel = 'rl', description = 'Sets a specific Leader', help = 'leader.txt' )

Definecommand(:

command = 'leaderecho', accessLevel = 'rl', description = 'Set if the text of the leader will be repeated', help = 'leader.txt' )

Instance: Commands this controller contains:
Located at BASIC_CHAT_MODULE/ChatLeaderController.class.php

Methods summary
`public`	# `leaderCommand( $message, $channel, $sender, $sendto, $args )` This command handler sets the leader of the raid. This command handler sets the leader of the raid. Handlescommand("leader") Matches("/^leader$/i")
`public`	# `leaderSetCommand( $message, $channel, $sender, $sendto, $args )` This command handler sets a specific leader. This command handler sets a specific leader. Handlescommand("leader (.+)") Matches("/^leader (.+)$/i")
`public`	# `setLeader( $name, $sender )`
`public`	# `leaderechoOnCommand( $message, $channel, $sender, $sendto, $args )` This command handler enables leader echoing in private channel. This command handler enables leader echoing in private channel. Handlescommand("leaderecho") Matches("/^leaderecho on$/i")
`public`	# `leaderechoOffCommand( $message, $channel, $sender, $sendto, $args )` This command handler disables leader echoing in private channel. This command handler disables leader echoing in private channel. Handlescommand("leaderecho") Matches("/^leaderecho off$/i")
`public`	# `leaderechoCommand( $message, $channel, $sender, $sendto, $args )` This command handler shows current echoing state. This command handler shows current echoing state. Handlescommand("leaderecho") Matches("/^leaderecho$/i")
`public`	# `privEvent( $eventObj )` Description("repeats what the leader says in the color of leaderecho_color setting") Event("priv")
`public`	# `leavePrivEvent( $eventObj )` Description("removes leader when the leader leaves the channel") Event("leavepriv")
`private`	# `getEchoStatusText( )` Returns echo's status message based on 'leaderecho' setting. Returns echo's status message based on 'leaderecho' setting.
`private`	# `getLeaderStatusText( )` Returns current leader and echo's current status. Returns current leader and echo's current status.
`public`	# `getLeader( )`
`public`	# `checkLeaderAccess( $sender )`

Properties summary
`public`	`$chatBot` Inject	#
`public`	`$settingManager` Inject	#
`public`	`$accessManager` Inject	#
`public string`	`$defaultLeaderecho` Description("repeat the text of the leader") Intoptions("1;0") Options("true;false") Setting("leaderecho") Type("options") Visibility("edit")	# `'1'`
`public string`	`$defaultLeaderechoColor` Description("color for leader echo") Setting("leaderecho_color") Type("color") Visibility("edit")	# `'<font color=#FFFF00>'`
`private`	`$leader` Name of the leader character. Name of the leader character.	#

Namespaces

Classes

Class ChatLeaderController

Handlescommand("leader")

Matches("/^leader$/i")

Handlescommand("leader

Matches("/^leader

Handlescommand("leaderecho")

Matches("/^leaderecho

Handlescommand("leaderecho")

Matches("/^leaderecho

Handlescommand("leaderecho")

Matches("/^leaderecho$/i")

Description("repeats

Event("priv")

Description("removes

Event("leavepriv")

Inject

Inject

Inject

Description("repeat

Intoptions("1;0")

Options("true;false")

Setting("leaderecho")

Type("options")

Visibility("edit")

Description("color

Setting("leaderecho_color")

Type("color")

Visibility("edit")