Skip to content

Minor fixes for documentation #291

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

Merged
brachy84 merged 3 commits into from
Mar 18, 2025
Merged

Minor fixes for documentation #291

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6825ddf
fix quarryplus (AdditionalEnchantedMiner)
WaitingIdly Mar 18, 2025
2689647
remove period before colon
WaitingIdly Mar 18, 2025
35ee2f7
fix botania tweaks docs being incorrect
WaitingIdly Mar 18, 2025
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
2 changes: 1 addition & 1 deletion examples/postInit/botania_tweaks.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ log.info 'mod \'botania_tweaks\' detected, running script'
// Terrestrial Agglomeration Plate place on top of a small 3x3 multiblock, of which the center, sides, and corners may be
// set to require specific blockstates. While the recipe is running, particles will gradually change color until the recipe
// is finished. Upon finishing the recipe, the center, sides, and corners can each be converted into a replacement
// blockstate.
// blockstate, if a replacement blockstate was set.

// mods.botania_tweaks.agglomeration_plate.removeByCenter(blockstate('botania:livingrock'))
// mods.botania_tweaks.agglomeration_plate.removeByCorner(blockstate('botania:livingrock'))
Expand Down
10 changes: 5 additions & 5 deletions examples/postInit/quarryplus.groovy
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@

log.info 'mod \'quarryplus\' detected, running script'

// Work bench:
// Workbench for crafting items using electricity.
// Workbench Plus:
// Converts up to 27 itemstacks into an output itemstack at the cost of power.

mods.quarryplus.work_bench_plus.removeByOutput(item('quarryplus:quarry'))
// mods.quarryplus.work_bench_plus.removeAll()
mods.quarryplus.workbench_plus.removeByOutput(item('quarryplus:quarry'))
// mods.quarryplus.workbench_plus.removeAll()

mods.quarryplus.work_bench_plus.recipeBuilder()
mods.quarryplus.workbench_plus.recipeBuilder()
.output(item('minecraft:nether_star'))
.input(item('minecraft:diamond'),item('minecraft:gold_ingot'))
.energy(10000)
Expand Down
2 changes: 1 addition & 1 deletion ...eanroommc/groovyscript/compat/mods/additionalenchantedminer/AdditionalEnchantedMiner.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@

public class AdditionalEnchantedMiner extends GroovyPropertyContainer {

public final WorkBenchPlus workBenchPlus = new WorkBenchPlus();
public final WorkbenchPlus workbenchPlus = new WorkbenchPlus();
}
8 changes: 4 additions & 4 deletions ...ditionalenchantedminer/WorkBenchPlus.java → ...ditionalenchantedminer/WorkbenchPlus.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
import java.util.stream.Collectors;

@RegistryDescription
public class WorkBenchPlus extends VirtualizedRegistry<IngredientRecipe> {
public class WorkbenchPlus extends VirtualizedRegistry<IngredientRecipe> {

@Override
public void onReload() {
Expand Down Expand Up @@ -83,12 +83,12 @@ public RecipeBuilder energy(double energy) {

@Override
public String getRecipeNamePrefix() {
return "additionalenchantedminer_workbenchplus_";
return "additionalenchantedminer_workbench_";
}

@Override
public String getErrorMsg() {
return "Error adding Additional Enchanted Miner WorkbenchPlus recipe";
return "Error adding Additional Enchanted Miner Workbench recipe";
}

@Override
Expand Down Expand Up @@ -116,7 +116,7 @@ public void validate(GroovyLog.Msg msg) {
.map(SeqLike::toSeq)
.collect(Collectors.toList())).asScala().toSeq();
IngredientRecipe recipe = new IngredientRecipe(this.name, output.get(0), energy, true, inputScalaList, true);
ModSupport.ADDITIONAL_ENCHANTED_MINER.get().workBenchPlus.add(recipe);
ModSupport.ADDITIONAL_ENCHANTED_MINER.get().workbenchPlus.add(recipe);
return recipe;
}
}
Expand Down
4 changes: 3 additions & 1 deletion src/main/java/com/cleanroommc/groovyscript/documentation/Registry.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,14 @@
import java.lang.reflect.Method;
import java.lang.reflect.ParameterizedType;
import java.util.*;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.stream.Stream;


public class Registry {

private static final Pattern PERIOD_END_PATTERN = Pattern.compile("\\.$");
private final GroovyContainer<? extends GroovyPropertyContainer> mod;
private final INamed registry;
private final String baseTranslationKey;
Expand Down Expand Up @@ -339,7 +341,7 @@ private String methodDescription(Method method) {

return String.format(
"- %s:\n\n%s",
Documentation.translate(lang),
PERIOD_END_PATTERN.matcher(Documentation.translate(lang)).replaceAll(""),
new CodeBlockBuilder()
.line(methodExample(method, Exporter.simpleSignature(method, types)))
.indentation(1)
Expand Down
10 changes: 7 additions & 3 deletions src/main/resources/assets/groovyscript/lang/en_us.lang
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,9 +174,12 @@ groovyscript.wiki.actuallyadditions.treasure_chest.min.required=less than or equ
groovyscript.wiki.actuallyadditions.treasure_chest.max.value=Sets the maximum stack size given when rolled
groovyscript.wiki.actuallyadditions.treasure_chest.max.required=greater than or equal to the size of min

#Additional Enchanted Miner
groovyscript.wiki.quarryplus.work_bench_plus.title=Work bench
groovyscript.wiki.quarryplus.work_bench_plus.description=Workbench for crafting items using electricity.

# Additional Enchanted Miner
groovyscript.wiki.quarryplus.workbench_plus.title=Workbench Plus
groovyscript.wiki.quarryplus.workbench_plus.description=Converts up to 27 itemstacks into an output itemstack at the cost of power.
groovyscript.wiki.quarryplus.workbench_plus.energy.value=Sets the amount of energy consumed to craft the recipe.


# Advanced Mortars
groovyscript.wiki.advancedmortars.mortar.title=Mortar
Expand All @@ -189,6 +192,7 @@ groovyscript.wiki.advancedmortars.mortar.duration.value=Sets how many interactio
groovyscript.wiki.advancedmortars.mortar.secondaryOutput.value=Sets the additional output itemstack
groovyscript.wiki.advancedmortars.mortar.secondaryOutputChance.value=Sets the chance of the additional output itemstack being output


# Advanced Rocketry
groovyscript.wiki.advancedrocketry.admonition.weights=The 'chances' used with the recipe outputs are actually output weights. For example, setting 'chance' to 0.1 will set the output's chance to 1, unless other outputs add up to the weight of 0.9. The output chances will also not do anything unless 'outputSize' is set to a number greater than 0.
groovyscript.wiki.advancedrocketry.admonition.input_slots=The recipes performed in this machine can have more than 9 inputs, but this makes the JEI handler overflow when displaying the recipe and breaks the tooltips.
Expand Down