Class UnitCarrier

Inheritance
Object
EntityComponentBase
UnitCarrier
Implements
IEntityPreInitializable
IAddableUnit
IEntityPostInitializable
Inherited Members
Namespace: RTSEngine.EntityComponent
Assembly: cs.temp.dll.dll
Syntax
public class UnitCarrier : EntityComponentBase, IEntityPreInitializable, IUnitCarrier, IEntityComponent, IMonoBehaviour, IAddableUnit, IEntityPostInitializable

Fields

tabID

Declaration
public Int2D tabID
Field Value
Type Description
Int2D

Properties

AllowMovementToExitCarrier

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

audioMgr

Declaration
protected IGameAudioManager audioMgr { get; }
Property Value
Type Description
IGameAudioManager

CarrierSlots

Declaration
public IReadOnlyList<IUnit> CarrierSlots { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<IUnit>

CurrAmount

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

factionEntity

Declaration
protected IFactionEntity factionEntity { get; }
Property Value
Type Description
IFactionEntity

globalEvent

Declaration
protected IGlobalEventPublisher globalEvent { get; }
Property Value
Type Description
IGlobalEventPublisher

gridSearch

Declaration
protected IGridSearchHandler gridSearch { get; }
Property Value
Type Description
IGridSearchHandler

HasMaxAmount

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

MaxAmount

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

mvtMgr

Declaration
protected IMovementManager mvtMgr { get; }
Property Value
Type Description
IMovementManager

selectionMgr

Declaration
protected ISelectionManager selectionMgr { get; }
Property Value
Type Description
ISelectionManager

terrainMgr

Declaration
protected ITerrainManager terrainMgr { get; }
Property Value
Type Description
ITerrainManager

Methods

Add(IUnit, AddableUnitData)

Declaration
public ErrorMessage Add(IUnit unit, AddableUnitData addableData = null)
Parameters
Type Name Description
IUnit unit
AddableUnitData addableData
Returns
Type Description
ErrorMessage

CallUnitsAction(Boolean)

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

CanAdd(IUnit, AddableUnitData)

Declaration
public ErrorMessage CanAdd(IUnit unit, AddableUnitData addableData = null)
Parameters
Type Name Description
IUnit unit
AddableUnitData addableData
Returns
Type Description
ErrorMessage

CanCallUnit(SetTargetInputData)

Declaration
public ErrorMessage CanCallUnit(SetTargetInputData data)
Parameters
Type Name Description
SetTargetInputData data
Returns
Type Description
ErrorMessage

CanMove(IUnit, AddableUnitData)

Declaration
public ErrorMessage CanMove(IUnit unit, AddableUnitData addableData = null)
Parameters
Type Name Description
IUnit unit
AddableUnitData addableData
Returns
Type Description
ErrorMessage

EjectAction(IUnit, Boolean, Boolean)

Declaration
public ErrorMessage EjectAction(IUnit unit, bool destroyed, bool playerCommand)
Parameters
Type Name Description
IUnit unit
Boolean destroyed
Boolean playerCommand
Returns
Type Description
ErrorMessage

EjectAllAction(Boolean, Boolean)

Declaration
public ErrorMessage EjectAllAction(bool destroyed, bool playerCommand)
Parameters
Type Name Description
Boolean destroyed
Boolean playerCommand
Returns
Type Description
ErrorMessage

GetAddablePosition(IUnit)

Declaration
public Vector3 GetAddablePosition(IUnit unit)
Parameters
Type Name Description
IUnit unit
Returns
Type Description
Vector3

GetEjectablePosition(IUnit)

Declaration
public Vector3 GetEjectablePosition(IUnit unit)
Parameters
Type Name Description
IUnit unit
Returns
Type Description
Vector3

HandleComponentUpgrade(IEntityComponent)

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

IsUnitStored(IUnit)

Declaration
public bool IsUnitStored(IUnit unit)
Parameters
Type Name Description
IUnit unit
Returns
Type Description
Boolean

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

Move(IUnit, AddableUnitData)

Declaration
public ErrorMessage Move(IUnit unit, AddableUnitData addableData)
Parameters
Type Name Description
IUnit unit
AddableUnitData addableData
Returns
Type Description
ErrorMessage

OnActiveStatusUpdated()

Declaration
protected override void OnActiveStatusUpdated()
Overrides

OnDisabled()

Declaration
protected override void OnDisabled()
Overrides

OnInit()

Declaration
protected override void OnInit()
Overrides

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

OnTaskUIClick(EntityComponentTaskUIAttributes)

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

Events

UnitAdded

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

UnitCalled

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

UnitRemoved

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

Implements

IEntityPreInitializable
IAddableUnit
IEntityPostInitializable