Version: 5.5 (switch to 5.6b)
LanguageEnglish
  • C#
  • JS

Script language

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

Handles.SnapValue

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

public static function SnapValue(val: float, snap: float): float;
public static float SnapValue(float val, float snap);

Parameters

val The argument to be modified and its value returned.
snap The destination amount.

Returns

float The rounded value, if snap is positive, and val otherwise.

Description

Rounds the value val to the closest multiple of snap (snap can only be positive).