PlatformerPro.Extras.FX_Base Class Reference

Base class for simple FX. More...

Inheritance diagram for PlatformerPro.Extras.FX_Base:

Public Member Functions
virtual void	StartEffect ()
	Starts the effect. More...
virtual void	StartEffect (GameObject callbackObject, string function)
	Starts the effect. More...

Public Attributes
bool	playOnAwake
	Should we play this on awake. More...

Protected Member Functions
abstract void	DoEffect ()
	The effect implementation. More...

Protected Attributes
bool	playWhenEnabled
	If we have play on awake true but we are not enabled we will defer the play until we are enabled. More...

Detailed Description

Base class for simple FX.

Member Function Documentation

DoEffect()

abstract void PlatformerPro.Extras.FX_Base.DoEffect ( )

protectedpure virtual

The effect implementation.

Implemented in PlatformerPro.Extras.FX_UIMoveTo, PlatformerPro.Extras.FX_UIFadeToColour, PlatformerPro.Extras.FX_SpinningObject, PlatformerPro.Extras.FX_SnapTo, PlatformerPro.Extras.FX_Shake, PlatformerPro.Extras.FX_MoveTo, PlatformerPro.Extras.FX_ImpartForce2D, PlatformerPro.Extras.FX_Flash, PlatformerPro.Extras.FX_FadeToColour, and PlatformerPro.Extras.FX_DisableAfterDelay.

StartEffect() [1/2]

virtual void PlatformerPro.Extras.FX_Base.StartEffect ( )

virtual

Starts the effect.

StartEffect() [2/2]

virtual void PlatformerPro.Extras.FX_Base.StartEffect ( GameObject  callbackObject, string  function  )

virtual

Starts the effect.

Parameters

callbackObject	Call back object.
function	Function to call.

Member Data Documentation

playOnAwake

bool PlatformerPro.Extras.FX_Base.playOnAwake

Should we play this on awake.

playWhenEnabled

bool PlatformerPro.Extras.FX_Base.playWhenEnabled

protected

If we have play on awake true but we are not enabled we will defer the play until we are enabled.

---

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

• D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Effects/FX_Base.cs