Class FactionEntityTargetProgressComponent<T>

Inheritance
Object
EntityComponentBase
FactionEntityTargetComponent<T>
FactionEntityTargetProgressComponent<T>
Builder
Converter
FactionEntityAttack
Healer
ResourceCollector
Implements
IEntityPreInitializable
IEntityPostInitializable
Inherited Members
Namespace: RTSEngine.EntityComponent
Assembly: cs.temp.dll.dll
Syntax
public abstract class FactionEntityTargetProgressComponent<T> : FactionEntityTargetComponent<T>, IEntityPreInitializable, IEntityTargetProgressComponent, IEntityTargetComponent, IEntityComponent, IMonoBehaviour, IEntityPostInitializable where T : IEntity
Type Parameters
Name Description
T

Fields

inProgressObject

Declaration
protected GameObject inProgressObject
Field Value
Type Description
GameObject

progressDuration

Declaration
protected float progressDuration
Field Value
Type Description
System.Single

progressEnabledAudio

Declaration
protected AudioClipFetcher progressEnabledAudio
Field Value
Type Description
AudioClipFetcher

progressOverrideController

Declaration
protected AnimatorOverrideControllerFetcher progressOverrideController
Field Value
Type Description
AnimatorOverrideControllerFetcher

sourceEffect

Declaration
protected GameObjectToEffectObjectInput sourceEffect
Field Value
Type Description
GameObjectToEffectObjectInput

targetEffect

Declaration
protected GameObjectToEffectObjectInput targetEffect
Field Value
Type Description
GameObjectToEffectObjectInput

Properties

InProgress

Is the faction entity currently actively working the entity component?

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

IsIdle

Declaration
public override bool IsIdle { get; }
Property Value
Type Description
Boolean
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<T>.IsIdle

ProgressData

Declaration
public EntityTargetComponentProgressData ProgressData { get; }
Property Value
Type Description
EntityTargetComponentProgressData

ProgressMaxDistance

Declaration
public float ProgressMaxDistance { get; }
Property Value
Type Description
System.Single

StopMovementOnProgressEnabled

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

WasInProgress

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

Methods

CanEnableProgress()

Declaration
protected abstract bool CanEnableProgress()
Returns
Type Description
Boolean

CanProgress()

Declaration
protected abstract bool CanProgress()
Returns
Type Description
Boolean

CanStopOnNoTarget()

Declaration
protected override bool CanStopOnNoTarget()
Returns
Type Description
Boolean
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<T>.CanStopOnNoTarget()

DisableProgress()

Declaration
protected void DisableProgress()

GetProgressCenter()

Declaration
public virtual Vector3 GetProgressCenter()
Returns
Type Description
Vector3

GetProgressRange()

Declaration
public virtual float GetProgressRange()
Returns
Type Description
System.Single

IsTargetInRange(Vector3, TargetData<IEntity>)

Declaration
public override bool IsTargetInRange(Vector3 sourcePosition, TargetData<IEntity> target)
Parameters
Type Name Description
Vector3 sourcePosition
TargetData<IEntity> target
Returns
Type Description
Boolean
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<T>.IsTargetInRange(Vector3, RTSEngine.EntityComponent.TargetData<IEntity>)

LaunchActionLocal(Byte, SetTargetInputData)

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

MustDisableProgress()

Declaration
protected abstract bool MustDisableProgress()
Returns
Type Description
Boolean

MustStopProgress()

Declaration
protected abstract bool MustStopProgress()
Returns
Type Description
Boolean

OnInProgressDisabledEffects()

Declaration
protected virtual void OnInProgressDisabledEffects()

OnInProgressEnabled()

Declaration
protected virtual void OnInProgressEnabled()

OnInProgressEnabledEffects()

Declaration
protected virtual void OnInProgressEnabledEffects()

OnNoTargetUpdate()

Declaration
protected virtual void OnNoTargetUpdate()

OnProgress()

Declaration
protected virtual void OnProgress()

OnProgressDisabled()

Declaration
protected virtual void OnProgressDisabled()

OnProgressInit()

Declaration
protected virtual void OnProgressInit()

OnProgressStop()

Declaration
protected virtual void OnProgressStop()

OnStop()

Declaration
protected override sealed void OnStop()
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<T>.OnStop()

OnTargetInit()

Declaration
protected override sealed void OnTargetInit()
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<T>.OnTargetInit()

OnTargetPreLocked(Boolean, TargetData<IEntity>, Boolean)

Declaration
protected override sealed void OnTargetPreLocked(bool playerCommand, TargetData<IEntity> newTarget, bool sameTarget)
Parameters
Type Name Description
Boolean playerCommand
TargetData<IEntity> newTarget
Boolean sameTarget
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<T>.OnTargetPreLocked(System.Boolean, RTSEngine.EntityComponent.TargetData<IEntity>, System.Boolean)

OnTargetUpdate()

Declaration
protected virtual void OnTargetUpdate()

OnUpdate()

Declaration
protected virtual void OnUpdate()

SetNextProgressData(EntityTargetComponentProgressData, IEntity, Boolean)

Declaration
public ErrorMessage SetNextProgressData(EntityTargetComponentProgressData nextData, IEntity target, bool playerCommand)
Parameters
Type Name Description
EntityTargetComponentProgressData nextData
IEntity target
Boolean playerCommand
Returns
Type Description
ErrorMessage

SetNextProgressDataLocal(EntityTargetComponentProgressData, IEntity, Boolean)

Declaration
public ErrorMessage SetNextProgressDataLocal(EntityTargetComponentProgressData nextData, IEntity target, bool playerCommand)
Parameters
Type Name Description
EntityTargetComponentProgressData nextData
IEntity target
Boolean playerCommand
Returns
Type Description
ErrorMessage

ToggleSourceTargetEffect(Boolean)

Declaration
protected void ToggleSourceTargetEffect(bool enable)
Parameters
Type Name Description
Boolean enable

Events

ProgressStart

Declaration
public event CustomEventHandler<IEntityTargetProgressComponent, EventArgs> ProgressStart
Event Type
Type Description
CustomEventHandler<IEntityTargetProgressComponent, System.EventArgs>

ProgressStop

Declaration
public event CustomEventHandler<IEntityTargetProgressComponent, EventArgs> ProgressStop
Event Type
Type Description
CustomEventHandler<IEntityTargetProgressComponent, System.EventArgs>

Implements

IEntityPreInitializable
IEntityPostInitializable