Jumpvalley.Players.Player Class Reference

This class represents a player who is playing Jumpvalley or some other app that derives from it. This class inherits from the Interactive class since it contains some functionality that assists with initializing, starting, stopping, and disposing the app components functioning on behalf of the player.

This class contains some of the basic components that allow the app to function for the player, such as:

• Their music player
• The Controller instance that allows them to control their character
• The Camera instance that allows them to control their camera
• Their primary GUI node

More...

Inheritance diagram for Jumpvalley.Players.Player:

Public Member Functions
	Player (SceneTree tree, Node rootNode)
new void	Dispose ()
	Disposes of this Player instance and whatever objects are currently in the Disposables list.
Public Member Functions inherited from Jumpvalley.Levels.Interactives.Interactive
	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.

Properties
SceneTree	Tree [get]
	The scene tree that the current application instance is running under. This Player instance should "correspond to" the application instance.
Node	RootNode [get]
	The root node containing the app's components as Godot nodes.
MusicPlayer	CurrentMusicPlayer [get, protected set]
	The player's current music player.
Node	PrimaryGui [get, protected set]
	The player's primary GUI root node.
CharacterBody3D	Character [get, protected set]
	The player's current character instance.
BaseMover	Mover [get, protected set]
	The primary mover instance acting on behalf of the player's character.
BaseCamera	Camera [get, protected set]
	The primary node that handles the player's camera.
List< IDisposable >	Disposables [get]
	Objects that will get disposed of once the current Player instance gets Dispose()'d.
Properties inherited from Jumpvalley.Levels.Interactives.Interactive
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.

Additional Inherited Members
Public Attributes inherited from Jumpvalley.Levels.Interactives.Interactive
object	Runner
	The object that's running this interactive.

Detailed Description

This class represents a player who is playing Jumpvalley or some other app that derives from it. This class inherits from the Interactive class since it contains some functionality that assists with initializing, starting, stopping, and disposing the app components functioning on behalf of the player.

This class contains some of the basic components that allow the app to function for the player, such as:

• Their music player
• The Controller instance that allows them to control their character
• The Camera instance that allows them to control their camera
• Their primary GUI node

---

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

• Player.cs