Grid.GetCellCenterLocal

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

Switch to Manual
public Vector3 GetCellCenterLocal(Vector3Int position);

Parameters

positionGrid cell position.

Returns

Vector3 Center of the cell transformed into local space coordinates.

Description

Get the logical center coordinate of a grid cell in local space.

In a rectangular grid layout, a call to GridLayout.CellToLocal with Vector3Int parameter, returns a Vector3 coordinate that represents the bottom-left of the cell. This is mathematically correct, but when for example instantiating a GameObject into the grid, you often prefer the center of the cell instead.

// Snap the GameObject to parent Grid center of cell
using UnityEngine;

public class ExampleClass : MonoBehaviour { void Start() { Grid grid = transform.parent.GetComponent<Grid>(); Vector3Int cellPosition = grid.LocalToCell(transform.localPosition); transform.localPosition = grid.GetCellCenterLocal(cellPosition); } }

Did you find this page useful? Please give it a rating: