Entity

Require

If the concord folder is in the root directory of your game, you can import this module like so:

concord.entity = require('concord.entity')

Entity

contains components which are processed by systems.

Fields

Name	Type	Description
has	fun(self: Entity, name: string): boolean
remove	fun(self: Entity, name: string): Entity

Private fields

Name	Type	Description
__world?	World

new

Creates a new Entity. Optionally queues it to be added to a World.

If Entity.SERIALIZE_BY_DEFAULT is true, the Entity is given a “serializable” Component.

entity = Entity.new( world )

Arguments

Name	Type	Description
world	World	World to add the entity to

Returns

Name	Type	Description
entity	Entity

give

Gives an Entity a Component.

If the Component already exists, it’s overridden by this new Component.

entity:give( name, ... )

Arguments

Name	Type	Description
name	string	Name of the ComponentClass
...	any	Additional arguments to pass to the Component’s populate function

Returns

Name	Type	Description
	Entity

---

entity:give( component )

Pass an existing Component instance (already populated, not attached to an entity). Skips name and populate arguments.

Arguments

Name	Type	Description
component	Component

ensure

Ensures an Entity has a Component.

If the Component already exists, no action is taken.

entity:ensure( name, ... )

Arguments

Name	Type	Description
name	string	Name of the ComponentClass
...	any	Additional arguments to pass to the Component’s populate function

Returns

Name	Type	Description
	Entity

---

entity:ensure( component )

Pass an existing Component instance (already populated, not attached to an entity). Skips name and populate arguments.

Arguments

Name	Type	Description
component	Component

remove

Removes a Component from an Entity.

entity:remove( name )

Arguments

Name	Type	Description
name	string	Name of the ComponentClass to remove

Returns

Name	Type	Description
	Entity

assemble

Assembles an Entity.

entity:assemble( assemblage, ... )

Arguments

Name	Type	Description
assemblage	fun(entity: Entity, …)	Function that will assemble an entity
...	any	Additional arguments to pass to the assemblage function.

Returns

Name	Type	Description
	Entity

destroy

Destroys the Entity.

Queues removal from its World if it’s in one. The Entity stays in the World until the next flush.

entity:destroy()

Returns

Name	Type	Description
	Entity

has

Returns true if the Entity has a Component.

boolean = entity:has( name )

Arguments

Name	Type	Description
name	string	Name of the ComponentClass to check

Returns

Name	Type	Description
boolean	boolean

get

Gets a Component from the Entity.

entity:get( name )

Arguments

Name	Type	Description
name	string	Name of the ComponentClass to get

Returns

Name	Type	Description
	Component|nil	The Component, or nil if the Entity does not have it

getComponents

Returns a shallow copy of the Entity’s fields, excluding __world and __isEntity.

This is primarily the Entity’s Components. Extra non-component fields are also copied. Mutating a copied Component still mutates the Entity’s Component.

matches = entity:getComponents( output )

Arguments

Name	Type	Description
output	table	Table to copy into. A new table is created if omitted.

Returns

Name	Type	Description
matches	table

inWorld

Returns true if the Entity has been assigned a World.

True as soon as addition is queued, and remains true until removal is flushed.

boolean = entity:inWorld()

Returns

Name	Type	Description
boolean	boolean

getWorld

Returns the World the Entity is in.

world = entity:getWorld()

Returns

Name	Type	Description
world	World

serialize

Serializes the Entity’s Components.

Components that return nil from serialize are omitted.

matches = entity:serialize( ignoreKey )

Arguments

Name	Type	Description
ignoreKey	boolean	If true, the key Component is omitted

Returns

Name	Type	Description
matches	table	Serialized Entity data

deserialize

Deserializes Components onto the Entity.

entity:deserialize( data )

Arguments

Name	Type	Description
data	table	Serialized Entity data