tacotexmex/late
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fixed a mistake on condition data documentation

Browse Source
This commit is contained in:
Pierre-Yves Rollo 2018-11-19 10:37:49 +01:00
parent 0e4e3b6916
commit 8ee875b267
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
API.md
View File

@ -247,7 +247,7 @@ Registering new condition types allows to extend the available types of conditio
### Condition definition table
`definition` table may contain following fields:
* `check` (optional) = function(data, target, effect) A function called to check is a condition is fulfilled. Should return true if condition still fulfilled, false otherwise. This function is not called at each step, only when engine needs it. Function parameters:
* `data`: effect data
* `data`: condition data (value of this condition field in effect definition)
* `target`: target affected,
* `effect`: Effect object instance.
* `step` (optional) = function(data, target, effect) A function called at each step. Could be useful to prepare condition checking. Same parameters as `check` function.