Entity.Path Class Reference

Represents a Path object that contains actions-info for a specific Entity created by Gui-User. More...

Inheritance diagram for Entity.Path:

Public Member Functions
	Path ()
	Initializes a new instance of the Path class with an empty WaypointList.
	Path (List< Waypoint > waypointList, Waypoint overallStartTrigger=null, Waypoint overallStopTrigger=null)
	Initializes a new instance of the Path class with the specified WaypointList, OverallStartTrigger, and OverallStopTrigger.
object	Clone ()
	Creates a new Path object that is a deepcopy of the current instance.
List< Location >	GetRouteLocations ()
	Creates a list of all waypoint locations in the path to define the entity's route via an AssignRouteAction.
List< Location >	GetAllLocations ()
bool	IsEmpty ()
	Determines if the WaypointList is empty or not.
void	InitAssignRouteWaypoint (Location spawnpoint, WaypointStrategy strategy)
	Initializes the AssignRouteWaypoint at the end of the WaypointList with a Waypoint containing the ActionType "AssignRouteAction" and all waypoint locations. Needs to be invoked at the end after WayPointList is finished (so when ExportButton is pressed).

Properties
Waypoint	OverallStartTrigger [get, set]
Waypoint	OverallStopTrigger [get, set]
List< Waypoint >	WaypointList [get, set]
Waypoint	AssignRouteWaypoint [get, set]

Detailed Description

Represents a Path object that contains actions-info for a specific Entity created by Gui-User.

Constructor & Destructor Documentation

Path()

Entity.Path.Path ( List< Waypoint >  waypointList, Waypoint  overallStartTrigger = null, Waypoint  overallStopTrigger = null  )

inline

Initializes a new instance of the Path class with the specified WaypointList, OverallStartTrigger, and OverallStopTrigger.

Parameters

waypointList	The list of waypoints in the path.
overallStartTrigger	A Waypoint object containing information regarding the overall start trigger of an act.
overallStopTrigger	A Waypoint object containing information regarding the overall stop trigger of an act.

Member Function Documentation

Clone()

object Entity.Path.Clone ( )

inline

Creates a new Path object that is a deepcopy of the current instance.

Returns

A new Path object that is a deepcopy of the current instance.

GetRouteLocations()

List< Location > Entity.Path.GetRouteLocations ( )

inline

Creates a list of all waypoint locations in the path to define the entity's route via an AssignRouteAction.

Returns

A list of all waypoint locations in the path.

Creates a List of all Waypoint.Locations in the Path to define the Entities Route via a AssignRouteAction

InitAssignRouteWaypoint()

void Entity.Path.InitAssignRouteWaypoint ( Location  spawnpoint, WaypointStrategy  strategy  )

inline

Initializes the AssignRouteWaypoint at the end of the WaypointList with a Waypoint containing the ActionType "AssignRouteAction" and all waypoint locations. Needs to be invoked at the end after WayPointList is finished (so when ExportButton is pressed).

Parameters

spawnpoint

The initial spawnpoint for the Entity.

IsEmpty()

bool Entity.Path.IsEmpty ( )

inline

Determines if the WaypointList is empty or not.

Returns

True if the WaypointList is empty, false otherwise.

---

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

• C:/Users/stefa/source/repos/AI_Testing_Simulator/Unity/Assets/Entities/Path.cs