exit.html 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127
  1. <!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
  2. <html><head><title>Python: exit</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>exit</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;exit&nbsp;module,&nbsp;for&nbsp;all&nbsp;MUD&nbsp;exit-related&nbsp;stuff.</tt></p>
  11. <p>
  12. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  13. <tr bgcolor="#ee77aa">
  14. <td colspan=3 valign=bottom>&nbsp;<br>
  15. <font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
  16. <tr><td bgcolor="#ee77aa"><tt>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</tt></td><td>&nbsp;</td>
  17. <td width="100%"><dl>
  18. <dt><font face="helvetica, arial"><a href="__builtin__.html#object">__builtin__.object</a>
  19. </font></dt><dd>
  20. <dl>
  21. <dt><font face="helvetica, arial"><a href="exit.html#Exit">Exit</a>
  22. </font></dt></dl>
  23. </dd>
  24. </dl>
  25. <p>
  26. <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
  27. <tr bgcolor="#ffc8d8">
  28. <td colspan=3 valign=bottom>&nbsp;<br>
  29. <font color="#000000" face="helvetica, arial"><a name="Exit">class <strong>Exit</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
  30. <tr bgcolor="#ffc8d8"><td rowspan=2><tt>&nbsp;&nbsp;&nbsp;</tt></td>
  31. <td colspan=2><tt>Python&nbsp;<a href="#Exit">Exit</a>&nbsp;<a href="__builtin__.html#object">object</a><br>&nbsp;</tt></td></tr>
  32. <tr><td>&nbsp;</td>
  33. <td width="100%">Methods defined here:<br>
  34. <dl><dt><a name="Exit-__cmp__"><strong>__cmp__</strong></a>(...)</dt><dd><tt>x.<a href="#Exit-__cmp__">__cmp__</a>(y)&nbsp;&lt;==&gt;&nbsp;cmp(x,y)</tt></dd></dl>
  35. <dl><dt><a name="Exit-__init__"><strong>__init__</strong></a>(...)</dt><dd><tt>x.<a href="#Exit-__init__">__init__</a>(...)&nbsp;initializes&nbsp;x;&nbsp;see&nbsp;x.__class__.__doc__&nbsp;for&nbsp;signature</tt></dd></dl>
  36. <dl><dt><a name="Exit-close"><strong>close</strong></a>(...)</dt><dd><tt><a href="#Exit-close">close</a>()<br>
  37. &nbsp;<br>
  38. Close&nbsp;the&nbsp;exit's&nbsp;door&nbsp;if&nbsp;it&nbsp;exists.</tt></dd></dl>
  39. <dl><dt><a name="Exit-filldoor"><strong>filldoor</strong></a>(...)</dt><dd><tt><a href="#Exit-filldoor">filldoor</a>()<br>
  40. &nbsp;<br>
  41. Erase&nbsp;a&nbsp;door&nbsp;that&nbsp;was&nbsp;on&nbsp;the&nbsp;exit.</tt></dd></dl>
  42. <dl><dt><a name="Exit-lock"><strong>lock</strong></a>(...)</dt><dd><tt><a href="#Exit-lock">lock</a>()<br>
  43. &nbsp;<br>
  44. Locks&nbsp;the&nbsp;exit's&nbsp;door&nbsp;if&nbsp;it&nbsp;exists.&nbsp;Also&nbsp;closes.</tt></dd></dl>
  45. <dl><dt><a name="Exit-makedoor"><strong>makedoor</strong></a>(...)</dt><dd><tt><a href="#Exit-makedoor">makedoor</a>(name=None,&nbsp;keywords=None,&nbsp;opposite=None,&nbsp;closed=False,&nbsp;locked=False)<br>
  46. &nbsp;<br>
  47. Create&nbsp;a&nbsp;door&nbsp;for&nbsp;the&nbsp;exit.</tt></dd></dl>
  48. <dl><dt><a name="Exit-open"><strong>open</strong></a>(...)</dt><dd><tt><a href="#Exit-open">open</a>()<br>
  49. &nbsp;<br>
  50. Opens&nbsp;the&nbsp;exit's&nbsp;door&nbsp;if&nbsp;it&nbsp;exists.&nbsp;Also&nbsp;unlocks.</tt></dd></dl>
  51. <dl><dt><a name="Exit-unlock"><strong>unlock</strong></a>(...)</dt><dd><tt><a href="#Exit-unlock">unlock</a>()<br>
  52. &nbsp;<br>
  53. Unlocks&nbsp;the&nbsp;exit's&nbsp;door&nbsp;if&nbsp;it&nbsp;exists.</tt></dd></dl>
  54. <hr>
  55. Data descriptors defined here:<br>
  56. <dl><dt><strong>desc</strong></dt>
  57. <dd><tt>The&nbsp;verbose&nbsp;description&nbsp;of&nbsp;the&nbsp;exit&nbsp;when,&nbsp;e.g.,&nbsp;it&nbsp;is&nbsp;looked&nbsp;at.</tt></dd>
  58. </dl>
  59. <dl><dt><strong>dest</strong></dt>
  60. <dd><tt>The&nbsp;room&nbsp;that&nbsp;this&nbsp;exit&nbsp;leads&nbsp;to.&nbsp;Can&nbsp;be&nbsp;set&nbsp;either&nbsp;by&nbsp;assigning&nbsp;a<br>
  61. world&nbsp;room&nbsp;key,&nbsp;or&nbsp;an&nbsp;actual&nbsp;room.</tt></dd>
  62. </dl>
  63. <dl><dt><strong>destproto</strong></dt>
  64. <dd><tt>The&nbsp;world&nbsp;room&nbsp;key&nbsp;of&nbsp;our&nbsp;destination.&nbsp;Immutable.</tt></dd>
  65. </dl>
  66. <dl><dt><strong>enter_mssg</strong></dt>
  67. <dd><tt>A&nbsp;message&nbsp;for&nbsp;when&nbsp;a&nbsp;char&nbsp;enters&nbsp;the&nbsp;room&nbsp;via&nbsp;this&nbsp;exit.</tt></dd>
  68. </dl>
  69. <dl><dt><strong>hidden</strong></dt>
  70. <dd><tt>Alias&nbsp;for&nbsp;exit.Exit.spot_diff</tt></dd>
  71. </dl>
  72. <dl><dt><strong>is_closable</strong></dt>
  73. <dd><tt>True&nbsp;or&nbsp;False&nbsp;if&nbsp;an&nbsp;exit&nbsp;can&nbsp;be&nbsp;closed.&nbsp;Immutable.</tt></dd>
  74. </dl>
  75. <dl><dt><strong>is_closed</strong></dt>
  76. <dd><tt>True&nbsp;or&nbsp;False&nbsp;if&nbsp;an&nbsp;exit&nbsp;is&nbsp;closed.&nbsp;Immutable.</tt></dd>
  77. </dl>
  78. <dl><dt><strong>is_locked</strong></dt>
  79. <dd><tt>True&nbsp;or&nbsp;False&nbsp;if&nbsp;an&nbsp;exit&nbsp;is&nbsp;locked.</tt></dd>
  80. </dl>
  81. <dl><dt><strong>key</strong></dt>
  82. <dd><tt>An&nbsp;object&nbsp;prototype&nbsp;name&nbsp;that&nbsp;can&nbsp;be&nbsp;used&nbsp;to&nbsp;unlock&nbsp;this&nbsp;exit.&nbsp;Can&nbsp;be<br>
  83. set&nbsp;either&nbsp;by&nbsp;assigning&nbsp;a&nbsp;prototype&nbsp;name,&nbsp;or&nbsp;an&nbsp;actual&nbsp;object.</tt></dd>
  84. </dl>
  85. <dl><dt><strong>keywords</strong></dt>
  86. <dd><tt>A&nbsp;comma-separated&nbsp;string&nbsp;of&nbsp;the&nbsp;door's&nbsp;keywords.</tt></dd>
  87. </dl>
  88. <dl><dt><strong>leave_mssg</strong></dt>
  89. <dd><tt>A&nbsp;message&nbsp;for&nbsp;when&nbsp;a&nbsp;character&nbsp;leaves&nbsp;a&nbsp;room&nbsp;via&nbsp;this&nbsp;exit.</tt></dd>
  90. </dl>
  91. <dl><dt><strong>name</strong></dt>
  92. <dd><tt>The&nbsp;name&nbsp;of&nbsp;the&nbsp;door&nbsp;for&nbsp;this&nbsp;exit,&nbsp;if&nbsp;any.</tt></dd>
  93. </dl>
  94. <dl><dt><strong>opposite</strong></dt>
  95. <dd><tt>if&nbsp;the&nbsp;exit&nbsp;is&nbsp;special,&nbsp;a&nbsp;dir&nbsp;name&nbsp;for&nbsp;the&nbsp;exit&nbsp;that&nbsp;leads&nbsp;back&nbsp;to<br>
  96. this&nbsp;exit's&nbsp;room.</tt></dd>
  97. </dl>
  98. <dl><dt><strong>pick_diff</strong></dt>
  99. <dd><tt>Integer&nbsp;value&nbsp;representing&nbsp;how&nbsp;hard&nbsp;the&nbsp;exit's&nbsp;lock&nbsp;is&nbsp;to&nbsp;pick.</tt></dd>
  100. </dl>
  101. <dl><dt><strong>room</strong></dt>
  102. <dd><tt>The&nbsp;room&nbsp;we&nbsp;this&nbsp;exit&nbsp;is&nbsp;attached&nbsp;to.&nbsp;Immutable.</tt></dd>
  103. </dl>
  104. <dl><dt><strong>spot_diff</strong></dt>
  105. <dd><tt>Integer&nbsp;value&nbsp;representing&nbsp;how&nbsp;hard&nbsp;to&nbsp;see&nbsp;the&nbsp;exit&nbsp;is.</tt></dd>
  106. </dl>
  107. <dl><dt><strong>uid</strong></dt>
  108. <dd><tt>The&nbsp;exit's&nbsp;universal&nbsp;identification&nbsp;nubmer.&nbsp;Immutable.</tt></dd>
  109. </dl>
  110. <hr>
  111. Data and other attributes defined here:<br>
  112. <dl><dt><strong>__new__</strong> = &lt;built-in method __new__ of type object at 0x6f780&gt;<dd><tt>T.<a href="#Exit-__new__">__new__</a>(S,&nbsp;...)&nbsp;-&gt;&nbsp;a&nbsp;new&nbsp;<a href="__builtin__.html#object">object</a>&nbsp;with&nbsp;type&nbsp;S,&nbsp;a&nbsp;subtype&nbsp;of&nbsp;T</tt></dl>
  113. </td></tr></table></td></tr></table>
  114. </body></html>