SCR_AIWaypointState Class Reference

Inheritance diagram for SCR_AIWaypointState:

Protected Member Functions
void	SCR_AIWaypointState (notnull SCR_AIGroupUtilityComponent utility, SCR_AIWaypoint waypoint)
void	OnSelected ()
void	OnDeselected ()
void	OnExecuteWaypointTree ()
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.

Definition at line 6 of file SCR_AIWaypointState.c.

Constructor & Destructor Documentation

SCR_AIWaypointState()

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

inlineprotected

Definition at line 11 of file SCR_AIWaypointState.c.

Member Function Documentation

GetWaypoint()

AIWaypoint SCR_AIWaypointState::GetWaypoint ( )

inlineprotected

Getter for the related waypoint.

Definition at line 37 of file SCR_AIWaypointState.c.

OnDeselected()

void SCR_AIWaypointState::OnDeselected ( )

inlineprotected

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.

Definition at line 24 of file SCR_AIWaypointState.c.

OnExecuteWaypointTree()

void SCR_AIWaypointState::OnExecuteWaypointTree ( )

inlineprotected

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

Definition at line 31 of file SCR_AIWaypointState.c.

OnSelected()

void SCR_AIWaypointState::OnSelected ( )

protected

Called when group selects the waypoint as current. Can be overridden in inherited class. Don't forget to call OnSelected of base class.

Member Data Documentation

m_Utility

SCR_AIGroupUtilityComponent SCR_AIWaypointState::m_Utility

protected

Definition at line 8 of file SCR_AIWaypointState.c.

m_Waypoint

AIWaypoint SCR_AIWaypointState::m_Waypoint

protected

Definition at line 9 of file SCR_AIWaypointState.c.

---

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

• scripts/Game/AI/Group/SCR_AIWaypointState.c