Struct RaycastResult
A hit result from a BaseRaycaster.
Namespace: UnityEngine.EventSystems
Syntax
public struct RaycastResultFields
depth
Used by raycasters where elements may have the same unit distance, but have specific ordering.
Declaration
public int depthField Value
| Type | Description |
|---|---|
| Int32 |
displayIndex
The display index from which the raycast was generated.
Declaration
public int displayIndexField Value
| Type | Description |
|---|---|
| Int32 |
distance
Distance to the hit.
Declaration
public float distanceField Value
| Type | Description |
|---|---|
| Single |
index
Hit index
Declaration
public float indexField Value
| Type | Description |
|---|---|
| Single |
module
BaseRaycaster that raised the hit.
Declaration
public BaseRaycaster moduleField Value
| Type | Description |
|---|---|
| BaseRaycaster |
screenPosition
The screen position from which the raycast was generated.
Declaration
public Vector2 screenPositionField Value
| Type | Description |
|---|---|
| Vector2 |
sortingLayer
The SortingLayer of the hit object.
Declaration
public int sortingLayerField Value
| Type | Description |
|---|---|
| Int32 |
Remarks
For UI.Graphic elements this will be the values from that graphic's Canvas For 3D objects this will always be 0. For 2D objects if a 2D Renderer (Sprite, Tilemap, SpriteShape) is attached to the same object as the hit collider that sortingLayerID will be used.
sortingOrder
The SortingOrder for the hit object.
Declaration
public int sortingOrderField Value
| Type | Description |
|---|---|
| Int32 |
Remarks
For Graphic elements this will be the values from that graphics Canvas For 3D objects this will always be 0. For 2D objects if a 2D Renderer (Sprite, Tilemap, SpriteShape) is attached to the same object as the hit collider that sortingOrder will be used.
worldNormal
The normal at the hit location of the raycast.
Declaration
public Vector3 worldNormalField Value
| Type | Description |
|---|---|
| Vector3 |
worldPosition
The world position of the where the raycast has hit.
Declaration
public Vector3 worldPositionField Value
| Type | Description |
|---|---|
| Vector3 |
Properties
gameObject
The GameObject that was hit by the raycast.
Declaration
public GameObject gameObject { get; set; }Property Value
| Type | Description |
|---|---|
| GameObject |
isValid
Is there an associated module and a hit GameObject.
Declaration
public bool isValid { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
Clear()
Reset the result.
Declaration
public void Clear()ToString()
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String |