using Content.Server.Administration.Logs;
using Content.Server.Atmos.Components;
using Content.Server.Atmos.EntitySystems;
using Content.Server.Station.Systems;
using Content.Server.Warps;
using Content.Shared.Database;
using Content.Shared.Examine;
using Content.Shared.Localizations;
using Content.Shared.Maps;
using Content.Shared.Pinpointer;
using JetBrains.Annotations;
using Robust.Shared.Map;
using Robust.Shared.Map.Components;
using Robust.Shared.Timing;
using System.Diagnostics.CodeAnalysis;
namespace Content.Server.Pinpointer;
///
/// Handles data to be used for in-grid map displays.
///
public sealed partial class NavMapSystem : SharedNavMapSystem
{
[Dependency] private readonly IAdminLogManager _adminLog = default!;
[Dependency] private readonly SharedAppearanceSystem _appearance = default!;
[Dependency] private readonly SharedMapSystem _mapSystem = default!;
[Dependency] private readonly SharedTransformSystem _transformSystem = default!;
[Dependency] private readonly IMapManager _mapManager = default!;
[Dependency] private readonly IGameTiming _gameTiming = default!;
[Dependency] private readonly ITileDefinitionManager _tileDefManager = default!;
public const float CloseDistance = 15f;
public const float FarDistance = 30f;
private EntityQuery _airtightQuery;
private EntityQuery _gridQuery;
private EntityQuery _navQuery;
public override void Initialize()
{
base.Initialize();
var categories = Enum.GetNames(typeof(NavMapChunkType)).Length - 1; // -1 due to "Invalid" entry.
if (Categories != categories)
throw new Exception($"{nameof(Categories)} must be equal to the number of chunk types");
_airtightQuery = GetEntityQuery();
_gridQuery = GetEntityQuery();
_navQuery = GetEntityQuery();
// Initialization events
SubscribeLocalEvent(OnStationInit);
// Grid change events
SubscribeLocalEvent(OnNavMapSplit);
SubscribeLocalEvent(OnTileChanged);
SubscribeLocalEvent(OnAirtightChange);
// Beacon events
SubscribeLocalEvent(OnNavMapBeaconMapInit);
SubscribeLocalEvent(OnNavMapBeaconAnchor);
SubscribeLocalEvent(OnConfigureMessage);
SubscribeLocalEvent(OnConfigurableMapInit);
SubscribeLocalEvent(OnConfigurableExamined);
}
private void OnStationInit(StationGridAddedEvent ev)
{
var comp = EnsureComp(ev.GridId);
RefreshGrid(ev.GridId, comp, Comp(ev.GridId));
}
#region: Grid change event handling
private void OnNavMapSplit(ref GridSplitEvent args)
{
if (!_navQuery.TryComp(args.Grid, out var comp))
return;
foreach (var grid in args.NewGrids)
{
var newComp = EnsureComp(grid);
RefreshGrid(grid, newComp, _gridQuery.GetComponent(grid));
}
RefreshGrid(args.Grid, comp, _gridQuery.GetComponent(args.Grid));
}
private NavMapChunk EnsureChunk(NavMapComponent component, Vector2i origin)
{
if (!component.Chunks.TryGetValue(origin, out var chunk))
{
chunk = new(origin);
component.Chunks[origin] = chunk;
}
return chunk;
}
private void OnTileChanged(ref TileChangedEvent ev)
{
if (!ev.EmptyChanged || !_navQuery.TryComp(ev.NewTile.GridUid, out var navMap))
return;
var tile = ev.NewTile.GridIndices;
var chunkOrigin = SharedMapSystem.GetChunkIndices(tile, ChunkSize);
var chunk = EnsureChunk(navMap, chunkOrigin);
// This could be easily replaced in the future to accommodate diagonal tiles
var relative = SharedMapSystem.GetChunkRelative(tile, ChunkSize);
ref var tileData = ref chunk.TileData[GetTileIndex(relative)];
if (ev.NewTile.IsSpace(_tileDefManager))
{
tileData = 0;
if (PruneEmpty((ev.NewTile.GridUid, navMap), chunk))
return;
}
else
{
tileData = FloorMask;
}
DirtyChunk((ev.NewTile.GridUid, navMap), chunk);
}
private void DirtyChunk(Entity entity, NavMapChunk chunk)
{
if (chunk.LastUpdate == _gameTiming.CurTick)
return;
chunk.LastUpdate = _gameTiming.CurTick;
Dirty(entity);
}
private void OnAirtightChange(ref AirtightChanged args)
{
if (args.AirBlockedChanged)
return;
var gridUid = args.Position.Grid;
if (!_navQuery.TryComp(gridUid, out var navMap) ||
!_gridQuery.TryComp(gridUid, out var mapGrid))
{
return;
}
var chunkOrigin = SharedMapSystem.GetChunkIndices(args.Position.Tile, ChunkSize);
var (newValue, chunk) = RefreshTileEntityContents(gridUid, navMap, mapGrid, chunkOrigin, args.Position.Tile, setFloor: false);
if (newValue == 0 && PruneEmpty((gridUid, navMap), chunk))
return;
DirtyChunk((gridUid, navMap), chunk);
}
#endregion
#region: Beacon event handling
private void OnNavMapBeaconMapInit(EntityUid uid, NavMapBeaconComponent component, MapInitEvent args)
{
if (component.DefaultText == null || component.Text != null)
return;
component.Text = Loc.GetString(component.DefaultText);
Dirty(uid, component);
UpdateNavMapBeaconData(uid, component);
}
private void OnNavMapBeaconAnchor(EntityUid uid, NavMapBeaconComponent component, ref AnchorStateChangedEvent args)
{
UpdateBeaconEnabledVisuals((uid, component));
UpdateNavMapBeaconData(uid, component);
}
private void OnConfigureMessage(Entity ent, ref NavMapBeaconConfigureBuiMessage args)
{
if (!TryComp(ent, out var beacon))
return;
if (beacon.Text == args.Text &&
beacon.Color == args.Color &&
beacon.Enabled == args.Enabled)
return;
_adminLog.Add(LogType.Action, LogImpact.Medium,
$"{ToPrettyString(args.Actor):player} configured NavMapBeacon \'{ToPrettyString(ent):entity}\' with text \'{args.Text}\', color {args.Color.ToHexNoAlpha()}, and {(args.Enabled ? "enabled" : "disabled")} it.");
if (TryComp(ent, out var warpPoint))
{
warpPoint.Location = args.Text;
}
beacon.Text = args.Text;
beacon.Color = args.Color;
beacon.Enabled = args.Enabled;
UpdateBeaconEnabledVisuals((ent, beacon));
UpdateNavMapBeaconData(ent, beacon);
}
private void OnConfigurableMapInit(Entity ent, ref MapInitEvent args)
{
if (!TryComp(ent, out var navMap))
return;
// We set this on mapinit just in case the text was edited via VV or something.
if (TryComp(ent, out var warpPoint))
warpPoint.Location = navMap.Text;
UpdateBeaconEnabledVisuals((ent, navMap));
}
private void OnConfigurableExamined(Entity ent, ref ExaminedEvent args)
{
if (!args.IsInDetailsRange || !TryComp(ent, out var navMap))
return;
args.PushMarkup(Loc.GetString("nav-beacon-examine-text",
("enabled", navMap.Enabled),
("color", navMap.Color.ToHexNoAlpha()),
("label", navMap.Text ?? string.Empty)));
}
#endregion
#region: Grid functions
private void RefreshGrid(EntityUid uid, NavMapComponent component, MapGridComponent mapGrid)
{
// Clear stale data
component.Chunks.Clear();
component.Beacons.Clear();
// Refresh beacons
var query = EntityQueryEnumerator();
while (query.MoveNext(out var qUid, out var qNavComp, out var qTransComp))
{
if (qTransComp.ParentUid != uid)
continue;
UpdateNavMapBeaconData(qUid, qNavComp);
}
// Loop over all tiles
var tileRefs = _mapSystem.GetAllTiles(uid, mapGrid);
foreach (var tileRef in tileRefs)
{
var tile = tileRef.GridIndices;
var chunkOrigin = SharedMapSystem.GetChunkIndices(tile, ChunkSize);
var chunk = EnsureChunk(component, chunkOrigin);
chunk.LastUpdate = _gameTiming.CurTick;
RefreshTileEntityContents(uid, component, mapGrid, chunkOrigin, tile, setFloor: true);
}
Dirty(uid, component);
}
private (int NewVal, NavMapChunk Chunk) RefreshTileEntityContents(EntityUid uid,
NavMapComponent component,
MapGridComponent mapGrid,
Vector2i chunkOrigin,
Vector2i tile,
bool setFloor)
{
var relative = SharedMapSystem.GetChunkRelative(tile, ChunkSize);
var chunk = EnsureChunk(component, chunkOrigin);
ref var tileData = ref chunk.TileData[GetTileIndex(relative)];
// Clear all data except for floor bits
if (setFloor)
tileData = FloorMask;
else
tileData &= FloorMask;
var enumerator = _mapSystem.GetAnchoredEntitiesEnumerator(uid, mapGrid, tile);
while (enumerator.MoveNext(out var ent))
{
if (!_airtightQuery.TryComp(ent, out var airtight))
continue;
var category = GetEntityType(ent.Value);
if (category == NavMapChunkType.Invalid)
continue;
var directions = (int)airtight.AirBlockedDirection;
tileData |= directions << (int) category;
}
// Remove walls that intersect with doors (unless they can both physically fit on the same tile)
// TODO NAVMAP why can this even happen?
// Is this for blast-doors or something?
// Shift airlock bits over to the wall bits
var shiftedAirlockBits = (tileData & AirlockMask) >> ((int) NavMapChunkType.Airlock - (int) NavMapChunkType.Wall);
// And then mask door bits
tileData &= ~shiftedAirlockBits;
return (tileData, chunk);
}
private bool PruneEmpty(Entity entity, NavMapChunk chunk)
{
foreach (var val in chunk.TileData)
{
// TODO NAVMAP SIMD
if (val != 0)
return false;
}
entity.Comp.Chunks.Remove(chunk.Origin);
Dirty(entity);
return true;
}
#endregion
#region: Beacon functions
private void UpdateNavMapBeaconData(EntityUid uid, NavMapBeaconComponent component, TransformComponent? xform = null)
{
if (!Resolve(uid, ref xform))
return;
if (xform.GridUid == null)
return;
if (!_navQuery.TryComp(xform.GridUid, out var navMap))
return;
var meta = MetaData(uid);
var changed = navMap.Beacons.Remove(meta.NetEntity);
if (TryCreateNavMapBeaconData(uid, component, xform, meta, out var beaconData))
{
navMap.Beacons.Add(meta.NetEntity, beaconData.Value);
changed = true;
}
if (changed)
Dirty(xform.GridUid.Value, navMap);
}
private void UpdateBeaconEnabledVisuals(Entity ent)
{
_appearance.SetData(ent, NavMapBeaconVisuals.Enabled, ent.Comp.Enabled && Transform(ent).Anchored);
}
///
/// Sets the beacon's Enabled field and refreshes the grid.
///
public void SetBeaconEnabled(EntityUid uid, bool enabled, NavMapBeaconComponent? comp = null)
{
if (!Resolve(uid, ref comp) || comp.Enabled == enabled)
return;
comp.Enabled = enabled;
UpdateBeaconEnabledVisuals((uid, comp));
}
///
/// Toggles the beacon's Enabled field and refreshes the grid.
///
public void ToggleBeacon(EntityUid uid, NavMapBeaconComponent? comp = null)
{
if (!Resolve(uid, ref comp))
return;
SetBeaconEnabled(uid, !comp.Enabled, comp);
}
///
/// For a given position, tries to find the nearest configurable beacon that is marked as visible.
/// This is used for things like announcements where you want to find the closest "landmark" to something.
///
[PublicAPI]
public bool TryGetNearestBeacon(Entity ent,
[NotNullWhen(true)] out Entity? beacon,
[NotNullWhen(true)] out MapCoordinates? beaconCoords)
{
beacon = null;
beaconCoords = null;
if (!Resolve(ent, ref ent.Comp))
return false;
return TryGetNearestBeacon(_transformSystem.GetMapCoordinates(ent, ent.Comp), out beacon, out beaconCoords);
}
///
/// For a given position, tries to find the nearest configurable beacon that is marked as visible.
/// This is used for things like announcements where you want to find the closest "landmark" to something.
///
public bool TryGetNearestBeacon(MapCoordinates coordinates,
[NotNullWhen(true)] out Entity? beacon,
[NotNullWhen(true)] out MapCoordinates? beaconCoords)
{
beacon = null;
beaconCoords = null;
var minDistance = float.PositiveInfinity;
var query = EntityQueryEnumerator();
while (query.MoveNext(out var uid, out _, out var navBeacon, out var xform))
{
if (!navBeacon.Enabled)
continue;
if (navBeacon.Text == null)
continue;
if (coordinates.MapId != xform.MapID)
continue;
var coords = _transformSystem.GetWorldPosition(xform);
var distanceSquared = (coordinates.Position - coords).LengthSquared();
if (!float.IsInfinity(minDistance) && distanceSquared >= minDistance)
continue;
minDistance = distanceSquared;
beacon = (uid, navBeacon);
beaconCoords = new MapCoordinates(coords, xform.MapID);
}
return beacon != null;
}
///
/// Returns a string describing the rough distance and direction
/// to the position of from the nearest beacon.
///
[PublicAPI]
public string GetNearestBeaconString(Entity ent)
{
if (!Resolve(ent, ref ent.Comp))
return Loc.GetString("nav-beacon-pos-no-beacons");
return GetNearestBeaconString(_transformSystem.GetMapCoordinates(ent, ent.Comp));
}
///
/// Returns a string describing the rough distance and direction
/// to from the nearest beacon.
///
public string GetNearestBeaconString(MapCoordinates coordinates)
{
if (!TryGetNearestBeacon(coordinates, out var beacon, out var pos))
return Loc.GetString("nav-beacon-pos-no-beacons");
var gridOffset = Angle.Zero;
if (_mapManager.TryFindGridAt(pos.Value, out var grid, out _))
gridOffset = Transform(grid).LocalRotation;
// get the angle between the two positions, adjusted for the grid rotation so that
// we properly preserve north in relation to the grid.
var offset = coordinates.Position - pos.Value.Position;
var dir = offset.ToWorldAngle();
var adjustedDir = (dir - gridOffset).GetDir();
var length = offset.Length();
if (length < CloseDistance)
{
return Loc.GetString("nav-beacon-pos-format",
("color", beacon.Value.Comp.Color),
("marker", beacon.Value.Comp.Text!));
}
var modifier = length > FarDistance
? Loc.GetString("nav-beacon-pos-format-direction-mod-far")
: string.Empty;
// we can null suppress the text being null because TryGetNearestVisibleStationBeacon always gives us a beacon with not-null text.
return Loc.GetString("nav-beacon-pos-format-direction",
("modifier", modifier),
("direction", ContentLocalizationManager.FormatDirection(adjustedDir).ToLowerInvariant()),
("color", beacon.Value.Comp.Color),
("marker", beacon.Value.Comp.Text!));
}
#endregion
}