Index (sola-ecs 2.3.1 API)

A C D E F G H I J O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form

A

activeSystemIterator() - Method in class technology.sola.ecs.SolaEcs
addComponent(Component) - Method in class technology.sola.ecs.Entity: Adds a Component to this Entity.
addSystem(EcsSystem) - Method in class technology.sola.ecs.SolaEcs: Adds an EcsSystem to the collection.
addSystems(EcsSystem...) - Method in class technology.sola.ecs.SolaEcs: Adds EcsSystems to the collection.
afterDeserialize(World) - Method in interface technology.sola.ecs.Component: Called after a World has been deserialized via WorldIo.parse(String).

C

c1() - Method in record class technology.sola.ecs.view.View1Entry: Returns the value of the c1 record component.
c1() - Method in record class technology.sola.ecs.view.View2Entry: Returns the value of the c1 record component.
c1() - Method in record class technology.sola.ecs.view.View3Entry: Returns the value of the c1 record component.
c1() - Method in record class technology.sola.ecs.view.View4Entry: Returns the value of the c1 record component.
c2() - Method in record class technology.sola.ecs.view.View2Entry: Returns the value of the c2 record component.
c2() - Method in record class technology.sola.ecs.view.View3Entry: Returns the value of the c2 record component.
c2() - Method in record class technology.sola.ecs.view.View4Entry: Returns the value of the c2 record component.
c3() - Method in record class technology.sola.ecs.view.View3Entry: Returns the value of the c3 record component.
c3() - Method in record class technology.sola.ecs.view.View4Entry: Returns the value of the c3 record component.
c4() - Method in record class technology.sola.ecs.view.View4Entry: Returns the value of the c4 record component.
Component - Interface in technology.sola.ecs: Holds data for an Entity that can be acted on via an EcsSystem.
componentClasses - Variable in class technology.sola.ecs.cache.ViewImpl: The component classes for the view.
ComponentJsonMapperNotFoundException - Exception in technology.sola.ecs.io.json: Exception thrown when a JsonWorldIo does not have the required JsonMapper for a Component registered to it.
ComponentJsonMapperNotFoundException(String) - Constructor for exception technology.sola.ecs.io.json.ComponentJsonMapperNotFoundException: Creates a new instance of this exception.
components() - Method in record class technology.sola.ecs.view.ViewNEntry: Returns the value of the components record component.
createEntity(String, String, Component...) - Method in class technology.sola.ecs.World: Creates a new Entity inside this World with a set unique id.
createEntity(String, Component...) - Method in class technology.sola.ecs.World: Creates a new Entity inside this World with a random unique id.
createEntity(Component...) - Method in class technology.sola.ecs.World: Creates a new Entity inside this World with a random unique id.
createEntryFromEntity(Entity) - Method in class technology.sola.ecs.cache.ViewImpl: Creates an ViewEntry from a Entity.
createEntryFromEntity(Entity) - Method in class technology.sola.ecs.view.View1
createEntryFromEntity(Entity) - Method in class technology.sola.ecs.view.View2
createEntryFromEntity(Entity) - Method in class technology.sola.ecs.view.View3
createEntryFromEntity(Entity) - Method in class technology.sola.ecs.view.View4
createEntryFromEntity(Entity) - Method in class technology.sola.ecs.view.ViewN
createView() - Method in class technology.sola.ecs.World: Returns a ViewBuilder instance for creating a View of ViewEntry with desired Components
createView(Class<? extends Component>...) - Method in class technology.sola.ecs.cache.ViewCache: Gets a ViewN for the desired component classes from the cache or creates it if it does not exist.
createView(Class<C1>) - Method in class technology.sola.ecs.cache.ViewCache: Gets a View1 for the desired component class from the cache or creates it if it does not exist.
createView(Class<C1>, Class<C2>) - Method in class technology.sola.ecs.cache.ViewCache: Gets a View2 for the desired component classes from the cache or creates it if it does not exist.
createView(Class<C1>, Class<C2>, Class<C3>) - Method in class technology.sola.ecs.cache.ViewCache: Gets a View3 for the desired component classes from the cache or creates it if it does not exist.
createView(Class<C1>, Class<C2>, Class<C3>, Class<C4>) - Method in class technology.sola.ecs.cache.ViewCache: Gets a View4 for the desired component classes from the cache or creates it if it does not exist.

D

destroy() - Method in class technology.sola.ecs.Entity: Queues this Entity for destruction.
destroyView(Class<? extends Component>[]) - Method in class technology.sola.ecs.cache.ViewCache: Destroys a view from the cache so that it no longer will receive any updates.
dropView(Class<? extends Component>...) - Method in class technology.sola.ecs.World: Drops a view with desired Components if it exists.

E

EcsSystem - Class in technology.sola.ecs: Acts on a group of Entity that contain a set of Component.
EcsSystem() - Constructor for class technology.sola.ecs.EcsSystem
EcsSystemNotFoundException - Exception in technology.sola.ecs.exception: Exception thrown when an EcsSystem was not found.
EcsSystemNotFoundException(Class<? extends EcsSystem>) - Constructor for exception technology.sola.ecs.exception.EcsSystemNotFoundException: Creates a new instance of this exception.
entity() - Method in record class technology.sola.ecs.view.View1Entry: Returns the value of the entity record component.
entity() - Method in record class technology.sola.ecs.view.View2Entry: Returns the value of the entity record component.
entity() - Method in record class technology.sola.ecs.view.View3Entry: Returns the value of the entity record component.
entity() - Method in record class technology.sola.ecs.view.View4Entry: Returns the value of the entity record component.
entity() - Method in interface technology.sola.ecs.view.ViewEntry
entity() - Method in record class technology.sola.ecs.view.ViewNEntry: Returns the value of the entity record component.
Entity - Class in technology.sola.ecs: An Entity is identified by its index in the World that ties a set of Components together.
EntityNameCache - Class in technology.sola.ecs.cache: The EntityNameCache class handles caching Entity by their name for quicker searching by name.
EntityNameCache() - Constructor for class technology.sola.ecs.cache.EntityNameCache
equals(Object) - Method in record class technology.sola.ecs.view.View1Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class technology.sola.ecs.view.View2Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class technology.sola.ecs.view.View3Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class technology.sola.ecs.view.View4Entry: Indicates whether some other object is "equal to" this one.
equals(Object) - Method in record class technology.sola.ecs.view.ViewNEntry: Indicates whether some other object is "equal to" this one.

F

findEntitiesWithComponents(Class<? extends Component>...) - Method in class technology.sola.ecs.World: Gets a List of Entity where each Entity has all of the Component classes searched for and is not disabled.
findEntityByName(String) - Method in class technology.sola.ecs.World: Searches for an Entity by its name.
findEntityByUniqueId(String) - Method in class technology.sola.ecs.World: Searches for an Entity by its unique id.

G

get(String) - Method in class technology.sola.ecs.cache.EntityNameCache: Returns the Entity with desired name or null if not found.
getComponent(Class<T>) - Method in class technology.sola.ecs.Entity: Gets a Component instance for the class passed in.
getCurrentCapacity() - Method in class technology.sola.ecs.World: Gets the current capacity of Entity for this world.
getCurrentComponents() - Method in class technology.sola.ecs.Entity: Returns a list of the current Component classes that this entity has.
getEnabledEntities() - Method in class technology.sola.ecs.World: Gets a List of all Entity in the world that are not disabled.
getEntities() - Method in class technology.sola.ecs.World: Gets a List of all Entity in the world even if they are disabled.
getEntityAtIndex(int) - Method in class technology.sola.ecs.World: Gets an Entity by index or null if one is not present.
getEntityCount() - Method in class technology.sola.ecs.World: Gets the current number of Entity in this World.
getEntries() - Method in class technology.sola.ecs.cache.ViewImpl
getEntries() - Method in interface technology.sola.ecs.view.View
getIndexInWorld() - Method in class technology.sola.ecs.Entity: Gets the integer id of this Entity.
getName() - Method in class technology.sola.ecs.Entity: Gets the name of this Entity.
getObjectClass() - Method in class technology.sola.ecs.io.json.WorldJsonMapper
getOrder() - Method in class technology.sola.ecs.EcsSystem: Gets the order of this System.
getSystem(Class<T>) - Method in class technology.sola.ecs.SolaEcs: Returns the EcsSystem corresponding to the passed class.
getSystems() - Method in class technology.sola.ecs.SolaEcs
getUniqueId() - Method in class technology.sola.ecs.Entity: Gets the unique id of this entity that persists through serialization and deserialization.
getWorld() - Method in class technology.sola.ecs.SolaEcs: Returns the World the collection of EcsSystems is currently acting on.

H

hasComponent(Class<T>) - Method in class technology.sola.ecs.Entity: Returns true if this Entity has the Component.
hashCode() - Method in record class technology.sola.ecs.view.View1Entry: Returns a hash code value for this object.
hashCode() - Method in record class technology.sola.ecs.view.View2Entry: Returns a hash code value for this object.
hashCode() - Method in record class technology.sola.ecs.view.View3Entry: Returns a hash code value for this object.
hashCode() - Method in record class technology.sola.ecs.view.View4Entry: Returns a hash code value for this object.
hashCode() - Method in record class technology.sola.ecs.view.ViewNEntry: Returns a hash code value for this object.

I

isActive() - Method in class technology.sola.ecs.EcsSystem: Returns true if this EcsSystem is active.
isDisabled() - Method in class technology.sola.ecs.Entity: Returns whether this Entity should be considered disabled or not.
isWatchingComponent(Class<? extends Component>) - Method in class technology.sola.ecs.cache.ViewImpl: Checks if this view responds to an Entity adding or removing the component type or if an entity is deleted while having the component type.
isWatchingComponent(Class<? extends Component>) - Method in interface technology.sola.ecs.view.View: Checks if this view responds to an Entity adding or removing the component type or if an entity is deleted while having the component type.

J

JsonWorldIo - Class in technology.sola.ecs.io.json: A reflection-free JSON implementation of WorldIo.
JsonWorldIo(List<JsonMapper<? extends Component>>) - Constructor for class technology.sola.ecs.io.json.JsonWorldIo: Creates a new JsonWorldIo instance with desired JsonMappers.

O

of(Class<? extends Component>...) - Method in class technology.sola.ecs.ViewBuilder: Returns a ViewN of entries having N many Components.
of(Class<C1>) - Method in class technology.sola.ecs.ViewBuilder: Returns a View1 of entries having one Component.
of(Class<C1>, Class<C2>) - Method in class technology.sola.ecs.ViewBuilder: Returns a View2 of entries having two Components.
of(Class<C1>, Class<C2>, Class<C3>) - Method in class technology.sola.ecs.ViewBuilder: Returns a View3 of entries having three Components.
of(Class<C1>, Class<C2>, Class<C3>, Class<C4>) - Method in class technology.sola.ecs.ViewBuilder: Returns a View4 of entries having three Components.

P

parse(String) - Method in class technology.sola.ecs.io.json.JsonWorldIo
parse(String) - Method in interface technology.sola.ecs.io.WorldIo: Deserializes a string into a World.
processWorldAfterDeserialize(World) - Static method in interface technology.sola.ecs.io.WorldIo: Loops through each Entity in a World and calls Component.afterDeserialize(World) for each Component of the Entity.

R

remove(String) - Method in class technology.sola.ecs.cache.EntityNameCache: Removes an Entity from the cache by its name.
removeComponent(Class<? extends Component>) - Method in class technology.sola.ecs.Entity: Removes a Component from this Entity.
removeSystem(EcsSystem) - Method in class technology.sola.ecs.SolaEcs: Removed an EcsSystem from the collection.

S

setActive(boolean) - Method in class technology.sola.ecs.EcsSystem: Sets the active state of this EcsSystem.
setDisabled(boolean) - Method in class technology.sola.ecs.Entity: Updates the disabled state of this Entity.
setName(String) - Method in class technology.sola.ecs.Entity: Sets the name of this Entity.
setWorld(World) - Method in class technology.sola.ecs.SolaEcs: Update the World the collection of EcsSystems acts on.
SolaEcs - Class in technology.sola.ecs: SolaEcs is a wrapper for a collection of EcsSystem.
SolaEcs() - Constructor for class technology.sola.ecs.SolaEcs: Creates an empty SolaEcs.
SolaEcs(World, EcsSystem...) - Constructor for class technology.sola.ecs.SolaEcs: Creates a new SolaEcs initialized with a World and EcsSystems.
stringify(World) - Method in class technology.sola.ecs.io.json.JsonWorldIo
stringify(World) - Method in interface technology.sola.ecs.io.WorldIo: Serializes a World into a string.
systemIterator() - Method in class technology.sola.ecs.SolaEcs

T

technology.sola.ecs - module technology.sola.ecs: Defines the sola-ecs API.
technology.sola.ecs - package technology.sola.ecs: This package provides the core classes for sola-ecs.
technology.sola.ecs.cache - package technology.sola.ecs.cache: This package provides class to cache different kinds of queries against World.
technology.sola.ecs.exception - package technology.sola.ecs.exception: This package provides various exceptions for errors that may happen during various sola-ecs operations.
technology.sola.ecs.io - package technology.sola.ecs.io: This package provides the API for serializing and deserializing World.
technology.sola.ecs.io.json - package technology.sola.ecs.io.json: This package provides the JSON implementations for serializing and deserializing World.
technology.sola.ecs.view - package technology.sola.ecs.view: This package provides implementations of View.
toJson(World) - Method in class technology.sola.ecs.io.json.WorldJsonMapper
toObject(JsonObject) - Method in class technology.sola.ecs.io.json.WorldJsonMapper
toString() - Method in record class technology.sola.ecs.view.View1Entry: Returns a string representation of this record class.
toString() - Method in record class technology.sola.ecs.view.View2Entry: Returns a string representation of this record class.
toString() - Method in record class technology.sola.ecs.view.View3Entry: Returns a string representation of this record class.
toString() - Method in record class technology.sola.ecs.view.View4Entry: Returns a string representation of this record class.
toString() - Method in record class technology.sola.ecs.view.ViewNEntry: Returns a string representation of this record class.

U

update() - Method in class technology.sola.ecs.World: Applies all entity mutations that happened during the previous frame.
update(Entity, String) - Method in class technology.sola.ecs.cache.EntityNameCache: Updates the cache for an Entity using its previous name as reference.
update(World, float) - Method in class technology.sola.ecs.EcsSystem: Called to update the state of Components attached to an Entity.
updateForAddComponent(Entity, Class<? extends Component>) - Method in class technology.sola.ecs.cache.ViewCache: Updates cached ViewImpls for an Entity's added Component.
updateForDeletedEntity(Entity) - Method in class technology.sola.ecs.cache.ViewCache: Updates cached ViewImpls for a deleted Entity.
updateForDisabledStateChange(Entity) - Method in class technology.sola.ecs.cache.ViewCache: Updates cached ViewImpls for an Entity that was disabled or enabled.
updateForRemoveComponent(Entity, Class<? extends Component>) - Method in class technology.sola.ecs.cache.ViewCache: Updates cached ViewImpls for an Entity's removed Component.
updateWorld(float) - Method in class technology.sola.ecs.SolaEcs: Called when the World should be updated.

V

View<E extends ViewEntry> - Interface in technology.sola.ecs.view: The View class is a container of ViewEntry that are updated whenever a World updates an Entity's components that now satisfies or no longer satisfies the List of watched Components.
View1<C1 extends Component> - Class in technology.sola.ecs.view: View1 is a ViewImpl implementation for ViewEntry for one Component.
View1(Class<C1>) - Constructor for class technology.sola.ecs.view.View1: Creates an instance of View1.
View1Entry<C1 extends Component> - Record Class in technology.sola.ecs.view: ViewEntry implementation for View1.
View1Entry(Entity, C1) - Constructor for record class technology.sola.ecs.view.View1Entry: Creates an instance of a View1Entry record class.
View2<C1 extends Component,C2 extends Component> - Class in technology.sola.ecs.view: View2 is a ViewImpl implementation for ViewEntry for two Component.
View2(Class<C1>, Class<C2>) - Constructor for class technology.sola.ecs.view.View2: Creates an instance of View2.
View2Entry<C1 extends Component,C2 extends Component> - Record Class in technology.sola.ecs.view: ViewEntry implementation for View2.
View2Entry(Entity, C1, C2) - Constructor for record class technology.sola.ecs.view.View2Entry: Creates an instance of a View2Entry record class.
View3<C1 extends Component,C2 extends Component,C3 extends Component> - Class in technology.sola.ecs.view: View3 is a ViewImpl implementation for ViewEntry for three Component.
View3(Class<C1>, Class<C2>, Class<C3>) - Constructor for class technology.sola.ecs.view.View3: Creates an instance of View3.
View3Entry<C1 extends Component,C2 extends Component,C3 extends Component> - Record Class in technology.sola.ecs.view: ViewEntry implementation for View3.
View3Entry(Entity, C1, C2, C3) - Constructor for record class technology.sola.ecs.view.View3Entry: Creates an instance of a View3Entry record class.
View4<C1 extends Component,C2 extends Component,C3 extends Component,C4 extends Component> - Class in technology.sola.ecs.view: View4 is a ViewImpl implementation for ViewEntry for four Component.
View4(Class<C1>, Class<C2>, Class<C3>, Class<C4>) - Constructor for class technology.sola.ecs.view.View4: Creates an instance of View4.
View4Entry<C1 extends Component,C2 extends Component,C3 extends Component,C4 extends Component> - Record Class in technology.sola.ecs.view: ViewEntry implementation for View4.
View4Entry(Entity, C1, C2, C3, C4) - Constructor for record class technology.sola.ecs.view.View4Entry: Creates an instance of a View4Entry record class.
ViewBuilder - Class in technology.sola.ecs: The ViewBuilder class exposes methods for creating Views.
ViewCache - Class in technology.sola.ecs.cache: The ViewCache classes handles caching and updating ViewImpl instances when Entity modifications are made in a World.
ViewCache(World) - Constructor for class technology.sola.ecs.cache.ViewCache: Creates a ViewCache instance for a World
ViewEntry - Interface in technology.sola.ecs.view: The ViewEntry interface defines the api for an entry in a View.
ViewImpl<E extends ViewEntry> - Class in technology.sola.ecs.cache: The View class is a container of ViewEntry that are updated whenever a World updates an Entity's components that now satisfies or no longer satisfies the List of watched Components.
ViewImpl(List<Class<? extends Component>>) - Constructor for class technology.sola.ecs.cache.ViewImpl: Creates a new view watching desired components.
ViewN - Class in technology.sola.ecs.view: ViewN is a ViewImpl implementation for ViewEntry for N many Components.
ViewN(Class<? extends Component>[]) - Constructor for class technology.sola.ecs.view.ViewN: Creates an instance for desired component classes.
ViewNEntry - Record Class in technology.sola.ecs.view: ViewEntry implementation for ViewN.
ViewNEntry(Entity, List<Component>) - Constructor for record class technology.sola.ecs.view.ViewNEntry: Creates an instance of a ViewNEntry record class.

W

World - Class in technology.sola.ecs: World contains arrays of Components and methods for creating Entity instances and searching for entities.
World(int) - Constructor for class technology.sola.ecs.World: Creates a new World instance with specified initial capacity of Entity.
WorldIo - Interface in technology.sola.ecs.io: Defines the API contract for serializing and deserializing a World.
WorldJsonMapper - Class in technology.sola.ecs.io.json: JsonMapper implementation for World.
WorldJsonMapper(List<JsonMapper<? extends Component>>) - Constructor for class technology.sola.ecs.io.json.WorldJsonMapper: Creates a new JsonWorldIo instance with desired JsonMappers.

A C D E F G H I J O P R S T U V W
All Classes and Interfaces|All Packages|Serialized Form