1
0
mirror of https://github.com/GeyserMC/Geyser.git synced 2025-12-19 14:59:27 +00:00

Add since annotations to new API methods

This commit is contained in:
onebeastchris
2025-06-26 00:23:03 +02:00
parent 2ca4ea7652
commit 473cd0bb97

View File

@@ -67,6 +67,7 @@ public interface GeyserConnection extends Connection, CommandSource {
/** /**
* @return {@code true} if the client currently has a form open. * @return {@code true} if the client currently has a form open.
* @since 2.8.0
*/ */
boolean hasFormOpen(); boolean hasFormOpen();
@@ -81,7 +82,7 @@ public interface GeyserConnection extends Connection, CommandSource {
int protocolVersion(); int protocolVersion();
/** /**
* Tries to open the {@code minecraft:pause_screen_additions} dialog tag. This method opens this tag the same way Java does, that is: * Attempts to open the {@code minecraft:pause_screen_additions} dialog tag. This method opens this dialog the same way Java does, that is:
* *
* <ul> * <ul>
* <li>If there are multiple dialogs in the additions tag, the {@code minecraft:custom_options} dialog is opened to select a dialog.</li> * <li>If there are multiple dialogs in the additions tag, the {@code minecraft:custom_options} dialog is opened to select a dialog.</li>
@@ -91,11 +92,12 @@ public interface GeyserConnection extends Connection, CommandSource {
* </ul> * </ul>
* *
* <p>Use {@link GeyserConnection#hasFormOpen()} to check if a dialog was opened.</p> * <p>Use {@link GeyserConnection#hasFormOpen()} to check if a dialog was opened.</p>
* @since 2.8.0
*/ */
void openPauseScreenAdditions(); void openPauseScreenAdditions();
/** /**
* Tries to open the {@code minecraft:quick_actions} dialog tag. This method opens this tag the same way Java does, that is: * Attempts to open the {@code minecraft:quick_actions} dialog tag. This method opens this dialog the same way Java does, that is:
* *
* <ul> * <ul>
* <li>If there are multiple dialogs in the actions tag, the {@code minecraft:quick_actions} dialog is opened to select a dialog.</li> * <li>If there are multiple dialogs in the actions tag, the {@code minecraft:quick_actions} dialog is opened to select a dialog.</li>
@@ -104,6 +106,7 @@ public interface GeyserConnection extends Connection, CommandSource {
* </ul> * </ul>
* *
* <p>Use {@link GeyserConnection#hasFormOpen()} to check if a dialog was opened.</p> * <p>Use {@link GeyserConnection#hasFormOpen()} to check if a dialog was opened.</p>
* @since 2.8.0
*/ */
void openQuickActions(); void openQuickActions();
@@ -111,6 +114,7 @@ public interface GeyserConnection extends Connection, CommandSource {
* Sends a command as if the player had executed it. * Sends a command as if the player had executed it.
* *
* @param command the command without the leading forward-slash * @param command the command without the leading forward-slash
* @since 2.8.0
*/ */
void sendCommand(String command); void sendCommand(String command);