Version: Unity 6.1 Alpha (6000.1)
LanguageEnglish
  • C#

Rigidbody2D.linearVelocityX

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 float linearVelocityX;

Description

The X component of the linear velocity of the Rigidbody2D in world-units per second.

The linear velocity is specified as a Vector2 with components in the X and Y directions (there is no Z direction in 2D physics).

This property lets you read and write only the X component of the Rigidbody2D.linearVelocity without affecting the Y component of the Rigidbody2D.linearVelocity. This is convenient when dealing with X and Y directions in isolation.

Additional resources: Rigidbody2D.linearVelocity and Rigidbody2D.linearVelocityY.

using UnityEngine;

// Ensure that the maximum horizontal speed moving right isn't larger than the configurable value. public class Example : MonoBehaviour { public float MaximumSpeedRight = 2f;

private Rigidbody2D rb;

void Start() { rb = GetComponent<Rigidbody2D>(); }

void FixedUpdate() { // Clamp the horizontal speed. if (rb.linearVelocityX > MaximumSpeedRight) { rb.linearVelocityX = MaximumSpeedRight; } } }