class-description NEWS COMMUNITY STORE LABS SIGN UP LOGIN LOGOUT ROKOJORI NEWSLETTER SIGN UP LOGIN LOGOUT NEWS COMMUNITY STORE LABS TOGGLE FULLSCREEN VOLLBILD AN/AUS ObjectNodeCanvasItemNode2D CollisionObject2D
Abstract base class for 2D physics objects.

Abstract base class for 2D physics objects. CollisionObject2D can hold any number of Shape2Ds for collision. Each shape must be assigned to a shape owner. Shape owners are not nodes and do not appear in the editor, but are accessible through code using the shape_owner_* methods.

 input_event input_event<>( Node viewport=, viewport:Node=, InputEvent event=, event:InputEvent=, int shape_idx=, shape_idx:int=, ):input_event

Emitted when an input event occurs. Requires input_pickable to be true and at least one collision_layer bit to be set. See _input_event for details.

 mouse_entered mouse_entered<>():mouse_entered

Emitted when the mouse pointer enters any of this object's shapes. Requires input_pickable to be true and at least one collision_layer bit to be set. Note that moving between different shapes within a single CollisionObject2D won't cause this signal to be emitted.

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 CollisionObject2D's area is small. This signal may also not be emitted if another CollisionObject2D is overlapping the CollisionObject2D in question.

 mouse_exited mouse_exited<>():mouse_exited

Emitted when the mouse pointer exits all this object's shapes. Requires input_pickable to be true and at least one collision_layer bit to be set. Note that moving between different shapes within a single CollisionObject2D won't cause this signal to be emitted.

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 CollisionObject2D's area is small. This signal may also not be emitted if another CollisionObject2D is overlapping the CollisionObject2D in question.

 mouse_shape_entered mouse_shape_entered<>( int shape_idx=, shape_idx:int=, ):mouse_shape_entered

Emitted when the mouse pointer enters any of this object's shapes or moves from one shape to another. shape_idx is the child index of the newly entered Shape2D. Requires input_pickable to be true and at least one collision_layer bit to be set.

 mouse_shape_exited mouse_shape_exited<>( int shape_idx=, shape_idx:int=, ):mouse_shape_exited

Emitted when the mouse pointer exits any of this object's shapes. shape_idx is the child index of the exited Shape2D. Requires input_pickable to be true and at least one collision_layer bit to be set.

 Enum DisableMode<>():Enum

DISABLE_MODE_REMOVE = 0

When Node.process_mode is set to Node.PROCESS_MODE_DISABLED, remove from the physics simulation to stop all physics interactions with this CollisionObject2D.


DISABLE_MODE_MAKE_STATIC = 1

When Node.process_mode is set to Node.PROCESS_MODE_DISABLED, make the body static. Doesn't affect Area2D. PhysicsBody2D can't be affected by forces or other bodies while static.


DISABLE_MODE_KEEP_ACTIVE = 2

When Node.process_mode is set to Node.PROCESS_MODE_DISABLED, do not affect the physics simulation.

 int collision_layer<>():int

The physics layers this CollisionObject2D is in. Collision objects can exist in one or more of 32 different layers. See also collision_mask.

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.

 int collision_mask<>():int

The physics layers this CollisionObject2D scans. Collision objects can scan one or more of 32 different layers. See also collision_layer.

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.

 float collision_priority<>():float

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.

 DisableMode disable_mode<>():DisableMode

Defines the behavior in physics when Node.process_mode is set to Node.PROCESS_MODE_DISABLED. See DisableMode for more details about the different modes.

 bool input_pickable<>():bool

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 collision_layer bit to be set.

 void _input_event<>( Viewport viewport=, viewport:Viewport=, InputEvent event=, event:InputEvent=, int shape_idx=, shape_idx:int=, ):void

Accepts unhandled InputEvents. shape_idx is the child index of the clicked Shape2D. Connect to input_event to easily pick up these events.

Note: _input_event requires input_pickable to be true and at least one collision_layer bit to be set.

 void _mouse_enter<>():void

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

 void _mouse_exit<>():void

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

 void _mouse_shape_enter<>( int shape_idx=, shape_idx:int=, ):void

Called when the mouse pointer enters any of this object's shapes or moves from one shape to another. shape_idx is the child index of the newly entered Shape2D. Requires input_pickable to be true and at least one collision_layer bit to be called.

 void _mouse_shape_exit<>( int shape_idx=, shape_idx:int=, ):void

Called when the mouse pointer exits any of this object's shapes. shape_idx is the child index of the exited Shape2D. Requires input_pickable to be true and at least one collision_layer bit to be called.

 int create_shape_owner<>( Object owner=, owner:Object=, ):int

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

 bool get_collision_layer_value<>( int layer_number=, layer_number:int=, ):bool

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

 bool get_collision_mask_value<>( int layer_number=, layer_number:int=, ):bool

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

 RID get_rid<>():RID

Returns the object's RID.

 float get_shape_owner_one_way_collision_margin<>( int owner_id=, owner_id:int=, ):float

Returns the one_way_collision_margin of the shape owner identified by given owner_id.

 PackedInt32Array get_shape_owners<>():PackedInt32Array

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

 bool is_shape_owner_disabled<>( int owner_id=, owner_id:int=, ):bool

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

 bool is_shape_owner_one_way_collision_enabled<>( int owner_id=, owner_id:int=, ):bool

Returns true if collisions for the shape owner originating from this CollisionObject2D will not be reported to collided with CollisionObject2Ds.

 void remove_shape_owner<>( int owner_id=, owner_id:int=, ):void

Removes the given shape owner.

 void set_collision_layer_value<>( int layer_number=, layer_number:int=, bool value=, value:bool=, ):void

Based on value, enables or disables the specified layer in the collision_layer, given a layer_number between 1 and 32.

 void set_collision_mask_value<>( int layer_number=, layer_number:int=, bool value=, value:bool=, ):void

Based on value, enables or disables the specified layer in the collision_mask, given a layer_number between 1 and 32.

 int shape_find_owner<>( int shape_index=, shape_index:int=, ):int

Returns the owner_id of the given shape.

 void shape_owner_add_shape<>( int owner_id=, owner_id:int=, Shape2D shape=, shape:Shape2D=, ):void

Adds a Shape2D to the shape owner.

 void shape_owner_clear_shapes<>( int owner_id=, owner_id:int=, ):void

Removes all shapes from the shape owner.

 Object shape_owner_get_owner<>( int owner_id=, owner_id:int=, ):Object

Returns the parent object of the given shape owner.

 Shape2D shape_owner_get_shape<>( int owner_id=, owner_id:int=, int shape_id=, shape_id:int=, ):Shape2D

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

 int shape_owner_get_shape_count<>( int owner_id=, owner_id:int=, ):int

Returns the number of shapes the given shape owner contains.

 int shape_owner_get_shape_index<>( int owner_id=, owner_id:int=, int shape_id=, shape_id:int=, ):int

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

 Transform2D shape_owner_get_transform<>( int owner_id=, owner_id:int=, ):Transform2D

Returns the shape owner's Transform2D.

 void shape_owner_remove_shape<>( int owner_id=, owner_id:int=, int shape_id=, shape_id:int=, ):void

Removes a shape from the given shape owner.

 void shape_owner_set_disabled<>( int owner_id=, owner_id:int=, bool disabled=, disabled:bool=, ):void

If true, disables the given shape owner.

 void shape_owner_set_one_way_collision<>( int owner_id=, owner_id:int=, bool enable=, enable:bool=, ):void

If enable is true, collisions for the shape owner originating from this CollisionObject2D will not be reported to collided with CollisionObject2Ds.

 void shape_owner_set_one_way_collision_margin<>( int owner_id=, owner_id:int=, float margin=, margin:float=, ):void

Sets the one_way_collision_margin of the shape owner identified by given owner_id to margin pixels.

 void shape_owner_set_transform<>( int owner_id=, owner_id:int=, Transform2D transform=, transform:Transform2D=, ):void

Sets the Transform2D of the given shape owner.


All social media brands are registrated trademarks and belong to their respective owners.





CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com CONTACT IMPRINT TERMS OF USE PRIVACY © ROKOROJI ® 2021 rokojori.com We are using cookies on this site. Read more... Wir benutzen Cookies auf dieser Seite. Mehr lesen...