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 |
|
29 |
|
30 |
|
31 |
<h2>Modules</h2> |
32 |
<ul class="nowrap"> |
33 |
<li><a href="modules/Agent.html">Agent</a></li> |
34 |
<li><a href="modules/BaseTextSubtitleDisplay.html">BaseTextSubtitleDisplay</a></li> |
35 |
<li><a href="modules/ChatSubtitleDisplay.html">ChatSubtitleDisplay</a></li> |
36 |
<li><a href="modules/ClassicSubtitleDisplay.html">ClassicSubtitleDisplay</a></li> |
37 |
<li><a href="modules/CornerSubtitleDisplay.html">CornerSubtitleDisplay</a></li> |
38 |
<li><a href="modules/Sound.html">Sound</a></li> |
39 |
<li><a href="modules/SubtitleDisplay.html">SubtitleDisplay</a></li> |
40 |
<li><a href="modules/WaypointSubtitleDisplay.html">WaypointSubtitleDisplay</a></li> |
41 |
<li><a href="modules/api.html">api</a></li> |
42 |
<li><a href="modules/chatcommands.html">chatcommands</a></li> |
43 |
<li><a href="modules/descriptions.html">descriptions</a></li> |
44 |
<li><a href="modules/init.html">init</a></li> |
45 |
<li><a href="modules/listeners.html">listeners</a></li> |
46 |
<li><a href="modules/menu.html">menu</a></li> |
47 |
<li><a href="modules/util.html">util</a></li> |
48 |
</ul> |
49 |
|
50 |
</div> |
51 |
|
52 |
<div id="content"> |
53 |
|
54 |
|
55 |
|
56 |
<h2>Modules</h2> |
57 |
<table class="module_list"> |
58 |
<tr> |
59 |
<td class="name" nowrap><a href="modules/Agent.html">Agent</a></td> |
60 |
<td class="summary">Provides the Agent class, which represents a player.</td> |
61 |
</tr> |
62 |
<tr> |
63 |
<td class="name" nowrap><a href="modules/BaseTextSubtitleDisplay.html">BaseTextSubtitleDisplay</a></td> |
64 |
<td class="summary">Provides the BaseTextSubtitleDisplay class, a base class for subtitle displays using text HUDs.</td> |
65 |
</tr> |
66 |
<tr> |
67 |
<td class="name" nowrap><a href="modules/ChatSubtitleDisplay.html">ChatSubtitleDisplay</a></td> |
68 |
<td class="summary">Provides the ChatSubtitleDisplay class, which displays subtitles in the chat.</td> |
69 |
</tr> |
70 |
<tr> |
71 |
<td class="name" nowrap><a href="modules/ClassicSubtitleDisplay.html">ClassicSubtitleDisplay</a></td> |
72 |
<td class="summary">Provides the ClassicSubtitleDisplay class, which displays subtitles at the bottom of the screen.</td> |
73 |
</tr> |
74 |
<tr> |
75 |
<td class="name" nowrap><a href="modules/CornerSubtitleDisplay.html">CornerSubtitleDisplay</a></td> |
76 |
<td class="summary">Provides the CornerSubtitleDisplay class, which displays subtitles in a corner of the screen.</td> |
77 |
</tr> |
78 |
<tr> |
79 |
<td class="name" nowrap><a href="modules/Sound.html">Sound</a></td> |
80 |
<td class="summary">Provides the Sound class, which represents a playing sound effect.</td> |
81 |
</tr> |
82 |
<tr> |
83 |
<td class="name" nowrap><a href="modules/SubtitleDisplay.html">SubtitleDisplay</a></td> |
84 |
<td class="summary">Provides the SubtitleDisplay class, which is the base class for subtitle displays.</td> |
85 |
</tr> |
86 |
<tr> |
87 |
<td class="name" nowrap><a href="modules/WaypointSubtitleDisplay.html">WaypointSubtitleDisplay</a></td> |
88 |
<td class="summary">Provides the WaypointSubtitleDisplay class, which displays subtitles floating in the world.</td> |
89 |
</tr> |
90 |
<tr> |
91 |
<td class="name" nowrap><a href="modules/api.html">api</a></td> |
92 |
<td class="summary">Public API functions.</td> |
93 |
</tr> |
94 |
<tr> |
95 |
<td class="name" nowrap><a href="modules/chatcommands.html">chatcommands</a></td> |
96 |
<td class="summary">Provides the `/subtitles` command.</td> |
97 |
</tr> |
98 |
<tr> |
99 |
<td class="name" nowrap><a href="modules/descriptions.html">descriptions</a></td> |
100 |
<td class="summary">Defines descriptions for sounds.</td> |
101 |
</tr> |
102 |
<tr> |
103 |
<td class="name" nowrap><a href="modules/init.html">init</a></td> |
104 |
<td class="summary">Mod entry point.</td> |
105 |
</tr> |
106 |
<tr> |
107 |
<td class="name" nowrap><a href="modules/listeners.html">listeners</a></td> |
108 |
<td class="summary">Implements hooks and patches to detect when sounds are played and various other things.</td> |
109 |
</tr> |
110 |
<tr> |
111 |
<td class="name" nowrap><a href="modules/menu.html">menu</a></td> |
112 |
<td class="summary">Implements the subtitle menu GUI.</td> |
113 |
</tr> |
114 |
<tr> |
115 |
<td class="name" nowrap><a href="modules/util.html">util</a></td> |
116 |
<td class="summary">Generic utility functions.</td> |
117 |
</tr> |
118 |
</table> |
119 |
|
120 |
</div> <!-- id="content" --> |
121 |
</div> <!-- id="main" --> |
122 |
<div id="about"> |
123 |
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i> |
124 |
<i style="float:right;">Last updated 2023-01-14 06:51:17 </i> |
125 |
</div> <!-- id="about" --> |
126 |
</div> <!-- id="container" --> |
127 |
</body> |
128 |
</html> |