All Classes

Class	Description
accumulator	A component that can stores up energy upto a predefined limit.
appFSM<State,Trigger>	Provides a StateMachine<State, Trigger> to manage moving between the major States of the game and enable/disable the appropriate JME application states.
appFSM.State
appFSM.Trigger
appliesto	Added to specification entities, this component indicates what the spec entity is meant to build to eg a planetSpec has an appliesto = planet.class, an engineSpec has appliesto = engine.class
AsyncThread	Indicate a method may be initiated from the eventbus handling and hence run on a separate thread.
AttributedValueReferenceConverter	Processes an XML element in the form <element key="key">value</element> into a reference object that consists of a key to another entity and an optional value.
baseEF	Factories produce entities in the entity repository.
build	A build ticket that describes a task in the manufacturing process.
build.PROGRESS	Status of this ticket.
build.TYPE	These are the type of activity to be performed.
builder	Added to specification entities, this component indicates that it builds things ie it is a shipyard or industry.
buildQueue	Every facility capable of construction will have an associated buildQueue.
Cache	Annotate a method to indicate its output is cached.
clientHandler	Accept incoming message objects from and send messages to the zodiac remote server.
clockState	Regulates the progress of the game via the stardate.
combatState	This JMonkeyEngine application state handles confrontations between (for instance) ships.
ConstantConverter
construct	Create a new entity in the repository and make delivery.
coordinates	Component that stores a strategic map xy coordinate as a Vector (for ease of later use).
description	An entity component that represents a meaningful description for the entity eg "homeworld of humans".
destination	The destination component is attached to entities that are travelling towards other entities.
DimensionConverter	Convert XML representing a Dimension value into a Dimension object.
display	A component that holds information relating to display and visual aspects of an entity.
distribute	Move power from the output of an engine to the associated parts according to the distribution component.
distribution	A component that specifies the power distribution eg from an engine to multiple ship components such as the hull and weapons.
engine	Engine provide power for hulls (so they can move), shields and weapons.
engineEF	Engines provide power according to their specification and health.
engineEF	Engines provide power according to their specification and health.
engineSpec	The read-only blueprint (eg "E01") for a particular type of engine.
engineSpecEF	A engineSpec consists of components: Name - unique key description appliesto=engine physical manufacture
engineSpecEF	A engineSpec consists of components: Name - unique key description appliesto=engine physical manufacture
entityFactory	Creates entity factories which can then in turn create appropriate repository entities.
entityFactory.FACTORY	Identify which type of factories we want.
faction	Process a <faction> XML element into an object.
factionEF	A faction has components: Name - unique key description specification politics
fire	Fire a weapon to cause damage to a target.
gameConfig	Read an XML properties configuration file of game settings.
gameConfig.keys	Enum all the allowed settings values in the gameConfig file or provided on the command line and associate defaults.
gameEvent	A gameEvent is used to broadcast that something of note has happened in the in-game world such as a ship arriving at a planet.
gameEvent.REASON	List of REASONs for the event, the source should be able to provide the associated data if required.
gamefile	A game file is a snapshot of the gameplay and settings that can be saved and reloaded to/from disk.
hasher	Create unique String hashcodes we can use in things like equipment serial numbers.
health	A component that tracks the health of an entity.
hull	Hulls provide a container to allow other components to be collected together into a ship.
hullEF	A hull consists of components: Name - unique key description specification=hullSpec health accumulator
hullEF	A hull consists of components: Name - unique key description specification=hullSpec health accumulator
hullSpec	The read-only properties of a particular type ship hull as represented in XML.
hullSpecEF	A hullSpec consists of components: Name - unique key description appliesto=hull physical manufacture
hullSpecEF	A hullSpec consists of components: Name - unique key description appliesto=hull physical manufacture
iDockable	Provide an interface for any dockable that can be added (docked) into the zUIDock container.
iEntityReference	Apply this interface to any component that contains a reference to another EntityId.
industry	Industry builds things.
industryEF	A industry consists of components: Name - unique key description specification=industrySpec location
industryEF	A industry consists of components: Name - unique key description specification=industrySpec location
industrySpec	The read-only properties of a particular type of industry.
industrySpecEF	A industrySpec consists of components: Name - unique key description appliesto=industry manufacture builder
industrySpecEF	A industrySpec consists of components: Name - unique key description appliesto=industry manufacture builder
inorbit	This component is used for entities that don't have their own coordinates but are in orbit of another entity eg a planet around a sun.
install	Manipulate the parts of an entity (currently only a ship has parts)
InternalAppender	This log4j appender is configurable AT RUNTIME by an application.
iZodiacApp	The extra functions added to the SimpleApplication to provide the specific members and fields for zodiac.
iZodiacState	Applied to all the states to encourage consistency.
izSwing	Interface for all the UI component handlers using cookswing giving them acccess to a shared cookswing handler and the zodiac app.
loadandsaveState	This JMonkeyEngine application state handles the users requests to load and save the gamefile.
location	The location component is attached to entities that have a fixed position relative to another entity eg an industry on a planet.
main	The main entry point into the game.
manufacture	Component that has data required for manufacturing an entity.
manufacture.BUILDER	Set by processor and used by manufacturingState to allocate builds to the appropriate buildQueue.
manufacture.DELIVER	Set by entityConverter, used by manufacturingState to determine how completed builds are delivered.
manufacturingState	This JMonkeyEngine application state handles the various buildQueues and industry manufacturing things.
move	Movement calculations, this doesnt alter the coordinates, just calculates whats possible.
movementState	This JMonkeyEngine application state handles the movement of the game pieces ie ships.
orbiting	Process the XML <orbiting key="Sol">3</orbiting> into an object.
owner	Entities that can be owned has this component which references a faction.
parts	A component that can Lists the equipment installed on a ship.
physical	A component that holds static physical properties such as size or mass.
planet	Process a <planet> XML element into an entity and components.
planetDockable	Provides the handler to represent a planet as a dockable tile.
planetEF	A planet consists of components: Name - unique key description specification inorbit
planetEF	A planet consists of components: Name - unique key description specification inorbit
planetSpec	The read-only properties of a particular type or classification (eg class "M") of a planet.
planetSpecEF	A planetSpec consists of components: Name - unique key description appliesto=planet physical display
planetSpecEF	A planetSpec consists of components: Name - unique key description appliesto=planet physical display
playbarDockable	This handler controls the start/stop/pause display of the stardate in-game clock visualised as a set of media-player buttons.
politics	A component that captures the socio-political aspects for a faction such as their wealth, attitude to other factions.
position	Update the coordinates and destinations of a ship.
reference	Process the XML of form <reference key="Sol">3</reference> into an object.
remoteState	This JMonkeyEngine application state allows remote control (via sockets/Apache mina).
renderState	Render the model/data contained in the entity repository into a scene.
sceneToImage	This added to a viewport where it copies rendered frames (in memory) onto a specified Swing panel.
search	Search for data in the entity repository.
serverHandler	Use the static serverHandler.makeServer() to create a new server.
service	Store some objects against their Class for retrieval from any point in the codebase.
shield	Shields absorb incoming damage.
shieldEF	A shield consists of components: Name - unique key description specification=shieldSpec health accumulator
shieldEF	A shield consists of components: Name - unique key description specification=shieldSpec health accumulator
shieldSpec	The read-only blueprint (eg "S01") for a particular type of shield.
shieldSpecEF	A shieldSpec consists of components: Name - unique key description appliesto=shield physical manufacture
shieldSpecEF	A shieldSpec consists of components: Name - unique key description appliesto=shield physical manufacture
ship	Process a <ship> XML element into an entity and components.
shipEF	A ship consists of components: Name - unique key description specification=shipSpec inorbit or coordinates parts - List of EntityId of installed equipment distribution
shipEF	A ship consists of components.
shipEF	A ship consists of components.
shipSpec	The blueprint or specification for a particular type of ship.
shipSpecEF	A shipSpec consists of components: Name - unique key description appliesto=ship manufacture parts - List of EntityId of the specs required to complete this shipSpec
shipSpecEF	A shipSpec consists of components: Name - unique key description appliesto=ship manufacture parts - List of EntityId of the specs required to complete this shipSpec
shipSpecEF	A shipSpec consists of components: Name - unique key description appliesto=ship manufacture parts - List of EntityId of the specs required to complete this shipSpec
shipyard	Shipyards are in orbit around planets and build ships and hulls.
shipyardEF	A shipyard consists of components: Name - unique key description specification=shipyardSpec inorbit
shipyardEF	A shipyard consists of components: Name - unique key description specification=shipyardSpec inorbit
shipyardSpec	The read-only properties of a particular type of shipyard.
shipyardSpecEF	A shipyardSpec consists of components: Name - unique key description appliesto=shipyard manufacture builder
shipyardSpecEF	A shipyardSpec consists of components: Name - unique key description appliesto=shipyard manufacture builder
SingleValueDescriptionConverter	Will convert XML <description> elements into a description component.
SingleValueEnergyConverter	Will convert XML <ftl> elements into an Amount<Energy> object.
SingleValueMassConverter	Will convert XML <mass> elements into an Amount<Mass> object.
SingleValueMoneyConverter	Will convert XML <money> elements into an Amount<Money> object.
SingleValuePercentConverter	Will convert XML <mass> elements into an Amount<Mass> object.
SingleValueVectorConverter	Convert XML representing coordinates into a vector.
spec	Simple utility class to parse a <spec key="..."> XML element
species	Simple placeholder class for now.
speciesSpec	The essential unchanging physiology of a species.
speciesSpecEF	A speciesSpec has components: Name - unique key description appliesto=faction display
specification	An entity with this component has a specification available and this component points to it.
specLoader	Class that loads all specifications held in XML into java objects.
star	A star has a unique key eg "Sol", type (a stellar spec ) optional description and may have planets associated with it.
starDate	Holds an in-game date (obviously in the far-future!).
starDateDockable	Provides the handler to represent the starDate as a two-width tile.
starEF	A star consists of components: Name - unique key description specification coordinates owner - optional
starEF	A star consists of components: Name - unique key description specification coordinates owner - optional
starmap	A starmap contains the unchanging geographical positions in space of the planets (and other such?) stellar features.
starSpec	The read-only properties of a particular type or classification (eg class "M") of a star.
starSpecEF	A starSpec consists of components: Name - unique key description appliesto=star physical display
starSpecEF	A starSpec consists of components: Name - unique key description appliesto=star physical display
tileDockable
update	Modify the entity repository.
warehouse	Any planet with manufacturing facilities will deliver manufactured equipment into a planet-wide/orbit-wide warehouse.
weapon	Weapon that directs energy to a target to deliver damage.
weaponEF	An weapon consists of components: Name - unique key description specification=weaponSpec health accumulator
weaponEF	An weapon consists of components: Name - unique key description specification=weaponSpec health accumulator
weaponSpec	The read-only blueprint (eg "W01") for a particular type of weapon.
weaponSpecEF	A weaponSpec consists of components: Name - unique key description appliesto=weapon physical manufacture
weaponSpecEF	A weaponSpec consists of components: Name - unique key description appliesto=weapon physical manufacture
windowEvent	A windowEvent is used to broadcast that something of note has happened at the application level such as a change in windows or menu requests.
windowEvent.REASON	List of REASONs for the event, the source should be able to provide the associated data if required.
XMLbase	XML data is parsed by XStream into the appropriate data object.
zAppMenu	Wraps the main application menu, events are handled here and routed through to the JME application.
zExitDialog
zFrame	The top level windowing interface, built using the cookxml library/swing.
zImagePanel	Display an image into a JPanel.
zLoadDialog
zLoadDialog.XMLFileFilter	Allows limiting the dialog to look for XML files
zodiac	Creates, initialises and manages all the globals, subsystems, application states for the game.
zodiac.SingletonHolder	Implements a singleton pattern.
zodiac.ZSTATE	Connects the JME app states, a unique identifier and the finite state machine.
ZodiacDataException	Exception thrown when an anticipated structure in the entity repository isn't followed - usually because the incoming data isnt referentially complete.
ZodiacEntityReference	Annotate a field that will require converting from a its reference to another entity eg "Sol" into a real reference to that entity eg '4'
ZodiacException	Base of Zodiac specific exceptions.
ZodiacInjectException	Exception thrown when an anticipated @Inject is not fullfilled.
zUIDockable	A dockable component is a generic draggable/droppable component to provide the wrapper around a supplied handler.