Jumpvalley.Levels.Interactives.Interactive Class Reference

The base class for all Interactive types in Jumpvalley. More...

Inheritance diagram for Jumpvalley.Levels.Interactives.Interactive:

Public Member Functions
	Interactive (OffsetStopwatch clock, object runner=null)
	Creates a new instance of Interactive that will run on the given OffsetStopwatch.
virtual void	Initialize ()
	Interactive initialization method that initializes the interactive after the constructor runs, in case such method is needed. By default, this method is only called once after the object's constructor runs. Initialize() typically shouldn't be called more than once for the same Interactive instance.
virtual void	Start ()
	The interactive's start method. This method is called every time the user starts or restarts the interactive, and it's a great place to put code that will be run after initialization, but just before the interactive starts.
virtual void	Stop ()
	The interactive's stop method. This method is called right after the user stops or exits the interactive.
new void	Dispose ()
	Disposes of this Interactive instance. This method is a great place to free up resources being used by the interactive instance, especially right before the interactive itself gets freed from memory.

Public Attributes
object	Runner
	The object that's running this interactive.

Properties
bool	IsInitialized [get, protected set]
	Whether or not Initialize has been called once already.
bool	IsRunning [get, protected set]
	Whether or not the interactive is running (e.g. after Start has been called).
OffsetStopwatch	Clock [get]
	The OffsetStopwatch that the Interactive will run on. This stopwatch can be used to synchronize the Interactive's various operations to whatever the current time on this stopwatch is.

Detailed Description

The base class for all Interactive types in Jumpvalley.

Constructor & Destructor Documentation

Interactive()

Jumpvalley.Levels.Interactives.Interactive.Interactive ( OffsetStopwatch clock, object runner = null )

inline

Creates a new instance of Interactive that will run on the given OffsetStopwatch.

Parameters

clock	The Stopwatch that the Interactive will run on
runner	The object that's running this interactive

Member Function Documentation

Initialize()

virtual void Jumpvalley.Levels.Interactives.Interactive.Initialize ( )

inlinevirtual

Interactive initialization method that initializes the interactive after the constructor runs, in case such method is needed.
By default, this method is only called once after the object's constructor runs. Initialize() typically shouldn't be called more than once for the same Interactive instance.

Reimplemented in Jumpvalley.Levels.Level.

Start()

virtual void Jumpvalley.Levels.Interactives.Interactive.Start ( )

inlinevirtual

The interactive's start method. This method is called every time the user starts or restarts the interactive, and it's a great place to put code that will be run after initialization, but just before the interactive starts.

Reimplemented in Jumpvalley.Levels.Interactives.Mechanics.Spinner, Jumpvalley.Levels.Interactives.Mechanics.Teleporters.StartEndTeleporter, and Jumpvalley.Levels.Level.

Stop()

virtual void Jumpvalley.Levels.Interactives.Interactive.Stop ( )

inlinevirtual

The interactive's stop method. This method is called right after the user stops or exits the interactive.

Reimplemented in Jumpvalley.Levels.Interactives.Mechanics.Spinner, Jumpvalley.Levels.Interactives.Mechanics.Teleporters.StartEndTeleporter, and Jumpvalley.Levels.Level.

---

The documentation for this class was generated from the following file:

• Interactive.cs