Package ca.cgjennings.apps.arkham.component.design

Class SupportPreferences

  • public final class SupportPreferences
extends java.lang.Object
    This is a utility class that can be used by design support implementations to look up the current state of the various design support preference settings.
    Since:
    3.0
    Author:
    Chris Jennings

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  SupportPreferences.FeedbackLevel
      An enumeration of the different levels of validation feedback that can be requested for component sheets.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static SupportPreferences.FeedbackLevel getValidationFeedbackLevel()
      Returns the level of feedback that the user has requested when a component is considered invalid.
      static boolean isDesignSupportEnabled()
      Returns true if the user has requested that game component editors show design support information for components with design support.
      static boolean isStrictValidationEnabled()
      Returns true if the user has requested that components should be validated more strictly.

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • isDesignSupportEnabled

        public static boolean isDesignSupportEnabled()
        Returns true if the user has requested that game component editors show design support information for components with design support.
        Returns:
        true if editors should show design support

      • getValidationFeedbackLevel

        public static SupportPreferences.FeedbackLevel getValidationFeedbackLevel()
        Returns the level of feedback that the user has requested when a component is considered invalid. Game components that consider validity (game balance, fairness) as part of their design support analysis should also add support to the component's Sheets to display feedback when the component is invalid. This setting indicates how bold this feedback should be.
        Returns:
        a value that reflects how obviously invalid components should be marked

      • isStrictValidationEnabled

        public static boolean isStrictValidationEnabled()
        Returns true if the user has requested that components should be validated more strictly. The exact interpretation of this is left up to the design support, but generally it means that borderline cases that may have simply been noted in the design support view ought to invalidate the component.
        Returns:
        true if validation is enabled and the user has requested strict validation mode