event.html 2.4 KB

12345678910111213141516171819202122232425262728293031323334
  1. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: event</title>
  3. </head><body bgcolor="#f0f0f8">
  4. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
  5. <tr bgcolor="#7799ee">
  6. <td valign=bottom>&nbsp;<br>
  7. <font color="#ffffff" face="helvetica, arial">&nbsp;<br><big><big><strong>event</strong></big></big></font></td
  8. ><td align=right valign=bottom
  9. ><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br>(built-in)</font></td></tr></table>
  10. <p><tt>The&nbsp;event&nbsp;module&nbsp;handles&nbsp;delayed&nbsp;function&nbsp;calls.</tt></p>
  11. <p>
  12. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  13. <tr bgcolor="#eeaa77">
  14. <td colspan=3 valign=bottom>&nbsp;<br>
  15. <font color="#ffffff" face="helvetica, arial"><big><strong>Functions</strong></big></font></td></tr>
  16. <tr><td bgcolor="#eeaa77"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  17. <td width="100%"><dl><dt><a name="-interrupt_events_involving"><strong>interrupt_events_involving</strong></a>(...)</dt><dd><tt><a href="#-interrupt_events_involving">interrupt_events_involving</a>(thing)<br>
  18. &nbsp;<br>
  19. Interrupt&nbsp;all&nbsp;events&nbsp;involving&nbsp;a&nbsp;given&nbsp;object,&nbsp;room,&nbsp;or&nbsp;character.</tt></dd></dl>
  20. <dl><dt><a name="-start_event"><strong>start_event</strong></a>(...)</dt><dd><tt><a href="#-start_event">start_event</a>(owner,&nbsp;delay,&nbsp;event_func,&nbsp;data=None,&nbsp;arg='')<br>
  21. &nbsp;<br>
  22. Queue&nbsp;a&nbsp;new&nbsp;delayed&nbsp;event,&nbsp;to&nbsp;go&nbsp;off&nbsp;after&nbsp;delay&nbsp;seconds.&nbsp;Events&nbsp;are<br>
  23. cancelled&nbsp;when&nbsp;their&nbsp;owner&nbsp;is&nbsp;extracted.&nbsp;Owners&nbsp;can&nbsp;be&nbsp;characters,&nbsp;<br>
  24. objects,&nbsp;rooms,&nbsp;or&nbsp;None.&nbsp;The&nbsp;event&nbsp;function&nbsp;should&nbsp;take&nbsp;three&nbsp;arguments:<br>
  25. the&nbsp;event&nbsp;owner,&nbsp;the&nbsp;event&nbsp;data,&nbsp;and&nbsp;the&nbsp;string&nbsp;argument.&nbsp;Data&nbsp;is&nbsp;an<br>
  26. optional&nbsp;argument&nbsp;that&nbsp;can&nbsp;be&nbsp;of&nbsp;any&nbsp;type.&nbsp;Arg&nbsp;is&nbsp;an&nbsp;optional&nbsp;argument<br>
  27. that&nbsp;must&nbsp;be&nbsp;a&nbsp;string.</tt></dd></dl>
  28. <dl><dt><a name="-start_update"><strong>start_update</strong></a>(...)</dt><dd><tt>Deprecated.&nbsp;For&nbsp;repeating&nbsp;events,&nbsp;use&nbsp;events&nbsp;that&nbsp;manually&nbsp;re-queue<br>
  29. their&nbsp;selves.</tt></dd></dl>
  30. </td></tr></table>
  31. </body></html>