Career Unlock Flags Module

Dependencies

M.dependencies = {"career_saveSystem"}

Boolean flag system for tracking unlockable career features. Flags are defined by other modules via the onGetUnlockFlagDefinitions hook and cached on first access. Supports lazy evaluation through unlockedFunction.

Public API

Lifecycle Hooks

Dependencies

• career_saveSystem (required) - save slot access

Flag Definition Format

Other modules register flags via onGetUnlockFlagDefinitions(flagDefinitions):

-- Example hook handler (not part of this extension):
local function onGetUnlockFlagDefinitions(flagDefinitions)
  flagDefinitions["myFeatureUnlocked"] = {
    unlockedFunction = function()
      return career_branches.getBranchLevel("motorsport") >= 2
    end,
    icon  = "trophy",
    level = 2,
    label = "Reach Motorsport Level 2",
  }
end

Locked Reason Format

getFlagLockedReason(flagName) returns:

{
  type  = "locked",
  icon  = "trophy",
  level = 2,
  label = "Reach Motorsport Level 2",
}

Caching Behavior

• Flags are lazily cached: unlockedFunction() runs only on first getFlag() call
• Cache persists until resetFlags() or onCareerActivated
• setFlag() overrides the cached value without calling unlockedFunction

Hooks Emitted

Usage Example

-- Check if a feature is unlocked
if career_modules_unlockFlags.getFlag("cargoLogisticsMaterials") then
  -- enable materials transport
end

See Also

• permissions - Runtime permission checks (different from persistent flags)
• playerAttributes - Attribute-based progression