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

Turns an object active or inactive at the various stages of the feedback More...

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

Public Types

enum  PossibleStates { PossibleStates.Enabled, PossibleStates.Disabled, PossibleStates.Toggle }
 sets the inspector color for this feedback More...
 

Public Attributes

Behaviour TargetBehaviour
 the gameobject we want to change the active state of More...
 
List< Behaviour > ExtraTargetBehaviours
 a list of extra gameobjects we want to change the active state of More...
 
bool SetStateOnInit = false
 whether or not we should alter the state of the target object on init More...
 
PossibleStates StateOnInit = PossibleStates.Disabled
 how to change the state on init More...
 
bool SetStateOnPlay = false
 whether or not we should alter the state of the target object on play More...
 
PossibleStates StateOnPlay = PossibleStates.Disabled
 how to change the state on play More...
 
bool SetStateOnStop = false
 whether or not we should alter the state of the target object on stop More...
 
PossibleStates StateOnStop = PossibleStates.Disabled
 how to change the state on stop More...
 
bool SetStateOnReset = false
 whether or not we should alter the state of the target object on reset More...
 
PossibleStates StateOnReset = PossibleStates.Disabled
 how to change the state on 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 we change the state of our Behaviour if needed More...
 
override void CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
 On Play we change the state of our Behaviour if needed More...
 
override void CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
 On Stop we change the state of our Behaviour if needed More...
 
override void CustomReset ()
 On Reset we change the state of our Behaviour if needed More...
 
virtual void SetStatus (PossibleStates state)
 Changes the status of the Behaviour More...
 
virtual void SetStatus (PossibleStates state, Behaviour target)
 Sets the specified status on the target Behaviour More...
 
override void CustomRestoreInitialValues ()
 On restore, we put our object back at its initial position More...
 

Protected Attributes

bool _initialState
 

Additional Inherited Members

Detailed Description

Turns an object active or inactive at the various stages of the feedback

Member Enumeration Documentation

◆ PossibleStates

sets the inspector color for this feedback

the possible effects the feedback can have on the target object's status

Enumerator
Enabled 
Disabled 
Toggle 

Member Function Documentation

◆ CustomInitialization()

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

On init we change the state of our Behaviour if needed

Parameters
owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

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

On Play we change the state of our Behaviour if needed

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomReset()

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

On Reset we change the state of our Behaviour if needed

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

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

On restore, we put our object back at its initial position

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_Enable.CustomStopFeedback ( Vector3  position,
float  feedbacksIntensity = 1 
)
protectedvirtual

On Stop we change the state of our Behaviour if needed

Parameters
position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ SetStatus() [1/2]

virtual void MoreMountains.Feedbacks.MMF_Enable.SetStatus ( PossibleStates  state)
protectedvirtual

Changes the status of the Behaviour

Parameters
state

◆ SetStatus() [2/2]

virtual void MoreMountains.Feedbacks.MMF_Enable.SetStatus ( PossibleStates  state,
Behaviour  target 
)
protectedvirtual

Sets the specified status on the target Behaviour

Parameters
state
target

Member Data Documentation

◆ _initialState

bool MoreMountains.Feedbacks.MMF_Enable._initialState
protected

◆ ExtraTargetBehaviours

List<Behaviour> MoreMountains.Feedbacks.MMF_Enable.ExtraTargetBehaviours

a list of extra gameobjects we want to change the active state of

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Enable.FeedbackTypeAuthorized = true
static

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

◆ SetStateOnInit

bool MoreMountains.Feedbacks.MMF_Enable.SetStateOnInit = false

whether or not we should alter the state of the target object on init

◆ SetStateOnPlay

bool MoreMountains.Feedbacks.MMF_Enable.SetStateOnPlay = false

whether or not we should alter the state of the target object on play

◆ SetStateOnReset

bool MoreMountains.Feedbacks.MMF_Enable.SetStateOnReset = false

whether or not we should alter the state of the target object on reset

◆ SetStateOnStop

bool MoreMountains.Feedbacks.MMF_Enable.SetStateOnStop = false

whether or not we should alter the state of the target object on stop

◆ StateOnInit

PossibleStates MoreMountains.Feedbacks.MMF_Enable.StateOnInit = PossibleStates.Disabled

how to change the state on init

◆ StateOnPlay

PossibleStates MoreMountains.Feedbacks.MMF_Enable.StateOnPlay = PossibleStates.Disabled

how to change the state on play

◆ StateOnReset

PossibleStates MoreMountains.Feedbacks.MMF_Enable.StateOnReset = PossibleStates.Disabled

how to change the state on reset

◆ StateOnStop

PossibleStates MoreMountains.Feedbacks.MMF_Enable.StateOnStop = PossibleStates.Disabled

how to change the state on stop

◆ TargetBehaviour

Behaviour MoreMountains.Feedbacks.MMF_Enable.TargetBehaviour

the gameobject we want to change the active state of


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