Class DropOffSource

Inheritance
Object
EntityComponentBase
FactionEntityTargetComponent<IFactionEntity>
DropOffSource
Implements
IEntityPreInitializable
IEntityPostInitializable
Inherited Members
Namespace: RTSEngine.EntityComponent
Assembly: cs.temp.dll.dll
Syntax
public class DropOffSource : FactionEntityTargetComponent<IFactionEntity>, IEntityPreInitializable, IDropOffSource, IEntityTargetComponent, IEntityComponent, IMonoBehaviour, IEntityPostInitializable

Properties

CollectedResources

Declaration
public IReadOnlyDictionary<ResourceTypeInfo, int> CollectedResources { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<ResourceTypeInfo, Int32>

CollectedResourcesSum

Declaration
public int CollectedResourcesSum { get; }
Property Value
Type Description
Int32

IsIdle

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

LastCollectedResourceType

Declaration
public ResourceTypeInfo LastCollectedResourceType { get; }
Property Value
Type Description
ResourceTypeInfo

RequireIdleEntity

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

State

Declaration
public DropOffState State { get; }
Property Value
Type Description
DropOffState

Unit

Declaration
public IUnit Unit { get; }
Property Value
Type Description
IUnit

Methods

AttemptStartDropOff(Boolean, ResourceTypeInfo)

Declaration
public bool AttemptStartDropOff(bool force = false, ResourceTypeInfo resourceType = null)
Parameters
Type Name Description
Boolean force
ResourceTypeInfo resourceType
Returns
Type Description
Boolean

Cancel()

Declaration
public void Cancel()

CanStopOnNoTarget()

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

GetMaxCapacity(ResourceTypeInfo)

Declaration
public int GetMaxCapacity(ResourceTypeInfo resourceType)
Parameters
Type Name Description
ResourceTypeInfo resourceType
Returns
Type Description
Int32

HasReachedMaxCapacity(ResourceTypeInfo)

Declaration
public bool HasReachedMaxCapacity(ResourceTypeInfo resourceType = null)
Parameters
Type Name Description
ResourceTypeInfo resourceType
Returns
Type Description
Boolean

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<IFactionEntity>.IsTargetInRange(Vector3, RTSEngine.EntityComponent.TargetData<IEntity>)

IsTargetValid(SetTargetInputData)

Declaration
public override ErrorMessage IsTargetValid(SetTargetInputData data)
Parameters
Type Name Description
SetTargetInputData data
Returns
Type Description
ErrorMessage
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IFactionEntity>.IsTargetValid(RTSEngine.EntityComponent.SetTargetInputData)

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

OnComponentUpgraded(FactionEntityTargetComponent<IFactionEntity>)

Declaration
protected override void OnComponentUpgraded(FactionEntityTargetComponent<IFactionEntity> sourceFactionEntityTargetComponent)
Parameters
Type Name Description
FactionEntityTargetComponent<IFactionEntity> sourceFactionEntityTargetComponent
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IFactionEntity>.OnComponentUpgraded(RTSEngine.EntityComponent.FactionEntityTargetComponent<IFactionEntity>)

OnTargetDisabled()

Declaration
protected override void OnTargetDisabled()
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IFactionEntity>.OnTargetDisabled()

OnTargetInit()

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

OnTargetPostLocked(SetTargetInputData, Boolean)

Declaration
protected override void OnTargetPostLocked(SetTargetInputData input, bool sameTarget)
Parameters
Type Name Description
SetTargetInputData input
Boolean sameTarget
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IFactionEntity>.OnTargetPostLocked(RTSEngine.EntityComponent.SetTargetInputData, System.Boolean)

SendToTarget(Boolean)

Declaration
public ErrorMessage SendToTarget(bool playerCommand)
Parameters
Type Name Description
Boolean playerCommand
Returns
Type Description
ErrorMessage

Unload()

Declaration
public void Unload()

UpdateCollectedResources(ResourceTypeInfo, Int32)

Declaration
public void UpdateCollectedResources(ResourceTypeInfo resourceType, int value)
Parameters
Type Name Description
ResourceTypeInfo resourceType
Int32 value

Events

CollectedResourcesUpdated

Declaration
public event CustomEventHandler<IDropOffSource, EventArgs> CollectedResourcesUpdated
Event Type
Type Description
CustomEventHandler<IDropOffSource, System.EventArgs>

DropOffStateUpdated

Declaration
public event CustomEventHandler<IDropOffSource, EventArgs> DropOffStateUpdated
Event Type
Type Description
CustomEventHandler<IDropOffSource, System.EventArgs>

DropOffUnloaded

Declaration
public event CustomEventHandler<IDropOffSource, EventArgs> DropOffUnloaded
Event Type
Type Description
CustomEventHandler<IDropOffSource, System.EventArgs>

Implements

IEntityPreInitializable
IEntityPostInitializable