Scripting API

Home Scripting API Index Class Overview

com.nolimitscoaster

Class TrackTrigger


public class TrackTrigger
extends Entity
implements FrameListener

Represents a track trigger

Method Summary

void addTrackTriggerListener(TrackTriggerListener listener)
  Registers a TrackTriggerListener callback interface
static TrackTrigger createTrackTriggerAtOffset(TrackPos pos, double offset)
  Creates a track trigger at the track position with offset in meters on the center of rails spline
Coaster getCoaster()
  Returns the coaster this trigger belongs to
String getName()
  Returns the trigger's name as specified in the editor
void onNextFrame()
  This method is part of the FrameListener Interface implementation
void removeTrackTriggerListener(TrackTriggerListener listener)
  Removes a registered TrackTriggerListener callback interface


Method Detail


addTrackTriggerListener

public void addTrackTriggerListener(TrackTriggerListener listener)

Registers a TrackTriggerListener callback interface

Parameters:

listener - The callback listener to be registered, must not be null

createTrackTriggerAtOffset

public static TrackTrigger createTrackTriggerAtOffset(TrackPos pos, double offset)

Creates a track trigger at the track position with offset in meters on the center of rails spline

Warning: The computed trigger position will be clamped to the start and end of the current piece of track. The offset will not go beyond special or custom track boundaries.


getCoaster

public final Coaster getCoaster()

Returns the coaster this trigger belongs to

Returns:
    coaster this trigger belongs to

Since:
    2.5.7.0


getName

public final String getName()

Returns the trigger's name as specified in the editor

Returns:
    the name of the trigger as specified in the editor

Since:
    2.6.5.6


onNextFrame

public void onNextFrame()

This method is part of the FrameListener Interface implementation

Never call this method.


removeTrackTriggerListener

public void removeTrackTriggerListener(TrackTriggerListener listener)

Removes a registered TrackTriggerListener callback interface

Parameters:

listener - The listener to be removed