Module albow.core.CoreUtilities

Warning

This is warning text

Attention

This is attention text

Caution

This is caution text

Danger

This is danger text

Error

This is error text

Hint

This is hint text

Important

This is important text

Note

This is note text

Tip

This is tip text

Source code
"""
        .. WARNING::
            This is warning text

        .. ATTENTION::
            This is attention text

        .. CAUTION::
            This is caution text

        .. DANGER::
            This is danger text

        .. ERROR::
            This is error text

        .. HINT::
            This is hint text

        .. IMPORTANT::
            This is important text

        .. NOTE::
            This is note text

        .. TIP::
            This is tip text

"""
from time import time

from pygame.locals import *

from pygame.time import get_ticks

MOD_CMD = KMOD_LCTRL | KMOD_RCTRL | KMOD_LMETA | KMOD_RMETA

MODIFIERS = dict(
    shift=False,
    ctrl=False,
    alt=False,
    meta=False,
)

MOD_KEYS = {
    K_LSHIFT: 'shift',  K_RSHIFT: 'shift',
    K_LCTRL:  'ctrl',   K_RCTRL:  'ctrl',
    K_LALT:   'alt',    K_RALT:   'alt',
    K_LMETA:  'meta',   K_RMETA:  'meta',
}


class CoreUtilities:

    timeBase = 0

    """
    A static class for some leftover module functions
    """
    @staticmethod
    def set_modifier(key, value):
        attr = MOD_KEYS.get(key)
        if attr:
            MODIFIERS[attr] = value

    @staticmethod
    def add_modifiers(event):
        d = event.dict
        d.update(MODIFIERS)
        d['cmd'] = event.ctrl or event.meta

    @staticmethod
    def init_timebase():

        CoreUtilities.timeBase = time() * 1000.0 - get_ticks()
        print(f"timeBase: {str(CoreUtilities.timeBase)}")

Classes

class CoreUtilities (*args, **kwargs)
Source code
class CoreUtilities:

    timeBase = 0

    """
    A static class for some leftover module functions
    """
    @staticmethod
    def set_modifier(key, value):
        attr = MOD_KEYS.get(key)
        if attr:
            MODIFIERS[attr] = value

    @staticmethod
    def add_modifiers(event):
        d = event.dict
        d.update(MODIFIERS)
        d['cmd'] = event.ctrl or event.meta

    @staticmethod
    def init_timebase():

        CoreUtilities.timeBase = time() * 1000.0 - get_ticks()
        print(f"timeBase: {str(CoreUtilities.timeBase)}")

Class variables

var timeBase

A static class for some leftover module functions

Static methods

def add_modifiers(event)
Source code
@staticmethod
def add_modifiers(event):
    d = event.dict
    d.update(MODIFIERS)
    d['cmd'] = event.ctrl or event.meta
def init_timebase()
Source code
@staticmethod
def init_timebase():

    CoreUtilities.timeBase = time() * 1000.0 - get_ticks()
    print(f"timeBase: {str(CoreUtilities.timeBase)}")
def set_modifier(key, value)
Source code
@staticmethod
def set_modifier(key, value):
    attr = MOD_KEYS.get(key)
    if attr:
        MODIFIERS[attr] = value