Class ModSliderOption.SliderValue

Namespace

Nautilus.Options

Assembly

Nautilus.dll

Component for customizing slider's value behaviour. If you need more complex behaviour than just custom value format then you can inherit this component and add it to "Slider" game object in OnGameObjectCreated event (see AddToPanel(uGUI_TabbedControlsPanel, int) for details on adding component) You can override value converters ConvertToDisplayValue(float) and ConvertToSliderValue(float), in that case internal range for slider will be changed to [0.0f : 1.0f] and you can control displayed value with these converters (also this value will be passed to OnChange<T, E>(string, T) event)

public class ModSliderOption.SliderValue : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

ModSliderOption.SliderValue

Inherited Members

MonoBehaviour.IsInvoking()

MonoBehaviour.CancelInvoke()

MonoBehaviour.Invoke(string, float)

MonoBehaviour.InvokeRepeating(string, float, float)

MonoBehaviour.CancelInvoke(string)

MonoBehaviour.IsInvoking(string)

MonoBehaviour.StartCoroutine(string)

MonoBehaviour.StartCoroutine(string, object)

MonoBehaviour.StartCoroutine(IEnumerator)

MonoBehaviour.StartCoroutine_Auto(IEnumerator)

MonoBehaviour.StopCoroutine(IEnumerator)

MonoBehaviour.StopCoroutine(Coroutine)

MonoBehaviour.StopCoroutine(string)

MonoBehaviour.StopAllCoroutines()

MonoBehaviour.print(object)

MonoBehaviour.Internal_CancelInvokeAll(MonoBehaviour)

MonoBehaviour.Internal_IsInvokingAll(MonoBehaviour)

MonoBehaviour.InvokeDelayed(MonoBehaviour, string, float, float)

MonoBehaviour.CancelInvoke(MonoBehaviour, string)

MonoBehaviour.IsInvoking(MonoBehaviour, string)

MonoBehaviour.IsObjectMonoBehaviour(Object)

MonoBehaviour.StartCoroutineManaged(string, object)

MonoBehaviour.StartCoroutineManaged2(IEnumerator)

MonoBehaviour.StopCoroutineManaged(Coroutine)

MonoBehaviour.StopCoroutineFromEnumeratorManaged(IEnumerator)

MonoBehaviour.GetScriptClassName()

MonoBehaviour.useGUILayout

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.GetComponent(Type)

Component.GetComponentFastPath(Type, IntPtr)

Component.GetComponent<T>()

Component.TryGetComponent(Type, out Component)

Component.TryGetComponent<T>(out T)

Component.GetComponent(string)

Component.GetComponentInChildren(Type, bool)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(bool)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, bool)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(bool)

Component.GetComponentsInChildren<T>(bool, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, bool)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(bool)

Component.GetComponentsInParent<T>(bool, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponentsForListInternal(Type, object)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.GetComponents<T>()

Component.CompareTag(string)

Component.SendMessageUpwards(string, object, SendMessageOptions)

Component.SendMessageUpwards(string, object)

Component.SendMessageUpwards(string)

Component.SendMessageUpwards(string, SendMessageOptions)

Component.SendMessage(string, object)

Component.SendMessage(string)

Component.SendMessage(string, object, SendMessageOptions)

Component.SendMessage(string, SendMessageOptions)

Component.BroadcastMessage(string, object, SendMessageOptions)

Component.BroadcastMessage(string, object)

Component.BroadcastMessage(string)

Component.BroadcastMessage(string, SendMessageOptions)

Component.transform

Component.gameObject

Component.tag

Object.m_CachedPtr

Object.OffsetOfInstanceIDInCPlusPlusObject

Object.objectIsNullMessage

Object.cloneDestroyedMessage

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(object)

Object.CompareBaseObjects(Object, Object)

Object.EnsureRunningOnMainThread()

Object.IsNativeObjectAlive(Object)

Object.GetCachedPtr()

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, bool)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, bool)

Object.Destroy(Object, float)

Object.Destroy(Object)

Object.DestroyImmediate(Object, bool)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.DestroyObject(Object, float)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.CheckNullArgument(object, string)

Object.FindObjectOfType(Type)

Object.ToString()

Object.GetOffsetOfInstanceIDInCPlusPlusObject()

Object.CurrentThreadIsMainThread()

Object.Internal_CloneSingle(Object)

Object.Internal_CloneSingleWithParent(Object, Transform, bool)

Object.Internal_InstantiateSingle(Object, Vector3, Quaternion)

Object.Internal_InstantiateSingleWithParent(Object, Transform, Vector3, Quaternion)

Object.ToString(Object)

Object.GetName(Object)

Object.IsPersistent(Object)

Object.SetName(Object, string)

Object.DoesObjectWithInstanceIDExist(int)

Object.FindObjectFromInstanceID(int)

Object.ForceLoadFromInstanceID(int)

Object.Internal_InstantiateSingle_Injected(Object, ref Vector3, ref Quaternion)

Object.Internal_InstantiateSingleWithParent_Injected(Object, Transform, ref Vector3, ref Quaternion)

Object.name

Object.hideFlags

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetType()

object.MemberwiseClone()

Extension Methods

GameObjectExtensions.CopyComponent<TSelfComponent, TCopiedComponent>(TSelfComponent, TCopiedComponent)

GameObjectExtensions.Exists<T>(T)

JsonExtensions.LoadJson<T>(T, string, bool, params JsonConverter[])

JsonExtensions.SaveJson<T>(T, string, params JsonConverter[])

ReflectionHelper.CopyFields<T>(T, T, BindingFlags)

ReflectionHelper.GetInstanceField<T>(T, string, BindingFlags)

ReflectionHelper.GetInstanceMethod<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticField<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticMethod<T>(T, string, BindingFlags)

ReflectionHelper.SetInstanceField<T>(T, string, object, BindingFlags)

ReflectionHelper.SetStaticField<T>(T, string, object, BindingFlags)

Fields

label

The value label of the ModSliderOption.SliderValue

protected TextMeshProUGUI label

Field Value

TextMeshProUGUI

maxValue

The maximum value of the ModSliderOption.SliderValue. In case of custom value converters it can be not equal to internal maximum value for slider

protected float maxValue

Field Value

float

minValue

The minimum value of the ModSliderOption.SliderValue. In case of custom value converters it can be not equal to internal minimum value for slider

protected float minValue

Field Value

float

slider

The slider controlling this ModSliderOption.SliderValue

protected Slider slider

Field Value

Slider

valueFormat

Custom value format

protected string valueFormat

Field Value

string

Properties

ValueFormat

Custom value format property. Set it right after adding component to game object for proper behaviour

public string ValueFormat { get; set; }

Property Value

string

ValueWidth

Width for value text field. Used by ModSliderOption.SliderOptionAdjust to adjust label width. It is calculated in UpdateValueWidth(), but you can override this property.

public virtual float ValueWidth { get; protected set; }

Property Value

float

Methods

Awake()

Component initialization. If you overriding this, make sure that you calling base.Awake()

protected virtual void Awake()

ConvertToDisplayValue(float)

Converts internal slider value [0.0f : 1.0f] to displayed value

public virtual float ConvertToDisplayValue(float sliderValue)

Parameters

sliderValue float

Returns

float

ConvertToSliderValue(float)

Converts displayed value to internal slider value [0.0f : 1.0f]

public virtual float ConvertToSliderValue(float displayValue)

Parameters

displayValue float

Returns

float

InitConverters()

Override this if you need to initialize custom value converters

protected virtual void InitConverters()

OnValueChanged(float)

Called when user changes slider value

protected virtual void OnValueChanged(float value)

Parameters

value float

Start()

UnityEngine.MonoBehaviour.Start()

protected virtual IEnumerator Start()

Returns

IEnumerator

UpdateLabel()

Updates label's text with formatted and converted slider's value. Override this if you need even more control on slider's value behaviour.

protected virtual void UpdateLabel()

UpdateValueWidth()

Method for calculating necessary label's width. Creates temporary label and compares widths of min and max values, then sets ValueWidth to the wider. Be aware that in case of using custom converters some intermediate value may be wider than min/max values.

protected virtual IEnumerator UpdateValueWidth()

Returns

IEnumerator