Campaign Photo Safari

Photo safari mission system for campaign exploration. Players drive to locations, enter photo mode, and capture specific objects within camera constraints.

Overview

Manages photo safari missions where players must photograph target objects from correct positions. Tracks found/unfound locations, unlocks progressive hints via trigger zones, and validates photos against camera frustum and distance checks.

Public API

Module State

Mission Data Format

{
  "location_key": {
    "objectName": "SceneObjectName",
    "closeToPhoto": "trigger_name",
    "hints": ["Hint 1", "Hint 2", "Hint 3"]
  }
}

Photo Validation

takepiccheck() performs these checks:

1. Already found - Skip if location already photographed
2. Close enough - Player must be near the target trigger
3. Camera distance - Camera must not be farther than initial entry distance
4. Frustum check - Target object's world box must be fully contained in camera frustum
5. Special case: on-site - Additional vehicle position check for on_site locations

-- Frustum validation
if not Engine.sceneGetCameraFrustum():isBoxOutside(sceneObject:getWorldBox())
   and Engine.sceneGetCameraFrustum():isBoxContained(sceneObject:getWorldBox()) then
  -- Photo accepted!
end

Hint System

Hints are unlocked progressively by entering specific trigger zones:

-- Predefined hint triggers
local hintTriggers = {
  'prototype_2_trigger_CD',
  'prototype_2_shady_trigger',
  'prototype_2_ranger_trigger',
  'prototype_2_stuntman_trigger',
  'prototype_2_police_trigger'
}
-- Each trigger visited unlocks the next hint level for all unfound locations

Trigger Flow

Enter hint trigger → Unlock next hint for all unfound locations
Enter photo location trigger → Set photomodeOpen, record target object
Enter closeToPhoto trigger → Enable photo validation, record camera distance
Exit photo location → Disable photomodeOpen

Integration

Called from campaign_exploration.openLocationExtraUI():

if locationInfo.subtype == 'photoMode' then
  campaign_photoSafari.missionaccepted(locationData.filepath)
end

Photo safari data is also read by campaign_exploration.getMinimapInfo() for minimap POI display.

Notes

• Photo validation exits photo mode and shows a flash message with the result
• simTimeAuthority.pause(false) is called after validation to resume gameplay
• The on_site location has special handling requiring both vehicle and camera positioning
• seen table tracks which hint triggers have been visited (prevents re-triggering)
• Camera distance reference is set on first entry to the closeToPhoto trigger
• Uses Engine.sceneGetCameraFrustum() for real-time frustum queries

See Also

• Campaign Exploration - Triggers photo safari from exploration UI
• Campaign System - Campaign orchestration

Additional Exports

• M.cameraDistanceToObject - (undocumented)
• M.closeToPhoto - (undocumented)
• M.count - (undocumented)
• M.description - (undocumented)
• M.foundLocation - (undocumented)
• M.location - (undocumented)
• M.msg - (undocumented)
• M.photoSafariData - (undocumented)
• M.photoSafarimissions - (undocumented)
• M.showhint - (undocumented)