Highroad Engine v1.3
Public Types | Public Member Functions | Public Attributes | Protected Member Functions | Protected Attributes | List of all members
MoreMountains.Tools.MMDebugMenuItemSlider Class Reference

A class used to bind a slider to a MMDebugMenu More...

Inheritance diagram for MoreMountains.Tools.MMDebugMenuItemSlider:

Public Types

enum  Modes { Float , Int }
 the possible modes this slider can operate on More...
 

Public Member Functions

void ValueChangeCheck ()
 Invoked when the slider value changes More...
 
virtual void OnEnable ()
 Starts listening for events More...
 
virtual void OnDestroy ()
 Stops listening for events More...
 

Public Attributes

Modes Mode = Modes.Float
 the selected mode for this slider More...
 
Slider TargetSlider
 the Slider to use to change the value More...
 
Text SliderText
 the text comp used to display the slider's name More...
 
Text SliderValueText
 the text comp used to display the slider's value More...
 
Image SliderKnob
 the target knob More...
 
Image SliderLine
 the line behind the knob More...
 
float RemapZero = 0f
 the value to remap the slider's 0 to More...
 
float RemapOne = 1f
 the value to remap the slider's 1 to More...
 
string SliderEventName = "Checkbox"
 the name of the event bound to this slider More...
 
float SliderValue
 the current slider value More...
 
int SliderValueInt
 the current slider int value More...
 

Protected Member Functions

virtual void Awake ()
 On Awake we start listening for slider changes More...
 
virtual void UpdateValue (float newValue)
 
virtual void TriggerSliderEvent (float value)
 Triggers a slider event More...
 
virtual void OnMMDebugMenuSliderEvent (string sliderEventName, float value, MMDebugMenuSliderEvent.EventModes eventMode)
 When we get a set slider event, we set our value More...
 

Protected Attributes

bool _valueSetThisFrame = false
 
bool _listening = false
 

Detailed Description

A class used to bind a slider to a MMDebugMenu

Member Enumeration Documentation

◆ Modes

the possible modes this slider can operate on

Enumerator
Float 
Int 

Member Function Documentation

◆ Awake()

virtual void MoreMountains.Tools.MMDebugMenuItemSlider.Awake ( )
protectedvirtual

On Awake we start listening for slider changes

◆ OnDestroy()

virtual void MoreMountains.Tools.MMDebugMenuItemSlider.OnDestroy ( )
virtual

Stops listening for events

◆ OnEnable()

virtual void MoreMountains.Tools.MMDebugMenuItemSlider.OnEnable ( )
virtual

Starts listening for events

◆ OnMMDebugMenuSliderEvent()

virtual void MoreMountains.Tools.MMDebugMenuItemSlider.OnMMDebugMenuSliderEvent ( string  sliderEventName,
float  value,
MMDebugMenuSliderEvent.EventModes  eventMode 
)
protectedvirtual

When we get a set slider event, we set our value

Parameters
sliderEventName
value

◆ TriggerSliderEvent()

virtual void MoreMountains.Tools.MMDebugMenuItemSlider.TriggerSliderEvent ( float  value)
protectedvirtual

Triggers a slider event

Parameters
value

◆ UpdateValue()

virtual void MoreMountains.Tools.MMDebugMenuItemSlider.UpdateValue ( float  newValue)
protectedvirtual

◆ ValueChangeCheck()

void MoreMountains.Tools.MMDebugMenuItemSlider.ValueChangeCheck ( )

Invoked when the slider value changes

Member Data Documentation

◆ _listening

bool MoreMountains.Tools.MMDebugMenuItemSlider._listening = false
protected

◆ _valueSetThisFrame

bool MoreMountains.Tools.MMDebugMenuItemSlider._valueSetThisFrame = false
protected

◆ Mode

Modes MoreMountains.Tools.MMDebugMenuItemSlider.Mode = Modes.Float

the selected mode for this slider

◆ RemapOne

float MoreMountains.Tools.MMDebugMenuItemSlider.RemapOne = 1f

the value to remap the slider's 1 to

◆ RemapZero

float MoreMountains.Tools.MMDebugMenuItemSlider.RemapZero = 0f

the value to remap the slider's 0 to

◆ SliderEventName

string MoreMountains.Tools.MMDebugMenuItemSlider.SliderEventName = "Checkbox"

the name of the event bound to this slider

◆ SliderKnob

Image MoreMountains.Tools.MMDebugMenuItemSlider.SliderKnob

the target knob

◆ SliderLine

Image MoreMountains.Tools.MMDebugMenuItemSlider.SliderLine

the line behind the knob

◆ SliderText

Text MoreMountains.Tools.MMDebugMenuItemSlider.SliderText

the text comp used to display the slider's name

◆ SliderValue

float MoreMountains.Tools.MMDebugMenuItemSlider.SliderValue

the current slider value

◆ SliderValueInt

int MoreMountains.Tools.MMDebugMenuItemSlider.SliderValueInt

the current slider int value

◆ SliderValueText

Text MoreMountains.Tools.MMDebugMenuItemSlider.SliderValueText

the text comp used to display the slider's value

◆ TargetSlider

Slider MoreMountains.Tools.MMDebugMenuItemSlider.TargetSlider

the Slider to use to change the value


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