Photon Fusion 2.0.3

Public Member Functions | Public Attributes | Protected Member Functions | List of all members
SphereOverlapQuery Class Reference

Class that represents a sphere overlap query. Used to query against the NetworkRunner.LagCompensation API. More...

Inherits Query.

Public Member Functions

 SphereOverlapQuery (ref SphereOverlapQueryParams sphereOverlapParams)
 Create a new SphereOverlapQuery with the given SphereOverlapQueryParams. More...
 
 SphereOverlapQuery (ref SphereOverlapQueryParams sphereOverlapParams, Collider[] physXOverlapHitsCache, Collider2D[] box2DOverlapHitsCache)
 Create a new SphereOverlapQuery with the given SphereOverlapQueryParams. More...
 

Public Attributes

Vector3 Center
 Represents the center of the sphere for the overlap query. More...
 
float Radius
 Represents the radius of the sphere for the overlap query. More...
 
- Public Attributes inherited from Query
float? Alpha
 Represents the interpolation factor between the current and next simulation tick. More...
 
LayerMask LayerMask
 Represents the layer mask to selectively ignore colliders when performing the query. More...
 
HitOptions Options
 Represents the options for the hit detection of the query. More...
 
PlayerRef Player
 Represents the player who initiated the query. More...
 
PreProcessingDelegate PreProcessingDelegate
 Represents the delegate to be called for pre-processing before the query is performed. More...
 
int? Tick
 Represents the simulation tick at which the query was initiated. More...
 
int? TickTo
 Represents the simulation tick to which the query is performed. More...
 
QueryTriggerInteraction TriggerInteraction
 Represents the interaction type of the query with triggers. More...
 
void * UserArgs
 Represents the user arguments for the query. More...
 

Protected Member Functions

override bool Check (ref AABB bounds)
 Check if the given AABB intersects with the sphere overlap query. More...
 
- Protected Member Functions inherited from Query
 Query (ref QueryParams qParams)
 Initializes a new instance of the Query class using the provided QueryParams. More...
 

Detailed Description

Class that represents a sphere overlap query. Used to query against the NetworkRunner.LagCompensation API.

Constructor & Destructor Documentation

◆ SphereOverlapQuery() [1/2]

SphereOverlapQuery ( ref SphereOverlapQueryParams  sphereOverlapParams)

Create a new SphereOverlapQuery with the given SphereOverlapQueryParams.

Parameters
sphereOverlapParamsThe parameters to be used when creating the query.

◆ SphereOverlapQuery() [2/2]

SphereOverlapQuery ( ref SphereOverlapQueryParams  sphereOverlapParams,
Collider[]  physXOverlapHitsCache,
Collider2D[]  box2DOverlapHitsCache 
)

Create a new SphereOverlapQuery with the given SphereOverlapQueryParams.

Parameters
sphereOverlapParamsThe parameters to be used when creating the query.
physXOverlapHitsCacheArray to write the results of the PhysX query if used.
box2DOverlapHitsCacheArray to write the results of the Box2D query if used.

Member Function Documentation

◆ Check()

override bool Check ( ref AABB  bounds)
protectedvirtual

Check if the given AABB intersects with the sphere overlap query.

Parameters
boundsThe bounds to check against.
Returns
True if the bounds intersects with the sphere overlap query, false otherwise.

Implements Query.

Member Data Documentation

◆ Center

Vector3 Center

Represents the center of the sphere for the overlap query.

◆ Radius

float Radius

Represents the radius of the sphere for the overlap query.