Typist.pk3

// Entry point for Typist.pk3.
class tt_EventHandler : EventHandler
{
  override void worldTick()
  {
    _playerHandler.tick();
    _server.tick();
    self.IsUiProcessor = _playerHandler.isCapturingKeys();
  }

  override bool uiProcess(UiEvent event)
  {
    let character = tt_Character.of(event.type, event.keyChar, event.isCtrl);
    _playerHandler.processKey(character);

    return false;
  }

  override bool inputProcess(InputEvent event)
  {
    _playerHandler.processInput(event.type);
    return false;
  }

  override void playerEntered(PlayerEvent event)
  {
    if (gameState != GS_Level && gameState != GS_StartUp) return;

    self.RequireMouse = true;

    if (_server == NULL) _server = tt_Server.of();

    int playerNumber = event.playerNumber;

    _server.addPlayer(playerNumber);
    tt_GameTweaks.tweakPlayer(players[playerNumber]);

    if (playerNumber == consolePlayer)
      _playerHandler = tt_PlayerSupervisor.of(consolePlayer);
  }

  override void playerDisconnected(PlayerEvent event)
  {
    _server.removePlayer(event.playerNumber);
  }

  override void playerDied(PlayerEvent event)
  {
    _playerHandler.setMode(tt_Mode.Explore);
  }

  override void playerRespawned(PlayerEvent event)
  {
    _playerHandler.setMode(tt_Mode.None);
  }

  override void worldThingDied(WorldEvent event)
  {
    _playerHandler.reportDead(event.Thing);
  }

  override void worldLoaded(WorldEvent event)
  {
    bool isTitlemap = (level.mapName ~== "TITLEMAP");
    if (isTitlemap)
      destroy();
  }

  override void worldUnloaded(WorldEvent event)
  {
    self.IsUiProcessor = false;
  }

  override void renderOverlay(RenderEvent event)
  {
    _playerHandler.draw(event);
  }

  override void consoleProcess(ConsoleEvent event)
  {
    string command = event.Name;

    if (command.left(3) != "tt_") return;

    if      (command == "tt_unlock_mode"  ) _playerHandler.setMode(tt_Mode.None);
    else if (command == "tt_force_combat" ) _playerHandler.setMode(tt_Mode.Combat);
    else if (command == "tt_reset_targets") _playerHandler.reset(consolePlayer);
  }

  override void networkCommandProcess(NetworkCommand command)
  {
    if (command.command == "tt_target")
    {
      double x = command.readDouble();
      double y = command.readDouble();
      double z = command.readDouble();

      _server.react(command.player, (x, y, z));
    }
  }

  int getMode() const { return _playerHandler.getMode(); }

  private tt_PlayerHandler _playerHandler;
  private tt_Server        _server;
}

// Buddha
server bool tt_buddha_enabled = true;

// Handles game tweaks.
class tt_GameTweaks play
{
  static void tweakPlayer(PlayerInfo player)
  {
    let pawn = player.mo;
    if (pawn == NULL) return;

    makeInvulnerable(pawn);
    increaseDamage(pawn);
    decreaseIncomingDamage(pawn);
    protectFromSelfDamage(pawn);
    disableSeekingMissiles(pawn);
  }

  // Still lose health down to 1 point.
  static private void makeInvulnerable(PlayerPawn pawn)
  {
    if (tt_buddha_enabled)
      pawn.giveInventory("tt_Buddha", 1);
  }

  static private void increaseDamage(PlayerPawn pawn)
  {
    double originalDamage = getDefaultByType(pawn.getClass()).damageMultiply;
    pawn.damageMultiply = originalDamage * 10;
  }

  static private void decreaseIncomingDamage(PlayerPawn pawn)
  {
    double originalFactor = getDefaultByType(pawn.getClass()).damageFactor;
    pawn.damageFactor = originalFactor / 2;
  }

  static private void protectFromSelfDamage(PlayerPawn pawn)
  {
    pawn.selfDamageFactor = 0;
  }

  static private void disableSeekingMissiles(PlayerPawn pawn)
  {
    pawn.bCantSeek = true;
  }
}

class tt_Buddha : PowerBuddha
{
  Default
  {
    // https://zdoom.org/wiki/Powerup_properties
    Powerup.Duration 0x7FFFFFFD;
    +INVENTORY.UNDROPPABLE;
  }
}

// Handles the game for one player.
class tt_PlayerHandler abstract
{
  abstract void reset(int playerNumber);

  abstract void processKey(tt_Character character);

  // Type is from InputEvent.EGenericEvent.
  abstract void processInput(int type);

  abstract void tick();

  abstract void reportDead(Actor dead);

  abstract bool isCapturingKeys();

  // Mode is from tt_Mode.
  abstract void setMode(int mode);

  // Mode is from tt_Mode.
  abstract int getMode() const;

  ui abstract void draw(RenderEvent event);
}

// General settings
user int  tt_view_scale = 1;
user bool tt_fast_confirmation = false;

// Command settings
user string tt_command_pass_through = "/pass";

// Sound settings
user bool tt_sound_enabled = true;
user int  tt_sound_theme = 1;
user bool tt_sound_typing_enabled = true;

// Handles Typist.pk3 features for one player.
class tt_PlayerSupervisor : tt_PlayerHandler
{
  static tt_PlayerSupervisor of(int playerNumber)
  {
    let result = new("tt_PlayerSupervisor");
    result.reset(playerNumber);
    return result;
  }

  override void reset(int playerNumber)
  {
    let playerSource = tt_PlayerSourceImpl.of(playerNumber);
    let clock        = tt_TotalClock      .of();

    let soundPlayer = tt_PlayerSoundPlayer
      .of(playerSource,
          tt_BoolCvar.of(playerSource, "tt_sound_enabled"),
          tt_IntCvar.of(playerSource, "tt_sound_theme"));

    let answerReporter   = tt_SoundAnswerReporter  .of(soundPlayer);
    let modeReporter     = tt_SoundModeReporter    .of(soundPlayer);
    let isTypingEnabled  = tt_BoolCvar.of(playerSource, "tt_sound_typing_enabled");
    let keyPressReporter = tt_SoundKeyPressReporter.of(soundPlayer, isTypingEnabled);

    let manualModeSource = tt_SettableMode .of();
    let playerInput      = tt_PlayerInput  .of(manualModeSource, keyPressReporter);
    let deathReporter    = tt_DeathReporter.of();

    let originSource     = tt_PlayerOriginSource.of(playerSource);
    let targetRadar      = tt_TargetRadar       .of(originSource);
    let radarStaleMarker = tt_StaleMarkerImpl   .of(clock);
    let radarCacheDirty  = tt_TargetSourceCache .of(targetRadar, radarStaleMarker);
    let radarCache       = tt_TargetSourcePruner.of(radarCacheDirty);
    let lesson           = makeLesson(playerSource);

    let targetRegistry = makeTargetRegistry(radarCache, lesson, deathReporter, clock);

    let answerStateSource = tt_PressedAnswerState.of();

    let visibleTargetSource = tt_VisibleKnownTargetSource.of(targetRegistry,
                                                             playerSource);
    let pressMatcher = tt_QuestionAnswerMatcher
      .of(visibleTargetSource, playerInput, answerStateSource);

    let hastyMatcher = tt_HastyQuestionAnswerMatcher
      .of(visibleTargetSource, playerInput, answerReporter);

    let fastConfirmation   = tt_BoolCvar.of(playerSource, "tt_fast_confirmation");
    let targetOriginSource = tt_OriginSourceCache
      .of(tt_SelectableOriginSource.of(hastyMatcher, pressMatcher, fastConfirmation),
          tt_StaleMarkerImpl.of(clock));

    let projector      = tt_Projector           .of(visibleTargetSource, playerSource);
    let widgetRegistry = tt_TargetWidgetRegistry.of(projector);
    let widgetSorter   = tt_SorterByDistance    .of(widgetRegistry, originSource);

    let autoModeSource = tt_AutoModeSource.of(visibleTargetSource);
    Array<tt_ModeSource> modeSources = {
      tt_AutomapModeSource.of(),
      manualModeSource,
      tt_DelayedCombatModeSource.of(clock, autoModeSource, radarCache),
      autoModeSource
    };

    let modeSource = tt_ReportedModeSource.of(modeReporter,
                                              tt_ModeCascade.of(modeSources));

    let inputManager = tt_PassThroughInputManager
      .of(tt_InputByModeManager.of(modeSource, playerInput));

    Array<tt_Activatable> commands = {
      tt_PassThrough.of(inputManager,
                        tt_StringCvar.of(playerSource, "tt_command_pass_through"))
    };

    let commandDispatcher = tt_CommandDispatcher.of(playerInput,
                                                    commands,
                                                    answerReporter,
                                                    answerStateSource,
                                                    fastConfirmation);

    let oldModeSource         = tt_SettableMode.of();
    let inputBlockAfterCombat = tt_InputBlockAfterCombat
      .of(playerInput, modeSource, oldModeSource);

    let scaleSetting = tt_PositiveIntCvar.of(playerSource, "tt_view_scale");
    let infoPanel = tt_InfoPanel.of(modeSource,
                                    playerInput,
                                    commandDispatcher,
                                    visibleTargetSource,
                                    scaleSetting);

    Array<tt_View> views = {
      tt_TargetOverlay.of(widgetSorter, playerInput, scaleSetting, modeSource),
      tt_Frame.of(modeSource),
      infoPanel
    };

    let targetSender = tt_TargetOriginSender.of(targetOriginSource);

    Array<tt_Effect> effects = {
      tt_Gunner.of(targetOriginSource, targetSender),
      tt_AnswerResetter.of(answerStateSource, playerInput),
      tt_MatchWatcher.of(answerStateSource, answerReporter, targetOriginSource)
    };

    Array<tt_KeyProcessor> keyProcessors = {inputBlockAfterCombat, answerStateSource};

    _keyProcessor       = tt_KeyProcessors.of(keyProcessors);
    _deathReporter      = deathReporter;
    _targetRegistry     = targetRegistry;
    _view               = tt_ConditionalView.of(tt_Views.of(views));
    _modeSource         = modeSource;
    _targetWidgetSource = projector;
    _commandDispatcher  = commandDispatcher;
    _manualModeSource   = manualModeSource;
    _inputManager       = inputManager;
    _oldModeSource      = oldModeSource;
    _inputBlockAfterCombat = inputBlockAfterCombat;
    _effects            = tt_Effects.of(effects);
  }

  override void processKey(tt_Character character)
  {
    _keyProcessor.processKey(character);
  }

  override void processInput(int type)
  {
    _inputManager.processInput(type);
  }

  override void tick()
  {
    _commandDispatcher.activate();
    _inputManager.manageInput();

    _inputBlockAfterCombat.update();
    _oldModeSource.setMode(_modeSource.getMode());

    _effects.doEffect();
  }

  override void reportDead(Actor dead)
  {
    _deathReporter.reportDead(dead);
  }

  override bool isCapturingKeys()
  {
    return _inputManager.isCapturingKeys();
  }

  override void setMode(int mode)
  {
    _manualModeSource.setMode(mode);
  }

  override int getMode() const { return _modeSource.getMode(); }

  override void draw(RenderEvent event)
  {
    _view.draw(event);
  }

// Mixed Lesson configuration
user bool tt_is_english_enabled = true;
user bool tt_is_random_enabled  = false;
user bool tt_is_maths_enabled   = false;
user bool tt_is_custom_enabled  = false;

  private static tt_Lesson makeLesson(tt_PlayerSource playerSource)
  {
    let randomLessonSettings = tt_RandomCharactersLessonSettingsImpl.of(playerSource);

    Array<tt_SwitchableLesson> lessons = {
      tt_SwitchableLesson.of(tt_BoolCvar.of(playerSource, "tt_is_random_enabled"),
                             tt_RandomCharactersLesson.of(randomLessonSettings)),
      tt_SwitchableLesson.of(tt_BoolCvar.of(playerSource, "tt_is_maths_enabled"),
                             tt_MathsLesson.of()),
      tt_SwitchableLesson.of(tt_BoolCvar.of(playerSource, "tt_is_english_enabled"),
                             tt_StringSet.of("tt_1000")),
      tt_SwitchableLesson.of(tt_BoolCvar.of(playerSource, "tt_is_custom_enabled"),
                             tt_StringSet.of("typist_custom_text"))
    };

    return tt_MixedLesson.of(lessons);
  }

  private static tt_KnownTargetSource makeTargetRegistry(
    tt_TargetSource   targetSource,
    tt_Lesson         lesson,
    tt_TargetSource   deathReporter,
    tt_Clock          clock)
  {
    let registry      = tt_TargetRegistry .of(targetSource, lesson, deathReporter);
    let staleMarker   = tt_StaleMarkerImpl.of(clock);
    let registryCache = tt_KnownTargetSourceCache.of(registry, staleMarker);

    return registryCache;
  }

  private tt_KeyProcessor       _keyProcessor;
  private tt_KnownTargetSource  _targetRegistry;
  private tt_DeathReporter      _deathReporter;
  private tt_View               _view;
  private tt_ModeSource         _modeSource;
  private tt_TargetWidgetSource _targetWidgetSource;
  private tt_CommandDispatcher  _commandDispatcher;
  private tt_ModeStorage        _manualModeSource;
  private tt_PassThroughInputManager _inputManager;
  private tt_SettableMode       _oldModeSource;
  private tt_InputBlockAfterCombat _inputBlockAfterCombat;
  private tt_Effect             _effects;
}

class tt_Server
{
  static tt_Server of()
  {
    let result = new("tt_Server");
    result._globalChangers = tt_PlayerWorldChangers.of();
    return result;
  }

  void addPlayer(int playerNumber)
  {
    let playerSource       = tt_PlayerSourceImpl    .of(playerNumber);
    let originSource       = tt_PlayerOriginSource  .of(playerSource);
    let targetOriginSource = tt_ExternalOriginSource.of();
    let targetRadar        = tt_TargetRadar         .of(originSource);
    let radarStaleMarker   = tt_StaleMarkerImpl     .of(tt_TotalClock.of());
    let radarCacheDirty    = tt_TargetSourceCache   .of(targetRadar, radarStaleMarker);
    let radarCache         = tt_TargetSourcePruner  .of(radarCacheDirty);
    let freelookSetting    = tt_BoolCvar            .of(playerSource, "freelook");

    Array<tt_WorldChanger> targetChangers = {
      tt_HorizontalAimer.of(targetOriginSource, playerSource),
      tt_VerticalAimer.of(targetOriginSource, playerSource, freelookSetting),
      tt_Firer.of(playerSource)
    };

    _targetSources[playerNumber]  = targetOriginSource;
    _targetChangers[playerNumber] = tt_WorldChangers.of(targetChangers);

    Array<tt_WorldChanger> globalChangers = {
      tt_ProjectileSpeedController.of(originSource, playerSource),
      tt_EnemySpeedController.of(radarCache, playerSource)
    };

    _globalChangers.add(playerNumber, tt_WorldChangers.of(globalChangers));
  }

  void removePlayer(int playerNumber) { _globalChangers.remove(playerNumber); }

  play void react(int playerNumber, vector3 targetOrigin)
  {
    _targetSources[playerNumber].setOrigin(tt_Origin.of(targetOrigin));
    _targetChangers[playerNumber].changeWorld();
  }

  play void tick() { _globalChangers.changeWorld(); }

  tt_ExternalOriginSource _targetSources[MAXPLAYERS];
  tt_WorldChanger         _targetChangers[MAXPLAYERS];
  tt_PlayerWorldChangers  _globalChangers;
}

// This interface represents entities that change the world state.
class tt_WorldChanger abstract
{
  play abstract void changeWorld();
}

// Implements tt_WorldChanger by executing several instances of tt_WorldChanger.
class tt_WorldChangers : tt_WorldChanger
{
  static tt_WorldChangers of(Array<tt_WorldChanger> changers)
  {
    let result = new("tt_WorldChangers");
    result._changers.move(changers);
    return result;
  }

  void add(tt_WorldChanger changer) { _changers.push(changer); }

  override void changeWorld()
  {
    foreach (changer : _changers)
      changer.changeWorld();
  }

  private Array<tt_WorldChanger> _changers;
}

// Implements tt_WorldChanger by executing not-NULL world changers.
class tt_PlayerWorldChangers : tt_WorldChanger
{
  static tt_PlayerWorldChangers of() { return new("tt_PlayerWorldChangers"); }

  void add(int playerNumber, tt_WorldChanger changer)
  {
    _changers[playerNumber] = changer;
  }

  void remove(int playerNumber)
  {
    _changers[playerNumber] = NULL;
  }

  override void changeWorld()
  {
    foreach (changer : _changers)
      if (changer != NULL) changer.changeWorld();
  }

  private tt_WorldChanger _changers[MAXPLAYERS];
}

// Implements tt_WorldChanger by slowing down enemies.
class tt_EnemySpeedController : tt_WorldChanger
{
  static tt_EnemySpeedController of(tt_TargetSource targetSource,
                                    tt_PlayerSource playerSource)
  {
    let result = new("tt_EnemySpeedController");
    result._targetSource = targetSource;
    result._playerSource = playerSource;
    return result;
  }

  override void changeWorld()
  {
    let  targets  = _targetSource.getTargets();
    uint nTargets = targets.size();
    int  player   = _playerSource.getNumber();

    for (uint i = 0; i < nTargets; ++i)
    {
      let enemy = targets.at(i).getActor();
      if (!tt_VelocityStorage.isSlowedDown(enemy, player))
        tt_VelocityStorage.slowDown(enemy, player);
    }
  }

  private tt_TargetSource _targetSource;
  private tt_PlayerSource _playerSource;
}

// Implements tt_WorldChanger by slowing down projectiles that fly towards the player.
//
// When a projectile is no longer flying towards the player, its speed is
// restored.
class tt_ProjectileSpeedController : tt_WorldChanger
{
  static tt_ProjectileSpeedController of(tt_OriginSource playerOriginSource,
                                         tt_PlayerSource playerSource)
  {
    let result = new("tt_ProjectileSpeedController");
    result._playerOriginSource = playerOriginSource;
    result._playerSource = playerSource;
    return result;
  }

  override void changeWorld()
  {
    let origin       = _playerOriginSource.getOrigin().getVector();
    let playerRadius = _playerSource.getPawn().radius;
    int player       = _playerSource.getNumber();

    foreach (Actor a : ThinkerIterator.Create("Actor", Thinker.STAT_DEFAULT))
      if (a.bMissile) controlProjectile(a, origin, playerRadius, player);
  }

  private play void controlProjectile(Actor a,
                                      vector3 playerOrigin,
                                      double playerRadius,
                                      int player)
  {
    bool isInRange = tt_Math.isInEffectiveRange(a.pos, playerOrigin);

    if (isInRange && isMovingTowardsPlayer(a, playerOrigin, playerRadius))
    {
      if (!tt_VelocityStorage.isSlowedDown(a, player))
        tt_VelocityStorage.slowDown(a, player);
    }
    else if (tt_VelocityStorage.isSlowedDown(a, player))
    {
      tt_VelocityStorage.restoreVelocity(a, player);
    }
  }

  private play bool isMovingTowardsPlayer(Actor projectile,
                                          vector3 playerPos,
                                          double playerRadius)
  {
    vector3 vel = projectile.vel;
    if (vel == (0, 0, 0)) { return false; } // doesn't move

    double oldDistance = (projectile.pos - vel - playerPos).length();
    double distance    = (projectile.pos -       playerPos).length();

    if (distance > oldDistance) { return false; } // moves from player

    // http://mathworld.wolfram.com/Point-LineDistance3-Dimensional.html
    vector3 x10             = projectile.pos - playerPos;
    vector3 prod            = vel cross x10;
    double  lineDistance    = prod.length() / vel.length();
    double  hitDistance     = playerRadius + projectile.radius;
    bool    willTouchPlayer = (hitDistance >= lineDistance);

    return willTouchPlayer;
  }

  private tt_OriginSource _playerOriginSource;
  private tt_PlayerSource _playerSource;
}

// This is a helper class that allows storing the velocity.
// TODO: rewrite with a Behavior?
class tt_VelocityStorage : Inventory
{
  static bool isSlowedDown(Actor other, int byPlayer)
  {
    let storage = tt_VelocityStorage(other.findInventory("tt_VelocityStorage"));
    if (storage == NULL) return false;

    return storage._byWhichPlayer[byPlayer];
  }

  static void slowDown(Actor other, int byPlayer)
  {
    let storage = tt_VelocityStorage(other.findInventory("tt_VelocityStorage"));

    if (storage != NULL)
    {
      storage._byWhichPlayer[byPlayer] = true;
      return;
    }

    storage = tt_VelocityStorage(Actor.spawn("tt_VelocityStorage"));
    storage._velocity = other.vel;
    storage._speed    = other.speed;

    other.addInventory(storage);

    other.vel   *= VELOCITY_SCALE_FACTOR;
    other.speed *= VELOCITY_SCALE_FACTOR;
  }

  static void restoreVelocity(Actor other, int byPlayer)
  {
    let storage = tt_VelocityStorage(other.findInventory("tt_VelocityStorage"));

    storage._byWhichPlayer[byPlayer] = false;

    if (storage.countByPlayers() == 0)
    {
      other.vel   = storage._velocity;
      other.speed = storage._speed;

      other.removeInventory(storage);
      storage.destroy();
    }
  }

  private int countByPlayers()
  {
    int result = 0;
    foreach (byPlayer : _byWhichPlayer)
      result += byPlayer;
    return result;
  }

  // TODO: make velocity scale factor configurable for projectiles and enemies.
  // for actors it was 0.2.
  const VELOCITY_SCALE_FACTOR = 0.1;

  private vector3 _velocity;
  private double  _speed;
  private bool[MAXPLAYERS] _byWhichPlayer;
}

// Implements tt_WorldChanger interface by rotating the player.
class tt_HorizontalAimer : tt_WorldChanger
{
  static tt_HorizontalAimer of(tt_OriginSource targetOriginSource,
                               tt_PlayerSource playerSource)
  {
    let result = new("tt_HorizontalAimer");
    result._targetOriginSource = targetOriginSource;
    result._playerSource       = playerSource;
    return result;
  }

  override void changeWorld()
  {
    let targetOrigin = _targetOriginSource.getOrigin();
    if (targetOrigin == NULL) return;

    let pawn = _playerSource.getPawn();
    if (pawn == NULL) return;

    vector3 myPosition    = pawn.pos;
    vector3 otherPosition = targetOrigin.getVector();
    double  angle         = angleTo(myPosition.XY, otherPosition.XY);

    pawn.a_SetAngle(angle, SPF_INTERPOLATE);
  }

  private static double angleTo(vector2 myPosition, vector2 otherPosition)
  {
    vector2 diff = level.vec2Diff(myPosition, otherPosition);
    return vectorAngle(diff.x, diff.y);
  }

  private tt_OriginSource _targetOriginSource;
  private tt_PlayerSource _playerSource;
}

// Implements tt_WorldChanger interface by adjusting the player pitch
// (horizontal angle). If freelook is disabled, no pitch adjustment is done.
// TODO: fix when is an enemy is visible, but its middle is not.
class tt_VerticalAimer : tt_WorldChanger
{
  static tt_VerticalAimer of(tt_OriginSource targetOriginSource,
                             tt_PlayerSource playerSource,
                             tt_BoolSetting  freelookSetting)
  {
    let result = new("tt_VerticalAimer");
    result._targetOriginSource = targetOriginSource;
    result._playerSource       = playerSource;
    result._freelookSetting    = freelookSetting;
    return result;
  }

  override void changeWorld()
  {
    if (_freelookSetting.get()) setPitch();
  }

  private play void setPitch()
  {
    let targetOrigin = _targetOriginSource.getOrigin();
    if (targetOrigin == NULL) { return; }

    let pawn = _playerSource.getPawn();
    if (pawn == NULL) { return; }

    vector3 myPosition = pawn.pos;
    myPosition.z += pawn.Height / 2 + pawn.AttackZOffset;

    vector3 otherPosition = targetOrigin.getVector();
    vector3 diff          = level.vec3Diff(myPosition, otherPosition);
    double  pitch         = -atan2(diff.z, diff.xy.Length());

    pawn.a_SetPitch(pitch, SPF_INTERPOLATE);
  }

  private tt_OriginSource _targetOriginSource;
  private tt_PlayerSource _playerSource;
  private tt_BoolSetting  _freelookSetting;
}

// Implements tt_WorldChanger by making the player pawn fire a shot.
class tt_Firer : tt_WorldChanger
{
  static tt_Firer of(tt_PlayerSource playerSource)
  {
    let result = new("tt_Firer");
    result._playerSource = playerSource;
    return result;
  }

  override void changeWorld()
  {
    let  playerInfo = _playerSource.getInfo();
    bool isReady    = isWeaponReady(playerInfo);

    if (isReady)
    {
      let   pawn = _playerSource.getPawn();
      State stat = NULL;
      playerInfo.cmd.buttons |= BT_ATTACK;
      pawn.FireWeapon(stat);
    }
  }

  private static bool isWeaponReady(PlayerInfo player)
  {
    bool isReady = (player.WeaponState & WF_WEAPONREADY)
      || (player.WeaponState & WF_WEAPONREADYALT)
      || player.attackDown;

    return isReady;
  }

  private tt_PlayerSource _playerSource;
}

// This interface represents a game element that can be activated by the same
// way the target is damaged. Such elements can be considered generic targets.
class tt_Activatable abstract
{
  abstract void activate();

  abstract tt_Strings getCommands();

  abstract bool isVisible();
}

class tt_PassThrough : tt_Activatable
{
  static tt_PassThrough of(tt_PassThroughInputManager passThroughInputManager,
                           tt_StringCvar passThroughSetting)
  {
    let result = new("tt_PassThrough");
    result._inputManager = passThroughInputManager;
    result._passThroughSetting = passThroughSetting;
    result._commands = tt_Strings.ofOne("");
    return result;
  }

  override void activate()
  {
    _inputManager.setPassThrough();
  }

  override tt_Strings getCommands()
  {
    _commands.set(0, _passThroughSetting.get());
    return _commands;
  }

  override bool isVisible()
  {
    return true;
  }

  private tt_PassThroughInputManager _inputManager;
  private tt_StringSetting _passThroughSetting;
  private tt_Strings       _commands;
}

// Contains Activatables and activates() ones with commands matching answer.
class tt_CommandDispatcher : tt_Activatable
{
  static tt_CommandDispatcher of(tt_AnswerSource       answerSource,
                                 Array<tt_Activatable> activatables,
                                 tt_AnswerReporter     answerReporter,
                                 tt_AnswerStateSource  answerStateSource,
                                 tt_BoolSetting        fastConfirmation)
  {
    let result = new("tt_CommandDispatcher");

    result._answerSource      = answerSource;
    result._activatables.Copy(activatables);
    result._answerReporter    = answerReporter;
    result._answerStateSource = answerStateSource;
    result._fastConfirmation  = fastConfirmation;
    result._commands          = tt_Strings.of();

    return result;
  }

  override void activate()
  {
    let answerState = _answerStateSource.getAnswerState();
    if (!tt_AnswerState.isReady(answerState) && !_fastConfirmation.get()) return;

    let answer       = _answerSource.getAnswer();
    let answerString = answer.getString();

    foreach (activatable : _activatables)
    {
      bool isActivated = tryActivate(activatable, answerString);

      if (isActivated)
      {
        _answerReporter.reportMatch();
        _answerSource.reset();
        _answerStateSource.reset();
        return;
      }
    }
  }

  override tt_Strings getCommands()
  {
    _commands.clear();

    foreach (activatable : _activatables)
    {
      if (!activatable.isVisible()) continue;

      let commands = activatable.getCommands();

      uint nCommands = commands.size();
      for (uint c = 0; c < nCommands; ++c)
        _commands.add(commands.at(c));
    }

    return _commands;
  }

  override bool isVisible()
  {
    return true;
  }

  private bool tryActivate(tt_Activatable activatable, string answer)
  {
    let commands = activatable.getCommands();

    uint nCommands = commands.size();
    for (uint c = 0; c < nCommands; ++c)
    {
      string command    = commands.at(c);
      bool   isMatching = (command == answer);

      if (isMatching)
      {
        activatable.activate();
        return true;
      }
    }

    return false;
  }

  private tt_AnswerSource       _answerSource;
  private Array<tt_Activatable> _activatables;
  private tt_AnswerReporter     _answerReporter;
  private tt_AnswerStateSource  _answerStateSource;
  private tt_BoolSetting        _fastConfirmation;
  private tt_Strings            _commands;
}

// Represents an answer to a tt_Question.
// See tt_Question.
class tt_Answer
{
  static tt_Answer of(String answer = "")
  {
    let result = new("tt_Answer");
    result._answer = answer;
    return result;
  }

  string getString() const
  {
    return _answer;
  }

  void append(string character)
  {
    _answer = _answer .. character;
  }

  void deleteLastCharacter()
  {
    _answer.deleteLastCharacter();
  }

  private string _answer;
}

// This interface represents a source of answers.
class tt_AnswerSource : tt_KeyProcessor abstract
{
  abstract tt_Answer getAnswer();

  // Clears answer.
  abstract void reset();
}

// Implements tt_AnswerSource by taking another tt_AnswerSource,
// and only passing keys to it if a key was pressed down after the game mode
// has changed to Combat.
class tt_InputBlockAfterCombat : tt_AnswerSource
{
  static tt_InputBlockAfterCombat of(tt_AnswerSource answerSource,
                                     tt_ModeSource   modeSource,
                                     tt_ModeSource   oldModeSource)
  {
    let result = new("tt_InputBlockAfterCombat");

    result._answerSource  = answerSource;
    result._modeSource    = modeSource;
    result._oldModeSource = oldModeSource;

    result._isLocked = false;

    return result;
  }

  void update()
  {
    int mode    = _modeSource.getMode();
    int oldMode = _oldModeSource.getMode();

    if (oldMode != tt_Mode.Combat && mode == tt_Mode.Combat)
    {
      _isLocked = true;
    }
  }

  override tt_Answer getAnswer()
  {
    return _answerSource.getAnswer();
  }

  override void processKey(tt_Character character)
  {
    if (character.getEventType() == UiEvent.Type_KeyDown)
    {
      _isLocked = false;
    }

    if (!_isLocked)
    {
      _answerSource.processKey(character);
    }
  }

  override void reset() {}

  private tt_AnswerSource _answerSource;
  private tt_ModeSource   _modeSource;
  private tt_ModeSource   _oldModeSource;

  private bool _isLocked;
}

// Implements tt_AnswerSource by receiving player key inputs and
// composing an answer from them.
class tt_PlayerInput : tt_AnswerSource
{
  static tt_PlayerInput of(tt_ModeStorage      modeStorage,
                           tt_KeyPressReporter keyPressReporter)
  {
    let result = new("tt_PlayerInput");

    result._modeStorage      = modeStorage;
    result._keyPressReporter = keyPressReporter;

    result._answer = tt_Answer.of();

    return result;
  }

  override tt_Answer getAnswer()
  {
    return _answer;
  }

  override void processKey(tt_Character character)
  {
    int type = character.getType();
    switch (type)
    {
    case tt_Character.NONE: break;

    case tt_Character.PRINTABLE:
      _answer.append(character.getCharacter());
      _keyPressReporter.report();
      break;

    case tt_Character.BACKSPACE:      _answer.deleteLastCharacter();         break;
    case tt_Character.CTRL_BACKSPACE: reset();                               break;
    case tt_Character.ESCAPE:         _modeStorage.setMode(tt_Mode.Explore); break;
    }
  }

  override void reset()
  {
    _answer = tt_Answer.of();
  }

  private tt_ModeStorage      _modeStorage;
  private tt_KeyPressReporter _keyPressReporter;

  private tt_Answer _answer;
}

// Represents Answer state.
// See tt_Answer class.
class tt_AnswerState
{
  enum _
  {
    Unknown,
    Preparing,
    Ready,
    Finished
  }

  static bool isReady(int state) { return state >= Ready; }
  static bool isFinished(int state) { return state == Finished; }
}

// This interface provides access to tt_AnswerState.
class tt_AnswerStateSource : tt_KeyProcessor abstract
{
  // Returns value from tt_AnswerState.
  abstract int getAnswerState();

  abstract void reset();
}

// Implements tt_AnswerState by observing Enter and Space keys.
//
// The state is:
// - Preparing when no Enter or Space key is pressed.
// - Ready when Enter or Space key is pressed, but not yet released.
// - Finished when Enter or Space key is released.
//
// Note: space acts the same as Enter key, see tt_Character class for details.
class tt_PressedAnswerState : tt_AnswerStateSource
{
  static tt_PressedAnswerState of()
  {
    let result = new("tt_PressedAnswerState");
    result._answerState = DEFAULT_STATE;
    return result;
  }

  override void processKey(tt_Character character)
  {
    switch (character.getType())
    {
    case tt_Character.ENTER:    _answerState = tt_AnswerState.Ready;     break;
    case tt_Character.ENTER_UP: _answerState = tt_AnswerState.Finished;  break;
    case tt_Character.NONE:     break;
    default:                    _answerState = tt_AnswerState.Preparing; break;
    }
  }

  override int getAnswerState()
  {
    return _answerState;
  }

  override void reset()
  {
    _answerState = DEFAULT_STATE;
  }

  const DEFAULT_STATE = tt_AnswerState.Preparing;

  private int _answerState;
}

// Represents a character.
class tt_Character
{
  static tt_Character of(int type, int code, bool isCtrl)
  {
    let result = new("tt_Character");

    result._eventType = type;
    //Console.printf("type: %d, code: %d", type, code);

    // Normally, KeyUp events aren't registered, but releasing Enter or Space
    // key has special meaning, important for Hold Fire feature.
    if (type == UiEvent.Type_KeyUp &&
        (code == tt_su_Ascii.CARRIAGE_RETURN_CR || code == tt_su_Ascii.SPACE))
    {
      result._type = ENTER_UP;
      return result;
    }

    bool isChar    = (type == UiEvent.Type_Char);
    bool isDown    = (type == UiEvent.Type_KeyDown);
    bool isRepeat  = (type == UiEvent.Type_KeyRepeat);
    bool isControl = (code == tt_su_Ascii.BACKSPACE
                   || code == tt_su_Ascii.CARRIAGE_RETURN_CR
                   || code == tt_su_Ascii.SPACE
                   || code == tt_su_Ascii.ESCAPE);

    if (!isChar && !((isDown || isRepeat) && isControl))
    {
      result._type = NONE;
      return result;
    }

    if      (code == tt_su_Ascii.BACKSPACE)
      result._type = isCtrl ? CTRL_BACKSPACE : BACKSPACE;
    else if (code == tt_su_Ascii.DELETE)             result._type = CTRL_BACKSPACE;
    else if (code == tt_su_Ascii.CARRIAGE_RETURN_CR) result._type = ENTER;
    else if (code == tt_su_Ascii.SPACE)              result._type = ENTER;
    else if (code == tt_su_Ascii.ESCAPE)             result._type = ESCAPE;
    else if (code <  tt_su_Ascii.FIRST_PRINTABLE)    result._type = NONE;
    else
    {
      result._type      = PRINTABLE;
      result._character = string.format("%c", code);
    }

    return result;
  }

  enum _
  {
    NONE,
    PRINTABLE,
    BACKSPACE,
    CTRL_BACKSPACE,
    ENTER,
    ENTER_UP,
    ESCAPE,
  }

  int getType() const { return _type; }

  string getCharacter() const { return _character; }

  int getEventType() const { return _eventType; }

  private int    _type;
  private string _character;
  private int    _eventType;
}

// Provides access to time.
class tt_Clock abstract
{
  // Provides access to getting points in time.
  // Returns a moment in time.
  abstract int getNow();

  // Provides a way to determine how many ticks passed since a moment in time.
  // moment: a moment in time, received from getNow().
  // Returns a number of ticks since  moment.
  abstract int since(int moment);
}

// Implements tt_Clock by getting total time since game start.
class tt_TotalClock : tt_Clock
{
  static tt_TotalClock of()
  {
    let result = new("tt_TotalClock");
    return result;
  }

  override int getNow()
  {
    return Level.totalTime;
  }

  override int since(int moment)
  {
    return getNow() - moment;
  }
}

// Interface for reporting answer matching events.
class tt_AnswerReporter abstract
{
  abstract void reportMatch();

  abstract void reportNotMatch();
}

// Implements tt_AnswerReporter by playing a sound.
class tt_SoundAnswerReporter : tt_AnswerReporter
{
  static tt_SoundAnswerReporter of(tt_SoundPlayer soundPlayer)
  {
    let result = new("tt_SoundAnswerReporter");
    result._soundPlayer = soundPlayer;
    return result;
  }

  override void reportMatch()
  {
    _soundPlayer.playSound("tt/match");
  }

  override void reportNotMatch()
  {
    _soundPlayer.playSound("tt/not-match");
  }

  private tt_SoundPlayer _soundPlayer;
}

// Interface for reporting key press events.
class tt_KeyPressReporter abstract
{
  abstract void report();
}

// Implements tt_KeyPressReporter by playing a sound.
// The sound won't play if it's disabled in settings.
class tt_SoundKeyPressReporter : tt_KeyPressReporter
{
  static tt_SoundKeyPressReporter of(tt_SoundPlayer soundPlayer,
                                     tt_BoolSetting isEnabledSetting)
  {
    let result = new("tt_SoundKeyPressReporter");
    result._soundPlayer      = soundPlayer;
    result._isEnabledSetting = isEnabledSetting;
    return result;
  }

  override void report()
  {
    if (_isEnabledSetting.get()) _soundPlayer.playSound("tt/click");
  }

  private tt_SoundPlayer _soundPlayer;
  private tt_BoolSetting _isEnabledSetting;
}

// Interface for reporting mode change events.
class tt_ModeReporter abstract
{
  abstract void report(int mode);
}

// Implements tt_ModeReporter by playing the corresponding sound for each mode.
class tt_SoundModeReporter : tt_ModeReporter
{
  static tt_SoundModeReporter of(tt_SoundPlayer soundPlayer)
  {
    let result = new("tt_SoundModeReporter");
    result._soundPlayer = soundPlayer;
    return result;
  }

  override void report(int mode)
  {
    switch (mode)
    {
    case tt_Mode.Unknown:
      Console.printf("%s: report: unknown mode!", getClassName());
      break;
    case tt_Mode.Combat:  _soundPlayer.playSound("tt/combat");  break;
    case tt_Mode.Explore: _soundPlayer.playSound("tt/explore"); break;
    case tt_Mode.None:    break;
    }
  }

  private tt_SoundPlayer _soundPlayer;
}

// This is an interface for playing sounds.
class tt_SoundPlayer abstract
{
  abstract void playSound(String soundId);
}

// Implements tt_SoundPlayer by playing sounds for a player.
// The sounds won't play if they are disabled in settings.
class tt_PlayerSoundPlayer : tt_SoundPlayer
{
  static tt_PlayerSoundPlayer of(tt_PlayerSource playerSource,
                                 tt_BoolSetting  enabledSetting,
                                 tt_IntSetting   themeSetting)
  {
    let result = new("tt_PlayerSoundPlayer");
    result._playerSource = playerSource;
    result._enabledSetting = enabledSetting;
    result._themeSetting   = themeSetting;
    return result;
  }

  override void playSound(String soundId)
  {
    if (isDisabled()) return;

    let player = _playerSource.getPawn();
    int theme  = _themeSetting.get();
    soundId.appendFormat("%d", theme);

    player.a_StartSound(soundId, CHAN_AUTO, SOUND_FLAGS);
  }

  private bool isDisabled()
  {
    return (!_enabledSetting.get());
  }

  const SOUND_FLAGS = CHANF_UI | CHANF_OVERLAP | CHANF_LOCAL;

  private tt_PlayerSource _playerSource;
  private tt_BoolSetting  _enabledSetting;
  private tt_IntSetting   _themeSetting;
}

// Global Typist sound settings ////////////////////////////////////////////////

// Do not randomize pitch shift value.
$pitchshiftrange 0

// 1. Default sound theme //////////////////////////////////////////////////////

tt/combat1    "sounds/Default/danger1.ogg"
tt/explore1   "sounds/Default/safe1.ogg"
tt/click1-1   "sounds/Default/typea1.ogg"
tt/click1-2   "sounds/Default/typea2.ogg"
tt/click1-3   "sounds/Default/typea3.ogg"
tt/click1-4   "sounds/Default/typea4.ogg"
tt/click1-5   "sounds/Default/typea5.ogg"
tt/match1     "sounds/Default/success1.ogg"
tt/not-match1 "sounds/Default/fail1.ogg"

$random tt/click1 { tt/click1-1 tt/click1-2 tt/click1-3 tt/click1-4 tt/click1-5 }

$volume tt/combat1  0.4
$volume tt/explore1 0.6
$volume tt/match1   0.4

// 2. SNES sound theme /////////////////////////////////////////////////////////

tt/combat2    "sounds/SNES/danger2.ogg"
tt/explore2   "sounds/SNES/safe2.ogg"
tt/click2-1   "sounds/SNES/typeb1.ogg"
tt/click2-2   "sounds/SNES/typeb2.ogg"
tt/click2-3   "sounds/SNES/typeb3.ogg"
tt/click2-4   "sounds/SNES/typeb4.ogg"
tt/click2-5   "sounds/SNES/typeb5.ogg"
tt/match2     "sounds/SNES/success2.ogg"
tt/not-match2 "sounds/SNES/sneserrors.ogg"

$random tt/click2 { tt/click2-1 tt/click2-2 tt/click2-3 tt/click2-4 tt/click2-5 }

// 4. Dakka sound theme ////////////////////////////////////////////////////////

tt/combat4    "sounds/Dakka/danger4.ogg"
tt/explore4   "sounds/Dakka/safe4.ogg"
tt/click4-1   "sounds/Dakka/typed1.ogg"
tt/click4-2   "sounds/Dakka/typed2.ogg"
tt/click4-3   "sounds/Dakka/typed3.ogg"
tt/click4-4   "sounds/Dakka/typed4.ogg"
tt/click4-5   "sounds/Dakka/typed5.ogg"
tt/match4     "sounds/Dakka/success4.ogg"
tt/not-match4 "sounds/Dakka/fail4.ogg"

$random tt/click4 { tt/click4-1 tt/click4-2 tt/click4-3 tt/click4-4 tt/click4-5 }

// 5. GroceryStore sound theme /////////////////////////////////////////////////

tt/combat5    "sounds/GroceryStore/danger5.ogg"
tt/explore5   "sounds/GroceryStore/safe5.ogg"
tt/click5-1   "sounds/GroceryStore/typee1.ogg"
tt/click5-2   "sounds/GroceryStore/typee2.ogg"
tt/click5-3   "sounds/GroceryStore/typee3.ogg"
tt/click5-4   "sounds/GroceryStore/typee4.ogg"
tt/click5-5   "sounds/GroceryStore/typee5.ogg"
tt/match5     "sounds/GroceryStore/success5.ogg"
tt/not-match5 "sounds/GroceryStore/fail5.ogg"

$random tt/click5 { tt/click5-1 tt/click5-2 tt/click5-3 tt/click5-4 tt/click5-5 }

$volume tt/click5 0.2

// Helps managing user input.
class tt_InputManager abstract
{
  abstract void manageInput();

  abstract bool isCapturingKeys();
}

// Implements tt_InputManager by examining the current and old Typist mode.
// Input is reset when the game mode is changed.
class tt_InputByModeManager : tt_InputManager
{
  static tt_InputByModeManager of(tt_ModeSource modeSource,
                                  tt_PlayerInput playerInput)
  {
    let result = new("tt_InputByModeManager");

    result._modeSource  = modeSource;
    result._playerInput = playerInput;

    result._oldMode = tt_Mode.Unknown;

    return result;
  }

  override void manageInput()
  {
    int  mode             = _modeSource.getMode();
    bool isCapturingKeys  = (mode == tt_Mode.Combat);
    bool wasCapturingKeys = (_oldMode != tt_Mode.Combat);

    if (wasCapturingKeys && isCapturingKeys == false)
    {
      _playerInput.reset();
    }

    _oldMode = mode;
  }

  override bool isCapturingKeys()
  {
    int mode = _modeSource.getMode();
    return (mode == tt_Mode.Combat);
  }

  private tt_ModeSource  _modeSource;
  private tt_PlayerInput _playerInput;

  private int _oldMode;
}

// Doesn't capture keys when pass throug is set, otherwise acts as base.
class tt_PassThroughInputManager : tt_InputManager
{
  static tt_PassThroughInputManager of(tt_InputManager base)
  {
    let result = new("tt_PassThroughInputManager");
    result._base = base;
    result._passThrough = PassThroughDisabled;
    return result;
  }

  override void manageInput()
  {
    _base.manageInput();
  }

  override bool isCapturingKeys()
  {
    if (_passThrough != PassThroughDisabled) return false;

    return _base.isCapturingKeys();
  }

  void setPassThrough()
  {
    _passThrough = WaitingForKeyDown;
  }

  void processInput(int type)
  {
    switch (_passThrough)
    {
      case PassThroughDisabled:
        return;

      case WaitingForKeyDown:
        if (type == InputEvent.Type_KeyDown)
          _passThrough = WaitingForKeyUp;
        return;

      case WaitingForKeyUp:
        if (type == InputEvent.Type_KeyUp)
          _passThrough = PassThroughDisabled;
        return;
    }
  }

  private tt_InputManager _base;
  private int _passThrough;

  enum _
  {
    PassThroughDisabled,
    WaitingForKeyDown,
    WaitingForKeyUp
  }
}

// This interface represents an entity that processes input keys.
class tt_KeyProcessor abstract
{
  abstract void processKey(tt_Character character);
}

// Implements tt_KeyProcessor interface by calling several instances
// of tt_KeyProcessor.
class tt_KeyProcessors : tt_KeyProcessor
{
  static tt_KeyProcessors of(Array<tt_KeyProcessor> keyProcessors)
  {
    let result = new("tt_KeyProcessors");
    result._keyProcessors.copy(keyProcessors);
    return result;
  }

  override void processKey(tt_Character character)
  {
    foreach (keyProcessor : _keyProcessors)
      keyProcessor.processKey(character);
  }

  private Array<tt_KeyProcessor> _keyProcessors;
}

// Represents a target that already has been seen and registered.
class tt_KnownTarget
{
  static tt_KnownTarget of(tt_Target target, tt_Question question)
  {
    let result = new("tt_KnownTarget");

    result._target   = target;
    result._question = question;

    return result;
  }

  tt_Target getTarget() const { return _target; }

  tt_Question getQuestion() const { return _question; }

  private tt_Target   _target;
  private tt_Question _question;
}

// Represents a list of known targets.
class tt_KnownTargets
{
  static tt_KnownTargets of()
  {
    return new("tt_KnownTargets");
  }

  // Returns a target in this list.
  tt_KnownTarget at(uint index) const
  {
    return _targets[index];
  }

  // Returns a number of targets in this list.
  uint size() const
  {
    return _targets.size();
  }

  // Returns true if this target list contains a target with the specified id.
  bool contains(tt_Target target) const
  {
    return (find(target) != size());
  }

  tt_KnownTarget findTarget(tt_Target target) const
  {
    uint index = find(target);
    return (index == size()) ? NULL : at(index);
  }

  // Adds a target to this list.
  void add(tt_KnownTarget target)
  {
    _targets.push(target);
  }

  void addMany(tt_KnownTargets targets)
  {
    uint nTargets = targets.size();
    for (uint i = 0; i < nTargets; ++i)
    {
      _targets.push(targets.at(i));
    }
  }

  // Removes a target from the list.
  // If the target is not in the list, does nothing.
  void remove(tt_Target target)
  {
    uint index = find(target);
    if (index != size()) { _targets.Delete(index); }
  }

  void clear() { _targets.clear(); }

  // Searches for a target with a particular id.
  // Returns index on success, the total number of targets on failure.
  private uint find(tt_Target target) const
  {
    uint nTargets = size();
    for (uint i = 0; i < nTargets; ++i)
    {
      if (_targets[i].getTarget().isEqual(target)) { return i; }
    }
    return nTargets;
  }

  private Array<tt_KnownTarget> _targets;
}

// This interface represents a source of known targets.
// See tt_KnownTarget.
class tt_KnownTargetSource abstract
{
  // Returns the currently registered (known) targets.
  abstract tt_KnownTargets getTargets() const;

  // Returns true if there are no targets in this source.
  abstract bool isEmpty() const;
}

// Implements tt_KnownTargetSource by reading other
// tt_KnownTargetSource only if the data is stale.
class tt_KnownTargetSourceCache : tt_KnownTargetSource
{
  static tt_KnownTargetSourceCache of(tt_KnownTargetSource targetSource,
                                      tt_StaleMarker staleMarker)
  {
    let result = new("tt_KnownTargetSourceCache");

    result._targetSource = targetSource;
    result._staleMarker  = staleMarker;

    return result;
  }

  override tt_KnownTargets getTargets()
  {
    ensureUpdated();
    return _targets;
  }

  override bool isEmpty()
  {
    ensureUpdated();
    return (_targets.size() == 0);
  }

  private void ensureUpdated()
  {
    if (_staleMarker.isStale())
    {
      _targets = _targetSource.getTargets();
    }
  }

  private tt_KnownTargetSource _targetSource;
  private tt_StaleMarker       _staleMarker;

  private tt_KnownTargets _targets;
}

// Implements tt_KnownTargetSource by reading from targets from
// tt_TargetSource, assigning them questions, and storing them.
//
// Deactivated targets are removed from storage.
class tt_TargetRegistry : tt_KnownTargetSource
{
  static tt_TargetRegistry of(tt_TargetSource targetSource,
                              tt_Lesson lesson,
                              tt_TargetSource disabledTargetSource)
  {
    let result = new("tt_TargetRegistry");

    result._targetSource = targetSource;
    result._lesson       = lesson;
    result._disabledTargetSource = disabledTargetSource;

    result._registry = tt_KnownTargets.of();
    result._newKnownTargets = tt_KnownTargets.of();
    result._pruned = tt_KnownTargets.of();

    return result;
  }

  override tt_KnownTargets getTargets()
  {
    update();
    return _registry;
  }

  override bool isEmpty()
  {
    update();
    return (_registry.size() == 0);
  }

  private void update()
  {
    let newTargets = _targetSource.getTargets();
    merge(newTargets);

    let disabledTargets = _disabledTargetSource.getTargets();
    subtract(disabledTargets);

    pruneNulls();
  }

  // Adds targets that are not already registered to the registry.
  //
  // Given that tt_KnownTargets.contains() is O(n), this function is O(n^2).
  // Optimization possible.
  private void merge(tt_Targets targets)
  {
    uint nTargets = targets.size();

    for (uint i = 0; i < nTargets; ++i)
    {
      let target   = targets.at(i);
      let existing = _registry.findTarget(target);

      if (existing == NULL)
      {
        let knownTarget = makeKnownTarget(target);

        if (knownTarget != NULL)
          _newKnownTargets.add(knownTarget);
      }
    }

    _registry.addMany(_newKnownTargets);
    _newKnownTargets.clear();
  }

  // Given that tt_KnownTargets.remove() is at least O(n), this function is
  // at least O(n^2).
  // Optimization possible.
  private void subtract(tt_Targets targets)
  {
    uint nTargets = targets.size();
    for (uint i = 0; i < nTargets; ++i)
    {
      _registry.remove(targets.at(i));
    }
  }

  private tt_KnownTarget makeKnownTarget(tt_Target target) const
  {
    let question = _lesson.getQuestion();

    if (question == NULL)
    {
      return NULL;
    }

    let newKnownTarget = tt_KnownTarget.of(target, question);

    return newKnownTarget;
  }

  private void pruneNulls()
  {
    uint nTargets = _registry.size();
    for (uint i = 0; i < nTargets; ++i)
    {
      let target      = _registry.at(i).getTarget();
      let targetActor = target.getActor();

      if (targetActor != NULL)
        _pruned.add(_registry.at(i));
    }

    tt_KnownTargets temp = _registry;
    _registry = _pruned;
    _pruned   = temp;
    _pruned.clear();
  }

  private tt_TargetSource   _targetSource;
  private tt_Lesson _lesson;
  private tt_TargetSource   _disabledTargetSource;

  private tt_KnownTargets _registry;
  private tt_KnownTargets _newKnownTargets;
  private tt_KnownTargets _pruned;
}

// Implements tt_KnownTargetSource by providing only targets visible to player.
class tt_VisibleKnownTargetSource : tt_KnownTargetSource
{
  static tt_VisibleKnownTargetSource of(tt_KnownTargetSource base,
                                        tt_PlayerSource playerSource)
  {
    let result = new("tt_VisibleKnownTargetSource");
    result._base = base;
    result._playerSource = playerSource;
    result._targets = tt_KnownTargets.of();
    return result;
  }

  override tt_KnownTargets getTargets() const
  {
    _targets.clear();

    if (_base.isEmpty()) return _targets;

    let  pawn        = _playerSource.getPawn();
    let  baseTargets = _base.getTargets();
    uint targetCount = baseTargets.size();

    for (uint i = 0; i < targetCount; ++i)
    {
      let target = baseTargets.at(i);
      if (isVisible(target, pawn)) _targets.add(target);
    }

    return _targets;
  }

  override bool isEmpty() const
  {
    if (_base.isEmpty()) return true;

    let  pawn        = _playerSource.getPawn();
    let  baseTargets = _base.getTargets();
    uint targetCount = baseTargets.size();
    for (uint i = 0; i < targetCount; ++i)
      if (isVisible(baseTargets.at(i), pawn)) return false;

    return true;
  }

  // Play-const hack: Actor.isVisible(...) is not const, but should be.
  private play bool isVisible(tt_KnownTarget target, Actor pawn) const
  {
    return pawn.isVisible(target.getTarget().getActor(), ALL_AROUND);
  }

  const ALL_AROUND = 1; // true

  private tt_KnownTargetSource _base;
  private tt_PlayerSource _playerSource;
  private tt_KnownTargets _targets;
}

// Interface for getting Questions.
class tt_Lesson abstract
{
  abstract tt_Question getQuestion();
}

// Implements tt_Lesson by composing arithmetic tasks.
class tt_MathsLesson : tt_Lesson
{
  static tt_MathsLesson of()
  {
    let result = new("tt_MathsLesson");
    return result;
  }

  override tt_Question getQuestion()
  {
    int operation = random[typist](Addition, Division);

    switch (operation)
    {
    case Addition:       return makeAdditionQuestion();
    case Subtraction:    return makeSubtractionQuestion();
    case Multiplication: return makeMultiplicationQuestion();
    case Division:       return makeDivisionQuestion();
    }

    Console.printf("%s: getQuestion: unknown operation!", getClassName());
    return NULL;
  }

  private tt_Question makeAdditionQuestion()
  {
    int leftAddend  = random[typist](11, 49);
    int rightAddend = random[typist](11, 50);
    int sum         = leftAddend + rightAddend;

    string description = string.format("%d + %d", leftAddend,  rightAddend);
    string answer      = string.format("%d", sum);

    let question = tt_Match.of(answer, description);
    return question;
  }

  private tt_Question makeSubtractionQuestion()
  {
    int minuend    = random[typist](50, 99);
    int subtrahend = random[typist](11, 50);
    int difference = minuend - subtrahend;

    string description = string.format("%d - %d", minuend, subtrahend);
    string answer      = string.format("%d", difference);

    let question = tt_Match.of(answer, description);
    return question;
  }

  private tt_Question makeMultiplicationQuestion()
  {
    int multiplicand = random[typist](2, 9);
    int multiplier   = random[typist](2, 9);
    int product      = multiplicand * multiplier;

    string description = string.format("%d * %d", multiplicand, multiplier);
    string answer      = string.format("%d", product);

    let question = tt_Match.of(answer, description);
    return question;
  }

  private tt_Question makeDivisionQuestion()
  {
    int quotient = random[typist](2, 9);
    int divisor  = random[typist](2, 9);
    int dividend = quotient * divisor;

    string description = string.format("%d / %d", dividend, divisor);
    string answer      = string.format("%d", quotient);

    let question = tt_Match.of(answer, description);
    return question;
  }

  enum Operations
  {
    Addition,
    Subtraction,
    Multiplication,
    Division,
  }
}

{
  let question = tt_MathsLesson.of().getQuestion();

  it("tt_MathsLesson: question isn't equal to the answer",
    AssertFalse(question.isRight(question.getDescription())));
}

class tt_SwitchableLesson
{
  static tt_SwitchableLesson of(tt_BoolSetting setting, tt_Lesson lesson)
  {
    let result = new("tt_SwitchableLesson");
    result._setting = setting;
    result._lesson  = lesson;
    return result;
  }

  bool isEnabled() { return _setting.get(); }
  tt_Lesson lesson() { return _lesson; }

  private tt_BoolSetting _setting;
  private tt_Lesson      _lesson;
}

class tt_MixedLesson : tt_Lesson
{
  static tt_MixedLesson of(Array<tt_SwitchableLesson> lessons)
  {
    let result = new("tt_MixedLesson");
    result._lessons.move(lessons);
    return result;
  }

  override tt_Question getQuestion()
  {
    _enabledLessons.clear();

    foreach (lesson : _lessons)
      if (lesson.isEnabled()) _enabledLessons.push(lesson.lesson());

    uint nEnabledLessons = _enabledLessons.size();
    if (nEnabledLessons == 0)
    {
      Console.printf("All lessons disabled");
      return tt_FallbackQuestion.of();
    }

    uint randomLessonIndex = random[typist](0, nEnabledLessons - 1);

    return _enabledLessons[randomLessonIndex].getQuestion();
  }

  private Array<tt_SwitchableLesson> _lessons;
  private Array<tt_Lesson> _enabledLessons;
}

// Implements tt_Lesson by composing a question from groups
// of characters enabled by settings.
class tt_RandomCharactersLesson : tt_Lesson
{
  static tt_RandomCharactersLesson of(tt_RandomCharactersLessonSettings settings)
  {
    let result = new("tt_RandomCharactersLesson");
    result._settings = settings;
    return result;
  }

  override tt_Question getQuestion()
  {
    string characters = composeCharacterRange();
    int    length     = _settings.getLessonLength();
    string picked     = pick(characters, length);

    if (picked.length() == 0)
    {
      Console.printf("Random characters lesson: no characters enabled");
      return tt_FallbackQuestion.of();
    }

    return tt_Match.of(picked, picked);
  }

  // This function is guaranteed to return non-empty strings.
  private string composeCharacterRange()
  {
    string characters;

    if (_settings.isUppercaseLettersEnabled()) characters.appendFormat("%s", UPPERCASE_LETTERS);
    if (_settings.isLowercaseLettersEnabled()) characters.appendFormat("%s", LOWERCASE_LETTERS);
    if (_settings.isNumbersEnabled()) characters.appendFormat("%s", NUMBERS);
    if (_settings.isPunctuationEnabled()) characters.appendFormat("%s", PUNCTUATION);
    if (_settings.isSymbolsEnabled())
    {
      // GZDoom cannot handle "\\" in a string, so add it manually.
      characters.AppendFormat("%s%c", SYMBOLS, tt_su_Ascii.REVERSE_SOLIDUS);
    }
    if (_settings.isCustomCharactersEnabled())
    {
      characters.AppendFormat("%s", _settings.getCustomCharacters());
    }

    return characters;
  }

  // This function is guaranteed to return non-empty strings.
  private static string pick(string characters, int number)
  {
    if (characters.length() == 0) return "";

    string result;
    int    lastCharacter = characters.CodePointCount() - 1;

    for (int i = 0; i < number; ++i)
    {
      int randomIndex = random[typist](0, lastCharacter);
      int character   = getCodePointAt(characters, randomIndex);

      result.appendFormat("%c", character);
    }

    return result;
  }

  // Attention! O(n)
  private static int getCodePointAt(String str, int index)
  {
    int letterCode;
    int charPos = 0;
    for (int i = 0; i <= index; ++i)
    {
      [letterCode, charPos] = str.GetNextCodePoint(charPos);
    }

    return letterCode;
  }

  const LOWERCASE_LETTERS = "abcdefghijklmnopqrstuvwxyz";
  const UPPERCASE_LETTERS = "ABCDEFGHIJKLMNOPQRSTUVWXYZ";
  const NUMBERS           = "0123456789";
  const PUNCTUATION       = ",.();:-'\"?!/";
  const SYMBOLS           = "~`@#$%^&*+=[]{}<>|";

  private tt_RandomCharactersLessonSettings _settings;
}

// Implements tt_Lesson by producing questions that contain
// string composed from random numbers and should match exactly to the answers.
class tt_RandomNumberSource : tt_Lesson
{
  static tt_RandomNumberSource of()
  {
    let result = new("tt_RandomNumberSource");
    return result;
  }

  override tt_Question getQuestion()
  {
    let stringLength = 3;
    let str          = "";

    for (int i = 0; i < stringLength; ++i)
    {
      int number = random[typist](tt_su_Ascii.DIGIT_ZERO, tt_su_Ascii.DIGIT_NINE);
      str.AppendFormat("%c", number);
    }

    let question = tt_Match.of(str, str);

    return question;
  }
}

// Implements tt_Lesson by reading a lump with words and
// randomly selecting words from this lump.
class tt_StringSet : tt_Lesson
{
  static tt_StringSet of(String lumpName)
  {
    int    lump     = Wads.findLump(lumpName, 0, Wads.AnyNamespace);
    string contents = Wads.readLump(lump);
    Array<string> words;
    tt_su_su.splitByWords(contents, words);

    Array<string> filteredWords;
    filterWords(words, filteredWords);

    let result = new("tt_StringSet");

    result._lumpName = lumpName;
    result._words.move(filteredWords);

    return result;
  }

  override tt_Question getQuestion()
  {
    int nWords = int(_words.size());
    if (nWords == 0)
    {
      Console.printf("%s: getQuestion: no words in lump %s.",
                     getClassName(),
                     _lumpName);
      return tt_FallbackQuestion.of();
    }

    int    wordIndex = random[typist](0, nWords - 1);
    string word      = _words[wordIndex];
    let    question  = tt_Match.of(word, word);

    return question;
  }

  // Removes too short words, removes duplicates.
  private static void filterWords(Array<String> input, out Array<String> result)
  {
    // Use map to remove duplicates.
    Map<string, int> wordSet;

    foreach (word : input)
    {
      if (word.codePointCount() > 1)
        wordSet.insert(word, 0);
    }

    foreach (word, value : wordSet)
      result.push(word);
  }

  private string        _lumpName;
  private Array<string> _words;
}

{
  let    stringSet   = tt_StringSet.of("tt_test_words");
  let    question    = stringSet.getQuestion();
  string description = question.getDescription();

  it("tt_StringSet: Question must be valid", AssertNotNull(question));
  it("tt_StringSet: Description", Assert(description == "привет"));
}

привет

// Represents the mode in which Typist operates.
class tt_Mode
{
  enum _
  {
    Unknown, // Should never be used. Only for detecting uninitialized variables.
    Combat,  // Typist is focused on destroying the targets.
    Explore, // Typist is focused on movement and exploration.
    None,    // None of the above.
  }
}

// This interface represents a source of modes.
// See: tt_Mode.
class tt_ModeSource abstract
{
  abstract int getMode();
}

// Implements tt_ModeSource by examining the specified tt_KnownTargetSource.
class tt_AutoModeSource : tt_ModeSource
{
  static tt_AutoModeSource of(tt_KnownTargetSource knownTargetSource)
  {
    let result = new("tt_AutoModeSource");
    result._knownTargetSource = knownTargetSource;
    return result;
  }

  override int getMode()
  {
    return _knownTargetSource.isEmpty() ? tt_Mode.Explore : tt_Mode.Combat;
  }

  private tt_KnownTargetSource _knownTargetSource;
}

// Implements tt_ModeSource by reading other tt_ModeSource, and switching to
// Exploration mode only if some time has passed or there is no enemies around.
class tt_DelayedCombatModeSource : tt_ModeSource
{
  static tt_DelayedCombatModeSource of(tt_Clock        clock,
                                       tt_ModeSource   modeSource,
                                       tt_TargetSource targetSource)
  {
    let result = new("tt_DelayedCombatModeSource");

    result._clock        = clock;
    result._modeSource   = modeSource;
    result._targetSource = targetSource;

    result._switchDetected = false;
    result._oldMode        = tt_Mode.None;
    result._switchToExploreMoment = 0;

    return result;
  }

  override int getMode()
  {
    int topMode = _modeSource.getMode();

    if (topMode != tt_Mode.Explore)
    {
      // let others decide.
      _oldMode = topMode;
      return tt_Mode.None;
    }

    bool wasCombat        = _oldMode == tt_Mode.Combat;
    bool isExplore        =  topMode == tt_Mode.Explore;
    bool areEnemiesAround = !_targetSource.getTargets().isEmpty();

    if (wasCombat && isExplore && areEnemiesAround)
    {
      _switchDetected        = true;
      _switchToExploreMoment = _clock.getNow();
    }

    _oldMode = topMode;

    if (!_switchDetected)
    {
      return tt_Mode.None;
    }

    bool timeIsUp = _clock.since(_switchToExploreMoment) > DELAY;

    if (timeIsUp)
    {
      _switchDetected = false;
    }

    return timeIsUp ? tt_Mode.None : tt_Mode.Combat;
  }

  const DELAY = TICRATE * 1; // 1 second

  private tt_Clock        _clock;
  private tt_ModeSource   _modeSource;
  private tt_TargetSource _targetSource;

  private int _switchDetected;
  private int _oldMode;
  private int _switchToExploreMoment;
}

// C - Combat Mode
// E - Exploration Mode
// N - None Mode (let other decide)
//
// |-----|-----|---------|-------------|--------|-------------------------|
// | old | new | enemies | time is up? | result | test                    |
// |-----|-----|---------|-------------|--------|-------------------------|
// |  *  |  C  |    *    |      *      | None   | checkNewCombat          |
// |  C  |  E  |   no    |      *      | None   | checkNoEnemies          |
// |  C  |  E  |   yes   |     no      | Combat | checkEnemiesStillCombat |
// |  C  |  E  |   yes   |     yes     | None   | checkEnemiesTimeIsUp    |
// |  E  |  *  |    *    |      *      | None   | checkOldExploration     |
// |-----|-----|---------|-------------|--------|-------------------------|
{
  let tag = "tt_DelayedCombatModeSource: checkNewCombat";
  let env = tt_DelayedCombatModeSourceTestEnvironment.of();

  env.modeSource.expect_getMode(tt_Mode.Combat, 2);
  env.clock.expect_getNow(0, 0);
  env.clock.expect_since(0, 0);

  int result1 = env.delay.getMode();
  it(tag .. ": new combat -> None", AssertEval(result1, "==", tt_Mode.None));

  int result2 = env.delay.getMode();
  it(tag .. ": again, combat -> None", AssertEval(result2, "==", tt_Mode.None));

  assertSatisfaction(env.getSatisfaction(), tag);
}
{
  let tag = "tt_DelayedCombatModeSource: checkNoEnemies";
  let env = tt_DelayedCombatModeSourceTestEnvironment.of();

  // set up history: it was combat.
  env.modeSource.expect_getMode(tt_Mode.Combat);
  env.delay.getMode();

  env.modeSource.expect_getMode(tt_Mode.Explore);
  env.targetSource.expect_getTargets(tt_Targets.of());

  int result = env.delay.getMode();
  it(tag .. ": no enemies", AssertEval(result, "==", tt_Mode.None));

  assertSatisfaction(env.getSatisfaction(), tag);
}
{
  let tag = "tt_DelayedCombatModeSource: checkEnemiesStillCombat";
  let env = tt_DelayedCombatModeSourceTestEnvironment.of();

  // set up history: it was combat.
  env.modeSource.expect_getMode(tt_Mode.Combat);
  env.delay.getMode();

  { // set expectations
    env.modeSource.expect_getMode(tt_Mode.Explore);

    let targets = tt_Targets.of();
    targets.add(NULL);
    env.targetSource.expect_getTargets(targets);

    env.clock.expect_getNow(0);
    env.clock.expect_since(0);
  }

  int result = env.delay.getMode();
  it(tag .. ": still combat", AssertEval(result, "==", tt_Mode.Combat));
  assertSatisfaction(env.getSatisfaction(), tag);
}
{
  let tag = "tt_DelayedCombatModeSource: checkEnemiesTimeIsUp";
  let env = tt_DelayedCombatModeSourceTestEnvironment.of();

  // set up history: it was combat.
  env.modeSource.expect_getMode(tt_Mode.Combat);
  env.delay.getMode();

  { // set expectations
    env.modeSource.expect_getMode(tt_Mode.Explore);

    let targets = tt_Targets.of();
    targets.add(NULL);
    env.targetSource.expect_getTargets(targets);

    env.clock.expect_getNow(0);
    env.clock.expect_since(999);
  }

  int result = env.delay.getMode();
  it(tag .. ": no more combat", AssertEval(result, "==", tt_Mode.None));
  assertSatisfaction(env.getSatisfaction(), tag);
}
{
  let tag = "tt_DelayedCombatModeSource: checkOldExploration";
  let env = tt_DelayedCombatModeSourceTestEnvironment.of();

  env.modeSource.expect_getMode(tt_Mode.Explore, 2);
  env.clock.expect_getNow(0, 0);
  env.clock.expect_since(0, 0);
  env.targetSource.expect_getTargets(tt_Targets.of(), 2);

  int result1 = env.delay.getMode();
  it(tag .. ": old Exploration -> None", AssertEval(result1, "==", tt_Mode.None));

  int result2 = env.delay.getMode();
  it(tag .. ": again, old Exploration -> None",
    AssertEval(result2, "==", tt_Mode.None));

  assertSatisfaction(env.getSatisfaction(), tag);
}

class tt_DelayedCombatModeSourceTestEnvironment
{
  static tt_DelayedCombatModeSourceTestEnvironment of()
  {
    let result = new("tt_DelayedCombatModeSourceTestEnvironment");
    result.clock        = tt_ClockMock.of();
    result.modeSource   = tt_ModeSourceMock.of();
    result.targetSource = tt_TargetSourceMock.of();

    result.delay        = tt_DelayedCombatModeSource.of(result.clock,
                                                        result.modeSource,
                                                        result.targetSource);
    return result;
  }

  tt_Satisfaction getSatisfaction() const
  {
    return clock.getSatisfaction()
      .add(modeSource.getSatisfaction())
      .add(targetSource.getSatisfaction());
  }

  tt_ClockMock        clock;
  tt_ModeSourceMock   modeSource;
  tt_TargetSourceMock targetSource;

  tt_DelayedCombatModeSource delay;
}

// Implements ModeSource by taking the first mode from ModeSources
// list that is not NONE.
class tt_ModeCascade : tt_ModeSource
{
  static tt_ModeCascade of(Array<tt_ModeSource> modeSources)
  {
    let result = new("tt_ModeCascade");
    result._modeSources.move(modeSources);
    return result;
  }

  override int getMode()
  {
    foreach (source : _modeSources)
    {
      int mode = source.getMode();
      if (mode != tt_Mode.None) return mode;
    }

    return tt_Mode.None;
  }

  private Array<tt_ModeSource> _modeSources;
}

{
  Array<tt_ModeSource> sources;
  let cascade = tt_ModeCascade.of(sources);

  int mode = cascade.getMode();

  it("tt_ModeCascade: check zero sources: No source -> no mode",
     AssertEval(mode, "==", tt_Mode.None));
}
{
  let source1 = tt_ModeSourceMock.of();
  let source2 = tt_ModeSourceMock.of();

  source1.expect_getMode(tt_Mode.Explore);
  source2.expect_getMode(tt_Mode.Combat);

  Array<tt_ModeSource> sources = {source1, source2};
  int mode = tt_ModeCascade.of(sources).getMode();

  it("tt_ModeCascade: check cascade first: Must be the first mode",
     AssertEval(mode, "==", tt_Mode.Explore));
}
{
  let source1 = tt_ModeSourceMock.of();
  let source2 = tt_ModeSourceMock.of();

  source1.expect_getMode(tt_Mode.None);
  source2.expect_getMode(tt_Mode.Combat);

  Array<tt_ModeSource> sources = {source1, source2};
  int mode = tt_ModeCascade.of(sources).getMode();

  it("tt_ModeCascade: check cascade second: Must be the second mode",
     AssertEval(mode, "==", tt_Mode.Combat));
}

// This is an interface for storing and retrieving mode.
class tt_ModeStorage : tt_ModeSource abstract
{
  abstract void setMode(int mode);
}

// Implements tt_ModeSource by reading other mode source, and
// reporting an event when the mode has changed.
class tt_ReportedModeSource : tt_ModeSource
{
  static tt_ReportedModeSource of(tt_ModeReporter reporter, tt_ModeSource modeSource)
  {
    let result = new("tt_ReportedModeSource");

    result._reporter   = reporter;
    result._modeSource = modeSource;

    result._oldMode = tt_Mode.None;

    return result;
  }

  override int getMode()
  {
    int newMode = _modeSource.getMode();

    if (newMode != _oldMode)
    {
      if (_oldMode != tt_Mode.None)
      {
        _reporter.report(newMode);
      }

      _oldMode = newMode;
    }

    return newMode;
  }

  private tt_ModeReporter _reporter;
  private tt_ModeSource   _modeSource;

  private int _oldMode;
}

{
  let tag = "tt_ReportedModeSource: checkInitial";
  let env = tt_ReportedModeSourceTestEnvironment.of();

  int expected = tt_Mode.Explore;
  env.modeSource.expect_getMode(expected);

  int mode = env.reportedMode.getMode();

  it(tag .. ": explore after init", AssertEval(mode, "==", expected));

  assertSatisfaction(env.getSatisfaction(), tag);
}
{
  let tag = "tt_ReportedModeSource: checkExplorationToCombat";
  let env = tt_ReportedModeSourceTestEnvironment.of();

  env.reporter.expect_report();

  env.modeSource.expect_getMode(tt_Mode.Explore);
  int mode1 = env.reportedMode.getMode();

  env.modeSource.expect_getMode(tt_Mode.Combat);
  int mode2 = env.reportedMode.getMode();

  assertSatisfaction(env.getSatisfaction(), tag);
}
{
  let tag = "tt_ReportedModeSource: checkCombatToExploration";
  let env = tt_ReportedModeSourceTestEnvironment.of();

  env.reporter.expect_report();

  env.modeSource.expect_getMode(tt_Mode.Combat);
  int mode1 = env.reportedMode.getMode();

  env.modeSource.expect_getMode(tt_Mode.Explore);
  int mode2 = env.reportedMode.getMode();

  assertSatisfaction(env.getSatisfaction(), tag);
}

class tt_ReportedModeSourceTestEnvironment
{
  static tt_ReportedModeSourceTestEnvironment of()
  {
    let result = new("tt_ReportedModeSourceTestEnvironment");
    result.reporter     = tt_ModeReporterMock.of();
    result.modeSource   = tt_ModeSourceMock.of();
    result.reportedMode = tt_ReportedModeSource.of(result.reporter,
                                                   result.modeSource);
    return result;
  }

  tt_Satisfaction getSatisfaction() const
  {
    return reporter.getSatisfaction().add(modeSource.getSatisfaction());
  }

  tt_ModeReporterMock   reporter;
  tt_ModeSourceMock     modeSource;
  tt_ReportedModeSource reportedMode;
}

// Implements ModeStorage by simply storing the mode that was set.
class tt_SettableMode : tt_ModeStorage
{
  static tt_SettableMode of()
  {
    let result = new("tt_SettableMode");

    result._mode = tt_Mode.None;

    return result;
  }

  override int getMode()
  {
    return _mode;
  }

  override void setMode(int mode)
  {
    _mode = mode;
  }

  private int _mode;
}

{
  let settableMode = tt_SettableMode.of();
  int before       = tt_Mode.Combat;

  settableMode.setMode(before);
  int after = settableMode.getMode();

  it("tt_SettableMode: mode must be the same", AssertEval(before, "==", after));
}

// Implements tt_ModeSource by choosing Explore mode on the automap.
class tt_AutomapModeSource : tt_ModeSource
{
  static tt_AutomapModeSource of()
  {
    return new("tt_AutomapModeSource");
  }

  override int getMode()
  {
    return automapActive ? tt_Mode.Explore : tt_Mode.None;
  }
}

// Represents a point in space.
// Note that the Origin position cannot change once set.
class tt_Origin
{
  static tt_Origin of(vector3 pos)
  {
    let result = new("tt_Origin");
    result._pos = pos;
    return result;
  }

  vector3 getVector() const { return _pos; }
  void setVector(vector3 value) { _pos = value; }

  private vector3 _pos;
}

// This interface represents a source of origins.
class tt_OriginSource abstract
{
  // Returns the origin (coordinate in 3D space).
  // Getting the origin doesn't change it.
  abstract tt_Origin getOrigin();
}

// Implements OriginSource by finding an origin for a known target
// that fits to for the answer.
class tt_HastyQuestionAnswerMatcher : tt_OriginSource
{
  static tt_HastyQuestionAnswerMatcher of(tt_KnownTargetSource knownTargetSource,
                                          tt_AnswerSource      answerSource,
                                          tt_AnswerReporter    reporter)
  {
    let result = new("tt_HastyQuestionAnswerMatcher");
    result._knownTargetSource = knownTargetSource;
    result._answerSource      = answerSource;
    result._reporter          = reporter;
    return result;
  }

  override tt_Origin getOrigin()
  {
    let targets = _knownTargetSource.getTargets();
    if (targets == NULL || targets.size() == 0) { return NULL; }

    let answer = _answerSource.getAnswer();
    if (answer == NULL) { return NULL; }

    let result = findMatchedTarget(targets, answer);

    if (result != NULL)
    {
      _reporter.reportMatch();
      _answerSource.reset();
    }

    return result;
  }

  private tt_Origin findMatchedTarget(tt_KnownTargets targets, tt_Answer answer)
  {
    string answerString = answer.getString();
    uint nTargets = targets.size();
    for (uint i = 0; i < nTargets; ++i)
    {
      let target   = targets.at(i);
      let question = target.getQuestion();

      if (!question.isRight(answerString)) continue;

      let result = target.getTarget().getPosition();
      return result;
    }

    return NULL;
  }

  private tt_KnownTargetSource _knownTargetSource;
  private tt_AnswerSource      _answerSource;
  private tt_AnswerReporter    _reporter;
}

// Implements OriginSource by reading other OriginSource only if origin is stale.
class tt_OriginSourceCache : tt_OriginSource
{
  static tt_OriginSourceCache of(tt_OriginSource originSource,
                                 tt_StaleMarker staleMarker)
  {
    let result = new("tt_OriginSourceCache");

    result._originSource = originSource;
    result._staleMarker  = staleMarker;

    result._origin = NULL;

    return result;
  }

  override tt_Origin getOrigin()
  {
    if (_staleMarker.isStale())
    {
      _origin = _originSource.getOrigin();
    }

    return _origin;
  }

  private tt_OriginSource _originSource;
  private tt_StaleMarker  _staleMarker;

  private tt_Origin _origin;
}

// Implements tt_OriginSource by providing the center of the player pawn.
class tt_PlayerOriginSource : tt_OriginSource
{
  static tt_PlayerOriginSource of(tt_PlayerSource playerSource)
  {
    let result = new("tt_PlayerOriginSource");
    result._playerSource = playerSource;
    result._origin = tt_Origin.of((0, 0, 0));
    return result;
  }

  override tt_Origin getOrigin()
  {
    let pawn = _playerSource.getPawn();
    let pos  = pawn.pos;
    pos.z += pawn.height / 2;

    _origin.setVector(pos);
    return _origin;
  }

  private tt_PlayerSource _playerSource;
  private tt_Origin       _origin;
}

{
  let tag = "tt_PlayerOriginSource";

  double x = 1;
  double y = 2;
  double z = 3;
  let player = PlayerPawn(spawn("DoomPlayer", (x, y, z)));

  let playerSource = tt_PlayerSourceMock.of();
  let originSource = tt_PlayerOriginSource.of(playerSource);

  playerSource.expect_getPawn(player);

  let origin  = originSource.getOrigin().getVector();

  it(tag .. ": X matches",  AssertEval(x, "==", origin.x));
  it(tag .. ": Y matches",  AssertEval(y, "==", origin.y));
  it(tag .. ": Z in range", AssertEval(z, "<=", origin.z));
  it(tag .. ": Z in range", AssertEval(z + player.Height, ">=", origin.z));
  assertSatisfaction(playerSource.getSatisfaction(), tag);

  cleanUpSpawned();
}

// Implements OriginSource by finding an origin for a known target that fits to
// for the answer. Searches far matching target only if answer state is Ready.
class tt_QuestionAnswerMatcher : tt_OriginSource
{
  static tt_QuestionAnswerMatcher of(tt_KnownTargetSource knownTargetSource,
                                     tt_AnswerSource      answerSource,
                                     tt_AnswerStateSource answerStateSource)
  {
    let result = new("tt_QuestionAnswerMatcher");
    result._knownTargetSource = knownTargetSource;
    result._answerSource      = answerSource;
    result._answerStateSource = answerStateSource;
    return result;
  }

  override tt_Origin getOrigin()
  {
    let targets = _knownTargetSource.getTargets();
    if (targets == NULL || targets.size() == 0) { return NULL; }

    let answer = _answerSource.getAnswer();
    if (answer == NULL) { return NULL; }

    let answerState = _answerStateSource.getAnswerState();
    if (!tt_AnswerState.isReady(answerState)) { return NULL; }

    let result = findMatchedTarget(targets, answer);

    return result;
  }

  private tt_Origin findMatchedTarget(tt_KnownTargets targets, tt_Answer answer)
  {
    string answerString = answer.getString();
    uint nTargets = targets.size();
    for (uint i = 0; i < nTargets; ++i)
    {
      let target   = targets.at(i);
      let question = target.getQuestion();

      if (!question.isRight(answerString)) continue;

      let result = target.getTarget().getPosition();
      return result;
    }

    return NULL;
  }

  private tt_KnownTargetSource _knownTargetSource;
  private tt_AnswerSource      _answerSource;
  private tt_AnswerStateSource _answerStateSource;
}

// Implements OriginSource by selecting one of the two supplied
// origin sources based on a value of tt_BoolSetting.
class tt_SelectableOriginSource : tt_OriginSource
{
  static tt_SelectableOriginSource of(tt_OriginSource source1,
                                      tt_OriginSource source2,
                                      tt_BoolSetting  fastConfirmation)
  {
    let result = new("tt_SelectableOriginSource");
    result._source1 = source1;
    result._source2 = source2;
    result._fastConfirmation = fastConfirmation;
    return result;
  }

  override tt_Origin getOrigin()
  {
    return _fastConfirmation.get()
      ? _source1.getOrigin()
      : _source2.getOrigin();
  }

  private tt_OriginSource _source1;
  private tt_OriginSource _source2;
  private tt_BoolSetting  _fastConfirmation;
}

// Implements tt_OriginSource by receiving the source from elsewhere.
class tt_ExternalOriginSource : tt_OriginSource
{
  static tt_ExternalOriginSource of()
  {
    let result = new("tt_ExternalOriginSource");
    return result;
  }

  override tt_Origin getOrigin()
  {
    return _origin;
  }

  void setOrigin(tt_Origin origin)
  {
    _origin = origin;
  }

  private tt_Origin _origin;
}

// Interface for getting player info and player pawn.
class tt_PlayerSource abstract
{
  abstract PlayerInfo getInfo();

  abstract PlayerPawn getPawn();

  abstract int getNumber();
}

// Implements tt_PlayerSource by returning player by player number.
class tt_PlayerSourceImpl : tt_PlayerSource
{
  static tt_PlayerSourceImpl of(int playerNumber)
  {
    let result           = new ("tt_PlayerSourceImpl");
    result._playerNumber = playerNumber;
    return result;
  }

  override PlayerInfo getInfo() { return players[_playerNumber]; }

  override PlayerPawn getPawn() { return getInfo().mo; }

  override int getNumber() { return _playerNumber; }

  private int _playerNumber;
}

// This interface represents a question.
class tt_Question abstract
{
  abstract bool isRight(string answer);

  abstract string getDescription();

  abstract string getHintFor(string answer);
}

class tt_FallbackQuestion : tt_Question
{
  static tt_FallbackQuestion of() { return new("tt_FallbackQuestion"); }

  override bool isRight(string answer) { return false; }

  override string getDescription()
  {
    return StringTable.localize("TT_FALLBACK_QUESTION");
  }

  override string getHintFor(string answer) { return getDescription(); }
}

// Implements tt_Question. The answer is right for this kind of question if it
// matches the string contained in this question.
class tt_Match : tt_Question
{
  static tt_Match of(string answer, string description)
  {
    let result = new("tt_Match");
    result._answer      = answer;
    result._description = description;
    return result;
  }

  override bool isRight(string answer)
  {
    return (_answer == answer);
  }

  override string getDescription()
  {
    return _description;
  }

  override string getHintFor(string answer)
  {
    return getColoredMatch(_answer, answer);
  }

  static string getColoredMatch(string origin, string matched)
  {
    string result;

    int originLength  = origin .codePointCount();
    int matchedLength = matched.codePointCount();
    int nChars        = min(originLength, matchedLength);
    int originPos     = 0;
    int matchedPos    = 0;

    for (int i = 0; i < nChars; ++i)
    {
      let [originCode,  nextOriginPos ] = origin .getNextCodePoint(originPos );
      let [matchedCode, nextMatchedPos] = matched.getNextCodePoint(matchedPos);

      int colorCode = (originCode == matchedCode)
        ? tt_su_Ascii.HYPHEN_MINUS // Use the base color.
        : tt_TextColorCodes.WrongAnswer;

      result.appendFormat("\c%c%c", colorCode, matchedCode);

      originPos  = nextOriginPos;
      matchedPos = nextMatchedPos;
    }

    // Everything that is beyond origin is wrong.
    if (matchedLength > originLength)
    {
      result.appendFormat("\c%c%s",
                          tt_TextColorCodes.WrongAnswer,
                          matched.mid(matchedPos));
    }

    return result;
  }

  private string _answer;
  private string _description;
}

class tt_BoolSetting abstract
{
  abstract bool isDefined();

  abstract bool get();
}

class tt_IntSetting abstract
{
  abstract bool isDefined();

  abstract int get();
}

class tt_FloatSetting abstract
{
  abstract bool isDefined();

  abstract double get();
}

class tt_StringSetting abstract
{
  abstract bool isDefined();

  abstract string get();
}

// Provides access to a user or server bool Cvar.
class tt_BoolCvar : tt_BoolSetting
{
  static tt_BoolCvar of(tt_PlayerSource playerSource, string name)
  {
    let result = new("tt_BoolCvar");
    result._cvar = Cvar.getCvar(name, playerSource.getInfo());
    if (result._cvar != NULL && result._cvar.getRealType() != Cvar.CVAR_Bool)
      throwAbortException("%s Cvar is not bool", name);
    return result;
  }

  override bool isDefined() { return (_cvar != NULL); }
  override bool get()   { return _cvar.getInt();  }

  private Cvar _cvar;
}

// Provides access to a user or server bool Cvar. Protects against values < 1.
class tt_PositiveIntCvar : tt_IntSetting
{
  static tt_PositiveIntCvar of(tt_PlayerSource playerSource, string name)
  {
    let result = new("tt_PositiveIntCvar");
    result._cvar = Cvar.getCvar(name, playerSource.getInfo());
    if (result._cvar != NULL && result._cvar.getRealType() != Cvar.CVAR_Int)
      throwAbortException("%s Cvar is not int", name);
    return result;
  }

  override bool isDefined() { return (_cvar != NULL); }
  override int  get()       { return max(1, _cvar.getInt());  }

  private Cvar _cvar;
}

// Provides access to a user or server bool Cvar.
class tt_IntCvar : tt_IntSetting
{
  static tt_IntCvar of(tt_PlayerSource playerSource, string name)
  {
    let result = new("tt_IntCvar");
    result._cvar = Cvar.getCvar(name, playerSource.getInfo());
    if (result._cvar != NULL && result._cvar.getRealType() != Cvar.CVAR_Int)
      throwAbortException("%s Cvar is not int", name);
    return result;
  }

  override bool isDefined() { return (_cvar != NULL); }
  override int  get()       { return _cvar.getInt();  }

  private Cvar _cvar;
}

// Provides access to a user or server float Cvar.
class tt_FloatCvar : tt_FloatSetting
{
  static tt_FloatCvar of(tt_PlayerSource playerSource, string name)
  {
    let result = new("tt_FloatCvar");
    result._cvar = Cvar.getCvar(name, playerSource.getInfo());
    if (result._cvar != NULL && result._cvar.getRealType() != Cvar.CVAR_Float)
      throwAbortException("%s Cvar is not float", name);
    return result;
  }

  override bool   isDefined() { return (_cvar != NULL); }
  override double get() { return _cvar.getFloat(); }

  private Cvar _cvar;
}

// Provides access to a user or server string Cvar.
class tt_StringCvar : tt_StringSetting
{
  static tt_StringCvar of(tt_PlayerSource playerSource, string name)
  {
    let result = new("tt_StringCvar");
    result._cvar = Cvar.getCvar(name, playerSource.getInfo());
    if (result._cvar != NULL && result._cvar.getRealType() != Cvar.CVAR_String)
      throwAbortException("%s Cvar is not string", name);
    return result;
  }

  override bool   isDefined() { return (_cvar != NULL); }
  override string get() { return _cvar.getString(); }

  private Cvar _cvar;
}

// Represents settings for tt_RandomCharactersLesson.
class tt_RandomCharactersLessonSettings abstract
{
  abstract int getLessonLength();

  abstract bool isUppercaseLettersEnabled();

  abstract bool isLowercaseLettersEnabled();

  abstract bool isNumbersEnabled();

  abstract bool isPunctuationEnabled();

  abstract bool isSymbolsEnabled();

  abstract bool isCustomCharactersEnabled();

  abstract string getCustomCharacters();
}

// This interface provides information when its instance becomes stale.
class tt_StaleMarker abstract
{
  // Update stale status.
  // Attention! Calling this function may change the state of tt_StaleMarker.
  // Returns true if this instance is currently stale.
  abstract bool isStale();
}

// Implements tt_StaleMarker by observing a tt_Clock.
class tt_StaleMarkerImpl : tt_StaleMarker
{
  // Creates an instance of tt_StaleMarkerImpl.
  // clock: dependency, a clock to be observed.
  // updateTicks: in how much ticks this marker becomes stale.
  static tt_StaleMarkerImpl of(tt_Clock clock, int updateTicks = 1)
  {
    let result = new("tt_StaleMarkerImpl");

    result._clock       = clock;

    result._updateTicks = updateTicks;
    result._isEmpty     = true;
    result._oldMoment   = 0;

    return result;
  }

  override bool isStale()
  {
    if (!shouldUpdate()) return false;

    _oldMoment = _clock.getNow();
    _isEmpty   = false;

    return true;
  }

  private bool shouldUpdate() const
  {
    if (_isEmpty) return true;

    int  passed     = _clock.since(_oldMoment);
    bool isObsolete = (passed >= _updateTicks);

    return isObsolete;
  }

  private tt_Clock _clock;

  private int  _updateTicks;
  private bool _isEmpty;
  private int  _oldMoment;
}

// Represents a set of strings.
class tt_Strings
{
  static tt_Strings of()
  {
    let result = new("tt_Strings");
    return result;
  }

  static tt_Strings ofOne(String s)
  {
    let result = new("tt_Strings");
    result.add(s);
    return result;
  }

  uint size() const
  {
    return _strings.size();
  }

  string at(uint i) const
  {
    return _strings[i];
  }

  void set(uint i, string value)
  {
    _strings[i] = value;
  }

  bool contains(String str) const
  {
    uint foundIndex = _strings.Find(str);
    bool isFound    = (foundIndex != size());

    return isFound;
  }

  void add(String str)
  {
    _strings.push(str);
  }

  void clear() { _strings.clear(); }

  private Array<String> _strings;
}

// Represents an attack target.
class tt_Target
{
  static tt_Target of(Actor a)
  {
    let result = new("tt_Target");
    result._actor = a;
    result._origin = tt_Origin.of((0, 0, 0));
    return result;
  }

  // Get position in game space of this target.
  tt_Origin getPosition() const
  {
    vector3 position = _actor.pos;
    position.z += _actor.height / 2;

    _origin.setVector(position);
    return _origin;
  }

  bool isEqual(tt_Target other) const
  {
    return other._actor == _actor;
  }

  Actor getActor() const
  {
    return _actor;
  }

  private Actor     _actor;
  private tt_Origin _origin;
}

// Represent a list of Targets.
class tt_Targets
{
  static tt_Targets of() { return new("tt_Targets"); }

  // Returns a target in this list.
  tt_Target at(uint index) const { return _targets[index]; }

  // Returns a number of targets in this list.
  uint size() const { return _targets.size(); }

  // Returns true if this target list contains a target with the specified id.
  bool contains(tt_Target target) const { return find(target) != size(); }

  bool isEmpty() const { return (size() == 0); }

  // Adds a target to this list.
  void add(tt_Target target) { _targets.push(target); }

  void clear() { _targets.clear(); }

  // Searches for a target with a particular id.
  // Returns index on success, the total number of targets on failure.
  private uint find(tt_Target target) const
  {
    uint nTargets = size();
    for (uint i = 0; i < nTargets; ++i)
      if (_targets[i].isEqual(target)) return i;
    return nTargets;
  }

  private Array<tt_Target> _targets;
}

// This interface represents a source of targets.
// See: tt_Target.
class tt_TargetSource abstract
{
  abstract tt_Targets getTargets();
}

// Implements tt_TargetSource by scanning the world around the
// supplied origin for actors suitable to be targets.
class tt_TargetRadar : tt_TargetSource
{
  static tt_TargetRadar of(tt_OriginSource originSource)
  {
    let result = new("tt_TargetRadar");
    result._originSource = originSource;
    result._targets      = tt_Targets.of();
    return result;
  }

  override tt_Targets getTargets()
  {
    _targets.clear();

    let origin = _originSource.getOrigin().getVector();

    let iterator = ThinkerIterator.Create("Actor", Thinker.STAT_DEFAULT);
    Actor a;
    while (a = Actor(iterator.Next()))
    {
      if (tt_Math.isInEffectiveRange(a.pos, origin) && isSuitableForTargeting(a))
        _targets.add(tt_Target.of(a));
    }

    return _targets;
  }

  private static bool isSuitableForTargeting(Actor anActor)
  {
    bool isMonster    = anActor.bIsMonster;
    bool isDamageable = !anActor.bNoDamage;
    bool isAlive      = anActor.Health > 0;
    bool isFriendly   = anActor.bFriendly;
    bool wasFriendly  = getDefaultByType(anActor.getClass()).bFriendly;

    return isMonster && isDamageable && isAlive && !isFriendly && !wasFriendly;
  }

  private tt_OriginSource _originSource;
  private tt_Targets      _targets;
}

// Implements tt_TargetSource by collecting reports of
// dead things as a list of DisabledTargets.
class tt_DeathReporter : tt_TargetSource
{
  static tt_DeathReporter of()
  {
    let result = new("tt_DeathReporter");
    result._accumulatedTargets = tt_Targets.of();
    result._resultTargets      = tt_Targets.of();
    return result;
  }

  void reportDead(Actor thing)
  {
    let newDisabled = tt_Target.of(thing);
    _accumulatedTargets.add(newDisabled);
  }

  override tt_Targets getTargets()
  {
    tt_Targets temp = _resultTargets;
    _resultTargets = _accumulatedTargets;
    _accumulatedTargets = temp;
    _accumulatedTargets.clear();
    return _resultTargets;
  }

  private tt_Targets _accumulatedTargets;
  private tt_Targets _resultTargets;
}

{
  let _deathReporter = tt_DeathReporter.of();
  let targetsBefore  = _deathReporter.getTargets();
  it("tt_DeathReporter: No targets before reporting",
    AssertEval(targetsBefore.size(), "==", 0));

  let something = spawn("DoomImp", (0, 0, 0));
  _deathReporter.reportDead(something);
  let targetsAfter = _deathReporter.getTargets();
  it("tt_DeathReporter: Single target after reporting",
    AssertEval(targetsAfter.size(), "==", 1));

  let targetsAfterAfter = _deathReporter.getTargets();
  it("tt_DeathReporter: No new targets",
    AssertEval(targetsAfterAfter.size(), "==", 0));

  cleanUpSpawned();
}

// Implements tt_TargetSource by calling other tt_TargetSource only
// if previously received target is stale.
class tt_TargetSourceCache : tt_TargetSource
{
  static tt_TargetSourceCache of(tt_TargetSource targetSource,
                                 tt_StaleMarker staleMarker)
  {
    let result = new("tt_TargetSourceCache");

    result._targetSource = targetSource;
    result._staleMarker  = staleMarker;

    return result;
  }

  override tt_Targets getTargets()
  {
    if (_staleMarker.isStale())
    {
      _targets = _targetSource.getTargets();
    }

    return _targets;
  }

  private tt_TargetSource _targetSource;
  private tt_StaleMarker  _staleMarker;

  private tt_Targets _targets;
}

// Implements tt_TargetSource by pruning other tt_TargetSource from
// targets with null actors.
class tt_TargetSourcePruner : tt_TargetSource
{
  static tt_TargetSourcePruner of(tt_TargetSource targetSource)
  {
    let result = new("tt_TargetSourcePruner");
    result._targetSource = targetSource;
    result._targets = tt_Targets.of();
    return result;
  }

  override tt_Targets getTargets()
  {
    let targets = _targetSource.getTargets();

    _targets.clear();

    uint nTargets = targets.size();
    for (uint i = 0; i < nTargets; ++i)
    {
      tt_Target target = targets.at(i);
      if (target.getActor() != NULL)
        _targets.add(target);
    }

    return _targets;
  }

  private tt_TargetSource _targetSource;
  private tt_Targets      _targets;
}

// Represents a target displayed on the screen.
class tt_TargetWidget
{
  static tt_TargetWidget of(tt_KnownTarget target, vector2 position)
  {
    let result = new("tt_TargetWidget");

    result._target   = target;
    result._position = position;

    return result;
  }

  tt_KnownTarget getTarget() const
  {
    return _target;
  }

  vector2 getPosition() const
  {
    return _position;
  }

  double getDistanceTo(vector3 other)
  {
    let worldPosition = _target.getTarget().getPosition().getVector();
    let distance      = (worldPosition - other).Length();

    return distance;
  }

  void setPosition(vector2 position)
  {
    _position = position;
  }

  private tt_KnownTarget _target;
  private vector2        _position;
}

// Represents a list of target widgets.
class tt_TargetWidgets
{
  static tt_TargetWidgets of() { return new("tt_TargetWidgets"); }

  // Returns a target in this list.
  tt_TargetWidget at(uint index) const { return _widgets[index]; }

  // Returns a number of targets in this list.
  uint size() const { return _widgets.size(); }

  tt_TargetWidget find(tt_Target id) const
  {
    foreach (widget : _widgets)
      if (widget.getTarget().getTarget().isEqual(id)) return widget;

    return NULL;
  }

  bool containsWidget(tt_TargetWidget widget) const
  {
    foreach (widgetItem : _widgets)
      if (widget == widgetItem) return true;

    return false;
  }

  tt_TargetWidgets copy() const
  {
    let result = tt_TargetWidgets.of();
    result._widgets.Reserve(size());
    result._widgets.Copy(_widgets);

    return result;
  }

  // Adds a target to this list.
  void add(tt_TargetWidget widget) { _widgets.push(widget); }

  void set(uint i, tt_TargetWidget widget)  { _widgets[i] = widget; }

  void clear() { _widgets.clear(); }

  private Array<tt_TargetWidget> _widgets;
}

// This interface provides a source of target widgets.
class tt_TargetWidgetSource abstract
{
  // Get a list of target widgets.
  // Returns a list of target widgets.
  ui abstract tt_TargetWidgets getWidgets(RenderEvent event);
}

// Implements TargetWidgetSource by accumulating Target Widgets.
// Attention: this class has no tests. Modifications must be checked manually.
class tt_Projector : tt_TargetWidgetSource
{
  static tt_Projector of(tt_KnownTargetSource knownTargetSource,
                         tt_PlayerSource playerSource)
  {
    let result = new("tt_Projector");

    result._knownTargetSource = knownTargetSource;
    result._playerSource      = playerSource;
    result._cvarRenderer      = tt_IntCvar.of(playerSource, "vid_rendermode");

    result._glProjection = new("tt_le_GlScreen");
    result._swProjection = new("tt_le_SwScreen");

    result._widgets = tt_TargetWidgets.of();

    return result;
  }

  override tt_TargetWidgets getWidgets(RenderEvent event)
  {
    let targets = _knownTargetSource.getTargets();
    let info    = _playerSource.getInfo();

    prepareProjection();

    _projection.CacheResolution();
    _projection.CacheFov(info.fov);
    _projection.OrientForRenderOverlay(event);
    _projection.BeginProjection();

    tt_le_Viewport viewport;
    viewport.FromHud();

    _widgets.clear();
    uint nTargets = targets.size();
    for (uint i = 0; i < nTargets; ++i)
    {
      let target = targets.at(i);

      let targetActor = target.getTarget().getActor();
      if (targetActor == NULL)
      {
        continue;
      }

      vector3 targetPos = target.getTarget().getPosition().getVector();
      vector2 position;
      bool    isPositionSuccessful;
      [position, isPositionSuccessful] = makeDrawPos(targetPos, viewport);

      if (isPositionSuccessful)
      {
        let widget = tt_TargetWidget.of(target, position);
        _widgets.add(widget);
      }
    }

    return _widgets;
  }

  // Calculates the screen position (draw position).
  // Returns screen position and success flag.
  private ui vector2, bool makeDrawPos(vector3 targetPos, tt_le_Viewport viewport)
  {
    _projection.ProjectWorldPos(targetPos);

    if(!_projection.IsInFront())
    {
      return (0, 0), false;
    }

    vector2 drawPos = viewport.SceneToWindow(_projection.ProjectToNormal());

    return drawPos, true;
  }

  private void prepareProjection()
  {
    if(_cvarRenderer.isDefined())
    {
      switch (_cvarRenderer.get())
      {
      case 0:
      case 1:  _projection = _swProjection; break;
      default: _projection = _glProjection; break;
      }
    }
    else // cannot get render mode.
    {
      _projection = _glProjection;
    }
  }

  private tt_KnownTargetSource _knownTargetSource;
  private tt_PlayerSource      _playerSource;

  private tt_le_ProjScreen _projection;
  private tt_le_GlScreen   _glProjection;
  private tt_le_SwScreen   _swProjection;

  private transient bool _isInitialized;

  private tt_IntCvar _cvarRenderer;

  private tt_TargetWidgets _widgets;
}

// Implements TargetWidgetSource by taking another TargetWidgetSource
// and sorting the widgets from it by a distance to origin from OriginSource.
//
// Sorting algorithm: merge sort
// https://en.wikipedia.org/wiki/Merge_sort
class tt_SorterByDistance : tt_TargetWidgetSource
{
  static tt_SorterByDistance of(tt_TargetWidgetSource targetWidgetSource,
                                tt_OriginSource originSource)
  {
    let result = new("tt_SorterByDistance");

    result._targetWidgetSource = targetWidgetSource;
    result._originSource       = originSource;

    return result;
  }

  override tt_TargetWidgets getWidgets(RenderEvent event)
  {
    let widgets = _targetWidgetSource.getWidgets(event);
    let origin  = _originSource.getOrigin().getVector();
    let sorted  = sort(widgets, origin);

    return sorted;
  }

  static tt_TargetWidgets sort(tt_TargetWidgets widgets, vector3 origin)
  {
    if (widgets.size() == 0) return widgets;

    let result    = widgets;
    let workplace = widgets.copy();

    TopDownSplitMerge(workplace, 0, widgets.size(), result, origin);

    return result;
  }

  private static void TopDownSplitMerge(tt_TargetWidgets B,
                                        uint             begin,
                                        uint             end,
                                        tt_TargetWidgets A,
                                        vector3          origin)
  {
    if ((end - begin) < 2) // if run size == 1 consider it sorted
    {
      return;
    }

    // split the run longer than 1 item into halves
    uint middle = (end + begin) / 2; // mid point

    // recursively sort both runs from array A into B
    TopDownSplitMerge(A, begin,  middle, B, origin); // sort the left  run
    TopDownSplitMerge(A, middle,    end, B, origin); // sort the right run

    // merge the resulting runs from array B into A
    TopDownMerge(B, begin, middle, end, A, origin);
  }

  private static void TopDownMerge(tt_TargetWidgets A,
                                   uint             begin,
                                   uint             middle,
                                   uint             end,
                                   tt_TargetWidgets B,
                                   vector3          origin)
  {
    uint i = begin;
    uint j = middle;

    // While there are elements in the left or right runs...
    for (uint k = begin; k < end; ++k)
    {
      // If left run head exists and is >= existing right run head.
      if (i < middle
          && (j >= end || A.at(i).getDistanceTo(origin) >= A.at(j).getDistanceTo(origin)))
      {
        B.set(k, A.at(i));
        ++i;
      }
      else
      {
        B.set(k, A.at(j));
        ++j;
      }
    }
  }

  private tt_TargetWidgetSource _targetWidgetSource;
  private tt_OriginSource       _originSource;
}

{
  let tag = "tt_SorterByDistance : checkEmpty";

  let before = tt_TargetWidgets.of();
  let origin = tt_Origin.of((0, 0, 0));
  let after  = tt_SorterByDistance.sort(before, origin.getVector());

  it(tag .. ": empty collection must remain empty",
     AssertEval(after.size(), "==", 0));
}
{
  let tag = "tt_SorterByDistance : checkSorted";

  let origin = tt_Origin.of((0, 0, 0));
  let before = tt_TargetWidgets.of();
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 2))));
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 1))));
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 0))));

  it(tag .. ": Before: sorted",
     Assert(tt_SorterByDistanceTest.isSorted(before, origin.getVector())));

  let after = tt_SorterByDistance.sort(before, origin.getVector());

  it(tag .. ": size of collection must the same",
     AssertEval(after.size(), "==", before.size()));
  it(tag .. ": contains same elements",
     Assert(tt_SorterByDistanceTest.isSameElements(before, after)));
  it(tag .. ": after: sorted",
     Assert(tt_SorterByDistanceTest.isSorted(after, origin.getVector())));

  cleanUpSpawned();
}
{
  let tag = "tt_SorterByDistance : checkReverse";

  let origin = tt_Origin.of((0, 0, 0));
  let before = tt_TargetWidgets.of();
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 0))));
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 1))));
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 2))));

  it(tag .. ": before: not sorted",
     Assert(!tt_SorterByDistanceTest.isSorted(before, origin.getVector())));

  let after = tt_SorterByDistance.sort(before, origin.getVector());

  it(tag .. ": size of collection must the same",
     AssertEval(after.size(), "==", before.size()));
  it(tag .. ": contains same elements",
     Assert(tt_SorterByDistanceTest.isSameElements(before, after)));
  it(tag .. ": after: sorted",
     Assert(tt_SorterByDistanceTest.isSorted(after, origin.getVector())));

  cleanUpSpawned();
}
{
  let tag = "tt_SorterByDistance : middle";

  let origin = tt_Origin.of((0, 0, 0));
  let before = tt_TargetWidgets.of();
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 1))));
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 2))));
  before.add(tt_SorterByDistanceTest.createAtPosition(spawn("Demon", (0, 0, 0))));

  it(tag .. ": before: not sorted",
     Assert(!tt_SorterByDistanceTest.isSorted(before, origin.getVector())));

  let after = tt_SorterByDistance.sort(before, origin.getVector());

  it(tag .. ": size of collection must the same",
     AssertEval(after.size(), "==", before.size()));
  it(tag .. ": contains same elements",
     Assert(tt_SorterByDistanceTest.isSameElements(before, after)));
  it(tag .. ": after: sorted",
     Assert(tt_SorterByDistanceTest.isSorted(after, origin.getVector())));

  cleanUpSpawned();
}

class tt_SorterByDistanceTest
{
  static bool isSorted(tt_TargetWidgets targetWidgets, vector3 origin)
  {
    uint nWidgets = targetWidgets.size();

    if (nWidgets < 2) return true;

    for (uint i = 1; i < nWidgets; ++i)
    {
      let prevDistance = targetWidgets.at(i - 1).getDistanceTo(origin);
      let thisDistance = targetWidgets.at(i    ).getDistanceTo(origin);

      if (prevDistance < thisDistance) return false;
    }

    return true;
  }

  static bool isSameElements(tt_TargetWidgets t1, tt_TargetWidgets t2)
  {
    uint nWidgets1 = t1.size();
    uint nWidgets2 = t2.size();

    if (nWidgets1 != nWidgets2) return false;

    for (uint i = 0; i < nWidgets1; ++i)
      if (!t2.containsWidget(t1.at(i))) return false;

    for (uint i = 0; i < nWidgets2; ++i)
      if (!t1.containsWidget(t2.at(i))) return false;

    return true;
  }

  static tt_TargetWidget createAtPosition(Actor anActor)
  {
    let target      = tt_Target.of(anActor);
    let question    = tt_QuestionMock.of();
    let knownTarget = tt_KnownTarget.of(target, question);
    let widget      = tt_TargetWidget.of(knownTarget, (0, 0));

    return widget;
  }
}

// Implements TargetWidgetSource by storing target widgets, getting
// new widgets from the source, and updating the coordinates of the widgets that
// are already registered.
class tt_TargetWidgetRegistry : tt_TargetWidgetSource
{
  static tt_TargetWidgetRegistry of(tt_TargetWidgetSource source)
  {
    let result = new("tt_TargetWidgetRegistry");
    result._source      = source;
    result._registry    = tt_TargetWidgets.of();
    result._newRegistry = tt_TargetWidgets.of();
    return result;
  }

  override tt_TargetWidgets getWidgets(RenderEvent event)
  {
    let widgets     = _source.getWidgets(event);

    uint nWidgets = widgets.size();
    for (uint i = 0; i < nWidgets; ++i)
    {
      let widget   = widgets.at(i);
      let target   = widget.getTarget().getTarget();
      let existing = _registry.find(target);

      if (existing == NULL)
      {
        _newRegistry.add(widget);
      }
      else
      {
        _newRegistry.add(existing);
        let newPosition      = widget.getPosition();
        let existingPosition = existing.getPosition();
        let middle           = (newPosition * 0.3 + existingPosition * 0.7);
        existing.setPosition(middle);
      }
    }

    // Widgets that are not new or not updated are thrown away.
    tt_TargetWidgets temp = _registry;
    _registry    = _newRegistry;
    _newRegistry = temp;
    _newRegistry.clear();

    return _registry;
  }

  private tt_TargetWidgetSource _source;
  private tt_TargetWidgets      _registry;
  private tt_TargetWidgets      _newRegistry;
}

// This interface represents a view - something that displays something.
class tt_View abstract
{
  ui abstract void draw(RenderEvent event);
}

// Implements View by allowing several Views to be drawn.
class tt_Views : tt_View
{
  static tt_Views of(Array<tt_View> views)
  {
    let result = new("tt_Views");
    result._views.move(views);
    return result;
  }

  override void draw(RenderEvent event)
  {
    foreach (view : _views)
      view.draw(event);
  }

  private Array<tt_View> _views;
}

class tt_Frame : tt_View
{
  static tt_Frame of(tt_ModeSource modeSource)
  {
    let result = new("tt_Frame");
    result._modeSource = modeSource;
    result._alphaInterpolator = tt_DoubleInterpolator.of();
    return result;
  }

  static int getWidth() { return Screen.getWidth() / 64; }

  override void draw(RenderEvent _)
  {
    double destination = (_modeSource.getMode() == tt_Mode.Combat) ? 1.0 : 0.0;

    _alphaInterpolator.reset(destination, 0.1);
    // TODO: untie from framerate?
    _alphaInterpolator.update();

    double alpha = _alphaInterpolator.getValue();

    if (alpha ~== 0.0) return;

    int   screenWidth  = Screen.getWidth();
    int   screenHeight = Screen.getHeight();
    int   width        = getWidth();
    int   height       = width;
    Color white        = "FFFFFF";

    Screen.dim(white, alpha, 0, 0, width, screenHeight);
    Screen.dim(white, alpha, width, 0, screenWidth - width * 2, height);
    Screen.dim(white, alpha, screenWidth - width, 0, width, screenHeight);
    Screen.dim(white,
               alpha,
               width,
               screenHeight - height,
               screenWidth - width * 2,
               height);
  }

  private tt_ModeSource _modeSource;
  private tt_DoubleInterpolator _alphaInterpolator;
}

class tt_DoubleInterpolator
{
  static tt_DoubleInterpolator of() { return new("tt_DoubleInterpolator"); }

  ui void update()
  {
    _currentValue = (_destination > _currentValue)
      ? min(_destination, _currentValue + _step)
      : max(_destination, _currentValue - _step);
  }

  ui double getValue() const { return _currentValue; }

  ui void reset(double destination, double step)
  {
    _destination = destination;
    _step = step;
  }

  private ui double _destination;
  private ui double _currentValue;
  private ui double _step;
}

// Implements a view by taking another view, and calling draw()
// only if conditions are met.
//
// The list of conditions:
// - not in a menu
// - automap is closed
//
// Attention! This class reads data from global scope.
class tt_ConditionalView : tt_View
{
  static tt_ConditionalView of(tt_View view)
  {
    let result = new("tt_ConditionalView");
    result._view = view;
    return result;
  }

  override void draw(RenderEvent event)
  {
    if (!menuActive && !automapActive) _view.draw(event);
  }

  private tt_View _view;
}

// Implements View by collecting and displaying various information:
// - game mode
// - list of commands
// - current input string
// - several targets
class tt_InfoPanel : tt_View
{
  static tt_InfoPanel of(tt_ModeSource        modeSource,
                         tt_AnswerSource      answerSource,
                         tt_Activatable       activatable,
                         tt_KnownTargetSource knownTargetSource,
                         tt_IntSetting        scaleSetting)
  {
    let result = new("tt_InfoPanel");

    result._modeSource   = modeSource;
    result._answerSource = answerSource;
    result._activatable  = activatable;
    result._targetSource = knownTargetSource;
    result._scaleSetting = scaleSetting;

    return result;
  }

  override void draw(RenderEvent _)
  {
    let targets      = _targetSource.getTargets();
    let targetCount  = targets.size();
    let commands     = _activatable.getCommands();
    let commandCount = commands.size();
    if (targetCount == 0 && commandCount == 0) return;

    int scale        = _scaleSetting.get();
    int screenWidth  = Screen.getWidth();
    int halfScreen   = screenWidth / 2;
    int scaledMargin = MARGIN * scale;
    int frameWidth   = tt_Frame.getWidth();
    int y            = scaledMargin + frameWidth;
    let answer       = _answerSource.getAnswer().getString();
    int color        = tt_Drawing.getColorForMode(_modeSource.getMode());

    int xLeft  = halfScreen;
    int xRight = halfScreen;

    // 1. Draw the first target in the center.
    if (targetCount > 0)
    {
      let    question       = targets.at(0).getQuestion();
      string questionString = question.getDescription();
      string hintedAnswer   = question.getHintFor(answer);
      let [width, height]   = tt_Drawing.getBoxSize(questionString,
                                                    hintedAnswer,
                                                    scale);

      tt_Drawing.drawTarget(halfScreen - width / 2,
                            y,
                            width,
                            height,
                            questionString,
                            hintedAnswer,
                            scale,
                            color);

      xLeft  = halfScreen - width / 2 - scaledMargin;
      xRight = xLeft + width + scaledMargin * 2;
    }

    // 2. Draw the targets to the right while there is space.
    uint i = 1;
    for (; i < targetCount; ++i)
    {
      let    question       = targets.at(i).getQuestion();
      string questionString = question.getDescription();
      string hintedAnswer   = question.getHintFor(answer);
      let [width, height]   = tt_Drawing.getBoxSize(questionString,
                                                    hintedAnswer,
                                                    scale);

      if (xRight + width > screenWidth - frameWidth) break;

      tt_Drawing.drawTarget(xRight,
                            y,
                            width,
                            height,
                            questionString,
                            hintedAnswer,
                            scale,
                            color);

      xRight += width + scaledMargin;
    }

    // 3. Draw the commands to the left while there is space.
    for (uint c = 0; c < commandCount; ++c)
    {
      let  command        = commands.at(c);
      let  hintedAnswer   = tt_Match.getColoredMatch(command, answer);
      let [width, height] = tt_Drawing.getBoxSize(command, hintedAnswer, scale);
      bool isCentered     = targetCount == 0 && c == 0;
      let  x              = isCentered ? halfScreen - width / 2 : xLeft - width;

      if (x < frameWidth) break;

      tt_Drawing.drawTarget(x,
                            y,
                            width,
                            height,
                            command,
                            hintedAnswer,
                            scale,
                            color);

      xLeft -= width + scaledMargin;
    }

    // 4. Draw the remaining targets to the left while there is space.
    for (; i < targetCount; ++i)
    {
      let    question       = targets.at(i).getQuestion();
      string questionString = question.getDescription();
      string hintedAnswer   = question.getHintFor(answer);
      let [width, height]   = tt_Drawing.getBoxSize(questionString,
                                                    hintedAnswer,
                                                    scale);

      if (xLeft - width < frameWidth) break;

      tt_Drawing.drawTarget(xLeft - width,
                            y,
                            width,
                            height,
                            questionString,
                            hintedAnswer,
                            scale,
                            color);

      xLeft -= width + scaledMargin;
    }
  }

  const MARGIN = 2;

  private tt_ModeSource        _modeSource;
  private tt_AnswerSource      _answerSource;
  private tt_Activatable       _activatable;
  private tt_KnownTargetSource _targetSource;
  private tt_IntSetting        _scaleSetting;
}

// Implement tt_View by getting a list of Target Widgets and drawing them.
class tt_TargetOverlay : tt_View
{
  static tt_TargetOverlay of(tt_TargetWidgetSource targetWidgetSource,
                             tt_AnswerSource       answerSource,
                             tt_IntSetting         scaleSetting,
                             tt_ModeSource         modeSource)
  {
    let result = new("tt_TargetOverlay");

    result._targetWidgetSource = targetWidgetSource;
    result._answerSource       = answerSource;
    result._scaleSetting       = scaleSetting;
    result._modeSource         = modeSource;

    return result;
  }

  override void draw(RenderEvent event)
  {
    let widgets = _targetWidgetSource.getWidgets(event);
    let answer  = _answerSource.getAnswer().getString();
    int mode    = _modeSource.getMode();
    int color   = tt_Drawing.getColorForMode(mode);
    int scale   = _scaleSetting.get();
    int screenWidth  = Screen.getWidth();
    int screenHeight = Screen.getHeight();
    int frameWidth   = tt_Frame.getWidth();

    uint nWidgets = widgets.size();
    for (uint i = 0; i < nWidgets; ++i)
    {
      let widget          = widgets.at(i);
      let question        = widget.getTarget().getQuestion();
      let questionString  = question.getDescription();
      let hintedAnswer    = question.getHintFor(answer);
      let position        = widget.getPosition();
      let [width, height] = tt_Drawing.getBoxSize(questionString,
                                                  hintedAnswer,
                                                  scale);

      int x = int(clamp(position.x - width / 2,
                        frameWidth,
                        screenWidth  - width - frameWidth));
      int y = int(clamp(position.y - height,
                        frameWidth,
                        screenHeight - height * 2 - frameWidth));

      tt_Drawing.drawTarget(x,
                            y,
                            width,
                            height,
                            questionString,
                            hintedAnswer,
                            scale,
                            color);
    }
  }

  private tt_TargetWidgetSource _targetWidgetSource;
  private tt_AnswerSource       _answerSource;
  private tt_IntSetting         _scaleSetting;
  private tt_ModeSource         _modeSource;
}

// Namespace for common drawing functions.
class tt_Drawing ui
{
  static int getColorForMode(int mode)
  {
    return (mode == tt_Mode.Combat)
      ? tt_RgbColors.AnswerCombat
      : tt_RgbColors.AnswerExploration;
  }

  static int, int getBoxSize(string question, string answer, int scale)
  {
    // One extra BORDER for width: stringWidth tends to underestimate the width.
    let aFont  = NewSmallFont;
    int height = scale * (BORDER * 4 + aFont.getHeight());
    int width  = scale * (BORDER * 5 + max(aFont.stringWidth(question),
                                           aFont.stringWidth(answer)));
    return width, height;
  }

  static void drawTarget(int    x,
                         int    y,
                         int    width,
                         int    height, // Box height, target is two boxes.
                         string question,
                         string answer,
                         int    scale,
                         Color  answerColor)
  {
    drawBox(x, y, width, height, question, scale, tt_RgbColors.Question);
    drawBox(x, y + height, width, height, answer, scale, answerColor);
  }

  private static void drawBox(int    x,
                              int    y,
                              int    width,
                              int    height,
                              string text,
                              int    scale,
                              Color  aColor)
  {
    int scaledBorder = BORDER * scale;
    Color backgroundColor = Color(aColor.r / 2, aColor.g / 2, aColor.b / 2);

    Screen.dim(aColor, ALPHA, x, y, width, height);
    Screen.dim(backgroundColor,
               ALPHA,
               x + scaledBorder,
               y + scaledBorder,
               width  - scaledBorder * 2,
               height - scaledBorder * 2,
               STYLE_Subtract);

    Screen.drawText(NewSmallFont,
                    tt_TextColors.Base,
                    x + scaledBorder * 2,
                    y + scaledBorder * 2,
                    text,
                    DTA_ScaleX, scale,
                    DTA_ScaleY, scale);
  }

  const BORDER = 2;
  const ALPHA  = 0.2;
}

// Interface for any non-play effects.
class tt_Effect abstract
{
  abstract void doEffect();
}

class tt_Effects : tt_Effect
{
  static tt_Effects of(Array<tt_Effect> effects)
  {
    let result = new("tt_Effects");
    result._effects.move(effects);
    return result;
  }

  override void doEffect()
  {
    foreach (effect : _effects)
      effect.doEffect();
  }

  private Array<tt_Effect> _effects;
}

// Implements tt_Effect by calling other tt_Effect if there is some tt_Origin.
class tt_Gunner : tt_Effect
{
  static tt_Gunner of(tt_OriginSource originSource, tt_Effect effect)
  {
    let result = new("tt_Gunner");
    result._originSource = originSource;
    result._effect       = effect;
    return result;
  }

  override void doEffect()
  {
    if (_originSource.getOrigin() != NULL) _effect.doEffect();
  }

  private tt_OriginSource _originSource;
  private tt_Effect       _effect;
}