1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<html><head>
<title>Class: Timer::Action</title>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<link rel=StyleSheet href="../.././rdoc-style.css" type="text/css" media="screen" />
<script type="text/javascript" language="JavaScript">
<!--
function popCode(url) {
window.open(url, "Code",
"resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
}
//-->
</script>
</head>
<body bgcolor="white">
<table summary="Information on class" width="100%" border="0" cellspacing="0">
<tr class="title-row">
<td class="big-title-font">
<sup><font color="aqua">Class</font></sup> Timer::Action
</td>
<td align="right">
<table summary="layout" cellspacing="0" cellpadding="2">
<tr valign="top">
<td class="small-title-font">In:</td>
<td class="small-title-font">
<a href="../../files/rbot/timer_rb.html" class="aqua">
rbot/timer.rb
</a>
<br />
</td>
</tr>
<tr>
<td class="small-title-font">Parent:</td>
<td class="small-title-font">
Object
</td>
</tr>
</table>
</td>
</tr>
</table>
<!-- banner header -->
<table summary="Diagram of classes and modules" width="100%">
<tr><td align="center">
<map name="map">
<area shape="RECT" coords="124,109,196,61" href="Action.html" alt="Class: Action">
<area shape="RECT" coords="28,109,100,61" href="Timer.html" alt="Class: Timer">
</map>
<img src="../../dot/m_4_0.png" usemap="#map" border=0 alt="Module: Timer">
</td></tr></table>
<div class="description"><p>
timer event, something to do and when/how often to do it
</p>
</div>
<table summary="Methods" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Methods</td></tr>
</table>
<div class="name-list">
<a href="#M000188">new</a>
<a href="#M000189">run</a>
</div>
<table summary="Attributes" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Attributes</td></tr>
</table>
<table summary="Attribute details" cellspacing="5">
<tr valign="top">
<td class="attr-name">:blocked</td>
<td align="center" class="attr-rw"> [RW] </td>
<td><p>
is this action blocked? if so it won't be run
</p>
</td>
</tr>
<tr valign="top">
<td class="attr-name">:in</td>
<td align="center" class="attr-rw"> [RW] </td>
<td><p>
when this action is due next (updated by tick())
</p>
</td>
</tr>
</table>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Class methods</td></tr>
</table>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000188"></a>
<a href="Action.src/M000188.html" target="Code" class="methodtitle"
onClick="popCode('Action.src/M000188.html');return false;">
<b>new</b>(period, data=nil, once=false, &func)
</a>
</td></tr>
</table>
<div class="description">
<table>
<tr><td valign="top">period:</td><td>how often (seconds) to run the action
</td></tr>
<tr><td valign="top">data:</td><td>optional data to pass to the proc
</td></tr>
<tr><td valign="top">once:</td><td>optional, if true, this action will be run once then removed
</td></tr>
<tr><td valign="top">func:</td><td>associate a block to be called to perform the action
</td></tr>
</table>
<p>
create a new action
</p>
</div>
<table summary="Method list" cellpadding="5" width="100%">
<tr><td class="tablesubtitle">Public Instance methods</td></tr>
</table>
<table summary="method" width="100%" cellspacing="0" cellpadding="5" border="0">
<tr><td class="methodtitle">
<a name="M000189"></a>
<a href="Action.src/M000189.html" target="Code" class="methodtitle"
onClick="popCode('Action.src/M000189.html');return false;">
<b>run</b>()
</a>
</td></tr>
</table>
<div class="description">
<p>
run the action by calling its proc
</p>
</div>
</body>
|
