Modular Cheat Code System v2.0

CheatManager.cs

This is the "brain" of the system. It's a MonoBehaviour that actively listens for keyboard input, manages the list of all available cheats, and triggers their actions when a valid code is typed.

ModularCheatDefinition.cs

This is a ScriptableObject and the heart of the system's modularity. Each cheat code in your game is a separate asset file. Here you define the cheat's code, its action (Spawn, Trigger Event, or Both), and the necessary data (prefab or event ID).

SmartSpawnCalculator.cs

A helper component that ensures your spawned objects don't get stuck in walls. It uses a SphereCast to find a safe, collision-free position in front of the player before instantiating a prefab.

CheatEventManager.cs

A static class that acts as a central communication hub. When a cheat with the TriggerEvent action is activated, this manager broadcasts a signal that any other script in your project can listen to, creating a powerful, decoupled workflow.

Using `SpawnObject`

This action type is perfect for instantly bringing physical objects into the game world. The SmartSpawnCalculator will ensure they appear in a safe location in front of the player.

• Spawn a Sports Car: Create a cheat with the code "FASTCAR" and assign your sports car prefab.
• Get a Weapon Set: Use the code "WEAPONSET1" to spawn a powerful shotgun pickup.
• Drop a Health Pack: Type "NEEDHEALTH" to make a health kit appear at your feet.

Using `TriggerEvent`

This is the most powerful action for interacting with your game's systems. It sends a message to your other scripts, telling them to perform an action. It's ideal for changing player stats or game states.

• God Mode: Create a cheat "INVINCIBLE" with the event ID "TOGGLE_GOD_MODE". Your `PlayerHealth` script can listen for this ID and set a boolean `isInvincible` to true.
• Add Money: Use "CASHMONEY" with the event ID "ADD_MONEY_1000". Your `PlayerWallet` script can listen and add 1000 to the player's balance.
• Infinite Ammo: A cheat "NOREL OAD" with the event ID "INFINITE_AMMO" can tell your `WeaponManager` to stop consuming ammo.

Using `Both`

Combine the power of spawning an object and triggering an event with a single code. This is perfect for situations where you want to give the player an item and immediately make it more powerful.

• Super Weapon & Max Ammo: Create a cheat "SUPERWEAPON" that spawns a rocket launcher prefab AND triggers the event "MAX_ALL_AMMO". The player gets the new weapon and instantly has full ammunition for it.
• Spawn a Jetpack & Enable Flight: Use "FLYHIGH" to spawn a jetpack prefab that attaches to the player, and simultaneously trigger the "ENABLE_FLIGHT_MODE" event in your character controller.

SpawnObject Examples

These cheats will spawn a simple colored box in front of the player.

• Spawn Red Box: Type RED to spawn a red-colored box.
• Spawn Blue Box: Type BLUE to spawn a blue-colored box.
• Spawn Gray Box: Type GRAY to spawn a gray-colored box.

TriggerEvent Examples

These cheats interact with the PlayerStats.cs script included in the demo to modify player attributes.

• Add +15 Health: Type HEALTH to add 15 points to your health.
• Add +10 Armor: Type ARMOR to add 10 points to your armor.
• Add +80 Coins: Type COINS to add 80 coins to your balance.

Both Examples

These cheats demonstrate the power of executing two actions with a single code.

• Add +10 Armor & Spawn Red Box: Type ARCV to receive 10 armor points and spawn a red box simultaneously.
• Add +80 Coins & Spawn Gray Box: Type NRTV to receive 80 coins and spawn a gray box simultaneously.

Step 1: Create the Cheat Definition

Create a new ModularCheatDefinition asset. Configure it as follows:

• Cheat Code: HEALME
• Action Type: TriggerEvent
• Event Identifier: ADD_HEALTH (This is a custom ID you define)

Don't forget to add this new asset to the CheatManager's list.

Step 2: Modify Your Player Script to Listen

Open your existing PlayerStats.cs (or any other relevant script) and add the following code. The comments explain each part of the simple integration process.

using UnityEngine;
// Make sure to include the system's namespace
using ModularCheatCodeSystem; 

public class PlayerStats : MonoBehaviour
{
    public int currentHealth = 50;
    public int maxHealth = 100;

    // STEP 1: Subscribe to the event manager when this script is enabled.
    private void OnEnable()
    {
        CheatEventManager.OnCheatTriggered += HandleCheatInput;
    }

    // STEP 2: Unsubscribe when the script is disabled to prevent errors.
    private void OnDisable()
    {
        CheatEventManager.OnCheatTriggered -= HandleCheatInput;
    }

    // STEP 3: Create the handler function that will be called by the event.
    private void HandleCheatInput(string eventID)
    {
        // Check if the received event ID is the one we're listening for.
        if (eventID == "ADD_HEALTH")
        {
            Debug.Log("Health cheat activated! Restoring health.");
            currentHealth = maxHealth;
            // Optionally, update your UI here.
        }
    }
}

Q: Why isn't my cheat activating in the game?
A: The most common reasons are: 1) The cheat code is misspelled. 2) The ModularCheatDefinition asset has not been added to the Available Cheats list on your CheatManager component. 3) The cheat is not configured correctly (e.g., a missing prefab) - check the console for warnings at game start.

Q: Can I have cheats that take arguments, like "SPAWN GRENADES 10"?
A: Version 2.0 does not support arguments directly in the cheat code. However, you can easily achieve this by creating a separate cheat definition for each value (e.g., a cheat "GIVE10GRENADES" with an event ID of "ADD_10_GRENADES").