PhysicsShapeQueryParameters2D

Home | API by Category | Complete API Index | API Compatibility

Field	Value
Full name	Electron2D.PhysicsShapeQueryParameters2D
Namespace	Electron2D
Kind	class
Category	Physics

Overview

Stores parameters for Electron2D.PhysicsDirectSpaceState2D.IntersectShape(Electron2D.PhysicsShapeQueryParameters2D,System.Int32).

Syntax

public sealed class Electron2D.PhysicsShapeQueryParameters2D : Electron2D.RefCounted

Godot 4.7 C# profile compatibility

Profile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: PhysicsShapeQueryParameters2D

Shape query parameters for direct 2D physics queries, including shape resource, transform, motion, margin, mask and excluded RIDs.

Remarks

This type is part of the Electron2D 0.1.0 Preview public API.

Thread Safety

This type is not synchronized. Mutate it on the main scene thread.

Since

This type is available since Electron2D 0.1.0 Preview.

Members

Member	Kind	Summary
CollideWithAreas	Property	Gets or sets whether area objects are included.
CollideWithBodies	Property	Gets or sets whether body objects are included.
CollisionMask	Property	Gets or sets the collision layers scanned by this query.
Exclude	Property	Gets or sets RIDs excluded from the query.
Margin	Property	Gets or sets an extra margin added around the query bounds.
Motion	Property	Gets or sets extra motion swept into the query bounds.
Shape	Property	Gets or sets the shape resource used by the query.
ShapeRid	Property	Gets or sets the shape RID used by future production backends.
Transform	Property	Gets or sets the query shape transform in world coordinates.
Electron2D.PhysicsShapeQueryParameters2D()	Constructor	Initializes a new instance of the PhysicsShapeQueryParameters2D type.

Member Details

CollideWithAreas

Kind: Property

public System.Boolean CollideWithAreas { get; set; }

Summary

Gets or sets whether area objects are included.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current collide with areas value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

CollideWithBodies

Kind: Property

public System.Boolean CollideWithBodies { get; set; }

Summary

Gets or sets whether body objects are included.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current collide with bodies value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

CollisionMask

Kind: Property

public System.UInt32 CollisionMask { get; set; }

Summary

Gets or sets the collision layers scanned by this query.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current collision mask value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

Exclude

Kind: Property

public Electron2D.Rid[] Exclude { get; set; }

Summary

Gets or sets RIDs excluded from the query.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current exclude value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

Margin

Kind: Property

public System.Single Margin { get; set; }

Summary

Gets or sets an extra margin added around the query bounds.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current margin value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

Motion

Kind: Property

public Electron2D.Vector2 Motion { get; set; }

Summary

Gets or sets extra motion swept into the query bounds.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current motion value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

Shape

Kind: Property

public Electron2D.Shape2D Shape { get; set; }

Summary

Gets or sets the shape resource used by the query.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current shape value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

ShapeRid

Kind: Property

public Electron2D.Rid ShapeRid { get; set; }

Summary

Gets or sets the shape RID used by future production backends.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current shape rid value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

Transform

Kind: Property

public Electron2D.Transform2D Transform { get; set; }

Summary

Gets or sets the query shape transform in world coordinates.

Remarks

This property follows the validation and lifetime rules of its declaring type.

Value

The current transform value.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D

Electron2D.PhysicsShapeQueryParameters2D()

Kind: Constructor

public Electron2D.PhysicsShapeQueryParameters2D()

Summary

Initializes a new instance of the PhysicsShapeQueryParameters2D type.

Remarks

The new instance follows the lifetime and validation rules of its declaring type.

Thread Safety

This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.

Since

This API is available since Electron2D 0.1.0 Preview.

See Also

• Electron2D.PhysicsShapeQueryParameters2D