Unified item mods #18735

mugling · 2016-10-11T20:16:33Z

Provides the groundwork for #17008 by implementing a TOOLMOD type. The design is intentionally very simple - only one mod can be installed at once and the only possible restrictions are per ammo type. We don't want nor need anything as complex as the GUNMOD mess.

Pure JSON definition of tool mods can probably also be exploited by mod authors
Replaces multiple iuse functions with iuse::toolmod_attach
Deprecates DOUBLE_AMMO and ATOMIC_AMMO flags
Gets rid of some special cases in crafting code (removal of mods)
Replace hardcoding with explicit toolmod weight and volume/volume_integral
Includes legacy savegame migration

The purpose of this PR is to cleanup core - not to expand the range of tool mods (although mod authors may wish to do so). The following fields are supported:

acceptable_ammo
ammo_modifier
capacity_multiplier
magazine_adaptor
flags

The radio activation mod could probably also later be converted to use this functionality (separate PR)

mugling · 2016-10-12T00:43:09Z

Ready

BorkBorkGoesTheCode · 2016-10-12T02:29:10Z

Could this be fixed? #18739

mugling · 2016-10-12T08:22:43Z

Could this be fixed? #18739

Unrelated to this PR

Coolthulhu · 2016-10-12T12:13:34Z

Has a conflict with #18514 - looks trivial, just a string change.

mugling · 2016-10-12T12:16:09Z

Has a conflict with #18514 - looks trivial, just a string change.

Yes, I've purposely avoided adding requirement and denial reasons to this PR so that it won't cause a problem when we later resume #18514

Coolthulhu · 2016-10-12T12:53:50Z

Received unrecognized iuse function UPS_BATTERY, using iuse::none instead

And then segfault during migration.

mugling · 2016-10-12T13:01:32Z

Will look into. I don't suppose you have a stack trace?

mugling · 2016-10-12T13:12:03Z

Fixed (099a8cf) by removing the useless entry to UPS_BATTERY. An unmatched use_action shouldn't result in a segfault but that's a separate issue to be tackled in another PR.

Coolthulhu · 2016-10-12T13:31:20Z

Spawn each of the battery mods
Spawn flashlights
Apply atomic mod

Expected:

Flashlights are listed
Applying to one unloads it and then applies the mod

Got:

"No compatible tools"
Unload flashlight
Becomes compatible

mugling · 2016-10-12T13:39:57Z

Known limitation to avoid transmutation of ammo. If it's essential we could add an implicit unload step but I'd prefer to wait for #18514 and then write an implementation complete with denial reasons?

Coolthulhu · 2016-10-12T13:49:42Z

Old implementation allowed it.
It should be easy to just remove the ammo before application of the mod.

mugling · 2016-10-12T13:58:45Z

Fixed

Coolthulhu · 2016-10-12T14:10:01Z

Atomic mod lost a 0 in multiplier - it's 10 times capacity, was 100.

mugling · 2016-10-12T14:10:44Z

Atomic mod lost a 0 in multiplier - it's 10 times capacity, was 100.

Intentional although I'm not especially attached to that if you disagree

Coolthulhu · 2016-10-12T15:20:55Z

Atomic batteries are incredibly expensive compared to regular ones, them having "infinite" capacity makes them less useless.

mugling · 2016-10-12T15:51:15Z

Atomic batteries are incredibly expensive compared to regular ones, them having "infinite" capacity makes them less useless.

Ok, fixed

Coolthulhu · 2016-10-12T17:59:45Z

src/item.cpp

@@ -3558,6 +3559,11 @@ bool item::is_wheel() const
    return type->wheel.get() != nullptr;
 }

+bool item::is_toolmod() const
+{
+    return !is_gunmod() && type->mod;


That's really hacky now that I think about it.

Coolthulhu · 2016-10-12T18:01:08Z

src/itype.h

+    std::set<ammotype> acceptable_ammo;
+
+    /** If set modifies parent ammo to this type */
+    ammotype ammo_modifier = NULL_ID;


Shit, I merged it because it didn't crash on my build, but NULL_ID in unspecified context (possibly static) is still unsafe.

I'll push an amendment now

I think it wasn't change though from the original?

EDIT: Yes, it wasn't changed

What are the rules about NULL_ID. We need to get that fixed for 0.D?

NULL_ID must never be used in context that can be static.
Static initialization is not guaranteed to happen in any order other than those specified for single file.

For example, on Cygwin (just an example), the sort order of files seems totally scrambled.
I think it's the link order which determines static initialization order. There are ways to guarantee static initialization order, but they most likely depend on very specific linking which would be a pain to keep.

Would probably be better to just drop the static NULL_ID and wrap it in a getter. We had a PR like this and I think I stalled it, but I can't think of a better way to do it.
We could keep the null id type for that weird overload trick, but it should no longer point to possibly-valid object.

Coolthulhu · 2016-10-12T18:01:38Z

src/iuse.cpp

-    static const std::vector<std::string> removable_mods = {{
-        "DOUBLE_AMMO", "USE_UPS", "ATOMIC_AMMO"
-    }};
+    if( !p ) {


Redundant, p is never null.

Only because we hacked around that. Theres a code comment somewhere about wanting to drop that precondition

Would be much better to hand it over to a null character anyway.

True. I want to rework iuse to use an item_location. What would a good function signature look like?

Character &user, item &it, bool t, const tripoint &pos

If using item_location, you should first guarantee that the supplied location:

Always points to a valid item (this should never need to be checked in the iuses)

Can be accessed in constant time almost always (ie. unpacking would be done only for the first time)

remove_item is never invoked during processing. Otherwise the active item vectors would get scrambled and the function itself could segfault.

So overall it would be better to keep it without location. If we want location, it would be better to keep an item map and give items some sort of id - it would be more work at start, but would most likely end up less work in total.

remove_item could remove the item from the active item vectors. One of the reasons I want to use item_location is that it makes vehicle mounted tools or interaction with static furniture much easier.

Now that would lead to a giant mess, as active item processing would need to understand being tampered with in the middle of iteration.

Coolthulhu · 2016-10-12T18:02:42Z

src/iuse.cpp

-        p->add_msg_if_player( m_info, _( "You do not have that item!" ) );
+    // can remove mods from unloaded tools only
+    auto filter = []( const item &e ) {
+        return !e.toolmods().empty() && !e.ammo_remaining() && !e.magazine_current();


Wouldn't be hard to just unload them before removing the mods.

Lots of nasty corner cases (plutonium)

mugling force-pushed the toolmod branch from 89625a4 to 1ac1149 Compare October 11, 2016 20:17

mugling added 2 commits October 11, 2016 22:21

Initial implementation of unified item mods

1ac1149

Add linter rules for TOOLMOD

30243bb

mugling force-pushed the toolmod branch from c8d37ad to 09e9d78 Compare October 11, 2016 22:37

mugling added 5 commits October 11, 2016 23:59

Atomic battery becomes TOOLMOD

b68d295

Convert more toolmods to JSON

e606819

Inherit flags from toolmods

d9c83d1

Handle UPS battery mod

9dea818

Display modification status

09e9d78

mugling changed the title ~~Unified item mods [WIP]~~ Unified item mods Oct 11, 2016

mugling mentioned this pull request Oct 11, 2016

[RDY]Batteries as magazines mod #17008

Merged

3 tasks

mugling added 3 commits October 12, 2016 00:58

Support removal of toolmods

d7bc691

Improve display of attached toolmods

59797b0

Restore missing flags from atomic mod

c86703c

mugling added 2 commits October 12, 2016 01:46

Migrate legacy savegames

d837239

Drop documentation for deprecated flags

3bb3c7b

Coolthulhu self-assigned this Oct 12, 2016

Add missing item action definition

2934fe7

mugling added 2 commits October 12, 2016 15:14

Fix segfault

099a8cf

Auto-unload tools when adding mods

e662287

Coolthulhu merged commit 400ac9b into CleverRaven:master Oct 12, 2016

Bump atomic battery capacity

a7e824c

Coolthulhu reviewed Oct 12, 2016

View reviewed changes

keyspace mentioned this pull request Feb 6, 2017

Bayonet attached as gunmod to gun does not give increased damage, including for reach attacks (regression) #20214

Closed

alanbrady mentioned this pull request Jun 24, 2019

magazine_adaptor is not documented #31816

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Unified item mods #18735

Unified item mods #18735

mugling commented Oct 11, 2016 •

edited

Loading

mugling commented Oct 12, 2016

BorkBorkGoesTheCode commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016 •

edited

Loading

Coolthulhu Oct 12, 2016

Coolthulhu Oct 12, 2016

mugling Oct 12, 2016

mugling Oct 12, 2016 •

edited

Loading

mugling Oct 12, 2016

Coolthulhu Oct 12, 2016

Coolthulhu Oct 12, 2016

mugling Oct 12, 2016 •

edited

Loading

Coolthulhu Oct 12, 2016

mugling Oct 12, 2016

Coolthulhu Oct 12, 2016

mugling Oct 12, 2016

Coolthulhu Oct 12, 2016

Coolthulhu Oct 12, 2016

mugling Oct 12, 2016

Unified item mods #18735

Unified item mods #18735

Conversation

mugling commented Oct 11, 2016 • edited Loading

mugling commented Oct 12, 2016

BorkBorkGoesTheCode commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016

Coolthulhu commented Oct 12, 2016

mugling commented Oct 12, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mugling Oct 12, 2016 • 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

mugling Oct 12, 2016 • 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

mugling commented Oct 11, 2016 •

edited

Loading

mugling commented Oct 12, 2016 •

edited

Loading

mugling Oct 12, 2016 •

edited

Loading

mugling Oct 12, 2016 •

edited

Loading