Package me.keehl.elevators.api.models

Interface IElevatorType

    • Method Detail

      • getTypeKey

        java.lang.String getTypeKey()
        Returns:
        the type name of the elevator.

      • canElevatorExplode

        boolean canElevatorExplode()
        Specified by:
        canElevatorExplode in interface IConfigElevatorType
        Returns:
        whether the elevator can explode from creepers, tnt, etc.

      • canElevatorBeDyed

        boolean canElevatorBeDyed()
        Specified by:
        canElevatorBeDyed in interface IConfigElevatorType
        Returns:
        where a recipe for this elevator type can produce a colored elevator.

      • shouldValidateSameColor

        boolean shouldValidateSameColor()
        Specified by:
        shouldValidateSameColor in interface IConfigElevatorType
        Returns:
        controls whether an elevator can be teleported to if the destination is a separate color than the origin.

      • doesElevatorRequirePermissions

        boolean doesElevatorRequirePermissions()
        Specified by:
        doesElevatorRequirePermissions in interface IConfigElevatorType
        Returns:
        controls whether the elevator should check permissions to allow operation. This is mostly used for those small, local servers where permissions plugins aren't used.

      • checkDestinationElevatorType

        boolean checkDestinationElevatorType()
        Specified by:
        checkDestinationElevatorType in interface IConfigElevatorType
        Returns:
        controls whether the elevator must teleport to destination elevator of the same type.

      • getMaxSolidBlocksAllowedBetweenElevators

        int getMaxSolidBlocksAllowedBetweenElevators()
        Specified by:
        getMaxSolidBlocksAllowedBetweenElevators in interface IConfigElevatorType
        Returns:
        the maximum amount of non-air blocks that can be between the origin and destination elevator before it stops searching.

      • shouldStopObstructedTeleport

        boolean shouldStopObstructedTeleport()
        Specified by:
        shouldStopObstructedTeleport in interface IConfigElevatorType
        Returns:
        controls whether an elevator can be teleported to if the destination will place the player inside of a block.

      • setDisplayName

        void setDisplayName​(ILocaleComponent displayName)
        Sets the elevators ItemStack display name.

      • setUsePermission

        void setUsePermission​(java.lang.String usePermission)
        Sets the elevators use permission.

      • setDyePermission

        void setDyePermission​(java.lang.String dyePermission)
        Sets the elevators dye permission.

      • setMaxDistanceAllowedBetweenElevators

        void setMaxDistanceAllowedBetweenElevators​(int maxDistance)
        Sets the maximum distance that an elevator will search for a destination elevator.

      • setMaxStackSize

        void setMaxStackSize​(int maxStackSize)
        Sets the max stack size of an elevator ItemStack

      • setMaxSolidBlocksAllowedBetweenElevators

        void setMaxSolidBlocksAllowedBetweenElevators​(int maxSolidBlocks)
        Sets the maximum amount of non-air blocks that can be between the origin and destination elevator before it stops searching.

      • setCheckDestinationElevatorType

        void setCheckDestinationElevatorType​(boolean checkType)
        Sets whether the elevator must teleport to destination elevator of the same type.

      • setElevatorRequiresPermissions

        void setElevatorRequiresPermissions​(boolean checkPerms)
        Set whether the elevator should check permissions to allow operation. This is mostly used for those small, local servers where permissions plugins aren't used.

      • setCanElevatorExplode

        void setCanElevatorExplode​(boolean canExplode)
        Set whether the elevator can explode from creepers, tnt, etc.

      • setCanDye

        void setCanDye​(boolean supportDying)
        Set whether a recipe for this elevator type can produce a colored elevator.

      • setStopsObstructedTeleportation

        void setStopsObstructedTeleportation​(boolean stopsObstruction)
        Set whether an elevator can be teleported to if the destination will place the player inside of a block.

      • setShouldValidateColor

        void setShouldValidateColor​(boolean checkColor)
        Set whether an elevator can be teleported to if the destination is a separate color than the origin.

      • setShouldAllowIndividualEdit

        void setShouldAllowIndividualEdit​(boolean allowIndividualEdit)
        Set whether users can open the settings-edit menu of an elevator type.

      • setHologramLines

        void setHologramLines​(java.util.List<ILocaleComponent> holoLines)
        Set the lines that should appear over an elevator of this type.

      • updateAllHolograms

        void updateAllHolograms​(boolean chunkCheck)

      • setLore

        void setLore​(java.util.List<ILocaleComponent> loreLines)
        Set the lines that should appear in an itemstack of this type.