Package noppes.npcs.api.handler.data

Interface IMagicCycle

  • public interface IMagicCycle
    Represents a cycle (or category) grouping for magics. A magic cycle holds ordering and display information as well as associations to multiple magics.

    • Method Detail

      • getId

        int getId()
        Gets the unique identifier of this magic cycle.
        Returns:
        the cycle ID

      • getName

        String getName()
        Gets the internal name of the magic cycle.
        Returns:
        the name of the cycle

      • setName

        void setName​(String name)
        Sets the internal name of the magic cycle.
        Parameters:
        name - the new name of the cycle

      • getDisplayName

        String getDisplayName()
        Gets the display name of the magic cycle.
        Returns:
        the display name for the cycle

      • setDisplayName

        void setDisplayName​(String displayName)
        Sets the display name of the magic cycle.
        Parameters:
        displayName - the new display name of the cycle

      • getLayoutType

        int getLayoutType()
        Gets the layout type for the cycle. This is typically an integer representation of the layout enum.

        0: CIRCULAR 1: SQUARE 2: TREE 3: GENERATED 4: CIRCULAR_MANUAL 5: SQUARE_MANUAL 6: TREE_MANUAL 7: CHART

        Returns:
        the layout type as an integer

      • setLayoutType

        void setLayoutType​(int layout)
        Sets the layout type for the cycle. The provided integer should correspond to a valid layout type.

        0: CIRCULAR 1: SQUARE 2: TREE 3: GENERATED 4: CIRCULAR_MANUAL 5: SQUARE_MANUAL 6: TREE_MANUAL 7: CHART

        Parameters:
        layout - the layout type as an integer