Genesis.Entity (genesis v0.10.0)

Copy Markdown View Source

A struct that represents an entity and contains information about its origin. In essence, an entity is simply a unique identifier (reference) that exists within a specific context. An entity holds information about the world and context it belongs to, along with a unique identification hash.

Fields

  • :ref - the unique reference for this entity
  • :context - the context where the entity lives
  • :world - the world the entity was instantiated on
  • :hash - a checksum that represents the entity's identity
  • :name - the name the entity was registered with
  • :parent - the entity this was cloned from

Summary

Types

context()
t()

Functions

child?(entity)

Returns true when the entity is a child of another entity.

colocated?(entity1, entity2)

Returns true when two entities share the same context.

equal?(entity1, entity2)

Returns true when two entities represent the same identity.

local?(entity)

Returns true when the entity was created on this node.

named?(entity)

Returns true when the entity has a name.

new(opts)

Creates a new entity.

prefab?(entity)

Returns true when the entity is a prefab.

Types

context()

@type context() :: pid() | atom()

t()

@type t() :: %Genesis.Entity{
  context: context(),
  hash: binary(),
  name: binary() | nil,
  parent: t() | nil,
  ref: reference(),
  world: pid() | nil
}

Functions

child?(entity)

Returns true when the entity is a child of another entity.

colocated?(entity1, entity2)

Returns true when two entities share the same context.

equal?(entity1, entity2)

Returns true when two entities represent the same identity.

local?(entity)

Returns true when the entity was created on this node.

named?(entity)

Returns true when the entity has a name.

new(opts)

Creates a new entity.

Options:

  • :context - the context PID where the entity lives (required)
  • :world - the world GenServer PID if entity belongs to a world (optional)
  • :name - an optional name for the entity (optional)
  • :parent - the parent entity this was cloned from (optional)

prefab?(entity)

Returns true when the entity is a prefab.