com.levelonelabs.aimbot.modules
Class HeyuModule

java.lang.Object
  com.levelonelabs.aimbot.BotModule
      com.levelonelabs.aimbot.modules.HeyuModule

public class HeyuModule

extends BotModule

Handles requests to control X10 devices using Heyu and CM11A. Heyu runs on Linux/Unix and is written by Daniel B. Suthers. Heyu is available for free at http://heyu.tanj.com. Daniel requests that NO mirrors of his Heyu source code be created. HeyuModule officially supports Heyu version 1.35. HeyuModule REQUIRES a WORKING INSTALLATION of Heyu on the same physical machine (i.e. you must be running the jaimbot on Linux/Unix with a CM11A attached and Heyu installed, running and working). Please see the Heyu FAQ at http://heyu.tanj.com for details about X10 and the CM11A. The CM11A is available from http://www.x10.com and other sources for under $50. Bundled deals that include X10 modules for the CM11A to control can often be purchased at that price (a substantial discount). Please note: The author is NOT trying to generate sales for X10, just simply stating how you can get started using this module. CM11A and X10 may be Registered Trademarks of X10 Corp. (http://www.x10.com) The author of this software is not affiliated with X10 Corp.

Author:

David Nelson (david@david-nelson.com)

Field Summary

Fields inherited from class com.levelonelabs.aimbot.BotModule

bot

Constructor Summary

HeyuModule(AIMBot bot)

Method Summary

java.lang.String	getModules()
java.lang.String	getName() Gets the canonical name of the BotModule
java.util.ArrayList	getServices() Must implement this to return a list of Strings that represent the keywords the module wants to be called for
java.lang.String	help() A String to be presented to a client that descibes the services (keywords) this module provides.
void	performService(AIMBuddy buddy, java.lang.String query) This will be called when the AIMBot gets a string starting with a keyword that this module advertised as a service.

Methods inherited from class com.levelonelabs.aimbot.BotModule

addAIMListener, addBuddies, addBuddy, denyBuddy, getBuddy, getBuddyNames, getPermitMode, permitBuddy, removeBuddies, removeBuddy, sendMessage, sendWarning, setAvailable, setPermitMode, setUnavailable

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

HeyuModule

public HeyuModule(AIMBot bot)

Method Detail

getServices

public java.util.ArrayList getServices()

Description copied from class: BotModule

Must implement this to return a list of Strings that represent the keywords the module wants to be called for

Specified by:

getServices in class BotModule

Returns:

all list of strings that are the keywords the module wants to hear about

help

public java.lang.String help()

Description copied from class: BotModule

A String to be presented to a client that descibes the services (keywords) this module provides. NOTE: a URL to documentation is acceptable.

Specified by:

help in class BotModule

Returns:

the help text

getModules

public java.lang.String getModules()

performService

public void performService(AIMBuddy buddy,
                           java.lang.String query)

Description copied from class: BotModule

This will be called when the AIMBot gets a string starting with a keyword that this module advertised as a service.

Specified by:

performService in class BotModule

Parameters:

buddy -

query -

getName

public java.lang.String getName()

Description copied from class: BotModule

Gets the canonical name of the BotModule

Specified by:

getName in class BotModule

Returns:

The name of the module