PlatformerPro.Extras.FX_Flash Class Reference

FX class which flashes a sprite by changing its colour. More...

Inheritance diagram for PlatformerPro.Extras.FX_Flash:

Public Attributes
Color	invisibleColour
	Target color. More...
float	totalTime
	How long to flash for. More...
float	invisibleTime
	How long to stay in the invisble colour. More...
float	visibleTime
	How long to stay in the invisble colour. More...
Component	fadeTarget
	Target to fade. More...
Public Attributes inherited from PlatformerPro.Extras.FX_Base
bool	playOnAwake
	Should we play this on awake. More...

Protected Member Functions
override void	DoEffect ()
	Do the effect. More...
virtual IEnumerator	Flash ()
	Flash the target. More...
virtual void	SetOriginalColor (Component component)
	Sets the original color by inspecting the relevant component. More...
virtual void	SetColorForComponent (Component component, Color32 color)
	Sets the color for component. More...

Protected Attributes
Color	originalColor
Protected Attributes inherited from PlatformerPro.Extras.FX_Base
bool	playWhenEnabled
	If we have play on awake true but we are not enabled we will defer the play until we are enabled. More...

Additional Inherited Members
Public Member Functions inherited from PlatformerPro.Extras.FX_Base
virtual void	StartEffect ()
	Starts the effect. More...
virtual void	StartEffect (GameObject callbackObject, string function)
	Starts the effect. More...

Detailed Description

FX class which flashes a sprite by changing its colour.

Member Function Documentation

DoEffect()

override void PlatformerPro.Extras.FX_Flash.DoEffect ( )

protectedvirtual

Do the effect.

Implements PlatformerPro.Extras.FX_Base.

Flash()

virtual IEnumerator PlatformerPro.Extras.FX_Flash.Flash ( )

protectedvirtual

Flash the target.

SetColorForComponent()

virtual void PlatformerPro.Extras.FX_Flash.SetColorForComponent ( Component  component, Color32  color  )

protectedvirtual

Sets the color for component.

Parameters

component	Component.
color	Color.

SetOriginalColor()

virtual void PlatformerPro.Extras.FX_Flash.SetOriginalColor ( Component  component )

protectedvirtual

Sets the original color by inspecting the relevant component.

Parameters

component

Component.

Member Data Documentation

fadeTarget

Component PlatformerPro.Extras.FX_Flash.fadeTarget

Target to fade.

invisibleColour

Color PlatformerPro.Extras.FX_Flash.invisibleColour

Target color.

invisibleTime

float PlatformerPro.Extras.FX_Flash.invisibleTime

How long to stay in the invisble colour.

originalColor

Color PlatformerPro.Extras.FX_Flash.originalColor

protected

totalTime

float PlatformerPro.Extras.FX_Flash.totalTime

How long to flash for.

visibleTime

float PlatformerPro.Extras.FX_Flash.visibleTime

How long to stay in the invisble colour.

---

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

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