Mods
Tags
Authors
SkimnerPhiemanresudengr1065WaffleDevsShrimp
Tools
ShapezLauncherCode SearchSavegame Converter
Knowledge
Installing mods
ASAR Modding GuideInstalling shapez CE

RandomEventsLib

by WaffleDevsTotal downloads: 35

A library allowing developers to add custom events to the game!

Tags:library
Install
Download
1.0.0 Latest
all versions...
Warning
This mod is deprecated. It is not maintained by the developer and may not work as intended anymore. Possible reasons for deprecation include lack of time to develop this mod, supersession by another mod or loss of interest in the mod.

Allows mods to add Random Events that can happen upon entering a state (Ex. Going to the main menu, Opening the settings.) or can happen randomly during gameplay.
**Note: This mod doesn't do anything on it's own. You will need to download a mod using this library for it to do anything.**

For Modders

There is an API that allows easily adding new State Enter Events (SEE) and Ingame Random Events (IRE).

To access it, get window.REL during the Preloader state.

window.REL.registerStateEnterEvent(eventName: string, state: string, func: Function)

Registers an SEE with name eventName that has a X chance to run func when signals.stateEntered runs for state state.X is determined by the mod's config entry, stateEnterEventChance.
window.REL.registerIngameRandomEvent(eventName: string, func: Function)

Registers an IRE with name eventName that has a chance to run func every X seconds. X is determined by the mod's config entry, randomEventInterval.

There is also a modified version src/js/core/rng.js with the following methods:

window.REL.RNG.chance(chance: number)

Returns true every chance% of times.
window.REL.RNG.choiceDict(obj: Object)

The Object version of RandomNumberGenerator.choice(array: Array). Returns a random key from the given Object.

The lib also allows for editing the stateEnterEventChance and randomEventInterval in case you want to mello out the experience or turn it to full hell.