Struct Entity
- Namespace
- Frent
- Assembly
- Frent.dll
An Entity reference; refers to a collection of components of unqiue types.
public struct Entity : IEquatable<Entity>- Implements
- Inherited Members
- Extension Methods
Constructors
Entity()
public Entity()Remarks
Entity generally shouldn't manually constructed
Properties
ArchetypicalComponentTypes
Gets the archetypical component types for this entity.
public readonly ImmutableArray<ComponentID> ArchetypicalComponentTypes { get; }Property Value
Exceptions
- InvalidOperationException
Entity is dead.
ComponentTypes
Gets all the component types for this entity.
public readonly ImmutableArray<ComponentID> ComponentTypes { get; }Property Value
Exceptions
- InvalidOperationException
Entity is dead.
IsAlive
Checks to see if this Entity is still alive
public readonly bool IsAlive { get; }Property Value
IsNull
public readonly bool IsNull { get; }Property Value
Null
The null entity
public static Entity Null { get; }Property Value
OnComponentAddedGeneric
Raised when a component is added to an entity, with the generic parameter
public readonly GenericEvent? OnComponentAddedGeneric { get; set; }Property Value
OnComponentRemovedGeneric
Raised when a component is removed to an entity, with the generic parameter
public readonly GenericEvent? OnComponentRemovedGeneric { get; set; }Property Value
TagTypes
Gets tags the entity has
public readonly ImmutableArray<TagID> TagTypes { get; }Property Value
Exceptions
- InvalidOperationException
Entity is dead.
Type
The EntityType of this Entity.
public readonly EntityType Type { get; }Property Value
World
Gets the world this entity belongs to
public readonly World World { get; }Property Value
Exceptions
- InvalidOperationException
Entity is dead.
Methods
AddAs(ComponentID, object)
Adds a component to this Entity, as a specific component type.
public readonly void AddAs(ComponentID componentID, object component)Parameters
componentIDComponentIDThe component type to add as.
componentobjectThe component to add.
Exceptions
- InvalidCastException
componentis not assignable to the type represented bycomponentID.
AddAs(Type, object)
Add a component to an Entity
public readonly void AddAs(Type type, object component)Parameters
typeTypeThe type to add the component as. Note that a component of type DerivedClass and BaseClass are different component types.
componentobjectThe component to add
AddBoxed(object)
Adds a component to this Entity as its own type
public readonly void AddBoxed(object component)Parameters
componentobjectThe component, which could be boxed
AddFromHandles(params ReadOnlySpan<ComponentHandle>)
Adds a set of components copied from component handles.
public readonly void AddFromHandles(params ReadOnlySpan<ComponentHandle> componentHandles)Parameters
componentHandlesReadOnlySpan<ComponentHandle>The handles to copy components from.
Exceptions
- ArgumentException
If adding
componentHandles.Length.Lengthcomponents will result in more than the maximum allowed commponent count.
Add<T>(in T)
Adds a component to this Entity.
public void Add<T>(in T c1)Parameters
c1T
Type Parameters
T
Remarks
If the world is being updated, changed are deffered to the end of the world update.
Delete()
Deletes this entity
public readonly void Delete()Detach(TagID)
Removes a tag from this Entity. Tags are like components but do not take up extra memory.
public readonly bool Detach(TagID tagID)Parameters
tagIDTagIDThe type of tag to remove.
Returns
Exceptions
- InvalidOperationException
Entity is dead.
Detach(Type)
Removes a tag from this Entity. Tags are like components but do not take up extra memory.
public readonly bool Detach(Type type)Parameters
typeTypeThe type of tag to remove.
Returns
Exceptions
- InvalidOperationException
Entity is dead.
Detach<T>()
Removes a tag from this Entity
public void Detach<T>()Type Parameters
T
Remarks
If the world is being updated, changed are deffered to the end of the world update.
EnumerateComponents(IGenericAction)
Enumerates all components one by one
public readonly void EnumerateComponents(IGenericAction onEach)Parameters
onEachIGenericActionThe unbound generic function called on each item
EnumerateIncomingWithEntities(LinkID)
Enumerates every Entity that links to this one with a link of type TLink.
public readonly EntityLinkEnumerator.Enumerable EnumerateIncomingWithEntities(LinkID linkID)Parameters
linkIDLinkIDThe kind of link to enumerate.
Returns
Exceptions
- InvalidOperationException
This Entity is dead.
EnumerateIncomingWithEntities<TLink>()
Enumerates every Entity that links to this one with a link of type TLink.
public readonly EntityLinkEnumerator.Enumerable EnumerateIncomingWithEntities<TLink>()Returns
Type Parameters
TLinkThe type of link to enumerate.
Exceptions
- InvalidOperationException
This Entity is dead.
EnumerateIncomingWithEntities<T>(LinkID)
Enumerates every Entity that links to this one with a link of type TLink, along with their components.
public readonly EntityLinkEnumerator<T>.Enumerable EnumerateIncomingWithEntities<T>(LinkID linkID)Parameters
linkIDLinkIDThe kind of link to enumerate.
Returns
Type Parameters
T
Remarks
Linked entities that do not have every enumerated component are skipped.
EnumerateIncomingWithEntities<TLink, T>()
Enumerates every Entity that links to this one with a link of type TLink, along with their components.
public readonly EntityLinkEnumerator<T>.Enumerable EnumerateIncomingWithEntities<TLink, T>()Returns
Type Parameters
TLinkT
Remarks
Linked entities that do not have every enumerated component are skipped.
EnumerateIncoming<T>(LinkID)
Enumerates the components of every Entity that links to this one with a link of type TLink.
public readonly LinkEnumerable<T> EnumerateIncoming<T>(LinkID linkID)Parameters
linkIDLinkIDThe kind of link to enumerate.
Returns
Type Parameters
T
Remarks
Linked entities that do not have every enumerated component are skipped.
EnumerateIncoming<TLink, T>()
Enumerates the components of every Entity that links to this one with a link of type TLink.
public readonly LinkEnumerable<T> EnumerateIncoming<TLink, T>()Returns
Type Parameters
TLinkT
Remarks
Linked entities that do not have every enumerated component are skipped.
EnumerateOutgoingWithEntities(LinkID)
Enumerates every Entity this one links to with a link of type TLink.
public readonly EntityLinkEnumerator.Enumerable EnumerateOutgoingWithEntities(LinkID linkID)Parameters
linkIDLinkIDThe kind of link to enumerate.
Returns
Exceptions
- InvalidOperationException
This Entity is dead.
EnumerateOutgoingWithEntities<TLink>()
Enumerates every Entity this one links to with a link of type TLink.
public readonly EntityLinkEnumerator.Enumerable EnumerateOutgoingWithEntities<TLink>()Returns
Type Parameters
TLinkThe type of link to enumerate.
Exceptions
- InvalidOperationException
This Entity is dead.
EnumerateOutgoingWithEntities<T>(LinkID)
Enumerates every Entity this one links to with a link of type TLink, along with their components.
public readonly EntityLinkEnumerator<T>.Enumerable EnumerateOutgoingWithEntities<T>(LinkID linkID)Parameters
linkIDLinkIDThe kind of link to enumerate.
Returns
Type Parameters
T
Remarks
Linked entities that do not have every enumerated component are skipped.
EnumerateOutgoingWithEntities<TLink, T>()
Enumerates every Entity this one links to with a link of type TLink, along with their components.
public readonly EntityLinkEnumerator<T>.Enumerable EnumerateOutgoingWithEntities<TLink, T>()Returns
Type Parameters
TLinkT
Remarks
Linked entities that do not have every enumerated component are skipped.
EnumerateOutgoing<T>(LinkID)
Enumerates the components of every Entity this one links to with a link of type TLink.
public readonly LinkEnumerable<T> EnumerateOutgoing<T>(LinkID linkID)Parameters
linkIDLinkIDThe kind of link to enumerate.
Returns
Type Parameters
T
Remarks
Linked entities that do not have every enumerated component are skipped.
EnumerateOutgoing<TLink, T>()
Enumerates the components of every Entity this one links to with a link of type TLink.
public readonly LinkEnumerable<T> EnumerateOutgoing<TLink, T>()Returns
Type Parameters
TLinkT
Remarks
Linked entities that do not have every enumerated component are skipped.
Equals(Entity)
public bool Equals(Entity other)Parameters
otherEntityThe entity to compare with the current entity.
Returns
Equals(object?)
Determines whether the specified object is equal to the current Entity.
public override bool Equals(object? obj)Parameters
objobjectThe object to compare with the current entity.
Returns
- bool
true if the specified object is an Entity and is equal to the current entity; otherwise, false.
Get(ComponentID)
Gets this Entity's component of type id.
public readonly object Get(ComponentID id)Parameters
idComponentIDThe ID of the type of component to get
Returns
- object
The boxed component.
Exceptions
- InvalidOperationException
Entity is dead.
- ComponentNotFoundException
Entity does not have component of type
id.
Get(Type)
Gets this Entity's component of type type.
public readonly object Get(Type type)Parameters
typeTypeThe type of component to get
Returns
- object
The component of type
type
Exceptions
- InvalidOperationException
Entity is dead.
- ComponentNotFoundException
Entity does not have component of type
type.
GetEnumerator()
Gets a Entity.EntityComponentIDEnumerator that can be used to enumerate all component types on this entity.
public readonly Entity.EntityComponentIDEnumerator GetEnumerator()Returns
Remarks
Can be used to enumerate sparse and archetypical component types without allocating.
GetHashCode()
Serves as the default hash function.
public override int GetHashCode()Returns
Get<T>()
Gets this Entity's component of type T.
public readonly ref T Get<T>()Returns
- T
A reference to the component in memory.
Type Parameters
TThe type of component.
Remarks
The returned reference could become invalid after a structural change to a world.
Exceptions
- InvalidOperationException
Entity is dead.
- NullReferenceException
Entity does not have component of type
T.
Has(ComponentID)
Checks of this Entity has a component specified by componentID.
public readonly bool Has(ComponentID componentID)Parameters
componentIDComponentIDThe component ID of the component type to check.
Returns
Has(Type)
Checks to see if this Entity has a component of Type type.
public readonly bool Has(Type type)Parameters
typeTypeThe component type to check if this entity has.
Returns
HasIncomingLink(LinkID)
Checks whether anything links to this Entity with a link of type T.
public readonly bool HasIncomingLink(LinkID linkKind)Parameters
linkKindLinkIDThe kind of link to check for.
Returns
Exceptions
- InvalidOperationException
This Entity is dead.
HasIncomingLink<T>()
Checks whether anything links to this Entity with a link of type T.
public readonly bool HasIncomingLink<T>()Returns
Type Parameters
TThe type of link to check for.
Exceptions
- InvalidOperationException
This Entity is dead.
HasOutgoingLink(LinkID)
Checks whether this Entity links to anything with a link of type T.
public readonly bool HasOutgoingLink(LinkID linkKind)Parameters
linkKindLinkIDThe kind of link to check for.
Returns
Exceptions
- InvalidOperationException
This Entity is dead.
HasOutgoingLink(LinkID, Entity)
Checks whether this Entity links to target with a link of type T.
public readonly bool HasOutgoingLink(LinkID linkKind, Entity target)Parameters
Returns
Remarks
There is no incoming counterpart taking an Entity, since links are stored in both directions:
ask whether source links to this Entity with source.HasOutgoingLink<T>(this).
Exceptions
- InvalidOperationException
Either Entity is dead.
- ArgumentException
The entities belong to different worlds.
HasOutgoingLink<T>()
Checks whether this Entity links to anything with a link of type T.
public readonly bool HasOutgoingLink<T>()Returns
Type Parameters
TThe type of link to check for.
Exceptions
- InvalidOperationException
This Entity is dead.
HasOutgoingLink<T>(Entity)
Checks whether this Entity links to target with a link of type T.
public readonly bool HasOutgoingLink<T>(Entity target)Parameters
Returns
Type Parameters
TThe type of link to check for.
Remarks
There is no incoming counterpart taking an Entity, since links are stored in both directions:
ask whether source links to this Entity with source.HasOutgoingLink<T>(this).
Exceptions
- InvalidOperationException
Either Entity is dead.
- ArgumentException
The entities belong to different worlds.
Has<T>()
Checks to see if this Entity has a component of Type T.
public readonly bool Has<T>()Returns
Type Parameters
TThe type of component to check.
Link(LinkID, Entity)
Links from this Entity outgoing to target with a link of kind linkKind.
public readonly void Link(LinkID linkKind, Entity target)Parameters
Exceptions
- InvalidOperationException
Either Entity is dead, they belong to different worlds, or the link already exists.
Link<T>(Entity)
Links from this Entity outgoing to target of type T.
public readonly void Link<T>(Entity target)Parameters
Type Parameters
TThe type of link to create.
Exceptions
- InvalidOperationException
Either Entity is dead, they belong to different worlds, or the link already exists.
Remove(ComponentID)
Removes a component from this entity
public readonly void Remove(ComponentID componentID)Parameters
componentIDComponentIDThe ComponentID of the component to be removed
Remove(Type)
Removes a component from an Entity
public readonly void Remove(Type type)Parameters
typeTypeThe type of component to remove
Exceptions
- InvalidOperationException
Entity is dead.
- ComponentNotFoundException
Entity does not have component of type
type.
Remove<T>()
Removes a component from this Entity
public void Remove<T>()Type Parameters
T
Remarks
If the world is being updated, changed are deffered to the end of the world update.
Set(ComponentID, object)
Gets this Entity's component of type id.
public readonly void Set(ComponentID id, object obj)Parameters
idComponentIDThe ID of the type of component to get
objobjectThe component to set
Exceptions
- InvalidOperationException
Entity is dead.
- ComponentNotFoundException
Entity does not have component of type
id.
Set(Type, object)
Gets this Entity's component of type type.
public readonly void Set(Type type, object obj)Parameters
Exceptions
- InvalidOperationException
Entity is dead.
- ComponentNotFoundException
Entity does not have component of type
type.
Tag(TagID)
Adds a tag to this Entity. Tags are like components but do not take up extra memory.
public readonly bool Tag(TagID tagID)Parameters
tagIDTagIDThe tagID to use as the tag
Returns
Remarks
Prefer the Tag(TagID) or Tag<T>() overloads. Use ID to get a TagID instance
Exceptions
- InvalidOperationException
Entity is dead.
Tag(Type)
Adds a tag to this Entity. Tags are like components but do not take up extra memory.
public readonly bool Tag(Type type)Parameters
typeTypeThe type to use as a tag
Returns
Exceptions
- InvalidOperationException
Entity is dead.
TagFromIDs(ReadOnlySpan<TagID>)
Adds a set of tags to this entity.
public readonly void TagFromIDs(ReadOnlySpan<TagID> tagIds)Parameters
tagIdsReadOnlySpan<TagID>The tag types to add.
Remarks
You can get a TagID by using TagTypes or GetTagID(Type)
Tag<T>()
Adds a tag to this Entity
public void Tag<T>()Type Parameters
T
Remarks
If the world is being updated, changed are deffered to the end of the world update.
Tagged(TagID)
public readonly bool Tagged(TagID tagID)Parameters
tagIDTagIDThe identifier of the tag to check.
Returns
Exceptions
- InvalidOperationException
Thrown if the Entity is not alive.
Tagged(Type)
public readonly bool Tagged(Type type)Parameters
Returns
Remarks
Prefer the Tagged(TagID) or Tagged<T>() overloads. Use ID to get a TagID instance
Exceptions
- InvalidOperationException
Thrown if the Entity not alive.
Tagged<T>()
Checks whether this Entity has a specific tag, using a generic type parameter to represent the tag.
public readonly bool Tagged<T>()Returns
Type Parameters
TThe type used as the tag.
Exceptions
- InvalidOperationException
Thrown if the Entity is not alive.
TryGet(Type, out object?)
Attempts to get a component from an Entity.
public readonly bool TryGet(Type type, out object? value)Parameters
typeTypeThe type of component to try and get
valueobjectA wrapper over a reference to the component when true.
Returns
TryGet<T>(out Ref<T>)
Attempts to get a component from an Entity.
public readonly bool TryGet<T>(out Ref<T> value)Parameters
Returns
Type Parameters
TThe type of component.
Remarks
When this method returns true, value points directly into component storage. Treat it as invalid after a
structural change in the same World and retrieve the component again.
TryHas(ComponentID)
Checks of this Entity has a component specified by componentID without throwing when dead.
public readonly bool TryHas(ComponentID componentID)Parameters
componentIDComponentIDThe component ID of the component type to check.
Returns
TryHas(Type)
Checks of this Entity has a component specified by type without throwing when dead.
public readonly bool TryHas(Type type)Parameters
typeTypeThe type of the component type to check.
Returns
TryHasIncomingLink(LinkID)
Checks whether anything links to this Entity with a link of type T, without throwing when dead.
public readonly bool TryHasIncomingLink(LinkID linkKind)Parameters
linkKindLinkIDThe kind of link to check for.
Returns
- bool
true when this Entity is alive and is the target of at least one link of type
T, otherwise false.
TryHasIncomingLink<T>()
Checks whether anything links to this Entity with a link of type T, without throwing when dead.
public readonly bool TryHasIncomingLink<T>()Returns
- bool
true when this Entity is alive and is the target of at least one link of type
T, otherwise false.
Type Parameters
TThe type of link to check for.
TryHasOutgoingLink(LinkID)
Checks whether this Entity links to anything with a link of type T, without throwing when dead.
public readonly bool TryHasOutgoingLink(LinkID linkKind)Parameters
linkKindLinkIDThe kind of link to check for.
Returns
- bool
true when this Entity is alive and is the source of at least one link of type
T, otherwise false.
TryHasOutgoingLink(LinkID, Entity)
Checks whether this Entity links to target with a link of type T, without throwing when dead.
public readonly bool TryHasOutgoingLink(LinkID linkKind, Entity target)Parameters
Returns
- bool
true when both entities are alive and a link of type
Tgoes from this Entity totarget, otherwise false.
Remarks
There is no incoming counterpart taking an Entity, since links are stored in both directions:
ask whether source links to this Entity with source.HasOutgoingLink<T>(this).
TryHasOutgoingLink<T>()
Checks whether this Entity links to anything with a link of type T, without throwing when dead.
public readonly bool TryHasOutgoingLink<T>()Returns
- bool
true when this Entity is alive and is the source of at least one link of type
T, otherwise false.
Type Parameters
TThe type of link to check for.
TryHasOutgoingLink<T>(Entity)
Checks whether this Entity links to target with a link of type T, without throwing when dead.
public readonly bool TryHasOutgoingLink<T>(Entity target)Parameters
Returns
- bool
true when both entities are alive and a link of type
Tgoes from this Entity totarget, otherwise false.
Type Parameters
TThe type of link to check for.
Remarks
There is no incoming counterpart taking an Entity, since links are stored in both directions:
ask whether source links to this Entity with source.HasOutgoingLink<T>(this).
TryHas<T>()
Checks of this Entity has a component specified by T without throwing when dead.
public readonly bool TryHas<T>()Returns
Type Parameters
TThe type of component to check.
TryLink(LinkID, Entity)
Links from this Entity outgoing to target with a link of kind linkKind, if it is possible to do so.
public readonly bool TryLink(LinkID linkKind, Entity target)Parameters
Returns
- bool
true when the link was created, false when either Entity is dead, they belong to different worlds, or the link already exists.
TryLink<T>(Entity)
Links from this Entity outgoing to target of type T, if it is possible to do so.
public readonly bool TryLink<T>(Entity target)Parameters
Returns
- bool
true when the link was created, false when either Entity is dead, they belong to different worlds, or the link already exists.
Type Parameters
TThe type of link to create.
TryUnlink(LinkID, Entity)
Removes the outgoing link of kind linkKind from this Entity to target, if it exists.
public readonly bool TryUnlink(LinkID linkKind, Entity target)Parameters
Returns
- bool
true when the link was removed, false when either Entity is dead, they belong to different worlds, or the link does not exist.
TryUnlink<T>(Entity)
Removes the outgoing link of type T from this Entity to target, if it exists.
public readonly bool TryUnlink<T>(Entity target)Parameters
Returns
- bool
true when the link was removed, false when either Entity is dead, they belong to different worlds, or the link does not exist.
Type Parameters
TThe type of link to remove.
Unlink(LinkID, Entity)
Removes the outgoing link of kind linkKind from this Entity to target.
public readonly void Unlink(LinkID linkKind, Entity target)Parameters
Exceptions
- InvalidOperationException
Either Entity is dead, they belong to different worlds, or the link does not exist.
Unlink<T>(Entity)
Removes the outgoing link of type T from this Entity to target.
public readonly void Unlink<T>(Entity target)Parameters
Type Parameters
TThe type of link to remove.
Exceptions
- InvalidOperationException
Either Entity is dead, they belong to different worlds, or the link does not exist.
Events
OnComponentAdded
Raised when a component is added to an entity
public readonly event Action<Entity, ComponentID> OnComponentAddedEvent Type
OnComponentRemoved
Raised when a component is removed from an entity
public readonly event Action<Entity, ComponentID> OnComponentRemovedEvent Type
OnDelete
Raised when the entity is deleted
public readonly event Action<Entity> OnDeleteEvent Type
OnDetach
Raised when a tag is detached from the entity
public readonly event Action<Entity, TagID> OnDetachEvent Type
OnIncomingLinked
Raised when this entity becomes the target of a link
public readonly event Action<Entity, LinkID> OnIncomingLinkedEvent Type
OnIncomingUnlinked
Raised when an incoming link to this entity is removed
public readonly event Action<Entity, LinkID> OnIncomingUnlinkedEvent Type
OnOutgoingLinked
Raised when this entity becomes the source of a link
public readonly event Action<Entity, LinkID> OnOutgoingLinkedEvent Type
OnOutgoingUnlinked
Raised when an outgoing link from this entity is removed
public readonly event Action<Entity, LinkID> OnOutgoingUnlinkedEvent Type
OnTagged
Raised when the entity is tagged
public readonly event Action<Entity, TagID> OnTaggedEvent Type
Operators
operator ==(Entity, Entity)
Checks if two Entity structs refer to the same entity.
public static bool operator ==(Entity a, Entity b)Parameters
Returns
operator !=(Entity, Entity)
Checks if two Entity structs do not refer to the same entity.
public static bool operator !=(Entity a, Entity b)