Class EntityComponentBase

Inheritance
Object
EntityComponentBase
BuildingCreator
EntityComponentTaskLauncher
FactionEntityTargetComponent<T>
PendingTaskEntityComponentBase
ResourceGenerator
UnitCarrier
Implements
IEntityPostInitializable
IEntityPreInitializable
Namespace: RTSEngine.EntityComponent
Assembly: cs.temp.dll.dll
Syntax
public abstract class EntityComponentBase : MonoBehaviour, IEntityComponent, IMonoBehaviour, IEntityPostInitializable, IEntityPreInitializable

Properties

AllowPreEntityInit

Declaration
public virtual bool AllowPreEntityInit { get; }
Property Value
Type Description
Boolean

Code

Declaration
public string Code { get; }
Property Value
Type Description
String

Data

Declaration
public EntityComponentData Data { get; }
Property Value
Type Description
EntityComponentData

Entity

Declaration
public IEntity Entity { get; }
Property Value
Type Description
IEntity

gameMgr

Declaration
protected IGameManager gameMgr { get; }
Property Value
Type Description
IGameManager

IsActive

Declaration
public bool IsActive { get; }
Property Value
Type Description
Boolean

IsInitialized

Declaration
public bool IsInitialized { get; }
Property Value
Type Description
Boolean

logger

Declaration
protected IGameLoggingService logger { get; }
Property Value
Type Description
IGameLoggingService

playerMsgHandler

Declaration
protected IPlayerMessageHandler playerMsgHandler { get; }
Property Value
Type Description
IPlayerMessageHandler

Methods

Disable()

Declaration
public void Disable()

HandleComponentUpgrade(IEntityComponent)

Declaration
public virtual void HandleComponentUpgrade(IEntityComponent sourceEntityComponent)
Parameters
Type Name Description
IEntityComponent sourceEntityComponent

LaunchAction(Byte, SetTargetInputData)

Declaration
public ErrorMessage LaunchAction(byte actionID, SetTargetInputData input)
Parameters
Type Name Description
System.Byte actionID
SetTargetInputData input
Returns
Type Description
ErrorMessage

LaunchActionLocal(Byte, SetTargetInputData)

Declaration
public virtual ErrorMessage LaunchActionLocal(byte actionID, SetTargetInputData input)
Parameters
Type Name Description
System.Byte actionID
SetTargetInputData input
Returns
Type Description
ErrorMessage

OnActiveStatusUpdated()

Declaration
protected virtual void OnActiveStatusUpdated()

OnAwaitingTaskTargetSet(EntityComponentTaskUIAttributes, TargetData<IEntity>)

Declaration
public virtual bool OnAwaitingTaskTargetSet(EntityComponentTaskUIAttributes taskAttributes, TargetData<IEntity> target)
Parameters
Type Name Description
EntityComponentTaskUIAttributes taskAttributes
TargetData<IEntity> target
Returns
Type Description
Boolean

OnDisabled()

Declaration
protected virtual void OnDisabled()

OnEntityPostInit(IGameManager, IEntity)

Declaration
public void OnEntityPostInit(IGameManager gameMgr, IEntity entity)
Parameters
Type Name Description
IGameManager gameMgr
IEntity entity

OnEntityPreInit(IGameManager, IEntity)

Declaration
public void OnEntityPreInit(IGameManager gameMgr, IEntity entity)
Parameters
Type Name Description
IGameManager gameMgr
IEntity entity

OnFactionUpdateComplete()

Declaration
protected virtual void OnFactionUpdateComplete()

OnFactionUpdateStart()

Declaration
protected virtual void OnFactionUpdateStart()

OnInit()

Declaration
protected virtual void OnInit()

OnTaskUICacheUpdate(List<EntityComponentTaskUIAttributes>, List<String>)

Declaration
protected virtual bool OnTaskUICacheUpdate(List<EntityComponentTaskUIAttributes> taskUIAttributesCache, List<string> disabledTaskCodesCache)
Parameters
Type Name Description
List<EntityComponentTaskUIAttributes> taskUIAttributesCache
List<String> disabledTaskCodesCache
Returns
Type Description
Boolean

OnTaskUIClick(EntityComponentTaskUIAttributes)

Declaration
public virtual bool OnTaskUIClick(EntityComponentTaskUIAttributes taskAttributes)
Parameters
Type Name Description
EntityComponentTaskUIAttributes taskAttributes
Returns
Type Description
Boolean

OnTaskUIRequest(out IReadOnlyList<EntityComponentTaskUIAttributes>, out IReadOnlyList<String>)

Declaration
public bool OnTaskUIRequest(out IReadOnlyList<EntityComponentTaskUIAttributes> taskUIAttributes, out IReadOnlyList<string> disabledTaskCodes)
Parameters
Type Name Description
System.Collections.Generic.IReadOnlyList<EntityComponentTaskUIAttributes> taskUIAttributes
System.Collections.Generic.IReadOnlyList<String> disabledTaskCodes
Returns
Type Description
Boolean

SetActive(Boolean, Boolean)

Declaration
public ErrorMessage SetActive(bool active, bool playerCommand)
Parameters
Type Name Description
Boolean active
Boolean playerCommand
Returns
Type Description
ErrorMessage

SetActiveLocal(Boolean, Boolean)

Declaration
public ErrorMessage SetActiveLocal(bool active, bool playerCommand)
Parameters
Type Name Description
Boolean active
Boolean playerCommand
Returns
Type Description
ErrorMessage

Events

ActiveStatusUpdate

Declaration
public event CustomEventHandler<IEntityComponent, EventArgs> ActiveStatusUpdate
Event Type
Type Description
CustomEventHandler<IEntityComponent, System.EventArgs>

Implements

IEntityPostInitializable
IEntityPreInitializable