api: re-implement WidgetHiddenChanged event

runelite-api/src/main/java/net/runelite/api/events/WidgetHiddenChanged.java

@@ -0,0 +1,44 @@
+/*
+ * Copyright (c) 2018, Adam <Adam@sigterm.info>
+ * All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice, this
+ *    list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this list of conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+ * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */
+package net.runelite.api.events;
+
+import net.runelite.api.widgets.Widget;
+import lombok.Data;
+
+/**
+ * An event where the hidden state of a {@link Widget} has been modified.
+ */
+@Data
+public class WidgetHiddenChanged implements Event
+{
+	/**
+	 * The affected widget.
+	 */
+	private Widget widget;
+	/**
+	 * The new hidden state of the widget.
+	 */
+	private boolean hidden;
+}

runelite-mixins/src/main/java/net/runelite/mixins/RSWidgetMixin.java

@@ -28,6 +28,7 @@ import net.runelite.api.HashTable;
 import net.runelite.api.Node;
 import net.runelite.api.Point;
 import net.runelite.api.WidgetNode;
+import net.runelite.api.events.WidgetHiddenChanged;
 import net.runelite.api.events.WidgetPositioned;
 import net.runelite.api.mixins.Copy;
 import net.runelite.api.mixins.FieldHook;
@@ -74,6 +75,48 @@ public abstract class RSWidgetMixin implements RSWidget
 		rl$y = -1;
 	}
 
+	@Inject
+	@Override
+	public void broadcastHidden(boolean hidden)
+	{
+		WidgetHiddenChanged event = new WidgetHiddenChanged();
+		event.setWidget(this);
+		event.setHidden(hidden);
+
+		client.getCallbacks().post(event);
+
+		RSWidget[] children = getChildren();
+
+		if (children != null)
+		{
+			// recursive through children
+			for (RSWidget child : children)
+			{
+				// if the widget is hidden it will not magically unhide from its parent changing
+				if (child == null || child.isSelfHidden())
+				{
+					continue;
+				}
+
+				child.broadcastHidden(hidden);
+			}
+		}
+
+		// make sure we iterate nested children as well
+		// cannot be null
+		Widget[] nestedChildren = getNestedChildren();
+
+		for (Widget nestedChild : nestedChildren)
+		{
+			if (nestedChild == null || nestedChild.isSelfHidden())
+			{
+				continue;
+			}
+
+			((RSWidget) nestedChild).broadcastHidden(hidden);
+		}
+	}
+
 	@Inject
 	@Override
 	public void setRenderParentId(int parentId)

runescape-api/src/main/java/net/runelite/rs/api/RSWidget.java

@@ -588,4 +588,6 @@ public interface RSWidget extends Widget
 	@Import("onVarTransmit")
 	@Override
 	void setOnVarTransmitListener(Object[] o);
+
+	void broadcastHidden(boolean hidden);
 }