MoreMountains.Feedbacks.MMInputSequenceRecorder Class Reference

This class lets you record sequences via input presses. More...

Inheritance diagram for MoreMountains.Feedbacks.MMInputSequenceRecorder:

Public Member Functions
virtual void	Initialization ()
	Makes sure we have a scriptable object to record to.
virtual void	StartRecording ()
	Clears the sequence if needed and starts recording.
virtual void	StopRecording ()
	Stops the recording.
virtual void	AddNoteToTrack (MMSequenceTrack track)
	Adds a note to the specified track.

Public Attributes
MMSequence	SequenceScriptableObject
	the target scriptable object to write to
bool	Recording
	whether this recorder is recording right now or not
bool	RemoveInitialSilence = true
	whether any silence between the start of the recording and the first press should be removed or not
bool	AdditiveRecording = false
	whether this recording should write on top of existing entries or not
bool	StartRecordingOnGameStart = false
	whether this recorder should start recording when entering play mode
float	RecordingStartOffset = 0f
	the offset to apply to entries
KeyCode	StartRecordingHotkey = KeyCode.Home
	the key binding for recording start
KeyCode	StopRecordingHotkey = KeyCode.End
	the key binding for recording stop

Protected Member Functions
virtual void	Awake ()
	On awake we initialize our recorder.
virtual void	Start ()
	On Start, starts a recording if needed.
virtual void	Update ()
	On update we look for key presses.
virtual void	DetectStartAndEnd ()
	Detects key presses for start and end recording actions.
virtual void	DetectRecording ()
	Look for key presses to write to the sequence.

Protected Attributes
MMSequenceNote	_note
float	_recordingStartedAt = 0f

Detailed Description

This class lets you record sequences via input presses.

Member Function Documentation

AddNoteToTrack()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.AddNoteToTrack ( MMSequenceTrack track )

virtual

Adds a note to the specified track.

Parameters

track

Awake()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.Awake ( )

protectedvirtual

On awake we initialize our recorder.

DetectRecording()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.DetectRecording ( )

protectedvirtual

Look for key presses to write to the sequence.

DetectStartAndEnd()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.DetectStartAndEnd ( )

protectedvirtual

Detects key presses for start and end recording actions.

Initialization()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.Initialization ( )

virtual

Makes sure we have a scriptable object to record to.

Start()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.Start ( )

protectedvirtual

On Start, starts a recording if needed.

StartRecording()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.StartRecording ( )

virtual

Clears the sequence if needed and starts recording.

StopRecording()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.StopRecording ( )

virtual

Stops the recording.

Update()

virtual void MoreMountains.Feedbacks.MMInputSequenceRecorder.Update ( )

protectedvirtual

On update we look for key presses.

Member Data Documentation

_note

MMSequenceNote MoreMountains.Feedbacks.MMInputSequenceRecorder._note

protected

_recordingStartedAt

float MoreMountains.Feedbacks.MMInputSequenceRecorder._recordingStartedAt = 0f

protected

AdditiveRecording

bool MoreMountains.Feedbacks.MMInputSequenceRecorder.AdditiveRecording = false

whether this recording should write on top of existing entries or not

Recording

bool MoreMountains.Feedbacks.MMInputSequenceRecorder.Recording

whether this recorder is recording right now or not

RecordingStartOffset

float MoreMountains.Feedbacks.MMInputSequenceRecorder.RecordingStartOffset = 0f

the offset to apply to entries

RemoveInitialSilence

bool MoreMountains.Feedbacks.MMInputSequenceRecorder.RemoveInitialSilence = true

whether any silence between the start of the recording and the first press should be removed or not

SequenceScriptableObject

MMSequence MoreMountains.Feedbacks.MMInputSequenceRecorder.SequenceScriptableObject

the target scriptable object to write to

StartRecordingHotkey

KeyCode MoreMountains.Feedbacks.MMInputSequenceRecorder.StartRecordingHotkey = KeyCode.Home

the key binding for recording start

StartRecordingOnGameStart

bool MoreMountains.Feedbacks.MMInputSequenceRecorder.StartRecordingOnGameStart = false

whether this recorder should start recording when entering play mode

StopRecordingHotkey

KeyCode MoreMountains.Feedbacks.MMInputSequenceRecorder.StopRecordingHotkey = KeyCode.End

the key binding for recording stop

---

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

• H:/Code/MoreMountains/topdownengine/Assets/TopDownEngine/ThirdParty/MoreMountains/MMFeedbacks/MMFeedbacks/Sequencing/Scripts/MMInputSequenceRecorder.cs