<filename>assets/src/ba_data/python/ba/_score.py
# Released under the MIT License. See LICENSE for details.
#
"""Score related functionality."""

from __future__ import annotations

from enum import Enum, unique
from dataclasses import dataclass
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    import ba


@unique
class ScoreType(Enum):
    """Type of scores.

    Category: Enums
    """
    SECONDS = 's'
    MILLISECONDS = 'ms'
    POINTS = 'p'


@dataclass
class ScoreConfig:
    """Settings for how a game handles scores.

    Category: Gameplay Classes

    Attributes:

       label
          A label show to the user for scores; 'Score', 'Time Survived', etc.

       scoretype
          How the score value should be displayed.

       lower_is_better
          Whether lower scores are preferable. Higher scores are by default.

       none_is_winner
          Whether a value of None is considered better than other scores.
          By default it is not.

       version
          To change high-score lists used by a game without renaming the game,
          change this. Defaults to an empty string.

    """
    label: str = 'Score'
    scoretype: ba.ScoreType = ScoreType.POINTS
    lower_is_better: bool = False
    none_is_winner: bool = False
    version: str = ''
