onyx_online/duckypad-twitch
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/duckypad-twitch.git synced 2026-01-09 13:07:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

upd docstrings

Browse Source
This commit is contained in:
Onyx and Iris 2026-01-02 20:51:50 +00:00
parent e271c2a324
commit 4f087a0358
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
duckypad_twitch/util.py
View File

@ -1,5 +1,7 @@
def ensure_obsws(func):
"""ensure an obs websocket connection has been established"""
"""ensure an obs websocket connection has been established
Used as a decorator for functions that require an obs websocket connection"""
def wrapper(self, *args):
if self.request is None:
@ -11,8 +13,11 @@ def ensure_obsws(func):
return wrapper
def ensure_mixer_fadeout(func):
"""ensure mixer fadeout is stopped before proceeding"""
"""ensure mixer is faded out before proceeding (disable monitor speaker)
Used as a decorator for functions that require the mixer to be faded out"""
def wrapper(self, *args):
if self.mixer.lr.mix.fader > -90:
@ -21,6 +26,7 @@ def ensure_mixer_fadeout(func):
return wrapper
def to_snakecase(scene_name: str) -> str:
"""Convert caplitalized words to lowercase snake_case"""
return '_'.join(word.lower() for word in scene_name.split())