Station AI ability to electricute doors #32012

Fildrance · 2024-09-09T17:28:52Z

About the PR

AI now have ability to electrify airlocks.
AI now have ability to set door to EmergencyAccess (yellow-lights-door).
AI now have better feedback on actions with airlocks: new icons for radial menu, sound effects

Why / Balance

AI can now help low-pop crew by setting some non-critical doors to emergency-access, enabling people to access medical self-care without breaking law (and doors).
AI can have quite harmful laws but it doesn't have any way to implement them. Electrifying doors is first step how AI can dominate human race and show who is master of the station (in not entirely gamebreaking way).

Technical details

ElectrifiedComponent was moved to shared to indicate is it On/Off for AI actions radial menu. It is marked dirty on IsEnabled change, logic was not transferred to shared.
SharedAirlockSystem.ToggleEmergencyAccess was changed to SetEmergencyAccess so AI commands can be more predictable.

Media

device_not_responding.1.mp4

bolt_showcase.mp4

overcharge_showcase.mp4

ai_wire_showcase.mp4

Requirements

I have read and am following the Pull Request and Changelog Guidelines.
I have added media to this PR or it does not require an ingame showcase.

Breaking changes

none

Changelog

🆑 Fildrance, ScarKy0

add: AI now can electrify doors and set them to emergency access. Setting door to emergency access will now play sound effect for everyone around, while electrifying door will play sound effect only for AI
fix: AI will now be notified when trying to interact with door without power or when respective wires were messed up with

…ract with door

…system

github-actions · 2024-09-09T17:29:26Z

RSI Diff Bot; head commit c1f9f60 merging into 2a6f15d
This PR makes changes to 1 or more RSIs. Here is a summary of all changes:

Resources/Textures/Interface/Actions/actions_ai.rsi

State	Old	New	Status
bolt_door			Added
door_overcharge_off			Added
door_overcharge_on			Added
emergency_off			Added
emergency_on			Added
unbolt_door			Added

Edit: diff updated after c1f9f60

ScarKy0 · 2024-09-09T17:38:21Z

Hype

Resources/Textures/Interface/Actions/actions_ai.rsi/electrify_door.png

Resources/Textures/Interface/Actions/actions_ai.rsi/unelectrify_door.png

Resources/Textures/Interface/Actions/actions_ai.rsi/meta.json

ScarKy0 · 2024-09-09T17:47:01Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Airlock.cs


 namespace Content.Shared.Silicons.StationAi;

 public abstract partial class SharedStationAiSystem
 {
+    private static readonly SoundPathSpecifier AirlockOverchargeDisabled = new("/Audio/Machines/airlock_overcharge_on.ogg");


Couldnt you put those in the component or would that break things?

Not sure where to put this. Maybe maint will propose good ideas. AirlockComponent is not used in this code path, ElectrifyComponent - well, fine but its still wierd... its only hear-able to AI.

If it's only hear-able to AI, maybe put specifiers into AI Core or Held? It would allow change audio paths in prototypes...

@metalgearsloth what do you think about moving this to HeldComponent example? sounds a bit sus

This should be wherever stuff is electrified, also don't call it "overcharge" because it's just confusing what it's for.

Fildrance · 2024-09-09T18:09:32Z

Resources/Textures/Interface/Actions/actions_ai.rsi/meta.json

+			"name": "unelectrify_door"
+		},
+		{
+			"name": "door_overcharge_on"


New ones are CC0-1.0 by ScarKy0, don't really know how to add this info to license and copyright! :(

inserted new files and mention side-by-side... folder fits too well...

…th door which have wire cut

JIPDawg · 2024-09-10T20:51:48Z

Headphone warning for the Airhorn when electrifying the door. Ouch. My only complaints are the sound made when electrifying the door, why a airhorn? I also still don't like the sound for Emergency access either. Just my 2 cents.

ScarKy0 · 2024-09-10T21:25:21Z

Headphone warning for the Airhorn when electrifying the door. Ouch. My only complaints are the sound made when electrifying the door, why a airhorn? I also still don't like the sound for Emergency access either. Just my 2 cents.

Its mostly due to the quality of the clips, i believe

metalgearsloth · 2024-09-11T03:47:47Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.cs

+    [Dependency] private   readonly SharedElectrocutionSystem _electrify = default!;
+    [Dependency] private   readonly SharedAirlockSystem _airlocks = default!;
    [Dependency] private   readonly SharedEyeSystem _eye = default!;
    [Dependency] protected readonly SharedMapSystem Maps = default!;
    [Dependency] private readonly SharedMindSystem _mind = default!;
    [Dependency] private   readonly SharedMoverController _mover = default!;
    [Dependency] private   readonly SharedTransformSystem _xforms = default!;
    [Dependency] private   readonly SharedUserInterfaceSystem _uiSystem = default!;
    [Dependency] private   readonly StationAiVisionSystem _vision = default!;
+    [Dependency] private readonly SharedPopupSystem _popup = default!;
+    [Dependency] protected readonly SharedPowerReceiverSystem PowerReceiver = default!;
+    [Dependency] private readonly SharedAudioSystem _audio = default!;


Alphabetical and follow format of the existing stuff please I beg.

fine, but it was not me who started it (39 line by original file)

not 100% sure what u wanted but i sorted it all by field names.

metalgearsloth · 2024-09-11T03:48:42Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Held.cs

+        var verb = new AlternativeVerb
        {
            Text = isOpen ? Loc.GetString("ai-close") : Loc.GetString("ai-open"),
            Act = () =>
            {
+                // no need to show menu if device is not powered.
+                SharedApcPowerReceiverComponent? component = null;
+                if (PowerReceiver.ResolveApc(ent.Owner, ref component) && !component.Powered)
+                {
+                    _popup.PopupClient(Loc.GetString("ai-device-not-responding"), user, PopupType.MediumCaution);
+                    return;
+                }
+


Please do not hardcode in devices here, it's supposed to be generic. Use an event or anything else.

I swear PowerReceiver.IsPowered was throwing exception... but now i tested it and it works fine for all cases. Oh well...

metalgearsloth · 2024-09-11T03:52:23Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Airlock.cs

+    private void OnElectrified(EntityUid ent, ElectrifiedComponent component, StationAiElectrifiedEvent args)
+    {
+        if (!TryComp<ElectrifiedComponent>(ent, out var electrified)
+            || !TryComp<StationAiWhitelistComponent>(ent, out var whiteList))
+        {
+            return;
+        }
+
+        SharedApcPowerReceiverComponent? apcPowerReceiverComponent = null;
+        if (
+            !whiteList.Enabled
+            || electrified.IsWireCut
+            || (
+                PowerReceiver.ResolveApc(ent, ref apcPowerReceiverComponent)
+                && !apcPowerReceiverComponent.Powered
+                )
+        )
+        {


Whitelist comp gets handled in the BUI attempt event, having to check this manually every single time is bug prone and shouldn't be done.

Just add the whitelist enabled check to it.

i'll send popup from there, ye. It checks out pretty well.

metalgearsloth · 2024-09-11T03:52:35Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Airlock.cs

+            : AirlockOverchargeEnabled;
+        _audio.PlayEntity(soundToPlay, args.User, ent);


Use the predicted version this isn't predicted.

metalgearsloth · 2024-09-11T03:53:49Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Airlock.cs

+
+        if (!whiteList.Enabled || !component.Powered)
+        {
+            _popup.PopupClient(Loc.GetString("ai-device-not-responding"), args.User, PopupType.MediumCaution);
+            return;
+        }
+


AirlockComponent.Powered is obsolete please don't use it.

used PowerReceiver.IsPowered instead. we might need to mark it obsolete and remove related code btw... its really misleading...

is it true for bolts component?

fixed, and used PowerReceiver system

metalgearsloth · 2024-09-11T03:54:35Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Airlock.cs

+
+        if (!whiteList.Enabled || component.BoltWireCut || !component.Powered)
+        {
+            _popup.PopupClient(Loc.GetString("ai-device-not-responding"), args.User, PopupType.MediumCaution);
+            return;
+        }
+


The latter 3 checks should be handled via a setbolts overload not here because other callers will forget to do this.

Enabled as mentioned should be handled in the BUI message attempt.

Need to add TrySetBolt to send popup in case it fails

…ctricute-for-real

Content.Client/Silicons/StationAi/StationAiSystem.Airlock.cs

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Held.cs

Fildrance · 2024-09-12T13:38:55Z

Updated media with cool (and more up to date) video from ScarKy0

…/closing when ai wire was cut

ScarKy0

Looks fine to me

metalgearsloth · 2024-09-16T12:15:09Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Held.cs

+            || !HasComp<StationAiHeldComponent>(args.User)
+            || !HasComp<StationAiWhitelistComponent>(args.Target))


I think this whitelist check is unneeded?

It is, i belive, currently overlapping with OnHeldInteraction, but i'm not 100% sure it covers every possible scenario

Seemed good when i tested it - so i removed condition check duplication!

metalgearsloth · 2024-09-16T12:16:12Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Held.cs

+        StationAiWhitelistComponent? whitelistComponent = null;
        if (TryComp(ev.Actor, out StationAiHeldComponent? aiComp) &&
           (!ValidateAi((ev.Actor, aiComp)) ||
-            !HasComp<StationAiWhitelistComponent>(ev.Target)))
+            !TryComp(ev.Target, out whitelistComponent)))
        {
            ev.Cancel();


Just inline the component no reason to leave it separate.

you mean - use one block? and always call ShowDeviceNotRespondingPopup? this doesn't sound right - popup is kinda bound to whitelistComponent is { Enabled: false } scenario - there is no reason to show it if ai is not valid or we have no StationAiHeldComponent comp

I cannot inline declaration because then declaration (which is required in the next lines) will be optional (based on previous conditions eval) and code won't compile :(

And i don't want popup spam on every click! :/ so i want popup in separate condition... otherwise it will spam popup on every click, anywhere (walls included).

It absolutely will compile, the only reason it won't is if you don't get the component out of it, just adjust the if statement for it.

metalgearsloth · 2024-09-16T12:16:38Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Airlock.cs

+    private void OnElectrified(EntityUid ent, ElectrifiedComponent component, StationAiElectrifiedEvent args)
+    {
+        if (!TryComp<ElectrifiedComponent>(ent, out var electrified))
+        {
+            return;
+        }
+


This component is doubled.

metalgearsloth · 2024-09-21T05:55:56Z

Content.Server/Electrocution/ElectrocutionSystem.cs

+
+    public void SetElectrifiedWireCut(Entity<ElectrifiedComponent> ent, bool value)
+    {
+        ent.Comp.IsWireCut = value;


You should guard these values behind equals checks to avoid dirtying if the value hasn't changed because dirtying is expensive.

metalgearsloth · 2024-09-21T05:56:08Z

Content.Shared/Doors/Components/AirlockComponent.cs

+
+    /// <summary>
+    /// Sound to play when the airlock emergency access is turned on.
+    /// </summary>
+    [DataField, ViewVariables(VVAccess.ReadWrite)]
+    public SoundSpecifier EmergencyOnSound = new SoundPathSpecifier("/Audio/Machines/airlock_emergencyon.ogg");
+
+    /// <summary>
+    /// Sound to play when the airlock emergency access is turned off.
+    /// </summary>
+    [DataField, ViewVariables(VVAccess.ReadWrite)]
+    public SoundSpecifier EmergencyOffSound = new SoundPathSpecifier("/Audio/Machines/airlock_emergencyoff.ogg");


VVRW is redundant with datafield.

metalgearsloth · 2024-09-21T06:02:25Z

Content.Shared/Doors/Systems/SharedAirlockSystem.cs

+
+        var sound = ent.Comp.EmergencyAccess ? ent.Comp.EmergencyOnSound : ent.Comp.EmergencyOffSound;
+        if (predicted)
+            Audio.PlayPredicted(sound, ent, user: user);
+        else
+            Audio.PlayPvs(sound, ent);
    }


Do any of the callers even need this? This method is new...

AdminVerbSystem uses non-predicted version. is that wrong?

metalgearsloth · 2024-09-21T06:06:13Z

Content.Shared/Electrocution/SharedElectrocutionSystem.cs

+        /// <summary>
+        /// Sets electrified value of component and marks dirty if required.
+        /// </summary>
+        public void SetElectrified(Entity<ElectrifiedComponent> ent, bool value)
+        {
+            var oldValue = ent.Comp.Enabled;
+            ent.Comp.Enabled = value;
+            if (value != oldValue)
+            {
+                Dirty(ent, ent.Comp);
+            }
+        }


You did it here but also this is written in a weird way, just check if the values are the same before assigning (not sure if the JIT even accounts for this?)

metalgearsloth · 2024-09-21T06:07:01Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Airlock.cs


 namespace Content.Shared.Silicons.StationAi;

 public abstract partial class SharedStationAiSystem
 {
+    private static readonly SoundPathSpecifier AirlockOverchargeDisabled = new("/Audio/Machines/airlock_overcharge_on.ogg");


This should be wherever stuff is electrified, also don't call it "overcharge" because it's just confusing what it's for.

metalgearsloth · 2024-09-21T06:08:11Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Held.cs

+        StationAiWhitelistComponent? whitelistComponent = null;
        if (TryComp(ev.Actor, out StationAiHeldComponent? aiComp) &&
           (!ValidateAi((ev.Actor, aiComp)) ||
-            !HasComp<StationAiWhitelistComponent>(ev.Target)))
+            !TryComp(ev.Target, out whitelistComponent)))
        {
            ev.Cancel();


It absolutely will compile, the only reason it won't is if you don't get the component out of it, just adjust the if statement for it.

metalgearsloth · 2024-09-21T06:08:43Z

Content.Shared/Silicons/StationAi/SharedStationAiSystem.cs

    [Dependency] private   readonly ISharedAdminManager _admin = default!;
-    [Dependency] private   readonly IGameTiming _timing = default!;
-    [Dependency] private   readonly INetManager _net = default!;
-    [Dependency] private   readonly ItemSlotsSystem _slots = default!;
-    [Dependency] private   readonly ItemToggleSystem _toggles = default!;
-    [Dependency] private   readonly ActionBlockerSystem _blocker = default!;
-    [Dependency] private   readonly MetaDataSystem _metadata = default!;
+    [Dependency] private   readonly SharedAirlockSystem _airlocks = default!;
    [Dependency] private   readonly SharedAppearanceSystem _appearance = default!;
+    [Dependency] private   readonly SharedAudioSystem _audio = default!;
+    [Dependency] private   readonly ActionBlockerSystem _blocker = default!;
    [Dependency] private   readonly SharedContainerSystem _containers = default!;
    [Dependency] private   readonly SharedDoorSystem _doors = default!;
+    [Dependency] private   readonly SharedElectrocutionSystem _electrify = default!;
    [Dependency] private   readonly SharedEyeSystem _eye = default!;
-    [Dependency] protected readonly SharedMapSystem Maps = default!;
-    [Dependency] private readonly SharedMindSystem _mind = default!;
+    [Dependency] private   readonly MetaDataSystem _metadata = default!;
+    [Dependency] private   readonly SharedMindSystem _mind = default!;
    [Dependency] private   readonly SharedMoverController _mover = default!;
-    [Dependency] private   readonly SharedTransformSystem _xforms = default!;
+    [Dependency] private   readonly INetManager _net = default!;
+    [Dependency] private   readonly SharedPopupSystem _popup = default!;
+    [Dependency] private   readonly ItemSlotsSystem _slots = default!;
+    [Dependency] private   readonly IGameTiming _timing = default!;
+    [Dependency] private   readonly ItemToggleSystem _toggles = default!;
    [Dependency] private   readonly SharedUserInterfaceSystem _uiSystem = default!;
    [Dependency] private   readonly StationAiVisionSystem _vision = default!;
+    [Dependency] private   readonly SharedTransformSystem _xforms = default!;
+    [Dependency] protected readonly SharedMapSystem Maps = default!;
+    [Dependency] private   readonly SharedPowerReceiverSystem PowerReceiver = default!;



This is a dog's breakfast please just make it alphabetical like it used to be.

thats a wierd way to sort it. ok, done.

ScarKy0 and others added 11 commits September 7, 2024 13:45

Boom! Emergency access!

bc88447

Emergency access sound

60bd34f

locale

130a3ea

Updated sounds

8d33a04

bleh

136f19b

Door electrify base

265fd07

feat: popups on attempt to activate AI action when wires cut

a08fffc

refactor: use SharedApcPowerReceiverComponent to check if AI can inte…

a5967bb

…ract with door

refactor: added icon and sound for door overcharge

9050743

meta.json should use tabs not spaces

846cf95

refactor: extracted sounds for airlock overcharge to static field in …

ac19543

…system

github-actions bot added the Changes: Sprites Should be reviewed or fixed by people who are knowledgeable with spriting or visual design. label Sep 9, 2024

ScarKy0 suggested changes Sep 9, 2024

View reviewed changes

refactor: cleanup, ScarKy0 mentions for resources

fc889c4

Fildrance commented Sep 9, 2024

View reviewed changes

refactor: removed unused textures

43261a5

Fildrance changed the title ~~Feature/ai door electricute for real~~ Station AI ability to electricute doors Sep 10, 2024

feat: now notification is displayed when AI attempting to interact wi…

d899a5a

…th door which have wire cut

Fildrance marked this pull request as ready for review September 10, 2024 19:49

Fildrance requested review from DrSmugleaf and Chief-Engineer as code owners September 10, 2024 19:49

github-actions bot added the Status: Needs Review This PR requires new reviews before it can be merged. label Sep 10, 2024

ScarKy0 mentioned this pull request Sep 10, 2024

AI Emergency Access + Sound #31875

Closed

2 tasks

metalgearsloth requested changes Sep 11, 2024

View reviewed changes

metalgearsloth added Status: Awaiting Changes This PR needs its reviews addressed or changes to be made in order to be merged. and removed Status: Needs Review This PR requires new reviews before it can be merged. labels Sep 11, 2024

pa.pecherskij added 5 commits September 12, 2024 11:09

Merge remote-tracking branch 'origin/master' into feature/ai-door-ele…

28f27fb

…ctricute-for-real

Merge remote-tracking branch 'origin/master' into feature/ai-door-ele…

9b2f203

…ctricute-for-real

refactor: use PlayLocal to play electrify sound only for AI player

9d8d5d4

refactor: SetBoltsDown now uses TrySetBoltDown, checks for power.

67e6875

bolts now check for power using SharedPowerReceiverSystem

5dc4dfc

Fildrance commented Sep 12, 2024

View reviewed changes

Content.Client/Silicons/StationAi/StationAiSystem.Airlock.cs Outdated Show resolved Hide resolved

Fildrance commented Sep 12, 2024

View reviewed changes

Content.Shared/Silicons/StationAi/SharedStationAiSystem.Held.cs Show resolved Hide resolved

pa.pecherskij added 2 commits September 12, 2024 16:49

electrify localization and louder electrify sounds

7483434

extracted ShowDeviceNotRespondingPopup, reverted airlocks not opening…

0b81947

…/closing when ai wire was cut

Fildrance requested review from metalgearsloth and ScarKy0 September 12, 2024 16:10

github-actions bot added Status: Needs Review This PR requires new reviews before it can be merged. and removed Status: Awaiting Changes This PR needs its reviews addressed or changes to be made in order to be merged. labels Sep 12, 2024

ScarKy0 approved these changes Sep 12, 2024

View reviewed changes

metalgearsloth reviewed Sep 16, 2024

View reviewed changes

refactor: cleanup

96c46fc

Fildrance requested a review from metalgearsloth September 16, 2024 20:30

ScarKy0 added 3 commits September 19, 2024 23:24

New sprites and fixes

1a7eac5

Copyright

fdc01d3

even more sprite changes

64094f9

metalgearsloth requested changes Sep 21, 2024

View reviewed changes

metalgearsloth added Status: Awaiting Changes This PR needs its reviews addressed or changes to be made in order to be merged. and removed Status: Needs Review This PR requires new reviews before it can be merged. labels Sep 21, 2024

refactore: cleanup, rename overcharge => electrify

c1f9f60

Fildrance requested a review from metalgearsloth September 21, 2024 14:32

github-actions bot added Status: Needs Review This PR requires new reviews before it can be merged. and removed Status: Awaiting Changes This PR needs its reviews addressed or changes to be made in order to be merged. labels Sep 21, 2024

		: AirlockOverchargeEnabled;
		_audio.PlayEntity(soundToPlay, args.User, ent);

		\|\| !HasComp<StationAiHeldComponent>(args.User)
		\|\| !HasComp<StationAiWhitelistComponent>(args.Target))

Station AI ability to electricute doors #32012

Are you sure you want to change the base?

Station AI ability to electricute doors #32012

Conversation

Fildrance commented Sep 9, 2024 • edited Loading

About the PR

Why / Balance

Technical details

Media

Requirements

Breaking changes

github-actions bot commented Sep 9, 2024 • edited Loading

ScarKy0 commented Sep 9, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JIPDawg commented Sep 10, 2024

ScarKy0 commented Sep 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fildrance commented Sep 12, 2024

ScarKy0 left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fildrance Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fildrance Sep 16, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Fildrance commented Sep 9, 2024 •

edited

Loading

github-actions bot commented Sep 9, 2024 •

edited

Loading

Fildrance Sep 16, 2024 •

edited

Loading

Fildrance Sep 16, 2024 •

edited

Loading