From ff99cefc647f9215ad1cdc9f408c9fc655b45706 Mon Sep 17 00:00:00 2001
From: Kelly Rauchenberger <fefferburbia@gmail.com>
Date: Fri, 4 May 2018 10:26:07 -0400
Subject: Added a comment to TransformableComponent describing the ferrying
 stipulation

---
 src/components/transformable.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'src')

diff --git a/src/components/transformable.h b/src/components/transformable.h
index 3296e49..6f3c2ef 100644
--- a/src/components/transformable.h
+++ b/src/components/transformable.h
@@ -8,6 +8,12 @@ public:
 
   /**
    * The coordinates of the entity.
+   *
+   * Note that ponderable entities sometimes have special behavior related to
+   * their coordinates, specifically that ferried bodies will behave oddly if
+   * their coordinates are changed outside of the PonderingSystem. Before doing
+   * so, use PonderingSystem::unferry on the body to ensure that it is not
+   * ferried.
    */
   double x;
   double y;
-- 
cgit 1.4.1