From 5bf72468f3a0925a9fc3c9acacf3f6e138bff35e Mon Sep 17 00:00:00 2001
From: SmallJoker <SmallJoker@users.noreply.github.com>
Date: Sat, 29 May 2021 11:44:48 +0200
Subject: UnitSAO: Prevent circular attachments

---
 doc/lua_api.txt | 2 ++
 1 file changed, 2 insertions(+)

(limited to 'doc')

diff --git a/doc/lua_api.txt b/doc/lua_api.txt
index ef86efcc1..6c7ae0fb5 100644
--- a/doc/lua_api.txt
+++ b/doc/lua_api.txt
@@ -6314,6 +6314,8 @@ object you are working with still exists.
       Default `{x=0, y=0, z=0}`
     * `forced_visible`: Boolean to control whether the attached entity
        should appear in first person. Default `false`.
+    * This command may fail silently (do nothing) when it would result
+      in circular attachments.
 * `get_attach()`: returns parent, bone, position, rotation, forced_visible,
     or nil if it isn't attached.
 * `get_children()`: returns a list of ObjectRefs that are attached to the
-- 
cgit v1.2.3