Torque 3D - Script Manual: Path Class Reference

TorqueScript

Main   Class List   Namespace List   Online

Path Class Reference
[Miscellaneous]

A spline along which various objects can move along. The spline object acts like a container for Marker objects, which make up the joints, or knots, along the path. Paths can be assigned a speed, can be looping or non-looping. Each of a path's markers can be one of three primary movement types: "normal", "Position Only", or "Kink". More...

Inheritance diagram for Path:

List of all members.

Public Member Functions

int getPathId ()
 Returns the PathID (not the object ID) of this path.

Public Attributes

bool isLooping
 If this is true, the loop is closed, otherwise it is open.

Detailed Description

A spline along which various objects can move along. The spline object acts like a container for Marker objects, which make up the joints, or knots, along the path. Paths can be assigned a speed, can be looping or non-looping. Each of a path's markers can be one of three primary movement types: "normal", "Position Only", or "Kink".

Example:
new path()
   {
     isLooping = "1";

     new Marker()
      {
         seqNum = "0";
         type = "Normal";
         msToNext = "1000";
         smoothingType = "Spline";
         position = "-0.054708 -35.0612 234.802";
         rotation = "1 0 0 0";
      };

   };
See also:
Marker
NetConnection::transmitPaths()
NetConnection::clearPaths()
Path

Member Function Documentation

int Path::getPathId (  ) 

Returns the PathID (not the object ID) of this path.

Returns:
PathID (not the object ID) of this path.
Example:
// Acquire the PathID of this path object.
%pathID = %thisPath.getPathId();

Member Data Documentation

If this is true, the loop is closed, otherwise it is open.



Copyright © GarageGames, LLC. All Rights Reserved.