Table of Contents

Scripting API Reference

The Anti-Cheat Toolkit (ACTk) provides a comprehensive set of APIs to protect your Unity games from common cheating methods. This reference covers all public classes, methods, and properties available in the toolkit.

  • Use the filter in the left pane to quickly find specific classes or methods
  • Browse by namespace to explore related functionality
  • Check the User Manual for detailed usage examples and best practices
  • Look for 🔗 See Also links at the bottom of each API page for related classes

Common Patterns

Basic Obscured Type Usage

// Instead of: int health = 100;
ObscuredInt health = new ObscuredInt(100);

// Instead of: string playerName = "Player";
ObscuredString playerName = new ObscuredString("Player");

Detector Setup

// Add detector to scene
var detector = SpeedHackDetector.AddToSceneOrGetExisting();

// Subscribe to cheat detection
detector.CheatDetected += OnCheatDetected;

Secure Storage

// Save encrypted data
ObscuredFilePrefs.Set("PlayerData", encryptedData);

// Load encrypted data
var data = ObscuredFilePrefs.Get("PlayerData", defaultValue);

💡 Pro Tip: For comprehensive guidance on implementation patterns and best practices, refer to the User Manual which covers real-world scenarios and advanced configurations.