mirror of
https://github.com/filoghost/HolographicDisplays.git
synced 2024-12-25 02:07:36 +01:00
Add missing Javadocs
This commit is contained in:
parent
c850488ba7
commit
459abdc2f8
@ -192,6 +192,7 @@ public interface HolographicDisplaysAPI {
|
|||||||
* Returns if a placeholder with a given identifier is registered.
|
* Returns if a placeholder with a given identifier is registered.
|
||||||
*
|
*
|
||||||
* @param identifier the case-insensitive identifier of the placeholder
|
* @param identifier the case-insensitive identifier of the placeholder
|
||||||
|
* @return if the given placeholder identifier exists
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
boolean isRegisteredPlaceholder(@NotNull String identifier);
|
boolean isRegisteredPlaceholder(@NotNull String identifier);
|
||||||
|
@ -199,6 +199,7 @@ public interface Position {
|
|||||||
* @param x the length to add to the X coordinate
|
* @param x the length to add to the X coordinate
|
||||||
* @param y the length to add to the Y coordinate
|
* @param y the length to add to the Y coordinate
|
||||||
* @param z the length to add to the Z coordinate
|
* @param z the length to add to the Z coordinate
|
||||||
|
* @return the new position
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
@NotNull Position add(double x, double y, double z);
|
@NotNull Position add(double x, double y, double z);
|
||||||
@ -209,6 +210,7 @@ public interface Position {
|
|||||||
* @param x the length to subtract from the X coordinate
|
* @param x the length to subtract from the X coordinate
|
||||||
* @param y the length to subtract from the Y coordinate
|
* @param y the length to subtract from the Y coordinate
|
||||||
* @param z the length to subtract from the Z coordinate
|
* @param z the length to subtract from the Z coordinate
|
||||||
|
* @return the new position
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
@NotNull Position subtract(double x, double y, double z);
|
@NotNull Position subtract(double x, double y, double z);
|
||||||
|
@ -41,6 +41,8 @@ public interface VisibilitySettings {
|
|||||||
* ({@link #getGlobalVisibility()}). The individual visibility value can be removed with
|
* ({@link #getGlobalVisibility()}). The individual visibility value can be removed with
|
||||||
* {@link #removeIndividualVisibility(Player)}.
|
* {@link #removeIndividualVisibility(Player)}.
|
||||||
*
|
*
|
||||||
|
* @param player the player for which to set the individual visibility
|
||||||
|
* @param visibility the new individual visibility to use for the player
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
void setIndividualVisibility(@NotNull Player player, @NotNull Visibility visibility);
|
void setIndividualVisibility(@NotNull Player player, @NotNull Visibility visibility);
|
||||||
@ -49,6 +51,7 @@ public interface VisibilitySettings {
|
|||||||
* Removes the individual visibility for a player. The visibility for the player will then be determined by the
|
* Removes the individual visibility for a player. The visibility for the player will then be determined by the
|
||||||
* global visibility ({@link #getGlobalVisibility()}).
|
* global visibility ({@link #getGlobalVisibility()}).
|
||||||
*
|
*
|
||||||
|
* @param player the player for which to remove the individual visibility
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
void removeIndividualVisibility(@NotNull Player player);
|
void removeIndividualVisibility(@NotNull Player player);
|
||||||
@ -65,7 +68,7 @@ public interface VisibilitySettings {
|
|||||||
* Checks if a hologram is visible to a player, taking into account both the global visibility and the individual
|
* Checks if a hologram is visible to a player, taking into account both the global visibility and the individual
|
||||||
* visibility for the player (if set).
|
* visibility for the player (if set).
|
||||||
*
|
*
|
||||||
* @param player the player
|
* @param player the player for which to check the visibility
|
||||||
* @return if the player can see the hologram
|
* @return if the player can see the hologram
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
|
@ -22,6 +22,8 @@ public interface GlobalPlaceholderReplaceFunction {
|
|||||||
/**
|
/**
|
||||||
* Same as {@link GlobalPlaceholder#getReplacement(String)}.
|
* Same as {@link GlobalPlaceholder#getReplacement(String)}.
|
||||||
*
|
*
|
||||||
|
* @param argument the optional placeholder argument, null if not specified
|
||||||
|
* @return the optional placeholder replacement, null to leave the placeholder unreplaced
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
@Nullable String getReplacement(@Nullable String argument);
|
@Nullable String getReplacement(@Nullable String argument);
|
||||||
|
@ -24,6 +24,9 @@ public interface IndividualPlaceholderReplaceFunction {
|
|||||||
/**
|
/**
|
||||||
* Same as {@link IndividualPlaceholder#getReplacement(Player, String)}.
|
* Same as {@link IndividualPlaceholder#getReplacement(Player, String)}.
|
||||||
*
|
*
|
||||||
|
* @param player the player that will see the provided replacement
|
||||||
|
* @param argument the optional placeholder argument, null if not specified
|
||||||
|
* @return the optional placeholder replacement, null to leave the placeholder unreplaced
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
@Nullable String getReplacement(@NotNull Player player, @Nullable String argument);
|
@Nullable String getReplacement(@NotNull Player player, @Nullable String argument);
|
||||||
|
@ -49,6 +49,7 @@ public interface Placeholder {
|
|||||||
* Note that more ticks can pass between invocations if no player is near, do not use the replacement callback as a
|
* Note that more ticks can pass between invocations if no player is near, do not use the replacement callback as a
|
||||||
* timer.
|
* timer.
|
||||||
*
|
*
|
||||||
|
* @return the refresh interval in ticks
|
||||||
* @since 1
|
* @since 1
|
||||||
*/
|
*/
|
||||||
int getRefreshIntervalTicks();
|
int getRefreshIntervalTicks();
|
||||||
|
Loading…
Reference in New Issue
Block a user