Stability Setter

Tungsten users: If you are using Tungsten with this mod, please ensure you have Tungsten 1.2.1 or higher if you are experiencing null errors!

 

This mod uses a Harmony patch on Vintagestory.GameContent.SystemTemporalStability.GetTemporalStability() to override a chunk's stability values, alllowing the tempoaral gear on the HUD to turn in the appropriate direction for the new values. Note that this method of patching may break more often with game updates, especially if the temporal stability system gets updated. The upside to this method is that anything that grabs chunk stability will see the set value rather than the inherent value. The changes made by this mod are non-destructive and can be reversed through a command or by simply removing the mod.

 

This mod is required on both the client and server!

 

This mod is inspired by Chunk Stability Override!

 

Stability Modes

• "Vanilla Behavior" - Chunks will return their normal stability value, or their set value if it has been set.
• Global Stability - Chunks will all have the same stability value set to whatever the current global stability value is.
• Global Stability Offset - Every chunk will have an offset applied to its final value, based on the current global offset value. For example, if the global offset is 2 then a chunk with 0.87658 stability will have 2.87658 stability or -1.12342 stability if the value is -2. Stability override values will also still be applied before the offset, so if you set a chunk to -3 stability and turn on a -2 offset the final stability will be -5.

Interaction with vanilla mechanics

• During temporal storms, the stability value of chunks which have had their values set will be offset by the storm, as if the set value was already the chunk's inherent value.
• Temporal rifts will still drain your stability rapidly if you approach them even if you are in a high-stability chunk.

Seralization

Most data from this mod is saved within the global savegame data.

The following data values are serialized:

• setChunks - A list of chunks stored as strings containing their coordinates and their set stability values.
• StabilityMode - The current stability mode, stored as a number [0,2].
• GlobalStability - Current global stability value stored as a float.
• GlobalStabilityOffset - Current global stability offset stored as a float.

Commands

/setStability <stability> - Sets the stability of the chunk you are in to a specific value (Not an offset!). A value of 1 is neutral stability, less is unstable and more is positive stability. Note that chunks are cubic, so higher or lower chunks in your column will have different values. Value range: -10000 to 10000. (The limits are in place to stop the HUD gear from glitching out, these values are enough to almost instantly fill/drain stability.)

/resetStability - Resets the stability of the chunk you are in to its default value.

/resetStability all <confirmCode> -  Resets stability for all chunks back to default. Run this without inputting any confirm code first to get a confirmation code, then run it again with that confirmation code to reset all chunk stability. This is not reversible!!!

/getStability - Shows the stability value for the position you are standing in.

/getStability global - Shows the current global value (Which is used only when global mode is set).

/getStability offset - Gets the current offset value (Which is used only when global offset mode is set)!

/getStability mode - Shows the current stability override mode. Could be the vanilla behavior, global offset, or global mode.

/setStabilityMode -  Sets the current stability mode. Default is "Vanilla Behavior". The possible values are: 0 - Vanilla Behavior, 1 - Global stability, 2 - Global stability offset. Value range: 0 to 2

/setGlobalStability <stability> - Sets the stability value for all chunks to a specific value, when Global Stability mode is active. Value range: -10000 to 10000.

/setGlobalStabilityOffset <stability> - Sets a value to apply as an offset to all chunk stability values. Final stability values will be clamped to -10000 to 10000. Value range: -10000 to 10000.

/requestStabilityData - Requests a new data packet from the server to the client, syncing all mod data from the server to the client. You probably won't need to use this.

Compatibility

Temporal Amulets - Confirmed Compatible

Spreading Devastation - Minor issues? In devestated chunks, the stability value from /getStability reflects changes made by that mod, but not the cog. Other chunks should be unaffected. You can still override devestated chunks.

Temporality Plus - Unknown. Game will load, no obvious issues. Can't yet confirm if temporal rifts will spawn in manually set unstable chunks or not or if it will spare manually set stable chunks. No issues with temporal storms.

Stable Surface - Seems to work fine. All surface chunks will start with 1.5 surface stability, but can still be affected by Stability Setter.

Tungsten - Recommended to use version 1.2.1 or higher. Lower versions may cause issues.

Questions that are not yet frequently asked but could be? (QTANYFABCB?)

• I set the stability value, why is the gear not spinning? - The gear will only spin when stability is actually changing. If you are at full or minimum stability then it will stop spinning if the value is not moving towards the other direction. If this is not the case, you may have found a bug!
• The game updated and the mod broke! - Since this mod uses a harmony patch it is more likely to break due to updates, though I do hope that the way I wrote it will minimize these issues. If this happens the mod will need an update.
• I set stability in my chunk, but my basement/attic has different stability values!? - Unlike the other block game which uses chunk columns, Vintage Story has a cubic chunk system. This means that a chunk is a large cube, and there are other chunks below and above it. You will need to set the values in these spaces if needed.
• How do I see chunks? - Use .debug wireframe chunk