Class CarriableUnit

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

Properties

CurrCarrier

Declaration
public IUnitCarrier CurrCarrier { get; }
Property Value
Type Description
IUnitCarrier

CurrSlot

Declaration
public Transform CurrSlot { get; }
Property Value
Type Description
Transform

CurrSlotID

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

IsIdle

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

unit

Declaration
protected IUnit unit { get; }
Property Value
Type Description
IUnit

Methods

EjectAction(Boolean)

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

EjectActionLocal(Boolean)

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

GetAddableData(SetTargetInputData)

Declaration
public AddableUnitData GetAddableData(SetTargetInputData input)
Parameters
Type Name Description
SetTargetInputData input
Returns
Type Description
AddableUnitData

GetAddableData(Boolean)

Declaration
public AddableUnitData GetAddableData(bool playerCommand)
Parameters
Type Name Description
Boolean playerCommand
Returns
Type Description
AddableUnitData

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(IUnitCarrier, AddableUnitData)

Declaration
public ErrorMessage IsTargetValid(IUnitCarrier carrier, AddableUnitData addableData)
Parameters
Type Name Description
IUnitCarrier carrier
AddableUnitData addableData
Returns
Type Description
ErrorMessage

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

OnCarrierUnitAdded(IUnitCarrier, UnitCarrierEventArgs)

Declaration
public void OnCarrierUnitAdded(IUnitCarrier carrier, UnitCarrierEventArgs args)
Parameters
Type Name Description
IUnitCarrier carrier
UnitCarrierEventArgs args

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>)

OnStop()

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

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)

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

Declaration
protected override bool OnTaskUICacheUpdate(List<EntityComponentTaskUIAttributes> taskUIAttributesCache, List<string> disabledTaskCodesCache)
Parameters
Type Name Description
List<EntityComponentTaskUIAttributes> taskUIAttributesCache
List<String> disabledTaskCodesCache
Returns
Type Description
Boolean
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IFactionEntity>.OnTaskUICacheUpdate(System.Collections.Generic.List<EntityComponentTaskUIAttributes>, System.Collections.Generic.List<System.String>)

OnTaskUIClick(EntityComponentTaskUIAttributes)

Declaration
public override bool OnTaskUIClick(EntityComponentTaskUIAttributes taskAttributes)
Parameters
Type Name Description
EntityComponentTaskUIAttributes taskAttributes
Returns
Type Description
Boolean
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IFactionEntity>.OnTaskUIClick(EntityComponentTaskUIAttributes)

SetTarget(IUnitCarrier, AddableUnitData)

Declaration
public ErrorMessage SetTarget(IUnitCarrier carrier, AddableUnitData addableData)
Parameters
Type Name Description
IUnitCarrier carrier
AddableUnitData addableData
Returns
Type Description
ErrorMessage

Events

UnitAdded

Declaration
public event CustomEventHandler<IUnitCarrier, UnitCarrierEventArgs> UnitAdded
Event Type
Type Description
CustomEventHandler<IUnitCarrier, UnitCarrierEventArgs>

UnitRemoved

Declaration
public event CustomEventHandler<IUnitCarrier, UnitCarrierEventArgs> UnitRemoved
Event Type
Type Description
CustomEventHandler<IUnitCarrier, UnitCarrierEventArgs>

Implements

IEntityPreInitializable
IEntityPostInitializable