Onyx-StageVariants

• Helper to create visual stage variants
• does nothing on its own, use with CoolStages
• Allows you to replace spritesheets, recolor layers and more

Import line:

StageVariants = mods["0n_x-StageVariants"].setup()

Functions

StageVariants.create(namespace, identifier, stage, name, subname, [weight]) -> Stage Variant

Creates a stage variant. It won't change anything for now, but it will be added to the variants that can be rolled and is visible in the imgui window

Parameters:

StageVariants.swap_tileset(stage_variant, original_tileset, replacement_tileset) -> nil

Adds a tileset swap to the variant. Once entering a stage with this variant the original tileset will be automatically replcaed by the replacement tileset. If you want to create a replacement tileset, you need to look at the original tileset and put the tiles of your new tileset in the same position as in the original tileset. for example if you want to replace a bottom right corner piece, your replacement tile needs to be in the same x and y position in the new tilemap

Parameters:

StageVariants.recolor_layer(stage_variant, layer_name, color) -> nil

Like swap_tileset, adds a recolored layer to the variant. Uncomment "GetLayerNames" in main.lua to print the names of all layers of your current stage. Layers get printed in the same order as they appear in provedit (Settings -> Background)

Parameters:

StageVariants.swap_sprite(stage_variant, original_sprite, replacement_sprite) -> nil

Like swap_tileset, adds a sprite swap to the variant, but for a single sprite. Tilesets get drawn differently and therefore need a different method to be replaced

Parameters:

StageVariants.find(namespace, identifier) -> Stage Variant

Returns a variant with the given namespace and identifier. Returns nil if it doesn't exist.

Parameters:

StageVariants.find_all(namespace, identifier) -> {Stage Variant}

Returns a table with all stage variants

Parameters:

StageVariants.delete(stage_variant) -> boolean

Deletes the given Stage Variant. Returns true if succesful and false if not

Parameters:

StageVariants.clear(stage_variant) -> nil

Removes all recolors, tile swaps and sprite swaps from the given variant

Parameters:

StageVariants.set_hidden(stage_variant, [hidden]) -> nil

Removes a variant from being visible in the imgui window

Parameters:

StageVariants.set_weight(stage_variant, weight) -> nil

Sets the weight for the given Stage, ranging from 0 to 100 (the imgui window only lets you set between 0 and 10. This value gets multiplied by 10 internally)

Parameters:

StageVariants.force_next(stage_variant) -> nil

Forces the given variant to appear next stage, if the next stage has this variant. Only for the next stage. If you want it for every stage, you need to call this after entering for every stage. If multiple variants are forced for next stage, one will be chosen randomly

Hotloading

if hotload then
    gm.sprite_replace(<sprite id of replacement sprite>, path.combine(PATH .. <same path used to originally load sprite>, "<sprite name>.png"), 1, false,
        false, 0, 0)
end
hotload = true

To hotload changes made to a tileset make sure to add this piece of code in your initialize before the swap tileset calls and after the resource load calls. Additionally, the following should be added after the initialize

if hotload then
    StageVariants.unload_stage()
    for _, variant in ipairs(StageVariants.find_all()) do --clear the content of all stagevariants, so there won't be duplicates when init gets run again
        StageVariants.clear(variant)
    end
    init()
end

Reference CoolStages for an example of hotloading

Parameters:

Special Thanks To

• The Return Of Modding Discord

Contact

For questions or bug reports, you can find us in the RoRR Modding Server @Onyx

1.0.1

• Fixed reamde

1.0.0

• Initial Release