Delivery Missions

Reference for gameplay_delivery_delivery, a class-based module providing delivery mission logic. Manages location selection, route calculation, timing, damage checking, and delivery progression.

Overview

This module returns a constructor function that creates delivery objects. Each delivery has a pickup point, a set of delivery locations selected from sites, a calculated roundtrip time limit, and fail conditions for damage and time.

Note: This is a class module (uses metatables), not a standard extension.

Constructor

local Delivery = require("gameplay/delivery/delivery")
local delivery = Delivery()

Methods

State Machine

Setup Flow

local delivery = Delivery()
delivery.vehId = playerVehId
delivery:setTimeParameters(60, 30) -- 60s base + 30s per km

delivery:setup(sites, pickupPos, 10, "deliveryPoint", 3)
-- Selects 3 random locations tagged "deliveryPoint"
-- Calculates roundtrip distance via road network
-- Sets timer = baseTime + timePerKm * distance/1000

delivery:startDelivery()

How It Works

1. setup() loads sites, selects random tagged locations, calculates the roundtrip distance via the road map, and sets the time limit
2. startDelivery() transitions to "active" state and sets locationIndex = 1
3. update(dt) decrements the timer and checks fail conditions each frame
4. proceedDelivery() advances locationIndex; when all locations are visited, state becomes "return"
5. checkFail(dt) checks if vehicle damage exceeds maxDamage (5000) or time runs out

Route Calculation

calculateRoundtrip() uses map.findClosestRoad() and map.getPath() to compute road-network distances between:

• Pickup → First location
• Each location → Next location
• Last location → Pickup

Fail Conditions

Key Behaviors

• Locations are shuffled randomly using Fisher-Yates shuffle
• The locationRewardFactor (0.5) scales reward based on completion progress
• Timer pauses briefly when isPartiallyInsideLocationOneFrame is true
• The events.proceedDelivery flag is set when advancing to the next location
• Route distances include road offset distances from findClosestRoad

See Also

• Gameplay Systems Guide - Guide