Draft: Store prototype API

QGazQ

I must say I'm for this change, and after a period of transition removing the old ones. It did confuse me a lot originally, and though I now have prototypes that handle most of it removing them will simplify things.

As others have mentioned there needs to be some way to define the limits for Labs and Nuker, as others have mentioned a single store object would be my preference with some kind of per resource limit field. The other "important" thing I do a lot is to check what resource type is in a lab, at the moment this is a simple .mineralType. I'd rather not have to iterate over the store / supportedResources and ignore energy to be able to get it in the new way of doing things (though if it were the only way I could add a prototype of .mineralType which did it and cached the result).

deft-code

I really like the unification of carry, store and energy as well as the inclusion of total and free methods.

The beauty of unified store is marred by StructureNuker and StructureLab, we need a little more consideration here.

I think everyone dislikes separate properties. I think @Xenofix's idea of extending the Store interface deal with the two oddballs is best.

How about extending the getUsedCapacity and getFreeCapacity to accept an optional resource type argument and adding a getTotalCapacity.

That way I can easily write uniform transfer and withdraw code by always including the resource type.

nuker.store.getTotalCapacity(RESOURCE_GHODIUM) => 5000
nuker.store.getTotalCapacity(RESOURCE_ENERGY) => 300000
nuker.store.getTotalCapacity() => 305000 // or 0 or whatever make sense
creep.store.getUsedCapacity(/*anything*/) => the same value

// look how nice labs work out.
lab.store.getUsedCapacity(RESOURCE_UTRIUM) => 1000
lab.store.getTotalCapacity(RESOURCE_UTRIUM) => 3000
lab.store.getTotalCapacity(RESOURCE_KEANIUM) => 0

Store.capacity === Store.getTotalCapacity()
Store[RESOURCE_ZYNTHIUM] === Store.getUsedCapacity(RESOURCE_ZYNTHIUM)

I would never need to use Store.supportedResources since getTotalCapacity answers that same question, and for the most part supportedResource is statically known based on structureType.

I think we'll still want a .mineralType member on the lab, but that could just be implemented with getUsedCapacity.

MrFaul

IMO incoming:

This change is long overdue, seriously but a couple of things:
For God's sake use "storage" or "stored", "store" is a incorrect definition and prone for misunderstandings.
It maybe it should be super class for all entities that contain something so that it is possible to directly call withdraw on them without the need to punch .store/storage/stored. between object and call.
This way all resource handling can be done central in one class without the need to fiddle in the endusers object code.

I have a lot more in mind but I'm tired so that will it be for now.

W4rl0ck

@artch would it be possible from the users script to modify the storage object of a creep and reset the cache? That would be nice because I currently already patch the creep object for example on successful withdraws, pickups and stuff like that so decisions made after that are based of the new values ( I know those can still fail when multiple creeps for example withdraw, so that should not be automatic maybe ) but I use it only for the decision to move to the creeps next target for example in the same tick.

If this is a breaking change ( and there are already other mentions in the docs about deprecated stuff like the transfer method on structures, the old spawn function,... ) maybe it's time to create a second selectable runtime? I don't know how much work that would be but perhaps it would also allow us to get one with lodash 4 already included ?

artch

@w4rl0ck Properties will be set with configurable:true, so yes, you can modify them.

artch

@deft-code I like this idea! Although, I would rename getTotalCapacity to getCapacity and remove the .capacity property at all then. The top post updated, check it out!

MrFaul

I still don't like it to be called Store since it is used a lot in other contexts.
Hence I like to propose to use a term that makes it very clear we talk about non stationary stuff:
Cargo <- This is short, pregnant and definitive.

If you think I'm nitpicking, think again.
Clear terminology is key for a good and comprehensible Codebase that is supposed to be used by others.

artch

@mrfaul Are you a native English speaker? I'm not, so I use dictionaries a lot. This is what the Oxford Dictionary gives for "store":

A quantity or supply of something kept for use as needed.

‘the squirrel has a store of food’

Looks valid to me.

MrFaul

I'm not a native speaker and butcher the grammar frequently but German is really not far from English.
(for those native tongues who learning German and cursing me right now for that statement, sry for us the complexity goes down )

This is not about its definition, it is about distinction in context.
I have a B.E. in machine design and this is one of the biggest challenge in my profession.
German by its nature is a very precise language, this keeps a lot of potential misunderstandings in check since we have a word for almost everything.
However when translating this in English, a lot (I mean a shit load) of this precise information is lost since English simplifies and reuses a lot of words to a degree that they are able to have very different meanings.

To combat this we have to make sure to use distinctive terminology in international conversations.
Now "Store" and "Cargo" are very similar with the distinction that "Cargo" is exclusively used for "stuff that is being transported"
This is the better term in this case since it will be used by structures and creeps.
Decide for your self what is easier to distinguish in a non written conversation or when you are hunting for bugs which may include typos:
Storage.store.[RESOURCE] or Storage.cargo[RESOURCE]

"store" is a completely valid term but since it is already used it shouldn't be given a additional meaning.

P.S. And don't get me started on the difference between "american" and "british" English that deserves it own rant

artch

@mrfaul Storage.store[RESOURCE] does look much better to me than Storage.cargo[RESOURCE]. "Store" is a more abstract term (e.g. an idiom "to have something in store"), and "cargo" is indeed mostly about transportation (thus irrelevant to game structures).

I think we're fine with store, but it's interesting to hear some native speakers' opinion.

MrFaul

@artch said in Draft: Store prototype API:

"Store" is a more abstract term (e.g. an idiom "to have something in store"),

You do realize that it is exactly what I'm bitching about, don't you? Too abstract.

and "cargo" is indeed mostly about transportation (thus irrelevant to game structures).

How is this irrelevant, every fucking resource has to transported in this game before it can be used...
It only stops being cargo when it is used up, and that is the moment you call an intend with it.
Before that you can move it around freely.

That said your call

Davaned

As a native english speaker, I've never had an issue with store. I agree with @artch, "cargo" definitely has in transit connotation, eg. something being delivered. To me terminal.cargo doesn't make sense @MrFaul.

A word like contents might make slightly more sense due to being specific to the object itself (eg. the storage.contents, the contents of the tower), but tbh to me the extra characters probably wouldn't be worth it.

Store can be used as in "grain stores for the winter" and in my mind "store" was being used to represent a stockpile. My only qualm would be that terminal.store has an active verb definition of "to store" which is what comes to mind first, but it's a nitpick at best. The exact word choice isn't an issue, as what it's meant to be is clear, so I'd stick with store. My 2¢ on it.

W4rl0ck

I would also prefer store .. it's short and I think it fits.

MrFaul

@davaned I know this seems like nitpicking but trust me I have seen markets shut down because of such little things like confusing naming conventions. (they switched logistic software)
Oh and cargo on a terminal makes perfect sense, just ask a port worker of your choice ^^

And again I'm not bitching about the term, I'm bitching about the lack of distinction.
I guess I'm just sensitized to filter out those problems early... ( That day mentioned above was a fuck up above 7 digits)

Davaned

@mrfaul

Tower.store - has verb implication, valid word choice
Tower.cargo - has incorrect implication, not getting transported
Tower.contents - most accurate, extra characters

Would you describe something stored in your pantry as "cargo"? Between the contents of the pantry and the cargo of the pantry I know which makes sense. Store is a little clunky, but I would not bother changing to an incorrect definition.

deft-code

More bad options:

hold. Same verb problem as store, same transit problem as cargo. less characters
resources, almost as good as contents, but longer, resources is often used abstractly in common english.
quanta, technically as correct as contents, horrifically confusing.
bikeshed, terrible, but think of the story we could tell new players
stuff, also a verb like store, but most often used as a noun, often used to end bikeshed arguments.

Seriously though, the consistent use will be a huge boon to those learning the API. The debate about which name is truly just bike shedding. There are bad options, many good enough options, and no objectively best options. More important than picking among good enough names is that the devs remain productive and this gets rolled out before the next crop of new players shows up.

If switching to contents speeds up the refactor, awesome. If leaving it as store means less work overall even better.

wtfrank

Renaming commonly-used variables 5 years into a project is often a terrible idea

Orlet

I'll miss Creep.carry, but .store is my preferred way of storeing things.

Davaned

Personally, I'm going to be wrapping all my .store/.carry methods with .booty and .plunder

Maxion

@artch said in Draft: Store prototype API:

Store.getUsedCapacity([resourceType])

resourceType is undefined: equals to _.sum(store) with internal caching or null if this is not a general purpose store;

resourceType is defined: returns capacity for that particular resource or null if this resource cannot be stored in this particular structure

It might be a case of copy paste, or just me nit picking, but I think in that last list point of returns capacity for that particular resource it should be returns used capacity of that particular resource.

(and don't mind me not figuring out how to replicate the bullet list indentation properly)