Path

consoledoc.h

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...

Callbacks

void
onAdd(SimObjectId ID)

Called when this ScriptGroup is added to the system.

Public Static Attributes

bool

Disables rendering of all instances of this type.

bool

Disables selection of all instances of this type.

Public Attributes

bool

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

int

Spawn Delay (max).

int

Spawn Delay (min).

int

Spawn Count.

float

Speed.

Public Functions

int

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

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".

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:
see:

Callbacks

onAdd(SimObjectId ID)

Called when this ScriptGroup is added to the system.

Parameters:

ID

Unique object ID assigned when created (this in script).

Public Static Attributes

bool isRenderable 

Disables rendering of all instances of this type.

bool isSelectable 

Disables selection of all instances of this type.

Public Attributes

bool isLooping 

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

int maxDelay 

Spawn Delay (max).

int minDelay 

Spawn Delay (min).

PathShapeData mPathShape 

Spawned PathShape.

int spawnCount 

Spawn Count.

float speed 

Speed.

Public Functions

getPathId()

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

return:

PathID (not the object ID) of this path.

// Acquire the PathID of this path object.
%pathID = %thisPath.getPathId();