Phaser API Documentation

  Version: 

Member of: Phaser.Math.Snap

<static> To(value, gap, [start], [divide])

Description:

Snap a value to nearest grid slice, using rounding.

Example: if you have an interval gap of 5 and a position of 12... you will snap to 10 whereas 14 will snap to 15.

Parameters:

name type arguments Default description
value number

The value to snap.

gap number

The interval gap of the grid.

start number <optional> 0

Optional starting offset for gap.

divide boolean <optional> false

If true it will divide the snapped value by the gap before returning.

Returns:
Description:

The snapped value.

Type:
  • number
Examples:
Since: 3.0.0
Source: src/math/snap/SnapTo.js (Line 7)