Freeroam Organizations

Loads and manages organization data used in career mode. Organizations have reputation levels, associated facilities, and delivery capabilities.

Public API

Organization Data Structure

{
  id = "orgId",
  name = "Organization Name",
  visible = true,            -- has the player interacted with this org?
  attributeKey = "orgIdReputation",
  reputation = {
    level = 2,
    value = 150,
    max = 1000,              -- from reputation module
    min = -1000,
    label = "Trusted"
  },
  reputationLevels = {       -- array of level definitions
    { unlocks = { ... } }
  },
  offersDeliveries = true,
  hasUnlocks = true,
  associatedFacilities = { ... }
}

How It Works

1. Loading: getOrganizations() scans gameplay/organizations/*.organizations.json files
2. Enrichment: Each organization gets reputation data from career_modules_reputation and visibility from career_career.hasInteractedWithOrganization()
3. UI Data: getUIDataForOrg() adds min/max/label for reputation, checks delivery capabilities, identifies associated facilities
4. Delivery Check: Iterates deliveryProvider facilities to find those with parcelDelivery or vehicleDelivery systems

Usage Examples

-- Get all organizations
local orgs = freeroam_organizations.getOrganizations()

-- Get UI-ready data for a specific org
local uiData = freeroam_organizations.getUIDataForOrg("belasco_corp")

-- Get all organizations sorted for UI
local allUiData = freeroam_organizations.getUIData()
-- Sorted alphabetically by name

Notes

• Organizations are cached after first load
• Reputation data refreshed on each getOrganization() call
• Reputation level labels come from career_modules_reputation.getLabel()
• getOrganizationIdOrderAndIcon returns fixed values - all orgs share the same base sort order

See Also

• Freeroam Big Map Markers - Related reference
• Freeroam Big Map Mode - Related reference
• Freeroam Big Map POI Provider - Related reference
• Freeroam Guide - Guide