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

This feedback will let you enable/disable/toggle a target collider 2D, or change its trigger status More...

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

Public Types

enum  Modes {
  Modes.Enable, Modes.Disable, Modes.ToggleActive, Modes.Trigger,
  Modes.NonTrigger, Modes.ToggleTrigger
}
 the possible effects the feedback can have on the target collider's status More...
 

Public Attributes

override bool HasAutomatedTargetAcquisition => true
 sets the inspector color for this feedback More...
 
Collider2D TargetCollider2D
 the collider to act upon More...
 
Modes Mode = Modes.Disable
 the effect the feedback will have on the target collider's status 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 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 Play we change the state of our collider if needed More...
 
virtual void ApplyChanges (Modes mode)
 Changes the state of the collider 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

This feedback will let you enable/disable/toggle a target collider 2D, or change its trigger status

Member Enumeration Documentation

◆ Modes

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

Enumerator
Enable 
Disable 
ToggleActive 
Trigger 
NonTrigger 
ToggleTrigger 

Member Function Documentation

◆ ApplyChanges()

virtual void MoreMountains.Feedbacks.MMF_Collider2D.ApplyChanges ( Modes  mode)
protectedvirtual

Changes the state of the collider

Parameters
state

◆ AutomateTargetAcquisition()

override void MoreMountains.Feedbacks.MMF_Collider2D.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_Collider2D.CustomPlayFeedback ( Vector3  position,
float  feedbacksIntensity = 1.0f 
)
protectedvirtual

On Play we change the state of our collider if needed

Parameters
position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomRestoreInitialValues()

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

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

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

Member Data Documentation

◆ _initialState

bool MoreMountains.Feedbacks.MMF_Collider2D._initialState
protected

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_Collider2D.FeedbackTypeAuthorized = true
static

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

◆ HasAutomatedTargetAcquisition

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

sets the inspector color for this feedback

◆ Mode

Modes MoreMountains.Feedbacks.MMF_Collider2D.Mode = Modes.Disable

the effect the feedback will have on the target collider's status

◆ TargetCollider2D

Collider2D MoreMountains.Feedbacks.MMF_Collider2D.TargetCollider2D

the collider to act upon


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