class_area2d

Area2D

####Inherits: CollisionObject2D ####Category: Core

Brief Description

General purpose area detection and influence for 2D Phisics.

Member Functions

• void set&#95space&#95override&#95mode ( int enable )
• int get&#95space&#95override&#95mode ( ) const
• void set&#95gravity&#95is&#95point ( bool enable )
• bool is&#95gravity&#95a&#95point ( ) const
• void set&#95gravity&#95vector ( Vector2 vector )
• Vector2 get&#95gravity&#95vector ( ) const
• void set&#95gravity ( real gravity )
• real get&#95gravity ( ) const
• void set&#95density ( real density )
• real get&#95density ( ) const
• void set&#95priority ( real priority )
• real get&#95priority ( ) const
• void set&#95enable&#95monitoring ( bool enable )
• bool is&#95monitoring&#95enabled ( ) const

Signals

• body&#95enter ( Object body )
• body&#95enter&#95shape ( int body_id, Object body, int body_shape, int area_shape )
• body&#95exit ( Object body )
• body&#95exit&#95shape ( int body_id, Object body, int body_shape, int area_shape )

Description

General purpose area detection for 2D Phisics. Areas can be used for detection of objects that enter/exit them, as well as overriding space parameters (changing gravity, damping, etc). An Area2D can be set as a children to a RigidBody2D to generate a custom gravity field. For this, use SPACE_OVERRIDE_COMBINE and point gravity at the center of mass.

Member Function Description

set_gravity_is_point

• void set&#95gravity&#95is&#95point ( bool enable )

When overriding space parameters, areas can have a center of gravity as a point.

is_gravity_a_point

• bool is&#95gravity&#95a&#95point ( ) const

Return if gravity is a point. When overriding space parameters, areas can have a center of gravity as a point.

set_gravity_vector

• void set&#95gravity&#95vector ( Vector2 vector )

Set gravity vector. If gravity is a point, this will be the attraction center