Interface IEntity

An entity is the most basic unit for composition. On itself it doesn't do anything except be a collection of components. Each added component adds more abilities to the entity. For example, adding a "talk" component to the entity, will give the entity the ability to talk.

Inherited Members

IComponentsCollection.AddComponent<TComponent>()

IComponentsCollection.AddComponent(Type)

IComponentsCollection.AddComponent<TComponent>(IComponent)

IComponentsCollection.RemoveComponent<TComponent>()

IComponentsCollection.RemoveComponent(Type)

IComponentsCollection.RemoveComponent(IComponent)

IComponentsCollection.PopComponent<TComponent>()

IComponentsCollection.HasComponent<TComponent>()

IComponentsCollection.HasComponent(Type)

IComponentsCollection.HasComponent(IComponent)

IComponentsCollection.GetComponent<TComponent>()

IComponentsCollection.GetComponent(Type)

IComponentsCollection.Bind<TComponent>(Action<TComponent>, Action<TComponent>)

IComponentsCollection.Count

IComponentsCollection.ComponentsInitialized

IComponentsCollection.OnComponentsInitialized

IComponentsCollection.OnComponentsChanged

IComponentsCollection.OnDisposed(Action)

System.Collections.Generic.IEnumerable<AGS.API.IComponent>.GetEnumerator()

System.IDisposable.Dispose()

Namespace: AGS.API

Assembly: AGS.API.dll

Syntax

public interface IEntity : IComponentsCollection, IEnumerable<IComponent>, IEnumerable, IDisposable

Properties

DisplayName

A human-readable name. This string could be used to display entity's name to players.

Declaration

string DisplayName { get; set; }

Property Value

Type	Description
System.String	The name.

ID

A unique identifier for the entity. This id is used by the engine to distinguish between different entities, so the id must be unique.

Declaration

string ID { get; }

Property Value

Type	Description
System.String	The identifier.

Methods

GetFriendlyName()

Returns a human-readable name of an entity, either taken from DisplayName or composed from other properties.

Declaration

string GetFriendlyName()

Returns

Type	Description
System.String	The name.