Refactor Level Setup, Import and Rename forms + Refactor script generators #1120

Nickelony · 2026-02-07T22:20:39Z

No description provided.

Copilot

Pull request overview

This PR refactors level setup/import/rename flows by extracting logic from WinForms into dedicated services and helper classes (PRJ2 handling, script-line generation, game-version defaults), while also updating some shared API shapes to use read-only collections.

Changes:

Replaced the old LevelHandling utility with focused helpers (Prj2Helper, LevelNameHelper, ScriptLineGenerator, GameVersionHelper) and updated call sites.
Introduced new ProjectMaster services for level setup/import/rename with options/result records and optional progress reporting.
Updated UI entry points (SectionLevelList, forms) to depend on the new services and adjusted namespaces/types (LevelCompileService, EngineVersionInfo, append-script-lines API).

Reviewed changes

Copilot reviewed 34 out of 34 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
TombIDE/TombIDE/Forms/FormImportProject.cs	Switches PRJ2 discovery to `Prj2Helper.GetValidFiles(...)`.
TombIDE/TombIDE.Shared/TombIDE.Shared.csproj	Sets `LangVersion` to 12 for Shared project.
TombIDE/TombIDE.Shared/SharedForms/FormLoading.cs	Uses `Prj2Helper.UpdateGameSettings` instead of removed `LevelHandling`.
TombIDE/TombIDE.Shared/SharedClasses/ScriptLineGenerator.cs	New script line generator replacing `LevelHandling.GenerateScriptLines`.
TombIDE/TombIDE.Shared/SharedClasses/LevelNameHelper.cs	New validation/sanitization helpers replacing name-related parts of `LevelHandling`.
TombIDE/TombIDE.Shared/SharedClasses/LevelHandling.cs	Removes legacy all-in-one helper.
TombIDE/TombIDE.Shared/SharedClasses/GameVersionHelper.cs	Centralizes game-version-specific defaults/capabilities for UI/services.
TombIDE/TombIDE.Shared/NewStructure/Prj2Helper.cs	Extends PRJ2 helper with valid-file enumeration + settings update logic.
TombIDE/TombIDE.Shared/IProgressReportingForm.cs	Adds progress-reporting interface for long-running imports.
TombIDE/TombIDE.Shared/IDE.cs	Changes append-script-lines event/API to `IReadOnlyList<string>`.
TombIDE/TombIDE.ProjectMaster/Services/Level/Setup/LevelSetupService.cs	New service that creates level folder + PRJ2 + optional script lines.
TombIDE/TombIDE.ProjectMaster/Services/Level/Setup/LevelSetupResult.cs	Result record for setup flow.
TombIDE/TombIDE.ProjectMaster/Services/Level/Setup/LevelSetupOptions.cs	Options record for setup flow.
TombIDE/TombIDE.ProjectMaster/Services/Level/Setup/ILevelSetupService.cs	Interface for level setup service.
TombIDE/TombIDE.ProjectMaster/Services/Level/Rename/LevelRenameState.cs	Captures UI checkbox/label state logic for rename form.
TombIDE/TombIDE.ProjectMaster/Services/Level/Rename/LevelRenameService.cs	New service handling rename logic + UI state computation.
TombIDE/TombIDE.ProjectMaster/Services/Level/Rename/LevelRenameResult.cs	Result record for rename flow.
TombIDE/TombIDE.ProjectMaster/Services/Level/Rename/LevelRenameOptions.cs	Options record for rename flow.
TombIDE/TombIDE.ProjectMaster/Services/Level/Rename/ILevelRenameService.cs	Interface for rename service.
TombIDE/TombIDE.ProjectMaster/Services/Level/Import/LevelImportService.cs	New service handling copy/keep import modes + PRJ2 updates + progress.
TombIDE/TombIDE.ProjectMaster/Services/Level/Import/LevelImportResult.cs	Result record for import flow.
TombIDE/TombIDE.ProjectMaster/Services/Level/Import/LevelImportOptions.cs	Options record for import flow.
TombIDE/TombIDE.ProjectMaster/Services/Level/Import/LevelImportMode.cs	Enum for import modes.
TombIDE/TombIDE.ProjectMaster/Services/Level/Import/ILevelImportService.cs	Interface for import service.
TombIDE/TombIDE.ProjectMaster/Services/Level/Compile/LevelCompileService.cs	Namespace refactor for compile service.
TombIDE/TombIDE.ProjectMaster/Services/Level/Compile/ILevelCompileService.cs	Namespace refactor for compile service interface.
TombIDE/TombIDE.ProjectMaster/Services/EngineVersion/IEngineVersionService.cs	Removes embedded `EngineVersionInfo` type (moved out).
TombIDE/TombIDE.ProjectMaster/Services/EngineVersion/EngineVersionService.cs	Refactors version-info creation to use new `EngineVersionInfo` record.
TombIDE/TombIDE.ProjectMaster/Services/EngineVersion/EngineVersionInfo.cs	New record type for engine version status.
TombIDE/TombIDE.ProjectMaster/Sections/SectionLevelList.cs	Wires new services into UI and switches script-lines type to read-only list.
TombIDE/TombIDE.ProjectMaster/LevelManager.cs	Constructs/injects new services into `SectionLevelList`.
TombIDE/TombIDE.ProjectMaster/Forms/FormRenameLevel.cs	Migrates rename logic/UI state to `ILevelRenameService`.
TombIDE/TombIDE.ProjectMaster/Forms/FormLevelSetup.cs	Migrates setup logic to `ILevelSetupService` and shared helpers.
TombIDE/TombIDE.ProjectMaster/Forms/FormImportLevel.cs	Migrates import logic to `ILevelImportService` and adds progress reporting.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

TombIDE/TombIDE.Shared/SharedClasses/ScriptLineGenerator.cs

TombIDE/TombIDE.Shared/IDE.cs

TombIDE/TombIDE.Shared/SharedClasses/ScriptLineGenerator.cs

TombIDE/TombIDE.ProjectMaster/Forms/FormImportLevel.cs

Copilot

Pull request overview

Copilot reviewed 38 out of 38 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

TombIDE/TombIDE.Shared/SharedClasses/ScriptLineGenerator.cs

Copilot

Pull request overview

Copilot reviewed 39 out of 39 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

TombIDE/TombIDE.Shared/SharedClasses/ScriptGenerationResult.cs

TombIDE/TombIDE.ScriptingStudio/LuaStudio.cs

Nickelony · 2026-02-09T20:53:41Z

@copilot Can you please make sure the core features haven't changed with this refactor, and that all affected features still work as they should?

Copilot · 2026-02-09T20:53:50Z

@Nickelony I've opened a new pull request, #1121, to work on those changes. Once the pull request is ready, I'll request review from you.

Co-authored-by: Nickelony <20436882+Nickelony@users.noreply.github.com>

Fix duplicate property declaration in ScriptGenerationResult record

Copilot

Pull request overview

Copilot reviewed 39 out of 39 changed files in this pull request and generated 4 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-09T21:37:48Z

TombIDE/TombIDE.Shared/SharedClasses/ScriptGenerationResult.cs

+	public IReadOnlyList<GeneratedScriptFile> FilesToCreate { get; init; } = [];
+
+	/// <summary>
+	/// Whether any script content was generated.
+	/// </summary>
+	public bool HasContent => GameFlowScript.Length > 0 || LanguageScript.Length > 0;


ScriptGenerationResult.HasContent ignores FilesToCreate, but multiple callers (e.g., ScriptEditor append events) use HasContent to decide whether to process the result at all. This can cause generated files (e.g., new level Lua files) to never be created when scripts are empty but FilesToCreate is not. Consider including FilesToCreate.Count > 0 in HasContent or introducing a separate property that reflects any output (scripts or files).

Copilot · 2026-02-09T21:37:48Z

TombIDE/TombIDE.ScriptingStudio/LuaStudio.cs

+						var collectionNameLine = stringsEditor.Document.Lines.FirstOrDefault(line => regex.IsMatch(stringsEditor.Document.GetText(line).Replace(" ", string.Empty)));

-					string stringsVariableName = regex.Match(stringsEditor.Document.GetText(collectionNameLine)).Groups[1].Value;
+						if (collectionNameLine == null)
+							return;

-					regex = new Regex(@"local\s+" + Regex.Escape(stringsVariableName) + @"\s*=");
-					var stringsStartLine = stringsEditor.Document.Lines.FirstOrDefault(line => regex.IsMatch(stringsEditor.Document.GetText(line)));
+						string stringsVariableName = regex.Match(stringsEditor.Document.GetText(collectionNameLine)).Groups[1].Value;

-					if (stringsStartLine == null)
-						return;
+						regex = new Regex(@"local\s+" + Regex.Escape(stringsVariableName) + @"\s*=");


The early return statements inside the language-file insertion block exit AppendScript without restoring/saving/closing the language tab and without creating result.FilesToCreate. This can leave the editor in an inconsistent state and skip creating generated files. Refactor to avoid returning from the method here (e.g., use a local flag / goto cleanup) so cleanup and file creation still run even when the language insertion can’t be performed.

Copilot · 2026-02-09T21:37:49Z

TombIDE/TombIDE.ScriptingStudio/LuaStudio.cs


-					var openingBrackets = new Stack<char>();
-					DocumentLine stopLine = null;
+						if (stringsStartLine == null)
+							return;



Same issue as above: returning here aborts the rest of AppendScript, skipping tab cleanup and FilesToCreate creation. Prefer breaking out of the language insertion logic and continuing with the rest of the method instead of returning.

Copilot · 2026-02-09T21:37:49Z

TombIDE/TombIDE.ScriptingStudio/LuaStudio.cs

+						if (stopLine == null || !stringsEditor.Document.GetText(stopLine).Trim().Equals("}"))
+							return;


Returning here also aborts the remainder of AppendScript (including file creation and any editor/tab cleanup). Consider handling this as a non-fatal language-insertion failure and continuing to process the rest of the script generation result.

Refactor Level Setup, Import and Rename forms

d2a30ae

Nickelony requested a review from Copilot February 7, 2026 22:20

Copilot started reviewing on behalf of Nickelony February 7, 2026 22:21 View session

Copilot AI reviewed Feb 7, 2026

View reviewed changes

Apply Copilot suggestions

5d62ca4

Nickelony requested a review from Copilot February 8, 2026 22:10

Copilot started reviewing on behalf of Nickelony February 8, 2026 22:11 View session

Copilot AI reviewed Feb 8, 2026

View reviewed changes

TombIDE/TombIDE.Shared/SharedClasses/ScriptLineGenerator.cs Outdated Show resolved Hide resolved

TombIDE/TombIDE.Shared/SharedClasses/ScriptLineGenerator.cs Outdated Show resolved Hide resolved

Refactor script generators

164086d

Nickelony changed the title ~~Refactor Level Setup, Import and Rename forms~~ Refactor Level Setup, Import and Rename forms + Refactor script generators Feb 9, 2026

Nickelony requested a review from Copilot February 9, 2026 17:39

Copilot started reviewing on behalf of Nickelony February 9, 2026 17:40 View session

Copilot AI reviewed Feb 9, 2026

View reviewed changes

TombIDE/TombIDE.Shared/SharedClasses/ScriptGenerationResult.cs Outdated Show resolved Hide resolved

TombIDE/TombIDE.ScriptingStudio/LuaStudio.cs Show resolved Hide resolved

Add missing tab

422e807

Initial plan

4e99b89

Copilot AI mentioned this pull request Feb 9, 2026

Fix duplicate property declaration in ScriptGenerationResult record #1121

Merged

Copilot AI and others added 2 commits February 9, 2026 20:58

Fix duplicate property in ScriptGenerationResult record

83c3a4a

Co-authored-by: Nickelony <20436882+Nickelony@users.noreply.github.com>

Merge pull request #1121 from TombEngine/copilot/sub-pr-1120

b14a5f4

Fix duplicate property declaration in ScriptGenerationResult record

Nickelony requested a review from Copilot February 9, 2026 21:32

Copilot started reviewing on behalf of Nickelony February 9, 2026 21:33 View session

Copilot AI reviewed Feb 9, 2026

View reviewed changes

		if (stopLine == null \|\| !stringsEditor.Document.GetText(stopLine).Trim().Equals("}"))
		return;

Refactor Level Setup, Import and Rename forms + Refactor script generators #1120

Are you sure you want to change the base?

Refactor Level Setup, Import and Rename forms + Refactor script generators #1120

Uh oh!

Conversation

Nickelony commented Feb 7, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Nickelony commented Feb 9, 2026

Uh oh!

Copilot AI commented Feb 9, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants