docs: add clarification about units to properties

This commit is contained in:
dusk 2024-12-06 22:38:57 +03:00
parent 99c1248d9c
commit c5f470ed2e
Signed by: dusk
SSH Key Fingerprint: SHA256:Abmvag+juovVufZTxyWY8KcVgrznxvBjQpJesv071Aw
2 changed files with 6 additions and 0 deletions

View File

@ -3,6 +3,9 @@ use godot::prelude::*;
#[derive(Default, Clone, Debug, GodotClass)] #[derive(Default, Clone, Debug, GodotClass)]
#[class(init, base=Resource)] #[class(init, base=Resource)]
/// Properties for a 2D/3D boid. /// Properties for a 2D/3D boid.
///
/// Note that these properties are used as is and do not get scaled / translated between 2D / 3D units.
/// So copying 2D properties to a 3D boid will *not* behave the same.
pub struct BoidProperties { pub struct BoidProperties {
#[export] #[export]
#[init(val = 4.0)] #[init(val = 4.0)]

View File

@ -3,6 +3,9 @@ use godot::prelude::*;
#[derive(Default, Clone, Debug, GodotClass)] #[derive(Default, Clone, Debug, GodotClass)]
#[class(tool, init, base=Resource)] #[class(tool, init, base=Resource)]
/// Properties for a 2D/3D flock. /// Properties for a 2D/3D flock.
///
/// Note that these properties are used as is and do not get scaled / translated between 2D / 3D units.
/// So copying 2D properties to a 3D flock will *not* behave the same.
pub struct FlockProperties { pub struct FlockProperties {
#[export] #[export]
#[init(val = 625.0)] #[init(val = 625.0)]