SCR_SuppliesTransportSystem Class Reference

Inheritance diagram for SCR_SuppliesTransportSystem:

Protected Member Functions
OnTransportUnitChangedInvoker	GetOnTransportUnitAdded ()
OnTransportUnitChangedInvoker	GetOnTransportUnitRemoved ()
set< SCR_TransportUnitComponent >	GetTransportUnits ()
int	GetTransportUnits (out notnull array< SCR_TransportUnitComponent > transportUnits, Faction faction)
bool	Register (notnull SCR_TransportUnitComponent transportUnit)
bool	Unregister (notnull SCR_TransportUnitComponent transportUnit)
bool	IsVehicleUsed (Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit=null)
bool	IsVehicleSelected (Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit=null)
bool	IsVehicleBoarded (Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit=null)
bool	IsTaskSolved (SCR_Task task, SCR_TransportUnitComponent ignoredTransportUnit=null)
void	OnUpdatePoint (WorldUpdatePointArgs args)
void	PopulateResupplyTaskToTransportUnitsMap ()
void	StartSolvingTaskByClosestUnit (SCR_ResupplyCampaignMilitaryBaseTaskEntity task, array< SCR_TransportUnitComponent > units)
void	EvaluateTransportUnits ()
void	OnInit ()
void	OnDiag (float timeSlice)
void	DrawDebug ()

Static Protected Member Functions
static override void	InitInfo (WorldSystemInfo outInfo)
static SCR_SuppliesTransportSystem	GetInstance ()

Protected Attributes
float	m_fTimer
ref set< SCR_TransportUnitComponent >	m_TransportUnits = new set<SCR_TransportUnitComponent>()
ref map< SCR_ResupplyCampaignMilitaryBaseTaskEntity, ref array< SCR_TransportUnitComponent > >	m_mResupplyTaskToTransportUnitsMap = new map<SCR_ResupplyCampaignMilitaryBaseTaskEntity, ref array<SCR_TransportUnitComponent>>()
ref OnTransportUnitChangedInvoker	m_OnTransportUnitAdded
ref OnTransportUnitChangedInvoker	m_OnTransportUnitRemoved

Detailed Description

Definition at line 5 of file SCR_SuppliesTransportSystem.c.

Member Function Documentation

DrawDebug()

void SCR_SuppliesTransportSystem::DrawDebug ( )

inlineprotected

Definition at line 291 of file SCR_SuppliesTransportSystem.c.

EvaluateTransportUnits()

void SCR_SuppliesTransportSystem::EvaluateTransportUnits ( )

inlineprotected

Definition at line 262 of file SCR_SuppliesTransportSystem.c.

GetInstance()

SCR_SuppliesTransportSystem SCR_SuppliesTransportSystem::GetInstance ( )

inlinestaticprotected

Returns

the instance of Supplies Transport System.

Definition at line 29 of file SCR_SuppliesTransportSystem.c.

GetOnTransportUnitAdded()

OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem::GetOnTransportUnitAdded ( )

inlineprotected

Definition at line 39 of file SCR_SuppliesTransportSystem.c.

GetOnTransportUnitRemoved()

OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem::GetOnTransportUnitRemoved ( )

inlineprotected

Definition at line 48 of file SCR_SuppliesTransportSystem.c.

GetTransportUnits() [1/2]

set< SCR_TransportUnitComponent > SCR_SuppliesTransportSystem::GetTransportUnits ( )

inlineprotected

Definition at line 57 of file SCR_SuppliesTransportSystem.c.

GetTransportUnits() [2/2]

int SCR_SuppliesTransportSystem::GetTransportUnits ( out notnull array< SCR_TransportUnitComponent > transportUnits, Faction faction )

inlineprotected

Definition at line 63 of file SCR_SuppliesTransportSystem.c.

InitInfo()

override void SCR_SuppliesTransportSystem::InitInfo ( WorldSystemInfo outInfo )

inlinestaticprotected

Definition at line 20 of file SCR_SuppliesTransportSystem.c.

IsTaskSolved()

bool SCR_SuppliesTransportSystem::IsTaskSolved ( SCR_Task task, SCR_TransportUnitComponent ignoredTransportUnit = null )

inlineprotected

Determines whether the specified task is currently being solved by any transport unit, excluding an optional transport unit.

Parameters

[in]	task	The task to check if it's being solved.
[in]	ignoredTransportUnit	(Optional) A transport unit to exclude from the check.

Returns

Returns true if the task is being solved by any transport unit except the ignored one; otherwise, false.

Definition at line 172 of file SCR_SuppliesTransportSystem.c.

IsVehicleBoarded()

bool SCR_SuppliesTransportSystem::IsVehicleBoarded ( Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit = null )

inlineprotected

Determines whether the specified vehicle is currently being boarded by any transport unit, excluding an optional transport unit.

Parameters

[in]	vehicle	The vehicle to check boarding status for.
[in]	ignoredTransportUnit	(Optional) A transport unit to exclude from the boarding check.

Returns

Returns true if the vehicle is being boarded by any transport unit except the ignored one; otherwise, false.

Definition at line 150 of file SCR_SuppliesTransportSystem.c.

IsVehicleSelected()

bool SCR_SuppliesTransportSystem::IsVehicleSelected ( Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit = null )

inlineprotected

Determines whether the specified vehicle is currently selected by any transport unit, excluding an optional transport unit.

Parameters

[in]	vehicle	The vehicle to check selection status for.
[in]	ignoredTransportUnit	(Optional) A transport unit to exclude from the selection check.

Returns

Returns true if the vehicle is selected by any transport unit except the ignored one; otherwise, false.

Definition at line 131 of file SCR_SuppliesTransportSystem.c.

IsVehicleUsed()

bool SCR_SuppliesTransportSystem::IsVehicleUsed ( Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit = null )

inlineprotected

Determines whether the specified vehicle is currently in use by any transport unit, excluding an optional transport unit.

Parameters

[in]	vehicle	The vehicle to check usage status for.
[in]	ignoredTransportUnit	(Optional) A transport unit to exclude from the usage check.

Returns

Returns true if the vehicle is in use by any transport unit except the ignored one; otherwise, false.

Definition at line 112 of file SCR_SuppliesTransportSystem.c.

OnDiag()

void SCR_SuppliesTransportSystem::OnDiag ( float timeSlice )

inlineprotected

Parameters

[in]

timeSlice

interval for diagnostics update.

Definition at line 283 of file SCR_SuppliesTransportSystem.c.

OnInit()

void SCR_SuppliesTransportSystem::OnInit ( )

inlineprotected

Definition at line 273 of file SCR_SuppliesTransportSystem.c.

OnUpdatePoint()

void SCR_SuppliesTransportSystem::OnUpdatePoint ( WorldUpdatePointArgs args )

inlineprotected

Definition at line 187 of file SCR_SuppliesTransportSystem.c.

PopulateResupplyTaskToTransportUnitsMap()

void SCR_SuppliesTransportSystem::PopulateResupplyTaskToTransportUnitsMap ( )

inlineprotected

Definition at line 214 of file SCR_SuppliesTransportSystem.c.

Register()

bool SCR_SuppliesTransportSystem::Register ( notnull SCR_TransportUnitComponent transportUnit )

inlineprotected

Definition at line 80 of file SCR_SuppliesTransportSystem.c.

StartSolvingTaskByClosestUnit()

void SCR_SuppliesTransportSystem::StartSolvingTaskByClosestUnit ( SCR_ResupplyCampaignMilitaryBaseTaskEntity task, array< SCR_TransportUnitComponent > units )

inlineprotected

Definition at line 241 of file SCR_SuppliesTransportSystem.c.

Unregister()

bool SCR_SuppliesTransportSystem::Unregister ( notnull SCR_TransportUnitComponent transportUnit )

inlineprotected

Definition at line 94 of file SCR_SuppliesTransportSystem.c.

Member Data Documentation

m_fTimer

float SCR_SuppliesTransportSystem::m_fTimer

protected

Definition at line 10 of file SCR_SuppliesTransportSystem.c.

m_mResupplyTaskToTransportUnitsMap

ref map<SCR_ResupplyCampaignMilitaryBaseTaskEntity, ref array<SCR_TransportUnitComponent> > SCR_SuppliesTransportSystem::m_mResupplyTaskToTransportUnitsMap = new map<SCR_ResupplyCampaignMilitaryBaseTaskEntity, ref array<SCR_TransportUnitComponent>>()

protected

Definition at line 14 of file SCR_SuppliesTransportSystem.c.

m_OnTransportUnitAdded

ref OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem::m_OnTransportUnitAdded

protected

Definition at line 16 of file SCR_SuppliesTransportSystem.c.

m_OnTransportUnitRemoved

ref OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem::m_OnTransportUnitRemoved

protected

Definition at line 17 of file SCR_SuppliesTransportSystem.c.

m_TransportUnits

ref set<SCR_TransportUnitComponent> SCR_SuppliesTransportSystem::m_TransportUnits = new set<SCR_TransportUnitComponent>()

protected

Definition at line 12 of file SCR_SuppliesTransportSystem.c.

---

The documentation for this class was generated from the following file:

• scripts/Game/SuppliesTransportSystem/SCR_SuppliesTransportSystem.c