MoreMountains.Feedbacks.MMFlash Class Reference

Add this class to an image and it'll flash when getting a MMFlashEvent More...

Inheritance diagram for MoreMountains.Feedbacks.MMFlash:

Public Member Functions
void	OnMMFlashEvent (Color flashColor, float duration, float alpha, int flashID, int channel)
	When getting a flash event, we turn our image on More...

Public Attributes
int	Channel = 0
	the channel to receive flash events on More...
int	FlashID = 0
	the ID of this MMFlash object. When triggering a MMFlashEvent you can specify an ID, and only MMFlash objects with this ID will answer the call and flash, allowing you to have more than one flash object in a scene More...

Protected Member Functions
virtual void	Start ()
	On start we grab our image component More...
virtual void	Update ()
	On update we flash our image if needed More...
virtual void	OnEnable ()
	On enable we start listening for events More...
virtual void	OnDisable ()
	On disable we stop listening for events More...

Protected Attributes
Image	_image
CanvasGroup	_canvasGroup
bool	_flashing = false
float	_targetAlpha
Color	_initialColor
float	_delta
float	_flashStartedTimestamp
int	_direction = 1
float	_duration

Detailed Description

Add this class to an image and it'll flash when getting a MMFlashEvent

Member Function Documentation

OnDisable()

virtual void MoreMountains.Feedbacks.MMFlash.OnDisable ( )

protectedvirtual

On disable we stop listening for events

OnEnable()

virtual void MoreMountains.Feedbacks.MMFlash.OnEnable ( )

protectedvirtual

On enable we start listening for events

OnMMFlashEvent()

void MoreMountains.Feedbacks.MMFlash.OnMMFlashEvent	(	Color	flashColor,
		float	duration,
		float	alpha,
		int	flashID,
		int	channel
	)

When getting a flash event, we turn our image on

Start()

virtual void MoreMountains.Feedbacks.MMFlash.Start ( )

protectedvirtual

On start we grab our image component

Update()

virtual void MoreMountains.Feedbacks.MMFlash.Update ( )

protectedvirtual

On update we flash our image if needed

Member Data Documentation

_canvasGroup

CanvasGroup MoreMountains.Feedbacks.MMFlash._canvasGroup

protected

_delta

float MoreMountains.Feedbacks.MMFlash._delta

protected

_direction

int MoreMountains.Feedbacks.MMFlash._direction = 1

protected

_duration

float MoreMountains.Feedbacks.MMFlash._duration

protected

_flashing

bool MoreMountains.Feedbacks.MMFlash._flashing = false

protected

_flashStartedTimestamp

float MoreMountains.Feedbacks.MMFlash._flashStartedTimestamp

protected

_image

Image MoreMountains.Feedbacks.MMFlash._image

protected

_initialColor

Color MoreMountains.Feedbacks.MMFlash._initialColor

protected

_targetAlpha

float MoreMountains.Feedbacks.MMFlash._targetAlpha

protected

Channel

int MoreMountains.Feedbacks.MMFlash.Channel = 0

the channel to receive flash events on

FlashID

int MoreMountains.Feedbacks.MMFlash.FlashID = 0

the ID of this MMFlash object. When triggering a MMFlashEvent you can specify an ID, and only MMFlash objects with this ID will answer the call and flash, allowing you to have more than one flash object in a scene

---

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

• F:/Github/Store/MMFeedbacksStore/Assets/MMFeedbacks/MMFeedbacks/MMFeedbacks/Shakers/MMFlash.cs