Skip to content

Add BUI helper overloads supporting constructor parameters #6311

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
B-Kirill wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add BUI helper overloads supporting constructor parameters #6311

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
129 changes: 118 additions & 11 deletions Robust.Client/UserInterface/BoundUserInterfaceExt.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,33 @@ namespace Robust.Client.UserInterface;

public static class BoundUserInterfaceExt
{
private static T GetWindow<T>(BoundUserInterface bui) where T : BaseWindow, new()
/// <summary>
/// Internal method to create a window with default constructor and register it with the BUI system.
/// </summary>
private static T GetWindow<T>(BoundUserInterface bui, UserInterfaceSystem system) where T : BaseWindow, new()
{
var window = bui.CreateDisposableControl<T>();

window.OnClose += bui.Close;
var system = bui.EntMan.System<UserInterfaceSystem>();
system.RegisterControl(bui, window);

return window;
}

/// <summary>
/// Internal method to create a window with constructor parameters and register it with the BUI system.
/// </summary>
private static T GetWindow<T>(BoundUserInterface bui, object[] args, UserInterfaceSystem system) where T : BaseWindow, IDisposable
{
var window = (T?)Activator.CreateInstance(typeof(T), args)
?? throw new InvalidOperationException($"Failed to create window of type {typeof(T)}");

window.OnClose += bui.Close;
system.RegisterControl(bui, window);

bui.Disposals ??= [];
bui.Disposals.Add(window);

return window;
}

Expand All @@ -21,9 +42,31 @@ public static class BoundUserInterfaceExt
/// </summary>
public static T CreateWindow<T>(this BoundUserInterface bui) where T : BaseWindow, new()
{
var window = GetWindow<T>(bui);
var system = bui.EntMan.System<UserInterfaceSystem>();
var window = GetWindow<T>(bui, system);

if (system.TryGetPosition(bui.Owner, bui.UiKey, out var position))
{
window.Open(position);
}
else
{
window.OpenCentered();
}

return window;
}

/// <summary>
/// Helper method to create a window with constructor parameters and also handle closing the BUI when it's closed.
/// </summary>
/// <param name="args">Arguments to pass to the window constructor.</param>
public static T CreateWindow<T>(this BoundUserInterface bui, params object[] args) where T : BaseWindow, IDisposable
{
var system = bui.EntMan.System<UserInterfaceSystem>();
var window = GetWindow<T>(bui, args, system);

if (bui.EntMan.System<UserInterfaceSystem>().TryGetPosition(bui.Owner, bui.UiKey, out var position))
if (system.TryGetPosition(bui.Owner, bui.UiKey, out var position))
{
window.Open(position);
}
Expand All @@ -35,11 +78,36 @@ public static class BoundUserInterfaceExt
return window;
}

/// <summary>
/// Creates a window centered to the left.
/// </summary>
public static T CreateWindowCenteredLeft<T>(this BoundUserInterface bui) where T : BaseWindow, new()
{
var window = GetWindow<T>(bui);
var system = bui.EntMan.System<UserInterfaceSystem>();
var window = GetWindow<T>(bui, system);

if (system.TryGetPosition(bui.Owner, bui.UiKey, out var position))
{
window.Open(position);
}
else
{
window.OpenCenteredLeft();
}

return window;
}

/// <summary>
/// Creates a window centered to the left with constructor parameters.
/// </summary>
/// <param name="args">Arguments to pass to the window constructor.</param>
public static T CreateWindowCenteredLeft<T>(this BoundUserInterface bui, params object[] args) where T : BaseWindow, IDisposable
{
var system = bui.EntMan.System<UserInterfaceSystem>();
var window = GetWindow<T>(bui, args, system);

if (bui.EntMan.System<UserInterfaceSystem>().TryGetPosition(bui.Owner, bui.UiKey, out var position))
if (system.TryGetPosition(bui.Owner, bui.UiKey, out var position))
{
window.Open(position);
}
Expand All @@ -51,11 +119,36 @@ public static class BoundUserInterfaceExt
return window;
}

/// <summary>
/// Creates a window centered to the right.
/// </summary>
public static T CreateWindowCenteredRight<T>(this BoundUserInterface bui) where T : BaseWindow, new()
{
var window = GetWindow<T>(bui);
var system = bui.EntMan.System<UserInterfaceSystem>();
var window = GetWindow<T>(bui, system);

if (system.TryGetPosition(bui.Owner, bui.UiKey, out var position))
{
window.Open(position);
}
else
{
window.OpenCenteredRight();
}

return window;
}

/// <summary>
/// Creates a window centered to the right with constructor parameters.
/// </summary>
/// <param name="args">Arguments to pass to the window constructor.</param>
public static T CreateWindowCenteredRight<T>(this BoundUserInterface bui, params object[] args) where T : BaseWindow, IDisposable
{
var system = bui.EntMan.System<UserInterfaceSystem>();
var window = GetWindow<T>(bui, args, system);

if (bui.EntMan.System<UserInterfaceSystem>().TryGetPosition(bui.Owner, bui.UiKey, out var position))
if (system.TryGetPosition(bui.Owner, bui.UiKey, out var position))
{
window.Open(position);
}
Expand All @@ -70,14 +163,28 @@ public static class BoundUserInterfaceExt
/// <summary>
/// Creates a control for this BUI that will be disposed when it is disposed.
/// </summary>
/// <param name="bui"></param>
/// <typeparam name="T"></typeparam>
/// <returns></returns>
public static T CreateDisposableControl<T>(this BoundUserInterface bui) where T : Control, IDisposable, new()
{
var control = new T();

bui.Disposals ??= [];
bui.Disposals.Add(control);

return control;
}

/// <summary>
/// Creates a control for this BUI with constructor parameters that will be disposed when it is disposed.
/// </summary>
/// <param name="args">Arguments to pass to the control constructor.</param>
public static T CreateDisposableControl<T>(this BoundUserInterface bui, params object[] args) where T : Control, IDisposable
{
var control = (T?)Activator.CreateInstance(typeof(T), args)
?? throw new InvalidOperationException($"Failed to create control of type {typeof(T)}");

bui.Disposals ??= [];
bui.Disposals.Add(control);

return control;
}
}
Loading