CollisionObject3D

public uint CollisionLayer { get; set; }

The physics layers this CollisionObject3D is in. Collision objects can exist in one or more of 32 different layers. See also CollisionObject3D.CollisionMask. For an easier way to change this value from a script, see CollisionObject3D.SetCollisionLayerValue. Note: Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See Collision layers and masks in the documentation for more information.

public uint CollisionMask { get; set; }

The physics layers this CollisionObject3D scans. Collision objects can scan one or more of 32 different layers. See also CollisionObject3D.CollisionLayer. For an easier way to change this value from a script, see CollisionObject3D.SetCollisionMaskValue. Note: Object A can detect a contact with object B only if object B is in any of the layers that object A scans. See Collision layers and masks in the documentation for more information.

public float CollisionPriority { get; set; }

The priority used to solve colliding when occurring penetration. The higher the priority is, the lower the penetration into the object will be. This can for example be used to prevent the player from breaking through the boundaries of a level.

public CollisionObject3D.DisableModeEnum DisableMode { get; set; }

Defines the behavior in physics when Entity.ProcessMode is set to Entity.ProcessModeEnum.Disabled.

public bool InputCaptureOnDrag { get; set; }

If true, the CollisionObject3D will continue to receive input events as the mouse is dragged across its shapes.

public bool InputRayPickable { get; set; }

If true, this object is pickable. A pickable object can detect the mouse pointer entering/leaving, and if the mouse is inside it, report input events. Requires at least one CollisionObject3D.CollisionLayer bit to be set.

public uint CreateShapeOwner(ReckfellObject owner);

Creates a new shape owner for the given object. Returns owner_id of the new owner for future reference.

public bool GetCollisionLayerValue(int layerNumber);

Returns whether or not the specified layer of the CollisionObject3D.CollisionLayer is enabled, given a layer_number between 1 and 32.

public bool GetCollisionMaskValue(int layerNumber);

Returns whether or not the specified layer of the CollisionObject3D.CollisionMask is enabled, given a layer_number between 1 and 32.

public Rid GetRid();

Returns the object's Rid.

public int[] GetShapeOwners();

Returns an Reckfell.Collections.Array of owner_id identifiers. You can use these ids in other methods that take owner_id as an argument.

public bool IsShapeOwnerDisabled(uint ownerId);

If true, the shape owner and its shapes are disabled.

public void RemoveShapeOwner(uint ownerId);

Removes the given shape owner.

public void SetCollisionLayerValue(int layerNumber, bool value);

Changes membership by layer number 1–32. Number 3 changes bit value 4; pass the number, not a precomputed mask.

public void SetCollisionMaskValue(int layerNumber, bool value);

Changes filtering by layer number 1–32. Mask and Layer have different roles; this does not edit geometry or every other object's filters.

public uint ShapeFindOwner(int shapeIndex);

Returns the owner_id of the given shape.

public void ShapeOwnerAddShape(uint ownerId, Shape3D shape);

Adds a Shape3D to the shape owner.

public void ShapeOwnerClearShapes(uint ownerId);

Removes all shapes from the shape owner.

public ReckfellObject ShapeOwnerGetOwner(uint ownerId);

Returns the parent object of the given shape owner.

public Shape3D ShapeOwnerGetShape(uint ownerId, int shapeId);

Returns the Shape3D with the given ID from the given shape owner.

public int ShapeOwnerGetShapeCount(uint ownerId);

Returns the number of shapes the given shape owner contains.

public int ShapeOwnerGetShapeIndex(uint ownerId, int shapeId);

Returns the child index of the Shape3D with the given ID from the given shape owner.

public Transform3D ShapeOwnerGetTransform(uint ownerId);

Returns the shape owner's Transform3D.

public void ShapeOwnerRemoveShape(uint ownerId, int shapeId);

Removes a shape from the given shape owner.

public void ShapeOwnerSetDisabled(uint ownerId, bool disabled);

If true, disables the given shape owner.

public void ShapeOwnerSetTransform(uint ownerId, Transform3D transform);

Sets the Transform3D of the given shape owner.

public virtual void _InputEvent(Camera3D camera, InputEvent @event, Vector3 eventPosition, Vector3 normal, int shapeIdx);

Detects unhandled mouse and touch InputEvents through event when they happen while hovering over the object. Gesture events are not detected. camera is the Camera3D that the event originated in (for cameras inside viewports other than the main one to be detected, the parent Viewport.PhysicsObjectPicking needs to be set to true). event_position is the position hit by a raycast from the camera to the mouse, in global space. normal is the normal vector of the surface at that point in world space. shape_idx is the index of the detected shape from PhysicsServer3D. See also Entity._UnhandledInput, CollisionObject3D.ShapeFindOwner, and CollisionObject3D.ShapeOwnerGetOwner. Note: InputEventScreenDrag events are triggered if the drag events started while hovering the object, or when the object is in the path of the drag event. Note: CollisionObject3D.InputEvent requires CollisionObject3D.InputRayPickable to be true and at least one CollisionObject3D.CollisionLayer bit to be set.

public virtual void _MouseEnter();

Called when the mouse pointer enters any of this object's shapes. Requires CollisionObject3D.InputRayPickable to be true and at least one CollisionObject3D.CollisionLayer bit to be set. Note that moving between different shapes within a single CollisionObject3D won't cause this function to be called.

public virtual void _MouseExit();

Called when the mouse pointer exits all this object's shapes. Requires CollisionObject3D.InputRayPickable to be true and at least one CollisionObject3D.CollisionLayer bit to be set. Note that moving between different shapes within a single CollisionObject3D won't cause this function to be called.

public event CollisionObject3D.InputEventEventHandler InputEvent;

Detects unhandled mouse and touch InputEvents through event when they happen while hovering over the object. Gesture events are not detected. camera is the Camera3D that the event originated in (for cameras inside viewports other than the main one to be detected, the parent Viewport.PhysicsObjectPicking needs to be set to true). event_position is the position hit by a raycast from the camera to the mouse, in global space. normal is the normal vector of the surface at that point in world space. shape_idx is the index of the detected shape from PhysicsServer3D. See also Entity._UnhandledInput, CollisionObject3D.ShapeFindOwner, and CollisionObject3D.ShapeOwnerGetOwner. Note: InputEventScreenDrag events are triggered if the drag events started while hovering the object, or when the object is in the path of the drag event. Note: CollisionObject3D.InputEvent requires CollisionObject3D.InputRayPickable to be true and at least one CollisionObject3D.CollisionLayer bit to be set.

public event Action MouseEntered;

Emitted when the mouse pointer enters any of this object's shapes. Requires CollisionObject3D.InputRayPickable to be true and at least one CollisionObject3D.CollisionLayer bit to be set. Note: Due to the lack of continuous collision detection, this signal may not be emitted in the expected order if the mouse moves fast enough and the CollisionObject3D's area is small. This signal may also not be emitted if another CollisionObject3D is overlapping the CollisionObject3D in question.

public event Action MouseExited;

Emitted when the mouse pointer exits all this object's shapes. Requires CollisionObject3D.InputRayPickable to be true and at least one CollisionObject3D.CollisionLayer bit to be set. Note: Due to the lack of continuous collision detection, this signal may not be emitted in the expected order if the mouse moves fast enough and the CollisionObject3D's area is small. This signal may also not be emitted if another CollisionObject3D is overlapping the CollisionObject3D in question.