🔄Exports

🏠 Farm Ownership

DoesPlayerOwnFarm

Check if a player owns any farm.

Parameters:

• source (number) - Player server ID

Returns:

• boolean - True if player owns a farm, false otherwise

Example:

local ownsFarm = exports['m-FarmingSimulator']:DoesPlayerOwnFarm(source)
if ownsFarm then
    print("Player owns a farm!")
end

---

GetPlayerFarm

Get complete farm data for a player.

Parameters:

• source (number) - Player server ID

Returns:

• table|nil - Farm data object or nil if no farm owned

Return Structure:

{
    id = 1,                      -- Database ID
    land_id = 1,                 -- Farm location ID
    owner = "license:xxxxx",     -- Owner identifier
    co_owners = {},              -- Array of co-owner data
    purchase_date = "2024-01-01",
    upgrade_level = 0,
    upgrades = {},
    total_earned = 0,
    total_spent = 0,
    plants_harvested = 0,
    products_collected = 0,
    contracts_completed = 0
}

Example:

local farm = exports['m-FarmingSimulator']:GetPlayerFarm(source)
if farm then
    print("Farm ID: " .. farm.land_id)
    print("Total earned: $" .. farm.total_earned)
end

---

GetFarmOwner

Get the owner identifier of a specific farm.

Parameters:

• farmId (number) - Farm location ID

Returns:

• string|nil - Owner identifier or nil if farm has no owner

Example:

local owner = exports['m-FarmingSimulator']:GetFarmOwner(1)
if owner then
    print("Farm 1 is owned by: " .. owner)
end

---

HasFarmAccess

Check if a player is the owner or co-owner of a specific farm.

Parameters:

• source (number) - Player server ID

• farmId (number) - Farm location ID

Returns:

• boolean - True if player has access (owner or co-owner)

Example:

local hasAccess = exports['m-FarmingSimulator']:HasFarmAccess(source, 1)
if hasAccess then
    -- Player can interact with this farm
end

---

📦 Farm Inventory

GetFarmInventory

Get all items stored in player's farm inventory.

Parameters:

• source (number) - Player server ID

Returns:

• table - Table of items {itemName = quantity}

Example:

local inventory = exports['m-FarmingSimulator']:GetFarmInventory(source)
for itemName, quantity in pairs(inventory) do
    print(itemName .. ": " .. quantity)
end

---

AddToFarmInventory

Add items to player's farm inventory.

Parameters:

• source (number) - Player server ID

• itemName (string) - Item name

• amount (number) - Quantity to add

Returns:

• boolean - Success status

Example:

local success = exports['m-FarmingSimulator']:AddToFarmInventory(source, 'tomato', 10)
if success then
    print("Added 10 tomatoes to farm inventory")
end

---

RemoveFromFarmInventory

Remove items from player's farm inventory.

Parameters:

• source (number) - Player server ID

• itemName (string) - Item name

• amount (number) - Quantity to remove

Returns:

• boolean - Success status (false if insufficient quantity)

Example:

local success = exports['m-FarmingSimulator']:RemoveFromFarmInventory(source, 'tomato', 5)
if success then
    print("Removed 5 tomatoes from farm inventory")
else
    print("Not enough tomatoes in inventory")
end

---

🌱 Plants Management

GetPlayerPlants

Get all plants from player's farm.

Parameters:

• source (number) - Player server ID

Returns:

• table - Array of plant data objects

Example:

local plants = exports['m-FarmingSimulator']:GetPlayerPlants(source)
print("Player has " .. #plants .. " plants")
for _, plant in ipairs(plants) do
    print("Plant: " .. plant.plant_type .. " | Health: " .. plant.health .. "%")
end

---

GetPlayerPlantCount

Get the number of plants on player's farm.

Parameters:

• source (number) - Player server ID

Returns:

• number - Number of plants

Example:

local count = exports['m-FarmingSimulator']:GetPlayerPlantCount(source)
print("Player has " .. count .. " plants")

---

🐄 Animals Management

GetPlayerAnimals

Get all animals from player's farm.

Parameters:

• source (number) - Player server ID

Returns:

• table - Array of animal data objects

Example:

local animals = exports['m-FarmingSimulator']:GetPlayerAnimals(source)
print("Player has " .. #animals .. " animals")
for _, animal in ipairs(animals) do
    print("Animal: " .. animal.animal_type .. " | Health: " .. animal.health .. "%")
end

---

GetPlayerAnimalCount

Get the number of animals on player's farm.

Parameters:

• source (number) - Player server ID

Returns:

• number - Number of animals

Example:

local count = exports['m-FarmingSimulator']:GetPlayerAnimalCount(source)
print("Player has " .. count .. " animals")

---

📊 Statistics

GetPlayerStatistics

Get player's farming statistics.

Parameters:

• source (number) - Player server ID

Returns:

• table|nil - Statistics object or nil if no farm

Return Structure:

{
    total_earned = 50000,
    total_spent = 30000,
    plants_harvested = 150,
    products_collected = 75,
    contracts_completed = 10,
    purchase_date = "2024-01-01",
    upgrade_level = 2
}

Example:

local stats = exports['m-FarmingSimulator']:GetPlayerStatistics(source)
if stats then
    local profit = stats.total_earned - stats.total_spent
    print("Total profit: $" .. profit)
end

---

AddPlayerEarnings

Add earnings to player's statistics (tracking purposes).

Parameters:

• source (number) - Player server ID

• amount (number) - Amount earned

Returns:

• boolean - Success status

Example:

exports['m-FarmingSimulator']:AddPlayerEarnings(source, 1000)

---

AddPlayerSpending

Add spending to player's statistics (tracking purposes).

Parameters:

• source (number) - Player server ID

• amount (number) - Amount spent

Returns:

• boolean - Success status

Example:

exports['m-FarmingSimulator']:AddPlayerSpending(source, 500)

---

🏆 Reputation & Contracts

GetPlayerReputation

Get player's farming reputation points.

Parameters:

• source (number) - Player server ID

Returns:

• number - Reputation points

Example:

local reputation = exports['m-FarmingSimulator']:GetPlayerReputation(source)
print("Player reputation: " .. reputation)

---

AddPlayerReputation

Add reputation points to player.

Parameters:

• source (number) - Player server ID

• amount (number) - Reputation to add (can be negative)

Returns:

• boolean - Success status

Example:

-- Add reputation for completing contract
exports['m-FarmingSimulator']:AddPlayerReputation(source, 10)

-- Remove reputation for failing
exports['m-FarmingSimulator']:AddPlayerReputation(source, -5)

---

GetPlayerActiveContracts

Get all active contracts for a player.

Parameters:

• source (number) - Player server ID

Returns:

• table - Array of active contract objects

Example:

local contracts = exports['m-FarmingSimulator']:GetPlayerActiveContracts(source)
print("Player has " .. #contracts .. " active contracts")

---

🛠️ Admin Utilities

GiveFarmToPlayer

Give a farm to a player (admin function).

Parameters:

• source (number) - Player server ID

• farmId (number) - Farm location ID

Returns:

• boolean - Success status

Conditions:

• Farm must exist in Config.FarmLocations

• Farm must not already have an owner

• Player must not already own a farm

Example:

-- Give farm ID 1 to player
local success = exports['m-FarmingSimulator']:GiveFarmToPlayer(source, 1)
if success then
    TriggerClientEvent('chat:addMessage', source, {
        args = {"System", "You received a farm!"}
    })
end

---

RemoveFarmFromPlayer

Remove farm and all related data from player (admin function).

Parameters:

• source (number) - Player server ID

Returns:

• boolean - Success status

Warning: This action is irreversible and removes:

• Farm ownership

• All plants

• All animals

• Farm inventory

• All contracts

• Decorations

Example:

local success = exports['m-FarmingSimulator']:RemoveFarmFromPlayer(source)
if success then
    print("Farm removed from player")
end

---

💡 Integration Examples

Custom Shop Integration

-- Check if player owns farm before allowing purchase
RegisterServerEvent('myshop:buyFarmSeeds')
AddEventHandler('myshop:buyFarmSeeds', function()
    local src = source
    
    if not exports['m-FarmingSimulator']:DoesPlayerOwnFarm(src) then
        TriggerClientEvent('chat:addMessage', src, {
            args = {"Shop", "You need to own a farm first!"}
        })
        return
    end
    
    -- Process purchase...
end)

Custom Reward System

-- Reward players based on farming activity
function GiveFarmingBonus(source)
    local stats = exports['m-FarmingSimulator']:GetPlayerStatistics(source)
    
    if stats and stats.plants_harvested >= 100 then
        -- Give bonus for harvesting 100+ plants
        GivePlayerMoney(source, 5000)
        exports['m-FarmingSimulator']:AddPlayerReputation(source, 25)
    end
end

Leaderboard System

-- Create farming leaderboard
function GetTopFarmers()
    local allPlayers = GetPlayers()
    local farmers = {}
    
    for _, playerId in ipairs(allPlayers) do
        local stats = exports['m-FarmingSimulator']:GetPlayerStatistics(tonumber(playerId))
        if stats then
            table.insert(farmers, {
                source = playerId,
                earnings = stats.total_earned
            })
        end
    end
    
    table.sort(farmers, function(a, b) return a.earnings > b.earnings end)
    return farmers
end

---