Skip to content

Commit 4f152f5

Browse files
TrentinTheKidTrentinTheKid
authored
Various documentation improvements (#185)
* fixes * remove unnecessary headers * remove unnecessary headers from beam module * remove unnecessary headers * test * use bold instead of header * update border color
1 parent 8f325e4 commit 4f152f5

29 files changed

+149
-148
lines changed

‎docs/developers/events.mdx‎

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Apollo provides its own listener based event system, similar to the existing eve
1111
<details>
1212
<summary>ApolloRegisterPlayerEvent</summary>
1313

14-
#### ApolloRegisterPlayerEvent
14+
### ApolloRegisterPlayerEvent
1515

1616
_Called when the player joins the server using Lunar Client._
1717

@@ -24,7 +24,7 @@ _Called when the player joins the server using Lunar Client._
2424
<details>
2525
<summary>ApolloUnregisterPlayerEvent</summary>
2626

27-
#### ApolloUnregisterPlayerEvent
27+
### ApolloUnregisterPlayerEvent
2828

2929
_Called when the player leaves the server using Lunar Client._
3030

@@ -37,7 +37,7 @@ _Called when the player leaves the server using Lunar Client._
3737
<details>
3838
<summary>ApolloPlayerHandshakeEvent</summary>
3939

40-
#### ApolloPlayerHandshakeEvent
40+
### ApolloPlayerHandshakeEvent
4141

4242
_Called when the client sends a PlayerHandshakeMessage._
4343

@@ -52,7 +52,7 @@ _Called when the client sends a PlayerHandshakeMessage._
5252
<details>
5353
<summary>Minecraft Version Information</summary>
5454

55-
##### All `MinecraftVersion minecraftVersion` Versions
55+
**All `MinecraftVersion minecraftVersion` Versions**
5656

5757
- V1_7
5858
- V1_8
@@ -85,7 +85,7 @@ _Called when the client sends a PlayerHandshakeMessage._
8585
<details>
8686
<summary>Lunar Client Version Information</summary>
8787

88-
##### How `LunarClientVersion lunarClientVersion` Works
88+
**How `lunarClientVersion` Works**
8989

9090
This returns all the attributes about the version of Lunar Client the player is using.
9191

@@ -100,7 +100,7 @@ This returns all the attributes about the version of Lunar Client the player is
100100
<details>
101101
<summary>LunarClientMod (Installed Mods) Information</summary>
102102

103-
##### How `List<LunarClientMod> installedMods` Works
103+
**How `installedMods` Works**
104104

105105
This returns a list of each mod, and its respective attributes.
106106

@@ -129,7 +129,7 @@ This returns a list of each mod, and its respective attributes.
129129
<details>
130130
<summary>ApolloReceivePacketEvent</summary>
131131

132-
#### ApolloReceivePacketEvent
132+
### ApolloReceivePacketEvent
133133

134134
_Called when the Apollo player receives an Apollo packet from Lunar Client._
135135

@@ -143,7 +143,7 @@ _Called when the Apollo player receives an Apollo packet from Lunar Client._
143143
<details>
144144
<summary>ApolloSendPacketEvent</summary>
145145

146-
#### ApolloSendPacketEvent
146+
### ApolloSendPacketEvent
147147

148148
_Called when the Apollo player sends an Apollo packet to Lunar Client._
149149

@@ -159,7 +159,7 @@ _Called when the Apollo player sends an Apollo packet to Lunar Client._
159159
<details>
160160
<summary>ApolloUpdateOptionEvent</summary>
161161

162-
#### ApolloUpdateOptionEvent
162+
### ApolloUpdateOptionEvent
163163

164164
_Called when an option is updated._
165165

@@ -177,7 +177,7 @@ _Called when an option is updated._
177177
<details>
178178
<summary>ApolloPlayerChatCloseEvent</summary>
179179

180-
#### ApolloPlayerChatCloseEvent
180+
### ApolloPlayerChatCloseEvent
181181

182182
_Called when the player closes their chat._
183183

@@ -191,7 +191,7 @@ _Called when the player closes their chat._
191191
<details>
192192
<summary>ApolloPlayerChatOpenEvent</summary>
193193

194-
#### ApolloPlayerChatOpenEvent
194+
### ApolloPlayerChatOpenEvent
195195

196196
_Called when the player opens their chat._
197197

@@ -205,7 +205,7 @@ _Called when the player opens their chat._
205205
<details>
206206
<summary>ApolloPlayerAttackEvent</summary>
207207

208-
#### ApolloPlayerAttackEvent
208+
### ApolloPlayerAttackEvent
209209

210210
_Called when the player attacks another player._
211211

@@ -221,7 +221,7 @@ _Called when the player attacks another player._
221221
<details>
222222
<summary>ApolloPlayerUseItemEvent</summary>
223223

224-
#### ApolloPlayerUseItemEvent
224+
### ApolloPlayerUseItemEvent
225225

226226
_Called when the player uses an item (1.16.1+)._
227227

‎docs/developers/modules/beam.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ Custom colors can be created from any RGB values using `new Color(int red, int g
129129

130130
<Tab>
131131

132-
### Displaying a Beam
132+
**Displaying a Beam**
133133

134134
```java
135135
public void displayBeamExample(Player viewer) {
@@ -143,7 +143,7 @@ public void displayBeamExample(Player viewer) {
143143
}
144144
```
145145

146-
### Removing a Beam
146+
**Removing a Beam**
147147

148148
```java
149149
public void removeBeamExample(Player viewer) {
@@ -155,7 +155,7 @@ public void removeBeamExample(Player viewer) {
155155
}
156156
```
157157

158-
### Resetting all Beams
158+
**Resetting all Beams**
159159

160160
```java
161161
public void resetBeamsExample(Player viewer) {
@@ -168,7 +168,7 @@ public void resetBeamsExample(Player viewer) {
168168

169169
<Tab>
170170

171-
### Displaying a Beam
171+
**Displaying a Beam**
172172

173173
```java
174174
public void displayBeamExample(Player viewer) {
@@ -184,7 +184,7 @@ public void displayBeamExample(Player viewer) {
184184
}
185185
```
186186

187-
### Removing a Beam
187+
**Removing a Beam**
188188

189189
```java
190190
public void removeBeamExample(Player viewer) {
@@ -196,7 +196,7 @@ public void removeBeamExample(Player viewer) {
196196
}
197197
```
198198

199-
### Resetting all Beams
199+
**Resetting all Beams**
200200

201201
```java
202202
public void resetBeamsExample(Player viewer) {

‎docs/developers/modules/border.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Custom colors can be created from any RGB values using `new Color(int red, int g
157157

158158
<Tab>
159159

160-
### Displaying a Border
160+
**Displaying a Border**
161161

162162
```java
163163
public void displayBorderExample(Player viewer) {
@@ -176,7 +176,7 @@ public void displayBorderExample(Player viewer) {
176176
}
177177
```
178178

179-
### Removing a Border
179+
**Removing a Border**
180180

181181
```java
182182
public void removeBorderExample(Player viewer) {
@@ -188,7 +188,7 @@ public void removeBorderExample(Player viewer) {
188188
}
189189
```
190190

191-
### Resetting all Borders
191+
**Resetting all Borders**
192192

193193
```java
194194
public void resetBordersExample(Player viewer) {
@@ -201,7 +201,7 @@ public void resetBordersExample(Player viewer) {
201201

202202
<Tab>
203203

204-
### Displaying a Border
204+
**Displaying a Border**
205205

206206
```java
207207
public void displayBorderExample(Player viewer) {
@@ -220,7 +220,7 @@ public void displayBorderExample(Player viewer) {
220220
}
221221
```
222222

223-
### Removing a Border
223+
**Removing a Border**
224224

225225
```java
226226
public void removeBorderExample(Player viewer) {
@@ -232,7 +232,7 @@ public void removeBorderExample(Player viewer) {
232232
}
233233
```
234234

235-
### Resetting all Borders
235+
**Resetting all Borders**
236236

237237
```java
238238
public void resetBordersExample(Player viewer) {

‎docs/developers/modules/chat.mdx‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public void removeLiveChatMessageExample() {
5454

5555
<Tab>
5656

57-
### Displaying a Live Chat Message
57+
**Displaying a Live Chat Message**
5858

5959
```java
6060
private int countdown = 5;
@@ -76,7 +76,7 @@ public void displayLiveChatMessageExample() {
7676
}
7777
```
7878

79-
### Removing a Live Chat Message
79+
**Removing a Live Chat Message**
8080

8181
```java
8282
public void removeLiveChatMessageExample() {
@@ -92,7 +92,7 @@ public void removeLiveChatMessageExample() {
9292

9393
<Tab>
9494

95-
### Displaying a Live Chat Message
95+
**Displaying a Live Chat Message**
9696

9797
```java
9898
private int countdown = 5;
@@ -114,7 +114,7 @@ public void displayLiveChatMessageExample() {
114114
}
115115
```
116116

117-
### Removing a Live Chat Message
117+
**Removing a Live Chat Message**
118118

119119
```java
120120
public void removeLiveChatMessageExample() {

‎docs/developers/modules/coloredfire.mdx‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public void resetColoredFiresExample(Player viewer) {
6262

6363
<Tab>
6464

65-
### Override a Fire Color
65+
**Override a Fire Color**
6666

6767
```java
6868
public void overrideColoredFireExample(UUID burningPlayer) {
@@ -75,7 +75,7 @@ public void overrideColoredFireExample(UUID burningPlayer) {
7575
}
7676
```
7777

78-
### Removing a Fire Color
78+
**Removing a Fire Color**
7979

8080
```java
8181
public void resetColoredFireExample(UUID burningPlayer) {
@@ -87,7 +87,7 @@ public void resetColoredFireExample(UUID burningPlayer) {
8787
}
8888
```
8989

90-
### Resetting all Fire Colors
90+
**Resetting all Fire Colors**
9191

9292
```java
9393
public void resetColoredFiresExample(Player viewer) {
@@ -100,7 +100,7 @@ public void resetColoredFiresExample(Player viewer) {
100100

101101
<Tab>
102102

103-
### Override a Fire Color
103+
**Override a Fire Color**
104104

105105
```java
106106
public void overrideColoredFireExample(UUID burningPlayer) {
@@ -113,7 +113,7 @@ public void overrideColoredFireExample(UUID burningPlayer) {
113113
}
114114
```
115115

116-
### Removing a Fire Color
116+
**Removing a Fire Color**
117117

118118
```java
119119
public void resetColoredFireExample(UUID burningPlayer) {
@@ -125,7 +125,7 @@ public void resetColoredFireExample(UUID burningPlayer) {
125125
}
126126
```
127127

128-
### Resetting all Fire Colors
128+
**Resetting all Fire Colors**
129129

130130
```java
131131
public void resetColoredFiresExample(Player viewer) {

‎docs/developers/modules/cooldown.mdx‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -114,7 +114,7 @@ public void resetCooldownsExample(Player viewer) {
114114

115115
<Tab>
116116

117-
### Displaying a Cooldown with an item
117+
**Displaying a Cooldown with an item**
118118

119119
```java
120120
public void displayCooldownItemExample(Player viewer) {
@@ -128,7 +128,7 @@ public void displayCooldownItemExample(Player viewer) {
128128
}
129129
```
130130

131-
### Displaying a Cooldown with a resource
131+
**Displaying a Cooldown with a resource**
132132

133133
```java
134134
public void displayCooldownResourceExample(Player viewer) {
@@ -142,7 +142,7 @@ public void displayCooldownResourceExample(Player viewer) {
142142
}
143143
```
144144

145-
### Removing a Cooldown
145+
**Removing a Cooldown**
146146

147147
```java
148148
public void removeCooldownExample(Player viewer) {
@@ -154,7 +154,7 @@ public void removeCooldownExample(Player viewer) {
154154
}
155155
```
156156

157-
### Resetting all Cooldowns
157+
**Resetting all Cooldowns**
158158

159159
```java
160160
public void resetCooldownsExample(Player viewer) {
@@ -167,7 +167,7 @@ public void resetCooldownsExample(Player viewer) {
167167

168168
<Tab>
169169

170-
### Displaying a Cooldown with an item
170+
**Displaying a Cooldown with an item**
171171

172172
```java
173173
public void displayCooldownItemExample(Player viewer) {
@@ -181,7 +181,7 @@ public void displayCooldownItemExample(Player viewer) {
181181
}
182182
```
183183

184-
### Displaying a Cooldown with a resource
184+
**Displaying a Cooldown with a resource**
185185

186186
```java
187187
public void displayCooldownResourceExample(Player viewer) {
@@ -195,7 +195,7 @@ public void displayCooldownResourceExample(Player viewer) {
195195
}
196196
```
197197

198-
### Removing a Cooldown
198+
**Removing a Cooldown**
199199

200200
```java
201201
public void removeCooldownExample(Player viewer) {
@@ -207,7 +207,7 @@ public void removeCooldownExample(Player viewer) {
207207
}
208208
```
209209

210-
### Resetting all Cooldowns
210+
**Resetting all Cooldowns**
211211

212212
```java
213213
public void resetCooldownsExample(Player viewer) {

0 commit comments

Comments
 (0)