diff options
author | David Thompson <dthompson@member.fsf.org> | 2013-09-24 21:06:41 -0400 |
---|---|---|
committer | David Thompson <dthompson@member.fsf.org> | 2013-09-24 21:06:41 -0400 |
commit | 1f1deea662da4328bf588c0642c8a90c7b1f2144 (patch) | |
tree | a7973b46b580ca2a9e8fb65f459e0004ae87b64f /doc/scripting/agenda.texi | |
parent | 7937b85219607a6e7755907e0752343344ed036c (diff) |
Rough draft of manual.
Diffstat (limited to 'doc/scripting/agenda.texi')
-rw-r--r-- | doc/scripting/agenda.texi | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/doc/scripting/agenda.texi b/doc/scripting/agenda.texi new file mode 100644 index 0000000..2954c15 --- /dev/null +++ b/doc/scripting/agenda.texi @@ -0,0 +1,37 @@ +@node Agendas +@section Agendas + +Agendas are used to schedule procedures to be called at distinct +points in game time. + +@anchor{2d agenda make-agenda}@defun make-agenda +Create a new, empty agenda. + +@end defun + +@anchor{2d agenda with-agenda}@defspec with-agenda agenda body ... +@end defspec + +@anchor{2d agenda agenda-schedule}@defun agenda-schedule thunk [delay] +Schedule THUNK in the current agenda to run after DELAY updates (1 by +default). + +@end defun + +@anchor{2d agenda agenda-schedule-interval}@defun agenda-schedule-interval thunk [interval] [delay] +Schedule THUNK in the current agenda to run after DELAY updates and run +every INTERVAL updates thereafter. Both DELAY and INTERVAL default to +1. Simply pass THUNK and nothing else to schedule THUNK to be run upon +every update. + +@end defun + +@anchor{2d agenda update-agenda}@defun update-agenda +Update the current agenda. + +@end defun + +@anchor{2d agenda clear-agenda}@defun clear-agenda +Clear the current agenda. + +@end defun |