Sanity Events

The Sanity System in Distorted Vigil is built with modularity at its core. Instead of manually registering every hallucination or effect, the system uses Reflection to automatically discover and execute your custom events.

To add a new insanity effect, you simply need to create a new C# class that inherits from

SanityEvent.

🛠 The Base Class

Every sanity event must inherit from the

SanityEvent abstract class. This class defines the lifecycle and the triggering conditions of your effect.

📋 Parameters

These properties define when and how often your event will occur. You can override them in your custom class:

Property	Description
eventID	A unique string ID (e.g., "hallucination_whisper"). Used for internal cooldown tracking.
minSanity	The minimum sanity value required for the event to be eligible.
maxSanity	The maximum sanity value required for the event to be eligible.
triggerChance	Percentage chance (0-100) to trigger during the system's check interval.
duration	How long the event stays active (in seconds).
cooldown	How long to wait before this specific event can trigger again.

---

🔄 Lifecycle Methods

Each event has three main stages. Understanding these is key to creating smooth effects:

1. onStart(SanitySystem system)

Triggered exactly once when the event begins.

• Use for: Initializing visual effects, playing a "start" sound, or spawning a temporary object.

• Tip: Always check if (system.IsOwner) to ensure effects only apply to the local player.

2. onUpdate(SanitySystem system)

Runs every frame while the event is active.

• Use for: Fading out a screen overlay, shaking the camera, or moving a "shadow person" closer to the player.

3. onStop(SanitySystem system)

Triggered exactly once after the duration ends.

• Use for: Cleanup. Resetting the camera rotation, hiding UI, or stopping looping audio.

---

💻 Code Example

Here is a complete template for a "Screen Tilt" event:

using UnityEngine;

public class ScreenTiltEvent : SanityEvent
{
    public override string eventID => "screen_tilt";
    public override float maxSanity => 30f; // Only happens when sanity is low
    public override float triggerChance => 20f;
    public override float duration => 3f;

    private float tiltAmount = 15f;

    public override void onStart(SanitySystem system)
    {
        if (system.IsOwner) Debug.Log("Everything is leaning...");
    }

    public override void onUpdate(SanitySystem system)
    {
        if (system.IsOwner)
        {
            // Gently tilt the camera over time
            float zRotation = Mathf.Sin(Time.time * 5f) * tiltAmount;
            Camera.main.transform.rotation = Quaternion.Euler(0, 0, zRotation);
        }
    }

    public override void onStop(SanitySystem system)
    {
        if (system.IsOwner)
        {
            // Reset the camera tilt
             Camera.main.transform.rotation = Quaternion.identity;
        }
    }
}

💡 Best Practices

• Check Ownership: Since this is a multiplayer game using FishNet, always use system.IsOwner

  inside your methods. You don't want a local hallucination to affect other players' cameras!

• Cleanup is Key: Always ensure onStop reverts any changes you made during onStart or onUpdate.

• Unique IDs: Make sure your eventID is unique. If two mods use the same ID, their cooldowns will interfere with each other.