Skip to content

Bugfix: SharedUserInterfaceSystem stores and applies BUI states in order. #6829

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

Merged
Princess-Cheeseballs merged 8 commits into from
Jul 23, 2026
Merged

Bugfix: SharedUserInterfaceSystem stores and applies BUI states in order. #6829

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
7f60b75
store intermediate bui states
whatston3 Jul 20, 2026
a3e35b2
exception printout, remove redundant check
whatston3 Jul 20, 2026
a89986f
Set state on Open
whatston3 Jul 20, 2026
30ac87b
trygetvalue defaults, you dingus
whatston3 Jul 20, 2026
8333a49
fix string interpolation bug
whatston3 Jul 20, 2026
8d8f637
queue in SetUiState
whatston3 Jul 22, 2026
59430ab
queue in SetUiState regardless
whatston3 Jul 22, 2026
32456aa
TryGetValue->GetValueOrDefault
whatston3 Jul 23, 2026
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
40 changes: 17 additions & 23 deletions Robust.Shared/GameObjects/Systems/SharedUserInterfaceSystem.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ private enum QueuedUpdate
/// <summary>
/// Defer BUIs during state handling so client doesn't spam a BUI constantly during prediction.
/// </summary>
private readonly List<(BoundUserInterface bui, QueuedUpdate updateType)> _queuedBuis = new();
private readonly List<(BoundUserInterface bui, QueuedUpdate updateType, BoundUserInterfaceState? state)> _queuedBuis = new();

public override void Initialize()
{
Expand Down Expand Up @@ -91,9 +91,9 @@ public override void Initialize()
SubscribeLocalEvent<UserInterfaceUserComponent, ComponentShutdown>(OnActorShutdown);
}

private void AddQueued(BoundUserInterface bui, QueuedUpdate type)
private void AddQueued(BoundUserInterface bui, QueuedUpdate type, BoundUserInterfaceState? state = null)
{
_queuedBuis.Add((bui, type));
_queuedBuis.Add((bui, type, state));
}

/// <summary>
Expand Down Expand Up @@ -292,7 +292,8 @@ private void OnUserInterfaceStartup(Entity<UserInterfaceComponent> ent, ref Comp
// PlayerAttachedEvent will catch some of these.
foreach (var (key, bui) in ent.Comp.ClientOpenInterfaces)
{
AddQueued(bui, QueuedUpdate.Open);
var state = ent.Comp.States.GetValueOrDefault(key);
AddQueued(bui, QueuedUpdate.Open, state);
}
}

Expand All @@ -312,7 +313,7 @@ protected void OnUserInterfaceShutdown(Entity<UserInterfaceComponent> ent, ref C
DebugTools.Assert(!ent.Comp.Actors.ContainsKey(key));
}

DebugTools.Assert(ent.Comp.ClientOpenInterfaces.Values.All(x => _queuedBuis.Contains((x, QueuedUpdate.Close))));
DebugTools.Assert(ent.Comp.ClientOpenInterfaces.Values.All(x => _queuedBuis.Contains((x, QueuedUpdate.Close, null))));
}

private void OnUserInterfaceGetState(Entity<UserInterfaceComponent> ent, ref ComponentGetState args)
Expand Down Expand Up @@ -500,7 +501,7 @@ private void OnUserInterfaceHandleState(Entity<UserInterfaceComponent> ent, ref
if (!ent.Comp.ClientOpenInterfaces.TryGetValue(key, out var cBui) || !cBui.IsOpened)
continue;

AddQueued(cBui, QueuedUpdate.ApplyState);
AddQueued(cBui, QueuedUpdate.ApplyState, buiState);
}
}

Expand Down Expand Up @@ -528,7 +529,7 @@ private void EnsureClientBui(Entity<UserInterfaceComponent> entity, Enum key, In
// Existing BUI just keep it.
if (entity.Comp.ClientOpenInterfaces.TryGetValue(key, out var existing))
{
_queuedBuis.Remove((existing, QueuedUpdate.Close));
_queuedBuis.Remove((existing, QueuedUpdate.Close, null));
return;
}

Expand Down Expand Up @@ -764,11 +765,7 @@ public void SetUiState(Entity<UserInterfaceComponent?> entity, Enum key, BoundUs
// Predict the change on client
if (state != null && _netManager.IsClient && entity.Comp.ClientOpenInterfaces.TryGetValue(key, out var bui))
{
if (bui.State?.Equals(state) != true)
{
bui.UpdateState(state);
bui.Update();
}
AddQueued(bui, QueuedUpdate.ApplyState, state);
}

DirtyField(entity, nameof(UserInterfaceComponent.States));
Expand Down Expand Up @@ -1110,7 +1107,7 @@ public override void Update(float frameTime)
{
if (_timing.IsFirstTimePredicted)
{
foreach (var (bui, updateType) in _queuedBuis)
foreach (var (bui, updateType, state) in _queuedBuis)
{
if (updateType == QueuedUpdate.Open || updateType == QueuedUpdate.ApplyState)
{
Expand All @@ -1123,26 +1120,23 @@ public override void Update(float frameTime)
bui.Open();
}

if (UIQuery.TryComp(bui.Owner, out var uiComp))
if (state != null)
{
if (uiComp.States.TryGetValue(bui.UiKey, out var buiState))
{
bui.State = buiState;
bui.UpdateState(buiState);
bui.Update();
}
bui.State = state;
bui.UpdateState(state);
bui.Update();
}
#if EXCEPTION_TOLERANCE
}
catch (Exception e)
{
var operationType = updateType == QueuedUpdate.Open ? "create" : "update";
Log.Error(
$"Caught exception while attempting to create a BUI {bui.UiKey} with type {bui.GetType()} on entity {ToPrettyString(bui.Owner)}. Exception: {e}");
$"Caught exception while attempting to {operationType} a BUI {bui.UiKey} with type {bui.GetType()} on entity {ToPrettyString(bui.Owner)}. Exception: {e}");
}
#endif
}
// Close BUI
else
else // Close BUI
{
if (UIQuery.TryComp(bui.Owner, out var uiComp))
{
Expand Down
Loading