mirror of
https://github.com/PaperMC/Paper.git
synced 2025-02-18 19:24:10 +01:00
parent
bd69020044
commit
156224dbfa
15 changed files with 27 additions and 27 deletions
paper-api
|
@ -83,7 +83,7 @@ Code Requirements
|
|||
* Do not attempt to fix multiple problems with a single patch or pull request.
|
||||
* Avoid moving or renaming classes.
|
||||
* All non-private methods and constructors must have specified nullability through [annotations](https://github.com/JetBrains/java-annotations)
|
||||
* All classes/methods/fields related to a [Minecraft Experimental Feature](https://minecraft.fandom.com/wiki/Experimental_Gameplay) must be marked with [`@MinecraftExperimental`](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/MinecraftExperimental.html)
|
||||
* All classes/methods/fields related to a [Minecraft Experimental Feature](https://minecraft.wiki/w/Experimental_Gameplay) must be marked with [`@MinecraftExperimental`](https://hub.spigotmc.org/javadocs/spigot/org/bukkit/MinecraftExperimental.html)
|
||||
* If necessary, you may consider the use of one of the following [ApiStatus Annotations](https://javadoc.io/doc/org.jetbrains/annotations-java5/23.0.0/org/jetbrains/annotations/ApiStatus.html):
|
||||
* [`@ApiStatus.Experimental`](https://javadoc.io/doc/org.jetbrains/annotations-java5/23.0.0/org/jetbrains/annotations/ApiStatus.Experimental.html) for API that is subject to change
|
||||
* [`@ApiStatus.Internal`](https://javadoc.io/doc/org.jetbrains/annotations-java5/23.0.0/org/jetbrains/annotations/ApiStatus.Internal.html) for API that is intended only for internal use in the Bukkit project and will not adhere to Bukkit's API contract
|
||||
|
|
|
@ -10,7 +10,7 @@ import org.jetbrains.annotations.Nullable;
|
|||
* GameRules dictate certain behavior within Minecraft itself
|
||||
* <br>
|
||||
* For more information please visit the
|
||||
* <a href="https://minecraft.gamepedia.com/Commands/gamerule">Minecraft
|
||||
* <a href="https://minecraft.wiki/w/Commands/gamerule">Minecraft
|
||||
* Wiki</a>
|
||||
*
|
||||
* @param <T> type of rule (Boolean or Integer)
|
||||
|
|
|
@ -3,8 +3,7 @@ package org.bukkit;
|
|||
/**
|
||||
* Further information regarding heightmaps.
|
||||
*
|
||||
* @see <a href="https://minecraft.gamepedia.com/Chunk_format">Gamepedia Chunk
|
||||
* Format</a>
|
||||
* @see <a href="https://minecraft.wiki/w/Chunk_format">Minecraft Wiki</a>
|
||||
*/
|
||||
public enum HeightMap {
|
||||
|
||||
|
|
|
@ -7919,7 +7919,7 @@ public enum Material implements Keyed, Translatable {
|
|||
* <li>Only occluding blocks can be "powered" ({@link Block#isBlockPowered()}).
|
||||
* </ul>
|
||||
* This list may be inconclusive. For a full list of the side effects of an occluding
|
||||
* block, see the <a href="https://minecraft.fandom.com/wiki/Opacity">Minecraft Wiki</a>.
|
||||
* block, see the <a href="https://minecraft.wiki/w/Opacity">Minecraft Wiki</a>.
|
||||
*
|
||||
* @return True if this material is a block and occludes light
|
||||
*/
|
||||
|
|
|
@ -9,7 +9,7 @@ import org.jetbrains.annotations.ApiStatus;
|
|||
|
||||
/**
|
||||
* Indicates that the annotated element (class, method, field, etc.) is part of a
|
||||
* <a href="https://minecraft.fandom.com/wiki/Experimental_Gameplay">minecraft experimental feature</a>
|
||||
* <a href="https://minecraft.wiki/w/Experimental_Gameplay">minecraft experimental feature</a>
|
||||
* and is subject to changes by Mojang.
|
||||
* <p>
|
||||
* <b>Note:</b> Elements marked with this annotation require the use of a datapack or otherwise
|
||||
|
|
|
@ -51,8 +51,7 @@ public interface UnsafeValues {
|
|||
* The advancement format is governed by Minecraft and has no specified
|
||||
* layout.
|
||||
* <br>
|
||||
* It is currently a JSON object, as described by the Minecraft Wiki:
|
||||
* http://minecraft.gamepedia.com/Advancements
|
||||
* It is currently a JSON object, as described by the <a href="https://minecraft.wiki/w/Advancements">Minecraft wiki</a>.
|
||||
* <br>
|
||||
* Loaded advancements will be stored and persisted across server restarts
|
||||
* and reloads.
|
||||
|
|
|
@ -321,7 +321,7 @@ public class WorldCreator {
|
|||
* @param generatorSettings The settings that should be used by the
|
||||
* generator
|
||||
* @return This object, for chaining
|
||||
* @see <a href="https://minecraft.gamepedia.com/Custom_dimension">Custom
|
||||
* @see <a href="https://minecraft.wiki/w/Custom_dimension">Custom
|
||||
* dimension</a> (scroll to "When the generator ID type is
|
||||
* <code>minecraft:flat</code>)"
|
||||
*/
|
||||
|
|
|
@ -223,7 +223,7 @@ public interface Structure extends TileState {
|
|||
/**
|
||||
* Only applicable while in {@link UsageMode#DATA}. Metadata are specific
|
||||
* functions that can be applied to the structure location. Consult the
|
||||
* <a href="https://minecraft.gamepedia.com/Structure_Block#Data">Minecraft
|
||||
* <a href="https://minecraft.wiki/w/Structure_Block#Data">Minecraft
|
||||
* wiki</a> for more information.
|
||||
*
|
||||
* @param metadata the function to perform on the selected location
|
||||
|
@ -233,7 +233,7 @@ public interface Structure extends TileState {
|
|||
/**
|
||||
* Get the metadata function this structure block will perform when
|
||||
* activated. Consult the
|
||||
* <a href="https://minecraft.gamepedia.com/Structure_Block#Data">Minecraft
|
||||
* <a href="https://minecraft.wiki/w/Structure_Block#Data">Minecraft
|
||||
* Wiki</a> for more information.
|
||||
*
|
||||
* @return the function that will be performed when this block is activated
|
||||
|
|
|
@ -23,7 +23,7 @@ public enum UsageMode {
|
|||
* Used to run specific custom functions, which can only be used for certain
|
||||
* Structures. The structure block is removed after this function completes.
|
||||
* The data tags (functions) can be found on the
|
||||
* <a href="http://minecraft.gamepedia.com/Structure_Block#Data">wiki</a>.
|
||||
* <a href="https://minecraft.wiki/w/Structure_Block#Data">wiki</a>.
|
||||
*/
|
||||
DATA;
|
||||
}
|
||||
|
|
|
@ -3,7 +3,7 @@ package org.bukkit.entity;
|
|||
/**
|
||||
* Represents groups of entities with shared spawn behaviors and mob caps.
|
||||
*
|
||||
* @see <a href="https://minecraft.fandom.com/wiki/Spawn#Java_Edition_mob_cap">Minecraft Wiki</a>
|
||||
* @see <a href="https://minecraft.wiki/w/Spawn#Java_Edition_mob_cap">Minecraft Wiki</a>
|
||||
*/
|
||||
public enum SpawnCategory {
|
||||
|
||||
|
|
|
@ -55,7 +55,7 @@ public interface TropicalFish extends Fish {
|
|||
|
||||
/**
|
||||
* Enumeration of all different fish patterns. Refer to the
|
||||
* <a href="https://minecraft.gamepedia.com/Fish_(mob)">Minecraft Wiki</a>
|
||||
* <a href="https://minecraft.wiki/w/Fish">Minecraft Wiki</a>
|
||||
* for pictures.
|
||||
*/
|
||||
public static enum Pattern {
|
||||
|
|
|
@ -12,8 +12,8 @@ import org.jetbrains.annotations.Nullable;
|
|||
* LootTables are technical files that represent what items should be in
|
||||
* naturally generated containers, what items should be dropped when killing a
|
||||
* mob, or what items can be fished.
|
||||
*
|
||||
* See the <a href="https://minecraft.gamepedia.com/Loot_table">
|
||||
* <br>
|
||||
* See the <a href="https://minecraft.wiki/w/Loot_table">
|
||||
* Minecraft Wiki</a> for more information.
|
||||
*/
|
||||
public interface LootTable extends Keyed {
|
||||
|
|
|
@ -8,9 +8,9 @@ import org.jetbrains.annotations.NotNull;
|
|||
/**
|
||||
* This enum holds a list of all known {@link LootTable}s offered by Mojang.
|
||||
* This list is not guaranteed to be accurate in future versions.
|
||||
*
|
||||
* <br>
|
||||
* See the
|
||||
* <a href="https://minecraft.gamepedia.com/Loot_table#List_of_loot_tables">
|
||||
* <a href="https://minecraft.wiki/w/Loot_table#List_of_loot_tables">
|
||||
* Minecraft Wiki</a> for more information on loot tables.
|
||||
*/
|
||||
public enum LootTables implements Keyed {
|
||||
|
|
|
@ -8,6 +8,8 @@ import org.jetbrains.annotations.NotNull;
|
|||
|
||||
/**
|
||||
* Represents a data pack.
|
||||
*
|
||||
* @see <a href="https://minecraft.wiki/w/Data_pack">Minecraft wiki</a>
|
||||
*/
|
||||
@ApiStatus.Experimental
|
||||
public interface DataPack extends Keyed {
|
||||
|
|
|
@ -335,7 +335,7 @@ public final class PluginDescriptionFile {
|
|||
* <li>An entry of this list can be referenced in {@link #getDepend()},
|
||||
* {@link #getSoftDepend()}, and {@link #getLoadBefore()}.
|
||||
* <li><code>provides</code> must be in <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* format</a>.
|
||||
* </ul>
|
||||
* <p>
|
||||
|
@ -454,7 +454,7 @@ public final class PluginDescriptionFile {
|
|||
* <li>A SpigotMC forum handle or email address is recommended.
|
||||
* <li>Is displayed when a user types <code>/version PluginName</code>
|
||||
* <li><code>authors</code> must be in <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* format</a>.
|
||||
* </ul>
|
||||
* <p>
|
||||
|
@ -491,7 +491,7 @@ public final class PluginDescriptionFile {
|
|||
* <li>A SpigotMC forum handle or email address is recommended.
|
||||
* <li>Is displayed when a user types <code>/version PluginName</code>
|
||||
* <li><code>contributors</code> must be in <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* format</a>.
|
||||
* </ul>
|
||||
* <p>
|
||||
|
@ -538,7 +538,7 @@ public final class PluginDescriptionFile {
|
|||
* href=https://en.wikipedia.org/wiki/Circular_dependency>network</a>,
|
||||
* all plugins in that network will fail.
|
||||
* <li><code>depend</code> must be in <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* format</a>.
|
||||
* </ul>
|
||||
* <p>
|
||||
|
@ -570,7 +570,7 @@ public final class PluginDescriptionFile {
|
|||
* or soft-dependending each other), it will arbitrarily choose a
|
||||
* plugin that can be resolved when ignoring soft-dependencies.
|
||||
* <li><code>softdepend</code> must be in <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* format</a>.
|
||||
* </ul>
|
||||
* <p>
|
||||
|
@ -597,7 +597,7 @@ public final class PluginDescriptionFile {
|
|||
* specified plugin's {@link #getSoftDepend()} include {@link
|
||||
* #getName() this plugin}.
|
||||
* <li><code>loadbefore</code> must be in <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* format</a>.
|
||||
* </ul>
|
||||
* <p>
|
||||
|
@ -661,7 +661,7 @@ public final class PluginDescriptionFile {
|
|||
* <td><code>aliases</code></td>
|
||||
* <td>{@link PluginCommand#setAliases(List)}</td>
|
||||
* <td>String or <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">List</a> of
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">List</a> of
|
||||
* strings</td>
|
||||
* <td>Alternative command names, with special usefulness for commands
|
||||
* that are already registered. <i>Aliases are not effective when
|
||||
|
@ -809,7 +809,7 @@ public final class PluginDescriptionFile {
|
|||
* <p>
|
||||
* Child permissions may be defined in a number of ways:<ul>
|
||||
* <li>Children may be defined as a <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">list</a> of
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">list</a> of
|
||||
* names. Using a list will treat all children associated
|
||||
* positively to their parent.
|
||||
* <li>Children may be defined as a map. Each permission name maps
|
||||
|
@ -917,7 +917,7 @@ public final class PluginDescriptionFile {
|
|||
* by the API, effectively discluding any derived type from any
|
||||
* plugin's classpath.
|
||||
* <li><code>awareness</code> must be in <a
|
||||
* href="http://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* href="https://en.wikipedia.org/wiki/YAML#Lists">YAML list
|
||||
* format</a>.
|
||||
* </ul>
|
||||
* <p>
|
||||
|
|
Loading…
Add table
Reference in a new issue