Files
Rail_Enterprise/client/RailEnterprise.Client/scripts/Tutorial/TutorialOverlay.cs
T
Alby96andClaude Opus 5.5 ebe4308e75 F6: tutorial guidato della prima partita
Tutorial facoltativo che accompagna il giocatore dalla mappa alla prima
linea in servizio e poi a Mercato globale, Finanze e La tua scalata. È
un'esperienza del solo client: osserva ciò che il client già riceve
(entità della compagnia in ClientWorld, esiti riusciti dei comandi,
pannello aperto, camera, velocità, anteprime del tracciato), non invia
comandi e non decide regole; Core, Protocol, Server e salvataggi non
cambiano (ADR 0023).

- Copione in assets/tutorial/tutorial.json (19 passi, chiavi di testo
  per T(), elemento da evidenziare con ripiego, condizione osservabile),
  esportato con il gioco; testi italiani e inglesi in strings.csv.
- Logica pura senza Godot in scripts/Tutorial/Logic: copione con
  validazione, fatti, condizioni counter/panel/all/any, macchina a stati,
  avanzamento salvato; compilata anche dal progetto dei test (8 test).
- Riquadro non modale in basso a sinistra della mappa, contorno ambra
  animato, Avanti / Salta passo / Chiudi tutorial, F1 per nasconderlo o
  riaprirlo; nel menu la casella «Mostra il tutorial» (attiva alla prima
  partita) e l'opzione «Tutorial».
- Avanzamento per partita in user://settings.cfg, ripreso dopo il
  caricamento; il pilota automatico non crea il tutorial.

Refs #45.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-08 14:21:12 +01:00

179 lines
7.3 KiB
C#
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
using Godot;
using RailEnterprise.Client.App;
using static RailEnterprise.Client.App.Localization;
namespace RailEnterprise.Client.Tutorial;
/// <summary>
/// Interfaccia del tutorial: riquadro ancorato in basso a sinistra dell'area della mappa (non modale, non
/// copre barra degli strumenti né pannello destro) e contorno ambra animato attorno all'elemento da
/// guardare. Tutto ciò che non è il riquadro lascia passare il mouse.
/// </summary>
public partial class TutorialOverlay : Control
{
private const float BoxWidth = 400;
private const float Margin = 16;
private readonly PanelContainer _box = new();
private readonly Label _counter = UiTheme.Text("", 12, Palette.TextSecondary);
private readonly Label _title = UiTheme.TitleLabel("", 26, Palette.AmberLight);
private readonly Label _text = UiTheme.Text("", 14);
private readonly Label _done = UiTheme.Text("", 13, Palette.Ok, bold: true);
private readonly ProgressBar _progress = new() { ShowPercentage = false, CustomMinimumSize = new Vector2(0, 4) };
private readonly VBoxContainer _body = new();
private readonly Button _next = UiTheme.Primary(T("Avanti"));
private readonly Button _skip = new() { Text = T("Salta passo") };
private readonly Button _close = new() { Text = T("Chiudi tutorial") };
private readonly Button _collapse = new() { Text = "–", Flat = true, CustomMinimumSize = new Vector2(28, 24) };
private readonly HighlightFrame _frame = new();
private double _doneTimer;
private bool _collapsed;
public event Action? NextPressed;
public event Action? SkipPressed;
public event Action? ClosePressed;
public override void _Ready()
{
SetAnchorsAndOffsetsPreset(LayoutPreset.FullRect);
MouseFilter = MouseFilterEnum.Ignore;
UiTheme.Apply(this);
AddChild(_frame);
_box.AddThemeStyleboxOverride("panel", UiTheme.Box(Palette.Panel, Palette.Amber, 10, 16));
_box.CustomMinimumSize = new Vector2(BoxWidth, 0);
AddChild(_box);
var col = new VBoxContainer();
col.AddThemeConstantOverride("separation", 8);
_box.AddChild(col);
var header = new HBoxContainer();
header.AddThemeConstantOverride("separation", 8);
header.AddChild(UiTheme.Badge(T("Tutorial")));
_counter.SizeFlagsHorizontal = SizeFlags.ExpandFill;
_counter.SizeFlagsVertical = SizeFlags.ShrinkCenter;
header.AddChild(_counter);
_collapse.TooltipText = T("Riduci o espandi il riquadro del tutorial");
_collapse.Pressed += () => SetCollapsed(!_collapsed);
header.AddChild(_collapse);
col.AddChild(header);
_progress.AddThemeStyleboxOverride("fill", UiTheme.Box(Palette.Amber, Palette.Amber, 2, 0));
_progress.AddThemeStyleboxOverride("background", UiTheme.Box(Palette.Border, Palette.Border, 2, 0));
col.AddChild(_progress);
_title.AutowrapMode = TextServer.AutowrapMode.WordSmart;
col.AddChild(_title);
_body.AddThemeConstantOverride("separation", 10);
col.AddChild(_body);
_text.AutowrapMode = TextServer.AutowrapMode.WordSmart;
_body.AddChild(_text);
_done.AutowrapMode = TextServer.AutowrapMode.WordSmart;
_done.Visible = false;
_body.AddChild(_done);
var buttons = new HBoxContainer();
buttons.AddThemeConstantOverride("separation", 8);
buttons.AddChild(_next);
buttons.AddChild(_skip);
buttons.AddChild(new Control { SizeFlagsHorizontal = SizeFlags.ExpandFill });
buttons.AddChild(_close);
_body.AddChild(buttons);
_next.Pressed += () => NextPressed?.Invoke();
_skip.Pressed += () => SkipPressed?.Invoke();
_close.Pressed += () => ClosePressed?.Invoke();
_close.TooltipText = T("Il tutorial si riapre con F1 o dal menu");
}
/// <summary>Mostra un passo: numero, titolo e testo già tradotti; Avanti solo per i passi informativi.</summary>
public void ShowStep(int number, int count, string title, string text, bool informative, bool last)
{
_counter.Text = string.Format(T("Passo {0} di {1}"), number, count);
_progress.MaxValue = count;
_progress.Value = number - 1;
_title.Text = title;
_text.Text = text;
_next.Visible = informative;
_next.Text = last ? T("Fine") : T("Avanti");
_skip.Visible = !informative;
}
/// <summary>Breve conferma del passo appena completato.</summary>
public void Flash(string completedTitle)
{
_done.Text = $"✓ {T("Fatto")}: {completedTitle}";
_done.Visible = true;
_doneTimer = 2.5;
}
/// <summary>Area libera in cui ancorare il riquadro (rettangolo globale della mappa o del pannello a tutto schermo).</summary>
public Rect2 Area { get; set; }
/// <summary>Elemento da evidenziare (rettangolo globale), null per nessuno.</summary>
public Rect2? Target
{
get => _frame.Target;
set => _frame.Target = value;
}
private void SetCollapsed(bool collapsed)
{
_collapsed = collapsed;
_body.Visible = !collapsed;
_collapse.Text = collapsed ? "+" : "–";
}
public override void _Process(double delta)
{
if (_doneTimer > 0)
{
_doneTimer -= delta;
if (_doneTimer <= 0) _done.Visible = false;
}
// in basso a sinistra dell'area libera; la larghezza si adatta alle finestre strette
var area = Area.Size == Vector2.Zero ? GetViewportRect() : Area;
float width = Math.Min(BoxWidth, Math.Max(240, area.Size.X - 2 * Margin));
_box.CustomMinimumSize = new Vector2(width, 0);
_box.Size = new Vector2(width, 0);
var size = _box.GetCombinedMinimumSize();
_box.Size = size;
_box.Position = new Vector2(area.Position.X + Margin, area.End.Y - Margin - size.Y);
}
/// <summary>Contorno ambra che pulsa attorno all'elemento evidenziato; non intercetta il mouse.</summary>
private sealed partial class HighlightFrame : Control
{
private double _time;
public Rect2? Target { get; set; }
public override void _Ready()
{
SetAnchorsAndOffsetsPreset(LayoutPreset.FullRect);
MouseFilter = MouseFilterEnum.Ignore;
}
public override void _Process(double delta)
{
_time += delta;
QueueRedraw();
}
public override void _Draw()
{
if (Target is not { } t || t.Size.X <= 0 || t.Size.Y <= 0) return;
float pulse = 0.5f + 0.5f * MathF.Sin((float)_time * 4f);
float grow = 3 + 3 * pulse;
var rect = t.Grow(grow);
rect.Position -= GetGlobalRect().Position;
var glow = new StyleBoxFlat { BgColor = Palette.WithAlpha(Palette.Amber, 0.06f + 0.06f * pulse), BorderColor = Palette.WithAlpha(Palette.AmberLight, 0.35f + 0.45f * pulse) };
glow.SetBorderWidthAll(3);
glow.SetCornerRadiusAll(10);
DrawStyleBox(glow, rect);
var outer = new StyleBoxFlat { BgColor = new Color(0, 0, 0, 0), BorderColor = Palette.WithAlpha(Palette.Amber, 0.25f * (1 - pulse)) };
outer.SetBorderWidthAll(2);
outer.SetCornerRadiusAll(14);
DrawStyleBox(outer, rect.Grow(6 + 4 * pulse));
}
}
}