This class represents group's processing of a waypoint. More...

Inheritance diagram for SCR_AIWaypointState:

Public Member Functions
void	SCR_AIWaypointState (notnull SCR_AIGroupUtilityComponent utility, SCR_AIWaypoint waypoint)

void	OnSelected ()
	Called when group selects the waypoint as current.

void	OnDeselected ()
	Called when group deselects the waypoint as current, also including completion or removal.

void	OnExecuteWaypointTree ()
	Called when group switches from Moving towards waypoint to behavior ON waypoint Default behavior is to cancel all activities of this waypoint so far, override if not your case.

AIWaypoint	GetWaypoint ()
	Getter for the related waypoint.

Protected Attributes
SCR_AIGroupUtilityComponent	m_Utility

AIWaypoint	m_Waypoint

Detailed Description

This class represents group's processing of a waypoint.

It is instantiated when a new waypoint is selected by group, and deleted when group switches to another waypoint.

Constructor & Destructor Documentation

◆ SCR_AIWaypointState()

void SCR_AIWaypointState.SCR_AIWaypointState	(	notnull SCR_AIGroupUtilityComponent	utility,
		SCR_AIWaypoint	waypoint
	)

Member Function Documentation

◆ GetWaypoint()

AIWaypoint SCR_AIWaypointState.GetWaypoint ( )

Getter for the related waypoint.

◆ OnDeselected()

void SCR_AIWaypointState.OnDeselected ( )

Called when group deselects the waypoint as current, also including completion or removal.

Can be overridden in inherited class. Don't forget to call OnDeselected of base class.

Implemented in SCR_AIDefendWaypointState.

◆ OnExecuteWaypointTree()

void SCR_AIWaypointState.OnExecuteWaypointTree ( )

Called when group switches from Moving towards waypoint to behavior ON waypoint Default behavior is to cancel all activities of this waypoint so far, override if not your case.

Implemented in SCR_AIAnimationWaypointState.

◆ OnSelected()

void SCR_AIWaypointState.OnSelected ( )

Called when group selects the waypoint as current.

Can be overridden in inherited class. Don't forget to call OnSelected of base class.

Implemented in SCR_DeploySmokeCoverWaypointState, and SCR_SuppressWaypointState.

Member Data Documentation

◆ m_Utility

SCR_AIGroupUtilityComponent SCR_AIWaypointState.m_Utility

protected

◆ m_Waypoint

AIWaypoint SCR_AIWaypointState.m_Waypoint