Documentation

Unity Engine


User Manual

Script Reference

Unity Engine


GetCellCenterLocal(Vector3Int)

Get the logical center coordinate of a grid cell in local space.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.GridModule
public Vector3 GetCellCenterLocal(Vector3Int position)

Parameters

position

Grid cell position.

Returns

Type

Description

Vector3Center of the cell transformed into local space coordinates.

Remarks

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.

Examples

// Snap the GameObject to parent Grid center of cellusing UnityEngine;public class ExampleClass : MonoBehaviour{ void Start() { Grid grid = transform.parent.GetComponent<Grid>(); Vector3Int cellPosition = grid.LocalToCell(transform.localPosition); transform.localPosition = grid.GetCellCenterLocal(cellPosition); }}