Source code for babase._text

# Released under the MIT License. See LICENSE for details.
#
"""Text related functionality."""

from __future__ import annotations


from typing import TYPE_CHECKING

if TYPE_CHECKING:
    import babase




def timestring(
    timeval: float | int,
    centi: bool = True,
) -> babase.Lstr:
    """Generate a localized string for displaying a time value.

    Given a time value, returns a localized string with:
    (hours if > 0 ) : minutes : seconds : (centiseconds if centi=True).

    .. warning::

      the underlying localized-string value is somewhat large, so don't
      use this to rapidly update text values for an in-game timer or you
      may consume significant network bandwidth. For that sort of thing
      you should use things like 'timedisplay' nodes and attribute
      connections.
    """
    from babase._language import Lstr

    # We take float seconds but operate on int milliseconds internally.
    timeval = int(1000 * timeval)
    bits = []
    subs = []
    hval = (timeval // 1000) // (60 * 60)
    if hval != 0:
        bits.append('${H}')
        subs.append(
            (
                '${H}',
                Lstr(
                    resource='timeSuffixHoursText',
                    subs=[('${COUNT}', str(hval))],
                ),
            )
        )
    mval = ((timeval // 1000) // 60) % 60
    if mval != 0:
        bits.append('${M}')
        subs.append(
            (
                '${M}',
                Lstr(
                    resource='timeSuffixMinutesText',
                    subs=[('${COUNT}', str(mval))],
                ),
            )
        )

    # We add seconds if its non-zero *or* we haven't added anything else.
    if centi:
        # pylint: disable=consider-using-f-string
        sval = timeval / 1000.0 % 60.0
        if sval >= 0.005 or not bits:
            bits.append('${S}')
            subs.append(
                (
                    '${S}',
                    Lstr(
                        resource='timeSuffixSecondsText',
                        subs=[('${COUNT}', ('%.2f' % sval))],
                    ),
                )
            )
    else:
        sval = timeval // 1000 % 60
        if sval != 0 or not bits:
            bits.append('${S}')
            subs.append(
                (
                    '${S}',
                    Lstr(
                        resource='timeSuffixSecondsText',
                        subs=[('${COUNT}', str(sval))],
                    ),
                )
            )
    return Lstr(value=' '.join(bits), subs=subs)



# Docs-generation hack; import some stuff that we likely only forward-declared
# in our actual source code so that docs tools can find it.
from typing import (Coroutine, Any, Literal, Callable,
  Generator, Awaitable, Sequence, Self)
import asyncio
from concurrent.futures import Future