CustomShipModule Class Reference

Inheritance diagram for CustomShipModule:

List of all members.

Public Member Functions
virtual void	OnAwake ()
	Called when the parent ship is awoken.
virtual void	OnStart ()
	Called when the parent ship starts.
virtual void	OnUpdate ()
	Called every frame that the parent ship is running for.
virtual void	OnFixedUpdate ()
	Called every timestep that the parent ship is running for.
virtual void	OnDestroy ()
	Called when the parent ship is destroyed.
virtual void	OnShipExploded ()
	Called when this ship has exploded.
virtual void	OnShipFinished ()
	Called when this ship finishes the event.
virtual void	OnShipLapUpdated ()
	Called when this ship completes a lap.
virtual void	OnShipDropPickup ()
	Called when this ship drops a pickup.
virtual void	OnShipAbsorbPickup (float shieldRestored)
	Called when this ship absorbs a pickup.
virtual void	OnShipObtainPickup (PickupBase pickup)
	Called when this ship obtains a pickup.
virtual void	OnShipUsePickup (PickupBase pickup)
	Called when this ship uses a pickup.
virtual void	OnShipHitWeaponTile (WeaponPad hitTile)
	Called when this ship flies over a weapon tile (2d).
virtual void	OnShipHitWeaponPad (TrackPad hitPad)
	Called when a ship flies over a weapon pad (3d).
virtual void	OnShipHitSpeedTile (Tile hitTile)
	Called when a ship flies ovver a speed tile (2d).
virtual void	OnShipHitSpeedPad (TrackPad hitPad)
	Called when a ship flies over a speed pad (3d).
virtual void	OnShipRespawn ()
	Called when this ship is respawned.
virtual void	OnShipScoreChanged (float oldScore, float newScore)
	Called when this ships score changes.
int	GetIntData (string key, int defaultValue)
	Returns an integer from a user variable on the ship.
float	GetFloatData (string key, float defaultValue)
	Returns a float from a user variable on the ship.
bool	GetBooleanData (string key, bool defaultValue)
	Returns a boolean from a user variable on the ship.
Vector2	GetVector2Data (string key, Vector2 defaultValue)
	Returns a Vector2 from a user variable on the ship.
Vector3	GetVector2Data (string key, Vector3 defaultValue)
	Returns a Vector3 from a user variable on the ship.
Quaternion	GetQuaternionData (string key, Quaternion defaultValue)
	Returns a Quaternion from a user variable on the ship.
Color	GetColorData (string key, Color defaultValue)
	Returns a Color from a user variable on the ship.
AnimationCurve	GetAnimationCurveData (string key, AnimationCurve defaultValue)
	Returns a Color from a user variable on the ship.
Static Public Member Functions
static CustomShipModule	FindModule (string name)
	Finds and returns a module if one containing the provided name (case insensitive) is present.
static CustomShipModule	LoadModule (string name)
	Finds, creates an instance of and returns a module if one containing the provided name (case insensitive) is present.
static bool	RegisterModule (string name, CustomShipModule module)
	Adds a new ship module to the game. Returns false if the module already exists.
Public Attributes
ShipRefs	Ship
	The ship that this module is attached to.

---

Member Function Documentation

static CustomShipModule CustomShipModule.FindModule

(

string

name

)

[inline, static]

Finds and returns a module if one containing the provided name (case insensitive) is present.

Returns:

AnimationCurve CustomShipModule.GetAnimationCurveData	(	string	key,
		AnimationCurve	defaultValue
	)		[inline]

Returns a Color from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

bool CustomShipModule.GetBooleanData	(	string	key,
		bool	defaultValue
	)		[inline]

Returns a boolean from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

Color CustomShipModule.GetColorData	(	string	key,
		Color	defaultValue
	)		[inline]

Returns a Color from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

float CustomShipModule.GetFloatData	(	string	key,
		float	defaultValue
	)		[inline]

Returns a float from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

int CustomShipModule.GetIntData	(	string	key,
		int	defaultValue
	)		[inline]

Returns an integer from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

Quaternion CustomShipModule.GetQuaternionData	(	string	key,
		Quaternion	defaultValue
	)		[inline]

Returns a Quaternion from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

Vector2 CustomShipModule.GetVector2Data	(	string	key,
		Vector2	defaultValue
	)		[inline]

Returns a Vector2 from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

Vector3 CustomShipModule.GetVector2Data	(	string	key,
		Vector3	defaultValue
	)		[inline]

Returns a Vector3 from a user variable on the ship.

Parameters:

key	The variable name.
defaultValue	The default value if the variable doesn't exist or isn't the right type.

static CustomShipModule CustomShipModule.LoadModule

(

string

name

)

[inline, static]

Finds, creates an instance of and returns a module if one containing the provided name (case insensitive) is present.

Returns:

virtual void CustomShipModule.OnAwake

(

)

[inline, virtual]

Called when the parent ship is awoken.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnDestroy

(

)

[inline, virtual]

Called when the parent ship is destroyed.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnFixedUpdate

(

)

[inline, virtual]

Called every timestep that the parent ship is running for.

Reimplemented in DragModule, and DebugCustomShipModule.

virtual void CustomShipModule.OnShipAbsorbPickup

(

float

shieldRestored

)

[inline, virtual]

Called when this ship absorbs a pickup.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipDropPickup

(

)

[inline, virtual]

Called when this ship drops a pickup.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipExploded

(

)

[inline, virtual]

Called when this ship has exploded.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipFinished

(

)

[inline, virtual]

Called when this ship finishes the event.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipHitSpeedPad

(

TrackPad

hitPad

)

[inline, virtual]

Called when a ship flies over a speed pad (3d).

Reimplemented in DragModule, DebugCustomShipModule, and TempestModule.

virtual void CustomShipModule.OnShipHitSpeedTile

(

Tile

hitTile

)

[inline, virtual]

Called when a ship flies ovver a speed tile (2d).

Reimplemented in DragModule, DebugCustomShipModule, and TempestModule.

virtual void CustomShipModule.OnShipHitWeaponPad

(

TrackPad

hitPad

)

[inline, virtual]

Called when a ship flies over a weapon pad (3d).

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipHitWeaponTile

(

WeaponPad

hitTile

)

[inline, virtual]

Called when this ship flies over a weapon tile (2d).

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipLapUpdated

(

)

[inline, virtual]

Called when this ship completes a lap.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipObtainPickup

(

PickupBase

pickup

)

[inline, virtual]

Called when this ship obtains a pickup.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipRespawn

(

)

[inline, virtual]

Called when this ship is respawned.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipScoreChanged	(	float	oldScore,
		float	newScore
	)		[inline, virtual]

Called when this ships score changes.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnShipUsePickup

(

PickupBase

pickup

)

[inline, virtual]

Called when this ship uses a pickup.

Reimplemented in DebugCustomShipModule.

virtual void CustomShipModule.OnStart

(

)

[inline, virtual]

Called when the parent ship starts.

Reimplemented in DragModule, and DebugCustomShipModule.

virtual void CustomShipModule.OnUpdate

(

)

[inline, virtual]

Called every frame that the parent ship is running for.

Reimplemented in DragModule, and DebugCustomShipModule.

static bool CustomShipModule.RegisterModule	(	string	name,
		CustomShipModule	module
	)		[inline, static]

Adds a new ship module to the game. Returns false if the module already exists.

---

Member Data Documentation

ShipRefs CustomShipModule.Ship

The ship that this module is attached to.

---

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

• A:/Projects/Unity/BallisticNG/Assets/Source/Ships/CustomShipModule.cs