Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


Clamp01(float)

Clamps value between 0 and 1 and returns value.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public static float Clamp01(float value)

Parameters

value

Returns

Type

Description

float

Remarks

If the value is negative then zero is returned. If value is greater than one then one is returned.

Examples

using UnityEngine;public class Example : MonoBehaviour{ // Set the position of the transform to be that of the time // but never less than 0 or more than 1 void Update() { transform.position = new Vector3(Mathf.Clamp01(Time.time), 0, 0); }}
using System.Collections;using System.Collections.Generic;using UnityEngine;// Print a random number every second. This number is chosen over a// range from startValue to endValue. The random number is clamped// to between zero and one by Clamp01().public class ExampleScript : MonoBehaviour{ public float startValue = -0.5f; public float endValue = 1.5f; private float timeCount = 0.0f; void FixedUpdate() { timeCount += Time.deltaTime; if (timeCount > 1.0f) { float result = Random.value; result = result * (endValue - startValue); result = result + startValue; float clampValue = Mathf.Clamp01(result); Debug.Log("value: " + result.ToString("F3") + " result: " + clampValue.ToString("F3")); timeCount = 0.0f; } }}