Source code for players.constants

# ../players/constants.py

"""Provides constant values that are player based."""

# =============================================================================
# >> IMPORTS
# =============================================================================
# Python Imports
#   Enum
from enum import IntEnum
from enum import IntFlag


# =============================================================================
# >> FORWARD IMPORTS
# =============================================================================
# Source.Python Imports
#   Players
from _players._constants import FIXANGLE_NONE
from _players._constants import FIXANGLE_ABSOLUTE
from _players._constants import FIXANGLE_RELATIVE
from _players._constants import FL_ONGROUND
from _players._constants import FL_DUCKING
from _players._constants import FL_WATERJUMP
from _players._constants import FL_ONTRAIN
from _players._constants import FL_INRAIN
from _players._constants import FL_FROZEN
from _players._constants import FL_ATCONTROLS
from _players._constants import FL_CLIENT
from _players._constants import FL_FAKECLIENT
from _players._constants import FL_INWATER
from _players._constants import HIDEHUD_WEAPONSELECTION
from _players._constants import HIDEHUD_FLASHLIGHT
from _players._constants import HIDEHUD_ALL
from _players._constants import HIDEHUD_HEALTH
from _players._constants import HIDEHUD_PLAYERDEAD
from _players._constants import HIDEHUD_NEEDSUIT
from _players._constants import HIDEHUD_MISCSTATUS
from _players._constants import HIDEHUD_CHAT
from _players._constants import HIDEHUD_CROSSHAIR
from _players._constants import HIDEHUD_VEHICLE_CROSSHAIR
from _players._constants import HIDEHUD_INVEHICLE
from _players._constants import HIDEHUD_BONUS_PROGRESS
from _players._constants import HIDEHUD_RADAR
from _players._constants import HITGROUP_GENERIC
from _players._constants import HITGROUP_HEAD
from _players._constants import HITGROUP_CHEST
from _players._constants import HITGROUP_STOMACH
from _players._constants import HITGROUP_LEFTARM
from _players._constants import HITGROUP_RIGHTARM
from _players._constants import HITGROUP_LEFTLEG
from _players._constants import HITGROUP_RIGHTLEG
from _players._constants import HITGROUP_GEAR
from _players._constants import IN_ATTACK
from _players._constants import IN_JUMP
from _players._constants import IN_DUCK
from _players._constants import IN_FORWARD
from _players._constants import IN_BACK
from _players._constants import IN_USE
from _players._constants import IN_CANCEL
from _players._constants import IN_LEFT
from _players._constants import IN_RIGHT
from _players._constants import IN_MOVELEFT
from _players._constants import IN_MOVERIGHT
from _players._constants import IN_ATTACK2
from _players._constants import IN_RUN
from _players._constants import IN_RELOAD
from _players._constants import IN_ALT1
from _players._constants import IN_ALT2
from _players._constants import IN_SCORE
from _players._constants import IN_SPEED
from _players._constants import IN_WALK
from _players._constants import IN_ZOOM
from _players._constants import IN_WEAPON1
from _players._constants import IN_WEAPON2
from _players._constants import IN_BULLRUSH
from _players._constants import IN_GRENADE1
from _players._constants import IN_GRENADE2
from _players._constants import IN_LOOKSPIN
from _players._constants import INVALID_PLAYER_USERID
from _players._constants import LIFE_ALIVE
from _players._constants import LIFE_DYING
from _players._constants import LIFE_DEAD
from _players._constants import LIFE_RESPAWNABLE
from _players._constants import LIFE_DISCARDBODY
from _players._constants import OBS_MODE_NONE
from _players._constants import OBS_MODE_DEATHCAM
from _players._constants import OBS_MODE_FREEZECAM
from _players._constants import OBS_MODE_FIXED
from _players._constants import OBS_MODE_IN_EYE
from _players._constants import OBS_MODE_CHASE
from _players._constants import OBS_MODE_ROAMING
from _players._constants import PlayerAnimation


# =============================================================================
# >> ALL DECLARATION
# =============================================================================
__all__ = ('FixAngle',
           'HideHudFlags',
           'HitGroup',
           'INVALID_PLAYER_USERID',
           'LifeState',
           'ObserverMode',
           'PlayerAnimation',
           'PlayerButtons',
           'PlayerStates',
           )


# =============================================================================
# >> ENUMERATORS
# =============================================================================
class FixAngle(IntEnum):
    """Player fix angle enumerator."""

    NONE = FIXANGLE_NONE
    ABSOLUTE = FIXANGLE_ABSOLUTE
    RELATIVE = FIXANGLE_RELATIVE


class PlayerStates(IntFlag):
    """Player states wrapper enumerator."""

    ONGROUND = FL_ONGROUND
    DUCKING = FL_DUCKING
    WATERJUMP = FL_WATERJUMP
    ONTRAIN = FL_ONTRAIN
    INRAIN = FL_INRAIN
    FROZEN = FL_FROZEN
    ATCONTROLS = FL_ATCONTROLS
    CLIENT = FL_CLIENT
    FAKECLIENT = FL_FAKECLIENT
    INWATER = FL_INWATER


class LifeState(IntEnum):
    """Player life states wrapper enumerator."""

    ALIVE = LIFE_ALIVE
    DYING = LIFE_DYING
    DEAD = LIFE_DEAD
    RESPAWNABLE = LIFE_RESPAWNABLE
    DISCARDBODY = LIFE_DISCARDBODY


class PlayerButtons(IntFlag):
    """Player buttons wrapper enumerator."""

    ATTACK = IN_ATTACK
    JUMP = IN_JUMP
    DUCK = IN_DUCK
    FORWARD = IN_FORWARD
    BACK = IN_BACK
    USE = IN_USE
    CANCEL = IN_CANCEL
    LEFT = IN_LEFT
    RIGHT = IN_RIGHT
    MOVELEFT = IN_MOVELEFT
    MOVERIGHT = IN_MOVERIGHT
    ATTACK2 = IN_ATTACK2
    RUN = IN_RUN
    RELOAD = IN_RELOAD
    ALT1 = IN_ALT1
    ALT2 = IN_ALT2
    SCORE = IN_SCORE
    SPEED = IN_SPEED
    WALK = IN_WALK
    ZOOM = IN_ZOOM
    WEAPON1 = IN_WEAPON1
    WEAPON2 = IN_WEAPON2
    BULLRUSH = IN_BULLRUSH
    GRENADE1 = IN_GRENADE1
    GRENADE2 = IN_GRENADE2
    LOOKSPIN = IN_LOOKSPIN


class HideHudFlags(IntFlag):
    """Hide hud flags wrapper enumerator."""

    WEAPONSELECTION = HIDEHUD_WEAPONSELECTION
    FLASHLIGHT = HIDEHUD_FLASHLIGHT
    ALL = HIDEHUD_ALL
    HEALTH = HIDEHUD_HEALTH
    PLAYERDEAD = HIDEHUD_PLAYERDEAD
    NEEDSUIT = HIDEHUD_NEEDSUIT
    MISCSTATUS = HIDEHUD_MISCSTATUS
    CHAT = HIDEHUD_CHAT
    CROSSHAIR = HIDEHUD_CROSSHAIR
    VEHICLE_CROSSHAIR = HIDEHUD_VEHICLE_CROSSHAIR
    INVEHICLE = HIDEHUD_INVEHICLE
    BONUS_PROGRESS = HIDEHUD_BONUS_PROGRESS
    RADAR = HIDEHUD_RADAR


class HitGroup(IntEnum):
    """Hit groups wrapper enumerator."""

    GENERIC = HITGROUP_GENERIC
    HEAD = HITGROUP_HEAD
    CHEST = HITGROUP_CHEST
    STOMACH = HITGROUP_STOMACH
    LEFTARM = HITGROUP_LEFTARM
    RIGHTARM = HITGROUP_RIGHTARM
    LEFTLEG = HITGROUP_LEFTLEG
    RIGHTLEG = HITGROUP_RIGHTLEG
    GEAR = HITGROUP_GEAR


class ObserverMode(IntEnum):
    """Observer modes wrapper enumerator."""

    NONE = OBS_MODE_NONE
    DEATHCAM = OBS_MODE_DEATHCAM
    FREEZECAM = OBS_MODE_FREEZECAM
    FIXED = OBS_MODE_FIXED
    IN_EYE = OBS_MODE_IN_EYE
    CHASE = OBS_MODE_CHASE
    ROAMING = OBS_MODE_ROAMING