[#5128][Bug] Tutorial 26 'Adaptive Steering' - Manual Exit out of Tutorial Locks Adaptive Steering Control Setting

[Duncaroos]

Version
8.0 & 9.0 Beta 1 [video file is from 9.0 Beta 1 using Steam Recording, however manually checked the 8.0 version using a NoSteam version to confirm it is also issue in 8.0]


Conditions for Problem to Occur
Problem occurs regardless of the initial setting, i.e.:

• 'Control Settings' -> 'Adaptive Steering - Mouse' -> 'OFF' [This is the case for the video file evidence]
• 'Control Settings' -> 'Adaptive Steering - Mouse' -> 'ON'

Description of Problem
The tutorial starts, and the Instructor forces the player's 'Adaptive Steering - Mouse' Control Setting to be 'ON', however the core problem is that it locks this control setting and attempting to toggle the setting via the pause menu does nothing (for good reason for THIS tutorial). However, if a player decides they no longer wish to complete the tutorial and exits the tutorial prior to the tutorial asking if they want Adaptive Steering to be On/Off by default - the rest of the X4.exe instance is stuck with Adaptive Steering to 'ON' regardless of the control setting in the pause menu.

So if a player exited early from this tutorial - the 'Adaptive Steering - Mouse' Controls Setting will always be 'ON' even if the setting is showing as 'OFF'.


Location of Problem

• Tutorial 26 - Adaptive Steering
• Main Menu -> Settings -> Controls -> 'Adaptive Steering - Mouse' Option

Reproduction Steps

1. Review Settings for 'Adaptive Steering - Mouse' (referred herein as "_Setting_" for this section).
2. Start Tutorial 'Adaptive Steering'.
3. Before Instructor locks setting - try mouse steering controls (if _Setting_ is 'OFF' - moving mouse left/right should yaw the ship; if 'ON' - moving mouse left/right should roll the ship).
4. Before Instructor locks setting - try toggling the _Setting_. You will notice NO CHANGE to the ship behaviour and the _Setting_ is always 'ON'.
5. After Instructor locks setting - try mouse steering controls (moving mouse left/right should roll the ship).
6. Pause the game and go and review the _Setting_; the _Setting_ will not have changed to 'ON' if it was previously 'OFF'.
7. Try toggling the _Setting_ and unpause; you will notice that the ship mouse steering control remains as if the _Setting_ was 'ON', regardless of the _Setting_ actually states in the Controls Settings.
   • This is not technically a bug, as the tutorial wants the player to try and use Adaptive Steering with the left/right mouse movement rolling the ship. However, this will be the cause of the unintended consequence in the next steps!
8. Exit the Tutorial before completing the tutorial / flying course.
9. Go to Open Universe or Tutorial 02 'Flight' - you will notice that regardless of the _Setting_ value in the Control Settings, the player will experience flight as if the _Setting_ was 'ON' [bug].

Found Workaround

1. User must set the setting they want for 'Adaptive Steering - Mouse'.
2. Exit X4 Game.
3. Restart X4 Game.

Suggested Fix
If this is originally like a condition where the game checks 'OR( AdaptiveMouseSteering_User , AdaptiveMouseSteering_Tutorial26 )', we could simply add an argument to ensure that assumed parameter 'AdaptiveMouseSteering_Tutorial26' is only valid when within that specific tutorial (i.e., the check becomes 'OR[ AdaptiveMouseSteering_User , (AdaptiveMouseSteering_Tutorial26) * (IsActive_Tutorial26) ]'.

IsActive_Tutorial26 is set to true when the tutorial starts, and IsActive_Tutorial26 is set to false when either (a) the player exits prematurely, or (b) the player finishes the tutorial to completion.

This way would resolve the issue without resorting to any complicated UI changes during the Tutorial like making the 'Adaptive Steering - Mouse' setting read-only (not accessible to player during Tutorial), or having to save User's default value and playing around with the 'Adaptive Steering - Mouse' setting in the Control Settings.


Save + Video Example
Save cannot be provided as it is disabled (Tutorial)
Video Evidence: https://drive.google.com/drive/folders/ ... sp=sharing

Video is broken down as follows, with testing notes:

• 'Flight' Tutorial
  • [normal] t=00m:29s ... Opened 'Flight' Tutorial, checked in-game mouse steering method (left/right=yaw == 'OFF') and confirmed setting in the Controls menu (set to 'OFF') {Result: OK}.
    • Checked in-game Primary/Secondary steering axis options under the current setting {Result: Primary (Secondary): left/right=yaw (roll) == 'OFF' - OK}.
  • [normal] t=00m:40s ... Toggled the 'Adaptive Steering - Mouse' setting in the Controls menu (set to 'ON'), checked in-game mouse steering method (left/right=roll == 'ON') {Result: OK}.
    • Checked in-game Primary/Secondary steering axis options under the current setting {Result: Primary (Secondary): left/right=roll (yaw) == 'ON' - OK}.
  • [normal] t=00m:59s ... Toggled the 'Adaptive Steering - Mouse' setting back to original in the Controls menu (set to 'OFF'), checked in-game mouse steering method (left/right=yaw == 'OFF') {Result: OK}.
    • Checked in-game Primary/Secondary steering axis options under the current setting {Result: Primary (Secondary): left/right=yaw (roll) == 'OFF' - OK}.
• 'Adaptive Steering' Tutorial
  • [normal] t=01m:49s ... Opened 'Adaptive Steering' Tutorial - Rechecked in-game mouse steering method same as above before Instructor locks 'Adaptive Steering - Mouse' Controls Setting to 'ON' {Result: left/right=yaw == 'OFF' - OK}.
    • Checked in-game Primary/Secondary steering axis options under the current setting {Result: Primary (Secondary): left/right=yaw (roll) == 'OFF' - OK}.
  • [normal] t=02m:25s ... Instructor locks Adaptive Steering setting to 'ON'. Checked in-game mouse steering method (left/right=roll == 'ON') {Result: OK}.
    • Checked in-game Primary/Secondary steering axis options under the current setting {Result: Primary (Secondary): left/right=roll (yaw) == 'ON' - OK}.
  • [important] t=02m:45s ... Reviewed Control Settings for 'Adaptive Steering - Mouse' Controls Setting is set to ''OFF'. Checked in-game mouse steering method (left/right=roll == 'ON') {Result: Tutorial forcing 'Adaptive Steering - Mouse' to be 'ON', regardless of player's Controls Setting - Conditionally OK}
  • [normal] t=03m:00s ... Toggled the 'Adaptive Steering - Mouse' Controls Setting to 'ON'). Checked in-game mouse steering method (left/right=roll == 'ON') {Result: OK}
• 'Flight' Tutorial
  • [normal] t=03m:10s ... Opened Tutorial 02 'Flight'. Confirmed 'Adaptive Steering - Mouse' Controls Setting is still set to 'ON'; checked in-game mouse steering method (left/right=roll == 'ON') {Result: OK}.
    • Checked in-game Primary/Secondary steering axis options under the current setting {Result: Primary (Secondary): left/right=roll (yaw) == 'ON' - OK}.
  • [bug] t=03m:50s ... Toggled the 'Adaptive Steering - Mouse' setting back to original in the Controls menu (set to 'OFF'); checked in-game mouse steering method (left/right=roll == 'ON') {Result: BUG & NOT OK}.
    • Checked in-game Primary/Secondary steering axis options under the current setting {Result: Primary (Secondary): left/right=roll (yaw) == 'ON' - BUG & NOT OK}.

[Duncaroos]

Isolating the Forced Adaptive Steering cue:

Code: Select all

<cue name="Tutorial_AdaptiveSteering_ForceAdaptiveSteering">
   <conditions>
      <event_cue_signalled/>
   </conditions>
   <actions>
      <set_value name="$AdaptiveSteeringDuration" exact="30s"/>
      <generate_loadout macro="$PlayerShip.macro" macros="[macro.thruster_gen_s_combat_01_mk1_macro]" result="$Loadouts" flags="thrusters"/>
      <apply_loadout object="$PlayerShip" flags="thrusters" loadout="$Loadouts.{1}"/>
      <set_adaptive_steering_forced/>   <<<<------------------------------------
   </actions>
</cue>

And Isolating the Completed Tutorial cue where it asks the player how they want to proceed with Adaptive Steering:

Code: Select all

<cue name="Tutorial_AdaptiveSteering_SettingQuestion">
   <conditions>
      <event_cue_signalled/>
   </conditions>
   <actions>
      <reset_adaptive_steering/>   <<<<------------------------------------
      ...
   </actions>
   ...
</cue>

<set_adaptive_steering_forced/>looks to be what I expected was causing the issue, and <reset_adaptive_steering/> at tutorial completion I suspect turns off <set_adaptive_steering_forced/>.

Unfortunately, in cue 'Tutorial_Quit' (I suspect this is what captures when a player exits a tutorial pre-maturely), <reset_adaptive_steering/> is not used. May be the key here!