Skip to content

YaQueryParameter

YaQueryParameter manages parameters for physics queries.

Functions

YaQueryParameter YaQueryParameter.Instance()

ReturnsQuery Parameter
Creates the object to query parameters for.

YaQueryParameter QueryPhysicsLayer(number layer)

ReturnsSelf
Returns the physics layer to query.
  • layer 1..31

YaQueryParameter QueryAllPhysicsLayer()

ReturnsSelf
Queries all layers in the scene.

YaQueryParameter IgnorePhysicsLayer(number layer)

ReturnsSelf
Ignores a specified physics layer. Call QueryAllPhysicsLayer to find all physics layers.
  • layer 1..31

YaQueryParameter QueryTrigger(boolean enable)

ReturnsSelf
Enables the query of trigger boxes. default false
  • enable True if querying Trigger objects

YaQueryParameter QueryDisableCollide(boolean enable)

ReturnsSelf
Enables the query of DisableCollide entity.
  • enable True if querying disable collide Entity

YaQueryParameter GeometrySphere(number radius)

ReturnsSelf
Defines the sphere space in which parameters are queried. This API only works for PhysicsAPI.Overlap.
  • radius Radius

YaQueryParameter GeometryBox(float3 size)

ReturnsSelf
Defines the box space in which parameters are queried. This API only works for PhysicsAPI.Overlap.
  • size box size

YaQueryParameter GeometryCapsule(number radius, number height)

ReturnsSelf
Defines the capsule space in which parameters are queried. This function only works for PhysicsAPI.Overlap.
  • radius Radius
  • height Height

YaQueryParameter GeometrySector180(number radius, number height)

ReturnsSelf
Queries in a half cylinder area. This function only works for PhysicsAPI.Overlap.
  • radius Radius
  • height Height

YaQueryParameter GeometryDirection(float3 direction)

ReturnsSelf
Queries the direction of the geometric shape, except for GeometryCapsule and GeometrySphere. This function only works for PhysicsAPI.Overlap.
  • direction Direction

YaQueryParameter GeometryRotation(float3 euler)

ReturnsSelf
Queries the rotation of the geometric shape. This function only works for PhysicsAPI.Overlap.
  • euler Rotation

YaQueryParameter GeometryOffset(float3 offset)

ReturnsSelf
Queries the offset of the geometric shape. This function only works for PhysicsAPI.Overlap.
  • offset Offset

YaQueryParameter IgnoreEntity(YaEntity entity)

ReturnsSelf
Adds an entity to ignore in the query. You can ignore more than one entities by calling this funtion multiple times.
  • entity Entity

YaQueryParameter IgnoreEntityAndChildren(YaEntity entity)

ReturnsSelf
Adds entity and its child entities recursively to ignore in the query.
  • entity Root entity

YaQueryParameter IgnoreDead(boolean enable)

ReturnsSelf
Ignores the dead. This API only works for PhysicsAPI.Overlap.
  • enable True if ignore dead entity. Default false.

YaQueryParameter Nearest(boolean enable)

ReturnsSelf
Queries the nearest object. This API only works for PhysicsAPI.Overlap.
  • enable True if queries the nearest object. Default false