Skip to content

Commit ff57ad3

Browse files
devnatanCopilot
andauthored
Update inventory-framework-api/src/main/java/me/devnatan/inventoryframework/context/IFConfinedContext.java
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Natan Vieira <24600258+devnatan@users.noreply.github.com>
1 parent 5e389b6 commit ff57ad3

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

inventory-framework-api/src/main/java/me/devnatan/inventoryframework/context/IFConfinedContext.java

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -61,27 +61,27 @@ public interface IFConfinedContext extends IFContext {
6161
void updateTitleForPlayer(@NotNull String title);
6262

6363
/**
64-
* Updates the container title only for the player current scope of execution.
64+
* Updates the container title only for the player in the current scope of execution using a component or non-String object.
6565
*
66-
* <p>This should not be used before the container is opened, if you need to set the __initial
67-
* title__ use {@link IFOpenContext#modifyConfig()} on open handler instead.
66+
* <p>This should not be used before the container is opened. If you need to set the __initial
67+
* title__, use {@link IFOpenContext#modifyConfig()} on open handler instead.
6868
*
69-
* <p>This method is version dependant, so it may be that your server version is not yet
70-
* supported, if you try to use this method and fail (can fail silently), report it to the
71-
* library developers to add support to your version.
69+
* <p>This method is version dependent, so it may be that your server version is not yet
70+
* supported. If you try to use this method and it fails (can fail silently), report it to the
71+
* library developers to add support for your version.
7272
* <p>
7373
*
7474
* <a href="https://github.com/KyoriPowered/adventure">Kyori's Adventure Text Component</a> is supported if your platform is PaperSpigot
75-
* in a non-legacy version. Non-{@link String} titles will be converted to a plain text.
75+
* in a non-legacy version. Non-{@link String} titles will be converted to plain text.
7676
* <p>
77-
* <b><i> This API is experimental and is not subject to the general compatibility guarantees
77+
* <b><i> This API is experimental and is not subject to the general compatibility guarantees;
7878
* such API may be changed or may be removed completely in any further release. </i></b>
7979
*
80-
* @param title The new container title.
80+
* @param titleComponent The new container title as a component or object.
8181
* @see <a href="https://github.com/DevNatan/inventory-framework/wiki/dynamic-title-update">Dynamic Title Update on Wiki</a>
8282
*/
8383
@ApiStatus.Experimental
84-
void updateTitleForPlayer(@NotNull Object title);
84+
void updateTitleComponentForPlayer(@NotNull Object titleComponent);
8585

8686
/**
8787
* Resets the container title only for the player current scope of execution to the initially

0 commit comments

Comments
 (0)