Home

Types

• DynamicCodingKey
• ComponentIdentifier: Identifies a component by it's meta type
• Entity: Entity
• Entity.ComponentsIterator
• EntityIdentifier: EntityIdentifier
• LinearIncrementingEntityIdGenerator: Linear incrementing entity id generator
• ComponentInstanceProvider: This component provider always returns the same instance of the component. The instance is passed to the provider at initialisation.
• ComponentTypeProvider: This component provider always returns a new instance of a component. An instance is created when requested and is of the type passed in to the initializer.
• ComponentSingletonProvider: This component provider always returns the same instance of the component. The instance is created when first required and is of the type passed in to the initializer.
• DynamicComponentProvider: This component provider calls a function to get the component instance. The function must return a single component of the appropriate type.
• DynamicComponentProvider.Closure: Wrapper for closure to make it hashable via ObjectIdentifier
• EntityState: Represents a state for an EntityStateMachine. The state contains any number of ComponentProviders which are used to add components to the entity when this state is entered.
• StateComponentMapping: Used by the EntityState class to create the mappings of components to providers via a fluent interface.
• EntityStateMachine: This is a state machine for an entity. The state machine manages a set of states, each of which has a set of component providers. When the state machine changes the state, it removes components associated with the previous state and adds components associated with the new state.
• Family
• Family.ComponentsIterator
• Family.EntityIterator
• Family.EntityComponentIterator
• FamilyMemberBuilderPreview
• FamilyTraitSet
• Requires1
• Requires2
• Requires3
• Requires4
• Requires5
• Requires6
• Requires7
• Requires8
• StringHashing: https://stackoverflow.com/a/52440609
• ManagedContiguousArray
• ComponentsBuilderPreview
• ComponentsBuilder.Context
• Nexus.EntitiesIterator
• Nexus
• DefaultCodingStrategy
• EntityCreated
• EntityDestroyed
• ComponentAdded
• ComponentRemoved
• FamilyMemberAdded
• FamilyMemberRemoved
• Single
• UnorderedSparseSet: An (unordered) sparse set.
• UnorderedSparseSet.ElementIterator

Protocols

• CodingStrategy
• Component: Component
• EntityIdentifierGenerator: Entity Identifier Generator
• DefaultInitializable: Requires initializer with default values. In case of component - makes sure it can be instantiated by component provider
• ComponentProvider: This is the Interface for component providers. Component providers are used to supply components for states within an EntityStateMachine. FirebladeECS includes three standard component providers, ComponentTypeProvider, ComponentInstanceProvider and ComponentSingletonProvider. Developers may wish to create more.
• TopLevelEncoder
• TopLevelDecoder
• FamilyDecoding
• FamilyEncoding
• FamilyRequirementsManaging
• RequiringComponents1
• RequiringComponents2
• RequiringComponents3
• RequiringComponents4
• RequiringComponents5
• RequiringComponents6
• RequiringComponents7
• RequiringComponents8
• NexusEvent
• NexusEventDelegate
• SingleComponent

Global Typealiases

• DefaultEntityIdGenerator: A default entity identifier generator implementation.
• ComponentInitializable
• FamilyMemberBuilder
• Family1
• Family2
• Family3
• Family4
• Family5
• Family6
• Family7
• Family8
• EntityComponentHash: entity id ^ component identifier hash
• ComponentTypeHash: component object identifier hash value
• ComponentsBuilder

Global Functions

• hash(combine:​_:​): Calculates the combined hash of two values. This implementation is based on boost::hash_combine. Will always produce the same result for the same combination of seed and value during the single run of a program.
• hash(combine:​): Calculates the combined hash value of the elements. This implementation is based on boost::hash_range. Is sensitive to the order of the elements.