Legacy Documentation: Version 2018.1 (Go to current version)
LanguageEnglish
  • C#
  • JS

Script language

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

Transform.localPosition

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 var localPosition: Vector3;
public Vector3 localPosition;

Description

Position of the transform relative to the parent transform.

If the transform has no parent, it is the same as Transform.position.

// Move the object to the same position as the parent:
transform.localPosition = Vector3(0, 0, 0);

// Get the y component of the position relative to the parent // and print it to the Console print(transform.localPosition.y);
using UnityEngine;
using System.Collections;

public class ExampleClass : MonoBehaviour { void Example() { // Move the object to the same position as the parent: transform.localPosition = new Vector3(0, 0, 0);

// Get the y component of the position relative to the parent // and print it to the Console print(transform.localPosition.y); } }

Note that the parent transform's world rotation and scale are applied to the local position when calculating the world position. This means that while 1 unit in Transform.position is always 1 unit, 1 unit in Transform.localPosition will get scaled by the scale of all ancestors.

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