Class RTSHelper

Inheritance

Object

RTSHelper

Namespace: RTSEngine

Assembly: cs.temp.dll.dll

Syntax

public static class RTSHelper

Fields

FREE_FACTION_ID

Declaration

public static int FREE_FACTION_ID

Field Value

Type	Description
Int32

STR_SEPARATOR_L1

Declaration

public static char STR_SEPARATOR_L1

Field Value

Type	Description
Char

STR_SEPARATOR_L2

Declaration

public static char STR_SEPARATOR_L2

Field Value

Type	Description
Char

Properties

LoggingService

Declaration

public static ILoggingService LoggingService { get; }

Property Value

Type	Description
ILoggingService

MiddleScreenPoint

Declaration

public static Vector3 MiddleScreenPoint { get; }

Property Value

Type	Description
Vector3

SemiTransparentWhite

Declaration

public static Color SemiTransparentWhite { get; }

Property Value

Type	Description
Color

Methods

DecreaseCountOnElementInCountDictionary(String[], IReadOnlyDictionary<String, Int32>, ref Int32)

Declaration

public static bool DecreaseCountOnElementInCountDictionary(string[] elements, IReadOnlyDictionary<string, int> countDict, ref int count)

Parameters

Type	Name	Description
String[]	elements
IReadOnlyDictionary<String, Int32>	countDict
Int32	count

Returns

Type	Description
Boolean

FilterEntities<T>(IEnumerable<T>, Func<T, Boolean>)

Declaration

public static IEnumerable<T> FilterEntities<T>(IEnumerable<T> entities, Func<T, bool> condition)
    where T : IEntity

Parameters

Type	Name	Description
IEnumerable<T>	entities
Func<T, Boolean>	condition

Returns

Type	Description
IEnumerable<T>

Type Parameters

Name	Description
T

FindIndex<T>(IReadOnlyList<T>, Predicate<T>)

Declaration

public static int FindIndex<T>(IReadOnlyList<T> list, Predicate<T> match)

Parameters

Type	Name	Description
IReadOnlyList<T>	list
Predicate<T>	match

Returns

Type	Description
Int32

Type Parameters

Name	Description
T

FromGameObject<T>(IEnumerable<GameObject>)

Declaration

public static IEnumerable<T> FromGameObject<T>(this IEnumerable<GameObject> gameObjects)
    where T : IMonoBehaviour

Parameters

Type	Name	Description
IEnumerable<GameObject>	gameObjects

Returns

Type	Description
IEnumerable<T>

Type Parameters

Name	Description
T

GenerateRandomIndexList(Int32)

Declaration

public static List<int> GenerateRandomIndexList(int length)

Parameters

Type	Name	Description
Int32	length

Returns

Type	Description
List<Int32>

GetAttackTargetPosition(TargetData<IFactionEntity>)

Declaration

public static Vector3 GetAttackTargetPosition(TargetData<IFactionEntity> target)

Parameters

Type	Name	Description
TargetData<IFactionEntity>	target

Returns

Type	Description
Vector3

GetAttackTargetRadius(TargetData<IFactionEntity>)

Declaration

public static float GetAttackTargetRadius(TargetData<IFactionEntity> target)

Parameters

Type	Name	Description
TargetData<IFactionEntity>	target

Returns

Type	Description
Single

GetClosestEntity<T>(Vector3, IEnumerable<T>)

Declaration

public static T GetClosestEntity<T>(Vector3 searchPosition, IEnumerable<T> entities)
    where T : IEntity

Parameters

Type	Name	Description
Vector3	searchPosition
IEnumerable<T>	entities

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetClosestEntity<T>(Vector3, IEnumerable<T>, Func<T, Boolean>)

Declaration

public static T GetClosestEntity<T>(Vector3 searchPosition, IEnumerable<T> entities, Func<T, bool> condition)
    where T : IEntity

Parameters

Type	Name	Description
Vector3	searchPosition
IEnumerable<T>	entities
Func<T, Boolean>	condition

Returns

Type	Description
T

Type Parameters

Name	Description
T

GetEntitiesDirection(IReadOnlyList<IEntity>, Vector3)

Gets the direction of a list of entities in regards to a target position.

Declaration

public static Vector3 GetEntitiesDirection(IReadOnlyList<IEntity> entities, Vector3 targetPosition)

Parameters

Type	Name	Description
IReadOnlyList<IEntity>	entities	List of IEntity instances.
Vector3	targetPosition	Vector3 that represents the position the entities will get their direction to.

Returns

Type	Description
Vector3	Vector3 that represents the direction of the entities towards the target position.

GetEntityFirst<T>(IEnumerable<T>, out T, Func<T, Boolean>)

Searches for a building center that allows the given building type to be built inside its territory.

Declaration

public static bool GetEntityFirst<T>(this IEnumerable<T> set, out T entity, Func<T, bool> condition)
    where T : IEntity

Parameters

Type	Name	Description
IEnumerable<T>	set
T	entity
Func<T, Boolean>	condition

Returns

Type	Description
Boolean

Type Parameters

Name	Description
T

GetKey(IEntity)

Declaration

public static int GetKey(this IEntity entity)

Parameters

Type	Name	Description
IEntity	entity

Returns

Type	Description
Int32

GetKey(RTSEngineScriptableObject)

Declaration

public static string GetKey(this RTSEngineScriptableObject so)

Parameters

Type	Name	Description
RTSEngineScriptableObject	so

Returns

Type	Description
String

GetLookRotation(Transform, Vector3, Boolean, Boolean)

Declaration

public static Quaternion GetLookRotation(Transform transform, Vector3 targetPosition, bool reversed = false, bool fixYRotation = true)

Parameters

Type	Name	Description
Transform	transform
Vector3	targetPosition
Boolean	reversed
Boolean	fixYRotation

Returns

Type	Description
Quaternion

GetNextIndex<T>(Int32, T[])

Declaration

public static int GetNextIndex<T>(this int index, T[] array)

Parameters

Type	Name	Description
Int32	index
T[]	array

Returns

Type	Description
Int32

Type Parameters

Name	Description
T

GetNextIndex<T>(Int32, IReadOnlyList<T>)

Declaration

public static int GetNextIndex<T>(this int index, IReadOnlyList<T> list)

Parameters

Type	Name	Description
Int32	index
IReadOnlyList<T>	list

Returns

Type	Description
Int32

Type Parameters

Name	Description
T

GetSuperInterfaceType<T>(Type)

Find the first interface that implements a service interface in an implementation or returns the implementing class if it directly implements a service.

Declaration

public static Type GetSuperInterfaceType<T>(this Type implementation)

Parameters

Type	Name	Description
Type	implementation

Returns

Type	Description
Type

Type Parameters

Name	Description
T

GetUnitSquad(IUnit)

Declaration

public static IUnitSquad GetUnitSquad(this IUnit unit)

Parameters

Type	Name	Description
IUnit	unit

Returns

Type	Description
IUnitSquad

GetWorkerManager(IEntity)

Declaration

public static IEntityWorkerManager GetWorkerManager(this IEntity source)

Parameters

Type	Name	Description
IEntity	source

Returns

Type	Description
IEntityWorkerManager

HasAuthority(IEntity)

Determines whether an entity instance belongs to the local player or not.

Declaration

public static bool HasAuthority(this IEntity entity)

Parameters

Type	Name	Description
IEntity	entity	IEntity instance to test.

Returns

Type	Description
Boolean	True if the entity belongs to the local player, otherwise false.

HasAuthority(IEnumerable<IEntity>)

Declaration

public static bool HasAuthority(this IEnumerable<IEntity> entities)

Parameters

Type	Name	Description
IEnumerable<IEntity>	entities

Returns

Type	Description
Boolean

IndexOf<T>(IReadOnlyList<T>, T)

Declaration

public static int IndexOf<T>(IReadOnlyList<T> list, T elementToFind)

Parameters

Type	Name	Description
IReadOnlyList<T>	list
T	elementToFind

Returns

Type	Description
Int32

Type Parameters

Name	Description
T

Init(IGameManager)

Declaration

public static void Init(IGameManager gameMgr)

Parameters

Type	Name	Description
IGameManager	gameMgr

Init<T>(IServicePublisher<T>)

Declaration

public static void Init<T>(IServicePublisher<T> publisher)

Parameters

Type	Name	Description
IServicePublisher<T>	publisher

Type Parameters

Name	Description
T

InitFactionEntities(IReadOnlyList<IFactionEntity>, Int32)

Declaration

public static void InitFactionEntities(IReadOnlyList<IFactionEntity> entities, int factionID)

Parameters

Type	Name	Description
IReadOnlyList<IFactionEntity>	entities
Int32	factionID

IsActiveFaction(IFactionSlot)

Declaration

public static bool IsActiveFaction(this IFactionSlot factionSlot)

Parameters

Type	Name	Description
IFactionSlot	factionSlot

Returns

Type	Description
Boolean

IsAttackLOSBlocked(IAttackComponent, Vector3, Vector3)

Declaration

public static ErrorMessage IsAttackLOSBlocked(IAttackComponent attackComponent, Vector3 targetPosition, Vector3 testPosition)

Parameters

Type	Name	Description
IAttackComponent	attackComponent
Vector3	targetPosition
Vector3	testPosition

Returns

Type	Description
ErrorMessage

IsAttackLOSBlocked(PathDestinationInputData, Vector3)

Declaration

public static ErrorMessage IsAttackLOSBlocked(PathDestinationInputData pathDestinationInput, Vector3 testPosition)

Parameters

Type	Name	Description
PathDestinationInputData	pathDestinationInput
Vector3	testPosition

Returns

Type	Description
ErrorMessage

IsBuilding(IEntity)

Declaration

public static bool IsBuilding(this IEntity source)

Parameters

Type	Name	Description
IEntity	source

Returns

Type	Description
Boolean

IsEntityTypeMatch(IEntity, EntityType)

Declaration

public static bool IsEntityTypeMatch(this IEntity entity, EntityType testType)

Parameters

Type	Name	Description
IEntity	entity
EntityType	testType

Returns

Type	Description
Boolean

IsFactionEntity(IEntity)

Declaration

public static bool IsFactionEntity(this IEntity source)

Parameters

Type	Name	Description
IEntity	source

Returns

Type	Description
Boolean

IsFactionEntity(IEntity, Int32)

Declaration

public static bool IsFactionEntity(this IEntity entity, int factionID)

Parameters

Type	Name	Description
IEntity	entity
Int32	factionID

Returns

Type	Description
Boolean

IsFriendlyFaction(IEntity, IEntity)

Declaration

public static bool IsFriendlyFaction(this IEntity source, IEntity target)

Parameters

Type	Name	Description
IEntity	source
IEntity	target

Returns

Type	Description
Boolean

IsFriendlyFaction(IEntity, IFactionSlot)

Declaration

public static bool IsFriendlyFaction(this IEntity source, IFactionSlot slot)

Parameters

Type	Name	Description
IEntity	source
IFactionSlot	slot

Returns

Type	Description
Boolean

IsFriendlyFaction(IEntity, Int32)

Declaration

public static bool IsFriendlyFaction(this IEntity source, int factionID)

Parameters

Type	Name	Description
IEntity	source
Int32	factionID

Returns

Type	Description
Boolean

IsFriendlyFaction(Int32, Int32)

Declaration

public static bool IsFriendlyFaction(this int sourceFactionID, int targetFactionID)

Parameters

Type	Name	Description
Int32	sourceFactionID
Int32	targetFactionID

Returns

Type	Description
Boolean

IsInLayerMask(LayerMask, Int32)

Declaration

public static bool IsInLayerMask(LayerMask mask, int layer)

Parameters

Type	Name	Description
LayerMask	mask
Int32	layer

Returns

Type	Description
Boolean

IsLocalPlayerFaction(IEntity)

Declaration

public static bool IsLocalPlayerFaction(this IEntity entity)

Parameters

Type	Name	Description
IEntity	entity

Returns

Type	Description
Boolean

IsLocalPlayerFaction(IFactionSlot)

Declaration

public static bool IsLocalPlayerFaction(this IFactionSlot factionSlot)

Parameters

Type	Name	Description
IFactionSlot	factionSlot

Returns

Type	Description
Boolean

IsLocalPlayerFaction(IEnumerable<IEntity>)

Declaration

public static bool IsLocalPlayerFaction(this IEnumerable<IEntity> entities)

Parameters

Type	Name	Description
IEnumerable<IEntity>	entities

Returns

Type	Description
Boolean

IsLocalPlayerFaction(Int32)

Declaration

public static bool IsLocalPlayerFaction(this int factionID)

Parameters

Type	Name	Description
Int32	factionID

Returns

Type	Description
Boolean

IsMasterInstance()

Declaration

public static bool IsMasterInstance()

Returns

Type	Description
Boolean

IsNPCFaction(IEntity)

Declaration

public static bool IsNPCFaction(this IEntity entity)

Parameters

Type	Name	Description
IEntity	entity

Returns

Type	Description
Boolean

IsNPCFaction(IFactionSlot)

Declaration

public static bool IsNPCFaction(this IFactionSlot factionSlot)

Parameters

Type	Name	Description
IFactionSlot	factionSlot

Returns

Type	Description
Boolean

IsNPCFaction(IEnumerable<IEntity>)

Declaration

public static bool IsNPCFaction(this IEnumerable<IEntity> entities)

Parameters

Type	Name	Description
IEnumerable<IEntity>	entities

Returns

Type	Description
Boolean

IsPrefab(GameObject)

Declaration

public static bool IsPrefab(this GameObject gameObject)

Parameters

Type	Name	Description
GameObject	gameObject

Returns

Type	Description
Boolean

IsResource(IEntity)

Declaration

public static bool IsResource(this IEntity source)

Parameters

Type	Name	Description
IEntity	source

Returns

Type	Description
Boolean

IsResourceBuilding(IEntity)

Declaration

public static bool IsResourceBuilding(this IEntity source)

Parameters

Type	Name	Description
IEntity	source

Returns

Type	Description
Boolean

IsResourceOnly(IEntity)

Declaration

public static bool IsResourceOnly(this IEntity source)

Parameters

Type	Name	Description
IEntity	source

Returns

Type	Description
Boolean

IsSameFaction(IEntity, IEntity)

Declaration

public static bool IsSameFaction(this IEntity entity1, IEntity entity2)

Parameters

Type	Name	Description
IEntity	entity1
IEntity	entity2

Returns

Type	Description
Boolean

IsSameFaction(IEntity, Int32)

Declaration

public static bool IsSameFaction(this IEntity entity1, int factionID)

Parameters

Type	Name	Description
IEntity	entity1
Int32	factionID

Returns

Type	Description
Boolean

IsSameFaction(IFactionManager, IEntity)

Declaration

public static bool IsSameFaction(this IFactionManager factionMgr, IEntity entity)

Parameters

Type	Name	Description
IFactionManager	factionMgr
IEntity	entity

Returns

Type	Description
Boolean

IsSameFaction(IFactionManager, Int32)

Declaration

public static bool IsSameFaction(this IFactionManager factionMgr, int factionID)

Parameters

Type	Name	Description
IFactionManager	factionMgr
Int32	factionID

Returns

Type	Description
Boolean

IsSameFaction(IFactionSlot, IEntity)

Declaration

public static bool IsSameFaction(this IFactionSlot factionSlot, IEntity entity)

Parameters

Type	Name	Description
IFactionSlot	factionSlot
IEntity	entity

Returns

Type	Description
Boolean

IsSameFaction(IFactionSlot, Int32)

Declaration

public static bool IsSameFaction(this IFactionSlot factionSlot, int factionID)

Parameters

Type	Name	Description
IFactionSlot	factionSlot
Int32	factionID

Returns

Type	Description
Boolean

IsSameFaction(Int32, Int32)

Declaration

public static bool IsSameFaction(this int factionID1, int factionID2)

Parameters

Type	Name	Description
Int32	factionID1
Int32	factionID2

Returns

Type	Description
Boolean

IsUnit(IEntity)

Declaration

public static bool IsUnit(this IEntity source)

Parameters

Type	Name	Description
IEntity	source

Returns

Type	Description
Boolean

IsValid(IEnumerable<IMonoBehaviour>)

Declaration

public static bool IsValid(this IEnumerable<IMonoBehaviour> collection)

Parameters

Type	Name	Description
IEnumerable<IMonoBehaviour>	collection

Returns

Type	Description
Boolean

IsValid(IReadOnlyList<IMonoBehaviour>)

Declaration

public static bool IsValid(this IReadOnlyList<IMonoBehaviour> collection)

Parameters

Type	Name	Description
IReadOnlyList<IMonoBehaviour>	collection

Returns

Type	Description
Boolean

IsValid(Object)

Declaration

public static bool IsValid(this object obj)

Parameters

Type	Name	Description
Object	obj

Returns

Type	Description
Boolean

IsValid(UnityEngine.Object)

Declaration

public static bool IsValid(this UnityEngine.Object obj)

Parameters

Type	Name	Description
UnityEngine.Object	obj

Returns

Type	Description
Boolean

IsValid<T>(GameObjectToComponentInput<T>)

Declaration

public static bool IsValid<T>(this GameObjectToComponentInput<T> input)
    where T : IMonoBehaviour

Parameters

Type	Name	Description
GameObjectToComponentInput<T>	input

Returns

Type	Description
Boolean

Type Parameters

Name	Description
T

IsValidFaction(Int32)

Declaration

public static bool IsValidFaction(this int factionID)

Parameters

Type	Name	Description
Int32	factionID

Returns

Type	Description
Boolean

IsValidIndex<T>(Int32, T[])

Declaration

public static bool IsValidIndex<T>(this int index, T[] array)

Parameters

Type	Name	Description
Int32	index
T[]	array

Returns

Type	Description
Boolean

Type Parameters

Name	Description
T

IsValidIndex<T>(Int32, IReadOnlyList<T>)

Declaration

public static bool IsValidIndex<T>(this int index, IReadOnlyList<T> list)

Parameters

Type	Name	Description
Int32	index
IReadOnlyList<T>	list

Returns

Type	Description
Boolean

Type Parameters

Name	Description
T

LaunchEntityComponentAction(IEntityComponent, Byte, SetTargetInputData)

Declaration

public static ErrorMessage LaunchEntityComponentAction(IEntityComponent entityComponent, byte actionID, SetTargetInputData input)

Parameters

Type	Name	Description
IEntityComponent	entityComponent
Byte	actionID
SetTargetInputData	input

Returns

Type	Description
ErrorMessage

LookAwayFrom(Transform, Vector3, Boolean)

Sets the rotation of a Transform instance to the direction opposite from a Vector3 position.

Declaration

public static void LookAwayFrom(Transform transform, Vector3 awayFrom, bool fixYRotation = false)

Parameters

Type	Name	Description
Transform	transform	Transform instance to set rotation for.
Vector3	awayFrom	Vector3 position whose opposite direction the transform will look at.
Boolean	fixYRotation

OnSingleTaskUIRequest(IEntityComponent, List<EntityComponentTaskUIAttributes>, List<String>, EntityComponentTaskUIAsset, Boolean, Boolean, Boolean)

Declaration

public static bool OnSingleTaskUIRequest(IEntityComponent entityComponent, List<EntityComponentTaskUIAttributes> taskUIAttributes, List<string> disabledTaskCodes, EntityComponentTaskUIAsset taskUIAsset, bool requireActiveComponent = true, bool extraCondition = true, bool enforceCanLaunchTask = true)

Parameters

Type	Name	Description
IEntityComponent	entityComponent
List<EntityComponentTaskUIAttributes>	taskUIAttributes
List<String>	disabledTaskCodes
EntityComponentTaskUIAsset	taskUIAsset
Boolean	requireActiveComponent
Boolean	extraCondition
Boolean	enforceCanLaunchTask

Returns

Type	Description
Boolean

SetEntityComponentActive(IEntityComponent, Boolean, Boolean)

Declaration

public static ErrorMessage SetEntityComponentActive(IEntityComponent entityComponent, bool active, bool playerCommand)

Parameters

Type	Name	Description
IEntityComponent	entityComponent
Boolean	active
Boolean	playerCommand

Returns

Type	Description
ErrorMessage

SetTargetFirstMany(IEnumerable<IEntity>, SetTargetInputData)

Declaration

public static void SetTargetFirstMany(this IEnumerable<IEntity> entities, SetTargetInputData input)

Parameters

Type	Name	Description
IEnumerable<IEntity>	entities
SetTargetInputData	input

ShuffleList<T>(List<T>)

Declaration

public static void ShuffleList<T>(List<T> inputList)

Parameters

Type	Name	Description
List<T>	inputList

Type Parameters

Name	Description
T

SortEntitiesByCode<T>(IReadOnlyList<T>, Func<T, Boolean>)

Sorts a set of instances that extend the IEntity interface into a ChainedSortedList based on the entities code.

Declaration

public static ChainedSortedList<string, T> SortEntitiesByCode<T>(IReadOnlyList<T> allComponents, Func<T, bool> filter)
    where T : IEntity

Parameters

Type	Name	Description
IReadOnlyList<T>	allComponents	An IEnumerable of instances that extend the IEntity interface.
Func<T, Boolean>	filter	Determines what entities are eligible to be added to the chained sorted list and which are not.

Returns

Type	Description
ChainedSortedList<String, T>	ChainedSortedList instance of the sorted entities based on their code.

Type Parameters

Name	Description
T	A type that extends IEntity.

Swap<T>(ref T, ref T)

Declaration

public static void Swap<T>(ref T item1, ref T item2)

Parameters

Type	Name	Description
T	item1
T	item2

Type Parameters

Name	Description
T

TestFactionEntityRequirement(FactionEntityRequirement, IFactionManager)

Declaration

public static bool TestFactionEntityRequirement(this FactionEntityRequirement req, IFactionManager factionMgr)

Parameters

Type	Name	Description
FactionEntityRequirement	req
IFactionManager	factionMgr

Returns

Type	Description
Boolean

TestFactionEntityRequirements(IEnumerable<FactionEntityRequirement>, IFactionManager)

Declaration

public static bool TestFactionEntityRequirements(this IEnumerable<FactionEntityRequirement> requirements, IFactionManager factionMgr)

Parameters

Type	Name	Description
IEnumerable<FactionEntityRequirement>	requirements
IFactionManager	factionMgr

Returns

Type	Description
Boolean

TimeToString(Single)

Declaration

public static string TimeToString(float time)

Parameters

Type	Name	Description
Single	time

Returns

Type	Description
String

ToFactionSlot(Int32)

Declaration

public static IFactionSlot ToFactionSlot(this int factionID)

Parameters

Type	Name	Description
Int32	factionID

Returns

Type	Description
IFactionSlot

ToSetTargetInputData(Vector3, Boolean)

Declaration

public static SetTargetInputData ToSetTargetInputData(this Vector3 position, bool playerCommand)

Parameters

Type	Name	Description
Vector3	position
Boolean	playerCommand

Returns

Type	Description
SetTargetInputData

ToSetTargetInputData<T>(T, Boolean)

Declaration

public static SetTargetInputData ToSetTargetInputData<T>(this T entity, bool playerCommand)
    where T : IEntity

Parameters

Type	Name	Description
T	entity
Boolean	playerCommand

Returns

Type	Description
SetTargetInputData

Type Parameters

Name	Description
T

ToTargetData<T>(T)

Declaration

public static TargetData<T> ToTargetData<T>(this T entity)
    where T : IEntity

Parameters

Type	Name	Description
T	entity

Returns

Type	Description
TargetData<T>

Type Parameters

Name	Description
T

TryGameInitPostStart(Action<IGameManager>)

Declaration

public static bool TryGameInitPostStart(this Action<IGameManager> sourceInitMethod)

Parameters

Type	Name	Description
Action<IGameManager>	sourceInitMethod

Returns

Type	Description
Boolean

TryGetEntityComponentWithCode(IEntity, String, out IEntityComponent)

Declaration

public static bool TryGetEntityComponentWithCode(IEntity entity, string code, out IEntityComponent component)

Parameters

Type	Name	Description
IEntity	entity
String	code
IEntityComponent	component

Returns

Type	Description
Boolean

TryNameToLayer(String)

Declaration

public static int TryNameToLayer(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Int32

UpdateDropdownValue(ref TMP_Dropdown, String, List<String>)

Declaration

public static void UpdateDropdownValue(ref TMP_Dropdown dropdownMenu, string lastOption, List<string> newOptions)

Parameters

Type	Name	Description
TMP_Dropdown	dropdownMenu
String	lastOption
List<String>	newOptions