Legacy Documentation: Version 4.5.0

Script language:

  • JS
  • C#
  • Boo
Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

Mathf.Repeat

static function Repeat(t: float, length: float): float;
static float Repeat(float t, float length);
static def Repeat(t as float, length as float) as float

Description

Loops the value t, so that it is never larger than length and never smaller than 0.

This is similar to the modulo operator but it works with floating point numbers. For example, using 3.0 for t and 2.5 for length, the result would be 0.5. With t = 5 and length = 2.5, the result would be 0.0. Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator.

	function Update () {
		// Set the x position to loop between 0 and 3
		transform.position = Vector3(
				     Mathf.Repeat(Time.time, 3), transform.position.y, transform.position.z);
	}
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour {
    void Update() {
        transform.position = new Vector3(Mathf.Repeat(Time.time, 3), transform.position.y, transform.position.z);
    }
}
import UnityEngine
import System.Collections

public class ExampleClass(MonoBehaviour):

	def Update() as void:
		transform.position = Vector3(Mathf.Repeat(Time.time, 3), transform.position.y, transform.position.z)