api: add clan ids and accessors

This commit is contained in:
Adam
2021-09-28 14:49:27 -04:00
parent c1f442e36e
commit 8d537cabf1
3 changed files with 56 additions and 0 deletions

View File

@@ -86,6 +86,7 @@
<configuration>
<classifier>runtime</classifier>
<excludes>
<exclude>net/runelite/api/clan/ClanID.class</exclude>
<exclude>net/runelite/api/AnimationID.class</exclude>
<exclude>net/runelite/api/EnumID.class</exclude>
<exclude>net/runelite/api/FontID.class</exclude>

View File

@@ -1916,4 +1916,22 @@ public interface Client extends GameEngine
*/
@Nullable
ClanSettings getGuestClanSettings();
/**
* Get clan channel by id.
* @param clanId the clan id
* @return
* @see net.runelite.api.clan.ClanID
*/
@Nullable
ClanChannel getClanChannel(int clanId);
/**
* Get clan settings by id
* @param clanId the clan id
* @return
* @see net.runelite.api.clan.ClanID
*/
@Nullable
ClanSettings getClanSettings(int clanId);
}

View File

@@ -0,0 +1,37 @@
/*
* Copyright (c) 2021, 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.clan;
public final class ClanID
{
/**
* The primary clan.
*/
public static final int CLAN = 0;
/**
* The group ironman clan.
*/
public static final int GROUP_IRONMAN = 1;
}