Skip to content

Various documentation improvements #185

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ItsNature merged 7 commits into from
Dec 19, 2024
Merged

Various documentation improvements #185

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
3c6c623
fixes
TrentinTheKid Dec 19, 2024
e1491bf
remove unnecessary headers
TrentinTheKid Dec 19, 2024
8db7324
remove unnecessary headers from beam module
TrentinTheKid Dec 19, 2024
6cddfd4
remove unnecessary headers
TrentinTheKid Dec 19, 2024
55f927d
test
TrentinTheKid Dec 19, 2024
7ac842f
use bold instead of header
TrentinTheKid Dec 19, 2024
b910df1
update border color
TrentinTheKid Dec 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 13 additions & 13 deletions docs/developers/events.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Apollo provides its own listener based event system, similar to the existing eve
<details>
<summary>ApolloRegisterPlayerEvent</summary>

#### ApolloRegisterPlayerEvent
### ApolloRegisterPlayerEvent

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

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

#### ApolloUnregisterPlayerEvent
### ApolloUnregisterPlayerEvent

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

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

#### ApolloPlayerHandshakeEvent
### ApolloPlayerHandshakeEvent

_Called when the client sends a PlayerHandshakeMessage._

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

##### All `MinecraftVersion minecraftVersion` Versions
**All `MinecraftVersion minecraftVersion` Versions**

- V1_7
- V1_8
Expand Down Expand Up @@ -85,7 +85,7 @@ _Called when the client sends a PlayerHandshakeMessage._
<details>
<summary>Lunar Client Version Information</summary>

##### How `LunarClientVersion lunarClientVersion` Works
**How `lunarClientVersion` Works**

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

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

##### How `List<LunarClientMod> installedMods` Works
**How `installedMods` Works**

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

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

#### ApolloReceivePacketEvent
### ApolloReceivePacketEvent

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

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

#### ApolloSendPacketEvent
### ApolloSendPacketEvent

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

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

#### ApolloUpdateOptionEvent
### ApolloUpdateOptionEvent

_Called when an option is updated._

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

#### ApolloPlayerChatCloseEvent
### ApolloPlayerChatCloseEvent

_Called when the player closes their chat._

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

#### ApolloPlayerChatOpenEvent
### ApolloPlayerChatOpenEvent

_Called when the player opens their chat._

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

#### ApolloPlayerAttackEvent
### ApolloPlayerAttackEvent

_Called when the player attacks another player._

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

#### ApolloPlayerUseItemEvent
### ApolloPlayerUseItemEvent

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

Expand Down
12 changes: 6 additions & 6 deletions docs/developers/modules/beam.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ Custom colors can be created from any RGB values using `new Color(int red, int g

<Tab>

### Displaying a Beam
**Displaying a Beam**

```java
public void displayBeamExample(Player viewer) {
Expand All @@ -143,7 +143,7 @@ public void displayBeamExample(Player viewer) {
}
```

### Removing a Beam
**Removing a Beam**

```java
public void removeBeamExample(Player viewer) {
Expand All @@ -155,7 +155,7 @@ public void removeBeamExample(Player viewer) {
}
```

### Resetting all Beams
**Resetting all Beams**

```java
public void resetBeamsExample(Player viewer) {
Expand All @@ -168,7 +168,7 @@ public void resetBeamsExample(Player viewer) {

<Tab>

### Displaying a Beam
**Displaying a Beam**

```java
public void displayBeamExample(Player viewer) {
Expand All @@ -184,7 +184,7 @@ public void displayBeamExample(Player viewer) {
}
```

### Removing a Beam
**Removing a Beam**

```java
public void removeBeamExample(Player viewer) {
Expand All @@ -196,7 +196,7 @@ public void removeBeamExample(Player viewer) {
}
```

### Resetting all Beams
**Resetting all Beams**

```java
public void resetBeamsExample(Player viewer) {
Expand Down
12 changes: 6 additions & 6 deletions docs/developers/modules/border.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,7 +157,7 @@ Custom colors can be created from any RGB values using `new Color(int red, int g

<Tab>

### Displaying a Border
**Displaying a Border**

```java
public void displayBorderExample(Player viewer) {
Expand All @@ -176,7 +176,7 @@ public void displayBorderExample(Player viewer) {
}
```

### Removing a Border
**Removing a Border**

```java
public void removeBorderExample(Player viewer) {
Expand All @@ -188,7 +188,7 @@ public void removeBorderExample(Player viewer) {
}
```

### Resetting all Borders
**Resetting all Borders**

```java
public void resetBordersExample(Player viewer) {
Expand All @@ -201,7 +201,7 @@ public void resetBordersExample(Player viewer) {

<Tab>

### Displaying a Border
**Displaying a Border**

```java
public void displayBorderExample(Player viewer) {
Expand All @@ -220,7 +220,7 @@ public void displayBorderExample(Player viewer) {
}
```

### Removing a Border
**Removing a Border**

```java
public void removeBorderExample(Player viewer) {
Expand All @@ -232,7 +232,7 @@ public void removeBorderExample(Player viewer) {
}
```

### Resetting all Borders
**Resetting all Borders**

```java
public void resetBordersExample(Player viewer) {
Expand Down
8 changes: 4 additions & 4 deletions docs/developers/modules/chat.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public void removeLiveChatMessageExample() {

<Tab>

### Displaying a Live Chat Message
**Displaying a Live Chat Message**

```java
private int countdown = 5;
Expand All @@ -76,7 +76,7 @@ public void displayLiveChatMessageExample() {
}
```

### Removing a Live Chat Message
**Removing a Live Chat Message**

```java
public void removeLiveChatMessageExample() {
Expand All @@ -92,7 +92,7 @@ public void removeLiveChatMessageExample() {

<Tab>

### Displaying a Live Chat Message
**Displaying a Live Chat Message**

```java
private int countdown = 5;
Expand All @@ -114,7 +114,7 @@ public void displayLiveChatMessageExample() {
}
```

### Removing a Live Chat Message
**Removing a Live Chat Message**

```java
public void removeLiveChatMessageExample() {
Expand Down
12 changes: 6 additions & 6 deletions docs/developers/modules/coloredfire.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ public void resetColoredFiresExample(Player viewer) {

<Tab>

### Override a Fire Color
**Override a Fire Color**

```java
public void overrideColoredFireExample(UUID burningPlayer) {
Expand All @@ -75,7 +75,7 @@ public void overrideColoredFireExample(UUID burningPlayer) {
}
```

### Removing a Fire Color
**Removing a Fire Color**

```java
public void resetColoredFireExample(UUID burningPlayer) {
Expand All @@ -87,7 +87,7 @@ public void resetColoredFireExample(UUID burningPlayer) {
}
```

### Resetting all Fire Colors
**Resetting all Fire Colors**

```java
public void resetColoredFiresExample(Player viewer) {
Expand All @@ -100,7 +100,7 @@ public void resetColoredFiresExample(Player viewer) {

<Tab>

### Override a Fire Color
**Override a Fire Color**

```java
public void overrideColoredFireExample(UUID burningPlayer) {
Expand All @@ -113,7 +113,7 @@ public void overrideColoredFireExample(UUID burningPlayer) {
}
```

### Removing a Fire Color
**Removing a Fire Color**

```java
public void resetColoredFireExample(UUID burningPlayer) {
Expand All @@ -125,7 +125,7 @@ public void resetColoredFireExample(UUID burningPlayer) {
}
```

### Resetting all Fire Colors
**Resetting all Fire Colors**

```java
public void resetColoredFiresExample(Player viewer) {
Expand Down
16 changes: 8 additions & 8 deletions docs/developers/modules/cooldown.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ public void resetCooldownsExample(Player viewer) {

<Tab>

### Displaying a Cooldown with an item
**Displaying a Cooldown with an item**

```java
public void displayCooldownItemExample(Player viewer) {
Expand All @@ -128,7 +128,7 @@ public void displayCooldownItemExample(Player viewer) {
}
```

### Displaying a Cooldown with a resource
**Displaying a Cooldown with a resource**

```java
public void displayCooldownResourceExample(Player viewer) {
Expand All @@ -142,7 +142,7 @@ public void displayCooldownResourceExample(Player viewer) {
}
```

### Removing a Cooldown
**Removing a Cooldown**

```java
public void removeCooldownExample(Player viewer) {
Expand All @@ -154,7 +154,7 @@ public void removeCooldownExample(Player viewer) {
}
```

### Resetting all Cooldowns
**Resetting all Cooldowns**

```java
public void resetCooldownsExample(Player viewer) {
Expand All @@ -167,7 +167,7 @@ public void resetCooldownsExample(Player viewer) {

<Tab>

### Displaying a Cooldown with an item
**Displaying a Cooldown with an item**

```java
public void displayCooldownItemExample(Player viewer) {
Expand All @@ -181,7 +181,7 @@ public void displayCooldownItemExample(Player viewer) {
}
```

### Displaying a Cooldown with a resource
**Displaying a Cooldown with a resource**

```java
public void displayCooldownResourceExample(Player viewer) {
Expand All @@ -195,7 +195,7 @@ public void displayCooldownResourceExample(Player viewer) {
}
```

### Removing a Cooldown
**Removing a Cooldown**

```java
public void removeCooldownExample(Player viewer) {
Expand All @@ -207,7 +207,7 @@ public void removeCooldownExample(Player viewer) {
}
```

### Resetting all Cooldowns
**Resetting all Cooldowns**

```java
public void resetCooldownsExample(Player viewer) {
Expand Down
Loading
Loading