Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Biome API: javadoc fixes #3348

Merged
merged 1 commit into from
Oct 1, 2023
Merged

Biome API: javadoc fixes #3348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion fabric-biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/BiomeModification.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,10 @@
import net.fabricmc.fabric.impl.biome.modification.BiomeModificationImpl;

/**
* <b>Experimental feature</b>, may be removed or changed without further notice.
* Provides methods for modifying biomes. To create an instance, call
* {@link BiomeModifications#create(Identifier)}.
*
* <p><b>Experimental feature</b>, may be removed or changed without further notice.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not for this PR: We should really make this stable, I think ill take a look at the modules and figure out what can become stable.

Copy link
Contributor

@maityyy maityyy Sep 30, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think so because Forge's API looks much better and we can do something similar (at least that is what I am planning to do when I have free time). See #3316

*
* @see BiomeModifications
*/
Expand Down
6 changes: 3 additions & 3 deletions ...biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/BiomeModificationContext.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,8 @@ public interface BiomeModificationContext {

interface WeatherContext {
/**
* @see Biome#getPrecipitation()
* @see Biome.Builder#precipitation(Biome.Precipitation)
* @see Biome#hasPrecipitation()
* @see Biome.Builder#precipitation(boolean)
*/
void setPrecipitation(boolean hasPrecipitation);

Expand All @@ -83,7 +83,7 @@ interface WeatherContext {
void setTemperatureModifier(Biome.TemperatureModifier temperatureModifier);

/**
* @see Biome#getDownfall()
* @see Biome.Weather#downfall()
* @see Biome.Builder#downfall(float)
*/
void setDownfall(float downfall);
Expand Down
5 changes: 2 additions & 3 deletions fabric-biome-api-v1/src/main/java/net/fabricmc/fabric/api/biome/v1/BiomeModifications.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,7 @@
/**
* Provides an API to modify Biomes after they have been loaded and before they are used in the World.
*
* <p>Any modifications made to biomes will not be available for use in server.properties (as of 1.16.1),
* or the demo level.
* <p>Any modifications made to biomes will not be available for use in the demo level.
*
* <p><b>Experimental feature</b>, may be removed or changed without further notice.
*/
Expand Down Expand Up @@ -87,7 +86,7 @@ public static void addSpawn(Predicate<BiomeSelectionContext> biomeSelector,
}

/**
* Create a new biome modification which will be applied whenever biomes are loaded from data packs.
* Creates a new biome modification which will be applied whenever biomes are loaded from data packs.
*
* @param id An identifier for the new set of biome modifications that is returned. Is used for
* guaranteeing consistent ordering between the biome modifications added by different mods
Expand Down
Loading