Differences

This shows you the differences between two versions of the page.

--- hide_widget [2020/12/05 20:35] – justin
+++ hide_widget [2023/11/06 14:31] (current) – justin
@@ Line 2: / Line 2: @@
 ----
-Hides the widget with the specified widget ID.
+Hides the widget with the specified widget ID (with an optional fade out over a duration of time).
 ====Signature:====
 <code python>
-hide_widget(widget_id)
+hide_widget(widget_id, fade_out_length)
 </code>
 ^Argument^Description^Type^Required^
 |widget_id|ID of the widget (as defined in the [[Widget Editor]]).|[[String]]|Yes|
+|fade_out_length|Length of the fade out effect (in seconds).|[[Number]]|No|
 ====Example:====
 <code bauxite>
-hide_widget("my_widget")
+hide_widget("my_widget", 1);
 </code>
-//Results:// The widget with an ID of "my_widget" will be hidden.
+//Results:// The widget with an ID of "my_widget" will be hidden, fading out over 1 second.
 ----

RPG in a BoxOfficial Documentation