Firepup650/bitbot-3.11-fork
2
0
Fork 0
Code Issues Pull requests Activity Actions

Add help/usage strings for ducks.py

Browse source
This commit is contained in:
jesopo 2019-06-10 16:41:32 +01:00
parent 87a01dac95
commit 03917649ee
1 changed files with 14 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
modules/ducks.py
View file

@ -80,6 +80,9 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.bef", alias_of="befriend") @utils.hook("received.command.bef", alias_of="befriend")
@utils.hook("received.command.befriend", channel_only=True) @utils.hook("received.command.befriend", channel_only=True)
def befriend(self, event): def befriend(self, event):
"""
:help: Befriend a duck
"""
if event["target"].duck_active: if event["target"].duck_active:
action = self._duck_action(event["target"], event["user"], "saved", action = self._duck_action(event["target"], event["user"], "saved",
"ducks-befriended") "ducks-befriended")
@ -89,6 +92,9 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.trap", channel_only=True) @utils.hook("received.command.trap", channel_only=True)
def trap(self, event): def trap(self, event):
"""
:help: Trap a duck
"""
if event["target"].duck_active: if event["target"].duck_active:
action = self._duck_action(event["target"], event["user"], "trapped", action = self._duck_action(event["target"], event["user"], "trapped",
"ducks-shot") "ducks-shot")
@ -98,11 +104,19 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.friends") @utils.hook("received.command.friends")
def friends(self, event): def friends(self, event):
"""
:help: Show top 10 duck friends
:usage: [channel]
"""
stats = self._duck_stats(event["server"], "ducks-befriended", "friends", stats = self._duck_stats(event["server"], "ducks-befriended", "friends",
event["args_split"][0] if event["args"] else None) event["args_split"][0] if event["args"] else None)
event["stdout"].write(stats) event["stdout"].write(stats)
@utils.hook("received.command.enemies") @utils.hook("received.command.enemies")
def enemies(self, event): def enemies(self, event):
"""
:help: Show top 10 duck enemies
:usage: [channel]
"""
stats = self._duck_stats(event["server"], "ducks-shot", "enemies", stats = self._duck_stats(event["server"], "ducks-shot", "enemies",
event["args_split"][0] if event["args"] else None) event["args_split"][0] if event["args"] else None)
event["stdout"].write(stats) event["stdout"].write(stats)