aom.scripting.xs.kb

Class Path

Object

Path

public class Path
extends Object

This class provides a collection of KB commands concerning Paths and Attack Routes. Paths are used by the AI to find its way throughout the map, launch attacks etc...

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields

Modifier and Type	Field and Description
int	cAttackRouteBackLeft
int	cAttackRouteBackRight
int	cAttackRouteFrontLeft
int	cAttackRouteFrontRight
int	cAttackRouteLeftBack
int	cAttackRouteLeftFront
int	cAttackRouteRightBack
int	cAttackRouteRightFront
int	cTransportPathTypeAreas
int	cTransportPathTypePoints

Method Summary

Modifier and Type	Method and Description
bool	kbAddAttackRouteIgnoreID(int ignoreAreaID) Ignore this area when finding the route.
bool	kbAddAttackRouteIgnoreType(int ignoreAreaTypeID) Ignore this area type when finding the route.
bool	kbAddAttackRouteSector(int sector) Add a new sector to path to.
bool	kbAttackRouteAddPath(int attackRouteID, int pathID) Returns true if path was added to attack route.
bool	kbCanPath2(vector pointA, vector pointB, long protoUnitTypeID, float range) Returns true if the given unit type can path from pointA to pointB.
bool	kbCanSimPath(vector pointA, vector pointB, long protoUnitTypeID, float range) Returns true if the given unit type can path from pointA to pointB.
int	kbCreateAttackRoute(string name, int startAreaID, int goalAreaID, int numInitialRoutes) Returns the Route ID if successful.
int	kbCreateAttackRouteWithPath(string name, vector startPt, vector endPt) Returns the Route ID if successful.
bool	kbDestroyAttackRoute(int routeID) Returns true if the route was deleted.
int	kbGetAttackRouteID(long startAreaID, long goalAreaID) Returns the id of the routes from area1 to area2.
int	kbGetNumAttackRoutes(long startAreaID, long goalAreaID) Returns the number of paths from start to goal area.
bool	kbMakeAttackRoutes() Find all the paths to the sector specified.
bool	kbPathAddWaypoint(int pathID, vector waypoint) Adds the waypoint to the given path.
int	kbPathCreate(string name) Creates a path with the given name.
bool	kbPathDestroy(int pathID) Destroys the given path.
int	kbPathGetIDByIndex(long index) Returns the index'th path ID.
float	kbPathGetLength(int pathID) Returns the length of the given path.
string	kbPathGetName(int pathID) Returns the name of the given path.
int	kbPathGetNumber() Returns the number of paths.
int	kbPathGetNumberWaypoints(int pathID) Returns the number of waypoints in the given path.
vector	kbPathGetWaypoint(int pathID, long waypointNumber) Returns the appropriate waypoint from the given path.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

cTransportPathTypePoints

public final int cTransportPathTypePoints

See Also:

Constant Field Values

cTransportPathTypeAreas

public final int cTransportPathTypeAreas

See Also:

Constant Field Values

cAttackRouteFrontRight

public final int cAttackRouteFrontRight

See Also:

Constant Field Values

cAttackRouteRightFront

public final int cAttackRouteRightFront

See Also:

Constant Field Values

cAttackRouteRightBack

public final int cAttackRouteRightBack

See Also:

Constant Field Values

cAttackRouteBackRight

public final int cAttackRouteBackRight

See Also:

Constant Field Values

cAttackRouteBackLeft

public final int cAttackRouteBackLeft

See Also:

Constant Field Values

cAttackRouteLeftBack

public final int cAttackRouteLeftBack

See Also:

Constant Field Values

cAttackRouteLeftFront

public final int cAttackRouteLeftFront

See Also:

Constant Field Values

cAttackRouteFrontLeft

public final int cAttackRouteFrontLeft

See Also:

Constant Field Values

Method Detail

kbPathCreate

public int kbPathCreate(string name)

Creates a path with the given name.

kbPathDestroy

public bool kbPathDestroy(int pathID)

Destroys the given path.

kbPathGetNumber

public int kbPathGetNumber()

Returns the number of paths.

kbPathGetIDByIndex

public int kbPathGetIDByIndex(long index)

Returns the index'th path ID.

kbPathGetName

public string kbPathGetName(int pathID)

Returns the name of the given path.

kbPathGetLength

public float kbPathGetLength(int pathID)

Returns the length of the given path.

kbPathGetNumberWaypoints

public int kbPathGetNumberWaypoints(int pathID)

Returns the number of waypoints in the given path.

kbPathAddWaypoint

public bool kbPathAddWaypoint(int pathID,
                              vector waypoint)

Adds the waypoint to the given path.

kbPathGetWaypoint

public vector kbPathGetWaypoint(int pathID,
                                long waypointNumber)

Returns the appropriate waypoint from the given path.

kbCanSimPath

public bool kbCanSimPath(vector pointA,
                         vector pointB,
                         long protoUnitTypeID,
                         float range)

Returns true if the given unit type can path from pointA to pointB.

kbCanPath2

public bool kbCanPath2(vector pointA,
                       vector pointB,
                       long protoUnitTypeID,
                       float range)

Returns true if the given unit type can path from pointA to pointB.

kbCreateAttackRoute

public int kbCreateAttackRoute(string name,
                               int startAreaID,
                               int goalAreaID,
                               int numInitialRoutes)

Returns the Route ID if successful.

kbCreateAttackRouteWithPath

public int kbCreateAttackRouteWithPath(string name,
                                       vector startPt,
                                       vector endPt)

Returns the Route ID if successful.

kbDestroyAttackRoute

public bool kbDestroyAttackRoute(int routeID)

Returns true if the route was deleted.

kbAddAttackRouteSector

public bool kbAddAttackRouteSector(int sector)

Add a new sector to path to.

kbAddAttackRouteIgnoreID

public bool kbAddAttackRouteIgnoreID(int ignoreAreaID)

Ignore this area when finding the route.

kbAddAttackRouteIgnoreType

public bool kbAddAttackRouteIgnoreType(int ignoreAreaTypeID)

Ignore this area type when finding the route.

kbAttackRouteAddPath

public bool kbAttackRouteAddPath(int attackRouteID,
                                 int pathID)

Returns true if path was added to attack route.

kbMakeAttackRoutes

public bool kbMakeAttackRoutes()

Find all the paths to the sector specified.

kbGetNumAttackRoutes

public int kbGetNumAttackRoutes(long startAreaID,
                                long goalAreaID)

Returns the number of paths from start to goal area.

kbGetAttackRouteID

public int kbGetAttackRouteID(long startAreaID,
                              long goalAreaID)

Returns the id of the routes from area1 to area2.