public abstract class BaseExtModule extends java.lang.Object implements IExternalModule
IExternalModule
.
External modules may choose to extend this class (this class implements the IExternalModule
interface).
Stores the parameters received by the init(IExtModManifestBean, IServices, IModEnv)
in attributes for later use.
Also stores some references that may/should be used frequently (like the application logger).
IExternalModule
Modifier and Type | Field and Description |
---|---|
IFactory |
factory
General factory to create / acquire instances of API interfaces.
|
IGuiFactory |
guiFactory
GUI factory to create / acquire instances of GUI API interfaces.
|
IGuiUtils |
guiUtils
(Swing) GUI utilities.
|
static java.lang.String |
IMPL_VERSION
Implementation version.
|
ILanguage |
language
Application logger to be used to log messages.
|
ILogger |
logger
Application logger to be used to log messages.
|
IExtModManifestBean |
manifest
External module manifest loaded from the
"Scelight-mod-x-manifest.xml" file from the version folder of the external module root folder. |
IModEnv |
modEnv
External module environment.
|
IRepParserEngine |
repParserEngine
Replay parser engine.
|
IServices |
services
Services provided for the module.
|
ISettingsGui |
settingsGui
Settings GUI utilities.
|
ISettingsUtils |
settingsUtils
Setting utilities.
|
IUtils |
utils
General utilities.
|
Constructor and Description |
---|
BaseExtModule() |
Modifier and Type | Method and Description |
---|---|
void |
init(IExtModManifestBean manifest,
IServices services,
IModEnv modEnv)
Stores the received parameters for later use.
Also stores some references that may/should be used frequently (like the application logger and the general factory). |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
destroy
public static final java.lang.String IMPL_VERSION
public IExtModManifestBean manifest
"Scelight-mod-x-manifest.xml"
file from the version folder of the external module root folder.public IServices services
public IModEnv modEnv
public ILogger logger
public ILanguage language
public IUtils utils
public IGuiUtils guiUtils
public ISettingsUtils settingsUtils
public ISettingsGui settingsGui
public IFactory factory
public IGuiFactory guiFactory
public IRepParserEngine repParserEngine
public void init(IExtModManifestBean manifest, IServices services, IModEnv modEnv)
If a module extends this class and overrides this method, in that overrider method super implementation (this version) should be called (start the
overrider method with super.init( manifest, services, modEnv )
).
init
in interface IExternalModule
manifest
- external module manifest loaded from the "Scelight-mod-x-manifest.xml"
file from the version folder of the external module
root folder; should be stored by the module if the module intends to use it laterservices
- module-independent services provided for the module; should be stored by the module if the module intends to use it latermodEnv
- external module environment, can be used to acquire external module specific info
This API documentation is public and is intended for / allowed to be used by anyone.
Scelight home page: https://sites.google.com/site/scelight/
Scelight is a trademark of András Belicza. Copyright © András Belicza, 2013-2015. All rights reserved.