GENERAL CAREER MODE REQUIREMENTS
This section outlines the essential parameters that all aircraft must comply with to function properly in Career Mode. It provides detailed descriptions of each parameter, their significance in the gameplay flow, and whether incorrect configurations may block mission progression.
Developers will find information to guide them in setting up critical components such as engine status, cover states, parking brakes, and flight parameters across different phases. By adhering to these requirements, you ensure a seamless and functional experience for players in Career Mode missions.
Before mission
This section details the essential pre-mission checks to be carried out to ensure optimum compatibility with career mode. Each point aims to ensure that critical parameters are correctly defined.
Item | Acceptance Criteria | Explanation | Link to documentation | Considered as blocker |
---|---|---|---|---|
Opt-In | The targeted specialization is correclty set in aircraft.cfg of each preset of the aircraft. | Include or exclude your aircraft from compatible specialization you aimed for your aircraft | Targeted_specializations | Yes |
Flight Performance Data | Accurate flight performance data is set, particularly landing distance tables. | Proper performance data allows the career system to select suitable airfields for mission activities. Landing distance data is crucial for destination runway selection. Missions system use data from flight_performance.cfg | Flight Performance Configuration | Yes |
Fuel Burn Rate | ui_fuel_burn_rate is correctly set depending on aircraft | Missions system determines its mission selection for each aircraft based on this paramters. it ensures missions selected can indeed be completed by the aircraft. It should be slightly conservative to ensure mission completion. | Aircraft Configuration - Fuel Burn Rate | Yes |
EFB Flight Plan Sync | Flight plan sync is correctly established between EFB and aircraft avionics. | Proper sync ensures the possibility to sync flight plan between EFB and aircraft avionics. Solutions include using updated avionics packages or implementing APIs for custom avionics. | - Using included avionics: MSFS Avionics Framework ("The MSFS Avionics Framework") - Using your own JS avionics: JS Listener Planned Route - Using WASM avionics: WASM Planned Route API |
No |
Mission flow
FLT
- Hangar.flt (load during the hangar view) :
- Cover : On
- Engine : Off
- Electrical system: Off
- Pkg brake : On (prevent the aircraft to move)
- OnGround : True
- Fly parameter : Idle
- Apron.flt (load at the very start of the mission) :
- Cover : On
- Engine : Off
- Electrical system: Off
- Pkg brake : On (prevent the aircraft to move)
- OnGround : True
- Fly parameter : Idle
- ApronWithoutCover.flt (load during some RTC with passenger after a skip of preflight phase) :
- Cover : Off
- Engine : Off
- Electrical system: Off
- Pkg brake : On (prevent the aircraft to move)
- OnGround : True
- Fly parameter : Idle
- Taxi.flt (load after a skip of the preflight or before taxi phase or after a back on track during taxi phase) :
- Cover : Off
- Engine : On
- Electrical system: On
- Pkg brake : On (prevent the aircraft to move)
- OnGround : True
- Fly parameter : Idle
- Runway.flt (load after a skip of the taxi phase or after a back on track during takeoff phase) :
- Cover : Off
- Engine : On
- Electrical system: On
- Pkg brake : On (prevent the aircraft to move)
- OnGround : True
- Fly parameter : Idle
- Cruise.flt (load after a back on track during cruise phase) :
- Cover : Off
- Engine : On
- Electrical system: On
- Pkg brake : Off
- OnGround : False
- Fly parameter : Stable flight
- Approach.flt (load after a back on track during landing phase before reaching final phase) :
- Cover : Off
- Engine : On
- Electrical system: On
- Pkg brake : Off
- OnGround : False
- Fly parameter : Stable flight low speed
- Final.flt (load after a back on track during landing phase before reaching final phase) :
- Cover : Off
- Engine : On
- Electrical system: On
- Pkg brake : Off
- OnGround : False
- Fly parameter : Descent flight ready to land
SimVars
1. During preflight :
- ENG COMBUSTION (BLOCKER) (Check if engines are on for heat engine aircraft, index on engine number / Can block engine ignition step validation, prevent to passs to the next part of the flow )
- NUMBER OF ENGINES (To find out how many engines the aircraft has : Linked to the ignition step validation)
- COVER ON (BLOCKER) (Check if covers are removed, index on cover number)
- CIRCUIT ELECTRIC ENGINE ON (BLOCKER) (Check if engines is on for electric engine aircraft)
- AIRCRAFT CATEGORY (should be aicraft object class) (Check if the aircraft is a plane or a helicopter)
2. During taxi :
- IS GEAR SKIDS (To find out how the taxi phase can be done : hover or rolling)
- PARKING BRAKE AVAILABLE (BLOCKER) (Check if the player needs a step to trigger parking brake - Not available for the moment)
- IS GEAR WHEELS (Check if the player needs a step to parking brake)
- BRAKE PARKING POSITION (To inform the player that he must remove his pkg brake before taxi if it set)
- GENERAL ENG THROTTLE LEVER POSITION (To inform the player that he must reduce speed before reach the holdshort)
3. During take-off :
- IS GEAR RETRACTABLE (Check if the player needs a step to retract the wheels)
- GEAR TOTAL PCT EXTENDED (Check if the player has retract the wheels)
- PLANE ALTITUDE MINUS CG (Check if the player is at good altitude to validate takeoff)
4. During Landing :
- GEAR SPEED EXCEEDED (Check if it is safe to extend your gear)
- RECIP ENG FUEL AVAILABLE (Check if the player perform a dead stick landing on a propeller engine, index on engine number)
- TURB ENG FUEL AVAILABLE (Check if the player perform a dead stick landing on a turbo engine, index on engine number)
5. Shutdown :
- ENG N1 RPM (BLOCKER) (Check if propeller rotation is completely stopped to trigger reward screen, index on engine number)
- ROTOR RPM (BLOCKER) (Check if rotorblade rotation is completely stopped to trigger reward screen)
- ROTOR BRAKE ACTIVE (Check if the player needs a step to trigger rotor brake)
Aviator performance penalty / failure
Flaps overspeed :
- FLAPS AVAILABLE (Check if aircraft has flaps to activate the penalty)
- FLAPS CURRENT SPEED LIMITATION (Check that the player is not extending his flaps at too high a speed)
Cruise speed IFR :
- ESTIMATED CRUISE SPEED
Fuel minimum :
- ENG FUEL FLOW GPH (for all engine)
- FUEL TOTAL QUANTITY
Landing light :
- LIGHT LANDING ON
Max G force :
- POSITIVE G LIMIT FLAPS UP
- POSITIVE G LIMIT FLAPS DOWN
- NEGATIVE G LIMIT FLAPS UP
- NEGATIVE G LIMIT FLAPS DOWN
Max speed :
- REFERENCE SPEED MAX IAS
Overtorque :
- TURB ENG MAX TORQUE PERCENT
Gears Overspeed :
- REFERENCE SPEED MAX IAS GEAR DOWN
Taxi speeding :
- SURFACE RELATIVE GROUND SPEED
Navigation graph nodes and tags
1. During preflight :
- SPAWN_EXTERIOR_RTC (Node facing the aircraft, where the avatar is after the walking RTC / when starting a mission)
- SPAWN_EXTERIOR (Node near the main aircraft door, where the avatar spawns when starting a freeflight / when leaving the aircraft)
- PILOT (Node where the pilot should be seat in the aircraft)