API Reference

// Generated by GameSchema — do not edit
public static class Enemies
{
    public const string TableName = "enemies";

    // One typed Column<T> per column. Use these in every query —
    // no raw strings, full refactoring support.
    public static readonly Column<int>    Id       = new("id");
    public static readonly Column<string> Name     = new("name");
    public static readonly Column<int>    Level    = new("level");
    public static readonly Column<int>    WeaponId = new("weapon_id");

    // Simple one-liners
    public static EnemyData           Get(int id)                   { ... }
    public static List<EnemyData>     GetAll(Condition filter = null){ ... }
    public static int                 Count(Condition filter = null) { ... }

    // Full query builder
    public static TypedQuery<EnemyData> Query()      { ... }
    public static TypedQuery<EnemyData> From(int id) { ... }
}

// Generated data class
[Table("enemies")]
public class EnemyData
{
    [PrimaryKey]            public int    Id;
    [NotNull]               public string Name;
                            public int    Level;
    [ForeignKey("weapons")] public int    WeaponId;
}

// Get a single row by primary key (returns null if not found)
EnemyData boss = Enemies.Get(42);

// Get all rows — no filter means every row
List<EnemyData> all = Enemies.GetAll();

// Get all rows matching a condition
List<EnemyData> tough = Enemies.GetAll(Enemies.Level > 5);

// Compound condition in one call
List<EnemyData> elite = Enemies.GetAll(
    (Enemies.Level > 10) & Enemies.Name.Like("%boss%")
);

// Count without allocating a list
int n = Enemies.Count(Enemies.Level > 5);

// Entry point: Enemies.Query() for all rows, .From(id) for a PK seed
var results = Enemies.Query()
    .Where(Enemies.Level > 5)
    .Where(Enemies.Name.Like("%goblin%"))   // AND-chained automatically
    .OrderBy(Enemies.Name)
    .Limit(10)
    .Offset(20)
    .FetchAll();                            // List<EnemyData>

// FetchOne — returns first match or default
EnemyData first = Enemies.Query()
    .Where(Enemies.Level > 5)
    .OrderByDesc(Enemies.Level)
    .FetchOne();

// FetchCount — no row allocation
int count = Enemies.Query()
    .Where(Enemies.Level > 5)
    .FetchCount();

// FetchExists — cheapest existence check
bool any = Enemies.Query()
    .Where(Enemies.Level > 100)
    .FetchExists();

// Traverse two FK hops in a single SQL query — no extra round-trips
string effectName = Enemies.From(42)
    .Follow(Enemies.WeaponId, "weapons")
    .Follow(Weapons.StatusEffectId, "status_effects")
    .Fetch(StatusEffects.Name);            // returns string

// Fetch the full object at the end of a chain
WeaponData weapon = Enemies.From(42)
    .Follow(Enemies.WeaponId, "weapons")
    .Fetch<WeaponData>();                  // full mapped object

// Follow a reverse relation (one → many)
// "All loot entries that reference this enemy's loot table"
List<LootEntryData> loot = Enemies.From(42)
    .Follow(Enemies.LootTableId, "loot_entries", "loot_table_id")
    .FetchAll<LootEntryData>();

// Generated lazy-loading navigation properties
// (requires FK attributes on the data class)
EnemyData boss = Enemies.Get(42);

WeaponData     weapon = boss.Weapon;           // lazy-loaded on first access
StatusEffect   effect = boss.Weapon.StatusEffect;
string         name   = boss.Weapon.StatusEffect.Name;

// Equality
Enemies.Level == 5          // WHERE level = 5
Enemies.Level != 5          // WHERE level != 5

// Comparison
Enemies.Level >  5          // WHERE level > 5
Enemies.Level >= 5          // WHERE level >= 5
Enemies.Level <  5          // WHERE level < 5
Enemies.Level <= 5          // WHERE level <= 5

// Pattern matching
Enemies.Name.Like("%goblin%")   // WHERE name LIKE '%goblin%'
Enemies.Name.Like("boss_%")     // WHERE name LIKE 'boss_%'

// Range
Enemies.Level.Between(5, 10)    // WHERE level BETWEEN 5 AND 10

// Set membership
Enemies.Level.In(1, 5, 10)      // WHERE level IN (1, 5, 10)
Enemies.Level.NotIn(1, 2, 3)    // WHERE level NOT IN (1, 2, 3)

// Null checks
Enemies.WeaponId.IsNull()       // WHERE weapon_id IS NULL
Enemies.WeaponId.IsNotNull()    // WHERE weapon_id IS NOT NULL

// & → AND
var c = Enemies.Level > 5 & Enemies.Name.Like("%boss%");

// | → OR
var c = Enemies.Level > 20 | Enemies.Name == "Dragon King";

// Compound: (Level > 5 AND Name LIKE '%goblin%') OR Level > 20
var c = (Enemies.Level > 5 & Enemies.Name.Like("%goblin%"))
      | Enemies.Level > 20;

// Use in GetAll, Count, or Where
var results = Enemies.GetAll(c);
int n       = Enemies.Count(c);
var q       = Enemies.Query().Where(c).OrderBy(Enemies.Level).FetchAll();

using GameSchema.Attributes;

// Maps the class to a specific table name.
// Omit to use the lowercase class name ("enemydata" → always specify this).
[Table("enemies")]
public class EnemyData
{
    // Marks this field as the PRIMARY KEY column
    [PrimaryKey]
    public int Id;

    // Maps to a differently-named column (e.g. "display_name" in the DB)
    [Column("display_name")]
    public string Name;

    // Adds NOT NULL to the schema
    [NotNull]
    public int Level;

    // Sets a default value in the schema
    [DefaultValue(1)]
    public int Tier;

    // Declares a FK relationship; the editor shows a dropdown of valid values
    [ForeignKey("weapons", "id")]
    public int WeaponId;

    // Same, but shows "name" column in the editor dropdown instead of the raw ID
    [ForeignKey("weapons", "id", DisplayColumn = "name")]
    public int SecondaryWeaponId;

    // Column stores an Addressable address; editor shows an asset picker
    [AssetRefColumn(typeof(Sprite))]
    public AssetRef<Sprite> Icon;

    // Excluded from DB mapping entirely — won't be read or written
    [Ignore]
    public string RuntimeOnlyCache;
}

// AssetRef<T> stores the Addressable address string in the DB.
// The GAMESCHEMA_ADDRESSABLES module must be enabled for the loading helpers.
// Enable it via Window > GameSchema > Welcome > Modules.

// In your data class:
public AssetRef<Sprite>     Icon;
public AssetRef<GameObject> Prefab;
public AssetRef<AudioClip>  SoundEffect;

// ── async / await ──────────────────────────────────────────────────────────
Sprite icon = await enemy.Icon.LoadAsync();
myRenderer.sprite = icon;

// ── Callback (no async overhead) ───────────────────────────────────────────
enemy.Icon.Load(sprite => myImage.sprite = sprite);

// With error handling:
enemy.Icon.Load(
    onLoaded: sprite => myImage.sprite = sprite,
    onFailed: err    => Debug.LogError(err)
);

// ── Coroutine ──────────────────────────────────────────────────────────────
yield return enemy.Prefab.LoadCoroutine(go => Instantiate(go));

// ── Blocking (only if asset is cached locally) ─────────────────────────────
Material mat = enemy.Material.LoadSync();

// ── Instantiate a prefab ───────────────────────────────────────────────────
GameObject go = await enemy.Prefab.InstantiateAsync(parentTransform);
enemy.Prefab.Instantiate(go => go.name = "SpawnedEnemy");

// ── Release when done ──────────────────────────────────────────────────────
enemy.Icon.Release(icon);
Addressables.ReleaseInstance(go);

// ── Without the module: use the address string directly ───────────────────
if (enemy.Icon.IsValid)
    Addressables.LoadAssetAsync<Sprite>(enemy.Icon.Address);

// Start a QueryBuilder directly (accepts raw strings — use sparingly)
var results = DB.Table("enemies")
    .Where("level", Op.Gt, 5)
    .Where("name", Op.Like, "%goblin%")
    .OrderBy("name")
    .Limit(10)
    .Get<EnemyData>();

// JOINs (only available on low-level QueryBuilder)
var joined = DB.Table("enemies")
    .JoinFK("weapon_id", "weapons")                   // LEFT JOIN weapons ON enemies.weapon_id = weapons.id
    .Join("loot_tables", "enemies.loot_id", "loot_tables.id") // INNER JOIN
    .Select("enemies.id", "enemies.name", "weapons.damage")
    .Where("enemies.level", Op.Gt, 5)
    .Get<EnemyCombatData>();

// Convenience shorthands
DB.Table("enemies").WhereEquals("name", "Goblin King").Get<EnemyData>();
DB.Table("enemies").WhereIn("level", 1, 5, 10).Get<EnemyData>();
DB.Table("enemies").WhereBetween("level", 5, 10).Get<EnemyData>();

// Direct access to the underlying GameDatabase (escape hatch)
GameDatabase db = DB.Main;

// Raw execute (INSERT / UPDATE / DELETE)
db.Execute("UPDATE enemies SET level = level + 1 WHERE id = ?", 42);

// Raw query → List<Dictionary<string, object>>
var rows = db.Query("SELECT * FROM enemies WHERE level > ?", 5);

// Scalar — first column of first row
int count = (int)(long)db.Scalar("SELECT COUNT(*) FROM enemies");

// Find by PK (low-level)
var enemy = DB.Find<EnemyData>("enemies", 42);