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

Inheritance diagram for MoreMountains.Feedbacks.MMF_SetActive:

Public Types
enum	PossibleStates { Active , Inactive , Toggle }
	sets the inspector color for this feedback More...

Public Attributes
GameObject	TargetGameObject
	the gameobject 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.Inactive
	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.Inactive
	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.Inactive
	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.Inactive
	how to change the state on reset More...

Public Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
bool	Active = true
	whether or not this feedback is active More...

int	UniqueID

string	Label = "MMFeedback"
	the name of this feedback to display in the inspector More...

int	Channel = 0
	the ID of the channel on which this feedback will communicate More...

float	Chance = 100f
	the chance of this feedback happening (in percent : 100 : happens all the time, 0 : never happens, 50 : happens once every two calls, etc) More...

Color	DisplayColor = Color.black
	use this color to customize the background color of the feedback in the MMF_Player's list More...

MMFeedbackTiming	Timing
	a number of timing-related values (delay, repeat, etc) More...

MMF_Player	Owner
	the Owner of the feedback, as defined when calling the Initialization method More...

bool	DebugActive = false
	whether or not this feedback is in debug mode 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 object if needed More...

override void	CustomPlayFeedback (Vector3 position, float feedbacksIntensity=1.0f)
	On Play we change the state of our object if needed More...

override void	CustomStopFeedback (Vector3 position, float feedbacksIntensity=1)
	On Stop we change the state of our object if needed More...

override void	CustomReset ()
	On Reset we change the state of our object if needed More...

virtual void	SetStatus (PossibleStates state)
	Changes the status of the object More...

Protected Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual IEnumerator	PlayCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	An internal coroutine delaying the initial play of the feedback More...

virtual void	RegularPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Triggers delaying coroutines if needed More...

virtual IEnumerator	InfinitePlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play without end More...

virtual IEnumerator	RepeatedPlay (Vector3 position, float feedbacksIntensity=1.0f)
	Internal coroutine used for repeated play More...

virtual IEnumerator	SequenceCoroutine (Vector3 position, float feedbacksIntensity=1.0f)
	A coroutine used to play this feedback on a sequence More...

virtual float	ApplyTimeMultiplier (float duration)
	Applies the host MMFeedbacks' time multiplier to this feedback More...

virtual float	ApplyDirection (float normalizedTime)
	Returns a new value of the normalized time based on the current play direction of this feedback More...

virtual void	CustomSkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	This method describes what happens when the feedback gets skipped to the end More...

Additional Inherited Members
Public Member Functions inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual void	CacheRequiresSetup ()

virtual bool	EvaluateRequiresSetup ()
	Override this method to determine if a feedback requires setup More...

virtual void	Initialization (MMF_Player owner)
	Initializes the feedback and its timing related variables More...

virtual void	Play (Vector3 position, float feedbacksIntensity=1.0f)
	Plays the feedback More...

virtual void	SetSequence (MMSequence newSequence)
	Use this method to change this feedback's sequence at runtime More...

virtual void	Stop (Vector3 position, float feedbacksIntensity=1.0f)
	Stops all feedbacks from playing. Will stop repeating feedbacks, and call custom stop implementations More...

virtual void	SkipToTheEnd (Vector3 position, float feedbacksIntensity=1.0f)
	Called when skipping to the end of MMF_Player, calls custom Skip on all feedbacks More...

virtual void	ResetFeedback ()
	Calls this feedback's custom reset More...

virtual void	SetDelayBetweenRepeats (float delay)
	Use this method to specify a new delay between repeats at runtime More...

virtual void	SetInitialDelay (float delay)
	Use this method to specify a new initial delay at runtime More...

virtual void	InitializeCustomAttributes ()
	Use this method to initialize any custom attributes you may have More...

virtual void	OnValidate ()
	Triggered when a change happens in the inspector More...

virtual void	OnDestroy ()
	Triggered when that feedback gets destroyed More...

Protected Attributes inherited from MoreMountains.Feedbacks.MMF_Feedback
float	_lastPlayTimestamp = -1f

int	_playsLeft

bool	_initialized = false

Coroutine	_playCoroutine

Coroutine	_infinitePlayCoroutine

Coroutine	_sequenceCoroutine

Coroutine	_repeatedPlayCoroutine

bool	_requiresSetup = false

string	_requiredTarget = ""

int	_sequenceTrackID = 0

float	_beatInterval

bool	BeatThisFrame = false

int	LastBeatIndex = 0

int	CurrentSequenceIndex = 0

float	LastBeatTimestamp = 0f

Properties inherited from MoreMountains.Feedbacks.MMF_Feedback
virtual IEnumerator	Pause `[get]`
	set this to true if your feedback should pause the execution of the feedback sequence More...

virtual bool	HoldingPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run More...

virtual bool	LooperPause `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	ScriptDrivenPause `[getset]`
	if this is true, this feedback will pause and wait until Resume() is called on its parent MMFeedbacks to resume execution More...

virtual float	ScriptDrivenPauseAutoResume `[getset]`
	if this is a positive value, the feedback will auto resume after that duration if it hasn't been resumed via script already More...

virtual bool	LooperStart `[get]`
	if this is true, this feedback will wait until all previous feedbacks have run, then run all previous feedbacks again More...

virtual bool	HasChannel `[get]`
	if this is true, the Channel property will be displayed, otherwise it'll be hidden More...

virtual bool	HasCustomInspectors `[get]`

virtual bool	InCooldown `[get]`
	returns true if this feedback is in cooldown at this time (and thus can't play), false otherwise More...

virtual bool	IsPlaying `[getset]`
	if this is true, this feedback is currently playing More...

virtual float	FeedbackTime `[get]`
	the time (or unscaled time) based on the selected Timing settings More...

virtual float	FeedbackDeltaTime `[get]`
	the delta time (or unscaled delta time) based on the selected Timing settings More...

virtual float	TotalDuration `[get]`
	The total duration of this feedback : total = initial delay + duration * (number of repeats + delay between repeats) More...

bool	RequiresSetup `[get]`
	A flag used to determine if a feedback has all it needs, or if it requires some extra setup. This flag will be used to display a warning icon in the inspector if the feedback is not ready to be played. More...

string	RequiredTarget `[get]`

virtual bool	DrawGroupInspectors `[get]`

virtual string	RequiresSetupText `[get]`

virtual string	RequiredTargetText `[get]`

virtual float?	FeedbackStartedAt `[get]`

virtual float	FeedbackDuration `[getset]`

virtual bool	FeedbackPlaying `[get]`
	whether or not this feedback is playing right now More...

virtual float?	FinalNormalizedTime `[get]`
	Returns the t value at which to evaluate a curve at the end of this feedback's play time More...

virtual bool	NormalPlayDirection `[get]`
	Returns true if this feedback should play normally, or false if it should play in rewind More...

virtual bool	ShouldPlayInThisSequenceDirection `[get]`
	Returns true if this feedback should play in the current parent MMFeedbacks direction, according to its MMFeedbacksDirectionCondition setting More...

Detailed Description

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

Member Enumeration Documentation

◆ PossibleStates

enum MoreMountains.Feedbacks.MMF_SetActive.PossibleStates

sets the inspector color for this feedback

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

Enumerator
Active
Inactive
Toggle

Member Function Documentation

◆ CustomInitialization()

override void MoreMountains.Feedbacks.MMF_SetActive.CustomInitialization ( MMF_Player owner )

protectedvirtual

On init we change the state of our object if needed

Parameters

owner

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomPlayFeedback()

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

protectedvirtual

On Play we change the state of our object if needed

Parameters

position
feedbacksIntensity

Implements MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomReset()

override void MoreMountains.Feedbacks.MMF_SetActive.CustomReset ( )

protectedvirtual

On Reset we change the state of our object if needed

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ CustomStopFeedback()

override void MoreMountains.Feedbacks.MMF_SetActive.CustomStopFeedback	(	Vector3	position,
		float	feedbacksIntensity = `1`
	)

protectedvirtual

On Stop we change the state of our object if needed

Parameters

position
feedbacksIntensity

Reimplemented from MoreMountains.Feedbacks.MMF_Feedback.

◆ SetStatus()

virtual void MoreMountains.Feedbacks.MMF_SetActive.SetStatus ( PossibleStates state )

protectedvirtual

Changes the status of the object

Parameters

state

Member Data Documentation

◆ FeedbackTypeAuthorized

bool MoreMountains.Feedbacks.MMF_SetActive.FeedbackTypeAuthorized = true

static

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

◆ SetStateOnInit

bool MoreMountains.Feedbacks.MMF_SetActive.SetStateOnInit = false

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

◆ SetStateOnPlay

bool MoreMountains.Feedbacks.MMF_SetActive.SetStateOnPlay = false

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

◆ SetStateOnReset

bool MoreMountains.Feedbacks.MMF_SetActive.SetStateOnReset = false

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

◆ SetStateOnStop

bool MoreMountains.Feedbacks.MMF_SetActive.SetStateOnStop = false

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

◆ StateOnInit

PossibleStates MoreMountains.Feedbacks.MMF_SetActive.StateOnInit = PossibleStates.Inactive

how to change the state on init

◆ StateOnPlay

PossibleStates MoreMountains.Feedbacks.MMF_SetActive.StateOnPlay = PossibleStates.Inactive

how to change the state on play

◆ StateOnReset

PossibleStates MoreMountains.Feedbacks.MMF_SetActive.StateOnReset = PossibleStates.Inactive

how to change the state on reset

◆ StateOnStop

PossibleStates MoreMountains.Feedbacks.MMF_SetActive.StateOnStop = PossibleStates.Inactive

how to change the state on stop

◆ TargetGameObject

GameObject MoreMountains.Feedbacks.MMF_SetActive.TargetGameObject

the gameobject we want to change the active state of

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

Assets/InfiniteRunnerEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Feedbacks/MMF_SetActive.cs

Public Types

Public Attributes

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

◆ PossibleStates

Member Function Documentation

◆ CustomInitialization()

◆ CustomPlayFeedback()

◆ CustomReset()

◆ CustomStopFeedback()

◆ SetStatus()

Member Data Documentation

◆ FeedbackTypeAuthorized

◆ SetStateOnInit

◆ SetStateOnPlay

◆ SetStateOnReset

◆ SetStateOnStop

◆ StateOnInit

◆ StateOnPlay

◆ StateOnReset

◆ StateOnStop

◆ TargetGameObject