--- /dev/null
+<Control
+ xmlns="https://spacestation14.io"
+ xmlns:viewport="clr-namespace:Content.Client.Viewport"
+ MouseFilter="Stop">
+ <PanelContainer StyleClasses="BackgroundDark" Name="AdminCameraWindowRoot" Access="Public">
+ <BoxContainer Orientation="Vertical" Access="Public">
+ <!-- Camera -->
+ <Control VerticalExpand="True" Name="CameraViewBox">
+ <viewport:ScalingViewport Name="CameraView"
+ MinSize="100 100"
+ MouseFilter="Ignore" />
+ </Control>
+ <!-- Controller buttons -->
+ <BoxContainer Orientation="Horizontal" Margin="5 5 5 5">
+ <Button StyleClasses="OpenRight" Name="FollowButton" HorizontalExpand="True" Access="Public" Text="{Loc 'admin-camera-window-follow'}" />
+ <Button StyleClasses="OpenLeft" Name="PopControl" HorizontalExpand="True" Access="Public" Text="{Loc 'admin-camera-window-pop-out'}" />
+ </BoxContainer>
+ </BoxContainer>
+ </PanelContainer>
+</Control>
--- /dev/null
+using System.Numerics;
+using Content.Client.Eye;
+using Content.Shared.Administration;
+using Robust.Client.AutoGenerated;
+using Robust.Client.Graphics;
+using Robust.Client.Timing;
+using Robust.Client.UserInterface;
+using Robust.Client.UserInterface.XAML;
+using Robust.Shared.Timing;
+
+namespace Content.Client.Administration.UI.AdminCamera;
+
+[GenerateTypedNameReferences]
+public sealed partial class AdminCameraControl : Control
+{
+ [Dependency] private readonly IEntityManager _entManager = default!;
+ [Dependency] private readonly IClientGameTiming _timing = default!;
+
+ public event Action? OnFollow;
+ public event Action? OnPopoutControl;
+
+ private readonly EyeLerpingSystem _eyeLerpingSystem;
+ private readonly FixedEye _defaultEye = new();
+ private AdminCameraEuiState? _nextState;
+
+ private const float MinimumZoom = 0.1f;
+ private const float MaximumZoom = 2.0f;
+
+ public EntityUid? CurrentCamera;
+ public float Zoom = 1.0f;
+
+ public bool IsPoppedOut;
+
+ public AdminCameraControl()
+ {
+ RobustXamlLoader.Load(this);
+ IoCManager.InjectDependencies(this);
+
+ _eyeLerpingSystem = _entManager.System<EyeLerpingSystem>();
+
+ CameraView.Eye = _defaultEye;
+
+ FollowButton.OnPressed += _ => OnFollow?.Invoke();
+ PopControl.OnPressed += _ => OnPopoutControl?.Invoke();
+ CameraView.OnResized += OnResized;
+ }
+
+ private new void OnResized()
+ {
+ var width = Math.Max(CameraView.PixelWidth, (int)Math.Floor(CameraView.MinWidth));
+ var height = Math.Max(CameraView.PixelHeight, (int)Math.Floor(CameraView.MinHeight));
+
+ CameraView.ViewportSize = new Vector2i(width, height);
+ }
+
+ protected override void MouseWheel(GUIMouseWheelEventArgs args)
+ {
+ base.MouseWheel(args);
+
+ if (CameraView.Eye == null)
+ return;
+
+ Zoom = Math.Clamp(Zoom - args.Delta.Y * 0.15f * Zoom, MinimumZoom, MaximumZoom);
+ CameraView.Eye.Zoom = new Vector2(Zoom, Zoom);
+ args.Handle();
+ }
+
+ public void SetState(AdminCameraEuiState state)
+ {
+ _nextState = state;
+ }
+
+ // I know that this is awful, but I copied this from the solution editor anyways.
+ // This is needed because EUIs update before the gamestate is applied, which means it will fail to get the uid from the net entity.
+ // The suggestion from the comment in the solution editor saying to use a BUI is not ideal either:
+ // - We would need to bind the UI to an entity, but with how BUIs currently work we cannot open it in the same tick as we spawn that entity on the server.
+ // - We want the UI opened by the user session, not by their currently attached entity. Otherwise it would close in cases where admins move from one entity to another, for example when ghosting.
+ protected override void FrameUpdate(FrameEventArgs args)
+ {
+ if (_nextState == null || _timing.LastRealTick < _nextState.Tick) // make sure the last gamestate has been applied
+ return;
+
+ if (!_entManager.TryGetEntity(_nextState.Camera, out var cameraUid))
+ return;
+
+ if (CurrentCamera == null)
+ {
+ _eyeLerpingSystem.AddEye(cameraUid.Value);
+ CurrentCamera = cameraUid;
+ }
+ else if (CurrentCamera != cameraUid)
+ {
+ _eyeLerpingSystem.RemoveEye(CurrentCamera.Value);
+ _eyeLerpingSystem.AddEye(cameraUid.Value);
+ CurrentCamera = cameraUid;
+ }
+
+ if (_entManager.TryGetComponent<EyeComponent>(CurrentCamera, out var eye))
+ CameraView.Eye = eye.Eye ?? _defaultEye;
+ }
+}
--- /dev/null
+using System.Numerics;
+using Content.Client.Eui;
+using Content.Shared.Administration;
+using Content.Shared.Eui;
+using JetBrains.Annotations;
+using Robust.Client.UserInterface.Controls;
+
+namespace Content.Client.Administration.UI.AdminCamera;
+
+/// <summary>
+/// Admin Eui for opening a viewport window to observe entities.
+/// Use the "Open Camera" admin verb or the "camera" command to open.
+/// </summary>
+[UsedImplicitly]
+public sealed partial class AdminCameraEui : BaseEui
+{
+ private readonly AdminCameraWindow _window;
+ private readonly AdminCameraControl _control;
+
+ // If not null the camera is in "popped out" mode and is in an external window.
+ private OSWindow? _OSWindow;
+
+ // The last location the window was located at in game.
+ // Is used for getting knowing where to "pop in" external windows.
+ private Vector2 _lastLocation;
+
+ public AdminCameraEui()
+ {
+ _window = new AdminCameraWindow();
+ _control = new AdminCameraControl();
+
+ _window.Contents.AddChild(_control);
+
+ _control.OnFollow += () => SendMessage(new AdminCameraFollowMessage());
+ _window.OnClose += () =>
+ {
+ if (!_control.IsPoppedOut)
+ SendMessage(new CloseEuiMessage());
+ };
+
+ _control.OnPopoutControl += () =>
+ {
+ if (_control.IsPoppedOut)
+ PopIn();
+ else
+ PopOut();
+ };
+ }
+
+ // Pop the window out into an external OS window
+ private void PopOut()
+ {
+ _lastLocation = _window.Position;
+
+ // TODO: When there is a way to have a minimum window size, enforce something!
+ _OSWindow = new OSWindow
+ {
+ SetSize = _window.Size,
+ Title = _window.Title ?? Loc.GetString("admin-camera-window-title-placeholder"),
+ };
+
+ _OSWindow.Show();
+
+ if (_OSWindow.Root == null)
+ return;
+
+ _control.Orphan();
+ _OSWindow.Root.AddChild(_control);
+
+ _OSWindow.Closed += () =>
+ {
+ if (_control.IsPoppedOut)
+ SendMessage(new CloseEuiMessage());
+ };
+
+ _control.IsPoppedOut = true;
+ _control.PopControl.Text = Loc.GetString("admin-camera-window-pop-in");
+
+ _window.Close();
+ }
+
+ // Pop the window back into the in game window.
+ private void PopIn()
+ {
+ _control.Orphan();
+ _window.Contents.AddChild(_control);
+
+ _window.Open(_lastLocation);
+
+ _control.IsPoppedOut = false;
+ _control.PopControl.Text = Loc.GetString("admin-camera-window-pop-out");
+
+ _OSWindow?.Close();
+ _OSWindow = null;
+ }
+
+ public override void Opened()
+ {
+ base.Opened();
+ _window.OpenCentered();
+ }
+
+ public override void Closed()
+ {
+ base.Closed();
+ _window.Close();
+ }
+
+ public override void HandleState(EuiStateBase baseState)
+ {
+ if (baseState is not AdminCameraEuiState state)
+ return;
+
+ _window.SetState(state);
+ _control.SetState(state);
+ }
+}
--- /dev/null
+<DefaultWindow xmlns="https://spacestation14.io"
+ Title="{Loc admin-camera-window-title-placeholder}"
+ SetSize="425 550"
+ MinSize="200 225"
+ Name="Window">
+</DefaultWindow>
--- /dev/null
+using Content.Shared.Administration;
+using Robust.Client.AutoGenerated;
+using Robust.Client.UserInterface.CustomControls;
+using Robust.Client.UserInterface.XAML;
+
+namespace Content.Client.Administration.UI.AdminCamera;
+
+[GenerateTypedNameReferences]
+public sealed partial class AdminCameraWindow : DefaultWindow
+{
+ public AdminCameraWindow()
+ {
+ RobustXamlLoader.Load(this);
+ IoCManager.InjectDependencies(this);
+
+ ContentsContainer.Margin = new Thickness(5, 0, 5, 0);
+ }
+
+ public void SetState(AdminCameraEuiState state)
+ {
+ Title = Loc.GetString("admin-camera-window-title", ("name", state.Name));
+ }
+}
<Button Name="FreezeAndMuteToggleButton" Text="{Loc player-panel-freeze-and-mute}" Disabled="True"/>
<Button Name="BanButton" Text="{Loc player-panel-ban}" Disabled="True"/>
<controls:ConfirmButton Name="RejuvenateButton" Text="{Loc player-panel-rejuvenate}" Disabled="True"/>
+ <Button Name="CameraButton" Text="{Loc player-panel-camera}" Disabled="True"/>
</GridContainer>
</BoxContainer>
</BoxContainer>
public event Action<NetUserId?>? OnOpenBans;
public event Action<NetUserId?>? OnAhelp;
public event Action<string?>? OnKick;
+ public event Action<string?>? OnCamera;
public event Action<NetUserId?>? OnOpenBanPanel;
public event Action<NetUserId?, bool>? OnWhitelistToggle;
public event Action? OnFollow;
public PlayerPanel(IClientAdminManager adminManager)
{
- RobustXamlLoader.Load(this);
- _adminManager = adminManager;
-
- UsernameCopyButton.OnPressed += _ => OnUsernameCopy?.Invoke(TargetUsername ?? "");
- BanButton.OnPressed += _ => OnOpenBanPanel?.Invoke(TargetPlayer);
- KickButton.OnPressed += _ => OnKick?.Invoke(TargetUsername);
- NotesButton.OnPressed += _ => OnOpenNotes?.Invoke(TargetPlayer);
- ShowBansButton.OnPressed += _ => OnOpenBans?.Invoke(TargetPlayer);
- AhelpButton.OnPressed += _ => OnAhelp?.Invoke(TargetPlayer);
- WhitelistToggle.OnPressed += _ =>
- {
- OnWhitelistToggle?.Invoke(TargetPlayer, _isWhitelisted);
- SetWhitelisted(!_isWhitelisted);
- };
- FollowButton.OnPressed += _ => OnFollow?.Invoke();
- FreezeButton.OnPressed += _ => OnFreeze?.Invoke();
- FreezeAndMuteToggleButton.OnPressed += _ => OnFreezeAndMuteToggle?.Invoke();
- LogsButton.OnPressed += _ => OnLogs?.Invoke();
- DeleteButton.OnPressed += _ => OnDelete?.Invoke();
- RejuvenateButton.OnPressed += _ => OnRejuvenate?.Invoke();
+ RobustXamlLoader.Load(this);
+ _adminManager = adminManager;
+
+ UsernameCopyButton.OnPressed += _ => OnUsernameCopy?.Invoke(TargetUsername ?? "");
+ BanButton.OnPressed += _ => OnOpenBanPanel?.Invoke(TargetPlayer);
+ KickButton.OnPressed += _ => OnKick?.Invoke(TargetUsername);
+ CameraButton.OnPressed += _ => OnCamera?.Invoke(TargetUsername);
+ NotesButton.OnPressed += _ => OnOpenNotes?.Invoke(TargetPlayer);
+ ShowBansButton.OnPressed += _ => OnOpenBans?.Invoke(TargetPlayer);
+ AhelpButton.OnPressed += _ => OnAhelp?.Invoke(TargetPlayer);
+ WhitelistToggle.OnPressed += _ =>
+ {
+ OnWhitelistToggle?.Invoke(TargetPlayer, _isWhitelisted);
+ SetWhitelisted(!_isWhitelisted);
+ };
+ FollowButton.OnPressed += _ => OnFollow?.Invoke();
+ FreezeButton.OnPressed += _ => OnFreeze?.Invoke();
+ FreezeAndMuteToggleButton.OnPressed += _ => OnFreezeAndMuteToggle?.Invoke();
+ LogsButton.OnPressed += _ => OnLogs?.Invoke();
+ DeleteButton.OnPressed += _ => OnDelete?.Invoke();
+ RejuvenateButton.OnPressed += _ => OnRejuvenate?.Invoke();
}
public void SetUsername(string player)
{
BanButton.Disabled = !_adminManager.CanCommand("banpanel");
KickButton.Disabled = !_adminManager.CanCommand("kick");
+ CameraButton.Disabled = !_adminManager.CanCommand("camera");
NotesButton.Disabled = !_adminManager.CanCommand("adminnotes");
ShowBansButton.Disabled = !_adminManager.CanCommand("banlist");
WhitelistToggle.Disabled =
[Dependency] private readonly IClientAdminManager _admin = default!;
[Dependency] private readonly IClipboardManager _clipboard = default!;
- private PlayerPanel PlayerPanel { get; }
+ private PlayerPanel PlayerPanel { get; }
public PlayerPanelEui()
{
PlayerPanel.OnOpenNotes += id => _console.ExecuteCommand($"adminnotes \"{id}\"");
// Kick command does not support GUIDs
PlayerPanel.OnKick += username => _console.ExecuteCommand($"kick \"{username}\"");
+ PlayerPanel.OnCamera += username => _console.ExecuteCommand($"camera \"{username}\"");
PlayerPanel.OnOpenBanPanel += id => _console.ExecuteCommand($"banpanel \"{id}\"");
PlayerPanel.OnOpenBans += id => _console.ExecuteCommand($"banlist \"{id}\"");
PlayerPanel.OnAhelp += id => _console.ExecuteCommand($"openahelp \"{id}\"");
PlayerPanel.OnFreeze += () => SendMessage(new PlayerPanelFreezeMessage());
PlayerPanel.OnLogs += () => SendMessage(new PlayerPanelLogsMessage());
PlayerPanel.OnRejuvenate += () => SendMessage(new PlayerPanelRejuvenationMessage());
- PlayerPanel.OnDelete+= () => SendMessage(new PlayerPanelDeleteMessage());
+ PlayerPanel.OnDelete += () => SendMessage(new PlayerPanelDeleteMessage());
PlayerPanel.OnFollow += () => SendMessage(new PlayerPanelFollowMessage());
PlayerPanel.OnClose += () => SendMessage(new CloseEuiMessage());
--- /dev/null
+using Content.Server.Administration.UI;
+using Content.Server.EUI;
+using Content.Shared.Administration;
+using Robust.Server.Player;
+using Robust.Shared.Console;
+
+namespace Content.Server.Administration.Commands;
+
+[AdminCommand(AdminFlags.Admin)]
+public sealed class CameraCommand : LocalizedCommands
+{
+ [Dependency] private readonly EuiManager _eui = default!;
+ [Dependency] private readonly IEntityManager _entManager = default!;
+ [Dependency] private readonly IPlayerManager _playerManager = default!;
+
+ public override string Command => "camera";
+
+ public override void Execute(IConsoleShell shell, string argStr, string[] args)
+ {
+ if (shell.Player is not { } user)
+ {
+ shell.WriteError(Loc.GetString("shell-cannot-run-command-from-server"));
+ return;
+ }
+
+ if (args.Length != 1)
+ {
+ shell.WriteError(Loc.GetString("shell-wrong-arguments-number"));
+ return;
+ }
+
+ if (!NetEntity.TryParse(args[0], out var targetNetId) || !_entManager.TryGetEntity(targetNetId, out var targetUid))
+ {
+ if (!_playerManager.TryGetSessionByUsername(args[0], out var player)
+ || player.AttachedEntity == null)
+ {
+ shell.WriteError(Loc.GetString("cmd-camera-wrong-argument"));
+ return;
+ }
+ targetUid = player.AttachedEntity.Value;
+ }
+
+ var ui = new AdminCameraEui(targetUid.Value);
+ _eui.OpenEui(ui, user);
+ }
+
+ public override CompletionResult GetCompletion(IConsoleShell shell, string[] args)
+ {
+ if (args.Length == 1)
+ {
+ return CompletionResult.FromHintOptions(
+ CompletionHelper.SessionNames(players: _playerManager),
+ Loc.GetString("cmd-camera-hint"));
+ }
+
+ return CompletionResult.Empty;
+ }
+}
Icon = new SpriteSpecifier.Rsi(new ResPath("/Textures/Interface/Actions/actions_borg.rsi"), "state-laws"),
});
}
+
+ // open camera
+ args.Verbs.Add(new Verb()
+ {
+ Priority = 10,
+ Text = Loc.GetString("admin-verbs-camera"),
+ Message = Loc.GetString("admin-verbs-camera-description"),
+ Icon = new SpriteSpecifier.Texture(new("/Textures/Interface/VerbIcons/vv.svg.192dpi.png")),
+ Category = VerbCategory.Admin,
+ Act = () =>
+ {
+ var ui = new AdminCameraEui(args.Target);
+ _euiManager.OpenEui(ui, player);
+ },
+ Impact = LogImpact.Low
+ });
}
}
--- /dev/null
+using Content.Server.Administration.Managers;
+using Content.Server.EUI;
+using Content.Shared.Administration;
+using Content.Shared.Eui;
+using Content.Shared.Follower;
+using Content.Shared.Coordinates;
+using Robust.Server.GameStates;
+using Robust.Shared.Player;
+using Robust.Shared.Prototypes;
+using Robust.Shared.Timing;
+using JetBrains.Annotations;
+
+namespace Content.Server.Administration.UI;
+
+/// <summary>
+/// Admin Eui for opening a viewport window to observe entities.
+/// Use the "Open Camera" admin verb or the "camera" command to open.
+/// </summary>
+[UsedImplicitly]
+public sealed partial class AdminCameraEui : BaseEui
+{
+ [Dependency] private readonly IAdminManager _admin = default!;
+ [Dependency] private readonly IEntityManager _entityManager = default!;
+ [Dependency] private readonly IGameTiming _timing = default!;
+
+ private readonly FollowerSystem _follower = default!;
+ private readonly PvsOverrideSystem _pvs = default!;
+ private readonly SharedViewSubscriberSystem _viewSubscriber = default!;
+
+ private static readonly EntProtoId CameraProtoId = "AdminCamera";
+
+ private readonly EntityUid _target;
+ private EntityUid? _camera;
+
+
+ public AdminCameraEui(EntityUid target)
+ {
+ IoCManager.InjectDependencies(this);
+ _follower = _entityManager.System<FollowerSystem>();
+ _pvs = _entityManager.System<PvsOverrideSystem>();
+ _viewSubscriber = _entityManager.System<SharedViewSubscriberSystem>();
+
+ _target = target;
+ }
+
+ public override void Opened()
+ {
+ base.Opened();
+
+ _camera = CreateCamera(_target, Player);
+ StateDirty();
+ }
+
+ public override void Closed()
+ {
+ base.Closed();
+
+ _entityManager.DeleteEntity(_camera);
+ }
+
+ public override void HandleMessage(EuiMessageBase msg)
+ {
+ base.HandleMessage(msg);
+
+ switch (msg)
+ {
+ case AdminCameraFollowMessage:
+ if (!_admin.HasAdminFlag(Player, AdminFlags.Admin) || Player.AttachedEntity == null)
+ return;
+ _follower.StartFollowingEntity(Player.AttachedEntity.Value, _target);
+ break;
+ default:
+ break;
+ }
+ }
+
+ public override EuiStateBase GetNewState()
+ {
+ var name = _entityManager.GetComponent<MetaDataComponent>(_target).EntityName;
+ var netEnt = _entityManager.GetNetEntity(_camera);
+ return new AdminCameraEuiState(netEnt, name, _timing.CurTick);
+ }
+
+ private EntityUid CreateCamera(EntityUid target, ICommonSession observer)
+ {
+ // Spawn a camera entity attached to the target.
+ var coords = target.ToCoordinates();
+ var camera = _entityManager.SpawnAttachedTo(CameraProtoId, coords);
+
+ // Allow the user to see the entities near the camera.
+ // This also force sends the camera entity to the user, overriding the visibility flags.
+ // (The camera entity has its visibility flags set to VisibilityFlags.Admin so that cheat clients can't see it)
+ _viewSubscriber.AddViewSubscriber(camera, observer);
+
+ return camera;
+ }
+}
--- /dev/null
+using Content.Shared.Eui;
+using Robust.Shared.Serialization;
+using Robust.Shared.Timing;
+
+namespace Content.Shared.Administration;
+
+[Serializable, NetSerializable]
+public sealed partial class AdminCameraEuiState(NetEntity? camera, string name, GameTick tick) : EuiStateBase
+{
+ /// <summary>
+ /// The camera entity we will use for the window.
+ /// </summary>
+ public readonly NetEntity? Camera = camera;
+
+ /// <summary>
+ /// The name of the observed entity.
+ /// </summary>
+ public readonly string Name = name;
+
+ /// <summary>
+ /// The current tick time, needed for cursed reasons.
+ /// </summary>
+ public readonly GameTick Tick = tick;
+}
+
+[Serializable, NetSerializable]
+public sealed partial class AdminCameraFollowMessage : EuiMessageBase;
[FlagsFor(typeof(VisibilityMaskLayer))]
public enum VisibilityFlags : int
{
- None = 0,
+ None = 0,
Normal = 1 << 0,
- Ghost = 1 << 1,
- Subfloor = 1 << 2,
+ Ghost = 1 << 1, // Observers and revenants.
+ Subfloor = 1 << 2, // Pipes, disposal chutes, cables etc. while hidden under tiles. Can be revealed with a t-ray.
+ Admin = 1 << 3, // Reserved for admins in stealth mode and admin tools.
}
}
/// <param name="entity">The entity to be followed</param>
public void StartFollowingEntity(EntityUid follower, EntityUid entity)
{
+ if (follower == entity || TerminatingOrDeleted(entity))
+ return;
+
// No recursion for you
var targetXform = Transform(entity);
while (targetXform.ParentUid.IsValid())
admin-verbs-freeze = Freeze
admin-verbs-freeze-and-mute = Freeze And Mute
admin-verbs-unfreeze = Unfreeze
+admin-verbs-camera = Open Camera
+admin-verbs-camera-description = Open a camera window that follows the selected entity.
admin-verbs-erase = Erase
admin-verbs-erase-description = Removes the player from the round and crew manifest and deletes their chat messages.
Their items are dropped on the ground.
--- /dev/null
+cmd-camera-desc = Opens a remote camera window for an entity.
+cmd-camera-help = Usage: camera <entityUid or player>
+
+cmd-camera-hint = <entityUid or player>
+cmd-camera-wrong-argument = Argument must be a valid netUid or a player name.
--- /dev/null
+admin-camera-window-title = Observing { $name }
+admin-camera-window-title-placeholder = Observing
+admin-camera-window-follow = Follow
+admin-camera-window-pop-out = Pop out
+admin-camera-window-pop-in = Pop in
player-panel-false = False
player-panel-true = True
player-panel-follow = Follow
+player-panel-camera = Camera
--- /dev/null
+# dummy entity for the admin camera EUI
+# this gets parented to the person being observed
+
+- type: entity
+ id: AdminCamera
+ categories: [ HideSpawnMenu ]
+ name: admin camera
+ description: We are watching you.
+ components:
+ - type: Visibility
+ layer: 8 # Don't network this to anyone so cheat clients can't see it. We are adding a PVS override to the user.
+ - type: Eye # for the camera itself
+ drawFov: false
+ pvsScale: 0.8 # we don't need the full range
projects / space-station-14.git / commitdiff