SCR_SuppliesTransportSystem Interface Reference

Inheritance diagram for SCR_SuppliesTransportSystem:

Public 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)
	Determines whether the specified vehicle is currently in use by any transport unit, excluding an optional transport unit.
bool	IsVehicleSelected (Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit=null)
	Determines whether the specified vehicle is currently selected by any transport unit, excluding an optional transport unit.
bool	IsVehicleBoarded (Vehicle vehicle, SCR_TransportUnitComponent ignoredTransportUnit=null)
	Determines whether the specified vehicle is currently being boarded by any transport unit, excluding an optional transport unit.
bool	IsTaskSolved (SCR_Task task, SCR_TransportUnitComponent ignoredTransportUnit=null)
	Determines whether the specified task is currently being solved by any transport unit, excluding an optional transport unit.
Public Member Functions inherited from GameSystem
bool	ShouldBePaused ()
	Is this system should be paused while the simulation is paused?
bool	ShouldBeEnabledInEditMode ()
	Is this system should be enabled inside the editor.

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

Protected Member Functions
override void	OnUpdatePoint (WorldUpdatePointArgs args)
void	PopulateResupplyTaskToTransportUnitsMap ()
void	StartSolvingTaskByClosestUnit (SCR_ResupplyCampaignMilitaryBaseTaskEntity task, array< SCR_TransportUnitComponent > units)
void	EvaluateTransportUnits ()
override void	OnInit ()
override void	OnDiag (float timeSlice)
void	DrawDebug ()

Protected Attributes
float	m_fUpdateInterval
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

Member Function Documentation

DrawDebug()

void SCR_SuppliesTransportSystem.DrawDebug ( )

protected

EvaluateTransportUnits()

void SCR_SuppliesTransportSystem.EvaluateTransportUnits ( )

protected

GetInstance()

static SCR_SuppliesTransportSystem SCR_SuppliesTransportSystem.GetInstance ( )

static

Returns

the instance of Supplies Transport System.

GetOnTransportUnitAdded()

OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem.GetOnTransportUnitAdded

(

)

GetOnTransportUnitRemoved()

OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem.GetOnTransportUnitRemoved

(

)

GetTransportUnits() [1/2]

set< SCR_TransportUnitComponent > SCR_SuppliesTransportSystem.GetTransportUnits

(

)

GetTransportUnits() [2/2]

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

InitInfo()

static override void SCR_SuppliesTransportSystem.InitInfo ( WorldSystemInfo outInfo )

static

IsTaskSolved()

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

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.

IsVehicleBoarded()

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

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.

IsVehicleSelected()

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

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.

IsVehicleUsed()

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

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.

OnDiag()

override void SCR_SuppliesTransportSystem.OnDiag ( float timeSlice )

protected

Parameters

[in]

timeSlice

interval for diagnostics update.

OnInit()

override void SCR_SuppliesTransportSystem.OnInit ( )

protected

OnUpdatePoint()

override void SCR_SuppliesTransportSystem.OnUpdatePoint ( WorldUpdatePointArgs args )

protected

PopulateResupplyTaskToTransportUnitsMap()

void SCR_SuppliesTransportSystem.PopulateResupplyTaskToTransportUnitsMap ( )

protected

Register()

bool SCR_SuppliesTransportSystem.Register

(

notnull SCR_TransportUnitComponent

transportUnit

)

StartSolvingTaskByClosestUnit()

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

protected

Unregister()

bool SCR_SuppliesTransportSystem.Unregister

(

notnull SCR_TransportUnitComponent

transportUnit

)

Member Data Documentation

m_fTimer

float SCR_SuppliesTransportSystem.m_fTimer

protected

m_fUpdateInterval

float SCR_SuppliesTransportSystem.m_fUpdateInterval

protected

m_mResupplyTaskToTransportUnitsMap

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

protected

m_OnTransportUnitAdded

ref OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem.m_OnTransportUnitAdded

protected

m_OnTransportUnitRemoved

ref OnTransportUnitChangedInvoker SCR_SuppliesTransportSystem.m_OnTransportUnitRemoved

protected

m_TransportUnits

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

protected

---

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

• Game/SuppliesTransportSystem/SCR_SuppliesTransportSystem.c