Game Framework  2021.05.31
IEntityManager接口 参考

实体管理器接口。 更多...

Public 成员函数

void SetObjectPoolManager (IObjectPoolManager objectPoolManager)
 设置对象池管理器。 更多...
 
void SetResourceManager (IResourceManager resourceManager)
 设置资源管理器。 更多...
 
void SetEntityHelper (IEntityHelper entityHelper)
 设置实体辅助器。 更多...
 
bool HasEntityGroup (string entityGroupName)
 是否存在实体组。 更多...
 
IEntityGroup GetEntityGroup (string entityGroupName)
 获取实体组。 更多...
 
IEntityGroup[] GetAllEntityGroups ()
 获取所有实体组。 更多...
 
void GetAllEntityGroups (List< IEntityGroup > results)
 获取所有实体组。 更多...
 
bool AddEntityGroup (string entityGroupName, float instanceAutoReleaseInterval, int instanceCapacity, float instanceExpireTime, int instancePriority, IEntityGroupHelper entityGroupHelper)
 增加实体组。 更多...
 
bool HasEntity (int entityId)
 是否存在实体。 更多...
 
bool HasEntity (string entityAssetName)
 是否存在实体。 更多...
 
IEntity GetEntity (int entityId)
 获取实体。 更多...
 
IEntity GetEntity (string entityAssetName)
 获取实体。 更多...
 
IEntity[] GetEntities (string entityAssetName)
 获取实体。 更多...
 
void GetEntities (string entityAssetName, List< IEntity > results)
 获取实体。 更多...
 
IEntity[] GetAllLoadedEntities ()
 获取所有已加载的实体。 更多...
 
void GetAllLoadedEntities (List< IEntity > results)
 获取所有已加载的实体。 更多...
 
int[] GetAllLoadingEntityIds ()
 获取所有正在加载实体的编号。 更多...
 
void GetAllLoadingEntityIds (List< int > results)
 获取所有正在加载实体的编号。 更多...
 
bool IsLoadingEntity (int entityId)
 是否正在加载实体。 更多...
 
bool IsValidEntity (IEntity entity)
 是否是合法的实体。 更多...
 
void ShowEntity (int entityId, string entityAssetName, string entityGroupName)
 显示实体。 更多...
 
void ShowEntity (int entityId, string entityAssetName, string entityGroupName, int priority)
 显示实体。 更多...
 
void ShowEntity (int entityId, string entityAssetName, string entityGroupName, object userData)
 显示实体。 更多...
 
void ShowEntity (int entityId, string entityAssetName, string entityGroupName, int priority, object userData)
 显示实体。 更多...
 
void HideEntity (int entityId)
 隐藏实体。 更多...
 
void HideEntity (int entityId, object userData)
 隐藏实体。 更多...
 
void HideEntity (IEntity entity)
 隐藏实体。 更多...
 
void HideEntity (IEntity entity, object userData)
 隐藏实体。 更多...
 
void HideAllLoadedEntities ()
 隐藏所有已加载的实体。 更多...
 
void HideAllLoadedEntities (object userData)
 隐藏所有已加载的实体。 更多...
 
void HideAllLoadingEntities ()
 隐藏所有正在加载的实体。 更多...
 
IEntity GetParentEntity (int childEntityId)
 获取父实体。 更多...
 
IEntity GetParentEntity (IEntity childEntity)
 获取父实体。 更多...
 
int GetChildEntityCount (int parentEntityId)
 获取子实体数量。 更多...
 
IEntity GetChildEntity (int parentEntityId)
 获取子实体。 更多...
 
IEntity GetChildEntity (IEntity parentEntity)
 获取子实体。 更多...
 
IEntity[] GetChildEntities (int parentEntityId)
 获取所有子实体。 更多...
 
void GetChildEntities (int parentEntityId, List< IEntity > results)
 获取所有子实体。 更多...
 
IEntity[] GetChildEntities (IEntity parentEntity)
 获取所有子实体。 更多...
 
void GetChildEntities (IEntity parentEntity, List< IEntity > results)
 获取所有子实体。 更多...
 
void AttachEntity (int childEntityId, int parentEntityId)
 附加子实体。 更多...
 
void AttachEntity (int childEntityId, int parentEntityId, object userData)
 附加子实体。 更多...
 
void AttachEntity (int childEntityId, IEntity parentEntity)
 附加子实体。 更多...
 
void AttachEntity (int childEntityId, IEntity parentEntity, object userData)
 附加子实体。 更多...
 
void AttachEntity (IEntity childEntity, int parentEntityId)
 附加子实体。 更多...
 
void AttachEntity (IEntity childEntity, int parentEntityId, object userData)
 附加子实体。 更多...
 
void AttachEntity (IEntity childEntity, IEntity parentEntity)
 附加子实体。 更多...
 
void AttachEntity (IEntity childEntity, IEntity parentEntity, object userData)
 附加子实体。 更多...
 
void DetachEntity (int childEntityId)
 解除子实体。 更多...
 
void DetachEntity (int childEntityId, object userData)
 解除子实体。 更多...
 
void DetachEntity (IEntity childEntity)
 解除子实体。 更多...
 
void DetachEntity (IEntity childEntity, object userData)
 解除子实体。 更多...
 
void DetachChildEntities (int parentEntityId)
 解除所有子实体。 更多...
 
void DetachChildEntities (int parentEntityId, object userData)
 解除所有子实体。 更多...
 
void DetachChildEntities (IEntity parentEntity)
 解除所有子实体。 更多...
 
void DetachChildEntities (IEntity parentEntity, object userData)
 解除所有子实体。 更多...
 

属性

int EntityCount [get]
 获取实体数量。 更多...
 
int EntityGroupCount [get]
 获取实体组数量。 更多...
 

事件

EventHandler< ShowEntitySuccessEventArgsShowEntitySuccess
 显示实体成功事件。 更多...
 
EventHandler< ShowEntityFailureEventArgsShowEntityFailure
 显示实体失败事件。 更多...
 
EventHandler< ShowEntityUpdateEventArgsShowEntityUpdate
 显示实体更新事件。 更多...
 
EventHandler< ShowEntityDependencyAssetEventArgsShowEntityDependencyAsset
 显示实体时加载依赖资源事件。 更多...
 
EventHandler< HideEntityCompleteEventArgsHideEntityComplete
 隐藏实体完成事件。 更多...
 

详细描述

实体管理器接口。

成员函数说明

◆ AddEntityGroup()

bool AddEntityGroup ( string  entityGroupName,
float  instanceAutoReleaseInterval,
int  instanceCapacity,
float  instanceExpireTime,
int  instancePriority,
IEntityGroupHelper  entityGroupHelper 
)

增加实体组。

参数
entityGroupName实体组名称。
instanceAutoReleaseInterval实体实例对象池自动释放可释放对象的间隔秒数。
instanceCapacity实体实例对象池容量。
instanceExpireTime实体实例对象池对象过期秒数。
instancePriority实体实例对象池的优先级。
entityGroupHelper实体组辅助器。
返回
是否增加实体组成功。

◆ AttachEntity() [1/8]

void AttachEntity ( IEntity  childEntity,
IEntity  parentEntity 
)

附加子实体。

参数
childEntity要附加的子实体。
parentEntity被附加的父实体。

◆ AttachEntity() [2/8]

void AttachEntity ( IEntity  childEntity,
IEntity  parentEntity,
object  userData 
)

附加子实体。

参数
childEntity要附加的子实体。
parentEntity被附加的父实体。
userData用户自定义数据。

◆ AttachEntity() [3/8]

void AttachEntity ( IEntity  childEntity,
int  parentEntityId 
)

附加子实体。

参数
childEntity要附加的子实体。
parentEntityId被附加的父实体的实体编号。

◆ AttachEntity() [4/8]

void AttachEntity ( IEntity  childEntity,
int  parentEntityId,
object  userData 
)

附加子实体。

参数
childEntity要附加的子实体。
parentEntityId被附加的父实体的实体编号。
userData用户自定义数据。

◆ AttachEntity() [5/8]

void AttachEntity ( int  childEntityId,
IEntity  parentEntity 
)

附加子实体。

参数
childEntityId要附加的子实体的实体编号。
parentEntity被附加的父实体。

◆ AttachEntity() [6/8]

void AttachEntity ( int  childEntityId,
IEntity  parentEntity,
object  userData 
)

附加子实体。

参数
childEntityId要附加的子实体的实体编号。
parentEntity被附加的父实体。
userData用户自定义数据。

◆ AttachEntity() [7/8]

void AttachEntity ( int  childEntityId,
int  parentEntityId 
)

附加子实体。

参数
childEntityId要附加的子实体的实体编号。
parentEntityId被附加的父实体的实体编号。

◆ AttachEntity() [8/8]

void AttachEntity ( int  childEntityId,
int  parentEntityId,
object  userData 
)

附加子实体。

参数
childEntityId要附加的子实体的实体编号。
parentEntityId被附加的父实体的实体编号。
userData用户自定义数据。

◆ DetachChildEntities() [1/4]

void DetachChildEntities ( IEntity  parentEntity)

解除所有子实体。

参数
parentEntity被解除的父实体。

◆ DetachChildEntities() [2/4]

void DetachChildEntities ( IEntity  parentEntity,
object  userData 
)

解除所有子实体。

参数
parentEntity被解除的父实体。
userData用户自定义数据。

◆ DetachChildEntities() [3/4]

void DetachChildEntities ( int  parentEntityId)

解除所有子实体。

参数
parentEntityId被解除的父实体的实体编号。

◆ DetachChildEntities() [4/4]

void DetachChildEntities ( int  parentEntityId,
object  userData 
)

解除所有子实体。

参数
parentEntityId被解除的父实体的实体编号。
userData用户自定义数据。

◆ DetachEntity() [1/4]

void DetachEntity ( IEntity  childEntity)

解除子实体。

参数
childEntity要解除的子实体。

◆ DetachEntity() [2/4]

void DetachEntity ( IEntity  childEntity,
object  userData 
)

解除子实体。

参数
childEntity要解除的子实体。
userData用户自定义数据。

◆ DetachEntity() [3/4]

void DetachEntity ( int  childEntityId)

解除子实体。

参数
childEntityId要解除的子实体的实体编号。

◆ DetachEntity() [4/4]

void DetachEntity ( int  childEntityId,
object  userData 
)

解除子实体。

参数
childEntityId要解除的子实体的实体编号。
userData用户自定义数据。

◆ GetAllEntityGroups() [1/2]

IEntityGroup [] GetAllEntityGroups ( )

获取所有实体组。

返回
所有实体组。

◆ GetAllEntityGroups() [2/2]

void GetAllEntityGroups ( List< IEntityGroup results)

获取所有实体组。

参数
results所有实体组。

◆ GetAllLoadedEntities() [1/2]

IEntity [] GetAllLoadedEntities ( )

获取所有已加载的实体。

返回
所有已加载的实体。

◆ GetAllLoadedEntities() [2/2]

void GetAllLoadedEntities ( List< IEntity results)

获取所有已加载的实体。

参数
results所有已加载的实体。

◆ GetAllLoadingEntityIds() [1/2]

int [] GetAllLoadingEntityIds ( )

获取所有正在加载实体的编号。

返回
所有正在加载实体的编号。

◆ GetAllLoadingEntityIds() [2/2]

void GetAllLoadingEntityIds ( List< int >  results)

获取所有正在加载实体的编号。

参数
results所有正在加载实体的编号。

◆ GetChildEntities() [1/4]

IEntity [] GetChildEntities ( IEntity  parentEntity)

获取所有子实体。

参数
parentEntity要获取所有子实体的父实体。
返回
所有子实体。

◆ GetChildEntities() [2/4]

void GetChildEntities ( IEntity  parentEntity,
List< IEntity results 
)

获取所有子实体。

参数
parentEntity要获取所有子实体的父实体。
results所有子实体。

◆ GetChildEntities() [3/4]

IEntity [] GetChildEntities ( int  parentEntityId)

获取所有子实体。

参数
parentEntityId要获取所有子实体的父实体的实体编号。
返回
所有子实体。

◆ GetChildEntities() [4/4]

void GetChildEntities ( int  parentEntityId,
List< IEntity results 
)

获取所有子实体。

参数
parentEntityId要获取所有子实体的父实体的实体编号。
results所有子实体。

◆ GetChildEntity() [1/2]

IEntity GetChildEntity ( IEntity  parentEntity)

获取子实体。

参数
parentEntity要获取子实体的父实体。
返回
子实体。

◆ GetChildEntity() [2/2]

IEntity GetChildEntity ( int  parentEntityId)

获取子实体。

参数
parentEntityId要获取子实体的父实体的实体编号。
返回
子实体。

◆ GetChildEntityCount()

int GetChildEntityCount ( int  parentEntityId)

获取子实体数量。

参数
parentEntityId要获取子实体数量的父实体的实体编号。
返回
子实体数量。

◆ GetEntities() [1/2]

IEntity [] GetEntities ( string  entityAssetName)

获取实体。

参数
entityAssetName实体资源名称。
返回
要获取的实体。

◆ GetEntities() [2/2]

void GetEntities ( string  entityAssetName,
List< IEntity results 
)

获取实体。

参数
entityAssetName实体资源名称。
results要获取的实体。

◆ GetEntity() [1/2]

IEntity GetEntity ( int  entityId)

获取实体。

参数
entityId实体编号。
返回
要获取的实体。

◆ GetEntity() [2/2]

IEntity GetEntity ( string  entityAssetName)

获取实体。

参数
entityAssetName实体资源名称。
返回
要获取的实体。

◆ GetEntityGroup()

IEntityGroup GetEntityGroup ( string  entityGroupName)

获取实体组。

参数
entityGroupName实体组名称。
返回
要获取的实体组。

◆ GetParentEntity() [1/2]

IEntity GetParentEntity ( IEntity  childEntity)

获取父实体。

参数
childEntity要获取父实体的子实体。
返回
子实体的父实体。

◆ GetParentEntity() [2/2]

IEntity GetParentEntity ( int  childEntityId)

获取父实体。

参数
childEntityId要获取父实体的子实体的实体编号。
返回
子实体的父实体。

◆ HasEntity() [1/2]

bool HasEntity ( int  entityId)

是否存在实体。

参数
entityId实体编号。
返回
是否存在实体。

◆ HasEntity() [2/2]

bool HasEntity ( string  entityAssetName)

是否存在实体。

参数
entityAssetName实体资源名称。
返回
是否存在实体。

◆ HasEntityGroup()

bool HasEntityGroup ( string  entityGroupName)

是否存在实体组。

参数
entityGroupName实体组名称。
返回
是否存在实体组。

◆ HideAllLoadedEntities() [1/2]

void HideAllLoadedEntities ( )

隐藏所有已加载的实体。

◆ HideAllLoadedEntities() [2/2]

void HideAllLoadedEntities ( object  userData)

隐藏所有已加载的实体。

参数
userData用户自定义数据。

◆ HideAllLoadingEntities()

void HideAllLoadingEntities ( )

隐藏所有正在加载的实体。

◆ HideEntity() [1/4]

void HideEntity ( IEntity  entity)

隐藏实体。

参数
entity实体。

◆ HideEntity() [2/4]

void HideEntity ( IEntity  entity,
object  userData 
)

隐藏实体。

参数
entity实体。
userData用户自定义数据。

◆ HideEntity() [3/4]

void HideEntity ( int  entityId)

隐藏实体。

参数
entityId实体编号。

◆ HideEntity() [4/4]

void HideEntity ( int  entityId,
object  userData 
)

隐藏实体。

参数
entityId实体编号。
userData用户自定义数据。

◆ IsLoadingEntity()

bool IsLoadingEntity ( int  entityId)

是否正在加载实体。

参数
entityId实体编号。
返回
是否正在加载实体。

◆ IsValidEntity()

bool IsValidEntity ( IEntity  entity)

是否是合法的实体。

参数
entity实体。
返回
实体是否合法。

◆ SetEntityHelper()

void SetEntityHelper ( IEntityHelper  entityHelper)

设置实体辅助器。

参数
entityHelper实体辅助器。

◆ SetObjectPoolManager()

void SetObjectPoolManager ( IObjectPoolManager  objectPoolManager)

设置对象池管理器。

参数
objectPoolManager对象池管理器。

◆ SetResourceManager()

void SetResourceManager ( IResourceManager  resourceManager)

设置资源管理器。

参数
resourceManager资源管理器。

◆ ShowEntity() [1/4]

void ShowEntity ( int  entityId,
string  entityAssetName,
string  entityGroupName 
)

显示实体。

参数
entityId实体编号。
entityAssetName实体资源名称。
entityGroupName实体组名称。

◆ ShowEntity() [2/4]

void ShowEntity ( int  entityId,
string  entityAssetName,
string  entityGroupName,
int  priority 
)

显示实体。

参数
entityId实体编号。
entityAssetName实体资源名称。
entityGroupName实体组名称。
priority加载实体资源的优先级。

◆ ShowEntity() [3/4]

void ShowEntity ( int  entityId,
string  entityAssetName,
string  entityGroupName,
int  priority,
object  userData 
)

显示实体。

参数
entityId实体编号。
entityAssetName实体资源名称。
entityGroupName实体组名称。
priority加载实体资源的优先级。
userData用户自定义数据。

◆ ShowEntity() [4/4]

void ShowEntity ( int  entityId,
string  entityAssetName,
string  entityGroupName,
object  userData 
)

显示实体。

参数
entityId实体编号。
entityAssetName实体资源名称。
entityGroupName实体组名称。
userData用户自定义数据。

属性说明

◆ EntityCount

int EntityCount
get

获取实体数量。

◆ EntityGroupCount

int EntityGroupCount
get

获取实体组数量。

事件说明

◆ HideEntityComplete

EventHandler<HideEntityCompleteEventArgs> HideEntityComplete

隐藏实体完成事件。

◆ ShowEntityDependencyAsset

EventHandler<ShowEntityDependencyAssetEventArgs> ShowEntityDependencyAsset

显示实体时加载依赖资源事件。

◆ ShowEntityFailure

EventHandler<ShowEntityFailureEventArgs> ShowEntityFailure

显示实体失败事件。

◆ ShowEntitySuccess

EventHandler<ShowEntitySuccessEventArgs> ShowEntitySuccess

显示实体成功事件。

◆ ShowEntityUpdate

EventHandler<ShowEntityUpdateEventArgs> ShowEntityUpdate

显示实体更新事件。