Class GameRuleset


  • public class GameRuleset
    extends Object
    A set of moderator specified rules that define how runs can be submitted for a specific Game. These are not rules in the sense of moderating the leaderboard, but rather as restrictions when submitting a run.

    This class is immutable and thread-safe.
    • Method Detail

      • areMillisecondsShown

        public boolean areMillisecondsShown()
        Returns true if milliseconds are shown on the leaderboard, otherwise false.
        Returns:
        whether milliseconds are displayed on runs
      • isVerificationRequired

        public boolean isVerificationRequired()
        Returns true if a run needs to be verified before it appears on the leaderboard.
        Returns:
        whether verification of a run is required
      • isVideoRequired

        public boolean isVideoRequired()
        Returns true if a video link is required, otherwise false.
        Returns:
        whether a video of a run is required
      • areEmulatorsAllowed

        public boolean areEmulatorsAllowed()
        Returns true if emulators are allowed to be used in runs, otherwise false.
        Returns:
        whether emulators are allowed in a run
      • getRunTimes

        public List<TimingType> getRunTimes()
        Gets a List of allowed TimingTypes that a run can have.
        Returns:
        an unmodifiable List of TimingTypes
      • getDefaultTime

        public TimingType getDefaultTime()
        Gets the default TimingType that this game uses to sort the leaderboard by.
        Returns:
        the TimingType that runs are sorted by