Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

DrawRay(Vector3, Vector3, Color, float, bool)

Draws a line from start to start + dir in world coordinates.
Read time 1 minuteLast updated 5 days ago

Definition

  • Type: Method
  • Namespace: UnityEngine
  • Assembly: UnityEngine.CoreModule
public static void DrawRay(Vector3 start, Vector3 dir, Color color, float duration, bool depthTest)

Parameters

start

Vector3
Point in world space where the ray should start.

dir

Vector3
Direction and length of the ray.

color

Color
Color of the drawn line.

duration

float
How long the line will be visible for (in seconds).

depthTest

bool
Determines whether objects closer to the camera obscure the line.

Remarks

The 
duration
parameter determines how long the line will be visible after the frame it is drawn. If duration is 0 (the default) then the line is rendered 1 frame.
If 
depthTest
is set to true then the line will be obscured by other objects in the Scene that are nearer to the camera.
The line will be drawn in the Scene view of the editor. If gizmo drawing is enabled in the game view, the line will also be drawn there.

Examples

using UnityEngine;public class Example : MonoBehaviour{    // Frame update example: Draws a 10 meter long green line from the position for 1 frame.    void Update()    {        Vector3 forward = transform.TransformDirection(Vector3.forward) * 10;        Debug.DrawRay(transform.position, forward, Color.green);    }}
using UnityEngine;public class Example : MonoBehaviour{    // Event callback example: Debug-draw all contact points and normals for 2 seconds.    void OnCollisionEnter(Collision collision)    {        Debug.DrawRay(collision.contacts[0].point, collision.contacts[0].normal, Color.green, 2, false);    }}