Package noppes.npcs.api.handler.data

Interface IParty

  • public interface IParty

    • Method Detail

      • getPartyUUIDString

        java.lang.String getPartyUUIDString()
        Returns:
        UUID of Party

      • getIsLocked

        boolean getIsLocked()
        Returns:
        if party is locked (quest is set)

      • setQuest

        void setQuest​(IQuest quest)
        Set a quest to the party (this does not validate use validateQuest())
        Parameters:
        quest - Quest Object

      • getQuest

        IQuest getQuest()
        Get the Quest for the Party, can be null
        Returns:
        quest

      • getCurrentQuestID

        int getCurrentQuestID()
        Get the Quest ID for Party | -1 if no quest
        Returns:
        quest id

      • getCurrentQuestName

        java.lang.String getCurrentQuestName()
        Get the Quest Name for Party | BLANK if no quest
        Returns:
        quest name

      • addPlayer

        boolean addPlayer​(java.lang.String playerName)
        Parameters:
        playerName - Username of Player (Case Sensitive)
        Returns:
        successful or not

      • removePlayer

        boolean removePlayer​(java.lang.String playerName)
        Parameters:
        playerName - Username of Player (Case Sensitive)
        Returns:
        successful or not

      • addPlayer

        boolean addPlayer​(IPlayer player)
        Parameters:
        player - IPlayer
        Returns:
        successful or not

      • removePlayer

        boolean removePlayer​(IPlayer player)
        Parameters:
        player - IPlayer
        Returns:
        successful or not

      • hasPlayer

        boolean hasPlayer​(IPlayer player)
        Check if Player is in Party with IPlayer
        Returns:
        true/false if player is in party

      • hasPlayer

        boolean hasPlayer​(java.lang.String playerName)
        Check if Player is in Party with Player Name
        Returns:
        true/false if player is in party

      • getPartyLeaderName

        java.lang.String getPartyLeaderName()
        Returns:
        Party Leader's Name

      • getPlayerNamesList

        java.util.List<java.lang.String> getPlayerNamesList()
        Returns:
        Collection of all Player Names in Party

      • validateQuest

        boolean validateQuest​(int questID,
                      boolean sendLeaderMessages)
        Parameters:
        questID - ID for the Quest to Verify
        sendLeaderMessages - IF true will send ERROR message to Party Leader on why the quest could not be set
        Returns:
        true/false if the party CAN have the quest set

      • toggleFriendlyFire

        void toggleFriendlyFire()
        Toggles Friendly Fire

      • friendlyFire

        boolean friendlyFire()
        Returns:
        Current Friendly Fire settings in Party

      • updateQuestObjectiveData

        void updateQuestObjectiveData()
        Sends information for Quest Objectives to all Party Participants [Lower Data]

      • updatePartyData

        void updatePartyData()
        Sends all PARTY INFORMATION to all Party Participants [Higher Data]