Mod: Survival: Difference between revisions
More actions
Bonsaibauer (talk | contribs) Create English ShroudForge Wiki article |
Bonsaibauer (talk | contribs) Marked this version for translation |
||
| Line 10: | Line 10: | ||
<translate> | <translate> | ||
<!--T:1--> | |||
SF Survival is a standalone ShroudForge mod with eight optional survival settings. Its package ID is <code>sf-survival</code>. It targets the client and Dedicated Server and uses the public typed runtime API. The package is disabled by default and has no dependency on SF Unlimited Flight. | SF Survival is a standalone ShroudForge mod with eight optional survival settings. Its package ID is <code>sf-survival</code>. It targets the client and Dedicated Server and uses the public typed runtime API. The package is disabled by default and has no dependency on SF Unlimited Flight. | ||
<!--T:2--> | |||
{| class="wikitable" | {| class="wikitable" | ||
! Setting !! Effect !! Engine value or scope | ! Setting !! Effect !! Engine value or scope | ||
| Line 32: | Line 34: | ||
|} | |} | ||
== How the effects work == | == How the effects work == <!--T:3--> | ||
<!--T:4--> | |||
Attribute effects are applied to authoritative player entities. Infinite Stamina, Infinite Mana, and Infinite Underwater Breath change the relevant minimum bound to match the current maximum. The game's own attribute calculation continues to consume and clamp the value. When a maximum changes, the mod checks and updates the related bounds together. | Attribute effects are applied to authoritative player entities. Infinite Stamina, Infinite Mana, and Infinite Underwater Breath change the relevant minimum bound to match the current maximum. The game's own attribute calculation continues to consume and clamp the value. When a maximum changes, the mod checks and updates the related bounds together. | ||
<!--T:5--> | |||
Fast regeneration multiplies the game's existing regeneration value. It retains the original timeout and ramp. It does not create a separate regeneration event, and it has no effect if natural regeneration is disabled. | Fast regeneration multiplies the game's existing regeneration value. It retains the original timeout and ramp. It does not create a separate regeneration event, and it has no effect if natural regeneration is disabled. | ||
<!--T:6--> | |||
Fall-damage configuration belongs to the shared player template, so players using that template share the change. Weapon durability is a world-wide setting and affects every player in the hosted world, including other players' carried items. | Fall-damage configuration belongs to the shared player template, so players using that template share the change. Weapon durability is a world-wide setting and affects every player in the hosted world, including other players' carried items. | ||
== Turning settings off and restoration == | == Turning settings off and restoration == <!--T:7--> | ||
<!--T:8--> | |||
The mod remembers every original value it changes. When a setting is disabled or the mod unloads during the same world session, it restores the original input. Before writing, it checks that the current value is still the value owned by the mod. If another system changed it, that external change is preserved. | The mod remembers every original value it changes. When a setting is disabled or the mod unloads during the same world session, it restores the original input. Before writing, it checks that the current value is still the value owned by the mod. If another system changed it, that external change is preserved. | ||
<!--T:9--> | |||
If an engine gate is busy, restoration is retried on a later update. An uncertain write stops further mutation. If cleanup cannot finish while the mod is being disabled, the runtime retains the scope and retries cleanup. Package refresh is aborted if cleanup cannot complete. | If an engine gate is busy, restoration is retried on a later update. An uncertain write stops further mutation. If cleanup cannot finish while the mod is being disabled, the runtime retains the scope and retries cleanup. Package refresh is aborted if cleanup cannot complete. | ||
<!--T:10--> | |||
Turn settings off before leaving the world and wait for restoration. An invalidated world session cannot authorize writes to old shared storage. If that happens while shared settings are still owned, the mod stops and reports that a game restart is needed. | Turn settings off before leaving the world and wait for restoration. An invalidated world session cannot authorize writes to old shared storage. If that happens while shared settings are still owned, the mod stops and reports that a game restart is needed. | ||
Latest revision as of 00:15, 18 November 2026
SF Survival is a standalone ShroudForge mod with eight optional survival settings. Its package ID is sf-survival. It targets the client and Dedicated Server and uses the public typed runtime API. The package is disabled by default and has no dependency on SF Unlimited Flight.
| Setting | Effect | Engine value or scope |
|---|---|---|
| No Fall Damage | Turns off fall damage. | Adjusts fallDamageStartDistance on the player character template, keeping it at least as high as the lethal distance.
|
| Fast Health Regen | Multiplies existing health regeneration by up to 100. | Uses existing Health_Recharge, capped at 65,536. Requires natural health regeneration.
|
| Fast Mana Regen | Multiplies existing mana regeneration by up to 100. | Uses existing Mana_Recharge, capped at 65,536. Requires natural mana regeneration.
|
| Infinite Stamina | Keeps stamina at its current maximum. | Updates the original stamina bounds when the maximum changes. It does not periodically refill the current value. |
| Infinite Underwater Breath | Keeps the underwater breath reserve at its current maximum. | Uses the original oxygen attribute bounds. |
| Infinite Weapon Durability | Disables durability loss for the hosted world. | Changes the world-level enableDurability setting. Other players' items are affected too.
|
| Infinite Frost Timer | Keeps body warmth at its current maximum. | Uses the original body-heat attribute bounds. |
| Infinite Mana | Keeps mana at its current maximum. | Updates the original mana bounds when the maximum changes. It does not periodically refill the current value. |
How the effects work
Attribute effects are applied to authoritative player entities. Infinite Stamina, Infinite Mana, and Infinite Underwater Breath change the relevant minimum bound to match the current maximum. The game's own attribute calculation continues to consume and clamp the value. When a maximum changes, the mod checks and updates the related bounds together.
Fast regeneration multiplies the game's existing regeneration value. It retains the original timeout and ramp. It does not create a separate regeneration event, and it has no effect if natural regeneration is disabled.
Fall-damage configuration belongs to the shared player template, so players using that template share the change. Weapon durability is a world-wide setting and affects every player in the hosted world, including other players' carried items.
Turning settings off and restoration
The mod remembers every original value it changes. When a setting is disabled or the mod unloads during the same world session, it restores the original input. Before writing, it checks that the current value is still the value owned by the mod. If another system changed it, that external change is preserved.
If an engine gate is busy, restoration is retried on a later update. An uncertain write stops further mutation. If cleanup cannot finish while the mod is being disabled, the runtime retains the scope and retries cleanup. Package refresh is aborted if cleanup cannot complete.
Turn settings off before leaving the world and wait for restoration. An invalidated world session cannot authorize writes to old shared storage. If that happens while shared settings are still owned, the mod stops and reports that a game restart is needed.