Core Data Types

PlayerData

The main data structure for player information, based on your DefaultData module.

export type PlayerData = typeof(DefaultData)

Example DefaultData structure:

{
    Coins = 0,
    Level = 1,
    Experience = 0,
    Inventory = {},
    Settings = {
        MusicEnabled = true,
        SoundEnabled = true,
    },
    Plot = {
        Likes = 0,
        Size = 1,
        Buildings = {},
    },
    Stats = {
        TotalPlayTime = 0,
        GamesPlayed = 0,
        HighScore = 0,
    },
    Achievements = {},

    -- NEW: Leaderstats configuration
    leaderstats = {
        ["💰 Coins"] = "Coins",
        ["⭐ Level"] = "Level",
        ["👍 Likes"] = "Plot.Likes"
    }
}

Path Types

ValuePath

String type for dot-separated data paths.

export type ValuePath = string

Examples:

"Coins"              -- Top-level access
"Plot.Likes"         -- Nested access
"Settings.MusicEnabled"  -- Deep nesting
"Stats.HighScore"    -- Any depth
"Plot.Buildings.House.Level"  -- Complex nesting

ArrayPath

String type for paths to array/list data structures.

export type ArrayPath = string

Examples:

"Inventory"          -- Top-level array
"Plot.Buildings"     -- Nested array
"Achievements"       -- List of achievements
"Stats.RecentScores" -- Nested score array

DictPath

String type for paths to dictionary/table data structures.

export type DictPath = string

Examples:

"Settings"           -- Settings dictionary
"Plot.Buildings"     -- Building configuration
"Stats"              -- Player statistics
"Inventory.Equipped" -- Equipment slots