WayPoint Class Reference
[Miscellaneous]

Special type of marker, distinguished by a name and team ID number. More...

Inheritance diagram for WayPoint:

[legend]

List of all members.

Public Attributes
Misc
caseString	markerName
	Unique name representing this waypoint.
WayPointTeam	team
	Unique numerical ID assigned to this waypoint, or set of waypoints.
Static Public Attributes
static bool	isRenderable
	Disables rendering of all instances of this type.
static bool	isSelectable
	Disables selection of all instances of this type.

---

Detailed Description

Special type of marker, distinguished by a name and team ID number.

The original Torque engines were built from a multi-player game called Tribes. The Tribes series featured various team based game modes, such as capture the flag. The WayPoint class survived the conversion from game (Tribes) to game engine (Torque).

Essentially, this is a MissionMarker with the addition of two variables: markerName and team. Whenever a WayPoint is created, it is added to a unique global list called WayPointSet. You can iterate through this set, seeking out specific markers determined by their markerName and team ID. This avoids the overhead of constantly calling commandToClient and commandToServer to determine a WayPoint object's name, unique ID, etc.

Note:

The markerName field was previously called name, but was changed because this conflicted with the SimObject name field. Existing scripts that relied on the WayPoint name field will need to be updated.

Example:

new WayPoint()
{
   team = "1";
   dataBlock = "WayPointMarker";
   position = "-0.0224786 1.53471 2.93219";
   rotation = "1 0 0 0";
   scale = "1 1 1";
   canSave = "1";
   canSaveDynamicFields = "1";
};

See also:

MissionMarker

MissionMarkerData

---

Member Data Documentation

bool WayPoint::isRenderable [static]

Disables rendering of all instances of this type.

Reimplemented from MissionMarker.

bool WayPoint::isSelectable [static]

Disables selection of all instances of this type.

Reimplemented from MissionMarker.

caseString WayPoint::markerName

Unique name representing this waypoint.

WayPointTeam WayPoint::team

Unique numerical ID assigned to this waypoint, or set of waypoints.