SCR_ScenarioFrameworkWaypointCycle Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkWaypointCycle:

Public Member Functions
override void	SetupWaypoint (IEntity waypointEntity)
ScriptInvokerScenarioFrameworkLayer	GetOnAllWaypointsSpawned ()
void	InvokeAllWaypointsSpawned ()
override void	SetWaypointCompletionRadius (float radius)
override float	GetWaypointCompletionRadius ()
override void	SetWaypointCompletionType (EAIWaypointCompletionType type)
override EAIWaypointCompletionType	GetWaypointCompletionType ()
override void	SetWaypointPrefab (ResourceName prefab)
override ResourceName	GetWaypointPrefab ()

Public Attributes
float	m_fCompletionRadius
EAIWaypointCompletionType	m_eAIWaypointCompletionType
float	m_fPriorityLevel
ResourceName	m_sWaypointPrefab
ref array< string >	m_aLayersWithWaypointsToCycle
int	m_iRerunCounter
bool	m_bUseRandomOrder
ref ScriptInvokerBase< ScriptInvokerScenarioFrameworkLayerMethod >	m_OnAllWaypointsSpawned
ref array< AIWaypoint >	m_aWaypointsWithoutCycle = {}
ref array< SCR_ScenarioFrameworkSlotWaypoint >	m_aSlotWaypoints = {}
AIWaypointCycle	m_CycleWaypoint
int	m_iCurrentlySpawnedWaypoints
bool	m_bInitiated
Public Attributes inherited from SCR_ScenarioFrameworkWaypoint
SCR_ScenarioFrameworkLayerBase	m_SlotWaypoint
	Getters and Setters in this class (And similar that inherit) are set in a way to allow for different default values for attributes of child classes.

Protected Member Functions
void	CheckWaypointsAfterInit (SCR_ScenarioFrameworkLayerBase layer)
void	ProcessWaypoints (SCR_ScenarioFrameworkLayerBase layer)
void	ShuffleWaypointArray (notnull array< AIWaypoint > arr)

Member Function Documentation

CheckWaypointsAfterInit()

void SCR_ScenarioFrameworkWaypointCycle.CheckWaypointsAfterInit ( SCR_ScenarioFrameworkLayerBase layer )

protected

GetOnAllWaypointsSpawned()

ScriptInvokerScenarioFrameworkLayer SCR_ScenarioFrameworkWaypointCycle.GetOnAllWaypointsSpawned

(

)

Returns

GetWaypointCompletionRadius()

override float SCR_ScenarioFrameworkWaypointCycle.GetWaypointCompletionRadius

(

)

Returns

Implements SCR_ScenarioFrameworkWaypoint.

GetWaypointCompletionType()

override EAIWaypointCompletionType SCR_ScenarioFrameworkWaypointCycle.GetWaypointCompletionType

(

)

Returns

Implements SCR_ScenarioFrameworkWaypoint.

GetWaypointPrefab()

override ResourceName SCR_ScenarioFrameworkWaypointCycle.GetWaypointPrefab

(

)

Returns

Implements SCR_ScenarioFrameworkWaypoint.

InvokeAllWaypointsSpawned()

void SCR_ScenarioFrameworkWaypointCycle.InvokeAllWaypointsSpawned

(

)

ProcessWaypoints()

void SCR_ScenarioFrameworkWaypointCycle.ProcessWaypoints ( SCR_ScenarioFrameworkLayerBase layer )

protected

Parameters

[in]

layer

SetupWaypoint()

override void SCR_ScenarioFrameworkWaypointCycle.SetupWaypoint

(

IEntity

waypointEntity

)

Parameters

[in]

waypointEntity

Implements SCR_ScenarioFrameworkWaypoint.

SetWaypointCompletionRadius()

override void SCR_ScenarioFrameworkWaypointCycle.SetWaypointCompletionRadius

(

float

radius

)

Parameters

[in]

radius

Implements SCR_ScenarioFrameworkWaypoint.

SetWaypointCompletionType()

override void SCR_ScenarioFrameworkWaypointCycle.SetWaypointCompletionType

(

EAIWaypointCompletionType

type

)

Parameters

[in]

type

Implements SCR_ScenarioFrameworkWaypoint.

SetWaypointPrefab()

override void SCR_ScenarioFrameworkWaypointCycle.SetWaypointPrefab

(

ResourceName

prefab

)

Parameters

[in]

prefab

Implements SCR_ScenarioFrameworkWaypoint.

ShuffleWaypointArray()

void SCR_ScenarioFrameworkWaypointCycle.ShuffleWaypointArray ( notnull array< AIWaypoint > arr )

protected

Member Data Documentation

m_aLayersWithWaypointsToCycle

ref array<string> SCR_ScenarioFrameworkWaypointCycle.m_aLayersWithWaypointsToCycle

m_aSlotWaypoints

ref array<SCR_ScenarioFrameworkSlotWaypoint> SCR_ScenarioFrameworkWaypointCycle.m_aSlotWaypoints = {}

m_aWaypointsWithoutCycle

ref array<AIWaypoint> SCR_ScenarioFrameworkWaypointCycle.m_aWaypointsWithoutCycle = {}

m_bInitiated

bool SCR_ScenarioFrameworkWaypointCycle.m_bInitiated

m_bUseRandomOrder

bool SCR_ScenarioFrameworkWaypointCycle.m_bUseRandomOrder

m_CycleWaypoint

AIWaypointCycle SCR_ScenarioFrameworkWaypointCycle.m_CycleWaypoint

m_eAIWaypointCompletionType

EAIWaypointCompletionType SCR_ScenarioFrameworkWaypointCycle.m_eAIWaypointCompletionType

m_fCompletionRadius

float SCR_ScenarioFrameworkWaypointCycle.m_fCompletionRadius

m_fPriorityLevel

float SCR_ScenarioFrameworkWaypointCycle.m_fPriorityLevel

m_iCurrentlySpawnedWaypoints

int SCR_ScenarioFrameworkWaypointCycle.m_iCurrentlySpawnedWaypoints

m_iRerunCounter

int SCR_ScenarioFrameworkWaypointCycle.m_iRerunCounter

m_OnAllWaypointsSpawned

ref ScriptInvokerBase<ScriptInvokerScenarioFrameworkLayerMethod> SCR_ScenarioFrameworkWaypointCycle.m_OnAllWaypointsSpawned

m_sWaypointPrefab

ResourceName SCR_ScenarioFrameworkWaypointCycle.m_sWaypointPrefab

---

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

• Game/ScenarioFramework/Waypoints/SCR_ScenarioFrameworkWaypointCycle.c