3
0
Mirror von https://github.com/PaperMC/Paper.git synchronisiert 2024-11-14 20:10:05 +01:00

Syntax highlighting and typo fix in CONTRIBUTING

Thanks @jamierocks
Dieser Commit ist enthalten in:
Zach Brown 2016-08-04 17:47:12 -05:00
Ursprung ae77393ad9
Commit c5f0256084
Es konnte kein GPG-Schlüssel zu dieser Signatur gefunden werden
GPG-Schlüssel-ID: CC9DA35FC5450B76

Datei anzeigen

@ -115,11 +115,11 @@ entity.getWorld().explode(new BlockPosition(spawnLocation.getX(), spawnLocation.
In an effort to make future updates easier on ourselves, Paper tries to use obfuscation helpers whenever possible. The purpose of these helpers is to make the code more readable. These helpers should be be made as easy to inline as possible by the JVM whenever possible. In an effort to make future updates easier on ourselves, Paper tries to use obfuscation helpers whenever possible. The purpose of these helpers is to make the code more readable. These helpers should be be made as easy to inline as possible by the JVM whenever possible.
An obfuscation helper to get an obfuscated field may be as simple as something like this: An obfuscation helper to get an obfuscated field may be as simple as something like this:
``` ```java
public final int getStuckArrows() { return this.bY(); } // Paper - OBFHELPER public final int getStuckArrows() { return this.bY(); } // Paper - OBFHELPER
``` ```
Or it may be as compex as forwarding an entire method so that it can be overriden later: Or it may be as complex as forwarding an entire method so that it can be overriden later:
``` ```java
public boolean be() { public boolean be() {
// Paper start - OBFHELPER // Paper start - OBFHELPER
return this.pushedByWater(); return this.pushedByWater();
@ -136,7 +136,7 @@ While they may not always be done in exactly the same way each time, the general
To use a configurable value in your patch, add a new entry in either ```PaperConfig``` or ```PaperWorldConfig```. Use the former if a value must remain the same throughout all worlds, or the latter if it can change between worlds. The latter is preferred whenever possible. To use a configurable value in your patch, add a new entry in either ```PaperConfig``` or ```PaperWorldConfig```. Use the former if a value must remain the same throughout all worlds, or the latter if it can change between worlds. The latter is preferred whenever possible.
###```PaperConfig``` example: ###```PaperConfig``` example:
``` ```java
public static boolean saveEmptyScoreboardTeams = false; public static boolean saveEmptyScoreboardTeams = false;
private static void saveEmptyScoreboardTeams() { private static void saveEmptyScoreboardTeams() {
saveEmptyScoreboardTeams = getBoolean("settings.save-empty-scoreboard-teams", false); saveEmptyScoreboardTeams = getBoolean("settings.save-empty-scoreboard-teams", false);
@ -146,7 +146,7 @@ Notice that the field is always public, but the setter is always private. This i
```if (!PaperConfig.saveEmptyScoreboardTeams) {``` ```if (!PaperConfig.saveEmptyScoreboardTeams) {```
###```PaperWorldConfig``` example: ###```PaperWorldConfig``` example:
``` ```java
public boolean useInhabitedTime = true; public boolean useInhabitedTime = true;
private void useInhabitedTime() { private void useInhabitedTime() {
useInhabitedTime = getBoolean("use-chunk-inhabited-timer", true); useInhabitedTime = getBoolean("use-chunk-inhabited-timer", true);