Package net.playavalon.mythicdungeons.api

Interface MythicDungeonsService

All Known Implementing Classes:
MythicDungeons
public interface MythicDungeonsService

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    acceptPartyInvite(org.bukkit.entity.Player target)
    Accepts the pending party invite for a player if one exists.
    boolean
    createParty(org.bukkit.entity.Player target)
    Creates a party for a player.
    boolean
    declinePartyInvite(org.bukkit.entity.Player target)
    Declines the pending party invite for a player if one exists.
    boolean
    disbandParty(MythicParty party)
    Disbands a party.
    boolean
    disbandParty(org.bukkit.entity.Player target)
    Disbands the party that a player is a part of.
    Collection<Dungeon>
    getAllDungeons()
    Get all registered dungeon objects.
    Instance
    getDungeonInstance(String worldName)
    Get the dungeon instance associated with the passed in world name.
    Instance
    getDungeonInstance(org.bukkit.entity.Player player)
    Returns the instance the player is in.
    MythicParty
    getParty(org.bukkit.entity.Player player)
    Returns the party that a player is in.
    boolean
    initiateDungeonForPlayer(org.bukkit.entity.Player player, String dungeonName)
    Initiate a dungeon instance for a player (and coordinating party) based on the dungeon name.
    boolean
    inviteToParty(org.bukkit.entity.Player source, org.bukkit.entity.Player target)
    Invites a player to a party based on the inviter's party.
    String
    isPartyQueuedForDungeon(IDungeonParty party)
    Returns the party that a player is in.
    String
    isPartyQueuedForDungeon(org.bukkit.entity.Player player)
    Returns the party that a player is in.
    boolean
    isPlayerInDungeon(org.bukkit.entity.Player player)
    Returns true if the player is in a dungeon.
    boolean
    removeFromParty(org.bukkit.entity.Player target)
    Removes a player from the current party they are in.
    boolean
    setPartyLeader(org.bukkit.entity.Player player)
    Sets the party leader for a player's party.

  • Method Details

    • isPlayerInDungeon

      boolean isPlayerInDungeon(org.bukkit.entity.Player player)
      Returns true if the player is in a dungeon.
      Parameters:
      player - The player to check.

    • getDungeonInstance

      Instance getDungeonInstance(org.bukkit.entity.Player player)
      Returns the instance the player is in.
      Parameters:
      player - The player to check for.
      Returns:
      The instance the player is in, or null if not in a dungeon.

    • initiateDungeonForPlayer

      boolean initiateDungeonForPlayer(org.bukkit.entity.Player player, String dungeonName)
      Initiate a dungeon instance for a player (and coordinating party) based on the dungeon name.
      Parameters:
      player - The player to initiate for.
      dungeonName - The name of the dungeon to initiate.
      Returns:
      True if the player successfully initiated a dungeon instance, else false.

    • getDungeonInstance

      Instance getDungeonInstance(String worldName)
      Get the dungeon instance associated with the passed in world name.
      Parameters:
      worldName -
      Returns:
      The dungeon instance associated with the passed in world name, or null if not found.

    • getAllDungeons

      Collection<Dungeon> getAllDungeons()
      Get all registered dungeon objects.
      Returns:
      A collection of all the registered dungeons on the server.

    • createParty

      boolean createParty(org.bukkit.entity.Player target)
      Creates a party for a player.
      Parameters:
      target - The player to create a party for.
      Returns:
      True if the player was successfully added to a party, else false.

    • removeFromParty

      boolean removeFromParty(org.bukkit.entity.Player target)
      Removes a player from the current party they are in.
      Parameters:
      target - The player to remove from the party they are currently in.
      Returns:
      True if the player was successfully removed from their party, else false.

    • disbandParty

      boolean disbandParty(MythicParty party)
      Disbands a party.
      Parameters:
      party - The party to disband.
      Returns:
      True if the party was successfully disbanded, else false.

    • disbandParty

      boolean disbandParty(org.bukkit.entity.Player target)
      Disbands the party that a player is a part of. NOTE: This will effectively remove ALL players that are in a party from that party!
      Parameters:
      target - The player to disband the party for.
      Returns:
      True if the party was successfully disbanded, else false.

    • inviteToParty

      boolean inviteToParty(org.bukkit.entity.Player source, org.bukkit.entity.Player target)
      Invites a player to a party based on the inviter's party.
      Parameters:
      source - The player who owns the party to invite to.
      target - The player to invite to the party.
      Returns:
      True if the player was successfully invited to the party, else false.

    • acceptPartyInvite

      boolean acceptPartyInvite(org.bukkit.entity.Player target)
      Accepts the pending party invite for a player if one exists.
      Parameters:
      target - The player to accept the party invite for.
      Returns:
      True if the player successfully accepted a pending party invite, else false.

    • declinePartyInvite

      boolean declinePartyInvite(org.bukkit.entity.Player target)
      Declines the pending party invite for a player if one exists.
      Parameters:
      target - The player to decline the party invite for.
      Returns:
      True if the player successfully declined a pending party invite, else false.

    • setPartyLeader

      boolean setPartyLeader(org.bukkit.entity.Player player)
      Sets the party leader for a player's party.
      Parameters:
      player - The player to set as party leader of their party.
      Returns:
      True if the player successfully set the party leader, else false.

    • getParty

      MythicParty getParty(org.bukkit.entity.Player player)
      Returns the party that a player is in.
      Parameters:
      player - The player to get the party from.
      Returns:
      The party that the player is in, or null if the player is not in a party.

    • isPartyQueuedForDungeon

      @Nullable String isPartyQueuedForDungeon(org.bukkit.entity.Player player)
      Returns the party that a player is in.
      Parameters:
      player - The player to check their party's queue status for.
      Returns:
      The dungeon name for the dungeon the party is queued for, otherwise null.

    • isPartyQueuedForDungeon

      @Nullable String isPartyQueuedForDungeon(IDungeonParty party)
      Returns the party that a player is in.
      Parameters:
      party - The party to check the queue status for.
      Returns:
      The dungeon name for the dungeon the party is queued for, otherwise null.