-
Notifications
You must be signed in to change notification settings - Fork 0
CollisionObject2D
Home | API by Category | Complete API Index | API Compatibility
| Field | Value |
|---|---|
| Full name | Electron2D.CollisionObject2D |
| Namespace | Electron2D |
| Kind | class |
| Category | Physics |
Provides the Electron2D base node for 2D objects that own a physics server RID.
public abstract class Electron2D.CollisionObject2D : Electron2D.Node2DProfile: Electron2D 0.1.0 2D
Status: Partial / Not verified
Out of profile: yes
Godot reference: CollisionObject2D
Base collision object with GetRid(), collision layer/mask storage, RID lifecycle and transform sync.
CollisionObject2D creates its RID when it enters a Electron2D.SceneTree
and frees it when it exits the tree. The RID is an Electron2D
Electron2D.Rid, not a Box2D.NET handle.
This type is not synchronized. Create and mutate nodes on the main scene thread.
This type is available since Electron2D 0.1.0 Preview.
| Member | Kind | Summary |
|---|---|---|
CollisionLayer |
Property | Gets or sets the collision layer bits for this object. |
CollisionMask |
Property | Gets or sets the collision mask bits used by this object. |
Electron2D.CollisionObject2D() |
Constructor | Initializes a new instance of the CollisionObject2D type. |
GetCollisionLayerValue(System.Int32) |
Method | Checks whether an Electron2D collision layer number is enabled. |
GetCollisionMaskValue(System.Int32) |
Method | Checks whether an Electron2D collision mask number is enabled. |
GetRid() |
Method | Gets the physics server RID owned by this collision object. |
SetCollisionLayerValue(System.Int32, System.Boolean) |
Method | Enables or disables an Electron2D collision layer number. |
SetCollisionMaskValue(System.Int32, System.Boolean) |
Method | Enables or disables an Electron2D collision mask number. |
Kind: Property
public System.UInt32 CollisionLayer { get; set; }Gets or sets the collision layer bits for this object.
This property follows the validation and lifetime rules of its declaring type.
The current collision layer value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Kind: Property
public System.UInt32 CollisionMask { get; set; }Gets or sets the collision mask bits used by this object.
This property follows the validation and lifetime rules of its declaring type.
The current collision mask value.
This property is not synchronized. Mutate it on the main scene thread.
This property is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Kind: Constructor
public Electron2D.CollisionObject2D()Initializes a new instance of the CollisionObject2D type.
The new instance follows the lifetime and validation rules of its declaring type.
This member is not synchronized. Call it from the thread that owns the related object unless the declaring type states otherwise.
This API is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Kind: Method
public System.Boolean GetCollisionLayerValue(System.Int32)(System.Int32 layerNumber)Checks whether an Electron2D collision layer number is enabled.
This method follows the validation and lifetime rules of its declaring type.
-
layerNumber: The layer number in the inclusive range1..32.
true when the layer bit is enabled; otherwise, false.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Kind: Method
public System.Boolean GetCollisionMaskValue(System.Int32)(System.Int32 layerNumber)Checks whether an Electron2D collision mask number is enabled.
This method follows the validation and lifetime rules of its declaring type.
-
layerNumber: The mask layer number in the inclusive range1..32.
true when the mask bit is enabled; otherwise, false.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Kind: Method
public Electron2D.Rid GetRid()()Gets the physics server RID owned by this collision object.
This method follows the validation and lifetime rules of its declaring type.
The current physics server RID, or the default empty Electron2D.Rid
when the node is not inside a Electron2D.SceneTree.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Kind: Method
public System.Void SetCollisionLayerValue(System.Int32, System.Boolean)(System.Int32 layerNumber, System.Boolean value)Enables or disables an Electron2D collision layer number.
This method follows the validation and lifetime rules of its declaring type.
-
layerNumber: The layer number in the inclusive range1..32. -
value: Whether the layer bit should be enabled.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Kind: Method
public System.Void SetCollisionMaskValue(System.Int32, System.Boolean)(System.Int32 layerNumber, System.Boolean value)Enables or disables an Electron2D collision mask number.
This method follows the validation and lifetime rules of its declaring type.
-
layerNumber: The mask layer number in the inclusive range1..32. -
value: Whether the mask bit should be enabled.
This method is not synchronized. Call it on the main scene thread.
This method is available since Electron2D 0.1.0 Preview.
Electron2D.CollisionObject2D
Electron2D 0.1.0 Preview API reference. Generated from 175 public runtime types.