0ae169e20952
Action docs.
author | Steve Losh <steve@stevelosh.com> |
---|---|
date | Wed, 10 Aug 2011 02:01:06 -0400 |
parents | 29631ac2b821 |
children | dfb084418ef9 |
branches/tags | (none) |
files | docs/source/actions.rst |
Changes
--- a/docs/source/actions.rst Wed Aug 10 01:48:55 2011 -0400 +++ b/docs/source/actions.rst Wed Aug 10 02:01:06 2011 -0400 @@ -1,8 +1,17 @@ Actions ======= -Actions are functions that take a ``Bot`` object and some arguments and handle -writing the packets to make the bot perform the action. +Actions are functions that take a ``Bot`` object and some arguments, and return +a delayed function that will handle writing the packets to your bot perform the +action. + +If you want to make your bot perform an action immediately you should use ``force`` +to make it happen:: + + (force (clojurecraft.actions/jump bot)) + +Technically you don't need to use ``force``, because the REPL's printing will force +the result to be evaluated, but conceptually it's a good habit to get into. jump ----