Navmap Warp #31653

Errant-4 · 2024-08-30T18:54:53Z

About the PR

Specific entities can now teleport using a navmap (or any navmap-inheritors such as the Crew Monitor)
Simply Alt-Click (Alternate Activate Item In World) on the map screen, and you are teleported to that location

Why / Balance

The AI Eye and aghosts can now get around the station more easily and quickly. A case could be made that regular ghosts should also be given some sort of navmap and this power, but currently only aghosts and AI Eyes are allowed.
#31543 asked for AI Ghost Warp

Technical details

Upon the specified input, client calculates the global coordinates at the cursor, gets the player's current entity, and sends a network event to the server. Server checks for the required component that allows warp, replaces the requesting entity with it's EyeComponent.Target if there was one, then teleports the entity to the specified location. There are no collision checks due to everything that is expected to use this being incorporeal

There is also no limit to where this can go, by scrolling the map away from the station any arbitrary distance can theoretically be reached. I don't know why anyone would do that. This creates a "stuck" state since there is no Crew Monitor available offgrid, but an AI's Go Home ability or GhostWarp can bring the player back to the station.

Media

original video
https://github.com/user-attachments/assets/0752a807-b410-402c-a6ba-3c14ac3a8a24

Now with a sound effect to better communicate to the brain "something happened"

warpsound.mp4

Requirements

I have read and I am following the Pull Request Guidelines. I understand that not doing so may get my pr closed at maintainer’s discretion
I have added screenshots/videos to this PR showcasing its changes ingame, or this PR does not require an ingame showcase

Changelog

🆑 Errant

add: The AI Eye can now teleport to any location on the station by Alt-Clicking on the Crew Monitor map.

Everturning · 2024-08-30T18:58:23Z

does it also teleport to crew? could work as a temporary "follow on cameras" before the actual one

ScarKy0 · 2024-08-30T19:01:34Z

Oh my god I love this
Once this gets merged the crew monitor just needs a search bar to look for specific people and thats basically AI warping done

Errant-4 · 2024-08-30T19:03:59Z

does it also teleport to crew? could work as a temporary "follow on cameras" before the actual one

It can only teleport to location, so if you want to teleport to a certain crewmember you have to click on the crewmember's list entry to filter to their dot on the map, locate it visually, then teleport to that location

ScarKy0 · 2024-08-30T19:05:50Z

It can only teleport to location, so if you want to teleport to a certain crewmember you have to click on the crewmember's list entry to filter to their dot on the map, locate it visually, then teleport to that location

Any chance a "Search" field could be added to the crew monitor then? Or is that for an entirely different PR?

Errant-4 · 2024-08-30T19:07:14Z

It can only teleport to location, so if you want to teleport to a certain crewmember you have to click on the crewmember's list entry to filter to their dot on the map, locate it visually, then teleport to that location

Any chance a "Search" field could be added to the crew monitor then? Or is that for an entirely different PR?

I might look into that, but on a different PR

ScarKy0 · 2024-08-30T19:08:12Z

I might look into that, but on a different PR

I see, looking forward to it!

Errant-4 · 2024-09-01T17:46:54Z

Updated with a sound effect for the warp

Errant-4 · 2024-09-02T08:08:42Z

I'm starting to hear that there is some sort of "pop" in one of the three static samples that can play, I might swap out that one for an alternate

nymhole · 2024-09-04T01:13:24Z

you should allow the map to have an adjustable size, WHEN DOES THIS MERGE. i guess it merges when ai can use crew monitor correctly?

metalgearsloth

I think this should just be stationmap only / a dedicated control rather than diluting other ones with functionality, especially because if you accidentally misclick on power or whatever it can be annoying. I've asked other maints for their opinion on it.

Also this needs a do_after to mask the pop-in because it will be pretty bad on live (live entity counts are significantly higher than dev).

Content.Shared/Maps/NavMapWarpComponent.cs

Content.Shared/Pinpointer/SharedNavMapSystem.cs

metalgearsloth · 2024-09-11T09:14:29Z

Content.Shared/Pinpointer/SharedNavMapSystem.cs

+    public void RequestWarpTo(EntityUid uid, Vector2 target)
+    {
+        var message = new MapWarpRequest(GetNetEntity(uid), target);
+        RaiseNetworkEvent(message);
+    }
+
+    private void OnMapWarp(MapWarpRequest args)
+    {
+        var uid = GetEntity(args.Uid);
+
+        // This was only tested with the AI Eye but should theoretically work with any other future remote-controlled things
+        if (TryComp<EyeComponent>(uid, out var eye) && eye.Target is not null)
+            uid = eye.Target.Value;
+
+        if (!TryComp<NavMapWarpComponent>(uid, out var warpComp))
+            return;
+
+        var xform = Transform(uid);
+
+        if (xform.MapUid is null)
+            return;
+
+        var index = _random.Next(warpComp.Sounds.Count);
+        _audio.PlayGlobal(warpComp.Sounds[index],
+            GetEntity(args.Uid),
+            AudioParams.Default.WithVariation(warpComp.PitchVariation));
+
+        // This was designed for incorporeal entities, thus there aren't any collision checks or anything
+        _transformSystem.SetCoordinates(uid, xform, new EntityCoordinates(xform.MapUid.Value, args.Target));
+        _transformSystem.AttachToGridOrMap(uid, xform);
+    }
+


I think you're better off just making it a BUI event so it gets validation done.

Also the audio should be predicted instead. Also don't do multiple transformsystem calls as it will double the amount of moveevents that get raised which are extremely expensive, just set the position once. Use PlaceAt or the likes.

Audio is now predicted. I have removed the AttachToGridOrMap call entirely, because it does not actually seem to bee needed at all (it was mostly just skipped by checks anyway).

There is now also a 2 second "cooldown" on warps so they can't be spammed

ScarKy0 · 2024-09-11T11:22:41Z

@metalgearsloth

I think this should just be stationmap only / a dedicated control rather than diluting other ones with functionality

I think it shouldnt be stationmap, at least a crew monitor so you can see where the people requesting you are, stationmap doesnt tell you anything about whoever calls you to do anything

Content.Shared/Pinpointer/MapWarpRequest.cs

github-actions · 2024-09-17T10:01:06Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

chromiumboy · 2024-10-16T21:40:45Z

I agree with Sloth about using a BUI event for initiating the warp request, rather than calling the method directly from the client

Also, regarding the point Sloth raised on the Discord discussion, you really should consider using ViewSubscriberSystem.AddViewSubscriber to get PVS updates from the area prior to warping in. Just use RemoveViewSubscriber when your finished warping

Otherwise the code looks good to me, tested fine

github-actions · 2024-10-23T14:35:13Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

github-actions · 2024-11-25T12:56:12Z

This pull request has conflicts, please resolve those before we can evaluate the pull request.

Niomi0 · 2025-01-29T20:57:55Z

Please merge this. Pleaseeee!!!!

navmap warp

4f468d1

Errant-4 requested a review from DrSmugleaf as a code owner August 30, 2024 18:54

github-actions bot added the S: Needs Review Status: Requires additional reviews before being fully accepted label Aug 30, 2024

Errant-4 added 2 commits August 30, 2024 21:14

Merge branch 'master' into mapwarp

96ab268

navmap warp sound

a78ee9d

Errant-4 added 2 commits September 4, 2024 14:07

minor audio adjustment

3f192f0

Merge branch 'master' into mapwarp

725b84f

TheShuEd mentioned this pull request Sep 10, 2024

Gate map #32032

Merged

16 tasks

metalgearsloth requested changes Sep 11, 2024

View reviewed changes

metalgearsloth added S: Awaiting Changes Status: Changes are required before another review can happen and removed S: Needs Review Status: Requires additional reviews before being fully accepted labels Sep 11, 2024

slarticodefast added the S: Undergoing Maintainer Discussion Status: Currently going through an extended discussion amongst maintainers, as per procedure. label Sep 11, 2024

soundspecifier

2b65827

de0rix reviewed Sep 14, 2024

View reviewed changes

Content.Shared/Pinpointer/MapWarpRequest.cs Outdated Show resolved Hide resolved

github-actions bot added the S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted label Sep 17, 2024

Errant-4 added 4 commits September 17, 2024 15:58

Merge branch 'master' into mapwarp

8c90bfe

predicted audio

fd4770d

mono sounds

de36b49

remove redundant transform call

83e5a12

Errant-4 added 2 commits September 26, 2024 16:51

rename MapWarpRequest

86ad241

warp cooldown

d730c68

github-actions bot removed the S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted label Sep 26, 2024

github-actions bot added the S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted label Oct 23, 2024

SlamBamActionman added the S: Untriaged Status: Indicates an item has not been triaged and doesn't have appropriate labels. label Nov 14, 2024

github-actions bot added the Merge Conflict label Nov 25, 2024

Merge branch 'master' into mapwarp

4a3d8e5

github-actions bot added size/M Denotes a PR that changes 100-999 lines. Changes: Audio Changes: Might require knowledge of audio. and removed S: Merge Conflict Status: Needs to resolve merge conflicts before it can be accepted labels Dec 18, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Navmap Warp #31653

Navmap Warp #31653

Errant-4 commented Aug 30, 2024 •

edited

Loading

Everturning commented Aug 30, 2024

ScarKy0 commented Aug 30, 2024

Errant-4 commented Aug 30, 2024 •

edited

Loading

ScarKy0 commented Aug 30, 2024

Errant-4 commented Aug 30, 2024

ScarKy0 commented Aug 30, 2024

Errant-4 commented Sep 1, 2024

Errant-4 commented Sep 2, 2024 •

edited

Loading

nymhole commented Sep 4, 2024

metalgearsloth left a comment

metalgearsloth Sep 11, 2024

Errant-4 Sep 26, 2024

ScarKy0 commented Sep 11, 2024

github-actions bot commented Sep 17, 2024

chromiumboy commented Oct 16, 2024 •

edited

Loading

github-actions bot commented Oct 23, 2024

github-actions bot commented Nov 25, 2024

Niomi0 commented Jan 29, 2025

Navmap Warp #31653

Are you sure you want to change the base?

Navmap Warp #31653

Conversation

Errant-4 commented Aug 30, 2024 • edited Loading

About the PR

Why / Balance

Technical details

Media

Requirements

Everturning commented Aug 30, 2024

ScarKy0 commented Aug 30, 2024

Errant-4 commented Aug 30, 2024 • edited Loading

ScarKy0 commented Aug 30, 2024

Errant-4 commented Aug 30, 2024

ScarKy0 commented Aug 30, 2024

Errant-4 commented Sep 1, 2024

Errant-4 commented Sep 2, 2024 • edited Loading

nymhole commented Sep 4, 2024

metalgearsloth left a comment

Choose a reason for hiding this comment

metalgearsloth Sep 11, 2024

Choose a reason for hiding this comment

Errant-4 Sep 26, 2024

Choose a reason for hiding this comment

ScarKy0 commented Sep 11, 2024

github-actions bot commented Sep 17, 2024

chromiumboy commented Oct 16, 2024 • edited Loading

github-actions bot commented Oct 23, 2024

github-actions bot commented Nov 25, 2024

Niomi0 commented Jan 29, 2025

Errant-4 commented Aug 30, 2024 •

edited

Loading

Errant-4 commented Aug 30, 2024 •

edited

Loading

Errant-4 commented Sep 2, 2024 •

edited

Loading

chromiumboy commented Oct 16, 2024 •

edited

Loading