From c5f470ed2e0eb0ef3a4f8b9733669b803418f254 Mon Sep 17 00:00:00 2001 From: dusk Date: Fri, 6 Dec 2024 22:38:57 +0300 Subject: [PATCH] docs: add clarification about units to properties --- rust/src/boid/boid_properties.rs | 3 +++ rust/src/flock/flock_properties.rs | 3 +++ 2 files changed, 6 insertions(+) diff --git a/rust/src/boid/boid_properties.rs b/rust/src/boid/boid_properties.rs index 2bec1f1..e065859 100644 --- a/rust/src/boid/boid_properties.rs +++ b/rust/src/boid/boid_properties.rs @@ -3,6 +3,9 @@ use godot::prelude::*; #[derive(Default, Clone, Debug, GodotClass)] #[class(init, base=Resource)] /// 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 { #[export] #[init(val = 4.0)] diff --git a/rust/src/flock/flock_properties.rs b/rust/src/flock/flock_properties.rs index da7ca65..7346847 100644 --- a/rust/src/flock/flock_properties.rs +++ b/rust/src/flock/flock_properties.rs @@ -3,6 +3,9 @@ use godot::prelude::*; #[derive(Default, Clone, Debug, GodotClass)] #[class(tool, init, base=Resource)] /// 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 { #[export] #[init(val = 625.0)]