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.
CloseFor 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| from | The ray start position in world space. |
| direction | The vector in world space defining the direction and length of the ray. The magnitude of this vector determines the length of the drawn ray. |
| r | A Ray struct that contains the origin and direction of the ray to draw. |
Draws a ray starting at a specified position from and extending in a given direction in the Scene view.
DrawRay is a method used for visual debugging in the Unity Editor. DrawRay renders a line segment in the Scene view. DrawRay is useful for visualizing raycasts, directions, or vectors in your scene.
The line is drawn using the current Gizmos color, which can be set using Gizmos.color before calling DrawRay.
The line is drawn using the current Gizmos matrix, which can be set using Gizmos.matrix before calling DrawRay.
Typically, you'd use this method within MonoBehaviour.OnDrawGizmos or MonoBehaviour.OnDrawGizmosSelected functions in your MonoBehaviour scripts, or within a method with the DrawGizmo attribute. Like all Gizmos, it's an Editor-only tool and should not be used for game functionality. This method has no effect in the GameView or at runtime. If you want to draw similar shapes at runtime refer to Debug.DrawLine.
The line segment respects the 3D space and perspective of the scene, including depth and occlusion by other objects. It also respects the alpha channel of the Gizmos color, allowing for semi-transparent lines as well as the transformation of Gizmos.matrix.
using UnityEngine;
public class RayGizmoExample : MonoBehaviour { public Vector3 direction = Vector3.forward; public float length = 5f; [Range(0f, 1f)] public float alpha = 0.75f;
private void OnDrawGizmos() { // Set the color with custom alpha. Gizmos.color = new Color(0f, 1f, 0f, alpha); // Green with custom alpha
// Draw the ray. Gizmos.DrawRay(transform.position, direction.normalized * length);
// Draw a sphere at the end of the ray. Gizmos.DrawSphere(transform.position + direction.normalized * length, 0.1f); } }
Additional resources: MonoBehaviour.OnDrawGizmos, MonoBehaviour.OnDrawGizmosSelected, DrawGizmo, Gizmos.color, Gizmos.matrix.
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.