Garmelon/haboli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add botrulez documentation

Browse source
This commit is contained in:
Joscha 2020-04-08 21:53:16 +00:00
parent 2d9491d2fb
commit 0e0596765e
2 changed files with 23 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
src/Haboli/Euphoria/Command.hs
View file

@ -25,13 +25,17 @@ runCommands (c:cs) msg = do
then pure True
else runCommands cs msg
-- | Run a list of 'Command's on all 'EventSend's. Passes through all events
-- unmodified.
-- | @'respondingToCommands' getEvent getCommands@ runs a list of 'Command's on
-- all 'EventSend's. It passes through all events unmodified.
--
-- The @getEvent@ action is used to obtain the next 'Event'. The @getCommands@
-- action is used to obtain the currently available commands. @getCommands@ is
-- called directly after a new 'Event' becomes available through @getEvent@.
--
-- This utility function is meant to be wrapped directly or indirectly around
-- 'nextEvent':
--
-- > event <- respondingToCommands commands nextEvent
-- > event <- respondingToCommands nextEvent commands
respondingToCommands :: Client e Event -> Client e [Command e] -> Client e Event
respondingToCommands getEvent getCommands = do
event <- getEvent