Reloading

GroovyScript recipes can be reloaded without having to do a full restart. Any script file using the postInit loader can be reloaded.

Danger

Some compat may not properly implement reloading, and will not be reloaded properly or may have errors while reloading.

To reload GroovyScript, either:

• Run the /gs reload command
• Use the keybind, by default bound to CTRL+R

Command

The /gs reload command can also be passed the argument --clean. This will delete the existing text in the groovy.log

Class Caching

For performance reasons, script classes are cached. In some situations, they may not be properly reloaded in-game. You can delete the cache to force these classes to be reloaded.

• Run the /gs deleteScriptCache command and then reload normally

Add Custom Reloading

For reloading to be added, each compat needs to be explicit handled by GroovyScript.

However, you can add your own custom class and implement reloading for your recipes even if GroovyScript doesn't have support for the given recipes natively. To do so, first make a new file in classes with the class containing an add, remove, and an onReload method. It should have an instance created inside it for access purposes.

Example

classes/DemoRegistry.groovy

import example.DemoHolder
import example.DemoRecipe

class DemoRegistry {

    static def instance = new DemoRegistry()

    def scripted = []
    def backup = []

    void onReload() {
        scripted.each { DemoHolder.demoRecipeList.remove(it) }
        scripted.clear()
        backup.each { DemoHolder.demoRecipeList.add(it) }
        backup.clear()
    }

    void add(DemoRecipe recipe) {
        scripted << recipe
        DemoHolder.demoRecipeList.add(recipe)
    }

    void remove(DemoRecipe recipe) {
        backup << recipe
        DemoHolder.demoRecipeList.remove(recipe)
    }
}

Then, you can accomplish reloading via one of two ways:

1. Create an event listener that is listening for GroovyReloadEvent in the init stage.
2. Check isReloading() in the postInit stage.

init/ReloadHelper.groovy

import classes.DemoRegistry
import com.cleanroommc.groovyscript.event.GroovyReloadEvent

eventManager.listen(GroovyReloadEvent) {
    DemoRegistry.instance.onReload()
}

postInit/ReloadHelper.groovy

import classes.DemoRegistry

if (!isReloading()) return

DemoRegistry.instance.onReload()

Finally, any time you would add a recipe to or remove a recipe from DemoHolder.DemoRecipeList, ensure it is manipulated via DemoRegistry.instance.

Contributors

Waiting Idly

Last edited 20 minutes ago

View full history

80c153e-update docs for GroovyScript 1.2.4 (#38)

8f2e8fa-Update Vanilla Registry Documentation (#36)

a0a4f76-GroovyScript Vanilla Improvements (#26)

481224d-GroovyScript Improvements (#12)