From facf438b5086ef8c2b0a042d50d1dcdff0e7ed24 Mon Sep 17 00:00:00 2001 From: Adam Date: Sat, 2 Mar 2019 18:59:05 -0500 Subject: [PATCH] api: add clan member join and leave events Co-authored-by: trimbe --- .../runelite/api/events/ClanMemberJoined.java | 36 ++++++++++ .../runelite/api/events/ClanMemberLeft.java | 36 ++++++++++ .../mixins/RSClanMemberManagerMixin.java | 58 +++++++++++++++ .../mixins/RSNameableContainerMixin.java | 72 +++++++++++++++++++ .../runelite/rs/api/RSNameableContainer.java | 13 ++++ 5 files changed, 215 insertions(+) create mode 100644 runelite-api/src/main/java/net/runelite/api/events/ClanMemberJoined.java create mode 100644 runelite-api/src/main/java/net/runelite/api/events/ClanMemberLeft.java create mode 100644 runelite-mixins/src/main/java/net/runelite/mixins/RSClanMemberManagerMixin.java create mode 100644 runelite-mixins/src/main/java/net/runelite/mixins/RSNameableContainerMixin.java diff --git a/runelite-api/src/main/java/net/runelite/api/events/ClanMemberJoined.java b/runelite-api/src/main/java/net/runelite/api/events/ClanMemberJoined.java new file mode 100644 index 0000000000..b8e50c6296 --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/events/ClanMemberJoined.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2018, trimbe + * 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 lombok.Value; + +@Value +public class ClanMemberJoined +{ + /** + * Name of the player who joined + */ + private String name; +} diff --git a/runelite-api/src/main/java/net/runelite/api/events/ClanMemberLeft.java b/runelite-api/src/main/java/net/runelite/api/events/ClanMemberLeft.java new file mode 100644 index 0000000000..6eb269dd6d --- /dev/null +++ b/runelite-api/src/main/java/net/runelite/api/events/ClanMemberLeft.java @@ -0,0 +1,36 @@ +/* + * Copyright (c) 2018, trimbe + * 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 lombok.Value; + +@Value +public class ClanMemberLeft +{ + /** + * Name of the player who left + */ + private String name; +} diff --git a/runelite-mixins/src/main/java/net/runelite/mixins/RSClanMemberManagerMixin.java b/runelite-mixins/src/main/java/net/runelite/mixins/RSClanMemberManagerMixin.java new file mode 100644 index 0000000000..b4c71dec2a --- /dev/null +++ b/runelite-mixins/src/main/java/net/runelite/mixins/RSClanMemberManagerMixin.java @@ -0,0 +1,58 @@ +/* + * Copyright (c) 2018, trimbe + * 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.mixins; + +import net.runelite.api.events.ClanMemberJoined; +import net.runelite.api.events.ClanMemberLeft; +import net.runelite.api.mixins.Inject; +import net.runelite.api.mixins.Mixin; +import net.runelite.api.mixins.Shadow; +import net.runelite.rs.api.RSClanMemberManager; +import net.runelite.rs.api.RSClient; +import net.runelite.rs.api.RSName; +import net.runelite.rs.api.RSNameable; + +@Mixin(RSClanMemberManager.class) +public abstract class RSClanMemberManagerMixin implements RSClanMemberManager +{ + @Shadow("clientInstance") + private static RSClient client; + + @Inject + @Override + public void rl$add(RSName name, RSName prevName) + { + ClanMemberJoined event = new ClanMemberJoined(name.getName()); + client.getCallbacks().post(event); + } + + @Inject + @Override + public void rl$remove(RSNameable nameable) + { + ClanMemberLeft event = new ClanMemberLeft(nameable.getRsName().getName()); + client.getCallbacks().post(event); + } +} diff --git a/runelite-mixins/src/main/java/net/runelite/mixins/RSNameableContainerMixin.java b/runelite-mixins/src/main/java/net/runelite/mixins/RSNameableContainerMixin.java new file mode 100644 index 0000000000..8a3a1492e0 --- /dev/null +++ b/runelite-mixins/src/main/java/net/runelite/mixins/RSNameableContainerMixin.java @@ -0,0 +1,72 @@ +/* + * Copyright (c) 2018, trimbe + * Copyright (c) 2019, Adam + * 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.mixins; + +import net.runelite.api.mixins.Inject; +import net.runelite.api.mixins.MethodHook; +import net.runelite.api.mixins.Mixin; +import net.runelite.rs.api.RSName; +import net.runelite.rs.api.RSNameable; +import net.runelite.rs.api.RSNameableContainer; + +@Mixin(RSNameableContainer.class) +public abstract class RSNameableContainerMixin implements RSNameableContainer +{ + /** + * Default implementation of rl$add + * @param name + * @param prevName + */ + @Inject + @Override + public void rl$add(RSName name, RSName prevName) + { + } + + /** + * Default implementation of rl$del + * @param nameable + */ + @Inject + @Override + public void rl$remove(RSNameable nameable) + { + } + + @Inject + @MethodHook(value = "add", end = true) + public void add(RSName name, RSName prevName) + { + rl$add(name, prevName); + } + + @Inject + @MethodHook("remove") + public void remove(RSNameable nameable) + { + rl$remove(nameable); + } +} diff --git a/runescape-api/src/main/java/net/runelite/rs/api/RSNameableContainer.java b/runescape-api/src/main/java/net/runelite/rs/api/RSNameableContainer.java index 18494e5a79..82fb52d9d4 100644 --- a/runescape-api/src/main/java/net/runelite/rs/api/RSNameableContainer.java +++ b/runescape-api/src/main/java/net/runelite/rs/api/RSNameableContainer.java @@ -36,4 +36,17 @@ public interface RSNameableContainer @Import("isMember") boolean isMember(RSName var1); + + /** + * Method called by the container when an element is added + * @param name + * @param prevName + */ + void rl$add(RSName name, RSName prevName); + + /** + * Method called by the container when an element is removed + * @param nameable + */ + void rl$remove(RSNameable nameable); }