Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetFloat

Returns the float value corresponding to key if it exists in the preference file.
Read time 2 minutesLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor

GetFloat(string, float)

Returns the float value corresponding to key if it exists in the preference file.
public static float GetFloat(string key, float defaultValue)

Parameters

Name of key to read float from.

defaultValue

Float value to return if the key is not in the storage.

Returns

Type

Description

floatThe float value stored in the preference file or the defaultValue id the requested float does not exist.

Remarks

If GetFloat does not exist in the Preference file the defaultValue will be returned.

Examples

// Simple script that allows a float value to be editted// in a slider. The start value is selected from the Editor Preferences.using UnityEngine;using UnityEditor;using System;public class SetFloatExample : EditorWindow{ static float floatValue = 0.0f; [MenuItem("Examples/Preferences SetFloat Example")] static void Init() { Rect r = new Rect(10, 10, 200, 100); SetFloatExample window = (SetFloatExample)EditorWindow.GetWindowWithRect(typeof(SetFloatExample), r); window.Show(); } void Awake() { floatValue = EditorPrefs.GetFloat("FloatExample", floatValue); } void OnGUI() { floatValue = EditorGUILayout.Slider(floatValue, -1.0f, 1.0f); if (GUILayout.Button("Save float " + Convert.ToString(floatValue) + "?")) { EditorPrefs.SetFloat("FloatExample", floatValue); } if (GUILayout.Button("Close")) this.Close(); }}

GetFloat(string)

Returns the float value corresponding to key if it exists in the preference file.
public static float GetFloat(string key)

Parameters

Name of key to read float from.

Returns

Type

Description

floatThe float value stored in the preference file or the defaultValue id the requested float does not exist.

Remarks

If GetFloat does not exist in the Preference file the defaultValue will be returned.

Examples

// Simple script that allows a float value to be editted// in a slider. The start value is selected from the Editor Preferences.using UnityEngine;using UnityEditor;using System;public class SetFloatExample : EditorWindow{ static float floatValue = 0.0f; [MenuItem("Examples/Preferences SetFloat Example")] static void Init() { Rect r = new Rect(10, 10, 200, 100); SetFloatExample window = (SetFloatExample)EditorWindow.GetWindowWithRect(typeof(SetFloatExample), r); window.Show(); } void Awake() { floatValue = EditorPrefs.GetFloat("FloatExample", floatValue); } void OnGUI() { floatValue = EditorGUILayout.Slider(floatValue, -1.0f, 1.0f); if (GUILayout.Button("Save float " + Convert.ToString(floatValue) + "?")) { EditorPrefs.SetFloat("FloatExample", floatValue); } if (GUILayout.Button("Close")) this.Close(); }}