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

API fixes

Browse Source
This commit is contained in:
raymoo 2016-05-25 22:10:07 -07:00
parent b6e7bd44a3
commit 9150eb12d2
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
API.md
View File

@ -24,8 +24,8 @@ A player monoid definition is a table with the following:
* ```combine(elem1, elem2)``` - An associative binary operation * ```combine(elem1, elem2)``` - An associative binary operation
* ```fold({elems})``` - Equivalent to combining a whole list with ```combine``` * ```fold({elems})``` - Equivalent to combining a whole list with ```combine```
* ```identity``` - An identity element for ```combine``` * ```identity``` - An identity element for ```combine```
* ```apply(value, player)``` - Apply the effect represented by ```value``` to * ```apply(value, player)``` - Apply the effect represented by ```value```
```player``` to ```player```
* ```on_change(val1, val2, player)``` - Do something when the value on a * ```on_change(val1, val2, player)``` - Do something when the value on a
player changes. (optional) player changes. (optional)
@ -71,9 +71,9 @@ Monoid Methods
argument ```id``` is supplied, that is used as the ID instead, and any existing argument ```id``` is supplied, that is used as the ID instead, and any existing
change with that ID is removed. change with that ID is removed.
```monoid:del_change(player, id)``` - Removes the change with the given ID, if ```monoid:del_change(id)``` - Removes the change with the given ID, if
it exists. it exists.
Monoid Properties Monoid Properties
----------------- -----------------
```monoid.value()``` - The current combined value of the monoid. ```monoid.value``` - The current combined value of the monoid.