Feel  3.16
The best way to improve your game's feel and make it extra juicy
MoreMountains.Feedbacks.MMF_Blink Class Reference

This feedback will trigger a MMBlink object, letting you blink something More...

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

Public Types

enum  BlinkModes { BlinkModes.Toggle, BlinkModes.Start, BlinkModes.Stop }
 the possible modes for this feedback, that correspond to MMBlink's public methods More...
 

Public Member Functions

override void InitializeCustomAttributes ()
 Initializes our duration button More...
 
virtual void GrabDurationFromBlink ()
 Grabs and stores the duration from our target blink component if one is set More...
 

Public Attributes

override bool HasAutomatedTargetAcquisition => true
 
MMBlink TargetBlink
 the target object to blink More...
 
List< MMBlinkExtraTargetBlinks
 an optional list of extra target objects to blink More...
 
BlinkModes BlinkMode = BlinkModes.Toggle
 the selected mode for this feedback More...
 
float Duration
 the duration of the blink. You can set it manually, or you can press the GrabDurationFromBlink button to automatically compute it. For performance reasons, this isn't updated unless you press the button, make sure you do so if you change the blink's duration. More...
 
MMF_Button GrabDurationFromBlinkButton
 

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 AutomateTargetAcquisition ()
 A method meant to be implemented per feedback letting you specify what happens (usually setting a target) More...
 
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Custom play, we trigger our MMBlink object More...
 
virtual void HandleBlink (MMBlink target)
 Toggles, starts or stops blink on the target More...
 
override void CustomRestoreInitialValues ()
 On restore, we restore our initial state More...
 

Properties

override float FeedbackDuration [get, set]
 sets the inspector color for this feedback More...
 

Additional Inherited Members

Detailed Description

This feedback will trigger a MMBlink object, letting you blink something

Member Enumeration Documentation

◆ BlinkModes

the possible modes for this feedback, that correspond to MMBlink's public methods

Enumerator
Toggle 
Start 
Stop 

Member Function Documentation

◆ AutomateTargetAcquisition()

override void MoreMountains.Feedbacks.MMF_Blink.AutomateTargetAcquisition ( )
protectedvirtual

A method meant to be implemented per feedback letting you specify what happens (usually setting a target)

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

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

On Custom play, we trigger our MMBlink object

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

override void MoreMountains.Feedbacks.MMF_Blink.CustomRestoreInitialValues ( )
protectedvirtual

On restore, we restore our initial state

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ GrabDurationFromBlink()

virtual void MoreMountains.Feedbacks.MMF_Blink.GrabDurationFromBlink ( )
virtual

Grabs and stores the duration from our target blink component if one is set

◆ HandleBlink()

virtual void MoreMountains.Feedbacks.MMF_Blink.HandleBlink ( MMBlink  target)
protectedvirtual

Toggles, starts or stops blink on the target

Parameters
target

◆ InitializeCustomAttributes()

override void MoreMountains.Feedbacks.MMF_Blink.InitializeCustomAttributes ( )
virtual

Initializes our duration button

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ BlinkMode

BlinkModes MoreMountains.Feedbacks.MMF_Blink.BlinkMode = BlinkModes.Toggle

the selected mode for this feedback

◆ Duration

float MoreMountains.Feedbacks.MMF_Blink.Duration

the duration of the blink. You can set it manually, or you can press the GrabDurationFromBlink button to automatically compute it. For performance reasons, this isn't updated unless you press the button, make sure you do so if you change the blink's duration.

◆ ExtraTargetBlinks

List<MMBlink> MoreMountains.Feedbacks.MMF_Blink.ExtraTargetBlinks

an optional list of extra target objects to blink

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Blink.FeedbackTypeAuthorized = true
static

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

◆ GrabDurationFromBlinkButton

MMF_Button MoreMountains.Feedbacks.MMF_Blink.GrabDurationFromBlinkButton

◆ HasAutomatedTargetAcquisition

override bool MoreMountains.Feedbacks.MMF_Blink.HasAutomatedTargetAcquisition => true

◆ TargetBlink

MMBlink MoreMountains.Feedbacks.MMF_Blink.TargetBlink

the target object to blink

Property Documentation

◆ FeedbackDuration

override float MoreMountains.Feedbacks.MMF_Blink.FeedbackDuration
getset

sets the inspector color for this feedback


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