Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

DrawLine(Vector2, Vector2, Color, float)

Draw a Line.
Read time 1 minuteLast updated 13 days ago

Definition

  • Type: Method
  • Namespace: Unity.U2D.Physics
  • Assembly: UnityEngine.PhysicsCore2DModule
public void DrawLine(Vector2 point0, Vector2 point1, Color color, float lifetime = 0)

Parameters

point0

Vector2
The start of the line.

point1

Vector2
The end of the line.

color

Color
The color to draw with.

lifetime

float
How long the element should be drawn for, in seconds. The default is zero indicating that it should only be drawn once. Lifetime is only used when the world is playing.

Remarks

Use this method, and the other 
Draw
methods of PhysicsWorld, to draw your own debug shapes. A drawn shape only lasts for one frame unless you set 
lifetime
to keep it visible for longer.
Additional Resources: PhysicsWorld.DrawCircle, PhysicsWorld.DrawPoint

Examples

// Get the main physics world.using UnityEngine;using Unity.U2D.Physics;public class DrawDebugShapesExample : MonoBehaviour{    void Update()    {        PhysicsWorld world = PhysicsWorld.defaultWorld;        // Draw a line from the origin to (30, 40) in "cornflower blue".        world.DrawLine(Vector2.zero, new Vector2(30f, 40f), Color.cornflowerBlue);        // Draw a circle from the origin to (30, 40) in "forest green".        world.DrawCircle(new Vector2(30f, 40f), 2f, Color.forestGreen);        // Draw a point with a 3 pixel radius at (-5, 10) in "gold".        world.DrawPoint(new Vector2(-5f, 10f), 3f, Color.gold);        // Draw a circle for 5 seconds instead of a single frame.        const float lifeTime = 5f;        world.DrawGeometry(new CircleGeometry { radius = 2f }, PhysicsTransform.identity, Color.cornflowerBlue, lifeTime);    }}