Struct gdnative::Area2D
[−]
[src]
pub struct Area2D { /* fields omitted */ }
core class Area2D : CollisionObject2D
(manually managed)
Base class
Area2D inherits CollisionObject2D and all of its methods.
Memory management
Non reference counted objects such as the ones of this type are usually owned by the engine.
In the cases where Rust code owns an object of this type, ownership should be either passed
to the engine or the object must be manually destroyed using Area2D::free
.
Methods
impl Area2D
[src]
pub fn as_collision_object_2d(&self) -> CollisionObject2D
[src]
Up-cast.
pub fn new() -> Self
[src]
Constructor.
Because this type is not reference counted, the lifetime of the returned object
is not automatically managed.
Immediately after creation, the object is owned by the caller, and can be
passed to the engine (in which case the engine will be responsible for
destroying the object) or destroyed manually using Area2D::free
.
pub unsafe fn free(self)
[src]
Manually deallocate the object.
pub fn _body_enter_tree(&mut self, id: i64)
[src]
pub fn _body_exit_tree(&mut self, id: i64)
[src]
pub fn _area_enter_tree(&mut self, id: i64)
[src]
pub fn _area_exit_tree(&mut self, id: i64)
[src]
pub fn set_space_override_mode(&mut self, space_override_mode: i64)
[src]
pub fn set_gravity_is_point(&mut self, enable: bool)
[src]
pub fn is_gravity_a_point(&self) -> bool
[src]
pub fn set_gravity_distance_scale(&mut self, distance_scale: f64)
[src]
pub fn get_gravity_distance_scale(&self) -> f64
[src]
pub fn set_gravity_vector(&mut self, vector: Vector2)
[src]
pub fn get_gravity_vector(&self) -> Vector2
[src]
pub fn set_gravity(&mut self, gravity: f64)
[src]
pub fn get_gravity(&self) -> f64
[src]
pub fn set_linear_damp(&mut self, linear_damp: f64)
[src]
pub fn get_linear_damp(&self) -> f64
[src]
pub fn set_angular_damp(&mut self, angular_damp: f64)
[src]
pub fn get_angular_damp(&self) -> f64
[src]
pub fn set_priority(&mut self, priority: f64)
[src]
pub fn get_priority(&self) -> f64
[src]
pub fn set_collision_mask(&mut self, collision_mask: i64)
[src]
pub fn get_collision_mask(&self) -> i64
[src]
pub fn set_collision_layer(&mut self, collision_layer: i64)
[src]
pub fn get_collision_layer(&self) -> i64
[src]
pub fn set_collision_mask_bit(&mut self, bit: i64, value: bool)
[src]
pub fn get_collision_mask_bit(&self, bit: i64) -> bool
[src]
pub fn set_collision_layer_bit(&mut self, bit: i64, value: bool)
[src]
pub fn get_collision_layer_bit(&self, bit: i64) -> bool
[src]
pub fn set_monitoring(&mut self, enable: bool)
[src]
pub fn is_monitoring(&self) -> bool
[src]
pub fn set_monitorable(&mut self, enable: bool)
[src]
pub fn is_monitorable(&self) -> bool
[src]
pub fn get_overlapping_bodies(&self) -> VariantArray
[src]
pub fn get_overlapping_areas(&self) -> VariantArray
[src]
pub fn overlaps_body(&self, body: Option<Object>) -> bool
[src]
pub fn overlaps_area(&self, area: Option<Object>) -> bool
[src]
pub fn set_audio_bus_name(&mut self, name: GodotString)
[src]
pub fn get_audio_bus_name(&self) -> GodotString
[src]
pub fn set_audio_bus_override(&mut self, enable: bool)
[src]
pub fn is_overriding_audio_bus(&self) -> bool
[src]
pub fn _body_inout(
&mut self,
arg0: i64,
arg1: Rid,
arg2: i64,
arg3: i64,
arg4: i64
)
[src]
&mut self,
arg0: i64,
arg1: Rid,
arg2: i64,
arg3: i64,
arg4: i64
)
pub fn _area_inout(
&mut self,
arg0: i64,
arg1: Rid,
arg2: i64,
arg3: i64,
arg4: i64
)
[src]
&mut self,
arg0: i64,
arg1: Rid,
arg2: i64,
arg3: i64,
arg4: i64
)
pub fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Methods from Deref<Target = CollisionObject2D>
pub fn as_node_2d(&self) -> Node2D
[src]
Up-cast.
pub fn _input_event(
&mut self,
viewport: Option<Object>,
event: Option<InputEvent>,
shape_idx: i64
)
[src]
&mut self,
viewport: Option<Object>,
event: Option<InputEvent>,
shape_idx: i64
)
pub fn get_rid(&self) -> Rid
[src]
pub fn set_pickable(&mut self, enabled: bool)
[src]
pub fn is_pickable(&self) -> bool
[src]
pub fn create_shape_owner(&mut self, owner: Option<Object>) -> i64
[src]
pub fn remove_shape_owner(&mut self, owner_id: i64)
[src]
pub fn get_shape_owners(&mut self) -> VariantArray
[src]
pub fn shape_owner_set_transform(
&mut self,
owner_id: i64,
transform: Transform2D
)
[src]
&mut self,
owner_id: i64,
transform: Transform2D
)
pub fn shape_owner_get_transform(&self, owner_id: i64) -> Transform2D
[src]
pub fn shape_owner_get_owner(&self, owner_id: i64) -> Option<Object>
[src]
pub fn shape_owner_set_disabled(&mut self, owner_id: i64, disabled: bool)
[src]
pub fn is_shape_owner_disabled(&self, owner_id: i64) -> bool
[src]
pub fn shape_owner_set_one_way_collision(&mut self, owner_id: i64, enable: bool)
[src]
pub fn is_shape_owner_one_way_collision_enabled(&self, owner_id: i64) -> bool
[src]
pub fn shape_owner_add_shape(&mut self, owner_id: i64, shape: Option<Shape2D>)
[src]
pub fn shape_owner_get_shape_count(&self, owner_id: i64) -> i64
[src]
pub fn shape_owner_get_shape(
&self,
owner_id: i64,
shape_id: i64
) -> Option<Shape2D>
[src]
&self,
owner_id: i64,
shape_id: i64
) -> Option<Shape2D>
pub fn shape_owner_get_shape_index(&self, owner_id: i64, shape_id: i64) -> i64
[src]
pub fn shape_owner_remove_shape(&mut self, owner_id: i64, shape_id: i64)
[src]
pub fn shape_owner_clear_shapes(&mut self, owner_id: i64)
[src]
pub fn shape_find_owner(&self, shape_index: i64) -> i64
[src]
pub fn cast<T: GodotObject>(&self) -> Option<T>
[src]
Trait Implementations
impl GodotObject for Area2D
[src]
fn class_name() -> &'static str
[src]
unsafe fn from_sys(obj: *mut godot_object) -> Self
[src]
unsafe fn to_sys(&self) -> *mut godot_object
[src]
impl Deref for Area2D
[src]
type Target = CollisionObject2D
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
Dereferences the value.