Class EntityHealth

Inheritance

Object

EntityHealth

FactionEntityHealth

ResourceHealth

Implements

IEntityHealth

IMonoBehaviour

IEntityPreInitializable

Namespace: RTSEngine.Health

Assembly: cs.temp.dll.dll

Syntax

public abstract class EntityHealth : MonoBehaviour, IEntityHealth, IMonoBehaviour, IEntityPreInitializable

Fields

stateHandler

Declaration

protected EntityHealthStateHandler stateHandler

Field Value

Type	Description
EntityHealthStateHandler

tabID

Declaration

public Int2D tabID

Field Value

Type	Description
Int2D

Properties

audioMgr

Declaration

protected IGameAudioManager audioMgr { get; }

Property Value

Type	Description
IGameAudioManager

CanDecrease

Declaration

public bool CanDecrease { get; set; }

Property Value

Type	Description
Boolean

CanIncrease

Declaration

public bool CanIncrease { get; set; }

Property Value

Type	Description
Boolean

CurrHealth

Declaration

public int CurrHealth { get; }

Property Value

Type	Description
Int32

DestroyObjectDelay

Declaration

public virtual float DestroyObjectDelay { get; }

Property Value

Type	Description
System.Single

effectObjPool

Declaration

protected IEffectObjectPool effectObjPool { get; }

Property Value

Type	Description
IEffectObjectPool

Entity

Declaration

public IEntity Entity { get; }

Property Value

Type	Description
IEntity

EntityType

Declaration

public abstract EntityType EntityType { get; }

Property Value

Type	Description
EntityType

gameMgr

Declaration

protected IGameManager gameMgr { get; }

Property Value

Type	Description
IGameManager

globalEvent

Declaration

protected IGlobalEventPublisher globalEvent { get; }

Property Value

Type	Description
IGlobalEventPublisher

HasMaxHealth

Declaration

public bool HasMaxHealth { get; }

Property Value

Type	Description
Boolean

HealthRatio

Declaration

public float HealthRatio { get; }

Property Value

Type	Description
System.Single

HoverHealthBarData

Declaration

public HoverHealthBarData HoverHealthBarData { get; }

Property Value

Type	Description
HoverHealthBarData

HoverHealthBarY

Declaration

public float HoverHealthBarY { get; }

Property Value

Type	Description
System.Single

inputMgr

Declaration

protected IInputManager inputMgr { get; }

Property Value

Type	Description
IInputManager

IsDead

Declaration

public bool IsDead { get; }

Property Value

Type	Description
Boolean

IsInitialized

Declaration

public bool IsInitialized { get; }

Property Value

Type	Description
Boolean

LockHealth

Declaration

public bool LockHealth { get; protected set; }

Property Value

Type	Description
Boolean

logger

Declaration

protected IGameLoggingService logger { get; }

Property Value

Type	Description
IGameLoggingService

MaxHealth

Declaration

public int MaxHealth { get; }

Property Value

Type	Description
Int32

playerMsgHandler

Declaration

protected IPlayerMessageHandler playerMsgHandler { get; }

Property Value

Type	Description
IPlayerMessageHandler

resourceMgr

Declaration

protected IResourceManager resourceMgr { get; }

Property Value

Type	Description
IResourceManager

selectionMgr

Declaration

protected ISelectionManager selectionMgr { get; }

Property Value

Type	Description
ISelectionManager

States

Declaration

protected IReadOnlyList<EntityHealthState> States { get; }

Property Value

Type	Description
System.Collections.Generic.IReadOnlyList<EntityHealthState>

TerminatedBy

Declaration

public IEntity TerminatedBy { get; }

Property Value

Type	Description
IEntity

Methods

Add(HealthUpdateArgs)

Declaration

public ErrorMessage Add(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

Returns

Type	Description
ErrorMessage

AddLocal(HealthUpdateArgs, Boolean)

Declaration

public ErrorMessage AddLocal(HealthUpdateArgs args, bool force = false)

Parameters

Type	Name	Description
HealthUpdateArgs	args
Boolean	force

Returns

Type	Description
ErrorMessage

CanAdd(HealthUpdateArgs)

Declaration

public abstract ErrorMessage CanAdd(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

Returns

Type	Description
ErrorMessage

CanDestroy(Boolean, IEntity)

Declaration

public virtual ErrorMessage CanDestroy(bool upgrade, IEntity source)

Parameters

Type	Name	Description
Boolean	upgrade
IEntity	source

Returns

Type	Description
ErrorMessage

Destroy(Boolean, IEntity)

Declaration

public ErrorMessage Destroy(bool upgrade, IEntity source)

Parameters

Type	Name	Description
Boolean	upgrade
IEntity	source

Returns

Type	Description
ErrorMessage

DestroyLocal(Boolean, IEntity)

Declaration

public ErrorMessage DestroyLocal(bool upgrade, IEntity source)

Parameters

Type	Name	Description
Boolean	upgrade
IEntity	source

Returns

Type	Description
ErrorMessage

Disable()

Declaration

public void Disable()

OnDestroyed(Boolean, IEntity)

Declaration

protected virtual void OnDestroyed(bool upgrade, IEntity source)

Parameters

Type	Name	Description
Boolean	upgrade
IEntity	source

OnDisabled()

Declaration

protected virtual void OnDisabled()

OnEntityHealthInit()

Declaration

protected virtual void OnEntityHealthInit()

OnEntityPreInit(IGameManager, IEntity)

Declaration

public void OnEntityPreInit(IGameManager gameMgr, IEntity entity)

Parameters

Type	Name	Description
IGameManager	gameMgr
IEntity	entity

OnHealthUpdated(HealthUpdateArgs)

Declaration

protected virtual void OnHealthUpdated(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

OnInitialHealthAdded()

Declaration

protected virtual void OnInitialHealthAdded()

OnMaxHealthReached(HealthUpdateArgs)

Declaration

protected virtual void OnMaxHealthReached(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

OnZeroHealthReached(HealthUpdateArgs)

Declaration

protected virtual void OnZeroHealthReached(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

RaiseEntityDead(DeadEventArgs)

Declaration

public void RaiseEntityDead(DeadEventArgs args)

Parameters

Type	Name	Description
DeadEventArgs	args

RaiseEntityHealthUpdated(HealthUpdateArgs)

Declaration

public void RaiseEntityHealthUpdated(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

RaiseEntityMaxHealthUpdated(HealthUpdateArgs)

Declaration

public void RaiseEntityMaxHealthUpdated(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

SetMax(HealthUpdateArgs)

Declaration

public ErrorMessage SetMax(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

Returns

Type	Description
ErrorMessage

SetMaxLocal(HealthUpdateArgs)

Declaration

public ErrorMessage SetMaxLocal(HealthUpdateArgs args)

Parameters

Type	Name	Description
HealthUpdateArgs	args

Returns

Type	Description
ErrorMessage

Events

EntityDead

Declaration

public event CustomEventHandler<IEntity, DeadEventArgs> EntityDead

Event Type

Type	Description
CustomEventHandler<IEntity, DeadEventArgs>

EntityHealthUpdated

Declaration

public event CustomEventHandler<IEntity, HealthUpdateArgs> EntityHealthUpdated

Event Type

Type	Description
CustomEventHandler<IEntity, HealthUpdateArgs>

EntityMaxHealthUpdated

Declaration

public event CustomEventHandler<IEntity, HealthUpdateArgs> EntityMaxHealthUpdated

Event Type

Type	Description
CustomEventHandler<IEntity, HealthUpdateArgs>

Implements

IEntityHealth

IMonoBehaviour

IEntityPreInitializable