CollisionObjectQueryParams

Overview

CollisionObjectQueryParams is a configuration object that defines the conditions needed when performing object type-based collision queries in the world.

Constructors

new

Creates a new CollisionObjectQueryParams instance.

Parameters

Return

CollisionObjectQueryParams	The created CollisionObjectQueryParams.

Code Samples

Properties

IgnoreMask

number

Specifies the object types to exclude from the query as a bitmask.

Code Samples

ObjectTypesToQuery

number

Specifies the object types to include in the query as a bitmask.

Code Samples

Methods

AddObjectTypesToQuery

Adds multiple object types to the query targets at once.

Parameters

Value InValue	The object type value to add.

Return

boolean	Whether the addition was successful.

Code Samples

AddObjectTypeToQuery

Adds a single object type to the query targets.

Parameters

Enum.CollisionChannel QueryChannel	The collision channel to add as a query target.

Return

boolean	Whether the addition was successful.

Code Samples

ResetObjectTypes

Clears all object types from the query targets. After this call, the ObjectTypesToQuery bitmask becomes 0, so no object types will be queried; you must re-add the desired channels using AddObjectTypeToQuery or AddObjectTypesToQuery afterwards.

Parameters

Return

void

Code Samples

ResetObjectTypesAsAllObjects

Resets the query targets to all objects.

Parameters

Return

void

Code Samples

Events