~jadedctrl/gem-xwx-moe

~jadedctrl/gem-xwx-moe/gemujo_ludo/mods.niaj/fasado/subtitles/doc/modules/SubtitleDisplay.html
 ..
0 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
1 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2 <html>
3 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
4 <head>
5 <title>Subtitles API Reference</title>
6 <link rel="stylesheet" href="../ldoc.css" type="text/css" />
7 </head>
8 <body>
9
10 <div id="container">
11
12 <div id="product">
13 <div id="product_logo"></div>
14 <div id="product_name"><big><b></b></big></div>
15 <div id="product_description"></div>
16 </div> <!-- id="product" -->
17
18
19 <div id="main">
20
21
22 <!-- Menu -->
23
24 <div id="navigation">
25 <br/>
26 <h1>ldoc</h1>
27
28 <ul>
29 <li><a href="../index.html">Index</a></li>
30 </ul>
31
32 <h2>Contents</h2>
33 <ul>
34 <li><a href="#Class_SubtitleDisplay">Class SubtitleDisplay </a></li>
35 </ul>
36
37
38 <h2>Modules</h2>
39 <ul class="nowrap">
40 <li><a href="../modules/Agent.html">Agent</a></li>
41 <li><a href="../modules/BaseTextSubtitleDisplay.html">BaseTextSubtitleDisplay</a></li>
42 <li><a href="../modules/ChatSubtitleDisplay.html">ChatSubtitleDisplay</a></li>
43 <li><a href="../modules/ClassicSubtitleDisplay.html">ClassicSubtitleDisplay</a></li>
44 <li><a href="../modules/CornerSubtitleDisplay.html">CornerSubtitleDisplay</a></li>
45 <li><a href="../modules/Sound.html">Sound</a></li>
46 <li><strong>SubtitleDisplay</strong></li>
47 <li><a href="../modules/WaypointSubtitleDisplay.html">WaypointSubtitleDisplay</a></li>
48 <li><a href="../modules/api.html">api</a></li>
49 <li><a href="../modules/chatcommands.html">chatcommands</a></li>
50 <li><a href="../modules/descriptions.html">descriptions</a></li>
51 <li><a href="../modules/init.html">init</a></li>
52 <li><a href="../modules/listeners.html">listeners</a></li>
53 <li><a href="../modules/menu.html">menu</a></li>
54 <li><a href="../modules/util.html">util</a></li>
55 </ul>
56
57 </div>
58
59 <div id="content">
60
61 <h1>Module <code>SubtitleDisplay</code></h1>
62 <p>Provides the SubtitleDisplay class, which is the base class for subtitle displays.</p>
63 <p></p>
64
65
66 <h2><a href="#Class_SubtitleDisplay">Class SubtitleDisplay </a></h2>
67 <table class="function_list">
68 <tr>
69 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:new">subtitles.SubtitleDisplay:new (username)</a></td>
70 <td class="summary">Constructor.</td>
71 </tr>
72 <tr>
73 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:init">subtitles.SubtitleDisplay:init ()</a></td>
74 <td class="summary">Initialises the display.</td>
75 </tr>
76 <tr>
77 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:register">subtitles.SubtitleDisplay:register ()</a></td>
78 <td class="summary">Registers the display, making it available to use.</td>
79 </tr>
80 <tr>
81 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:handle_sound_play">subtitles.SubtitleDisplay:handle_sound_play (sound)</a></td>
82 <td class="summary">Handles a call to `minetest.sound_play()` or an equivalent event.</td>
83 </tr>
84 <tr>
85 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:handle_sound_stop">subtitles.SubtitleDisplay:handle_sound_stop (sound_or_handle)</a></td>
86 <td class="summary">Handles a call to `minetest.sound_stop()` or an equivalent event.</td>
87 </tr>
88 <tr>
89 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:destroy">subtitles.SubtitleDisplay:destroy ()</a></td>
90 <td class="summary">Destroys the display.</td>
91 </tr>
92 <tr>
93 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:get_player">subtitles.SubtitleDisplay:get_player ()</a></td>
94 <td class="summary">Returns the display's owner.</td>
95 </tr>
96 <tr>
97 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:add_sound">subtitles.SubtitleDisplay:add_sound (sound)</a></td>
98 <td class="summary">Handles a subtitle being added.</td>
99 </tr>
100 <tr>
101 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:remove_sound">subtitles.SubtitleDisplay:remove_sound (sound)</a></td>
102 <td class="summary">Handles a subtitle being removed.</td>
103 </tr>
104 <tr>
105 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:update_sound">subtitles.SubtitleDisplay:update_sound (sound)</a></td>
106 <td class="summary">Handles a sound changing.</td>
107 </tr>
108 <tr>
109 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay:step">subtitles.SubtitleDisplay:step (dtime)</a></td>
110 <td class="summary">Called every game tick.</td>
111 </tr>
112 <tr>
113 <td class="name" nowrap><a href="#subtitles.SubtitleDisplay.get_by_name">subtitles.SubtitleDisplay.get_by_name (name)</a></td>
114 <td class="summary">Returns the subtitle display class with the specified name.</td>
115 </tr>
116 </table>
117
118 <br/>
119 <br/>
120
121
122 <h2 class="section-header has-description"><a name="Class_SubtitleDisplay"></a>Class SubtitleDisplay </h2>
123
124 <div class="section-description">
125 The base class for subtitle displays.
126 </div>
127 <dl class="function">
128 <dt>
129 <a name = "subtitles.SubtitleDisplay:new"></a>
130 <strong>subtitles.SubtitleDisplay:new (username)</strong>
131 </dt>
132 <dd>
133 Constructor.
134
135
136 <h3>Parameters:</h3>
137 <ul>
138 <li><span class="parameter">username</span>
139 The username of the player.
140 </li>
141 </ul>
142
143
144
145
146
147 </dd>
148 <dt>
149 <a name = "subtitles.SubtitleDisplay:init"></a>
150 <strong>subtitles.SubtitleDisplay:init ()</strong>
151 </dt>
152 <dd>
153 Initialises the display.
154
155
156
157
158
159
160
161 </dd>
162 <dt>
163 <a name = "subtitles.SubtitleDisplay:register"></a>
164 <strong>subtitles.SubtitleDisplay:register ()</strong>
165 </dt>
166 <dd>
167 Registers the display, making it available to use.
168
169
170
171
172
173
174
175 </dd>
176 <dt>
177 <a name = "subtitles.SubtitleDisplay:handle_sound_play"></a>
178 <strong>subtitles.SubtitleDisplay:handle_sound_play (sound)</strong>
179 </dt>
180 <dd>
181 Handles a call to `minetest.sound_play()` or an equivalent event.
182
183
184 <h3>Parameters:</h3>
185 <ul>
186 <li><span class="parameter">sound</span>
187 A `Sound` object.
188 </li>
189 </ul>
190
191
192
193
194
195 </dd>
196 <dt>
197 <a name = "subtitles.SubtitleDisplay:handle_sound_stop"></a>
198 <strong>subtitles.SubtitleDisplay:handle_sound_stop (sound_or_handle)</strong>
199 </dt>
200 <dd>
201 Handles a call to `minetest.sound_stop()` or an equivalent event.
202
203
204 <h3>Parameters:</h3>
205 <ul>
206 <li><span class="parameter">sound_or_handle</span>
207 The sound's numeric handle, or the `Sound` object
208 if it's ephemeral.
209 </li>
210 </ul>
211
212
213
214
215
216 </dd>
217 <dt>
218 <a name = "subtitles.SubtitleDisplay:destroy"></a>
219 <strong>subtitles.SubtitleDisplay:destroy ()</strong>
220 </dt>
221 <dd>
222 Destroys the display.
223
224
225
226
227
228
229
230 </dd>
231 <dt>
232 <a name = "subtitles.SubtitleDisplay:get_player"></a>
233 <strong>subtitles.SubtitleDisplay:get_player ()</strong>
234 </dt>
235 <dd>
236 Returns the display's owner.
237
238
239
240 <h3>Returns:</h3>
241 <ol>
242
243 The player's ObjectRef, or nil.
244 </ol>
245
246
247
248
249 </dd>
250 <dt>
251 <a name = "subtitles.SubtitleDisplay:add_sound"></a>
252 <strong>subtitles.SubtitleDisplay:add_sound (sound)</strong>
253 </dt>
254 <dd>
255 Handles a subtitle being added.
256
257
258 <h3>Parameters:</h3>
259 <ul>
260 <li><span class="parameter">sound</span>
261 A `Sound` object.
262 </li>
263 </ul>
264
265
266
267
268
269 </dd>
270 <dt>
271 <a name = "subtitles.SubtitleDisplay:remove_sound"></a>
272 <strong>subtitles.SubtitleDisplay:remove_sound (sound)</strong>
273 </dt>
274 <dd>
275 Handles a subtitle being removed.
276
277
278 <h3>Parameters:</h3>
279 <ul>
280 <li><span class="parameter">sound</span>
281 A `Sound` object.
282 </li>
283 </ul>
284
285
286
287
288
289 </dd>
290 <dt>
291 <a name = "subtitles.SubtitleDisplay:update_sound"></a>
292 <strong>subtitles.SubtitleDisplay:update_sound (sound)</strong>
293 </dt>
294 <dd>
295 Handles a sound changing.
296
297
298 <h3>Parameters:</h3>
299 <ul>
300 <li><span class="parameter">sound</span>
301 A `Sound` object.
302 </li>
303 </ul>
304
305
306
307
308
309 </dd>
310 <dt>
311 <a name = "subtitles.SubtitleDisplay:step"></a>
312 <strong>subtitles.SubtitleDisplay:step (dtime)</strong>
313 </dt>
314 <dd>
315 Called every game tick.
316
317
318 <h3>Parameters:</h3>
319 <ul>
320 <li><span class="parameter">dtime</span>
321 Seconds since the last tick.
322 </li>
323 </ul>
324
325
326
327
328
329 </dd>
330 <dt>
331 <a name = "subtitles.SubtitleDisplay.get_by_name"></a>
332 <strong>subtitles.SubtitleDisplay.get_by_name (name)</strong>
333 </dt>
334 <dd>
335 Returns the subtitle display class with the specified name.
336
337
338 <h3>Parameters:</h3>
339 <ul>
340 <li><span class="parameter">name</span>
341 A display name string.
342 </li>
343 </ul>
344
345 <h3>Returns:</h3>
346 <ol>
347
348 A subclass of `SubtitleDisplay` or nil.
349 </ol>
350
351
352
353
354 </dd>
355 </dl>
356
357
358 </div> <!-- id="content" -->
359 </div> <!-- id="main" -->
360 <div id="about">
361 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
362 <i style="float:right;">Last updated 2023-01-14 06:51:17 </i>
363 </div> <!-- id="about" -->
364 </div> <!-- id="container" -->
365 </body>
366 </html>