[Mod] Monoidal Effects [0.1.0.0] [monoidal_effects]

[Byakuren]

Deprecated by player_monoids.

This is a framework for managing player status, similar to playereffects. There are some parts of player state, such as privileges, physics overrides, player object properties, etc. that could get clobbered if multiple mods try to change it independently. Monoidal Effects provides a way for these to be centrally-managed, and also for effects to work cumulatively.

Download:
0.1.0.0-dev

Source: https://github.com/minetest-mods/monoidal_effects
License: Apache 2.0 (No non-code assets)
Dependencies: None
API: https://github.com/minetest-mods/monoid ... er/API.txt

Differences from playereffects:

+ Spoiler

• Monoids (analogous to playereffects groups) must be declared beforehand.
• Effects don't have individual "apply" functions. An effect provides values for each of the monoids it belongs to, and each monoid combines the values from all relevant effects, and applies an effect based on that.
• Multiple effects can affect the same status, and their effects will be combined together.
• You can have multiple effects of the same effect type active at once, since they can be combined together. If you want to recover the exclusive behavior of playereffects, you can cancel any old instances first. (I might add a convenience function to do this)
• Effects can have permanent duration. This allows permanent status changes to mesh nicely with temporary ones.
• Effects can have tags which don't change the operation of anything. It just allows you to get every effect with a particular tag, in case you want to e.g. cancel all magical effects.
• os.time is used for both handling effect cancellations and HUD updates. In playereffects, it is possible for the HUD to get out of sync because effect cancellations are done with minetest.after (which uses server step), but HUDs were updated using a remaining time calculated using os.time.

Mods that use it:

+ Spoiler

Currently just the magical_realm modpack, which I wrote (and where a lot of the testing of monoidal_effects is done). monoidal_effects has not caused any crashes on my server yet.

[Byakuren]

I've made my first release, since it seems stable enough.

[SaKeL]

Nice job. Will try it very soon on my server too ;) Thanks for sharing.

[SaKeL]

How do i check if the effect was already applied to the player so it will not get applied again ?
Im trying to get my head around it and work with the sets

Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.

Code: Select all

monoidal_effects.get_player_effects(user:get_player_name()):effects()

but nothing is working (yet)... just trying to find the simple way how to apply an effect to the player only if it's not already active (so no multiple times)

Your help would be appreciated.

[Byakuren]

How do i check if the effect was already applied to the player so it will not get applied again ?
Im trying to get my head around it and work with the sets

Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.

Code: Select all

monoidal_effects.get_player_effects(user:get_player_name()):effects()

but nothing is working (yet)... just trying to find the simple way how to apply an effect to the player only if it's not already active (so no multiple times)

Your help would be appreciated.

get_player_effects returns a set (i.e. a table with { foo = true, bar = true} if foo and bar are in the set }, not an effectset. Effectsets are not part of the public API, the documentation is just there for use while developing the mod.

Unfortunately right now there is no simple way to determine if an effect is of a particular type. I'm not sure if I want to make more additions to monoidal_effects, since I am thinking of merging functionality into playereffects.

It might be possible that your use-case is covered by first canceling effects of that effect type, then reapplying them. That could be done like

Your phone or window isn't wide enough to display the code box. If it's a phone, try rotating it to landscape mode.

Code: Select all

monoidal_effects.cancel_effect_type(eff_type, player_name)
monoidal_effects.apply_effect(eff_type, dur, player_name)