Package lol.pyr.znpcsplus.api.npc

Interface NpcEntry

public interface NpcEntry
Base class for all NPC entries An NPC entry is a wrapper around an NPC that contains additional information

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    enableEverything()
    Enables everything for this NPC entry That is, it makes the NPC processed, saveable, and allows command modification
    String
    getId()
    Gets the ID of this NPC entry
    Npc
    getNpc()
    Gets the NPC of this NPC entry
    boolean
    isAllowCommandModification()
    Gets if this NPC can be modified by commands
    boolean
    isProcessed()
    Gets if this NPC entry is processed or not
    boolean
    isSave()
     
    void
    setAllowCommandModification(boolean value)
    Sets if this NPC can be modified by commands
    void
    setProcessed(boolean value)
    Sets if this NPC entry is processed or not
    void
    setSave(boolean value)
    Sets if this NPC should be saved or not

  • Method Details

    • getId

      String getId()
      Gets the ID of this NPC entry
      Returns:
      The ID of this NPC entry

    • getNpc

      Npc getNpc()
      Gets the NPC of this NPC entry
      Returns:
      The Npc of this NPC entry

    • isProcessed

      boolean isProcessed()
      Gets if this NPC entry is processed or not
      Returns:
      If this NPC entry is processed or not

    • setProcessed

      void setProcessed(boolean value)
      Sets if this NPC entry is processed or not
      Parameters:
      value - If this NPC entry is processed or not

    • isSave

      boolean isSave()
      Returns:
      If this NPC entry SHOULD be saved into the storage or not

    • setSave

      void setSave(boolean value)
      Sets if this NPC should be saved or not
      Parameters:
      value - If this NPC entry should be saved or not

    • isAllowCommandModification

      boolean isAllowCommandModification()
      Gets if this NPC can be modified by commands
      Returns:
      true if this NPC can be modified by commands, false otherwise

    • setAllowCommandModification

      void setAllowCommandModification(boolean value)
      Sets if this NPC can be modified by commands
      Parameters:
      value - true if this NPC can be modified by commands, false otherwise

    • enableEverything

      void enableEverything()
      Enables everything for this NPC entry That is, it makes the NPC processed, saveable, and allows command modification