Interface IEntity

Inherited Members
Namespace: RTSEngine.Entities
Assembly: cs.temp.dll.dll
Syntax
public interface IEntity : IMonoBehaviour, IEquatable<IEntity>

Properties

ActiveAttackComponents

Declaration
IEnumerable<IAttackComponent> ActiveAttackComponents { get; }
Property Value
Type Description
IEnumerable<IAttackComponent>

AddableUnitComponents

Declaration
IReadOnlyDictionary<string, IAddableUnit> AddableUnitComponents { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<String, IAddableUnit>

AnimatorController

Declaration
IAnimatorController AnimatorController { get; }
Property Value
Type Description
IAnimatorController

AttackComponents

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

AttackComponentsDic

Declaration
IReadOnlyDictionary<string, IAttackComponent> AttackComponentsDic { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<String, IAttackComponent>

AudioSourceComponent

Declaration
AudioSource AudioSourceComponent { get; }
Property Value
Type Description
AudioSource

CanAttack

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

CanLaunchTask

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

Category

Declaration
IEnumerable<string> Category { get; }
Property Value
Type Description
IEnumerable<String>

Code

Declaration
string Code { get; }
Property Value
Type Description
String

Description

Declaration
string Description { get; }
Property Value
Type Description
String

EntityComponents

Declaration
IReadOnlyDictionary<string, IEntityComponent> EntityComponents { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<String, IEntityComponent>

EntityTargetComponents

Declaration
IReadOnlyDictionary<string, IEntityTargetComponent> EntityTargetComponents { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<String, IEntityTargetComponent>

EntityTargetProgressComponents

Declaration
IReadOnlyDictionary<string, IEntityTargetProgressComponent> EntityTargetProgressComponents { get; }
Property Value
Type Description
System.Collections.Generic.IReadOnlyDictionary<String, IEntityTargetProgressComponent>

FactionID

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

FirstActiveAttackComponent

Declaration
IAttackComponent FirstActiveAttackComponent { get; }
Property Value
Type Description
IAttackComponent

Health

Declaration
IEntityHealth Health { get; }
Property Value
Type Description
IEntityHealth

Icon

Declaration
Sprite Icon { get; }
Property Value
Type Description
Sprite

IsDummy

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

IsFree

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

IsIdle

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

IsInitialized

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

IsInteractable

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

IsSearchable

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

Key

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

MinimapIconHandler

Declaration
IEntityMinimapIconHandler MinimapIconHandler { get; }
Property Value
Type Description
IEntityMinimapIconHandler

Model

Declaration
GameObject Model { get; }
Property Value
Type Description
GameObject

MovementComponent

Declaration
IMovementComponent MovementComponent { get; }
Property Value
Type Description
IMovementComponent

Name

Declaration
string Name { get; }
Property Value
Type Description
String

PendingTaskEntityComponents

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

PendingTasksHandler

Declaration
IPendingTasksHandler PendingTasksHandler { get; }
Property Value
Type Description
IPendingTasksHandler

Radius

Declaration
float Radius { get; }
Property Value
Type Description
System.Single

Selection

Declaration
IEntitySelection Selection { get; }
Property Value
Type Description
IEntitySelection

SelectionColor

Declaration
Color SelectionColor { get; }
Property Value
Type Description
Color

SelectionMarker

Declaration
IEntitySelectionMarker SelectionMarker { get; }
Property Value
Type Description
IEntitySelectionMarker

Slot

Declaration
IFactionSlot Slot { get; }
Property Value
Type Description
IFactionSlot

TasksQueue

Declaration
IEntityTasksQueueHandler TasksQueue { get; }
Property Value
Type Description
IEntityTasksQueueHandler

Type

Declaration
EntityType Type { get; }
Property Value
Type Description
EntityType

WorkerMgr

Declaration
IEntityWorkerManager WorkerMgr { get; }
Property Value
Type Description
IEntityWorkerManager

Methods

CanMove()

Declaration
bool CanMove()
Returns
Type Description
Boolean

CanMove(Boolean)

Declaration
bool CanMove(bool playerCommand)
Parameters
Type Name Description
Boolean playerCommand
Returns
Type Description
Boolean

InitPrefab(IGameManager)

Declaration
void InitPrefab(IGameManager gameMgr)
Parameters
Type Name Description
IGameManager gameMgr

SetFaction(IEntity, Int32)

Declaration
ErrorMessage SetFaction(IEntity source, int targetFactionID)
Parameters
Type Name Description
IEntity source
Int32 targetFactionID
Returns
Type Description
ErrorMessage

SetFactionLocal(IEntity, Int32)

Declaration
ErrorMessage SetFactionLocal(IEntity source, int targetFactionID)
Parameters
Type Name Description
IEntity source
Int32 targetFactionID
Returns
Type Description
ErrorMessage

SetIdle(IEntityTargetComponent, Boolean)

Declaration
void SetIdle(IEntityTargetComponent exception, bool includeMovement = true)
Parameters
Type Name Description
IEntityTargetComponent exception
Boolean includeMovement

SetIdle(Boolean)

Declaration
void SetIdle(bool includeMovement = true)
Parameters
Type Name Description
Boolean includeMovement

SetTargetFirst(SetTargetInputData)

Declaration
ErrorMessage SetTargetFirst(SetTargetInputData input)
Parameters
Type Name Description
SetTargetInputData input
Returns
Type Description
ErrorMessage

UpdateRadius(Single)

Updates the 'Radius' property of the entity. Make sure this call is done locally on all client instances in case of a multiplayer game to avoid desync!

Declaration
void UpdateRadius(float newRadius)
Parameters
Type Name Description
System.Single newRadius

New radius value.

UpgradeComponent(UpgradeElement<IEntityComponent>)

Declaration
void UpgradeComponent(UpgradeElement<IEntityComponent> upgradeElement)
Parameters
Type Name Description
UpgradeElement<IEntityComponent> upgradeElement

Events

EntityComponentUpgraded

Declaration
event CustomEventHandler<IEntity, EntityComponentUpgradeEventArgs> EntityComponentUpgraded
Event Type
Type Description
CustomEventHandler<IEntity, EntityComponentUpgradeEventArgs>

EntityEnterIdle

Declaration
event CustomEventHandler<IEntity, EventArgs> EntityEnterIdle
Event Type
Type Description
CustomEventHandler<IEntity, System.EventArgs>

EntityExitIdle

Declaration
event CustomEventHandler<IEntity, EventArgs> EntityExitIdle
Event Type
Type Description
CustomEventHandler<IEntity, System.EventArgs>

EntityInitiated

Declaration
event CustomEventHandler<IEntity, EventArgs> EntityInitiated
Event Type
Type Description
CustomEventHandler<IEntity, System.EventArgs>

FactionUpdateComplete

Declaration
event CustomEventHandler<IEntity, FactionUpdateArgs> FactionUpdateComplete
Event Type
Type Description
CustomEventHandler<IEntity, FactionUpdateArgs>

FactionUpdateStart

Declaration
event CustomEventHandler<IEntity, FactionUpdateArgs> FactionUpdateStart
Event Type
Type Description
CustomEventHandler<IEntity, FactionUpdateArgs>