Struct Flags 

pub struct Flags { /* private fields */ }

Boolean flags controlling entity behavior and visibility.

This structure contains various flags that control how entities (buildings, props, etc.) behave in the game, including placement rules, seasonal visibility, and tactical view settings.

Flag Categories

Placement Flags

• allow_in_outfield: Entity can be placed outside the playable area
• clamp_to_surface: Entity position is clamped to terrain surface
• clamp_to_water_surface: Entity position is clamped to water surface

Seasonal Flags

• spring, summer, autumn, winter: Entity is visible in specified seasons

Visibility Flags

• visible_in_tactical_view: Entity is visible in tactical camera view
• visible_in_tactical_view_only: Entity is only visible in tactical view

Example

use rpfm_lib::files::bmd::common::flags::Flags;

let mut flags = Flags::default();
flags.set_serialise_version(4);
flags.set_spring(true);
flags.set_summer(true);
flags.set_clamp_to_surface(true);
flags.set_visible_in_tactical_view(true);

Implementations

impl Flags

pub fn serialise_version(&self) -> &u16

Format version number (1-4).

pub fn allow_in_outfield(&self) -> &bool

Whether the entity can be placed in the outfield (outside playable area).

pub fn clamp_to_surface(&self) -> &bool

Whether the entity position is clamped to the terrain surface.

pub fn clamp_to_water_surface(&self) -> &bool

Whether the entity position is clamped to the water surface.

pub fn spring(&self) -> &bool

Whether the entity is visible during spring season.

pub fn summer(&self) -> &bool

Whether the entity is visible during summer season.

pub fn autumn(&self) -> &bool

Whether the entity is visible during autumn season.

pub fn winter(&self) -> &bool

Whether the entity is visible during winter season.

pub fn visible_in_tactical_view(&self) -> &bool

Whether the entity is visible in tactical camera view.

pub fn visible_in_tactical_view_only(&self) -> &bool

Whether the entity is only visible in tactical view (hidden in normal view).

impl Flags

pub fn serialise_version_mut(&mut self) -> &mut u16

Format version number (1-4).

pub fn allow_in_outfield_mut(&mut self) -> &mut bool

Whether the entity can be placed in the outfield (outside playable area).

pub fn clamp_to_surface_mut(&mut self) -> &mut bool

Whether the entity position is clamped to the terrain surface.

pub fn clamp_to_water_surface_mut(&mut self) -> &mut bool

Whether the entity position is clamped to the water surface.

pub fn spring_mut(&mut self) -> &mut bool

Whether the entity is visible during spring season.

pub fn summer_mut(&mut self) -> &mut bool

Whether the entity is visible during summer season.

pub fn autumn_mut(&mut self) -> &mut bool

Whether the entity is visible during autumn season.

pub fn winter_mut(&mut self) -> &mut bool

Whether the entity is visible during winter season.

pub fn visible_in_tactical_view_mut(&mut self) -> &mut bool

Whether the entity is visible in tactical camera view.

pub fn visible_in_tactical_view_only_mut(&mut self) -> &mut bool

Whether the entity is only visible in tactical view (hidden in normal view).

impl Flags

pub fn set_serialise_version(&mut self, val: u16) -> &mut Self

Format version number (1-4).

pub fn set_allow_in_outfield(&mut self, val: bool) -> &mut Self

Whether the entity can be placed in the outfield (outside playable area).

pub fn set_clamp_to_surface(&mut self, val: bool) -> &mut Self

Whether the entity position is clamped to the terrain surface.

pub fn set_clamp_to_water_surface(&mut self, val: bool) -> &mut Self

Whether the entity position is clamped to the water surface.

pub fn set_spring(&mut self, val: bool) -> &mut Self

Whether the entity is visible during spring season.

pub fn set_summer(&mut self, val: bool) -> &mut Self

Whether the entity is visible during summer season.

pub fn set_autumn(&mut self, val: bool) -> &mut Self

Whether the entity is visible during autumn season.

pub fn set_winter(&mut self, val: bool) -> &mut Self

Whether the entity is visible during winter season.

pub fn set_visible_in_tactical_view(&mut self, val: bool) -> &mut Self

Whether the entity is visible in tactical camera view.

pub fn set_visible_in_tactical_view_only(&mut self, val: bool) -> &mut Self

Whether the entity is only visible in tactical view (hidden in normal view).

Trait Implementations

impl Clone for Flags

fn clone(&self) -> Flags

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Flags

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Decodeable for Flags

fn decode<R: ReadBytes>( data: &mut R, extra_data: &Option<DecodeableExtraData<'_>>, ) -> Result<Self>

Decodes binary data into the implementing type.

impl Default for Flags

fn default() -> Flags

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Flags

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encodeable for Flags

fn encode<W: WriteBytes>( &mut self, buffer: &mut W, extra_data: &Option<EncodeableExtraData<'_>>, ) -> Result<()>

Encodes the implementing type into binary data.

impl PartialEq for Flags

fn eq(&self, other: &Flags) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Flags

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Flags