nalc/player_monoids
1
0
Fork 0
forked from minetest-mods/player_monoids
Code Issues Pull Requests Releases Wiki Activity

Remove caveats from API

Browse Source
This commit is contained in:
raymoo 2016-05-27 15:35:11 -07:00
parent 9936955821
commit 025f1d398a
1 changed files with 0 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
API.md
View File

@ -74,17 +74,3 @@ the given player, if it exists.
```monoid:value(player)``` - The current combined value of the monoid for the ```monoid:value(player)``` - The current combined value of the monoid for the
given player. given player.
Caveats
=======
* If the global state managed by a monoid is modified by something other than
the monoid, you will have the same problem as when two mods both independently
try to modify global state without going through a monoid.
* This includes playereffects effects that affect global player state without
going through a monoid.
* You will also get problems if you use multiple monoids to manage the same
global state.
* The order that different effects get combined together is based on key order,
which may not be predictable. So you should try to make your monoids commutative
in addition to associative, or at least not care if the order of two changes
is swapped.