Class UnitMovement
Implements
IEntityPreInitializable
IEntityPostInitializable
Assembly: cs.temp.dll.dll
Syntax
public class UnitMovement : FactionEntityTargetComponent<IEntity>, IEntityPreInitializable, IMovementComponent, IEntityTargetComponent, IEntityComponent, IMonoBehaviour, IEntityPostInitializable
Properties
AreasMask
Declaration
public TerrainAreaMask AreasMask { get; }
Property Value
Type |
Description |
TerrainAreaMask |
|
CanSearch
Declaration
public override bool CanSearch { get; }
Property Value
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.CanSearch
Controller
An instance that extends the IMovementController interface which is responsible for computing the navigation path and moving the unit.
Declaration
public IMovementController Controller { get; }
Property Value
Type |
Description |
IMovementController |
|
Destination
Declaration
public Vector3 Destination { get; }
Property Value
DestinationReached
Has the unit reached its current's path destination?
Declaration
public bool DestinationReached { get; }
Property Value
Gets the MovementFormation struct that defines the movement formation for the unit.
Declaration
public MovementFormationSelector Formation { get; }
Property Value
Type |
Description |
MovementFormationSelector |
|
HasTarget
Declaration
public override bool HasTarget { get; }
Property Value
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.HasTarget
IsIdle
Declaration
public override bool IsIdle { get; }
Property Value
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.IsIdle
MovementPriority
The lower the Movement Priority value is, the more units of this type will be prioritized when generating the path destinations.
This can be used to have units pick path destinations in front of other units with higher Movement Priority values in the case of row-based formation movement.
Declaration
public int MovementPriority { get; }
Property Value
NextCorner
The current corner that the unit is moving towards in its current path.
Declaration
public Vector3 NextCorner { get; }
Property Value
NextRotationTarget
Declaration
public Quaternion NextRotationTarget { get; }
Property Value
Type |
Description |
Quaternion |
|
StartPosition
Declaration
public Vector3 StartPosition { get; }
Property Value
TargetPositionMarker
The IMovementTargetPositionMarker instance assigned to the unit movement that marks the position that the unit is moving towards.
Declaration
public IMovementTargetPositionMarker TargetPositionMarker { get; }
Property Value
Type |
Description |
IMovementTargetPositionMarker |
|
TerrainAreas
Declaration
public IReadOnlyList<TerrainAreaType> TerrainAreas { get; }
Property Value
Type |
Description |
System.Collections.Generic.IReadOnlyList<TerrainAreaType> |
|
TimeModifiedControllerData
Declaration
public MovementControllerData TimeModifiedControllerData { get; }
Property Value
Type |
Description |
MovementControllerData |
|
timeModifier
Declaration
protected ITimeModifier timeModifier { get; }
Property Value
Type |
Description |
ITimeModifier |
|
Unit
Declaration
public IUnit Unit { get; }
Property Value
Methods
CanStopOnNoTarget()
Declaration
protected override bool CanStopOnNoTarget()
Returns
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.CanStopOnNoTarget()
IsTargetInRange(Vector3, TargetData<IEntity>)
Declaration
public override bool IsTargetInRange(Vector3 sourcePosition, TargetData<IEntity> target)
Parameters
Type |
Name |
Description |
Vector3 |
sourcePosition |
|
TargetData<IEntity> |
target |
|
Returns
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.IsTargetInRange(Vector3, RTSEngine.EntityComponent.TargetData<IEntity>)
Declaration
public override ErrorMessage IsTargetValid(SetTargetInputData data)
Parameters
Returns
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.IsTargetValid(RTSEngine.EntityComponent.SetTargetInputData)
Declaration
public override ErrorMessage LaunchActionLocal(byte actionID, SetTargetInputData input)
Parameters
Returns
Overrides
OnComponentUpgraded(FactionEntityTargetComponent<IEntity>)
Declaration
protected override void OnComponentUpgraded(FactionEntityTargetComponent<IEntity> sourceFactionEntityTargetComponent)
Parameters
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.OnComponentUpgraded(RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>)
OnHandleAddableUnitStop()
Declaration
public void OnHandleAddableUnitStop()
OnPathDestination(TargetData<IEntity>, MovementSource)
Declaration
public ErrorMessage OnPathDestination(TargetData<IEntity> newTarget, MovementSource source)
Parameters
Type |
Name |
Description |
TargetData<IEntity> |
newTarget |
|
MovementSource |
source |
|
Returns
OnPathFailure()
Declaration
public void OnPathFailure()
OnPathPrepared(MovementSource)
Declaration
public void OnPathPrepared(MovementSource source)
Parameters
Type |
Name |
Description |
MovementSource |
source |
|
OnStop()
Stops the current unit's movement.
Declaration
protected override void OnStop()
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.OnStop()
OnTargetActiveStatusUpdated()
Declaration
protected override void OnTargetActiveStatusUpdated()
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.OnTargetActiveStatusUpdated()
OnTargetDisabled()
Declaration
protected override void OnTargetDisabled()
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.OnTargetDisabled()
OnTargetInit()
Declaration
protected override void OnTargetInit()
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.OnTargetInit()
SetPosition(Vector3)
Declaration
public ErrorMessage SetPosition(Vector3 position)
Parameters
Type |
Name |
Description |
Vector3 |
position |
|
Returns
Declaration
public override ErrorMessage SetTarget(SetTargetInputData input)
Parameters
Returns
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.SetTarget(RTSEngine.EntityComponent.SetTargetInputData)
SetTarget(TargetData<IEntity>, Single, MovementSource)
Declaration
public ErrorMessage SetTarget(TargetData<IEntity> newTarget, float stoppingDistance, MovementSource source)
Parameters
Type |
Name |
Description |
TargetData<IEntity> |
newTarget |
|
System.Single |
stoppingDistance |
|
MovementSource |
source |
|
Returns
Declaration
public override ErrorMessage SetTargetLocal(SetTargetInputData input)
Parameters
Returns
Overrides
RTSEngine.EntityComponent.FactionEntityTargetComponent<IEntity>.SetTargetLocal(RTSEngine.EntityComponent.SetTargetInputData)
SetTargetLocal(TargetData<IEntity>, Single, MovementSource)
Declaration
public ErrorMessage SetTargetLocal(TargetData<IEntity> newTarget, float stoppingDistance, MovementSource source)
Parameters
Type |
Name |
Description |
TargetData<IEntity> |
newTarget |
|
System.Single |
stoppingDistance |
|
MovementSource |
source |
|
Returns
UpdateRotationTarget(IEntity, Vector3, Boolean, Boolean)
Declaration
public void UpdateRotationTarget(IEntity rotationTarget, Vector3 rotationPosition, bool lookAway = false, bool setImmediately = false)
Parameters
Type |
Name |
Description |
IEntity |
rotationTarget |
|
Vector3 |
rotationPosition |
|
Boolean |
lookAway |
|
Boolean |
setImmediately |
|
UpdateRotationTarget(Quaternion, Boolean)
Declaration
public void UpdateRotationTarget(Quaternion targetRotation, bool setImmediately = false)
Parameters
Type |
Name |
Description |
Quaternion |
targetRotation |
|
Boolean |
setImmediately |
|
Events
MovementStart
Declaration
public event CustomEventHandler<IMovementComponent, MovementEventArgs> MovementStart
Event Type
MovementStop
Declaration
public event CustomEventHandler<IMovementComponent, EventArgs> MovementStop
Event Type
PositionSet
Declaration
public event CustomEventHandler<IMovementComponent, EventArgs> PositionSet
Event Type
Implements
IEntityPreInitializable
IEntityPostInitializable