CollisionObject

    Inherited By: , PhysicsBody

    Category: Core

    Base node for collision objects.

    Properties

    Signals

    • input_event ( camera, InputEvent event, click_position, Vector3 click_normal, shape_idx )

    Emitted when _input_event receives an event. See its description for details.

    • mouse_entered ( )

    Emitted when the mouse pointer enters any of this object’s shapes.

    Emitted when the mouse pointer exits all this object’s shapes.

    CollisionObject is the base class for physics objects. It can hold any number of collision s. Each shape must be assigned to a shape owner. The CollisionObject can have any number of shape owners. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the methods.

    Property Descriptions

    • bool input_capture_on_drag

    If true, the CollisionObject will continue to receive input events as the mouse is dragged across its shapes. Default value: false.

    • input_ray_pickable
    • void _input_event ( Object camera, event, Vector3 click_position, click_normal, int shape_idx ) virtual

    Accepts unhandled s. click_position is the clicked location in world space and click_normal is the normal vector extending from the clicked surface of the Shape at shape_idx. Connect to the input_event signal to easily pick up these events.

    • create_shape_owner ( Object owner )

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

    • get_rid ( ) const

    Returns the object’s RID.

    • get_shape_owners ( )

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

    • is_shape_owner_disabled ( int owner_id ) const

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

    • void remove_shape_owner ( owner_id )

    Removes the given shape owner.

    • int shape_find_owner ( shape_index ) const

    Returns the owner_id of the given shape.

    Adds a Shape to the shape owner.

    • void shape_owner_clear_shapes ( owner_id )
    • Object shape_owner_get_owner ( owner_id ) const

    Returns the parent object of the given shape owner.

    • Shape shape_owner_get_shape ( owner_id, int shape_id ) const

    Returns the with the given id from the given shape owner.

    • int shape_owner_get_shape_count ( owner_id ) const

    Returns the number of shapes the given shape owner contains.

    • int shape_owner_get_shape_index ( owner_id, int shape_id ) const

    Returns the child index of the with the given id from the given shape owner.

    • Transform shape_owner_get_transform ( owner_id ) const

    Returns the shape owner’s Transform.

    • void shape_owner_remove_shape ( owner_id, int shape_id )

    Removes a shape from the given shape owner.

    • void shape_owner_set_disabled ( owner_id, bool disabled )

    If , disables the given shape owner.

    • void shape_owner_set_transform ( owner_id, Transform transform )

    Sets the of the given shape owner.