~jadedctrl/gem-xwx-moe

~jadedctrl/gem-xwx-moe/gemujo_ludo/mods.niaj/fasado/subtitles/doc/modules/api.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="#Functions">Functions</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><a href="../modules/SubtitleDisplay.html">SubtitleDisplay</a></li>
47 <li><a href="../modules/WaypointSubtitleDisplay.html">WaypointSubtitleDisplay</a></li>
48 <li><strong>api</strong></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>api</code></h1>
62 <p>Public API functions.</p>
63 <p></p>
64
65
66 <h2><a href="#Functions">Functions</a></h2>
67 <table class="function_list">
68 <tr>
69 <td class="name" nowrap><a href="#subtitles.on_sound_play">subtitles.on_sound_play (spec, parameters, handle)</a></td>
70 <td class="summary">Handles a call to minetest.sound_play(), or an equivalent event.</td>
71 </tr>
72 <tr>
73 <td class="name" nowrap><a href="#subtitles.on_sound_stop">subtitles.on_sound_stop (handle)</a></td>
74 <td class="summary">Handles a call to minetest.sound_stop(), or an equivalent event.</td>
75 </tr>
76 <tr>
77 <td class="name" nowrap><a href="#subtitles.get_agent">subtitles.get_agent (player)</a></td>
78 <td class="summary">Returns the Agent object associated with the specified player.</td>
79 </tr>
80 <tr>
81 <td class="name" nowrap><a href="#subtitles.on_node_action">subtitles.on_node_action (pos, node, action)</a></td>
82 <td class="summary">Handles a node action.</td>
83 </tr>
84 <tr>
85 <td class="name" nowrap><a href="#subtitles.register_description">subtitles.register_description (name, description, parameters)</a></td>
86 <td class="summary">Registers a description associated with a sound name.</td>
87 </tr>
88 <tr>
89 <td class="name" nowrap><a href="#subtitles.report_missing">subtitles.report_missing (name)</a></td>
90 <td class="summary">Reports a missing subtitle to the debug log.</td>
91 </tr>
92 </table>
93
94 <br/>
95 <br/>
96
97
98 <h2 class="section-header "><a name="Functions"></a>Functions</h2>
99
100 <dl class="function">
101 <dt>
102 <a name = "subtitles.on_sound_play"></a>
103 <strong>subtitles.on_sound_play (spec, parameters, handle)</strong>
104 </dt>
105 <dd>
106 Handles a call to minetest.sound_play(), or an equivalent event.
107
108
109 <h3>Parameters:</h3>
110 <ul>
111 <li><span class="parameter">spec</span>
112 A SimpleSoundSpec.
113 </li>
114 <li><span class="parameter">parameters</span>
115 The sound parameters.
116 </li>
117 <li><span class="parameter">handle</span>
118 The sound's handle, or nil if the sound is ephemeral.
119 </li>
120 </ul>
121
122
123
124
125
126 </dd>
127 <dt>
128 <a name = "subtitles.on_sound_stop"></a>
129 <strong>subtitles.on_sound_stop (handle)</strong>
130 </dt>
131 <dd>
132 Handles a call to minetest.sound_stop(), or an equivalent event.
133
134
135 <h3>Parameters:</h3>
136 <ul>
137 <li><span class="parameter">handle</span>
138 The sound's handle.
139 </li>
140 </ul>
141
142
143
144
145
146 </dd>
147 <dt>
148 <a name = "subtitles.get_agent"></a>
149 <strong>subtitles.get_agent (player)</strong>
150 </dt>
151 <dd>
152 Returns the Agent object associated with the specified player.
153 The agent is created if necessary.
154
155
156 <h3>Parameters:</h3>
157 <ul>
158 <li><span class="parameter">player</span>
159 A username or `ObjectRef` of a connected player.
160 </li>
161 </ul>
162
163 <h3>Returns:</h3>
164 <ol>
165
166 An `Agent` object.
167 </ol>
168
169
170
171
172 </dd>
173 <dt>
174 <a name = "subtitles.on_node_action"></a>
175 <strong>subtitles.on_node_action (pos, node, action)</strong>
176 </dt>
177 <dd>
178 Handles a node action.
179
180
181 <h3>Parameters:</h3>
182 <ul>
183 <li><span class="parameter">pos</span>
184 The position of the node, as a integer vector.
185 </li>
186 <li><span class="parameter">node</span>
187 The node table or node name.
188 </li>
189 <li><span class="parameter">action</span>
190 A key in the `sounds` table, such as 'dig' or 'footstep'.
191 </li>
192 </ul>
193
194
195
196
197
198 </dd>
199 <dt>
200 <a name = "subtitles.register_description"></a>
201 <strong>subtitles.register_description (name, description, parameters)</strong>
202 </dt>
203 <dd>
204 Registers a description associated with a sound name.
205 When this sound is played, it will have the specified description unless a
206 description is explicitly specified.
207
208
209 <h3>Parameters:</h3>
210 <ul>
211 <li><span class="parameter">name</span>
212 The technical name of the sound, without the extension or index.
213 </li>
214 <li><span class="parameter">description</span>
215 The human-readable description of the sound, or nil to not associate a description.
216 </li>
217 <li><span class="parameter">parameters</span>
218 A table of parameters to override when playing this sound, or nil.
219 </li>
220 </ul>
221
222
223
224
225
226 </dd>
227 <dt>
228 <a name = "subtitles.report_missing"></a>
229 <strong>subtitles.report_missing (name)</strong>
230 </dt>
231 <dd>
232 Reports a missing subtitle to the debug log.
233
234
235 <h3>Parameters:</h3>
236 <ul>
237 <li><span class="parameter">name</span>
238 The technical name of the sound.
239 </li>
240 </ul>
241
242
243
244
245
246 </dd>
247 </dl>
248
249
250 </div> <!-- id="content" -->
251 </div> <!-- id="main" -->
252 <div id="about">
253 <i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
254 <i style="float:right;">Last updated 2023-01-14 06:51:17 </i>
255 </div> <!-- id="about" -->
256 </div> <!-- id="container" -->
257 </body>
258 </html>