Add a wait time for the rules popup (#5823)

* Create new rules popup

* Implement accept and quit buttons

* Add rules accept timer

Forces the player to read the rules by making them wait.

Speed reading the rules took me just under 45 seconds which means it'll take longer than that if someone's reading this for the first time.

* Fix info rules header

* Change _rulesPopup to local variable
This commit is contained in:
ShadowCommander
2021-12-24 17:32:33 -08:00
committed by GitHub
parent 944b4fb073
commit be6cb75122
10 changed files with 167 additions and 19 deletions

View File

@@ -43,7 +43,7 @@ namespace Content.Client.Info
private void PopulateRules(Info rulesList)
{
AddSection(rulesList, Loc.GetString("ui-info-header-rules"), "Rules.txt", true);
AddSection(rulesList, Loc.GetString("ui-rules-header"), "Rules.txt", true);
}
private void PopulateTutorial(Info tutorialList)

View File

@@ -0,0 +1,6 @@
<BoxContainer xmlns="https://spacestation14.io"
Name="InfoContainer"
Orientation="Vertical"
Margin="2 2 0 0"
SeparationOverride="10"
Access="Public"/>

View File

@@ -0,0 +1,23 @@
using Robust.Client.AutoGenerated;
using Robust.Client.ResourceManagement;
using Robust.Client.UserInterface.Controls;
using Robust.Client.UserInterface.XAML;
using Robust.Shared.IoC;
using Robust.Shared.Localization;
namespace Content.Client.Info;
[GenerateTypedNameReferences]
public partial class RulesControl : BoxContainer
{
[Dependency] private readonly IResourceCache _resourceManager = default!;
public RulesControl()
{
RobustXamlLoader.Load(this);
IoCManager.InjectDependencies(this);
AddChild(new InfoSection(Loc.GetString("ui-rules-header"),
_resourceManager.ContentFileReadAllText($"/Server Info/Rules.txt"), true));
}
}

View File

@@ -1,10 +1,11 @@
using System;
using System.Globalization;
using System.IO;
using Content.Client.Lobby;
using Content.Client.Viewport;
using Content.Shared.CCVar;
using Robust.Client.Console;
using Robust.Client.State;
using Robust.Client.UserInterface;
using Robust.Shared.Configuration;
using Robust.Shared.ContentPack;
using Robust.Shared.IoC;
@@ -16,9 +17,9 @@ public sealed class RulesManager
{
[Dependency] private readonly IResourceManager _resource = default!;
[Dependency] private readonly IConfigurationManager _configManager = default!;
[Dependency] private readonly IUserInterfaceManager _userInterfaceManager = default!;
[Dependency] private readonly IStateManager _stateManager = default!;
public event Action? OpenRulesAndInfoWindow;
[Dependency] private readonly IClientConsoleHost _consoleHost = default!;
public void Initialize()
{
@@ -39,8 +40,10 @@ public sealed class RulesManager
else
SaveLastReadTime();
if (showRules)
OpenRulesAndInfoWindow?.Invoke();
if (!showRules)
return;
ShowRules(_configManager.GetCVar(CCVars.RulesWaitTime));
}
/// <summary>
@@ -52,4 +55,25 @@ public sealed class RulesManager
sw.Write(DateTime.UtcNow.ToUniversalTime());
}
private void ShowRules(float time)
{
var rulesPopup = new RulesPopup
{
Timer = time
};
rulesPopup.OnQuitPressed += OnQuitPressed;
rulesPopup.OnAcceptPressed += OnAcceptPressed;
_userInterfaceManager.RootControl.AddChild(rulesPopup);
}
private void OnQuitPressed()
{
_consoleHost.ExecuteCommand("quit");
}
private void OnAcceptPressed()
{
SaveLastReadTime();
}
}

View File

@@ -0,0 +1,24 @@
<Control xmlns="https://spacestation14.io"
xmlns:parallax="clr-namespace:Content.Client.Parallax"
xmlns:info="clr-namespace:Content.Client.Info"
VerticalExpand="True" HorizontalExpand="True"
MouseFilter="Stop">
<parallax:ParallaxControl />
<Control VerticalExpand="True"
MaxWidth="650">
<PanelContainer StyleClasses="windowPanel" />
<ScrollContainer HScrollEnabled="False">
<BoxContainer Orientation="Vertical" SeparationOverride="10">
<info:RulesControl />
<Label Name="WaitLabel" />
<BoxContainer Orientation="Horizontal">
<Button Name="AcceptButton"
Text="{Loc 'ui-rules-accept'}"
Disabled="True" />
<Button Name="QuitButton"
Text="{Loc 'ui-escape-quit'}" />
</BoxContainer>
</BoxContainer>
</ScrollContainer>
</Control>
</Control>

View File

@@ -0,0 +1,69 @@
using System;
using Robust.Client.AutoGenerated;
using Robust.Client.UserInterface;
using Robust.Client.UserInterface.Controls;
using Robust.Client.UserInterface.XAML;
using Robust.Shared.Localization;
using Robust.Shared.Timing;
namespace Content.Client.Info;
[GenerateTypedNameReferences]
public partial class RulesPopup : Control
{
private float _timer;
public float Timer
{
get => _timer;
set
{
WaitLabel.Text = Loc.GetString("ui-rules-wait", ("time", MathF.Floor(value)));
_timer = value;
}
}
public event Action? OnQuitPressed;
public event Action? OnAcceptPressed;
public RulesPopup()
{
RobustXamlLoader.Load(this);
AcceptButton.OnPressed += OnAcceptButtonPressed;
QuitButton.OnPressed += OnQuitButtonPressed;
}
private void OnQuitButtonPressed(BaseButton.ButtonEventArgs obj)
{
OnQuitPressed?.Invoke();
Dispose();
}
private void OnAcceptButtonPressed(BaseButton.ButtonEventArgs obj)
{
Parent?.RemoveChild(this);
OnAcceptPressed?.Invoke();
Dispose();
}
protected override void FrameUpdate(FrameEventArgs args)
{
base.FrameUpdate(args);
if (!AcceptButton.Disabled)
return;
if (Timer > 0.0)
{
if (Timer - args.DeltaSeconds < 0)
Timer = 0;
else
Timer -= args.DeltaSeconds;
}
else
{
AcceptButton.Disabled = false;
}
}
}