API documentation

scripts/AudioController.nlvm

@@ -4,7 +4,7 @@ package scripts;
 //import scripts.utilities.*;
 import scripts.containers.*;
 
-public class AudioController extends Behaviour implements IReferenceable
+public final class AudioController extends Behaviour implements IReferenceable
 {
     private SpatialSound m_PrimaryAudioLoop = null;
     private AudioFile m_PrimaryAudioFile = null;

scripts/AudioCueButton.nlvm

@@ -2,7 +2,7 @@ package scripts;
 
 import com.nolimitscoaster.*;
 
-public class AudioCueButton extends AudioCue implements InteractionActionListener
+public final class AudioQueueButton extends AudioQueue implements InteractionActionListener
 {
     private InteractionObject m_Interaction = null;
     private Animation m_Animation = null;

scripts/AudioCueStationDispatch.nlvm

@@ -2,7 +2,7 @@ package scripts;
 
 import com.nolimitscoaster.*;
 
-public class AudioCueStationDispatch extends AudioCue
+public final class AudioQueueStationDispatch extends AudioQueue
 {
     private Section m_Station = null;
     private Train m_TrainAtStation = null;

scripts/AudioCueTimeOfDay.nlvm

@@ -2,7 +2,7 @@ package scripts;
 
 import scripts.math.*;
 
-public class AudioCueTimeOfDay extends AudioCue
+public final class AudioQueueTimeOfDay extends AudioQueue
 {
     private int m_Hour = 0;
     private int m_Minute = 0;

scripts/AudioCueTimer.nlvm

@@ -1,6 +1,6 @@
 package scripts;
 
-public class AudioCueTimer extends AudioCue
+public final class AudioQueueTimer extends AudioQueue
 {
     private Timer m_IntervalTimer = null;
 

scripts/AudioCueTrackTrigger.nlvm

@@ -3,7 +3,7 @@ package scripts;
 import com.nolimitscoaster.*;
 import scripts.utilities.*;
 
-public class AudioCueTrackTrigger extends AudioCue implements TrackTriggerListener
+public final class AudioQueueTrackTrigger extends AudioQueue implements TrackTriggerListener
 {
     private TrackTrigger m_TrackTrigger = null;
     private TrackTrigger m_StopTrigger = null;

scripts/AudioCueWeather.nlvm

@@ -1,6 +1,6 @@
 package scripts;
 
-public class AudioCueWeather extends AudioCue
+public final class AudioQueueWeather extends AudioQueue
 {
     private float m_WeatherThreshold = 0;
     private bool m_HasPlayed = false;

scripts/AudioEmitterCar.nlvm

@@ -6,7 +6,7 @@ import scripts.containers.*;
 import com.nolimitscoaster.*;
 import nlvm.math3d.*;
 
-public class AudioEmitterCar extends AudioEmitter
+public final class AudioEmitterCar extends AudioEmitter
 {
     private Coaster m_Coaster = null;
     private Train m_Train = null;

scripts/AudioEmitterCube.nlvm

@@ -2,7 +2,7 @@ package scripts;
 
 import scripts.math.*;
 
-public class AudioEmitterCube extends AudioEmitterVolume
+public final class AudioEmitterCube extends AudioEmitterVolume
 {
     public void Start()
     {

scripts/AudioEmitterSphere.nlvm

@@ -2,7 +2,7 @@ package scripts;
 
 import scripts.math.*;
 
-public class AudioEmitterSphere extends AudioEmitterVolume
+public final class AudioEmitterSphere extends AudioEmitterVolume
 {
     public void Start()
     {

scripts/AudioFile.nlvm

@@ -2,7 +2,7 @@ package scripts;
 
 import com.nolimitscoaster.*;
 
-public class AudioFile extends Behaviour implements IReferenceable
+public final class AudioFile extends Behaviour implements IReferenceable
 {
     private Sound m_Sound = null;
     private String m_Name = "";

scripts/Debug.nlvm

@@ -20,6 +20,10 @@ public final class Debug extends Object
     private static PrintStream m_TextStream = System.out;
     private static PrintStream m_ErrorStream = System.err;
 
+    /// <method>
+    /// <desc>Gets the debug state.</desc>
+    /// <return>True if debugging is enabled, otherwise False.</return>
+    /// </method>
     public static bool IsDebugMode()
     {
         if(m_GizmoHandler == null)
@@ -144,6 +148,8 @@ public final class Debug extends Object
         m_GizmoHandler.DrawLine(matrix, timespan, color);
     }
 
+
+
     private static void InternalPrintln(String str)
     {
         if(!IsDebugMode())

scripts/IReferenceable.nlvm

@@ -1,9 +1,22 @@
 package scripts;
 
+/// <interface>
+/// <desc>Represents a referenceable data type that can be accessed across scripts.</desc>
 public interface IReferenceable
 {
+    /// <method>
+    /// <desc>Gets the name of the reference.</desc>
+    /// </method>
     public String GetName();
+    /// <method>
+    /// <desc>Sets the name of the reference.</desc>
+    /// </method>
     public void SetName(String name);
 
+    /// <method>
+    /// <desc>Gets the referenceable type.</desc>
+    /// <return>String representation of the script identifier.</return>
+    /// </method>
     public String GetType();
-}
+}
+/// </interface>