TopDown Engine  v4.2
MoreMountains.Feedbacks.MMF_Events Class Reference

A feedback to bind Unity events to and trigger them when played More...

Inheritance diagram for MoreMountains.Feedbacks.MMF_Events:
MoreMountains.Feedbacks.MMF_Feedback

Public Attributes

UnityEvent PlayEvents
 sets the inspector color for this feedback More...
 
UnityEvent StopEvents
 the events to trigger when the feedback is stopped More...
 
UnityEvent InitializationEvents
 the events to trigger when the feedback is initialized More...
 
UnityEvent ResetEvents
 the events to trigger when the feedback is reset More...
 

Static Public Attributes

static bool FeedbackTypeAuthorized = true
 a static bool used to disable all feedbacks of this type at once More...
 

Protected Member Functions

override void CustomInitialization (MMF_Player owner)
 On init, triggers the init events More...
 
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play, triggers the play events More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Stop, triggers the stop events More...
 
override void CustomReset ()
 On reset, triggers the reset events More...
 

Additional Inherited Members

Detailed Description

A feedback to bind Unity events to and trigger them when played

Member Function Documentation

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_Events.CustomInitialization ( MMF_Player  owner)
protectedvirtual

On init, triggers the init events

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

override void MoreMountains.Feedbacks.MMF_Events.CustomPlayFeedback ( Vector3  position,
float  feedbacksIntensity = 1.0f 
)
protectedvirtual

On Play, triggers the play events

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomReset()

override void MoreMountains.Feedbacks.MMF_Events.CustomReset ( )
protectedvirtual

On reset, triggers the reset events

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_Events.CustomStopFeedback ( Vector3  position,
float  feedbacksIntensity = 1.0f 
)
protectedvirtual

On Stop, triggers the stop events

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Events.FeedbackTypeAuthorized = true
static

a static bool used to disable all feedbacks of this type at once

◆ InitializationEvents

UnityEvent MoreMountains.Feedbacks.MMF_Events.InitializationEvents

the events to trigger when the feedback is initialized

◆ PlayEvents

UnityEvent MoreMountains.Feedbacks.MMF_Events.PlayEvents

sets the inspector color for this feedback

the events to trigger when the feedback is played

◆ ResetEvents

UnityEvent MoreMountains.Feedbacks.MMF_Events.ResetEvents

the events to trigger when the feedback is reset

◆ StopEvents

UnityEvent MoreMountains.Feedbacks.MMF_Events.StopEvents

the events to trigger when the feedback is stopped


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