Class Index | File Index

Classes

Class ScriptBotCoreAdapter

This is an adapter object to work around Rhino not letting programmers have optional arguments on functions. Rhino requires that all arguments be sent. This object, being all JS, and not a interface-object is not subject to those requirements. This class does not implement all features of the class it is adapting.
Defined in: </ScriptBot/trunk/src/app/scriptbot.js>.

Class Summary
Constructor Attributes	Constructor Name and Description
	ScriptBotCoreAdapter(robot) Creates a default BotAdatper.

Field Summary
Field Attributes	Field Name and Description
	prefix

Method Summary
Method Attributes	Method Name and Description
	getBot() Returns the real ScriptBotCore instance.
	initialize(nick, ircServer, ircChannel)
	registerPlugin(event, handler, id)
	registerPluginInfo(plugin, handler, id)
	registerUnhandledEventPlugin(event, handler)
	registerUnrestrictedPlugin(event, handler, id)
	setPassword(value)
	setScriptLoggingEnabled(value)
	setVerbose(value)
	unregisterPlugin(plugin, info)
	unregisterPluginByEvent(event, id, unrestricted)
	unregisterPluginInfo(plugin, id)
	unregisterUnhandledEventPlugin(event)

Class Detail

ScriptBotCoreAdapter(robot)

Creates a default BotAdatper.
Author: AMcBain, 2008.

Parameters:
{ScriptBotCore} robot: The ScriptBotCore being passed.

Field Detail

prefix

See:: ScriptBotCore#prefix

Method Detail

{ScriptBotCore} getBot()

Returns the real ScriptBotCore instance.

Returns:: The real ScriptBotCore instance.

initialize(nick, ircServer, ircChannel)

Parameters:
nick
ircServer
ircChannel

See:: ScriptBotCore#initialize

registerPlugin(event, handler, id)

Parameters:
event
handler
id

See:: ScriptBotCore#registerPlugin

registerPluginInfo(plugin, handler, id)

Parameters:
plugin
handler
id

See:: ScriptBotCore#registerPluginInfo

registerUnhandledEventPlugin(event, handler)

Parameters:
event
handler

See:: ScriptBotCore#registerUnhandledEventPlugin

registerUnrestrictedPlugin(event, handler, id)

Parameters:
event
handler
id

See:: ScriptBotCore#registerUnrestrictedPlugin

setPassword(value)

Parameters:
value

See:: ScriptBotCore#setPassword

setScriptLoggingEnabled(value)

Parameters:
value

See:: ScriptBotCore#setScriptLoggingEnabled

setVerbose(value)

Parameters:
value

See:: ScriptBotCore#setVerbose

unregisterPlugin(plugin, info)

Parameters:
plugin
info

See:: ScriptBotCore#unregisterPlugin

unregisterPluginByEvent(event, id, unrestricted)

Parameters:
event
id
unrestricted

See:: ScriptBotCore#registerPlugin

unregisterPluginInfo(plugin, id)

Parameters:
plugin
id

See:: ScriptBotCore#unregisterPluginInfo

unregisterUnhandledEventPlugin(event)

Parameters:
event

See:: ScriptBotCore#unregisterUnhandledEventPlugin

Documentation generated by JsDoc Toolkit 2.1.1 on Thu May 06 2010 18:41:46 GMT-0700 (PDT)