Entish Docs (35% documented)

Entish Reference EntityController Class Reference

EntityController

Manages a set of game systems that implement the ISystem protocol and the Entity objects that interact with those systems.

  • registeredSystems

    Undocumented

  • entities

    Undocumented

  • systems

    Undocumented

  • entityFactory

    Undocumented

  • Signals

    Undocumented

    See more
  • signals

    A struct containing the subscribable signals published by the controller.

    Declaration

    Swift

    public var signals = Signals()
  • init()

    The designated initializer.

    Declaration

    Swift

    public init()
  • configure(_:)

    Initializes parameters from a loaded Config object. You must call configure() before any attempting to build any Entity objects, as the configuration contains the templates used to instantiate your entities.

    Declaration

    Swift

    public func configure(config:Config)

    Parameters

    config

    a Config object containing Entity templates
  • createEntity(template:)

    Creates a new Entity from the configuration template named by the template argument. The entity’s components are all automatically instantiated and added to their respective systems.

    Declaration

    Swift

    public func createEntity(#template:String) -> Result<Entity.EntityID>

    Parameters

    template

    The name of the template from which to instantiate the new Entity.

    Return Value

    The uuid of the new Entity.

  • addEntity(_:withComponents:)

    Adds the given entity to the controller and passes its components to their respective registered systems.

    Declaration

    Swift

    public func addEntity (entity:Entity, withComponents components: [IComponent]) -> Result<Void>
  • removeEntity(_:)

    Removes the entity with the given ID from the controller and from all registered systems that it interacts with.

    Declaration

    Swift

    public func removeEntity(entityID:EntityID) -> Entity?
  • entitiesWithAllComponents(_:)

    Returns an array containing all entities that contain all of the component types specified by the components bitmask.

    Declaration

    Swift

    public func entitiesWithAllComponents (components: Bitmask<Systems>) -> [Entity]
  • entitiesWithAnyComponents(_:)

    Returns an array containing all entities that contain any of the component types specified by the components bitmask.

    Declaration

    Swift

    public func entitiesWithAnyComponents (components: Bitmask<Systems>) -> [Entity]
  • registerSystem(_:)

    Registers the provided system with the controller. All systems must be registered before any entities that use them are created.

    Declaration

    Swift

    public func registerSystem(system:ISystem)
  • unregisterSystemWithID(_:)

    Unregisters the system with the given ID, if one exists.

    Declaration

    Swift

    public func unregisterSystemWithID(systemID:Systems) -> ISystem?

    Return Value

    The unregistered system, or nil if none was found.

  • update(_:)

    Scene loop update method. Call this from your scene’s update() method. It updates all entities and systems that are currently registered with the controller.

    Declaration

    Swift

    public func update(currentTime:NSTimeInterval)