From 508885dfcedf97b7fd5e36d7c42f21ce3f522b7e Mon Sep 17 00:00:00 2001
From: lL1l1 <82986251+lL1l1@users.noreply.github.com>
Date: Thu, 12 Dec 2024 01:07:39 -0800
Subject: [PATCH] Annotate `AddBlinkyBox` (#6577)

---
 changelog/snippets/other.6577.md | 1 +
 engine/User.lua                  | 4 ++--
 2 files changed, 3 insertions(+), 2 deletions(-)
 create mode 100644 changelog/snippets/other.6577.md

diff --git a/changelog/snippets/other.6577.md b/changelog/snippets/other.6577.md
new file mode 100644
index 0000000000..1a53a6e6b3
--- /dev/null
+++ b/changelog/snippets/other.6577.md
@@ -0,0 +1 @@
+- (#6577) Annotate `AddBlinkyBox`. This UI-side global engine function makes a unit's selection box blink for some time.
diff --git a/engine/User.lua b/engine/User.lua
index e80673bc60..ef83854aaf 100644
--- a/engine/User.lua
+++ b/engine/User.lua
@@ -124,8 +124,8 @@
 --- | 'NUMPAD_DECIMAL'
 --- | 'NUMPAD_DIVIDE'
 
---- No clue what this does
----@param entityId number
+--- Repeatedly the selection box of the unit to the hovered-over state to create a blinking effect
+---@param entityId EntityId
 ---@param onTime number
 ---@param offTime number
 ---@param totalTime number