Package org.rusherhack.client.api.feature.module

Class Module

java.lang.Object

org.rusherhack.client.api.feature.module.Module

All Implemented Interfaces:

IModule, Globals, org.rusherhack.core.event.listener.EventListener, org.rusherhack.core.feature.IFeature, org.rusherhack.core.feature.IFeatureConfigurable, org.rusherhack.core.interfaces.IHideable, org.rusherhack.core.interfaces.INamed, org.rusherhack.core.logging.ILoggable, org.rusherhack.core.notification.INotifiable, org.rusherhack.core.serialize.ISerializable<com.google.gson.JsonElement>, org.rusherhack.core.serialize.JsonSerializable

Direct Known Subclasses:

ToggleableModule

public abstract class Module
extends Object
implements IModule, org.rusherhack.core.event.listener.EventListener, org.rusherhack.core.logging.ILoggable, Globals

A base module with no implementation

Field Summary

Fields

Modifier and Type	Field	Description
protected final org.rusherhack.core.logging.ILogger	logger	Logger for this module

Fields inherited from interface org.rusherhack.client.api.Globals

mc

Constructor Summary

Constructors

Constructor	Description
Module(String name, String description, ModuleCategory category)
Module(String name, ModuleCategory category)

Method Summary

Modifier and Type	Method	Description
boolean	areNotificationsEnabled()
ModuleCommand	createCommand()
boolean	deserialize(com.google.gson.JsonElement jsonElement)
ModuleCategory	getCategory()
String	getDescription()
org.rusherhack.core.logging.ILogger	getLogger()
String	getName()
List<org.rusherhack.core.setting.Setting<?>>	getSettings()
boolean	isHidden()
boolean	isListening()
void	registerSettings(org.rusherhack.core.setting.Setting<?>... settings)
void	sendNotification(org.rusherhack.core.notification.NotificationType type, String message)
void	sendNotification(org.rusherhack.core.notification.NotificationType type, String message, int id)
com.google.gson.JsonElement	serialize()
void	setHidden(boolean hidden)
void	setListening(boolean state)
void	setNotifications(boolean notifications)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.rusherhack.core.feature.IFeatureConfigurable

getSetting, reset

Methods inherited from interface org.rusherhack.client.api.feature.module.IModule

getMetadata

Methods inherited from interface org.rusherhack.core.interfaces.INamed

getAliases, getDisplayName

Methods inherited from interface org.rusherhack.core.serialize.ISerializable

shouldAutoSave, shouldSerialize

Field Details

logger

protected final org.rusherhack.core.logging.ILogger logger

Logger for this module

Constructor Details

Module

public Module(String name,
 ModuleCategory category)

Module

public Module(String name,
 String description,
 ModuleCategory category)

Method Details

getName

public String getName()

Specified by:

getName in interface org.rusherhack.core.interfaces.INamed

getDescription

public String getDescription()

Specified by:

getDescription in interface org.rusherhack.core.feature.IFeature

getCategory

public ModuleCategory getCategory()

Specified by:

getCategory in interface IModule

Returns:

Category of this module

sendNotification

public void sendNotification(org.rusherhack.core.notification.NotificationType type,
 String message)

Specified by:

sendNotification in interface org.rusherhack.core.notification.INotifiable

sendNotification

public void sendNotification(org.rusherhack.core.notification.NotificationType type,
 String message,
 int id)

Specified by:

sendNotification in interface org.rusherhack.core.notification.INotifiable

registerSettings

public void registerSettings(org.rusherhack.core.setting.Setting<?>... settings)

Specified by:

registerSettings in interface org.rusherhack.core.feature.IFeatureConfigurable

getSettings

public List<org.rusherhack.core.setting.Setting<?>> getSettings()

Specified by:

getSettings in interface org.rusherhack.core.feature.IFeatureConfigurable

isHidden

public boolean isHidden()

Specified by:

isHidden in interface org.rusherhack.core.interfaces.IHideable

setHidden

public void setHidden(boolean hidden)

areNotificationsEnabled

public boolean areNotificationsEnabled()

setNotifications

public void setNotifications(boolean notifications)

serialize

public com.google.gson.JsonElement serialize()

Specified by:

serialize in interface org.rusherhack.core.serialize.ISerializable<com.google.gson.JsonElement>

deserialize

public boolean deserialize(com.google.gson.JsonElement jsonElement)

Specified by:

deserialize in interface org.rusherhack.core.serialize.ISerializable<com.google.gson.JsonElement>

isListening

public boolean isListening()

Specified by:

isListening in interface org.rusherhack.core.event.listener.EventListener

setListening

public void setListening(boolean state)

getLogger

public org.rusherhack.core.logging.ILogger getLogger()

Specified by:

getLogger in interface org.rusherhack.core.logging.ILoggable

createCommand

public ModuleCommand createCommand()