RacesOfValheim/JotunnModStub/Fenrir/FenrirRace.cs
kanym 9907cae292 fix(fenrir): give the forms a voice, and stop the sounds writing to the save
Every sound the Fenrir forms played was looked up by a name, and most of
those names are not prefabs in this game. The chains hid it: PlaySFX walks
its arguments and stops at the first that resolves, so a claw that asked for
"sfx_fenring_attack", "sfx_fenring_attack_claw", "sfx_wolf_attack" had a
Fenring swinging with a wolf's voice through a fallback nobody noticed. The
cultist's double claw asked for three dead names in a row and was silent from
the day it was written.

The creatures do have their own sounds. The forms now use them:
sfx_fenring_claw_start for the swing, sfx_fenring_claw_hit for the landing,
sfx_fenring_fireclaw to open the fire breath. The Ulv keeps the wolf's, since
vanilla ships it nothing but sfx_ulv_death.

THE HOWL WAS NEVER A PREFAB TO LOOK UP. It is an AnimationEvent inside the
wolf's 'C_Hawl' clip, firing at 0.39s with the sound handed over as an object
reference - and a player in wolf form idles through that clip and howls out
loud already, with the game's own AnimationEffect doing the work. Three
spellings of one word are why this took so long to find: the clip is
'C_Hawl', the sound is 'sfx_wolf_haul', and the mod was looking for
'sfx_wolf_howl', the only correct spelling of the three and the only one that
does not exist. The Fenring has no howl of its own at all, so it borrows the
wolf's over its Taunt.

The jump attack's impact moved to where the jump lands, next to the damage,
instead of firing before the dash while the form is still standing.

FenrirCreatureSound.Spawn is the other half. Some vanilla sound prefabs carry
a ZNetView - sfx_fenring_alerted does - and one that wakes with no init ZDO
writes a persistent record into the world, once per swing. Spawning now runs
inside ZNetView.StartGhostInit, the game's own answer, so no ZDO is made. All
nine sound spawns in these forms go through it.

sfx_fenring_howl resolves to an ordinary sound prefab and hard-exits the
process when spawned on its own. It is named in a Suspect set, described in
the log and never instantiated, because a name nobody records is a name
somebody adds back.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
2026-09-26 00:20:31 +02:00

493 lines
25 KiB
C#

using System;
using System.Collections;
using Jotunn.Configs;
using Jotunn.Entities;
using Jotunn.Managers;
using UnityEngine;
namespace RacesOfValheim {
public class FenrirRace : MonoBehaviour {
public static FenrirRace Instance;
public static SE_FenrirCurse curseSE;
public static SE_Stats formBuffSE;
public static SE_Stats wolfFormBuffSE;
public static SE_Stats cultistFormBuffSE;
public static SE_FormCooldown fenrirCdSE;
public static SE_FormCooldown cultistCdSE;
private GameObject currentTransformation;
private bool isTransformed = false;
private bool isTransformingSequence = false;
private FenrirProgression.FormRules activeRules = null;
private bool wasNight = false;
private float sunSicknessTimer = 0f;
private void Awake()
{
Instance = this;
}
public void CreateModAssets()
{
// The pack trough and its bloodline. Registered here because the faction merchant
// catalogue resolves its entries by prefab name, so both Ulvsblod have to exist before a
// Fenring is ever set up as a bench.
FenrirMangiatoia.Register();
// Same window, same reason: this method runs on PrefabManager.OnVanillaPrefabsAvailable,
// which is the one moment Jotunn will take a new item into ObjectDB. Registered later
// the prefab exists, logs its success, and cannot be spawned by anyone.
FenrirClaws.Instance.EnsureRegistered();
curseSE = ScriptableObject.CreateInstance<SE_FenrirCurse>();
curseSE.name = "SE_FenrirCurse";
curseSE.m_name = "Fenrir's Blood";
curseSE.m_tooltip = "You are of the Fenrir race.";
curseSE.m_mods = new System.Collections.Generic.List<HitData.DamageModPair>()
{
new HitData.DamageModPair() { m_type = HitData.DamageType.Spirit, m_modifier = HitData.DamageModifier.Weak }
};
GameObject fenringTrophy = PrefabManager.Cache.GetPrefab<ItemDrop>("TrophyFenring")?.gameObject;
Sprite fenringTrophyIcon = null;
if (fenringTrophy != null)
{
ItemDrop trophyDrop = fenringTrophy.GetComponent<ItemDrop>();
if (trophyDrop != null && trophyDrop.m_itemData.m_shared.m_icons.Length > 0)
{
fenringTrophyIcon = trophyDrop.m_itemData.m_shared.m_icons[0];
curseSE.m_icon = fenringTrophyIcon;
}
}
ItemManager.Instance.AddStatusEffect(new CustomStatusEffect(curseSE, fixReference: false));
fenrirCdSE = ScriptableObject.CreateInstance<SE_FormCooldown>();
fenrirCdSE.name = "SE_FenrirCooldown";
fenrirCdSE.m_name = "Fenrir Form Cooldown";
fenrirCdSE.m_icon = fenringTrophyIcon;
ItemManager.Instance.AddStatusEffect(new CustomStatusEffect(fenrirCdSE, fixReference: false));
cultistCdSE = ScriptableObject.CreateInstance<SE_FormCooldown>();
cultistCdSE.name = "SE_CultistCooldown";
cultistCdSE.m_name = "Cultist Form Cooldown";
cultistCdSE.m_icon = fenringTrophyIcon;
ItemManager.Instance.AddStatusEffect(new CustomStatusEffect(cultistCdSE, fixReference: false));
formBuffSE = ScriptableObject.CreateInstance<SE_Stats>();
formBuffSE.name = "SE_FenrirForm";
formBuffSE.m_name = "Bestial Fury";
formBuffSE.m_speedModifier = FenrirConfig.FullFormSpeedBonus.Value;
formBuffSE.m_jumpModifier = new Vector3(0, FenrirConfig.FullFormJumpBonus.Value, 0);
formBuffSE.m_fallDamageModifier = -FenrirConfig.FullFormFallDamageReduction.Value;
formBuffSE.m_staminaRegenMultiplier = FenrirConfig.FormStaminaRegenMultiplier.Value;
formBuffSE.m_runStaminaDrainModifier = -FenrirConfig.FormStaminaDrainReduction.Value;
formBuffSE.m_icon = fenringTrophyIcon;
ItemManager.Instance.AddStatusEffect(new CustomStatusEffect(formBuffSE, fixReference: false));
cultistFormBuffSE = ScriptableObject.CreateInstance<SE_Stats>();
cultistFormBuffSE.name = "SE_CultistForm";
cultistFormBuffSE.m_name = "Cultist Fury";
cultistFormBuffSE.m_speedModifier = FenrirConfig.FullFormSpeedBonus.Value;
cultistFormBuffSE.m_jumpModifier = new Vector3(0, FenrirConfig.FullFormJumpBonus.Value, 0);
cultistFormBuffSE.m_fallDamageModifier = -FenrirConfig.FullFormFallDamageReduction.Value;
cultistFormBuffSE.m_staminaRegenMultiplier = FenrirConfig.FormStaminaRegenMultiplier.Value;
cultistFormBuffSE.m_runStaminaDrainModifier = -FenrirConfig.FormStaminaDrainReduction.Value;
cultistFormBuffSE.m_icon = fenringTrophyIcon;
ItemManager.Instance.AddStatusEffect(new CustomStatusEffect(cultistFormBuffSE, fixReference: false));
wolfFormBuffSE = ScriptableObject.CreateInstance<SE_Stats>();
wolfFormBuffSE.name = "SE_WolfForm";
wolfFormBuffSE.m_name = "Wolf Senses";
wolfFormBuffSE.m_speedModifier = FenrirConfig.WolfFormSpeedBonus.Value;
wolfFormBuffSE.m_fallDamageModifier = -FenrirConfig.WolfFormFallDamageReduction.Value;
wolfFormBuffSE.m_staminaRegenMultiplier = FenrirConfig.FormStaminaRegenMultiplier.Value;
wolfFormBuffSE.m_runStaminaDrainModifier = -FenrirConfig.FormStaminaDrainReduction.Value;
wolfFormBuffSE.m_icon = fenringTrophyIcon;
ItemManager.Instance.AddStatusEffect(new CustomStatusEffect(wolfFormBuffSE, fixReference: false));
}
private void Update()
{
if (Player.m_localPlayer == null || EnvMan.instance == null) return;
if (isTransformingSequence) return;
if (!Player.m_localPlayer.GetSEMan().HaveStatusEffect("SE_FenrirCurse".GetStableHashCode())) return;
if (sunSicknessTimer > 0f)
{
sunSicknessTimer -= Time.deltaTime;
}
bool isNight = EnvMan.IsNight();
if (isNight && !wasNight)
{
Player.m_localPlayer.GetSEMan().RemoveStatusEffect("SE_FenrirCooldown".GetStableHashCode());
Player.m_localPlayer.GetSEMan().RemoveStatusEffect("SE_CultistCooldown".GetStableHashCode());
var fenrirSE = Player.m_localPlayer.GetSEMan().GetStatusEffect("SE_FenrirForm".GetStableHashCode());
if (fenrirSE != null) fenrirSE.m_ttl = 0f;
var cultistSE = Player.m_localPlayer.GetSEMan().GetStatusEffect("SE_CultistForm".GetStableHashCode());
if (cultistSE != null) cultistSE.m_ttl = 0f;
var wolfSE = Player.m_localPlayer.GetSEMan().GetStatusEffect("SE_WolfForm".GetStableHashCode());
if (wolfSE != null) wolfSE.m_ttl = 0f;
}
else if (!isNight && wasNight)
{
// Sunrise: a form that was granted for the night only is taken back, and the
// beast is tired for a while. A form the progression lets through by day (Queen's
// Fenrir, Fader's Cultist, Bonemass's Wolf) is not the sun's to take: activeRules is
// what the transform was actually granted under.
if (activeRules == null || activeRules.NeedsNight)
{
sunSicknessTimer = FenrirConfig.SunSicknessDuration.Value;
ForceRevert();
}
}
wasNight = isNight;
if (isTransformed)
{
bool hasAnyForm = Player.m_localPlayer.GetSEMan().HaveStatusEffect("SE_FenrirForm".GetStableHashCode()) ||
Player.m_localPlayer.GetSEMan().HaveStatusEffect("SE_CultistForm".GetStableHashCode()) ||
Player.m_localPlayer.GetSEMan().HaveStatusEffect("SE_WolfForm".GetStableHashCode());
if (!hasAnyForm)
{
ForceRevert();
return;
}
}
if (!RaceInput.Allowed) return;
int state = BossProgressionManager.GetCurrentProgressionState();
if (FenrirConfig.WolfFormKey.Value.IsDownIgnoringHeldKeys()) { TryTransformWithRules(FenrirProgression.GetGKeyRules(state)); return; }
if (FenrirConfig.FenrirFormKey.Value.IsDownIgnoringHeldKeys()) { TryTransformWithRules(FenrirProgression.GetHKeyRules(state)); return; }
if (FenrirConfig.CultistFormKey.Value.IsDownIgnoringHeldKeys()) { TryTransformWithRules(FenrirProgression.GetJKeyRules(state)); return; }
}
private void TryTransformWithRules(FenrirProgression.FormRules rules)
{
if (rules == null || rules.Form == FenrirProgression.FormType.None) return;
// The tiredness is the sun's doing, so it only stands in the way of a night form; the
// forms allowed by day would otherwise be locked out right after every sunrise.
if (rules.NeedsNight && sunSicknessTimer > 0f)
{
Player.m_localPlayer.Message(MessageHud.MessageType.Center, "The beast is tired");
return;
}
if (isTransformed)
{
StartCoroutine(RevertToHumanRoutine());
return;
}
if (rules.NeedsNight && !EnvMan.IsNight())
{
Player.m_localPlayer.Message(MessageHud.MessageType.Center, "The beast rests. You can only transform at night.");
return;
}
if (rules.CooldownMinutes > 0)
{
string cdName = rules.Form == FenrirProgression.FormType.Cultist ? "SE_CultistCooldown" : "SE_FenrirCooldown";
var cdSE = Player.m_localPlayer.GetSEMan().GetStatusEffect(cdName.GetStableHashCode());
if (cdSE != null)
{
float m_time = HarmonyLib.Traverse.Create(cdSE).Field<float>("m_time").Value;
float remaining = cdSE.m_ttl - m_time;
if (remaining < 0) remaining = 0;
int rMin = Mathf.FloorToInt(remaining / 60f);
int rSec = Mathf.FloorToInt(remaining % 60f);
string formName = rules.Form == FenrirProgression.FormType.Cultist ? "Cultist" : "Fenrir";
Player.m_localPlayer.Message(MessageHud.MessageType.Center, $"{formName} form is on cooldown ({rMin}:{rSec:00}).");
return;
}
}
StartCoroutine(TransformIntoWolfRoutine(rules));
}
public void ForceRevert()
{
if (isTransformed && !isTransformingSequence)
{
StartCoroutine(RevertToHumanRoutine());
}
}
private IEnumerator TransformIntoWolfRoutine(FenrirProgression.FormRules rules)
{
isTransformingSequence = true;
activeRules = rules;
ZSyncAnimation zAnim = Player.m_localPlayer.GetComponent<ZSyncAnimation>();
if (zAnim != null)
{
RaceInput.SuppressGuardianPowerBriefly();
zAnim.SetTrigger("gpower");
}
yield return new WaitForSeconds(1.1f);
SpawnPoofEffect();
// The howl of the creature being turned into, read off that creature. This used to look
// for "sfx_wolf_howl" and fall back to "sfx_fenring_idle": the first is not a prefab in
// this game, and the second is real but is the creature's ambient grunt, so every
// transformation announced itself with a small idle noise. FenrirCreatureSound exists for
// exactly this - see the note at the top of FenrirBehaviors for how it reads a creature's
// own voice off BaseAI.m_alertedEffects, which is the only route the Wolf and the Ulv
// have. The two Fenring forms could do better: vanilla does ship "sfx_fenring_howl", a
// real howl rather than an alert bark, and preferring it when it exists would cost four
// lines here.
FenrirCreatureSound.PlayHowl(CreaturePrefabFor(rules.Form), Player.m_localPlayer.transform.position);
yield return new WaitForSeconds(0.1f);
ExecuteTransformation(rules);
if (currentTransformation != null && currentTransformation.GetComponent<WolfFormBehavior>() == null && currentTransformation.GetComponent<UlvFormBehavior>() == null)
{
float elapsed = 0f;
float duration = 0.5f;
float startMultiplier = 0.5f;
Vector3 startScale = Vector3.one * startMultiplier;
Vector3 endScale = Vector3.one;
currentTransformation.transform.localScale = startScale;
while (elapsed < duration)
{
if (currentTransformation == null) break;
currentTransformation.transform.localScale = Vector3.Lerp(startScale, endScale, elapsed / duration);
elapsed += Time.deltaTime;
yield return null;
}
if (currentTransformation != null) currentTransformation.transform.localScale = endScale;
}
isTransformingSequence = false;
}
private IEnumerator RevertToHumanRoutine()
{
isTransformingSequence = true;
if (currentTransformation != null)
{
FenrirFormBehavior fenrirBehavior = currentTransformation.GetComponent<FenrirFormBehavior>();
if (fenrirBehavior != null) fenrirBehavior.enabled = false;
CultistFormBehavior cultistBehavior = currentTransformation.GetComponent<CultistFormBehavior>();
if (cultistBehavior != null) cultistBehavior.enabled = false;
WolfFormBehavior wolfBehavior = currentTransformation.GetComponent<WolfFormBehavior>();
if (wolfBehavior != null) wolfBehavior.enabled = false;
UlvFormBehavior ulvBehavior = currentTransformation.GetComponent<UlvFormBehavior>();
if (ulvBehavior != null) ulvBehavior.enabled = false;
if (wolfBehavior == null && ulvBehavior == null)
{
float elapsed = 0f;
float duration = 0.5f;
Vector3 startScale = currentTransformation.transform.localScale;
float endMultiplier = 0.5f;
Vector3 endScale = startScale * endMultiplier;
while (elapsed < duration)
{
if (currentTransformation == null) break;
currentTransformation.transform.localScale = Vector3.Lerp(startScale, endScale, elapsed / duration);
elapsed += Time.deltaTime;
yield return null;
}
}
}
SpawnPoofEffect();
yield return new WaitForSeconds(0.1f);
ExecuteReversion();
isTransformingSequence = false;
}
private void SpawnPoofEffect()
{
if (Player.m_localPlayer == null) return;
Vector3 pos = Player.m_localPlayer.transform.position + Vector3.up;
// Vanilla's puff carries a size suffix and has no bare "vfx_corpse_destruction" - so
// this used to resolve to nothing and the body swap happened in plain view, with only
// the sparks below to soften it. _medium is the one built for a body this size.
GameObject smoke = PrefabManager.Cache.GetPrefab<GameObject>("vfx_corpse_destruction_medium");
if (smoke != null) Instantiate(smoke, pos, Quaternion.identity);
GameObject sparks = PrefabManager.Cache.GetPrefab<GameObject>("vfx_HitSparks");
if (sparks != null) Instantiate(sparks, pos, Quaternion.identity);
}
/// <summary>
/// The vanilla creature a form is built from. One place rather than two, because the howl
/// that announces a transformation has to be read off the same creature the body comes from.
/// </summary>
private static string CreaturePrefabFor(FenrirProgression.FormType form)
{
switch (form)
{
case FenrirProgression.FormType.Wolf: return "Wolf";
case FenrirProgression.FormType.Ulv: return "Ulv";
case FenrirProgression.FormType.Fenring: return "Fenring";
case FenrirProgression.FormType.Cultist: return "Fenring_Cultist";
}
return "";
}
private void ExecuteTransformation(FenrirProgression.FormRules rules)
{
Transform playerVisual = Player.m_localPlayer.transform.Find("Visual");
string prefabName = CreaturePrefabFor(rules.Form);
GameObject prefab = PrefabManager.Cache.GetPrefab<GameObject>(prefabName);
// Sync to ZDO
ZNetView nview = Player.m_localPlayer.GetComponent<ZNetView>();
if (nview != null && nview.IsValid())
{
nview.GetZDO().Set("RacesOfValheim_FenrirForm", prefabName);
}
if (prefab != null && playerVisual != null)
{
// Shrinking the Visual to nothing was how this hid the human body, and it stopped
// working: the scale reset that keeps a non-Trol player at normal size runs from a
// postfix on this same update and puts it straight back to 1, so the man reappeared
// standing inside his own wolf. Hide the renderers instead - that is what Skadi and
// the Aswid already do, and nothing resets it.
PlayerVisualHider.Hide(playerVisual, "fenrir-local-form");
Transform visual = prefab.transform.Find("Visual");
if (visual != null)
{
currentTransformation = Instantiate(visual.gameObject, Player.m_localPlayer.transform);
currentTransformation.transform.localPosition = Vector3.zero;
currentTransformation.transform.localRotation = Quaternion.identity;
// DEAD LINE, kept until somebody decides what it was for. The game has no type
// called "AnimEvent" - the animation-event dispatcher is CharacterAnimEvent - and
// GetComponent(string) matches a type name in full, so this has never found
// anything and the Destroy has never run.
Component animEvent = currentTransformation.GetComponent("AnimEvent");
if (animEvent != null) Destroy(animEvent);
// The creature's own animations carry their sounds as events; this is what hears
// them. On the object that owns the Animator, because that is where Unity delivers
// an animation event - for the wolf that is WolfSmooth, two levels down, not the
// Visual this method has in hand.
Animator formAnimator = currentTransformation.GetComponentInChildren<Animator>(true);
if (formAnimator != null)
{
formAnimator.gameObject.AddComponent<FormAnimEventSound>();
Jotunn.Logger.LogInfo(
$"[FenrirForm] animation-event listener on '{formAnimator.gameObject.name}'.");
}
else
{
Jotunn.Logger.LogWarning(
"[FenrirForm] no Animator under the form; animation sounds will not play.");
}
float ttl = rules.DurationMinutes > 0 ? (rules.DurationMinutes * 60f) : 0f;
if (prefabName == "Ulv")
{
currentTransformation.AddComponent<UlvFormBehavior>();
Player.m_localPlayer.GetSEMan().AddStatusEffect("SE_WolfForm".GetStableHashCode(), true);
var se = Player.m_localPlayer.GetSEMan().GetStatusEffect("SE_WolfForm".GetStableHashCode());
if (se != null) se.m_ttl = ttl;
Player.m_localPlayer.Message(MessageHud.MessageType.Center, "You are an Ulv!");
}
else if (prefabName == "Wolf")
{
currentTransformation.AddComponent<WolfFormBehavior>();
Player.m_localPlayer.GetSEMan().AddStatusEffect("SE_WolfForm".GetStableHashCode(), true);
var se = Player.m_localPlayer.GetSEMan().GetStatusEffect("SE_WolfForm".GetStableHashCode());
if (se != null) se.m_ttl = ttl;
Player.m_localPlayer.Message(MessageHud.MessageType.Center, "You are a Wolf!");
}
else if (prefabName == "Fenring_Cultist")
{
currentTransformation.AddComponent<CultistFormBehavior>();
Player.m_localPlayer.GetSEMan().AddStatusEffect("SE_CultistForm".GetStableHashCode(), true);
var se = Player.m_localPlayer.GetSEMan().GetStatusEffect("SE_CultistForm".GetStableHashCode());
if (se != null) se.m_ttl = ttl;
Player.m_localPlayer.Message(MessageHud.MessageType.Center, "You are a Cultist!");
}
else
{
currentTransformation.AddComponent<FenrirFormBehavior>();
Player.m_localPlayer.GetSEMan().AddStatusEffect("SE_FenrirForm".GetStableHashCode(), true);
var se = Player.m_localPlayer.GetSEMan().GetStatusEffect("SE_FenrirForm".GetStableHashCode());
if (se != null) se.m_ttl = ttl;
Player.m_localPlayer.Message(MessageHud.MessageType.Center, "You are a Fenring!");
}
isTransformed = true;
}
}
}
private void DestroyAllForms()
{
if (Player.m_localPlayer == null) return;
var forms1 = Player.m_localPlayer.GetComponentsInChildren<FenrirFormBehavior>(true);
foreach (var f in forms1) Destroy(f.gameObject);
var forms2 = Player.m_localPlayer.GetComponentsInChildren<CultistFormBehavior>(true);
foreach (var f in forms2) Destroy(f.gameObject);
var forms3 = Player.m_localPlayer.GetComponentsInChildren<WolfFormBehavior>(true);
foreach (var f in forms3) Destroy(f.gameObject);
var forms4 = Player.m_localPlayer.GetComponentsInChildren<UlvFormBehavior>(true);
foreach (var f in forms4) Destroy(f.gameObject);
}
private void ExecuteReversion()
{
Transform playerVisual = Player.m_localPlayer.transform.Find("Visual");
if (currentTransformation != null) Destroy(currentTransformation);
DestroyAllForms(); // Safety check to remove any leaked forms
// Sync to ZDO
ZNetView nview = Player.m_localPlayer.GetComponent<ZNetView>();
if (nview != null && nview.IsValid())
{
nview.GetZDO().Set("RacesOfValheim_FenrirForm", "");
}
// Show undoes the scale and the SetActive of the older hiding paths as well, so a form
// entered before this change still reverts cleanly.
PlayerVisualHider.Show(playerVisual, "fenrir-local-revert");
Player.m_localPlayer.GetSEMan().RemoveStatusEffect("SE_FenrirForm".GetStableHashCode());
Player.m_localPlayer.GetSEMan().RemoveStatusEffect("SE_CultistForm".GetStableHashCode());
Player.m_localPlayer.GetSEMan().RemoveStatusEffect("SE_WolfForm".GetStableHashCode());
isTransformed = false;
Player.m_localPlayer.Message(MessageHud.MessageType.Center, "You returned to human form.");
if (activeRules != null && activeRules.CooldownMinutes > 0)
{
string cdName = activeRules.Form == FenrirProgression.FormType.Cultist ? "SE_CultistCooldown" : "SE_FenrirCooldown";
Player.m_localPlayer.GetSEMan().AddStatusEffect(cdName.GetStableHashCode(), true);
var cdSE = Player.m_localPlayer.GetSEMan().GetStatusEffect(cdName.GetStableHashCode());
if (cdSE != null) cdSE.m_ttl = activeRules.CooldownMinutes * 60f;
}
activeRules = null;
}
}
}