#[repr(C)]pub struct TileFlags(/* private fields */);
Expand description
These bitflags are found in many of the tile types found in tilemap layers. Note that the naming of the flags is very confusing and it is almost never a good idea to edit them directly. Use the helper methods instead, as they will have much more expected behavior!
The big issue is that while Tile
s from TilesLayer
s have 8 valid orientations,
directional tiles from physics layers (that contain TileFlag
s) only have 4 valid: Up, Down Left and Right.
Up is the default orientation of a physics tile.
While this could’ve been no issue, directional physics tiles actually have broken physics when in another state.
Implementations§
source§impl TileFlags
impl TileFlags
sourcepub fn flip_x(&mut self)
pub fn flip_x(&mut self)
Mirrors the tile, switches left <-> right. Doesn’t work with directional physics tiles!
Use TileFlips::flip_x instead!
sourcepub fn flip_y(&mut self)
pub fn flip_y(&mut self)
Mirrors the tile vertically, switches up <-> down. Doesn’t work with directional physics tiles!
Use TileFlips::flip_y instead!
sourcepub fn rotate_cw(&mut self)
pub fn rotate_cw(&mut self)
Performs a 90° clockwise rotation.
For generic programming, use TileFlips::rotate_cw instead!
sourcepub fn rotate_ccw(&mut self)
pub fn rotate_ccw(&mut self)
Performs a 90° counterclockwise rotation.
For generic programming, use TileFlips::rotate_ccw instead!
sourcepub fn flip_x_physics(&mut self)
pub fn flip_x_physics(&mut self)
In contrast to the TilesLayer
, the directional tiles of physics layers only have 4 valid rotation.
The rotate methods keep the correct state, flip_h
and flip_v
on the other hand don’t.
sourcepub fn flip_y_physics(&mut self)
pub fn flip_y_physics(&mut self)
In contrast to the TilesLayer
, the directional tiles of physics layers only have 4 valid rotation.
The rotate methods keep the correct state, flip_h
and flip_v
on the other hand don’t.
source§impl TileFlags
impl TileFlags
source§impl TileFlags
impl TileFlags
sourcepub const fn bits(&self) -> u8
pub const fn bits(&self) -> u8
Get the underlying bits value.
The returned value is exactly the bits set in this flags value.
sourcepub const fn from_bits(bits: u8) -> Option<Self>
pub const fn from_bits(bits: u8) -> Option<Self>
Convert from a bits value.
This method will return None
if any unknown bits are set.
sourcepub const fn from_bits_truncate(bits: u8) -> Self
pub const fn from_bits_truncate(bits: u8) -> Self
Convert from a bits value, unsetting any unknown bits.
sourcepub const fn from_bits_retain(bits: u8) -> Self
pub const fn from_bits_retain(bits: u8) -> Self
Convert from a bits value exactly.
sourcepub fn from_name(name: &str) -> Option<Self>
pub fn from_name(name: &str) -> Option<Self>
Get a flags value with the bits of a flag with the given name set.
This method will return None
if name
is empty or doesn’t
correspond to any named flag.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Whether any set bits in a source flags value are also set in a target flags value.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Whether all set bits in a source flags value are also set in a target flags value.
sourcepub fn remove(&mut self, other: Self)
pub fn remove(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
remove
won’t truncate other
, but the !
operator will.
sourcepub fn toggle(&mut self, other: Self)
pub fn toggle(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Call insert
when value
is true
or remove
when value
is false
.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
The bitwise and (&
) of the bits in two flags values.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
The bitwise or (|
) of the bits in two flags values.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
The bitwise exclusive-or (^
) of the bits in two flags values.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
The bitwise negation (!
) of the bits in a flags value, truncating the result.
source§impl TileFlags
impl TileFlags
sourcepub const fn iter(&self) -> Iter<TileFlags>
pub const fn iter(&self) -> Iter<TileFlags>
Yield a set of contained flags values.
Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.
sourcepub const fn iter_names(&self) -> IterNames<TileFlags>
pub const fn iter_names(&self) -> IterNames<TileFlags>
Yield a set of contained named flags values.
This method is like iter
, except only yields bits in contained named flags.
Any unknown bits, or bits not corresponding to a contained flag will not be yielded.
Trait Implementations§
source§impl BitAndAssign for TileFlags
impl BitAndAssign for TileFlags
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
The bitwise and (&
) of the bits in two flags values.
source§impl BitOrAssign for TileFlags
impl BitOrAssign for TileFlags
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
The bitwise or (|
) of the bits in two flags values.
source§impl BitXorAssign for TileFlags
impl BitXorAssign for TileFlags
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
The bitwise exclusive-or (^
) of the bits in two flags values.
source§impl<'de> Deserialize<'de> for TileFlags
impl<'de> Deserialize<'de> for TileFlags
source§fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
__D: Deserializer<'de>,
source§impl Extend<TileFlags> for TileFlags
impl Extend<TileFlags> for TileFlags
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
The bitwise or (|
) of the bits in each flags value.
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl Flags for TileFlags
impl Flags for TileFlags
source§fn from_bits_retain(bits: u8) -> TileFlags
fn from_bits_retain(bits: u8) -> TileFlags
source§fn from_bits_truncate(bits: Self::Bits) -> Self
fn from_bits_truncate(bits: Self::Bits) -> Self
source§fn from_name(name: &str) -> Option<Self>
fn from_name(name: &str) -> Option<Self>
source§fn iter_names(&self) -> IterNames<Self>
fn iter_names(&self) -> IterNames<Self>
source§fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
fn intersects(&self, other: Self) -> boolwhere
Self: Sized,
source§fn contains(&self, other: Self) -> boolwhere
Self: Sized,
fn contains(&self, other: Self) -> boolwhere
Self: Sized,
source§fn insert(&mut self, other: Self)where
Self: Sized,
fn insert(&mut self, other: Self)where
Self: Sized,
|
) of the bits in two flags values.source§fn remove(&mut self, other: Self)where
Self: Sized,
fn remove(&mut self, other: Self)where
Self: Sized,
&!
). Read moresource§fn toggle(&mut self, other: Self)where
Self: Sized,
fn toggle(&mut self, other: Self)where
Self: Sized,
^
) of the bits in two flags values.source§fn intersection(self, other: Self) -> Self
fn intersection(self, other: Self) -> Self
&
) of the bits in two flags values.source§fn difference(self, other: Self) -> Self
fn difference(self, other: Self) -> Self
&!
). Read moresource§fn symmetric_difference(self, other: Self) -> Self
fn symmetric_difference(self, other: Self) -> Self
^
) of the bits in two flags values.source§fn complement(self) -> Self
fn complement(self) -> Self
!
) of the bits in a flags value, truncating the result.source§impl FromIterator<TileFlags> for TileFlags
impl FromIterator<TileFlags> for TileFlags
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
The bitwise or (|
) of the bits in each flags value.
source§impl IntoIterator for TileFlags
impl IntoIterator for TileFlags
source§impl PartialEq for TileFlags
impl PartialEq for TileFlags
source§impl Sub for TileFlags
impl Sub for TileFlags
source§impl SubAssign for TileFlags
impl SubAssign for TileFlags
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
The intersection of a source flags value with the complement of a target flags value (&!
).
This method is not equivalent to self & !other
when other
has unknown bits set.
difference
won’t truncate other
, but the !
operator will.