SCR_ScenarioFrameworkWaypoint Interface Reference

Inheritance diagram for SCR_ScenarioFrameworkWaypoint:

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

Public Attributes
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.

Member Function Documentation

GetWaypointCompletionRadius()

float SCR_ScenarioFrameworkWaypoint.GetWaypointCompletionRadius

(

)

Returns

Implemented in SCR_ScenarioFrameworkWaypointAttack, SCR_ScenarioFrameworkWaypointCaptureRelay, SCR_ScenarioFrameworkWaypointCycle, SCR_ScenarioFrameworkWaypointDefend, SCR_ScenarioFrameworkWaypointDefendCP, SCR_ScenarioFrameworkWaypointDefendHierarchy, SCR_ScenarioFrameworkWaypointDefendLarge, SCR_ScenarioFrameworkWaypointDefendLargeCO, SCR_ScenarioFrameworkWaypointDeploySmokeCover, SCR_ScenarioFrameworkWaypointFollow, SCR_ScenarioFrameworkWaypointForcedMove, SCR_ScenarioFrameworkWaypointGetIn, SCR_ScenarioFrameworkWaypointGetInNearest, SCR_ScenarioFrameworkWaypointGetOut, SCR_ScenarioFrameworkWaypointHeal, SCR_ScenarioFrameworkWaypointLoiterCO, SCR_ScenarioFrameworkWaypointMove, SCR_ScenarioFrameworkWaypointObservationPost, SCR_ScenarioFrameworkWaypointOpenGate, SCR_ScenarioFrameworkWaypointPatrol, SCR_ScenarioFrameworkWaypointPatrolHierarchy, SCR_ScenarioFrameworkWaypointScout, SCR_ScenarioFrameworkWaypointSearchAndDestroy, SCR_ScenarioFrameworkWaypointSuppress, SCR_ScenarioFrameworkWaypointUserAction, and SCR_ScenarioFrameworkWaypointWait.

GetWaypointCompletionType()

EAIWaypointCompletionType SCR_ScenarioFrameworkWaypoint.GetWaypointCompletionType

(

)

Returns

Implemented in SCR_ScenarioFrameworkWaypointAnimation, SCR_ScenarioFrameworkWaypointAttack, SCR_ScenarioFrameworkWaypointCaptureRelay, SCR_ScenarioFrameworkWaypointCycle, SCR_ScenarioFrameworkWaypointDefend, SCR_ScenarioFrameworkWaypointDefendCP, SCR_ScenarioFrameworkWaypointDefendHierarchy, SCR_ScenarioFrameworkWaypointDefendLarge, SCR_ScenarioFrameworkWaypointDefendLargeCO, SCR_ScenarioFrameworkWaypointDeploySmokeCover, SCR_ScenarioFrameworkWaypointFollow, SCR_ScenarioFrameworkWaypointForcedMove, SCR_ScenarioFrameworkWaypointGetIn, SCR_ScenarioFrameworkWaypointGetInNearest, SCR_ScenarioFrameworkWaypointGetOut, SCR_ScenarioFrameworkWaypointHeal, SCR_ScenarioFrameworkWaypointLoiterCO, SCR_ScenarioFrameworkWaypointMove, SCR_ScenarioFrameworkWaypointObservationPost, SCR_ScenarioFrameworkWaypointOpenGate, SCR_ScenarioFrameworkWaypointPatrol, SCR_ScenarioFrameworkWaypointPatrolHierarchy, SCR_ScenarioFrameworkWaypointScout, SCR_ScenarioFrameworkWaypointSearchAndDestroy, SCR_ScenarioFrameworkWaypointSuppress, SCR_ScenarioFrameworkWaypointUserAction, and SCR_ScenarioFrameworkWaypointWait.

GetWaypointPrefab()

ResourceName SCR_ScenarioFrameworkWaypoint.GetWaypointPrefab

(

)

Returns

Implemented in SCR_ScenarioFrameworkWaypointAnimation, SCR_ScenarioFrameworkWaypointAttack, SCR_ScenarioFrameworkWaypointCaptureRelay, SCR_ScenarioFrameworkWaypointCycle, SCR_ScenarioFrameworkWaypointDefend, SCR_ScenarioFrameworkWaypointDefendCP, SCR_ScenarioFrameworkWaypointDefendHierarchy, SCR_ScenarioFrameworkWaypointDefendLarge, SCR_ScenarioFrameworkWaypointDefendLargeCO, SCR_ScenarioFrameworkWaypointDeploySmokeCover, SCR_ScenarioFrameworkWaypointFollow, SCR_ScenarioFrameworkWaypointForcedMove, SCR_ScenarioFrameworkWaypointGetIn, SCR_ScenarioFrameworkWaypointGetInNearest, SCR_ScenarioFrameworkWaypointGetOut, SCR_ScenarioFrameworkWaypointHeal, SCR_ScenarioFrameworkWaypointLoiterCO, SCR_ScenarioFrameworkWaypointMove, SCR_ScenarioFrameworkWaypointObservationPost, SCR_ScenarioFrameworkWaypointOpenGate, SCR_ScenarioFrameworkWaypointPatrol, SCR_ScenarioFrameworkWaypointPatrolHierarchy, SCR_ScenarioFrameworkWaypointScout, SCR_ScenarioFrameworkWaypointSearchAndDestroy, SCR_ScenarioFrameworkWaypointSuppress, SCR_ScenarioFrameworkWaypointUserAction, and SCR_ScenarioFrameworkWaypointWait.

SetupWaypoint()

void SCR_ScenarioFrameworkWaypoint.SetupWaypoint

(

IEntity

waypointEntity

)

Parameters

[in]

waypointEntity

Implemented in SCR_ScenarioFrameworkWaypointScripted, SCR_ScenarioFrameworkWaypointSmartAction, SCR_ScenarioFrameworkWaypointEntity, SCR_ScenarioFrameworkWaypointTimed, SCR_ScenarioFrameworkWaypointTimedDefend, SCR_ScenarioFrameworkWaypointBoarding, SCR_ScenarioFrameworkWaypointBoardingEntity, SCR_ScenarioFrameworkWaypointBoardingTimed, SCR_ScenarioFrameworkWaypointAnimation, SCR_ScenarioFrameworkWaypointCycle, SCR_ScenarioFrameworkWaypointDeploySmokeCover, and SCR_ScenarioFrameworkWaypointSuppress.

SetWaypointCompletionRadius()

void SCR_ScenarioFrameworkWaypoint.SetWaypointCompletionRadius

(

float

radius

)

Parameters

[in]

radius

Implemented in SCR_ScenarioFrameworkWaypointAttack, SCR_ScenarioFrameworkWaypointCaptureRelay, SCR_ScenarioFrameworkWaypointCycle, SCR_ScenarioFrameworkWaypointDefend, SCR_ScenarioFrameworkWaypointDefendCP, SCR_ScenarioFrameworkWaypointDefendHierarchy, SCR_ScenarioFrameworkWaypointDefendLarge, SCR_ScenarioFrameworkWaypointDefendLargeCO, SCR_ScenarioFrameworkWaypointDeploySmokeCover, SCR_ScenarioFrameworkWaypointFollow, SCR_ScenarioFrameworkWaypointForcedMove, SCR_ScenarioFrameworkWaypointGetIn, SCR_ScenarioFrameworkWaypointGetInNearest, SCR_ScenarioFrameworkWaypointGetOut, SCR_ScenarioFrameworkWaypointHeal, SCR_ScenarioFrameworkWaypointLoiterCO, SCR_ScenarioFrameworkWaypointMove, SCR_ScenarioFrameworkWaypointObservationPost, SCR_ScenarioFrameworkWaypointOpenGate, SCR_ScenarioFrameworkWaypointPatrol, SCR_ScenarioFrameworkWaypointPatrolHierarchy, SCR_ScenarioFrameworkWaypointScout, SCR_ScenarioFrameworkWaypointSearchAndDestroy, SCR_ScenarioFrameworkWaypointSuppress, SCR_ScenarioFrameworkWaypointUserAction, and SCR_ScenarioFrameworkWaypointWait.

SetWaypointCompletionType()

void SCR_ScenarioFrameworkWaypoint.SetWaypointCompletionType

(

EAIWaypointCompletionType

type

)

Parameters

[in]

type

Implemented in SCR_ScenarioFrameworkWaypointAnimation, SCR_ScenarioFrameworkWaypointAttack, SCR_ScenarioFrameworkWaypointCaptureRelay, SCR_ScenarioFrameworkWaypointCycle, SCR_ScenarioFrameworkWaypointDefend, SCR_ScenarioFrameworkWaypointDefendCP, SCR_ScenarioFrameworkWaypointDefendHierarchy, SCR_ScenarioFrameworkWaypointDefendLarge, SCR_ScenarioFrameworkWaypointDefendLargeCO, SCR_ScenarioFrameworkWaypointDeploySmokeCover, SCR_ScenarioFrameworkWaypointFollow, SCR_ScenarioFrameworkWaypointForcedMove, SCR_ScenarioFrameworkWaypointGetIn, SCR_ScenarioFrameworkWaypointGetInNearest, SCR_ScenarioFrameworkWaypointGetOut, SCR_ScenarioFrameworkWaypointHeal, SCR_ScenarioFrameworkWaypointLoiterCO, SCR_ScenarioFrameworkWaypointMove, SCR_ScenarioFrameworkWaypointObservationPost, SCR_ScenarioFrameworkWaypointOpenGate, SCR_ScenarioFrameworkWaypointPatrol, SCR_ScenarioFrameworkWaypointPatrolHierarchy, SCR_ScenarioFrameworkWaypointScout, SCR_ScenarioFrameworkWaypointSearchAndDestroy, SCR_ScenarioFrameworkWaypointSuppress, SCR_ScenarioFrameworkWaypointUserAction, and SCR_ScenarioFrameworkWaypointWait.

SetWaypointPrefab()

void SCR_ScenarioFrameworkWaypoint.SetWaypointPrefab

(

ResourceName

prefab

)

Parameters

[in]

prefab

Implemented in SCR_ScenarioFrameworkWaypointAnimation, SCR_ScenarioFrameworkWaypointAttack, SCR_ScenarioFrameworkWaypointCaptureRelay, SCR_ScenarioFrameworkWaypointCycle, SCR_ScenarioFrameworkWaypointDefend, SCR_ScenarioFrameworkWaypointDefendCP, SCR_ScenarioFrameworkWaypointDefendHierarchy, SCR_ScenarioFrameworkWaypointDefendLarge, SCR_ScenarioFrameworkWaypointDefendLargeCO, SCR_ScenarioFrameworkWaypointDeploySmokeCover, SCR_ScenarioFrameworkWaypointFollow, SCR_ScenarioFrameworkWaypointForcedMove, SCR_ScenarioFrameworkWaypointGetIn, SCR_ScenarioFrameworkWaypointGetInNearest, SCR_ScenarioFrameworkWaypointGetOut, SCR_ScenarioFrameworkWaypointHeal, SCR_ScenarioFrameworkWaypointLoiterCO, SCR_ScenarioFrameworkWaypointMove, SCR_ScenarioFrameworkWaypointObservationPost, SCR_ScenarioFrameworkWaypointOpenGate, SCR_ScenarioFrameworkWaypointPatrol, SCR_ScenarioFrameworkWaypointPatrolHierarchy, SCR_ScenarioFrameworkWaypointScout, SCR_ScenarioFrameworkWaypointSearchAndDestroy, SCR_ScenarioFrameworkWaypointSuppress, SCR_ScenarioFrameworkWaypointUserAction, and SCR_ScenarioFrameworkWaypointWait.

Member Data Documentation

m_SlotWaypoint

SCR_ScenarioFrameworkLayerBase SCR_ScenarioFrameworkWaypoint.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.

This is why we do not have the actual attribute here, but just empty Setters and Getters returning some value that will never be used.

---

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

• Game/ScenarioFramework/Waypoints/SCR_ScenarioFrameworkWaypoint.c