Version: 2023.1
LanguageEnglish
  • C#

SpherecastCommand Constructor

Suggest a change

Success!

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.

Close

Submission failed

For 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

Cancel

Declaration

public SpherecastCommand(Vector3 origin, float radius, Vector3 direction, QueryParameters queryParameters, float distance);

Parameters

origin The starting point of the sphere cast.
radius The radius of the casting sphere.
direction The direction of the sphere cast.
queryParameters Structure for specifying additional parameters for a batch query such as layer mask, hit triggers and hit backfaces.
distance The maximum distance the cast should check for collisions.

Description

Creates a SpherecastCommand.

The command is run in the default physics scene.


Declaration

public SpherecastCommand(PhysicsScene physicsScene, Vector3 origin, float radius, Vector3 direction, QueryParameters queryParameters, float distance);

Parameters

physicsScene The physics scene to run the command in.
origin The starting point of the sphere cast.
radius The radius of the casting sphere.
direction The direction of the sphere cast.
queryParameters Structure for specifying additional parameters for a batch query such as layer mask, hit triggers and hit backfaces.
distance The maximum distance the cast should check for collisions.

Description

Creates a SpherecastCommand.


Obsolete This struct signature is no longer supported. Use struct with a QueryParameters instead.

Declaration

public SpherecastCommand(Vector3 origin, float radius, Vector3 direction, float distance, int layerMask);

Parameters

origin The starting point of the sphere cast.
radius The radius of the casting sphere.
direction The direction of the sphere cast.
distance The maximum distance the cast should check for collisions.
layerMask The LayerMask that selectively ignores Colliders when casting a sphere.

Description

Creates a SpherecastCommand.

The command is run in the default physics scene.


Obsolete This struct signature is no longer supported. Use struct with a QueryParameters instead.

Declaration

public SpherecastCommand(PhysicsScene physicsScene, Vector3 origin, float radius, Vector3 direction, float distance, int layerMask);

Parameters

physicsScene The physics scene to run the command in.
origin The starting point of the sphere cast.
radius The radius of the casting sphere.
direction The direction of the sphere cast.
distance The maximum distance the cast should check for collisions.
layerMask The LayerMask that selectively ignores Colliders when casting a sphere.

Description

Creates a SpherecastCommand.