Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- add(K, V) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Adds a value to the end of a deque.
- add(K, V) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Adds a value to the end of a deque.
- add(R) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Adds a resource to the list.
- addDriver(EngineLoggingFactory.Driver...) - Method in class com.blackrook.engine.EngineLoggingFactory
-
Adds a logging driver or drivers from this factory.
- addEntries(Object, boolean) - Method in class com.blackrook.engine.EngineConsole
-
Adds the entries for commands and variables to the console manager.
- addFirst(K, V) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Adds a value to the beginning of a deque.
- addFirst(K, V) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Adds a value to the beginning of a deque.
- addInputReceiver(EngineInputEventReceiver) - Method in interface com.blackrook.engine.roles.EngineInputBroadcaster
-
Called by
Enginein order to pass along the event receiver that is used to broadcast input events to listening components in the engine. - addLast(K, V) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Adds a value to the end of a deque.
- addLast(K, V) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Adds a value to the end of a deque.
- addMessageReceiver(EngineMessageReceiver) - Method in interface com.blackrook.engine.roles.EngineMessageBroadcaster
-
Called by
Enginein order to pass along the message receiver that is used to broadcast messages to listening components in the engine. - addResource(T) - Method in class com.blackrook.engine.EngineResourceSet
- addWindowEventReceiver(EngineWindowEventReceiver) - Method in interface com.blackrook.engine.roles.EngineWindowBroadcaster
-
Called by
Enginein order to pass along the event receiver that is used to broadcast main window events to listening components in the engine. - archived() - Element in annotation type com.blackrook.engine.annotation.element.CVAR
-
Checks if this archived as a setting (if not read-only)?
- ArgumentTokenizer - Class in com.blackrook.engine.struct
-
String splitting class that parses strings by whitespace and quote wrapping (single, double, or "backtick") and returns them as different formats.
- ArgumentTokenizer(CharSequence) - Constructor for class com.blackrook.engine.struct.ArgumentTokenizer
-
Creates an argument tokenizer.
B
- BIG_ENDIAN - Static variable in class com.blackrook.engine.struct.SerialReader
- BIG_ENDIAN - Static variable in class com.blackrook.engine.struct.SerialWriter
- byteRead(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a byte from the bound stream.
- byteRead(InputStream, byte[]) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a series of bytes from the bound stream into a byte array until end of stream is reached or the array is filled with bytes.
- byteRead(InputStream, byte[], int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a series of bytes from the bound stream into a byte array until end of stream is reached or
maxlenbytes have been read.
C
- callCommand(String, Object...) - Method in class com.blackrook.engine.EngineConsole
-
Calls a command.
- CCMD - Annotation Type in com.blackrook.engine.annotation.element
-
Annotation for console command entry points.
- change(StateManager.StateEntry...) - Method in class com.blackrook.engine.state.StateManager
-
Changes the current state by emptying the state stack and pushing new ones onto the stack by name.
- close(AutoCloseable) - Static method in class com.blackrook.engine.struct.Utils
-
Attempts to close an
AutoCloseableobject. - closeFile(File) - Method in class com.blackrook.engine.EngineLoggingFactory.FileLogger
-
Called after the writer to the previous file is closed on a file switch via
EngineLoggingFactory.FileLogger.setFile(File) - cmdList(String) - Method in class com.blackrook.engine.EngineConsole
- com.blackrook.engine - package com.blackrook.engine
-
Contains the main parts of the engine.
- com.blackrook.engine.adapter - package com.blackrook.engine.adapter
-
Contains adapter classes for most roles.
- com.blackrook.engine.annotation - package com.blackrook.engine.annotation
-
Contains the annotations that highlight important pieces of the application.
- com.blackrook.engine.annotation.element - package com.blackrook.engine.annotation.element
-
Contains the annotations that stereotype singleton or pooled components.
- com.blackrook.engine.annotation.resource - package com.blackrook.engine.annotation.resource
-
Contains the annotations that stereotype engine resources, read on startup.
- com.blackrook.engine.exception - package com.blackrook.engine.exception
-
Contains exception classes for the engine.
- com.blackrook.engine.handler - package com.blackrook.engine.handler
-
Contains common interfaces that field events to the Engine.
- com.blackrook.engine.receiver - package com.blackrook.engine.receiver
-
Contains interfaces that describe objects that send events to the Engine.
- com.blackrook.engine.roles - package com.blackrook.engine.roles
-
Contains interfaces that describe objects that have automatic purpose to the Engine.
- com.blackrook.engine.state - package com.blackrook.engine.state
-
Contains the state and state manager stack stuff.
- com.blackrook.engine.struct - package com.blackrook.engine.struct
-
Additional helper data structures and methods.
- compareTo(EngineResourceSet.ResourceSet.Index) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet.Index
- ConsoleCommandInvocationException - Exception Class in com.blackrook.engine.exception
-
Exception thrown when a console command cannot be completed or an exception occurs during a console command invocation.
- ConsoleCommandInvocationException() - Constructor for exception class com.blackrook.engine.exception.ConsoleCommandInvocationException
- ConsoleCommandInvocationException(String) - Constructor for exception class com.blackrook.engine.exception.ConsoleCommandInvocationException
- ConsoleCommandInvocationException(String, Throwable) - Constructor for exception class com.blackrook.engine.exception.ConsoleCommandInvocationException
- ConsoleCommandInvocationException(Throwable) - Constructor for exception class com.blackrook.engine.exception.ConsoleCommandInvocationException
- ConsoleLogger() - Constructor for class com.blackrook.engine.EngineLoggingFactory.ConsoleLogger
-
Creates a new console logger.
- consolePrint(Object) - Method in class com.blackrook.engine.Engine
-
Prints a message to the console, which involves sending a message to all of the engine's registered console listeners.
- ConsoleSetupException - Exception Class in com.blackrook.engine.exception
-
Exception thrown when a console command or variable cannot be added for some reason.
- ConsoleSetupException() - Constructor for exception class com.blackrook.engine.exception.ConsoleSetupException
- ConsoleSetupException(String) - Constructor for exception class com.blackrook.engine.exception.ConsoleSetupException
- ConsoleSetupException(String, Throwable) - Constructor for exception class com.blackrook.engine.exception.ConsoleSetupException
- ConsoleSetupException(Throwable) - Constructor for exception class com.blackrook.engine.exception.ConsoleSetupException
- ConsoleVariableException - Exception Class in com.blackrook.engine.exception
-
Exception thrown when a console variable cannot be set/retrieved or an exception occurs during a set/get.
- ConsoleVariableException() - Constructor for exception class com.blackrook.engine.exception.ConsoleVariableException
- ConsoleVariableException(String) - Constructor for exception class com.blackrook.engine.exception.ConsoleVariableException
- ConsoleVariableException(String, Throwable) - Constructor for exception class com.blackrook.engine.exception.ConsoleVariableException
- ConsoleVariableException(Throwable) - Constructor for exception class com.blackrook.engine.exception.ConsoleVariableException
- construct(Constructor, Object...) - Static method in class com.blackrook.engine.struct.Utils
-
Creates a new instance of a class from a class type.
- containsCommand(String) - Method in class com.blackrook.engine.EngineConsole
-
Checks if a command exists.
- containsVariable(String) - Method in class com.blackrook.engine.EngineConsole
-
Checks if a variable exists by name.
- create() - Method in class com.blackrook.engine.struct.HashDequeMap
-
Called to create a new Deque implementation that gets stored in the table.
- create() - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Called to create a new Deque implementation that gets stored in the table.
- create(Class) - Static method in class com.blackrook.engine.struct.Utils
-
Creates a new instance of a class from a class type.
- createConfig(Map.Entry...) - Static method in class com.blackrook.engine.state.StateConfig
-
Creates a new state config using entries.
- createConsoleLoggerFor(Class) - Static method in class com.blackrook.engine.EngineLoggingFactory
-
A convenience method for creating a Console-appending logger for a particular source by class name.
- createConsoleLoggerFor(Class, boolean) - Static method in class com.blackrook.engine.EngineLoggingFactory
-
A convenience method for creating a Console-appending logger for a particular source by class name.
- createConsoleLoggerFor(String) - Static method in class com.blackrook.engine.EngineLoggingFactory
-
A convenience method for creating a Console-appending logger for a particular source by name.
- createConsoleLoggingFactory() - Static method in class com.blackrook.engine.EngineLoggingFactory
-
A convenience method for creating a Console-appending logger factory.
- createDevice() - Method in interface com.blackrook.engine.roles.EngineDevice
-
Creates this device.
- createEngine(EngineConfig) - Static method in class com.blackrook.engine.Engine
-
Creates the Engine and prepares all of its singletons and starts stuff up and returns the instance.
- createForType(Object, Class) - Static method in class com.blackrook.engine.struct.Utils
-
Creates a new instance of an object for placement in a POJO or elsewhere.
- createForType(String, Object, Class) - Static method in class com.blackrook.engine.struct.Utils
-
Creates a new instance of an object for placement in a POJO or elsewhere.
- createGlobalSettingFile(String) - Method in class com.blackrook.engine.EngineFileSystem
-
Creates a new file off of the global settings path provided by
EngineConfig. - createPath(String) - Static method in class com.blackrook.engine.struct.Utils
-
Creates the necessary directories for a file path.
- createPathForFile(File) - Static method in class com.blackrook.engine.struct.Utils
-
Creates the necessary directories for a file path.
- createPathForFile(String) - Static method in class com.blackrook.engine.struct.Utils
-
Creates the necessary directories for a file path.
- createResources(EngineLoggingFactory.Logger, EngineFileSystem, EngineResourceSet) - Method in interface com.blackrook.engine.roles.EngineResourceGenerator
-
Called when resources are needed to be created, before the first set of resources are built from the resource definitions.
- createUserSettingFile(String) - Method in class com.blackrook.engine.EngineFileSystem
-
Creates a new file off of the user settings path provided by
EngineConfig. - CVAR - Annotation Type in com.blackrook.engine.annotation.element
-
Annotation for variables accessible to the engine.
- cvarList(String) - Method in class com.blackrook.engine.EngineConsole
D
- debug() - Element in annotation type com.blackrook.engine.annotation.element.CCMD
-
Checks if this is exposed in DEBUG mode only.
- debug() - Element in annotation type com.blackrook.engine.annotation.EngineElement
-
Checks if this element is only instantiated on debug mode.
- debug(Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a DEBUG log message.
- DEBUG - Enum constant in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
- debugf(String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a DEBUG log message, formatted.
- DefinitionName - Annotation Type in com.blackrook.engine.annotation.resource
-
Defines the resource file's resource type name for reading resource definitions.
- description() - Element in annotation type com.blackrook.engine.annotation.element.CCMD
-
Command description.
- description() - Element in annotation type com.blackrook.engine.annotation.element.CVAR
-
Variable description.
- destroyDevice() - Method in interface com.blackrook.engine.roles.EngineDevice
-
Destroys this device.
E
- echo(String) - Method in class com.blackrook.engine.EngineConsole
- EMPTY_STRING_ARRAY - Static variable in interface com.blackrook.engine.EngineResource
-
Reference to an empty string array.
- Engine - Class in com.blackrook.engine
-
The main engine, created as the centerpoint of the communication between components or as a main mediator between system components.
- EngineConfig - Interface in com.blackrook.engine
-
Configuration for the Engine, which declares basic principles for its application setup.
- EngineConfigAdapter - Class in com.blackrook.engine.adapter
-
Adapter class for engine configs.
- EngineConfigAdapter() - Constructor for class com.blackrook.engine.adapter.EngineConfigAdapter
- EngineConsole - Class in com.blackrook.engine
-
The manager that can call and get/set elements available to the console.
- EngineConsole.CCMDMapping - Class in com.blackrook.engine
-
Mapping for console commands to methods.
- EngineConsole.CVARMapping - Class in com.blackrook.engine
-
Mapping for console variables to methods.
- EngineDevice - Interface in com.blackrook.engine.roles
-
Describes a device started by the engine after object creation and configuration script execution.
- EngineElement - Annotation Type in com.blackrook.engine.annotation
-
Annotation for classes that should be instantiated as singletons for the Engine.
- EngineElementConstructor - Annotation Type in com.blackrook.engine.annotation
-
Annotation on
EngineElements that signify the constructor for this component (rather than using the default). - EngineFileSystem - Class in com.blackrook.engine
-
Main file system tree for Engine applications.
- EngineInputBroadcaster - Interface in com.blackrook.engine.roles
-
This interface describes an object that should receive an input listener to attach itself to in order to pass input events along to the active
EngineInputListeners. - EngineInputEventReceiver - Interface in com.blackrook.engine.receiver
-
This class is designed to be the class that implementors of
EngineInputBroadcasteruse to fire input events to the engine. - EngineInputHandler - Interface in com.blackrook.engine.handler
-
Input handler methods.
- EngineInputListener - Interface in com.blackrook.engine.roles
-
This interface describes an object that should receive input events.
- EngineLoggingFactory - Class in com.blackrook.engine
-
Some kind of logger for logging messages.
- EngineLoggingFactory(EngineLoggingFactory.Driver...) - Constructor for class com.blackrook.engine.EngineLoggingFactory
-
Creates a new logging factory.
- EngineLoggingFactory(EngineLoggingFactory.LogLevel, EngineLoggingFactory.Driver...) - Constructor for class com.blackrook.engine.EngineLoggingFactory
-
Creates a new logging factory.
- EngineLoggingFactory.ConsoleLogger - Class in com.blackrook.engine
-
A logger driver that outputs to Standard Out.
- EngineLoggingFactory.Driver - Interface in com.blackrook.engine
-
A logging output driver that outputs messages to a log when it receives a set of inputs.
- EngineLoggingFactory.FileLogger - Class in com.blackrook.engine
-
A logging driver that writes to a text file.
- EngineLoggingFactory.Logger - Interface in com.blackrook.engine
-
Logger interface for all log writing.
- EngineLoggingFactory.LogLevel - Enum in com.blackrook.engine
-
Logging levels.
- EngineLoggingFactory.PrintStreamLogger - Class in com.blackrook.engine
-
A standard logger for outputting to a print stream.
- EngineMessageBroadcaster - Interface in com.blackrook.engine.roles
-
This interface describes an object that should receive a message listener to attach itself to in order to pass messages along to the active EngineMessageListeners.
- EngineMessageListener - Interface in com.blackrook.engine.roles
-
Any
EngineElementthat implements this interface is automatically added to the message broadcaster. - EngineMessageReceiver - Interface in com.blackrook.engine.receiver
-
This class is designed to be the class that implementors of
EngineMessageBroadcasteruse to fire messages to the engine and its visible components. - EngineReadyListener - Interface in com.blackrook.engine.roles
-
This is a component that has a method invoked on it after startup to kickstart the application (set gamestates and such).
- EngineResource - Interface in com.blackrook.engine
-
Describes a resource descriptor that the engine stores and indexes in its resource banks.
- EngineResourceGenerator - Interface in com.blackrook.engine.roles
-
Describes an object to instantiate at engine startup that generates resources on startup.
- EngineResourceSet - Class in com.blackrook.engine
-
The thing that holds and manages all engine resources (by class).
- EngineResourceSet.ResourceSet<R> - Class in com.blackrook.engine
-
Mapping of name-to-resource and id-to-resource.
- EngineResourceSet.ResourceSet.Index - Class in com.blackrook.engine
-
Index type.
- EngineResourceSet.ResourceSet.ValueGetter - Class in com.blackrook.engine
-
Value getter thing for ease of use.
- EngineSettingsListener - Interface in com.blackrook.engine.roles
-
This is a component that has methods invoked on it when persistent settings are saved and loaded.
- EngineSetupException - Exception Class in com.blackrook.engine.exception
-
Exception thrown when a problem happens during engine component creation.
- EngineSetupException() - Constructor for exception class com.blackrook.engine.exception.EngineSetupException
- EngineSetupException(String) - Constructor for exception class com.blackrook.engine.exception.EngineSetupException
- EngineSetupException(String, Throwable) - Constructor for exception class com.blackrook.engine.exception.EngineSetupException
- EngineSetupException(Throwable) - Constructor for exception class com.blackrook.engine.exception.EngineSetupException
- EngineShutdownListener - Interface in com.blackrook.engine.roles
-
This is a component that has a method invoked on it when the engine is shutting down.
- EngineTicker - Class in com.blackrook.engine
-
An update thread class that updates all updatable objects on a set interval.
- EngineUpdateHandler - Interface in com.blackrook.engine.handler
-
Update handler methods.
- EngineUpdateListener - Interface in com.blackrook.engine.roles
-
Defines an engine component that is added to the main engine ticker.
- EngineUtils - Class in com.blackrook.engine
-
Engine utility class.
- EngineWindowBroadcaster - Interface in com.blackrook.engine.roles
-
This interface describes an object that should receive a window listener to attach itself to in order to pass window events along to the EngineListeners.
- EngineWindowEventReceiver - Interface in com.blackrook.engine.receiver
-
This class is designed to be the class that implementors of
EngineWindowBroadcasteruse to fire window events to the engine. - EngineWindowListener - Interface in com.blackrook.engine.roles
-
Describes a component that is automatically added to a listener group that has its functions called whenever important engine things happen.
- enter(StateConfig) - Method in interface com.blackrook.engine.state.State
-
Called when this state has been activated or made current.
- entry(String, T) - Static method in class com.blackrook.engine.state.StateConfig
-
Creates a single mapping entry.
- equals(EngineResourceSet.ResourceSet.Index) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet.Index
- equals(Object) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet.Index
- error(Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a ERROR log message.
- error(Throwable, Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a ERROR log message.
- ERROR - Enum constant in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
- errorf(String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a ERROR log message, formatted.
- errorf(Throwable, String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a ERROR log message, formatted.
- exit() - Method in interface com.blackrook.engine.state.State
-
Called when this state is switched away.
- explodeFiles(File...) - Static method in class com.blackrook.engine.struct.Utils
-
Explodes a list of files into a larger list of files, such that all of the files in the resultant list are not directories, by traversing directory paths.
F
- fatal(Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a FATAL log message.
- fatal(Throwable, Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a FATAL log message.
- FATAL - Enum constant in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
- fatalf(String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a FATAL log message, formatted.
- fatalf(Throwable, String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a FATAL log message, formatted.
- FileLogger(File) - Constructor for class com.blackrook.engine.EngineLoggingFactory.FileLogger
-
Creates a new file logger the writes to a specific file.
- fireBlur() - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the window loses focus in the desktop for whatever reason.
- fireClosing() - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the window receives a signal to be closed (by OS - usually is a shortcut like Alt-F4 in Windows or clicking the close button in the corner of the window in most window systems).
- fireFocus() - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the window receives focus in the desktop.
- fireInputFlag(String, boolean) - Method in interface com.blackrook.engine.receiver.EngineInputEventReceiver
-
Should be called to fire an input set/release change event happens to the engine.
- fireInputValue(String, double) - Method in interface com.blackrook.engine.receiver.EngineInputEventReceiver
-
Should be called to fire an input value change event to the engine.
- fireMinimize() - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the window is minimizing (sometimes called "shrinking" or "iconifying").
- fireMouseEnter() - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the mouse enters the main canvas of the window.
- fireMouseExit() - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the mouse leaves the main canvas of the window.
- fireMouseMove(int, int) - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the mouse moves on the main canvas.
- fireMove(int, int) - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the canvas is moved.
- fireResize(int, int) - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the canvas is resized.
- fireRestore() - Method in interface com.blackrook.engine.receiver.EngineWindowEventReceiver
-
Should be called when the window is restored from minimization.
G
- get(Object) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet.ValueGetter
- get(String) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets a resource by its identity.
- getAfterIndexValue(String, Number, R[]) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets all objects that are after an index value.
- getAfterIndexValue(String, Number, R[], int) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets all objects that are after an index value.
- getAlias() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile.FieldInfo
- getAlias() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile.MethodInfo
- getAlias(Field) - Method in interface com.blackrook.engine.struct.TypeProfileFactory.MemberPolicy
-
Gets an alias name for the provided field.
- getAlias(Method) - Method in interface com.blackrook.engine.struct.TypeProfileFactory.MemberPolicy
-
Gets an alias name for the provided method.
- getApplicationContactEmail() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getApplicationContactEmail() - Method in interface com.blackrook.engine.EngineConfig
- getApplicationDataDirectory() - Method in class com.blackrook.engine.EngineConsole
- getApplicationHomepage() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getApplicationHomepage() - Method in interface com.blackrook.engine.EngineConfig
- getApplicationIcon() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getApplicationIcon() - Method in interface com.blackrook.engine.EngineConfig
- getApplicationName() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getApplicationName() - Method in interface com.blackrook.engine.EngineConfig
- getApplicationSettingsPath() - Static method in class com.blackrook.engine.struct.OSUtils
-
Current application settings directory.
- getApplicationSupportEmail() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getApplicationSupportEmail() - Method in interface com.blackrook.engine.EngineConfig
- getApplicationSupportPage() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getApplicationSupportPage() - Method in interface com.blackrook.engine.EngineConfig
- getApplicationVersion() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getApplicationVersion() - Method in interface com.blackrook.engine.EngineConfig
- getArrayDimensions(Class) - Static method in class com.blackrook.engine.struct.Utils
-
Gets how many dimensions that this array, represented by the provided type, has.
- getArrayDimensions(Object) - Static method in class com.blackrook.engine.struct.Utils
-
Gets how many array dimensions that an object (presumably an array) has.
- getArrayType(Class) - Static method in class com.blackrook.engine.struct.Utils
-
Gets the class type of this array type, if this is an array type.
- getArrayType(Object) - Static method in class com.blackrook.engine.struct.Utils
-
Gets the class type of this array, if this is an array.
- getBeforeIndexValue(String, Number, R[]) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets all objects that are before an index value.
- getBeforeIndexValue(String, Number, R[], int) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets all objects that are before an index value.
- getByIndex(String, Number, R[]) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets all objects that match an index value.
- getByIndex(String, Number, R[], int) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets all objects that match an index value.
- getByTag(String, R[]) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets resources by a tag name.
- getByTag(String, R[], int) - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
-
Gets resources by a tag name.
- getClasses(String) - Static method in class com.blackrook.engine.struct.Utils
-
Returns the fully-qualified names of all classes beginning with a certain string.
- getClasses(String, ClassLoader) - Static method in class com.blackrook.engine.struct.Utils
-
Returns the fully-qualified names of all classes beginning with a certain string.
- getClassesFromClasspath(String) - Static method in class com.blackrook.engine.struct.Utils
-
Returns the fully-qualified names of all classes beginning with a certain string.
- getCommandDefinition(String) - Method in class com.blackrook.engine.EngineConsole
-
Gets a command definition.
- getCommandLongestLength() - Method in class com.blackrook.engine.EngineConsole
-
Returns the length of the command with the longest name.
- getCommandNames() - Method in class com.blackrook.engine.EngineConsole
-
Gets all of the command names known to the console.
- getCommandNamesForPrefix(String) - Method in class com.blackrook.engine.EngineConsole
-
Returns all command names that start with a string.
- getConsoleCommandsToExecute() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getConsoleCommandsToExecute() - Method in interface com.blackrook.engine.EngineConfig
-
Gets the list of console commands to execute after startup.
- getDebugMode() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getDebugMode() - Method in interface com.blackrook.engine.EngineConfig
- getDescription() - Method in class com.blackrook.engine.EngineConsole.CCMDMapping
-
Gets the description of this command.
- getDescription() - Method in class com.blackrook.engine.EngineConsole.CVARMapping
-
Gets the description of this command.
- getDeviceName() - Method in interface com.blackrook.engine.roles.EngineDevice
-
Gets a friendlier name for this device.
- getElement(Class) - Method in class com.blackrook.engine.Engine
-
Creates or gets an engine singleton component by class.
- getExceptionString(Throwable) - Static method in class com.blackrook.engine.struct.Utils
-
Gets a full String representation of a Throwable type, including a line-by-line breakdown of the stack trace.
- getField() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile.FieldInfo
- getFieldValue(Object, Field) - Static method in class com.blackrook.engine.struct.Utils
-
Gets the value of a field on an object.
- getFileSystemArchives() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getFileSystemArchives() - Method in interface com.blackrook.engine.EngineConfig
-
Gets the file system archives to mount.
- getFileSystemStack() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getFileSystemStack() - Method in interface com.blackrook.engine.EngineConfig
-
Gets the list of directory paths to add in lowest to greatest stack precedence.
- getFileSystemStackArchiveAutoloadExtension() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getFileSystemStackArchiveAutoloadExtension() - Method in interface com.blackrook.engine.EngineConfig
-
Gets the file system extension for archive types to mount.
- getGetterMethodsByAlias() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's getter methods.
- getGetterMethodsByName() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's getter methods.
- getGlobalSettingFilePath(String) - Method in class com.blackrook.engine.EngineFileSystem
-
Gets the path to a file in the global setting path.
- getGlobalSettingsPath() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getGlobalSettingsPath() - Method in interface com.blackrook.engine.EngineConfig
-
Returns the directory path for storing global configuration.
- getGlobalVariablesFile() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getGlobalVariablesFile() - Method in interface com.blackrook.engine.EngineConfig
-
Returns the file off of the global directory path for storing/reading archived variables.
- getHomeDirectory() - Method in class com.blackrook.engine.EngineConsole
- getHomeDirectoryPath() - Static method in class com.blackrook.engine.struct.OSUtils
- getId() - Method in interface com.blackrook.engine.EngineResource
-
The identity of this resource.
- getJavaClasspath() - Method in class com.blackrook.engine.EngineConsole
- getJavaLibraryPath() - Method in class com.blackrook.engine.EngineConsole
- getJavaVendor() - Method in class com.blackrook.engine.EngineConsole
- getJavaVersion() - Method in class com.blackrook.engine.EngineConsole
- getJavaVMName() - Method in class com.blackrook.engine.EngineConsole
- getLogFile() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getLogFile() - Method in interface com.blackrook.engine.EngineConfig
-
Returns the file to log console output to (other than the console itself).
- getLogger(Class) - Method in class com.blackrook.engine.EngineLoggingFactory
-
Creates a new Logger for outputting logs, using the name of the class as a source name.
- getLogger(Class, boolean) - Method in class com.blackrook.engine.EngineLoggingFactory
-
Creates a new Logger for outputting logs, using the name of the class as a source name.
- getLogger(String) - Method in class com.blackrook.engine.EngineLoggingFactory
-
Creates a new Logger for outputting logs.
- getLoggingLevel() - Method in class com.blackrook.engine.EngineLoggingFactory
-
Returns the current logging level.
- getLoggingLevel() - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Gets the current individual logging level for this logger.
- getLogLevel() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getLogLevel() - Method in interface com.blackrook.engine.EngineConfig
- getMethod() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile.MethodInfo
- getNullFile() - Static method in class com.blackrook.engine.struct.OSUtils
- getOSArchitecture() - Method in class com.blackrook.engine.EngineConsole
- getOSName() - Method in class com.blackrook.engine.EngineConsole
- getOSVersion() - Method in class com.blackrook.engine.EngineConsole
- getPackageRoots() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getPackageRoots() - Method in interface com.blackrook.engine.EngineConfig
- getParameter(Class, String) - Method in class com.blackrook.engine.state.StateConfig
-
Gets a config parameter, casting it to the desired type.
- getProfile(Class) - Static method in class com.blackrook.engine.struct.Utils
-
Creates a new profile for a provided type.
- getPublicFieldsByAlias() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's public fields.
- getPublicFieldsByName() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's public fields.
- getResource(Class, String) - Method in class com.blackrook.engine.Engine
-
Creates or gets an engine resource by class and name.
- getResource(Class, String) - Method in class com.blackrook.engine.EngineResourceSet
-
Returns a resource of a particular type and id.
- getResourceSet(Class) - Method in class com.blackrook.engine.Engine
-
Creates or gets an engine resource set by class.
- getResourceSet(Class) - Method in class com.blackrook.engine.EngineResourceSet
-
Returns the resource list that stores a set of resources.
- getSetterMethodsByAlias() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's setter methods.
- getSetterMethodsByName() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile
-
Returns a reference to the map that contains this profile's setter methods.
- getStartupComponentClasses() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getStartupComponentClasses() - Method in interface com.blackrook.engine.EngineConfig
-
Gets the list of singleton classes that should be instantiated on startup.
- getTags() - Method in interface com.blackrook.engine.EngineResource
-
Returns the tags that this resource uses which abstractly may define its greater purpose.
- getTempDirectoryPath() - Static method in class com.blackrook.engine.struct.OSUtils
- getType() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile.FieldInfo
- getType() - Method in class com.blackrook.engine.struct.TypeProfileFactory.Profile.MethodInfo
- getUpdatesPerSecond() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getUpdatesPerSecond() - Method in interface com.blackrook.engine.EngineConfig
-
Gets how many updates per second that the main updating thread needs to do.
- getUsage() - Method in class com.blackrook.engine.EngineConsole.CCMDMapping
-
Gets the usage blurb of this command.
- getUserSettingFilePath(String) - Method in class com.blackrook.engine.EngineFileSystem
-
Gets the path to a file in the user setting path.
- getUserSettingsPath() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getUserSettingsPath() - Method in interface com.blackrook.engine.EngineConfig
-
Returns the directory path for storing user configuration.
- getUserVariablesFile() - Method in class com.blackrook.engine.adapter.EngineConfigAdapter
- getUserVariablesFile() - Method in interface com.blackrook.engine.EngineConfig
-
Returns the file off of the user directory path for storing/reading archived variables.
- getVariable(String) - Method in class com.blackrook.engine.EngineConsole
-
Gets the value of a variable by name.
- getVariable(String, Class) - Method in class com.blackrook.engine.EngineConsole
-
Gets the value of a variable by name, converted to a value type.
- getVariableDefinition(String) - Method in class com.blackrook.engine.EngineConsole
-
Gets a variable definition.
- getVariableLongestLength() - Method in class com.blackrook.engine.EngineConsole
-
Returns the length of the variable with the longest name.
- getVariableNames() - Method in class com.blackrook.engine.EngineConsole
-
Gets all of the variable names known to the console.
- getVariableNamesForPrefix(String) - Method in class com.blackrook.engine.EngineConsole
-
Returns all variable names that start with a string.
- getWorkingDirectory() - Method in class com.blackrook.engine.EngineConsole
- getWorkingDirectoryPath() - Static method in class com.blackrook.engine.struct.OSUtils
- global() - Element in annotation type com.blackrook.engine.annotation.element.CVAR
-
Checks if this a globally-saved variable (as opposed to user)?
H
- handleException(Throwable) - Method in class com.blackrook.engine.Engine
-
Handles an uncaught, fatal exception and initiates engine shutdown.
- HashDequeMap<K,
V> - Class in com.blackrook.engine.struct -
A hash map that stores deques of a particular type.
- HashDequeMap() - Constructor for class com.blackrook.engine.struct.HashDequeMap
-
Creates a new HashDequeMap that has default capacity and load factor.
- HashDequeMap(int) - Constructor for class com.blackrook.engine.struct.HashDequeMap
-
Creates a new HashDequeMap that has a specific capacity and default load factor.
- HashDequeMap(int, float) - Constructor for class com.blackrook.engine.struct.HashDequeMap
-
Creates a new HashDequeMap that has a specific capacity and default load factor.
I
- Indexed - Annotation Type in com.blackrook.engine.annotation.resource
-
Annotation that tells the resource loader to create a searchable index for the value returned by this method.
- info(Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a INFO log message.
- INFO - Enum constant in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
- infof(String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a INFO log message, formatted.
- invokeBlind(Method, Object, Object...) - Static method in class com.blackrook.engine.struct.Utils
-
Blindly invokes a method, only throwing a
RuntimeExceptionif something goes wrong. - isArchived() - Method in class com.blackrook.engine.EngineConsole.CVARMapping
-
Gets if this variable is to be archived.
- isARM() - Static method in class com.blackrook.engine.struct.OSUtils
- isArray(Class) - Static method in class com.blackrook.engine.struct.Utils
-
Tests if a class is actually an array type.
- isArray(Object) - Static method in class com.blackrook.engine.struct.Utils
-
Tests if an object is actually an array type.
- isDeviceActive() - Method in interface com.blackrook.engine.roles.EngineDevice
-
Checks if this device was "created" and can be destroyed.
- isEmpty() - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
- isEmpty() - Method in class com.blackrook.engine.state.StateManager
- isEmpty(Object) - Static method in class com.blackrook.engine.struct.Utils
-
Checks if a value is "empty."
- isGlobal() - Method in class com.blackrook.engine.EngineConsole.CVARMapping
-
Gets if this variable is to stored/read from global.
- isIgnored(Field) - Method in interface com.blackrook.engine.struct.TypeProfileFactory.MemberPolicy
-
Checks if a field is ignored by the profile generator.
- isIgnored(Method) - Method in interface com.blackrook.engine.struct.TypeProfileFactory.MemberPolicy
-
Checks if a method is ignored by the profile generator.
- isLinux() - Static method in class com.blackrook.engine.struct.OSUtils
- isOSX() - Static method in class com.blackrook.engine.struct.OSUtils
- isOSX64() - Static method in class com.blackrook.engine.struct.OSUtils
- isOSX86() - Static method in class com.blackrook.engine.struct.OSUtils
- isOSXPPC() - Static method in class com.blackrook.engine.struct.OSUtils
- isPPC() - Static method in class com.blackrook.engine.struct.OSUtils
- isReadOnly() - Method in class com.blackrook.engine.EngineConsole.CVARMapping
-
Gets if this variable is to be archived.
- isSolaris() - Static method in class com.blackrook.engine.struct.OSUtils
- isWin32() - Static method in class com.blackrook.engine.struct.OSUtils
- isWin64() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows10() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows11() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows2000() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows2003() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows2008() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows7() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows8() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindows9X() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindowsME() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindowsNT() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindowsVista() - Static method in class com.blackrook.engine.struct.OSUtils
- isWindowsXP() - Static method in class com.blackrook.engine.struct.OSUtils
- isX64() - Static method in class com.blackrook.engine.struct.OSUtils
- isX86() - Static method in class com.blackrook.engine.struct.OSUtils
- iterator() - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
J
- joinArrays(T[]...) - Static method in class com.blackrook.engine.struct.Utils
-
Concatenates a set of arrays together, such that the contents of each array are joined into one array.
K
- keys() - Method in class com.blackrook.engine.struct.OrderedProperties
L
- LITTLE_ENDIAN - Static variable in class com.blackrook.engine.struct.SerialReader
- LITTLE_ENDIAN - Static variable in class com.blackrook.engine.struct.SerialWriter
- loadGlobalVariables(Properties) - Method in class com.blackrook.engine.EngineConsole
-
Sets all variables and their values using the entries on a
Propertiesobject. - loadSettings() - Method in class com.blackrook.engine.Engine
-
Loads user and global settings from persistent storage and sets element properties.
- loadUserVariables(Properties) - Method in class com.blackrook.engine.EngineConsole
-
Sets all variables and their values using the entries on a
Propertiesobject. - log(Date, EngineLoggingFactory.LogLevel, String, String, Throwable) - Method in interface com.blackrook.engine.EngineLoggingFactory.Driver
-
Processes a logging message.
- log(Date, EngineLoggingFactory.LogLevel, String, String, Throwable) - Method in class com.blackrook.engine.EngineLoggingFactory.FileLogger
- log(Date, EngineLoggingFactory.LogLevel, String, String, Throwable) - Method in class com.blackrook.engine.EngineLoggingFactory.PrintStreamLogger
N
- nextBoolean() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a boolean value.
- nextBoolean(boolean) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a boolean value.
- nextByte() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a byte value.
- nextByte(byte) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a byte value.
- nextChar() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a char value.
- nextChar(char) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a char value.
- nextDouble() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a double value.
- nextDouble(double) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a double value.
- nextFloat() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a float value.
- nextFloat(float) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a float value.
- nextInt() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as an integer value.
- nextInt(int) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as an integer value.
- nextLong() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a long value.
- nextLong(long) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a long value.
- nextShort() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a short value.
- nextShort(short) - Method in class com.blackrook.engine.struct.ArgumentTokenizer
-
Reads the next token and parses it as a short value.
- nextToken() - Method in class com.blackrook.engine.struct.ArgumentTokenizer
O
- onBlur() - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when it detects that the main window loses focus by the OS.
- onClosing() - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when it detects that the main window is getting closed.
- onEngineMessage(Object, Object...) - Method in interface com.blackrook.engine.roles.EngineMessageListener
-
Called when a message is broadcast.
- onEngineReady() - Method in interface com.blackrook.engine.roles.EngineReadyListener
-
Invoked after
Enginestartup, which is after the filesystem, all resources, components are created, all user/global variables loaded, devices created, and pending console commands executed, but BEFORE the update ticker is started. - onEngineShutdown() - Method in interface com.blackrook.engine.roles.EngineShutdownListener
-
Called by Engine when it is shutting down.
- onFocus() - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when it detects that the main window gains focus by the OS.
- onInputFlag(String, boolean) - Method in interface com.blackrook.engine.handler.EngineInputHandler
-
Handles a boolean input code setting.
- onInputFlag(String, boolean) - Method in class com.blackrook.engine.state.StateManager
- onInputValue(String, double) - Method in interface com.blackrook.engine.handler.EngineInputHandler
-
Handles an input value change.
- onInputValue(String, double) - Method in class com.blackrook.engine.state.StateManager
- onLoadGlobalSettings(Properties) - Method in interface com.blackrook.engine.roles.EngineSettingsListener
-
Sets this element's global settings by reading them from the provided
Propertiesobject. - onLoadUserSettings(Properties) - Method in interface com.blackrook.engine.roles.EngineSettingsListener
-
Sets this element's user-specific settings by reading them from the provided
Propertiesobject. - onMinimize() - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when it detects that the main window is getting minimized.
- onMouseEnter() - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when the mouse has entered the main display canvas.
- onMouseExit() - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when the mouse has exited the main display canvas.
- onMouseMove(int, int) - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when the mouse has moved on the main display canvas.
- onMove(int, int) - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Should be called when the canvas is moved (absolutely).
- onPath(String) - Static method in class com.blackrook.engine.struct.OSUtils
-
Attempts to detect if an executable is present on the platform's PATH by name.
- onResize(int, int) - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Should be called when the canvas is resized.
- onRestore() - Method in interface com.blackrook.engine.roles.EngineWindowListener
-
Called by Engine when it detects that the main window is getting restored from a minimize.
- onSaveGlobalSettings(Properties) - Method in interface com.blackrook.engine.roles.EngineSettingsListener
-
Puts this element's global settings into the provided
Propertiesobject. - onSaveUserSettings(Properties) - Method in interface com.blackrook.engine.roles.EngineSettingsListener
-
Puts this element's user-specific settings into the provided
Propertiesobject. - onUnexpectedEngineShutDown(Throwable) - Method in interface com.blackrook.engine.roles.EngineShutdownListener
-
Called by Engine when it is shutting down unexpectedly.
- openGlobalSettingFile(String) - Method in class com.blackrook.engine.EngineFileSystem
-
Creates a new file off of the global settings path provided by
EngineConfig. - openUserSettingFile(String) - Method in class com.blackrook.engine.EngineFileSystem
-
Creates a new file off of the user settings path provided by
EngineConfig. - OrderedProperties - Class in com.blackrook.engine.struct
-
A special properties type that returns keys in lexicographical order.
- OrderedProperties() - Constructor for class com.blackrook.engine.struct.OrderedProperties
- Ordering - Annotation Type in com.blackrook.engine.annotation.element
-
An annotation to be used on Engine Role objects to influence the ordering.
- OSUtils - Class in com.blackrook.engine.struct
-
Simple OS utility functions.
P
- parseCommand(String) - Method in class com.blackrook.engine.EngineConsole
-
Parses a command.
- peekFirst(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Returns the value at the beginning of a deque.
- peekFirst(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Returns the value at the beginning of a deque.
- peekLast(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Returns the value at the end of a deque.
- peekLast(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Returns the value at the end of a deque.
- poll(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Removes a value from the front of a deque.
- poll(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Removes a value from the front of a deque.
- pollFirst(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Removes a value from the beginning of a deque.
- pollFirst(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Removes a value from the beginning of a deque.
- pollLast(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Removes a value from the end of a deque.
- pollLast(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Removes a value from the end of a deque.
- pop() - Method in class com.blackrook.engine.state.StateManager
-
Pops a bunch of game states off of the state stack as returns it.
- pop(int) - Method in class com.blackrook.engine.state.StateManager
-
Pops a bunch of game states off of the state stack.
- pop(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Removes a value from the front of a deque.
- pop(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Removes a value from the front of a deque.
- print(Object) - Method in class com.blackrook.engine.EngineConsole
-
Prints a message to the engine console.
- printf(String, Object...) - Method in class com.blackrook.engine.EngineConsole
-
Prints a formatted message to the console.
- printfln(String, Object...) - Method in class com.blackrook.engine.EngineConsole
-
Prints a formatted message to the console with a newline appended to it.
- println() - Method in class com.blackrook.engine.EngineConsole
-
Prints a newline.
- println(Object) - Method in class com.blackrook.engine.EngineConsole
-
Prints a message to the console with a newline appended to it.
- PrintStreamLogger(PrintStream) - Constructor for class com.blackrook.engine.EngineLoggingFactory.PrintStreamLogger
-
Creates a new print stream logger.
- processCommand(String) - Method in class com.blackrook.engine.EngineConsole
-
Processes a single command.
- push(StateManager.StateEntry...) - Method in class com.blackrook.engine.state.StateManager
-
Pushes new states onto the stack.
- push(K, V) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Adds a value to the front of a deque.
- push(K, V) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Adds a value to the front of a deque.
- pushArchive(FSFileArchive) - Method in class com.blackrook.engine.EngineFileSystem
Q
- quit(int) - Method in class com.blackrook.engine.EngineConsole
R
- read24BitInt(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a 24-bit integer.
- readBoolean(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a byte as a boolean value.
- readBooleanArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array of boolean values.
- readByte(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a single byte.
- readByteArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a byte array in from the reader.
- readBytes(InputStream, byte[]) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a series of bytes from the bound stream into a byte array until end of stream is reached or the array is filled with bytes.
- readBytes(InputStream, byte[], int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a series of bytes from the bound stream into a byte array until end of stream is reached or
maxlenbytes have been read. - readBytes(InputStream, int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a specified amount of bytes, returned as an array.
- readChar(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a character.
- readCharArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array of characters.
- readChars(InputStream, int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a specific amount of characters.
- readDouble(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a 64-bit float.
- readDoubleArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array 64-bit floats.
- readDoubles(InputStream, int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a specified amount of 64-bit floats.
- readFloat(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a 32-bit float.
- readFloatArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array 32-bit floats.
- readFloats(InputStream, int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a specified amount of 32-bit floats.
- readFor(InputStream, byte[]) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a bunch of bytes and checks to see if a set of bytes match completely with the input byte string.
- readInt(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an integer.
- readIntArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array of integers.
- readInts(InputStream, int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a specified amount of integers.
- readLong(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a long value.
- readLongArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array of long values.
- readLongs(InputStream, int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an amount of long values specified by the user.
- readShort(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a short.
- readShortArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array of shorts.
- readShorts(InputStream, int) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a specified amount of shorts.
- readString(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a char array and returns it as a String.
- readString(InputStream, int, String) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a byte vector of specific length and returns it as a String in a particular encoding.
- readString(InputStream, int, Charset) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a byte vector of specific length and returns it as a String in a particular encoding.
- readString(InputStream, String) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a byte vector (an int followed by a series of bytes) and returns it as a String in a particular encoding.
- readString(InputStream, Charset) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a byte vector (an int followed by a series of bytes) and returns it as a String in a particular encoding.
- readStringArray(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in an array of strings.
- readUnsignedByte(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a single byte, cast to a short to eliminate sign.
- readUnsignedInt(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a integer, cast to a long, discarding sign.
- readUnsignedShort(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads in a short, cast to an integer, discarding sign.
- readVariableLengthInt(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads an integer from an input stream that is variable-length encoded.
- readVariableLengthLong(InputStream) - Method in class com.blackrook.engine.struct.SerialReader
-
Reads a long from an input stream that is variable-length encoded.
- removeDriver(EngineLoggingFactory.Driver...) - Method in class com.blackrook.engine.EngineLoggingFactory
-
Removes a logging driver or drivers from this factory.
- removeFirst(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Removes a value from the beginning of a deque.
- removeFirst(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Removes a value from the beginning of a deque.
- removeLast(K) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Removes a value from the end of a deque.
- removeLast(K) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Removes a value from the end of a deque.
- removeValue(K, V) - Method in class com.blackrook.engine.struct.HashDequeMap
-
Removes a value from a deque.
- removeValue(K, V) - Method in class com.blackrook.engine.struct.TreeDequeMap
-
Removes a value from a deque.
- restartDevice(String) - Method in class com.blackrook.engine.Engine
-
Restarts an engine device.
S
- saveGlobalVariables(Properties) - Method in class com.blackrook.engine.EngineConsole
-
Puts all global variables and their values into a
Propertiesobject. - saveSettings() - Method in class com.blackrook.engine.Engine
-
Saves user and global settings to persistent storage.
- saveUserVariables(Properties) - Method in class com.blackrook.engine.EngineConsole
-
Puts all user variables and their values into a
Propertiesobject. - seekToPattern(InputStream, byte[]) - Method in class com.blackrook.engine.struct.SerialReader
-
Keeps reading until it hits a specific byte pattern.
- sendMessage(Object, Object...) - Method in interface com.blackrook.engine.receiver.EngineMessageReceiver
-
Should be called to fire a message to broadcast through the engine.
- SerialReader - Class in com.blackrook.engine.struct
-
Assists in endian reading from an input stream.
- SerialReader(boolean) - Constructor for class com.blackrook.engine.struct.SerialReader
-
Wraps a super reader around an InputStream.
- SerialWriter - Class in com.blackrook.engine.struct
-
Assists in endian writing to an output stream.
- SerialWriter(boolean) - Constructor for class com.blackrook.engine.struct.SerialWriter
-
Creates a new serial writer.
- setEndianMode(boolean) - Method in class com.blackrook.engine.struct.SerialReader
-
Sets the byte endian mode for the byte conversion methods.
- setEndianMode(boolean) - Method in class com.blackrook.engine.struct.SerialWriter
-
Sets the byte endian mode for the byte conversion methods.
- setFieldValue(Object, Field, Object) - Static method in class com.blackrook.engine.struct.Utils
-
Sets the value of a field on an object.
- setFile(File) - Method in class com.blackrook.engine.EngineLoggingFactory.FileLogger
-
Sets the log file to a new file.
- setLoggingLevel(EngineLoggingFactory.LogLevel) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Sets the individual logging level for this logger.
- setLoggingLevel(EngineLoggingFactory.LogLevel) - Method in class com.blackrook.engine.EngineLoggingFactory
-
Returns the current logging level.
- setParameter(String, Object) - Method in class com.blackrook.engine.state.StateConfig
-
Sets a config parameter.
- setVariable(String, Object) - Method in class com.blackrook.engine.EngineConsole
-
Sets the value of a variable.
- severe(Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a SEVERE log message.
- severe(Throwable, Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a SEVERE log message.
- SEVERE - Enum constant in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
- severef(String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a SEVERE log message, formatted.
- severef(Throwable, String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a SEVERE log message, formatted.
- shutDown() - Method in class com.blackrook.engine.Engine
-
Initiates engine shutdown.
- shutDown(int) - Method in class com.blackrook.engine.Engine
-
Initiates engine shutdown.
- size() - Method in class com.blackrook.engine.EngineResourceSet.ResourceSet
- size() - Method in class com.blackrook.engine.state.StateManager
- sleep(long) - Static method in class com.blackrook.engine.struct.Utils
-
Calls
Thread.sleep()but in an encapsulated try to avoid catching InterruptedException. - sleep(long, int) - Static method in class com.blackrook.engine.struct.Utils
-
Calls
Thread.sleep()but in an encapsulated try to avoid catching InterruptedException. - start() - Method in class com.blackrook.engine.EngineTicker
-
Starts the updater.
- State - Interface in com.blackrook.engine.state
-
Defines an engine state that can be pushed or popped from the
StateManager. - StateConfig - Class in com.blackrook.engine.state
-
A state configuration object.
- StateConfig() - Constructor for class com.blackrook.engine.state.StateConfig
-
Protected constructor for config.
- StateEntry(State, StateConfig) - Constructor for class com.blackrook.engine.state.StateManager.StateEntry
-
Creates a new State Entry for pushing onto the state stack.
- StateManager - Class in com.blackrook.engine.state
-
The state manager class for maintaining exclusive, updatable states.
- StateManager() - Constructor for class com.blackrook.engine.state.StateManager
- StateManager.StateEntry - Class in com.blackrook.engine.state
-
State entry.
- stop() - Method in class com.blackrook.engine.EngineTicker
-
Stops the updater.
T
- TreeDequeMap<K,
V> - Class in com.blackrook.engine.struct -
A tree map that stores deques of a particular type.
- TreeDequeMap() - Constructor for class com.blackrook.engine.struct.TreeDequeMap
-
Creates a new HashDequeMap that has default capacity and load factor.
- TreeDequeMap(Comparator) - Constructor for class com.blackrook.engine.struct.TreeDequeMap
-
Creates a new HashDequeMap that has a specific capacity and default load factor.
- TypeProfileFactory - Class in com.blackrook.engine.struct
-
A factory that produces type profiles for POJOs and data objects.
- TypeProfileFactory.MemberPolicy - Interface in com.blackrook.engine.struct
-
An interface for figuring out whether to ignore certain fields or methods on an object that a profile is being generated for (if they are already going to pass testing for includable fields).
- TypeProfileFactory.Profile<T> - Class in com.blackrook.engine.struct
-
Type profile for an unknown object that has an ambiguous signature for applying values to POJOs and beans.
- TypeProfileFactory.Profile.FieldInfo - Class in com.blackrook.engine.struct
-
Field information.
- TypeProfileFactory.Profile.MethodInfo - Class in com.blackrook.engine.struct
-
Method signature.
U
- update(long, long) - Method in interface com.blackrook.engine.handler.EngineUpdateHandler
-
Updates this component.
- update(long, long) - Method in class com.blackrook.engine.state.StateManager
- urlUnescape(String) - Static method in class com.blackrook.engine.struct.Utils
-
Decodes a URL-encoded string.
- usage() - Element in annotation type com.blackrook.engine.annotation.element.CCMD
-
Usage blurb.
- Utils - Class in com.blackrook.engine.struct
-
Various utility functions.
V
- value - Variable in class com.blackrook.engine.EngineResourceSet.ResourceSet.Index
-
Value in the index.
- value() - Element in annotation type com.blackrook.engine.annotation.element.CCMD
-
The command name.
- value() - Element in annotation type com.blackrook.engine.annotation.element.CVAR
-
The variable name.
- value() - Element in annotation type com.blackrook.engine.annotation.element.Ordering
-
Ordering bias.
- value() - Element in annotation type com.blackrook.engine.annotation.resource.DefinitionName
-
The resource structure type name to use when reading resources.
- value() - Element in annotation type com.blackrook.engine.annotation.resource.Indexed
-
Index name.
- valueOf(String) - Static method in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
-
Returns the enum constant of this type with the specified name.
- values() - Static method in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
-
Returns an array containing the constants of this enum type, in the order they are declared.
W
- warn(Object) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a WARNING log message.
- warnf(String, Object...) - Method in interface com.blackrook.engine.EngineLoggingFactory.Logger
-
Outputs a WARNING log message, formatted.
- WARNING - Enum constant in enum com.blackrook.engine.EngineLoggingFactory.LogLevel
- writeBoolean(OutputStream, boolean) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a boolean as a byte.
- writeBooleanArray(OutputStream, boolean...) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a boolean array, which is the length of the array as an integer plus each boolean grouped into integer bits.
- writeByte(OutputStream, byte) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a byte.
- writeByteArray(OutputStream, byte[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an array of bytes, which is the length of the array as an integer plus each byte.
- writeBytes(OutputStream, byte[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a series of bytes.
- writeChar(OutputStream, char) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a character.
- writeCharArray(OutputStream, char[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a character array, which is the length of the array as an integer plus each character.
- writeDouble(OutputStream, double) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a 64-bit float.
- writeDoubleArray(OutputStream, double[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an array of 64-bit floats, which is the length of the array as an integer plus each double.
- writeFloat(OutputStream, float) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a 32-bit float.
- writeFloatArray(OutputStream, float[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an array of 32-bit floats, which is the length of the array as an integer plus each float.
- writeInt(OutputStream, int) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an integer.
- writeIntArray(OutputStream, int[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an integer array, which is the length of the array as an integer plus each integer.
- writeLong(OutputStream, long) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a long.
- writeLongArray(OutputStream, long[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an array of longs, which is the length of the array as an integer plus each long.
- writeShort(OutputStream, short) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a short.
- writeShortArray(OutputStream, short[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an array of shorts, which is the length of the array as an integer plus each short.
- writeString(OutputStream, String) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a String.
- writeString(OutputStream, String, String) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a String in a specific encoding.
- writeString(OutputStream, String, Charset) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a String in a specific encoding.
- writeStringArray(OutputStream, String[]) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an array of Strings, which is the length of the array as an integer plus each String.
- writeUnsignedByte(OutputStream, int) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an int that is less than 256 to a byte.
- writeUnsignedByte(OutputStream, short) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a short that is less than 256 to a byte.
- writeUnsignedInteger(OutputStream, long) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes a long that is less than 2^32 to an integer.
- writeUnsignedShort(OutputStream, int) - Method in class com.blackrook.engine.struct.SerialWriter
-
Writes an integer, less than 65536, as a short.
- writeVariableLengthInt(OutputStream, int) - Method in class com.blackrook.engine.struct.SerialWriter
-
Converts an integer from an int to a variable-length string of bytes.
- writeVariableLengthLong(OutputStream, long) - Method in class com.blackrook.engine.struct.SerialWriter
-
Converts a long from a long to a variable-length string of bytes.
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form