Annotate AddBlinkyBox (#6577)

FAForever · Dec 12, 2024 · 508885d · 508885d
1 parent 8f68350
commit 508885d
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/changelog/snippets/other.6577.md 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
@@ -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
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		- (#6577) Annotate `AddBlinkyBox`. This UI-side global engine function makes a unit's selection box blink for some time.