Interface IEntity

The definition of a controller (this) to a model (IEntityData). Each entity in IdleKit has a IEntity, IEntityData, IGuidReferenceableAsset, and an optional ISavedData.

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public interface IEntity : IInjectable

Properties

Id

The id of the IEntityData that was used to CreateEntity() this IEntity.

Declaration

string Id { get; }

Property Value

Type	Description
String

Methods

Cleanup(IEntityLoaderService)

Responsible for performing cleanup on the child IEntitys and other objects owned by this IEntity. It is important to perform Cleanup(IEntityLoaderService) to make sure there is no memory leak.

Declaration

void Cleanup(IEntityLoaderService entityLoaderService)

Parameters

Type	Name	Description
IEntityLoaderService	entityLoaderService

Initialize()

Responsible for performing the setup logic including subscription to the IActions for this IEntity. It is called right after IdleKit.Core.IInjectable.Inject when this IEntity is loaded in the IEntityLoaderService.

Declaration

void Initialize()