Enchantment API

[copygirl]

Enchantment API

[copygirl]

I'd really like to expose the enchantments so other mods can use them, and not just my own locks. I know I could have an API function for the items, like getLevelSecurity, but if someone wanted to make their own locks and make then enchantable I'm not sure how they'd do it.

Maybe you know a good way to do it?

[copygirl]

I guess I'll just use a class with a bunch of public static Enchantment xyz; fields, and set them when the mod starts. It's simple and everything, so it should be good.

[cadyyan]

Just sat down to start looking at the code. I'm thinking it would be pretty nice if the enchantment didn't matter to the chest. Like the lock knows what effect it has on the chest and when the lock is attached it applies the effect to the chest. I'm hoping that's possible but it'll take some digging.

[cadyyan]

What about making your base enchantment class part of the API and then adding a method to that class that takes a container as a parameter and it allows the enchantment to apply some effect to the chest? The lock would need to get the list of enchantments it has and call this new method when the lock is added to a chest. A corresponding action would need to be done when the lock is removed as well. This way the lock has to know how to handle the enchantments, not the chest, AND the exact enchantment doesn't matter so much. This also means that someone else can implement their own enchantment that affects locks.

[cadyyan]

I might try and create a fork that has what I'm talking about a bit later.

[copygirl]

Yeah, I have an now idea how I'd do it, thanks to your input.
I won't be getting at the API until I've fixed some of the more serious problems.

About the fork, I do have to say I'm very picky about other people's contributions.

[cadyyan]

Yeah fixing core functionality is a bit more important.

I totally get it. I'm trying to stick to the style of your code and trying not to change anything. It's your mod and I don't want to change/add stuff that makes it less your mod.

[copygirl]

Added what I thought would be alright for the enchantment API.
Tell me if you'd like to suggest any changes or if it's fine, so I can close up the issue.

[cadyyan]

I think that should be sufficient. Only thing I can think to change is make the names more generic. So instead of shock make it just damage. That way someone could say add an enchantment that does burn damage or something. Then maybe also have the map of names to enchantments be a name to multiple enchantments and all the damage enchantments would be called.

[copygirl]

That wouldn't really make sense, as the locks are what decide what happens when the chest is being opened. You could have a lock which does something else to the player for the shock enchantment, but the enchantments themselves are just "there" and can't control anything.

I'll mark the issue as closed now, but I'm (obviously) still open for suggestions and the like.