ModEntry.cs

using Pathoschild.Stardew.NoclipMode.Framework;
using StardewModdingAPI;
using StardewModdingAPI.Events;
using StardewModdingAPI.Utilities;
using StardewValley;

namespace Pathoschild.Stardew.NoclipMode
{
    /// <summary>The mod entry point.</summary>
    public class ModEntry : Mod
    {
        /*********
        ** Fields
        *********/
        /// <summary>The mod configuration.</summary>
        private ModConfig Config = null!; // set in Entry

        /// <summary>The keys which toggle noclip mode.</summary>
        private KeybindList ToggleKey => this.Config.ToggleKey;

        /// <summary>An arbitrary number which identifies messages from Noclip Mode.</summary>
        private const int MessageID = 91871825;


        /*********
        ** Public methods
        *********/
        /// <summary>The mod entry point, called after the mod is first loaded.</summary>
        /// <param name="helper">Provides simplified APIs for writing mods.</param>
        public override void Entry(IModHelper helper)
        {
            // init
            I18n.Init(helper.Translation);
            this.Config = helper.ReadConfig<ModConfig>();

            // hook events
            helper.Events.GameLoop.GameLaunched += this.OnGameLaunched;
            helper.Events.Input.ButtonsChanged += this.OnButtonsChanged;
        }


        /*********
        ** Private methods
        *********/
        /// <inheritdoc cref="IGameLoopEvents.GameLaunched"/>
        /// <param name="sender">The event sender.</param>
        /// <param name="e">The event data.</param>
        private void OnGameLaunched(object? sender, GameLaunchedEventArgs e)
        {
            // add Generic Mod Config Menu integration
            new GenericModConfigMenuIntegrationForNoclipMode(
                getConfig: () => this.Config,
                reset: () => this.Config = new ModConfig(),
                saveAndApply: () => this.Helper.WriteConfig(this.Config),
                modRegistry: this.Helper.ModRegistry,
                monitor: this.Monitor,
                manifest: this.ModManifest
            ).Register();
        }

        /// <inheritdoc cref="IInputEvents.ButtonsChanged"/>
        /// <param name="sender">The event sender.</param>
        /// <param name="e">The event data.</param>
        private void OnButtonsChanged(object? sender, ButtonsChangedEventArgs e)
        {
            if (this.CanToggle() && this.ToggleKey.JustPressed())
            {
                bool enabled = Game1.player.ignoreCollisions = !Game1.player.ignoreCollisions;
                this.ShowConfirmationMessage(enabled, this.ToggleKey);
            }
        }

        /// <summary>Show a confirmation message for the given noclip mode, if enabled.</summary>
        /// <param name="noclipEnabled">Whether noclip was enabled; else noclip was disabled.</param>
        /// <param name="keybind">The keybind that was pressed.</param>
        private void ShowConfirmationMessage(bool noclipEnabled, KeybindList keybind)
        {
            // skip if message not enabled
            if (noclipEnabled && !this.Config.ShowEnabledMessage)
                return;
            if (!noclipEnabled && !this.Config.ShowDisabledMessage)
                return;

            // show message
            Game1.hudMessages.RemoveAll(p => p.number == ModEntry.MessageID);
            string? keybindStr = keybind.GetKeybindCurrentlyDown()?.ToString();
            string text = noclipEnabled ? I18n.EnabledMessage(keybindStr) : I18n.DisabledMessage(keybindStr);
            Game1.addHUDMessage(new HUDMessage(text, HUDMessage.error_type) { noIcon = true, number = ModEntry.MessageID });
        }

        /// <summary>Get whether noclip mode can be toggled in the current context.</summary>
        private bool CanToggle()
        {
            return
                Context.IsPlayerFree // free to move
                || (Context.IsWorldReady && Game1.eventUp); // in a cutscene (so players can get unstuck if something blocks scripted movement)
        }
    }
}