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

Add missing help strings to commands in modules/coins.py

Browse source
This commit is contained in:
jesopo 2018-10-16 13:53:32 +01:00
parent 7411c493f9
commit ff7ac9fe89
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

15
modules/coins.py
View file

@ -106,6 +106,9 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.bank") @utils.hook("received.command.bank")
def bank(self, event): def bank(self, event):
"""
:help: Show how many coins The Bank currently has
"""
event["stdout"].write("The Bank has %s coins" % event["stdout"].write("The Bank has %s coins" %
self._coin_str(self._get_pool(event["server"]))) self._coin_str(self._get_pool(event["server"])))
@ -119,6 +122,9 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.totalcoins") @utils.hook("received.command.totalcoins")
def total_coins(self, event): def total_coins(self, event):
"""
:help: Show how many coins are currently in circulation
"""
event["stdout"].write("Total coins: %s" % self._coin_str( event["stdout"].write("Total coins: %s" % self._coin_str(
self._total_coins(event["server"]))) self._total_coins(event["server"])))
@ -505,6 +511,9 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.mylottery") @utils.hook("received.command.mylottery")
def my_lottery(self, event): def my_lottery(self, event):
"""
:help: Show how many lottery tickets you currently have
"""
lottery = event["server"].get_setting("lottery", {}) lottery = event["server"].get_setting("lottery", {})
count = lottery.get(event["user"].nickname_lower, 0) count = lottery.get(event["user"].nickname_lower, 0)
event["stdout"].write("%s: You have %d lottery ticket%s" % ( event["stdout"].write("%s: You have %d lottery ticket%s" % (
@ -512,6 +521,9 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.jackpot") @utils.hook("received.command.jackpot")
def jackpot(self, event): def jackpot(self, event):
"""
:help: Show the current lottery jackpot
"""
lottery = event["server"].get_setting("lottery", {}) lottery = event["server"].get_setting("lottery", {})
count = sum([value for nickname, value in lottery.items()]) count = sum([value for nickname, value in lottery.items()])
event["stdout"].write("%s: The current jackpot is %s" % ( event["stdout"].write("%s: The current jackpot is %s" % (
@ -519,6 +531,9 @@ class Module(ModuleManager.BaseModule):
@utils.hook("received.command.nextlottery") @utils.hook("received.command.nextlottery")
def next_lottery(self, event): def next_lottery(self, event):
"""
:help: Show time until the next lottery draw
"""
until = self._until_next_6_hour() until = self._until_next_6_hour()
event["stdout"].write("Next lottery is in: %s" % event["stdout"].write("Next lottery is in: %s" %
utils.to_pretty_time(until)) utils.to_pretty_time(until))