Function start

src/OpenLoco/src/Tutorial.cpp:64–133

0x0043C590

    // 0x0043C590
    void start(int16_t tutorialNumber)
    {
        if (tutorialNumber < 0 || tutorialNumber > 3)
        {
            return;
        }

        // NB: only used by tutorial widget drawing after.
        _tutorialNumber = tutorialNumber;

        // Figure out what dimensions to use for the tutorial, and whether we can continue using scaling.
        const auto& config = Config::get();
        Config::Resolution newResolution = tutorialResolution;
        if (config.scaleFactor > 1.0)
        {
            newResolution *= config.scaleFactor;
            Config::Resolution desktopResolution = Ui::getDesktopResolution();

            // Don't scale if it means the new window won't fit the desktop.
            if (newResolution > desktopResolution)
            {
                Ui::setWindowScaling(1.0);
                newResolution = tutorialResolution;
            }
        }

        // Ensure that we're in windowed mode, using dimensions 1024x768.
        auto currentResolution = Ui::getResolution();
        if (config.display.mode != Config::ScreenMode::window || currentResolution != newResolution)
        {
            if (!Ui::setDisplayMode(Config::ScreenMode::window, newResolution))
            {
                return;
            }
        }

        // Get the environment file for this tutorial.
        static constexpr Environment::PathId tutorialFileIds[] = {
            Environment::PathId::tut1024_1,
            Environment::PathId::tut1024_2,
            Environment::PathId::tut1024_3,
        };

        auto fileId = tutorialFileIds[tutorialNumber];

        auto tutPath = Environment::getPath(fileId);
        _tutorialData = readTutorialFile(tutPath);
        _tutorialIt = _tutorialData.cbegin();

        // Set the first string to show.
        static constexpr StringId openingStringIds[] = {
            StringIds::tutorial_1_string_1,
            StringIds::tutorial_2_string_1,
            StringIds::tutorial_3_string_1,
        };

        _state = State::playing;
        _tutorialString = openingStringIds[_tutorialNumber];