PhysicsPointQueryParameters2D — C# API

class PhysicsPointQueryParameters2DReckfellSharpInherits RefCounted

Provides parameters for PhysicsDirectSpaceState2D.IntersectPoint.

By changing various properties of this object, such as the point position, you can configure the parameters for PhysicsDirectSpaceState2D.IntersectPoint.

Declarations checked against C# SDK 1.0.0. Expand a name to see declarations and documentation.

Constructors1

PhysicsPointQueryParameters2DConstructor

# PhysicsPointQueryParameters2D

C#
public PhysicsPointQueryParameters2D();

Properties6

CanvasInstanceIdProperty

# CanvasInstanceId

C#
public ulong CanvasInstanceId { get; set; }

If different from 0, restricts the query to a specific canvas layer specified by its instance ID. See ReckfellObject.GetInstanceId. If 0, restricts the query to the Viewport's default canvas layer.

CollideWithAreasProperty

# CollideWithAreas

C#
public bool CollideWithAreas { get; set; }

If true, the query will take Area2Ds into account.

CollideWithBodiesProperty

# CollideWithBodies

C#
public bool CollideWithBodies { get; set; }

If true, the query will take PhysicsBody2Ds into account.

CollisionMaskProperty

# CollisionMask

C#
public uint CollisionMask { get; set; }

The physics layers the query will detect (as a bitmask). By default, all collision layers are detected. See Collision layers and masks in the documentation for more information.

ExcludeProperty

# Exclude

C#
public Reckfell.Collections.Array<Rid> Exclude { get; set; }

The list of object Rids that will be excluded from collisions. Use CollisionObject2D.GetRid to get the Rid associated with a CollisionObject2D-derived node. Note: The returned array is copied and any changes to it will not update the original property value. To update the value you need to modify the returned array, and then assign it to the property again.

PositionProperty

# Position

C#
public Vector2 Position { get; set; }

The position being queried for, in global coordinates.

Methods12

GetCanvasInstanceIdulong

# GetCanvasInstanceId

C#
public ulong GetCanvasInstanceId();

Returns ulong

GetCollisionMaskuint

# GetCollisionMask

C#
public uint GetCollisionMask();

Returns uint

GetExcludeReckfell.Collections.Array<Rid>

# GetExclude

C#
public Reckfell.Collections.Array<Rid> GetExclude();

Returns Reckfell.Collections.Array<Rid>

GetPositionVector2

# GetPosition

C#
public Vector2 GetPosition();

Returns Vector2

IsCollideWithAreasEnabledbool

# IsCollideWithAreasEnabled

C#
public bool IsCollideWithAreasEnabled();

Returns bool

IsCollideWithBodiesEnabledbool

# IsCollideWithBodiesEnabled

C#
public bool IsCollideWithBodiesEnabled();

Returns bool

SetCanvasInstanceIdvoid

# SetCanvasInstanceId

C#
public void SetCanvasInstanceId(ulong canvasInstanceId);

Parameters
Name	Type	Default
`canvasInstanceId`	`ulong`	—

SetCollideWithAreasvoid

# SetCollideWithAreas

C#
public void SetCollideWithAreas(bool enable);

Parameters
Name	Type	Default
`enable`	`bool`	—

SetCollideWithBodiesvoid

# SetCollideWithBodies

C#
public void SetCollideWithBodies(bool enable);

Parameters
Name	Type	Default
`enable`	`bool`	—

SetCollisionMaskvoid

# SetCollisionMask

C#
public void SetCollisionMask(uint collisionMask);

Parameters
Name	Type	Default
`collisionMask`	`uint`	—

SetExcludevoid

# SetExclude

C#
public void SetExclude(Reckfell.Collections.Array<Rid> exclude);

Parameters
Name	Type	Default
`exclude`	`Reckfell.Collections.Array<Rid>`	—

SetPositionvoid

# SetPosition

C#
public void SetPosition(Vector2 position);

Parameters
Name	Type	Default
`position`	`Vector2`	—