Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

implicit operator bool(RaycastHit2D)

Implicit operator used to return a true or false result indicating if the result is valid or not.
Read time 1 minuteLast updated 4 days ago

Definition

  • Type: Operator
  • Namespace: UnityEngine
  • Assembly: UnityEngine.Physics2DModule

implicit operator bool(Boolea)

public static implicit operator bool(RaycastHit2D hit)

Parameters

hit

RaycastHit2D
The RaycastHit2D to being checked for valid results.

Returns

Type

Description

bool

Remarks

When using any physics query that returns a RaycastHit2D, you should always first check to see if it contains a valid result which indicates a hit (intersection) was detected. You can do this by checking if the RaycastHit2D is 
true
or 
false
.
NOTE: A valid result is indicated by the field Collider referring to a valid Collider2D i.e. not being NULL. This operator is therefore equivalent to checking if that field is NULL ( 
false
) or not NULL ( 
true
).

Examples

using UnityEngine;public class ExampleClass : MonoBehaviour{    public Vector2 direction;    void Update()    {        // Cast a ray in the direction specified in the inspector.        RaycastHit2D hit = Physics2D.Raycast(transform.position, direction);        // If something was hit, draw a line from the start position to the point we intersected.        if (hit)            Debug.DrawLine(transform.position, hit.point, Color.yellow);    }}