Struct TileData
#[repr(C)]pub struct TileData { /* private fields */ }
Expand description
Godot class TileData.
Inherits Object
.
Related symbols:
tile_data
: sidecar module with related enum/flag typesITileData
: virtual methodsSignalsOfTileData
: signal collection
See also Godot docs for TileData
.
§Construction
This class is manually managed. You can create a new instance using TileData::new_alloc()
.
Do not forget to call free()
or hand over ownership to Godot.
Implementations§
§impl TileData
impl TileData
pub fn set_flip_h(&mut self, flip_h: bool)
pub fn get_flip_h(&self) -> bool
pub fn set_flip_v(&mut self, flip_v: bool)
pub fn get_flip_v(&self) -> bool
pub fn set_transpose(&mut self, transpose: bool)
pub fn get_transpose(&self) -> bool
pub fn set_material(&mut self, material: impl AsArg<Option<Gd<Material>>>)
pub fn get_material(&self) -> Option<Gd<Material>>
pub fn set_texture_origin(&mut self, texture_origin: Vector2i)
pub fn get_texture_origin(&self) -> Vector2i
pub fn set_modulate(&mut self, modulate: Color)
pub fn get_modulate(&self) -> Color
pub fn set_z_index(&mut self, z_index: i32)
pub fn get_z_index(&self) -> i32
pub fn set_y_sort_origin(&mut self, y_sort_origin: i32)
pub fn get_y_sort_origin(&self) -> i32
pub fn set_occluder_polygons_count( &mut self, layer_id: i32, polygons_count: i32, )
pub fn get_occluder_polygons_count(&self, layer_id: i32) -> i32
pub fn add_occluder_polygon(&mut self, layer_id: i32)
pub fn remove_occluder_polygon(&mut self, layer_id: i32, polygon_index: i32)
pub fn set_occluder_polygon( &mut self, layer_id: i32, polygon_index: i32, polygon: impl AsArg<Option<Gd<OccluderPolygon2D>>>, )
pub fn get_occluder_polygon(
&self,
layer_id: i32,
polygon_index: i32,
) -> Option<Gd<OccluderPolygon2D>>
pub fn get_occluder_polygon( &self, layer_id: i32, polygon_index: i32, ) -> Option<Gd<OccluderPolygon2D>>
To set the default parameters, use Self::get_occluder_polygon_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_occluder_polygon_ex<'a>( &'a self, layer_id: i32, polygon_index: i32, ) -> ExGetOccluderPolygon<'a>
pub fn set_occluder( &mut self, layer_id: i32, occluder_polygon: impl AsArg<Option<Gd<OccluderPolygon2D>>>, )
pub fn get_occluder(&self, layer_id: i32) -> Option<Gd<OccluderPolygon2D>>
pub fn get_occluder(&self, layer_id: i32) -> Option<Gd<OccluderPolygon2D>>
To set the default parameters, use Self::get_occluder_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_occluder_ex<'a>(&'a self, layer_id: i32) -> ExGetOccluder<'a>
pub fn set_constant_linear_velocity(&mut self, layer_id: i32, velocity: Vector2)
pub fn get_constant_linear_velocity(&self, layer_id: i32) -> Vector2
pub fn set_constant_angular_velocity(&mut self, layer_id: i32, velocity: f32)
pub fn get_constant_angular_velocity(&self, layer_id: i32) -> f32
pub fn set_collision_polygons_count( &mut self, layer_id: i32, polygons_count: i32, )
pub fn get_collision_polygons_count(&self, layer_id: i32) -> i32
pub fn add_collision_polygon(&mut self, layer_id: i32)
pub fn remove_collision_polygon(&mut self, layer_id: i32, polygon_index: i32)
pub fn set_collision_polygon_points( &mut self, layer_id: i32, polygon_index: i32, polygon: &PackedArray<Vector2>, )
pub fn get_collision_polygon_points( &self, layer_id: i32, polygon_index: i32, ) -> PackedArray<Vector2>
pub fn set_collision_polygon_one_way( &mut self, layer_id: i32, polygon_index: i32, one_way: bool, )
pub fn is_collision_polygon_one_way( &self, layer_id: i32, polygon_index: i32, ) -> bool
pub fn set_collision_polygon_one_way_margin( &mut self, layer_id: i32, polygon_index: i32, one_way_margin: f32, )
pub fn get_collision_polygon_one_way_margin( &self, layer_id: i32, polygon_index: i32, ) -> f32
pub fn set_terrain_set(&mut self, terrain_set: i32)
pub fn get_terrain_set(&self) -> i32
pub fn set_terrain(&mut self, terrain: i32)
pub fn get_terrain(&self) -> i32
pub fn set_terrain_peering_bit( &mut self, peering_bit: CellNeighbor, terrain: i32, )
pub fn get_terrain_peering_bit(&self, peering_bit: CellNeighbor) -> i32
pub fn is_valid_terrain_peering_bit(&self, peering_bit: CellNeighbor) -> bool
To set the default parameters, use Self::get_navigation_polygon_ex
and its builder methods. See the book for detailed usage instructions.
pub fn set_probability(&mut self, probability: f32)
pub fn get_probability(&self) -> f32
pub fn set_custom_data( &mut self, layer_name: impl AsArg<GString>, value: &Variant, )
pub fn get_custom_data(&self, layer_name: impl AsArg<GString>) -> Variant
pub fn has_custom_data(&self, layer_name: impl AsArg<GString>) -> bool
pub fn set_custom_data_by_layer_id(&mut self, layer_id: i32, value: &Variant)
pub fn get_custom_data_by_layer_id(&self, layer_id: i32) -> Variant
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl GodotClass for TileData
impl GodotClass for TileData
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<Object> for TileData
impl Inherits<Object> for TileData
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for TileData
impl WithSignals for TileData
§type SignalCollection<'c, C: WithSignals> = SignalsOfTileData<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfTileData<'c, C>
impl GodotDefault for TileData
Auto Trait Implementations§
impl Freeze for TileData
impl RefUnwindSafe for TileData
impl !Send for TileData
impl !Sync for TileData
impl Unpin for TileData
impl UnwindSafe for TileData
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more