Skip to main content

BattleTreeItem

rpfm_lib::files::bmd_vegetation::tree_list

Struct BattleTreeItem 

Source 
pub struct BattleTreeItem { /* private fields */ }
Expand description

Individual tree instance with position, rotation, and scale.

Represents a single tree placed on the battle map with its transform data. The rotation is compressed into a single byte representing Y-axis rotation.

§Fields

  • id - Unique identifier for this tree instance
  • x - X coordinate in world space
  • y - Y coordinate in world space (height)
  • z - Z coordinate in world space
  • rotation - Y-axis rotation compressed to 0-255 range (multiply by 1.40625 to get degrees)
  • scale - Uniform scale factor applied to all axes
  • flags - Behavior flags for this tree instance

§Examples

ⓘ
let tree = BattleTreeItem {
    id: 0x1609e7e52919a40,
    x: -22.92,
    y: 58.75,
    z: -3.01,
    rotation: 72,  // ~102 degrees when converted
    scale: 1.0,
    flags: 3,
};

Implementations§

Source§

impl BattleTreeItem

Source

pub fn id(&self) -> &u64

Unique identifier for this tree instance.

Source

pub fn x(&self) -> &f32

X coordinate in world space.

Source

pub fn y(&self) -> &f32

Y coordinate in world space (height).

Source

pub fn z(&self) -> &f32

Z coordinate in world space.

Source

pub fn rotation(&self) -> &u8

Y-axis rotation (0-255 maps to 0-360 degrees). Version 4 only.

To convert to degrees: rotation as f32 * 1.40625

Source

pub fn scale(&self) -> &f32

Uniform scale factor. In versions 1 to 3 it is stored as a byte, 127 being 1.0.

Source

pub fn flags(&self) -> &u8

Behavior flags for this tree instance. In versions 1 to 3 the byte is the tree’s is_freeform: 1 keeps the stored height, 0 puts the tree on the terrain.

Source

pub fn is_burnable(&self) -> &u8

Version 2 only: whether the tree can burn. Always 1 in Attila.

Source§

impl BattleTreeItem

Source

pub fn id_mut(&mut self) -> &mut u64

Unique identifier for this tree instance.

Source

pub fn x_mut(&mut self) -> &mut f32

X coordinate in world space.

Source

pub fn y_mut(&mut self) -> &mut f32

Y coordinate in world space (height).

Source

pub fn z_mut(&mut self) -> &mut f32

Z coordinate in world space.

Source

pub fn rotation_mut(&mut self) -> &mut u8

Y-axis rotation (0-255 maps to 0-360 degrees). Version 4 only.

To convert to degrees: rotation as f32 * 1.40625

Source

pub fn scale_mut(&mut self) -> &mut f32

Uniform scale factor. In versions 1 to 3 it is stored as a byte, 127 being 1.0.

Source

pub fn flags_mut(&mut self) -> &mut u8

Behavior flags for this tree instance. In versions 1 to 3 the byte is the tree’s is_freeform: 1 keeps the stored height, 0 puts the tree on the terrain.

Source

pub fn is_burnable_mut(&mut self) -> &mut u8

Version 2 only: whether the tree can burn. Always 1 in Attila.

Source§

impl BattleTreeItem

Source

pub fn set_id(&mut self, val: u64) -> &mut Self

Unique identifier for this tree instance.

Source

pub fn set_x(&mut self, val: f32) -> &mut Self

X coordinate in world space.

Source

pub fn set_y(&mut self, val: f32) -> &mut Self

Y coordinate in world space (height).

Source

pub fn set_z(&mut self, val: f32) -> &mut Self

Z coordinate in world space.

Source

pub fn set_rotation(&mut self, val: u8) -> &mut Self

Y-axis rotation (0-255 maps to 0-360 degrees). Version 4 only.

To convert to degrees: rotation as f32 * 1.40625

Source

pub fn set_scale(&mut self, val: f32) -> &mut Self

Uniform scale factor. In versions 1 to 3 it is stored as a byte, 127 being 1.0.

Source

pub fn set_flags(&mut self, val: u8) -> &mut Self

Behavior flags for this tree instance. In versions 1 to 3 the byte is the tree’s is_freeform: 1 keeps the stored height, 0 puts the tree on the terrain.

Source

pub fn set_is_burnable(&mut self, val: u8) -> &mut Self

Version 2 only: whether the tree can burn. Always 1 in Attila.

Trait Implementations§

Source§

impl Clone for BattleTreeItem

Source§

fn clone(&self) -> BattleTreeItem

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for BattleTreeItem

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for BattleTreeItem

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for BattleTreeItem

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for BattleTreeItem

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for BattleTreeItem

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for BattleTreeItem

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<R, P> ReadPrimitive<R> for P
where R: Read + ReadEndian<P>, P: Default,

Source§

fn read_from_little_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_little_endian().
Source§

fn read_from_big_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_big_endian().
Source§

fn read_from_native_endian(read: &mut R) -> Result<Self, Error>

Read this value from the supplied reader. Same as ReadEndian::read_from_native_endian().
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> Scalar for T
where T: 'static + Clone + PartialEq + Debug,

§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.