Lock vehicle doors #61087

Numbuh474 · 2022-09-18T02:31:34Z

Summary

Features "Make vehicle doors lockable and pickable"

Purpose of change

This is a contribution to #51383, addressing the ability to lock and unlock vehicle doors.
It also fixes #46160.

Describe the solution

Enable locking and unlocking of certain vehicle doors, adding the LOCKABLE_DOOR flag for valid doors and the DOOR_LOCKING flag for parts that allow locking and unlocking. A new item, the door lock, was given the DOOR_LOCKING flag and most metal doors and hatches were given the LOCKABLE_DOOR tag. A door must be a LOCKABLE_DOOR and have a part with the DOOR_LOCKING tag on the same frame to enable the feature. Modify relevant door opening code to respect locked vehicle door status for player and NPCs. Add lockpicking behavior for vehicle doors, allowing lockpick tools to pick open doors that are otherwise inaccessible.

Monsters and door-opening ferals aren't able to figure out locks, but NPCs will path through locked doors if given the option. A new pair of behavior flags were added that allows you to make followers stop unlocking doors, or to also lock them if possible.

Behavior that protected door motors from damage if the door was closed was added to door locks and moved to the more generic BOARD_INTERNAL flag, which now also works with things installed in boards in case someone wants to add pipework or something. Doors and their locks can't be removed while a tile on the same square is in the "locked" state.

Door motor menu was modified to allow you to lock and unlock all closed doors if the door is lockable, and examining a tile with a lockable door now has options for modifying the lock state based on player position.

Describe alternatives you've considered

Doors could have been made intrinsically lockable without a corresponding DOOR_LOCKING part.
Part lock state currently has nothing to do with vehicle lock state, and these could be made to work together to do things like lock doors on vehicle spawn or trigger alarms.
Lockpicking could have been excluded or made impossible for player-owned vehicles, as this gives "free" locked doors for training purposes.

Testing

Tested door opening and closing from inside and outside the vehicle, door locking and unlocking from both inside and outside the vehicle, door-opening monster behavior for closed vs. locked doors, and locking and unlocking via the door motor menu.

Tested having an NPC follow you into and out of a vehicle with a door lock while using the new rule toggles.

Additional context

src/iexamine.cpp

irwiss

Bunch more stuff (besides the suggested) can be const-ified
Clang is also likely to scream at you for vector.size() > 0 over !vector.empty()

I'm sure many people are waiting for this feature ♥

src/map.cpp

src/vehicle.cpp

src/vehicle_use.cpp

Entity-y · 2022-09-20T19:39:49Z

This looks great, thanks for putting this together. We're one step away from having dedicated ignition keys for cars.

Key fobs would be a great addition as well for remote starting, locking/unlocking, trunk access, and panic alarm.

kevingranade · 2022-10-02T04:32:43Z

What are NPC interactions with locked doors like? They should have the same options as players.

Numbuh474 · 2022-10-02T04:59:05Z

What are NPC interactions with locked doors like? They should have the same options as players.

NPCs don't currently have any logic to interact with locked doors, but it would make sense for them to be able to do so. I'll have to read over the npc pathing and behavior code to see how this should be implemented.

Zireael07 · 2022-10-02T09:58:38Z

@Numbuh474 Probably something for a follow-up PR, though. The bigger the PR, the harder it is to review

kevingranade · 2022-10-03T02:29:02Z

No, it needs to happen in this PR. Having the player be the only agent that can interact with locks is a misfeature.

Numbuh474 · 2022-10-15T16:29:08Z

No, it needs to happen in this PR. Having the player be the only agent that can interact with locks is a misfeature.

Added relevant code for pathfinding and behavior toggles.

src/gates.cpp

src/iexamine.cpp

src/vehicle.cpp

src/vehicle_use.cpp

Night-Pryanik · 2022-10-15T18:50:16Z

I would like to see locked doors on some (most?) cars on spawn, as you described in "alternatives" section, but I guess that could wait for subsequent PRs.

Correct me if I'm wrong, but did you make it so doors can be locked and unlocked only from inside the vehicle?

Numbuh474 · 2022-10-16T02:56:50Z

I would like to see locked doors on some (most?) cars on spawn

So would I! As far as I can tell this would involve a lot of changes to car template json and some tweaks to vehicle spawning code, but as you can see this PR is getting quite large on its own.

did you make it so doors can be locked and unlocked only from inside the vehicle?

That's correct. A remote vehicle controller could be used from outside too.

GuardianDll · 2023-04-28T18:48:29Z

Why closed?

Numbuh474 · 2023-04-28T22:17:35Z

The "sync fork" button on Github web has done this twice now when it didn't before, and I'm scared to try a different method because last time I did that it nuked the PR (see comments from February).

Maleclypse · 2023-06-28T04:16:23Z

Ok I've cleared the merge conflicts and the errors from that. But I'm not sure what to do with the remaining errors when I attempt to test this.

23:08:55.844 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Sports Car' uses invalid variant 'wheel_left' for part 'door_trunk' defaulting to ''
23:08:58.243 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Sports Car' uses invalid variant 'wheel_left' for part 'door_trunk' defaulting to ''
23:08:58.260 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Fire Engine' uses invalid variant 'horizontal_2' for part 'door_trunk' defaulting to ''
[ Previous repeated 1 times ]
23:08:58.260 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Fire Engine' uses invalid variant 'horizontal_2' for part 'door_trunk' defaulting to ''
23:08:58.269 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in truck_swat
23:08:58.983 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in truck_swat
23:08:58.988 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Stagecoach' uses invalid variant 'nw' for part 'door_wood' defaulting to ''
23:08:58.988 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Stagecoach' uses invalid variant 'ne' for part 'door_wood' defaulting to ''
23:08:59.037 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in aapc-gl
23:08:59.040 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in aapc-mg
23:08:59.042 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in apc
23:08:59.044 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in apc-gl
23:08:59.090 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in armored_car
23:08:59.096 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Hippie Van' uses invalid variant 'horizontal_2' for part 'door_trunk' defaulting to ''
23:08:59.096 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1505 [finalize_prototypes] veh prototype 'Hippie Van' uses invalid variant 'horizontal_2' for part 'door_trunk' defaulting to ''
23:08:59.117 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\vehicle.cpp:1425 [install_part] installing v_curtain would make invalid vehicle: Part requires any of: door, hatch, heavy-duty hatch, heavy-duty trunk door, reinforced windshield, trunk door, windshield, or wooden door.
23:08:59.979 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1492 [finalize_prototypes] init_vehicles: 'Survivor RV' part 'v_curtain'(91) can't be installed to -2,3
23:09:00.435 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in security_van
23:09:00.439 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in prisoner_van_1
23:09:00.440 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1484 [finalize_prototypes] unknown vehicle part hddoor_opaque in prisoner_van_1
23:09:05.842 INFO : Loaded tileset: Chibi_Ultica
23:09:05.923 INFO : Loaded tileset: Chibi_Ultica
23:09:09.386 ERROR : C:\Users\colli\Documents\GitHub\Cataclysm-DDA\src\veh_type.cpp:1658 [check] vpart migration specifies invalid id 'hddoor_opaque'

RenechCDDA · 2023-06-28T04:35:33Z

Looks like some pre-made vehicles need to be updated. Not sure on the exact syntax, but here's the spots to make it easy for you.

Sports car:

Cataclysm-DDA/data/json/vehicles/cars.json

Lines 622 to 623 in 30f23ec

    
           { "x": -2, "y": 0, "parts": [ "frame#horizontal_rear", "door_trunk#wheel_left" ] }, 
        
           { "x": -2, "y": 1, "parts": [ "frame#horizontal_rear", "door_trunk#wheel_left" ] },

Fire Engine:

Cataclysm-DDA/data/json/vehicles/emergency.json

Lines 192 to 197 in 30f23ec

    
           { "x": -5, "y": -1, "parts": [ "frame#horizontal_rear", "roof", "door_trunk#horizontal_2" ] }, 
        
           { "x": -5, "y": -1, "parts": [ "storage_battery" ] }, 
        
           { "x": -5, "y": -2, "parts": [ "frame#sw", "roof", "board#sw" ] }, 
        
           { "x": -5, "y": 0, "parts": [ "frame#horizontal_rear", "roof", "door_trunk#horizontal_2" ] }, 
        
           { "x": -5, "y": 0, "parts": [ "storage_battery" ] }, 
        
           { "x": -5, "y": 1, "parts": [ "frame#horizontal_rear", "roof", "door_trunk#horizontal_2" ] },

truck_swat(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/emergency.json

Line 720 in 30f23ec

    
           { "x": -2, "y": 3, "parts": [ "hdframe#vertical_right", "hddoor_opaque#right", "hdroof" ] },

Cataclysm-DDA/data/json/vehicles/emergency.json

Line 740 in 30f23ec

    
           { "x": -5, "y": 1, "parts": [ "hdframe#horizontal_rear", "hddoor_opaque#rear", "hdroof" ] },

Stagecoach:

Cataclysm-DDA/data/json/vehicles/farm.json

Lines 305 to 306 in 30f23ec

    
           { "x": -3, "y": -1, "parts": [ "frame_wood#vertical_left", "door_wood#nw", "roof_wood" ] }, 
        
           { "x": -3, "y": 2, "parts": [ "frame_wood#vertical_right", "door_wood#ne", "roof_wood" ] },

aapc-gl(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/military.json

Line 79 in 30f23ec

    
           { "x": -2, "y": 0, "parts": [ "hdframe#horizontal_rear", "hddoor_opaque#rear", "omnicam" ] },

aapc-mg(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/military.json

Line 177 in 30f23ec

    
           { "x": -2, "y": 0, "parts": [ "hdframe#horizontal_rear", "hddoor_opaque#rear", "omnicam" ] },

apc(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/military.json

Line 275 in 30f23ec

    
           { "x": -2, "y": 0, "parts": [ "hdframe#horizontal_rear", "hddoor_opaque#rear", "omnicam" ] },

apc-gl(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/military.json

Line 363 in 30f23ec

    
           { "x": -2, "y": 0, "parts": [ "hdframe#horizontal_rear", "hddoor_opaque#rear", "omnicam" ] },

armored_car(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/vans_busses.json

Line 72 in 30f23ec

    
           { "x": -3, "y": 1, "parts": [ "hdframe#horizontal_rear", "hddoor_opaque#rear" ] },

Hippie van:

Cataclysm-DDA/data/json/vehicles/vans_busses.json

Lines 354 to 355 in 30f23ec

    
           { "x": -4, "y": 0, "parts": [ "frame#horizontal_rear", "door_trunk#horizontal_2", "muffler" ] }, 
        
           { "x": -4, "y": 1, "parts": [ "frame#horizontal_rear", "door_trunk#horizontal_2" ] },

Survivor RV (curtain needs to just be removed, looks like?):

Cataclysm-DDA/data/json/vehicles/vans_busses.json

Line 1322 in 30f23ec

{ "x": -2, "y": 3, "parts": [ "roof", "v_curtain" ] },

security van(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/vans_busses.json

Line 2251 in 30f23ec

    
           { "x": -5, "y": 1, "parts": [ "hdframe#horizontal", "hddoor_opaque#rear", "hdroof" ] },

prisoner_van_1(will be fixed by restoring hddoor_opaque):

Cataclysm-DDA/data/json/vehicles/vans_busses.json

Line 2433 in 30f23ec

    
           { "x": -5, "y": 0, "parts": [ "hdframe#horizontal", "hddoor_opaque#rear", "hdroof" ] },

Cataclysm-DDA/data/json/vehicles/vans_busses.json

Line 2437 in 30f23ec

    
           { "x": -5, "y": 2, "parts": [ "hdframe#horizontal", "hddoor_opaque#rear", "beeper" ] },

RenechCDDA · 2023-06-28T05:24:13Z

Found one of your problems. Some of the parts have been moved around in the last month. Here's two instances of door_trunk in the PR's branch.

Cataclysm-DDA/data/json/vehicleparts/doors.json

Lines 230 to 231 in 4e7329e

    
           "type": "vehicle_part", 
        
           "id": "door_trunk",

Cataclysm-DDA/data/json/vehicleparts/vehicle_parts.json

Lines 2236 to 2238 in 4e7329e

    
           "type": "vehicle_part", 
        
           "id": "door_trunk", 
        
           "name": { "str": "trunk door" },

RenechCDDA · 2023-06-28T05:26:34Z

Same deal with door_wood.

Cataclysm-DDA/data/json/vehicleparts/doors.json

Lines 195 to 197 in 4e7329e

    
           "type": "vehicle_part", 
        
           "id": "door_wood", 
        
           "copy-from": "door",

Cataclysm-DDA/data/json/vehicleparts/vehicle_parts.json

Lines 2712 to 2714 in 4e7329e

    
           "type": "vehicle_part", 
        
           "id": "door_wood", 
        
           "name": { "str": "wooden door" },

Maleclypse · 2023-06-28T05:40:07Z

Pushed the changes, loaded up the game created new player, world initialized with no errors then revealed map, teleported into nearest city to test vehicle doors and ctd.

Maleclypse · 2023-06-28T14:18:50Z

Compiled and tested this morning and it works. NPCs can also be commanded to lock doors as they pass through.

irwiss reviewed Sep 18, 2022

View reviewed changes

src/iexamine.cpp Outdated Show resolved Hide resolved

irwiss reviewed Sep 18, 2022

View reviewed changes

src/map.cpp Outdated Show resolved Hide resolved

src/vehicle.cpp Outdated Show resolved Hide resolved

github-actions bot added BasicBuildPassed This PR builds correctly, label assigned by github actions astyled astyled PR, label is assigned by github actions labels Sep 18, 2022

mqrause reviewed Sep 18, 2022

View reviewed changes

src/vehicle_use.cpp Outdated Show resolved Hide resolved

github-actions bot added <Documentation> Design documents, internal info, guides and help. [Markdown] Markdown issues and PRs Crafting / Construction / Recipes Includes: Uncrafting / Disassembling labels Sep 19, 2022

Numbuh474 mentioned this pull request Sep 21, 2022

Locks for vehicle doors #46160

Closed

github-actions bot added BasicBuildPassed This PR builds correctly, label assigned by github actions and removed BasicBuildPassed This PR builds correctly, label assigned by github actions labels Sep 29, 2022

Night-Pryanik reviewed Oct 15, 2022

View reviewed changes

github-actions bot added the json-styled JSON lint passed, label assigned by github actions label Oct 16, 2022

Numbuh474 closed this Apr 28, 2023

Numbuh474 force-pushed the lock-vehicle-doors branch from 9deb186 to 0b9b1fa Compare April 28, 2023 17:42

Resolve merge conflicts.

1e44f62

Numbuh474 reopened this Apr 28, 2023

Numbuh474 and others added 3 commits May 1, 2023 03:35

Merge branch 'CleverRaven:master' into lock-vehicle-doors

147420c

Merge branch 'CleverRaven:master' into lock-vehicle-doors

098fa09

Merge branch 'master' into lock-vehicle-doors

7c5459d

github-actions bot removed the BasicBuildPassed This PR builds correctly, label assigned by github actions label Jun 28, 2023

Maleclypse added 2 commits June 27, 2023 23:13

Fixes

7d72964

Update vehicle_parts.json

bb64dff

github-actions bot added json-styled JSON lint passed, label assigned by github actions and removed json-styled JSON lint passed, label assigned by github actions labels Jun 28, 2023

Update doors.json

4e7329e

Maleclypse added 2 commits June 28, 2023 00:33

Update vehicle_parts.json

6356390

Update vans_busses.json

2561d93

github-actions bot added the BasicBuildPassed This PR builds correctly, label assigned by github actions label Jun 28, 2023

Maleclypse merged commit 7fa704b into CleverRaven:master Jun 28, 2023

This was referenced Jun 29, 2023

Remove redefined door fields #66523

Merged

Enable mod tracker for vpart_info #66526

Merged

ehughsbaird mentioned this pull request Jul 13, 2023

Fix pathfinding around vehicles #66877

Merged

NEONZARIN mentioned this pull request Aug 6, 2023

Door lock on a vehicle. cataclysmbnteam/Cataclysm-BN#3037

Open

hexagonrecursion mentioned this pull request Mar 29, 2024

doc: LOCKABLE_DOOR, DOOR_LOCKING #72694

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Lock vehicle doors #61087

Lock vehicle doors #61087

Numbuh474 commented Sep 18, 2022 •

edited

Loading

irwiss left a comment •

edited

Loading

Entity-y commented Sep 20, 2022

kevingranade commented Oct 2, 2022

Numbuh474 commented Oct 2, 2022

Zireael07 commented Oct 2, 2022

kevingranade commented Oct 3, 2022

Numbuh474 commented Oct 15, 2022

Night-Pryanik commented Oct 15, 2022

Numbuh474 commented Oct 16, 2022 •

edited

Loading

GuardianDll commented Apr 28, 2023

Numbuh474 commented Apr 28, 2023

Maleclypse commented Jun 28, 2023

RenechCDDA commented Jun 28, 2023 •

edited

Loading

RenechCDDA commented Jun 28, 2023

RenechCDDA commented Jun 28, 2023

Maleclypse commented Jun 28, 2023

Maleclypse commented Jun 28, 2023

Lock vehicle doors #61087

Lock vehicle doors #61087

Conversation

Numbuh474 commented Sep 18, 2022 • edited Loading

Summary

Purpose of change

Describe the solution

Describe alternatives you've considered

Testing

Additional context

irwiss left a comment • edited Loading

Choose a reason for hiding this comment

Entity-y commented Sep 20, 2022

kevingranade commented Oct 2, 2022

Numbuh474 commented Oct 2, 2022

Zireael07 commented Oct 2, 2022

kevingranade commented Oct 3, 2022

Numbuh474 commented Oct 15, 2022

Night-Pryanik commented Oct 15, 2022

Numbuh474 commented Oct 16, 2022 • edited Loading

GuardianDll commented Apr 28, 2023

Numbuh474 commented Apr 28, 2023

Maleclypse commented Jun 28, 2023

RenechCDDA commented Jun 28, 2023 • edited Loading

RenechCDDA commented Jun 28, 2023

RenechCDDA commented Jun 28, 2023

Maleclypse commented Jun 28, 2023

Maleclypse commented Jun 28, 2023

Numbuh474 commented Sep 18, 2022 •

edited

Loading

irwiss left a comment •

edited

Loading

Numbuh474 commented Oct 16, 2022 •

edited

Loading

RenechCDDA commented Jun 28, 2023 •

edited

Loading