Interface IMovementComponent

Inherited Members
Namespace: RTSEngine.EntityComponent
Assembly: cs.temp.dll.dll
Syntax
public interface IMovementComponent : IEntityTargetComponent, IEntityComponent, IMonoBehaviour, IEntityPostInitializable

Properties

AreasMask

Declaration
TerrainAreaMask AreasMask { get; }
Property Value
Type Description
TerrainAreaMask

Controller

Declaration
IMovementController Controller { get; }
Property Value
Type Description
IMovementController

Destination

Declaration
Vector3 Destination { get; }
Property Value
Type Description
Vector3

DestinationReached

Declaration
bool DestinationReached { get; }
Property Value
Type Description
Boolean

Formation

Declaration
MovementFormationSelector Formation { get; }
Property Value
Type Description
MovementFormationSelector

MovementPriority

Declaration
int MovementPriority { get; }
Property Value
Type Description
Int32

StartPosition

Declaration
Vector3 StartPosition { get; }
Property Value
Type Description
Vector3

Target

Declaration
TargetData<IEntity> Target { get; }
Property Value
Type Description
TargetData<IEntity>

TargetPositionMarker

Declaration
IMovementTargetPositionMarker TargetPositionMarker { get; }
Property Value
Type Description
IMovementTargetPositionMarker

TerrainAreas

Declaration
IReadOnlyList<TerrainAreaType> TerrainAreas { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyList<TerrainAreaType>

Unit

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

Methods

OnPathDestination(TargetData<IEntity>, MovementSource)

Declaration
ErrorMessage OnPathDestination(TargetData<IEntity> newTarget, MovementSource source)
Parameters
Type Name Description
TargetData<IEntity> newTarget
MovementSource source
Returns
Type Description
ErrorMessage

OnPathFailure()

Declaration
void OnPathFailure()

OnPathPrepared(MovementSource)

Declaration
void OnPathPrepared(MovementSource source)
Parameters
Type Name Description
MovementSource source

SetPosition(Vector3)

Declaration
ErrorMessage SetPosition(Vector3 position)
Parameters
Type Name Description
Vector3 position
Returns
Type Description
ErrorMessage

SetTarget(TargetData<IEntity>, Single, MovementSource)

Declaration
ErrorMessage SetTarget(TargetData<IEntity> newTarget, float stoppingDistance, MovementSource source)
Parameters
Type Name Description
TargetData<IEntity> newTarget
System.Single stoppingDistance
MovementSource source
Returns
Type Description
ErrorMessage

SetTargetLocal(TargetData<IEntity>, Single, MovementSource)

Declaration
ErrorMessage SetTargetLocal(TargetData<IEntity> newTarget, float stoppingDistance, MovementSource source)
Parameters
Type Name Description
TargetData<IEntity> newTarget
System.Single stoppingDistance
MovementSource source
Returns
Type Description
ErrorMessage

UpdateRotationTarget(IEntity, Vector3, Boolean, Boolean)

Declaration
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
void UpdateRotationTarget(Quaternion targetRotation, bool setImmediately = false)
Parameters
Type Name Description
Quaternion targetRotation
Boolean setImmediately

Events

MovementStart

Declaration
event CustomEventHandler<IMovementComponent, MovementEventArgs> MovementStart
Event Type
Type Description
CustomEventHandler<IMovementComponent, MovementEventArgs>

MovementStop

Declaration
event CustomEventHandler<IMovementComponent, EventArgs> MovementStop
Event Type
Type Description
CustomEventHandler<IMovementComponent, System.EventArgs>

PositionSet

Declaration
event CustomEventHandler<IMovementComponent, EventArgs> PositionSet
Event Type
Type Description
CustomEventHandler<IMovementComponent, System.EventArgs>