Class RelayController

Authors: - Tyrence

Namespace: Budabot\User\Modules
Definecommand(:

command = 'grc', accessLevel = 'all', description = 'Relays incoming messages to guildchat' )

Instance: Commands this controller contains:
Located at RELAY_MODULE/RelayController.class.php

Methods summary
`public`	# `setup( )` Setup
`public`	# `grcCommand( $message, $channel, $sender, $sendto, $args )` Handlescommand("grc")
`public`	# `receiveRelayMessageExtPrivEvent( $eventObj )` Description("receive relay messages from other bots in the relay bot private channel") Event("extpriv")
`public`	# `receiveRelayMessagePrivEvent( $eventObj )` Description("receive relay messages from other bots in this bot's own private channel") Event("priv")
`public`	# `processIncomingRelayMessage( $sender, $message )`
`public`	# `orgChatToRelayEvent( $eventObj )` Description("sends org chat to relay") Event("guild")
`public`	# `privChatToRelayEvent( $eventObj )` Description("sends private channel chat to relay") Event("priv")
`public`	# `processOutgoingRelayMessage( $sender, $message, $type )`
`public`	# `acceptPrivJoinEvent( $eventObj )` Description("accept private channel join invitation from the relay bot") Event("extjoinprivrequest")
`public`	# `relayOrgMessagesEvent( $eventObj )` Description("relay Org Messages") Event("orgmsg")
`public`	# `relayLogonMessagesEvent( $eventObj )` Description("sends Logon messages over the relay") Event("logon")
`public`	# `relayLogoffMessagesEvent( $eventObj )` Description("sends Logoff messages over the relay") Event("logoff")
`public`	# `relayJoinPrivMessagesEvent( $eventObj )` Description("sends a message to the relay when someone joins the private channel") Event("joinpriv")
`public`	# `relayLeavePrivMessagesEvent( $eventObj )` Description("sends a message to the relay when someone leaves the private channel") Event("leavepriv")
`public`	# `sendMessageToRelay( $message )`
`public`	# `getGuildAbbreviation( )`

Properties summary
`public`	`$moduleName` Name of the module. Set automatically by module loader. Name of the module. Set automatically by module loader.	#
`public`	`$db` Inject	#
`public`	`$chatBot` Inject	#
`public`	`$settingManager` Inject	#
`public`	`$text` Inject	#
`public`	`$util` Inject	#
`public`	`$altsController` Inject	#
`public`	`$preferences` Inject	#
`public`	`$playerManager` Inject	#
`public`	`$commandAlias` Inject	#
`public`	`$logger` Logger	#

Namespaces

Classes

Class RelayController

Setup

Handlescommand("grc")

Description("receive

Event("extpriv")

Description("receive

Event("priv")

Description("sends

Event("guild")

Description("sends

Event("priv")

Description("accept

Event("extjoinprivrequest")

Description("relay

Event("orgmsg")

Description("sends

Event("logon")

Description("sends

Event("logoff")

Description("sends

Event("joinpriv")

Description("sends

Event("leavepriv")

Inject

Inject

Inject

Inject

Inject

Inject

Inject

Inject

Inject

Logger