Package name.moore.kevin.ze.entities

package name.moore.kevin.ze.entities

Provide processing and constants for creating specific types of entities.

The actual entities are stored in the entity repository. The classes in this package provide a factory pattern to create those data entities with their correct components.

All these processors end in "EF.java" (Entity Factory), and extend the abstract baseEF. The interface to the package is through the entityFactory class which will make an appropriate entityFactory which is then used to build the required entity.

Examples

Create a new 'ship' entity in the repository with specification EntityId s

engineEF proc = entityFactory.make(ship.class);
List<EntityComponent> toComponents = proc.toComponents(s);
EntityId built = eq.newEntity(toComponents);

Author:

Kevin Moore <dev@kevin.moore.name>

See Also:

name.moore.kevin.ze.components, Entity System Introduction

Class Summary

Class	Description
baseEF	Factories produce entities in the entity repository.
engineEF	Engines provide power according to their specification and health.
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.
factionEF	A faction has components: Name - unique key description specification politics
hasher	Create unique String hashcodes we can use in things like equipment serial numbers.
hullEF	A hull consists of components: Name - unique key description specification=hullSpec health accumulator
hullSpecEF	A hullSpec consists of components: Name - unique key description appliesto=hull physical manufacture
industryEF	A industry consists of components: Name - unique key description specification=industrySpec location
industrySpecEF	A industrySpec consists of components: Name - unique key description appliesto=industry manufacture builder
planetEF	A planet consists of components: Name - unique key description specification inorbit
planetSpecEF	A planetSpec consists of components: Name - unique key description appliesto=planet physical display
shieldEF	A shield consists of components: Name - unique key description specification=shieldSpec health accumulator
shieldSpecEF	A shieldSpec consists of components: Name - unique key description appliesto=shield physical manufacture
shipEF	A ship consists of components: Name - unique key description specification=shipSpec inorbit or coordinates parts - List of EntityId of installed equipment distribution
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
shipyardEF	A shipyard consists of components: Name - unique key description specification=shipyardSpec inorbit
shipyardSpecEF	A shipyardSpec consists of components: Name - unique key description appliesto=shipyard manufacture builder
speciesSpecEF	A speciesSpec has components: Name - unique key description appliesto=faction display
starEF	A star consists of components: Name - unique key description specification coordinates owner - optional
starSpecEF	A starSpec consists of components: Name - unique key description appliesto=star physical display
weaponEF	An weapon consists of components: Name - unique key description specification=weaponSpec health accumulator
weaponSpecEF	A weaponSpec consists of components: Name - unique key description appliesto=weapon physical manufacture

Enum Summary

Enum	Description
entityFactory.FACTORY	Identify which type of factories we want.