@gamepark/rules-api 6.24.2 → 6.25.0

package/dist/material/HiddenMaterialRules.js.map

@@ -1 +1 @@
-{"version":3,"file":"HiddenMaterialRules.js","sourceRoot":"","sources":["../../src/material/HiddenMaterialRules.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAA0C;AAC1C,mDAA4B;AAC5B,2DAAoC;AACpC,+DAAwC;AACxC,mDAA4B;AAC5B,uDAAgC;AAKhC,iDAA+C;AAC/C,iCAegB;AAShB;IACU,uCAAsB;IAG9B,6BAAY,IAA2B,EAAmB,MAAuB;QAC/E,YAAA,MAAK,YAAC,IAAI,CAAC,SAAA;QAD6C,YAAM,GAAN,MAAM,CAAiB;;IAEjF,CAAC;IAUD,uCAAS,GAAT,UAAU,IAA2B;QACnC,IAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,CAAC,EAAE,CAAC;YAMnC,6BAAY,IAAI,KAAE,MAAM,EAAE,EAAE,IAAE;QAChC,CAAC;QACD,OAAO,gBAAK,CAAC,SAAS,YAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAEO,iDAAmB,GAA3B,UAA4B,IAA2B;QAAvD,iBAGC;QAFC,OAAO,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAA,MAAM,IAAI,OAAA,KAAI,CAAC,2BAA2B,CAAC,IAAI,EAAE,MAAM,CAAC,EAA9C,CAA8C,CAAC,CAAC;YAC3G,CAAC,IAAA,yBAAiB,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAA,MAAM,IAAI,OAAA,KAAI,CAAC,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,EAAhD,CAAgD,CAAC,CAAC,CAAA;IACnH,CAAC;IAKD,2CAAa,GAAb,UAAc,IAAO;QACnB,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAKD,iDAAmB,GAAnB,UAAoB,IAA2B,EAAE,MAAS;QAA1D,iBAcC;QAbC,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACvD,CAAC;aAAM,IAAI,IAAA,yBAAiB,EAAC,IAAI,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACzD,CAAC;aAAM,IAAI,IAAA,oBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACxE,CAAC;aAAM,IAAI,IAAA,2BAAmB,EAAC,IAAI,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,EAA1D,CAA0D,CAAC,CAAA;QAC5F,CAAC;aAAM,IAAI,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,OAAO,gBAAK,CAAC,mBAAmB,YAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAKS,4CAAc,GAAxB,UAAyB,IAA2B;QAClD,OAAO,gBAAK,CAAC,cAAc,YAAC,IAAI,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;IACvE,CAAC;IAMS,mDAAqB,GAA/B,UAAgC,IAA2B;QACzD,OAAO,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAA,yBAAiB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;IACvE,CAAC;IAKD,qCAAO,GAAP,UAAQ,MAAU;QAAlB,iBAUC;QATC,6BACK,IAAI,CAAC,IAAI,KACZ,KAAK,EAAE,IAAA,mBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,UAAC,KAAK,EAAE,UAAU;gBAClD,IAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAM,CAAA;gBAC3C,IAAM,gBAAgB,GAAG,KAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAA;gBACzD,IAAI,CAAC,gBAAgB,IAAI,CAAC,KAAK;oBAAE,OAAO,KAAK,CAAA;gBAC7C,OAAO,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,EAAtC,CAAsC,CAAC,CAAA;YAClE,CAAC,CAAC,IACH;IACH,CAAC;IAEO,sCAAQ,GAAhB,UAAiB,IAAO,EAAE,IAAwB,EAAE,MAAU;QAC5D,IAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QAC9B,IAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;QACnD,KAAmB,UAAK,EAAL,eAAK,EAAL,mBAAK,EAAL,IAAK,EAAE,CAAC;YAAtB,IAAM,IAAI,cAAA;YACb,IAAA,eAAK,EAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACzB,CAAC;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAGO,gDAAkB,GAA1B,UAA2B,IAAO,EAAE,IAAwB,EAAE,MAAU;;QACtE,IAAM,cAAc,GAAG,MAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,0CAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACxE,OAAO,cAAc,CAAC,CAAC,CAAE,cAA8C,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC5F,CAAC;IAEO,sDAAwB,GAAhC,UAAiC,IAAO,EAAE,IAAwB,EAAE,MAAU;QAC5E,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IAC/D,CAAC;IAMD,uDAAyB,GAAzB,UAA0B,UAAiC,EAAE,UAAiC;QAC5F,IAAI,IAAA,kBAAU,EAAC,UAAU,CAAC,IAAI,IAAA,kBAAU,EAAC,UAAU,CAAC,EAAE,CAAC;YAC7C,IAAA,MAAM,GAAiC,UAAU,OAA3C,EAAK,uBAAuB,UAAK,UAAU,EAAnD,UAAsC,CAAF,CAAe;YACzD,OAAO,IAAA,iBAAO,EAAC,UAAU,EAAE,uBAAuB,CAAC,CAAA;QACrD,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAKD,yCAAW,GAAX,UAAY,IAAqC,EAAE,MAAU;QAA7D,iBAgBC;QAfC,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC9E,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,oBAAY,CAAC,IAAI;oBACpB,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAC3C,KAAK,oBAAY,CAAC,UAAU;oBAC1B,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAC7C,KAAK,oBAAY,CAAC,MAAM;oBACtB,6BAAY,IAAI,KAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAE;gBAC3E,KAAK,oBAAY,CAAC,YAAY;oBAC5B,6BAAY,IAAI,KAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,EAA1C,CAA0C,CAAC,IAAE;gBAC/F,KAAK,oBAAY,CAAC,OAAO;oBACvB,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,6CAAe,GAAvB,UAAwB,IAAuB,EAAE,MAAU;QACzD,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QAC7B,IAAM,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAChE,IAAI,CAAC,aAAa,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QACtC,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAE,CAAA;QAClE,IAAM,QAAQ,yBAAQ,IAAI,KAAE,MAAM,EAAE,EAAE,GAAE,CAAA;QACxC,KAAmB,UAAa,EAAb,+BAAa,EAAb,2BAAa,EAAb,IAAa,EAAE,CAAC;YAA9B,IAAM,IAAI,sBAAA;YACb,IAAA,aAAG,EAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,IAAA,aAAG,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;QAC7C,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,+CAAiB,GAAzB,UAA0B,IAA8B,EAAE,MAAU;QAClE,IAAI,CAAC,IAAI,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QAC7B,IAAM,QAAQ,yBAAkC,IAAI,KAAE,MAAM,EAAE,EAAE,GAAE,CAAA;QAClE,KAAoB,UAAY,EAAZ,KAAA,IAAI,CAAC,OAAO,EAAZ,cAAY,EAAZ,IAAY,EAAE,CAAC;YAA9B,IAAM,KAAK,SAAA;YACd,IAAM,aAAa,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;YACzE,IAAI,CAAC,aAAa,CAAC,MAAM;gBAAE,SAAQ;YACnC,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAE,CAAA;YACzD,QAAQ,CAAC,MAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;YAC5B,KAAmB,UAAa,EAAb,+BAAa,EAAb,2BAAa,EAAb,IAAa,EAAE,CAAC;gBAA9B,IAAM,IAAI,sBAAA;gBACb,IAAA,aAAG,EAAC,QAAQ,CAAC,MAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAA,aAAG,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,qDAAuB,GAA/B,UAAgC,IAAuB,EAAE,MAAU;QACjE,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAE,CAAA;QAClE,IAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAC9E,IAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;QAC3H,OAAO,IAAA,oBAAU,EAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAA;IACxD,CAAC;IAEO,uDAAyB,GAAjC,UAAkC,IAA8B,EAAE,SAAiB,EAAE,MAAU;QAC7F,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,SAAS,CAAE,CAAA;QAC7D,IAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAC9E,IAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAA;QAC5I,OAAO,IAAA,oBAAU,EAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAA;IACxD,CAAC;IAEO,yDAA2B,GAAnC,UAAoC,IAAuB,EAAE,MAAU;QACrE,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IAC9D,CAAC;IAEO,2DAA6B,GAArC,UAAsC,IAA8B,EAAE,MAAU;QAAhF,iBAEC;QADC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAC,KAAK,IAAK,OAAA,KAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,MAAM,EAA1D,CAA0D,CAAC,CAAA;IACjG,CAAC;IAEO,iDAAmB,GAA3B,UAA4B,IAA0B,EAAE,MAAU;QAChE,IAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC;YAAE,OAAO,IAAI,CAAA;QAC/C,IAAA,UAAU,GAAkB,IAAI,WAAtB,EAAK,QAAQ,UAAK,IAAI,EAAlC,cAA2B,CAAF,CAAS;QACxC,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,iDAAmB,GAA3B,UAA4B,IAAgB,EAAE,MAAU;QAAxD,iBAeC;QAdC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAO,IAAI,CAAA;QACtD,IAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7C,IAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAE,EAAE,MAAM,CAAC,CAAA;QACtG,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAA,KAAK;YACnE,OAAA,CAAC,IAAA,iBAAO,EAAC,WAAW,EAAE,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAE,EAAE,MAAM,CAAC,CAAC;QAA/F,CAA+F,CAChG,EAAE,CAAC;YACF,MAAM,IAAI,UAAU,CAAC,qEACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAE,EAAE,MAAM,CAAC,EAAxE,CAAwE,CAAC,CAAC,CACnH,CAAC,CAAA;QACL,CAAC;QAID,OAAO,CAAC,WAAW,CAAC,MAAM,CAAA;IAC5B,CAAC;IAKD,kCAAI,GAAJ,UAAK,IAAiE,EAAE,OAAyB;QAC/F,IAAM,MAAM,GAAG,gBAAK,CAAC,IAAI,YAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAExC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5E,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACjE,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YAC1G,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAA,yBAAiB,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACnF,KAAoB,UAAY,EAAZ,KAAA,IAAI,CAAC,OAAO,EAAZ,cAAY,EAAZ,IAAY,EAAE,CAAC;gBAA9B,IAAM,KAAK,SAAA;gBACd,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBACxD,IAAI,IAAI,EAAE,CAAC;oBACT,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;gBACjG,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IACH,0BAAC;AAAD,CAAC,AA/OD,CACU,6BAAa,GA8OtB;AA/OqB,kDAAmB;AA0PlC,IAAM,UAAU,GAAmB,cAAM,OAAA,CAAC,IAAI,CAAC,EAAN,CAAM,CAAA;AAAzC,QAAA,UAAU,cAA+B;AAK/C,IAAM,SAAS,GAAmB,cAAM,OAAA,CAAC,UAAU,CAAC,EAAZ,CAAY,CAAA;AAA9C,QAAA,SAAS,aAAqC"}
+{"version":3,"file":"HiddenMaterialRules.js","sourceRoot":"","sources":["../../src/material/HiddenMaterialRules.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAAA,iEAA0C;AAC1C,mDAA4B;AAC5B,2DAAoC;AACpC,+DAAwC;AACxC,mDAA4B;AAC5B,uDAAgC;AAKhC,iDAA+C;AAC/C,iCAegB;AAGhB;;;;;GAKG;AACH;IACU,uCAAsB;IAG9B,6BAAY,IAA2B,EAAmB,MAAuB;QAC/E,YAAA,MAAK,YAAC,IAAI,CAAC,SAAA;QAD6C,YAAM,GAAN,MAAM,CAAiB;;IAEjF,CAAC;IAUD,uCAAS,GAAT,UAAU,IAA2B,EAAE,MAAU;QAC/C,IAAI,MAAM,KAAK,SAAS,IAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,EAAE,CAAC;YACnE,uGAAuG;YACvG,kEAAkE;YAClE,uHAAuH;YACvH,6DAA6D;YAC7D,wJAAwJ;YACxJ,6BAAY,IAAI,KAAE,MAAM,EAAE,EAAE,IAAE;QAChC,CAAC;QACD,OAAO,gBAAK,CAAC,SAAS,YAAC,IAAI,CAAC,CAAA;IAC9B,CAAC;IAEO,iDAAmB,GAA3B,UAA4B,IAA2B,EAAE,MAAS;QAChE,OAAO,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,2BAA2B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;eACtE,CAAC,IAAA,yBAAiB,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAA;IACpF,CAAC;IAED;;OAEG;IACH,2CAAa,GAAb,UAAc,IAAO;QACnB,OAAO,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAA;IACrC,CAAC;IAED;;OAEG;IACH,iDAAmB,GAAnB,UAAoB,IAA2B,EAAE,MAAS;QAA1D,iBAcC;QAbC,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,2BAA2B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACvD,CAAC;aAAM,IAAI,IAAA,yBAAiB,EAAC,IAAI,CAAC,EAAE,CAAC;YACnC,OAAO,IAAI,CAAC,6BAA6B,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACzD,CAAC;aAAM,IAAI,IAAA,oBAAY,EAAC,IAAI,CAAC,EAAE,CAAC;YAC9B,OAAO,IAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QACxE,CAAC;aAAM,IAAI,IAAA,2BAAmB,EAAC,IAAI,CAAC,EAAE,CAAC;YACrC,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,wBAAwB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,EAA1D,CAA0D,CAAC,CAAA;QAC5F,CAAC;aAAM,IAAI,IAAA,iBAAS,EAAC,IAAI,CAAC,EAAE,CAAC;YAC3B,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAC/C,CAAC;aAAM,CAAC;YACN,OAAO,gBAAK,CAAC,mBAAmB,YAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAChD,CAAC;IACH,CAAC;IAED;;OAEG;IACO,4CAAc,GAAxB,UAAyB,IAA2B;QAClD,OAAO,gBAAK,CAAC,cAAc,YAAC,IAAI,CAAC,IAAI,IAAI,CAAC,qBAAqB,CAAC,IAAI,CAAC,CAAA;IACvE,CAAC;IAED;;;OAGG;IACO,mDAAqB,GAA/B,UAAgC,IAA2B;QACzD,OAAO,CAAC,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAA,yBAAiB,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAA;IACvE,CAAC;IAED;;OAEG;IACH,qCAAO,GAAP,UAAQ,MAAU;QAAlB,iBAUC;QATC,6BACK,IAAI,CAAC,IAAI,KACZ,KAAK,EAAE,IAAA,mBAAS,EAAC,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,UAAC,KAAK,EAAE,UAAU;gBAClD,IAAM,SAAS,GAAG,QAAQ,CAAC,UAAU,CAAM,CAAA;gBAC3C,IAAM,gBAAgB,GAAG,KAAI,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAA;gBACzD,IAAI,CAAC,gBAAgB,IAAI,CAAC,KAAK;oBAAE,OAAO,KAAK,CAAA;gBAC7C,OAAO,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,IAAI,EAAE,MAAM,CAAC,EAAtC,CAAsC,CAAC,CAAA;YAClE,CAAC,CAAC,IACH;IACH,CAAC;IAEO,sCAAQ,GAAhB,UAAiB,IAAO,EAAE,IAAwB,EAAE,MAAU;QAC5D,IAAM,KAAK,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QACzD,IAAI,CAAC,KAAK,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QAC9B,IAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAA;QACnD,KAAmB,UAAK,EAAL,eAAK,EAAL,mBAAK,EAAL,IAAK,EAAE,CAAC;YAAtB,IAAM,IAAI,cAAA;YACb,IAAA,eAAK,EAAC,UAAU,EAAE,IAAI,CAAC,CAAA;QACzB,CAAC;QACD,OAAO,UAAU,CAAA;IACnB,CAAC;IAGO,gDAAkB,GAA1B,UAA2B,IAAO,EAAE,IAAwB,EAAE,MAAU;;QACtE,IAAM,cAAc,GAAG,MAAA,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,0CAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAA;QACxE,OAAO,cAAc,CAAC,CAAC,CAAE,cAA8C,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAA;IAC5F,CAAC;IAEO,sDAAwB,GAAhC,UAAiC,IAAO,EAAE,IAAwB,EAAE,MAAU;QAC5E,OAAO,IAAI,CAAC,kBAAkB,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IAC/D,CAAC;IAED;;;OAGG;IACH,uDAAyB,GAAzB,UAA0B,UAAiC,EAAE,UAAiC;QAC5F,IAAI,IAAA,kBAAU,EAAC,UAAU,CAAC,IAAI,IAAA,kBAAU,EAAC,UAAU,CAAC,EAAE,CAAC;YAC7C,IAAA,MAAM,GAAiC,UAAU,OAA3C,EAAK,uBAAuB,UAAK,UAAU,EAAnD,UAAsC,CAAF,CAAe;YACzD,OAAO,IAAA,iBAAO,EAAC,UAAU,EAAE,uBAAuB,CAAC,CAAA;QACrD,CAAC;QACD,OAAO,KAAK,CAAA;IACd,CAAC;IAED;;OAEG;IACH,yCAAW,GAAX,UAAY,IAAqC,EAAE,MAAU;QAA7D,iBAgBC;QAfC,IAAI,IAAI,CAAC,IAAI,KAAK,gBAAQ,CAAC,QAAQ,IAAI,IAAI,CAAC,QAAQ,IAAI,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAC9E,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,oBAAY,CAAC,IAAI;oBACpB,OAAO,IAAI,CAAC,eAAe,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAC3C,KAAK,oBAAY,CAAC,UAAU;oBAC1B,OAAO,IAAI,CAAC,iBAAiB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;gBAC7C,KAAK,oBAAY,CAAC,MAAM;oBACtB,6BAAY,IAAI,KAAE,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,IAAE;gBAC3E,KAAK,oBAAY,CAAC,YAAY;oBAC5B,6BAAY,IAAI,KAAE,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,EAA1C,CAA0C,CAAC,IAAE;gBAC/F,KAAK,oBAAY,CAAC,OAAO;oBACvB,OAAO,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;YACjD,CAAC;QACH,CAAC;QACD,OAAO,IAAI,CAAA;IACb,CAAC;IAEO,6CAAe,GAAvB,UAAwB,IAAuB,EAAE,MAAU;QACzD,IAAM,aAAa,GAAG,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;QAChE,IAAI,CAAC,aAAa,CAAC,MAAM;YAAE,OAAO,IAAI,CAAA;QACtC,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACjE,IAAM,QAAQ,yBAAQ,IAAI,KAAE,MAAM,EAAE,EAAE,GAAE,CAAA;QACxC,KAAmB,UAAa,EAAb,+BAAa,EAAb,2BAAa,EAAb,IAAa,EAAE,CAAC;YAA9B,IAAM,IAAI,sBAAA;YACb,IAAA,aAAG,EAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,EAAE,IAAA,aAAG,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;QAC7C,CAAC;QACD,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,+CAAiB,GAAzB,UAA0B,IAA8B,EAAE,MAAU;QAClE,IAAM,QAAQ,gBAAkC,IAAI,CAAE,CAAA;QACtD,KAAoB,UAAY,EAAZ,KAAA,IAAI,CAAC,OAAO,EAAZ,cAAY,EAAZ,IAAY,EAAE,CAAC;YAA9B,IAAM,KAAK,SAAA;YACd,IAAM,aAAa,GAAG,IAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAA;YACzE,IAAI,CAAC,aAAa,CAAC,MAAM;gBAAE,SAAQ;YACnC,IAAI,CAAC,QAAQ,CAAC,MAAM;gBAAE,QAAQ,CAAC,MAAM,GAAG,EAAE,CAAA;YAC1C,QAAQ,CAAC,MAAO,CAAC,KAAK,CAAC,GAAG,EAAE,CAAA;YAC5B,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;YACxD,KAAmB,UAAa,EAAb,+BAAa,EAAb,2BAAa,EAAb,IAAa,EAAE,CAAC;gBAA9B,IAAM,IAAI,sBAAA;gBACb,IAAA,aAAG,EAAC,QAAQ,CAAC,MAAO,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,IAAA,aAAG,EAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAA;YACrD,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,qDAAuB,GAA/B,UAAgC,IAAuB,EAAE,MAAU;QACjE,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;QACjE,IAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAC9E,IAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,gBAAgB,CAAC,IAAI,CAAC,EAAE,MAAM,CAAC,CAAA;QAC3H,OAAO,IAAA,oBAAU,EAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAA;IACxD,CAAC;IAEO,uDAAyB,GAAjC,UAAkC,IAA8B,EAAE,SAAiB,EAAE,MAAU;QAC7F,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,SAAS,CAAC,CAAA;QAC5D,IAAM,iBAAiB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,MAAM,CAAC,CAAA;QAC9E,IAAM,gBAAgB,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,sBAAsB,CAAC,IAAI,EAAE,SAAS,CAAC,EAAE,MAAM,CAAC,CAAA;QAC5I,OAAO,IAAA,oBAAU,EAAC,iBAAiB,EAAE,gBAAgB,CAAC,CAAA;IACxD,CAAC;IAEO,yDAA2B,GAAnC,UAAoC,IAAuB,EAAE,MAAS;QACpE,OAAO,IAAI,CAAC,uBAAuB,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC,MAAM,GAAG,CAAC,CAAA;IAC9D,CAAC;IAEO,2DAA6B,GAArC,UAAsC,IAA8B,EAAE,MAAU;QAAhF,iBAEC;QADC,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAC,KAAK,IAAK,OAAA,KAAI,CAAC,yBAAyB,CAAC,IAAI,EAAE,KAAK,EAAE,MAAM,CAAC,CAAC,MAAM,EAA1D,CAA0D,CAAC,CAAA;IACjG,CAAC;IAEO,iDAAmB,GAA3B,UAA4B,IAA0B,EAAE,MAAU;QAChE,IAAI,IAAI,CAAC,mBAAmB,CAAC,IAAI,EAAE,MAAM,CAAC;YAAE,OAAO,IAAI,CAAA;QAC/C,IAAA,UAAU,GAAkB,IAAI,WAAtB,EAAK,QAAQ,UAAK,IAAI,EAAlC,cAA2B,CAAF,CAAS;QACxC,OAAO,QAAQ,CAAA;IACjB,CAAC;IAEO,iDAAmB,GAA3B,UAA4B,IAAgB,EAAE,MAAU;QAAxD,iBAeC;QAdC,IAAI,CAAC,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC;YAAE,OAAO,IAAI,CAAA;QACtD,IAAM,QAAQ,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAA;QAC7C,IAAM,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,CAAA;QACrG,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,IAAI,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAA,KAAK;YACnE,OAAA,CAAC,IAAA,iBAAO,EAAC,WAAW,EAAE,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,CAAC;QAA9F,CAA8F,CAC/F,EAAE,CAAC;YACF,MAAM,IAAI,UAAU,CAAC,qEACnB,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,KAAI,CAAC,kBAAkB,CAAC,IAAI,CAAC,QAAQ,EAAE,QAAQ,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,MAAM,CAAC,EAAvE,CAAuE,CAAC,CAAC,CAClH,CAAC,CAAA;QACL,CAAC;QACD,wHAAwH;QACxH,uGAAuG;QACvG,6EAA6E;QAC7E,OAAO,CAAC,WAAW,CAAC,MAAM,CAAA;IAC5B,CAAC;IAED;;OAEG;IACH,kCAAI,GAAJ,UAAK,IAAiE,EAAE,OAAyB;QAC/F,IAAM,MAAM,GAAG,gBAAK,CAAC,IAAI,YAAC,IAAI,EAAE,OAAO,CAAC,CAAA;QAExC,IAAI,IAAI,CAAC,MAAM,IAAI,IAAA,kBAAU,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YAC5E,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAA;YACjE,IAAI,IAAI,EAAE,CAAC;gBACT,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAE,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;YAC1G,CAAC;QACH,CAAC;QAED,IAAI,IAAI,CAAC,MAAM,IAAI,IAAA,yBAAiB,EAAC,IAAI,CAAC,IAAI,IAAI,CAAC,gBAAgB,CAAC,IAAI,CAAC,QAAQ,CAAC,EAAE,CAAC;YACnF,KAAoB,UAAY,EAAZ,KAAA,IAAI,CAAC,OAAO,EAAZ,cAAY,EAAZ,IAAY,EAAE,CAAC;gBAA9B,IAAM,KAAK,SAAA;gBACd,IAAM,IAAI,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,CAAA;gBACxD,IAAI,IAAI,EAAE,CAAC;oBACT,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAE,CAAC,KAAK,CAAC,GAAG,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;gBACjG,CAAC;YACH,CAAC;QACH,CAAC;QAED,OAAO,MAAM,CAAA;IACf,CAAC;IACH,0BAAC;AAAD,CAAC,AA9OD,CACU,6BAAa,GA6OtB;AA9OqB,kDAAmB;AAsPzC;;GAEG;AACI,IAAM,UAAU,GAAmB,cAAM,OAAA,CAAC,IAAI,CAAC,EAAN,CAAM,CAAA;AAAzC,QAAA,UAAU,cAA+B;AAEtD;;GAEG;AACI,IAAM,SAAS,GAAmB,cAAM,OAAA,CAAC,UAAU,CAAC,EAAZ,CAAY,CAAA;AAA9C,QAAA,SAAS,aAAqC"}

package/dist/material/MaterialGame.d.ts

@@ -2,6 +2,18 @@ import { MaterialItem } from './items';
 import { DisplayedItem, HelpDisplay } from './moves';
 import { RuleStep } from './rules';
 import { TutorialState } from './tutorial';
+/**
+ * The data structure of a game implemented with the {@link MaterialRules} approach.
+ * The game state should not be manipulated directly, but using the {@link MaterialMove} and {@link MaterialRulesPart} utilities.
+ *
+ * @property players Array of the identifiers of the players, ordered by their position around the table
+ * @property items All the {@link MaterialItem}s in the game. An item is identified by its type and its index in the array: items[type][index]
+ * @property rule The current step in the rules. See {@link MaterialRules.rules} and {@link RuleStep}
+ * @property memory A key-value record of free values when some state do not fit in items or rule properties. See {@link GameMemory} and {@link PlayerMemory}.
+ * @property helpDisplay Current help dialog opened on the client side
+ * @property droppedItem Item that was just dropped on the client side
+ * @property tutorial The {@link TutorialState}, only set for tutorial games
+ */
 export type MaterialGame<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> = {
     players: Player[];
     items: Partial<Record<MaterialType, MaterialItem<Player, LocationType>[]>>;

package/dist/material/MaterialGameSetup.d.ts

@@ -5,19 +5,93 @@ import { MaterialRules, MaterialRulesCreator } from './MaterialRules';
 import { GameMemory, PlayerMemory } from './memory';
 import { MaterialMove } from './moves';
 import { TutorialState } from './tutorial';
+/**
+ * Helper class to implement {@link GameSetup} when using the {@link MaterialRules} approach.
+ */
 export declare abstract class MaterialGameSetup<P extends number = number, M extends number = number, L extends number = number, Options = any> implements GameSetup<MaterialGame<P, M, L>, Options> {
+    /**
+     * The rules of the game
+     */
     abstract Rules: MaterialRulesCreator<P, M, L>;
+    /**
+     * The game setup state we are working on
+     * @protected
+     */
     protected game: MaterialGame<P, M, L>;
+    /**
+     * Get an instance of the rules of the game
+     */
     get rules(): MaterialRules<P, M, L>;
+    /**
+     * Entry point for {@link GameSetup}
+     * @param options Options of the game
+     * @param tutorial Initial tutorial state if any
+     * @returns the initial state of the game
+     */
     setup(options: Options, tutorial?: TutorialState): MaterialGame<P, M, L>;
+    /**
+     * @returns array of the player ids (shortcut for this.game.players)
+     */
     get players(): P[];
+    /**
+     * Override this function if you need to set up some material before the game starts. Called by {@link setup}.
+     * @param _options Options of the game
+     */
     setupMaterial(_options: Options): void;
+    /**
+     * Help function to execute a move immediately on the game state.
+     * When the game is on, the moves should never be played directly: the framework takes care of playing the moves when necessary
+     * (on te server, on the clients, during replays...).
+     * However, during the setup, the moves must be played immediately in the game state to provide the initial game state to the framework.
+     * This help function allows to easily play a {@link MaterialMove}, using the rules provided in {@link Rules}, including the consequences.
+     *
+     * @param move The MaterialMove to play
+     * @protected
+     */
     protected playMove(move: MaterialMove<P, M, L>): void;
+    /**
+     * Helper function to manipulate the items of the game. See {@link Material}.
+     * @param type The type of Material we want to work on
+     * @returns a Material instance to manipulate all the material of that type in current game state.
+     */
     material(type: M): Material<P, M, L>;
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     protected getMemory(player?: P): GameMemory<P> | PlayerMemory<P>;
+    /**
+     * Helper function to memorize some information that does not fit in an item or the rules state, in the game state
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param value Value to memorize
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     memorize<T = any>(key: keyof any, value: T | ((lastValue: T) => T), player?: P): void;
+    /**
+     * Implement this function to provide the first rules step of the game (see {@link MaterialRules.rules}). Called by {@link setup}.
+     * You can use {@link startPlayerTurn} or {@link startSimultaneousRule} for instance.
+     * @param options Options of the game
+     */
     abstract start(options: Options): void;
+    /**
+     * Helper function to play a {@link StartPlayerTurn} move on the game setup state.
+     * @param id Rule id to start
+     * @param player Player that starts the game (default value: this.game.players[0])
+     */
     startPlayerTurn<RuleId extends number = number>(id: RuleId, player?: P): void;
+    /**
+     * Helper function to play a {@link StartSimultaneousRule} move on the game setup state.
+     * @param id Rule id to start
+     * @param players Players that are active (all the players by default)
+     */
     startSimultaneousRule<RuleId extends number = number>(id: RuleId, players?: P[]): void;
+    /**
+     * Helper function to play a {@link StartRule} move on the game setup state.
+     * @param id Rule id to start
+     */
     startRule<RuleId extends number = number>(id: RuleId): void;
 }

package/dist/material/MaterialGameSetup.js

@@ -5,17 +5,33 @@ var utils_1 = require("../utils");
 var items_1 = require("./items");
 var memory_1 = require("./memory");
 var moves_1 = require("./moves");
-var MaterialGameSetup = (function () {
+/**
+ * Helper class to implement {@link GameSetup} when using the {@link MaterialRules} approach.
+ */
+var MaterialGameSetup = /** @class */ (function () {
     function MaterialGameSetup() {
+        /**
+         * The game setup state we are working on
+         * @protected
+         */
         this.game = { players: [], items: {}, memory: {} };
     }
     Object.defineProperty(MaterialGameSetup.prototype, "rules", {
+        /**
+         * Get an instance of the rules of the game
+         */
         get: function () {
             return new this.Rules(this.game);
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * Entry point for {@link GameSetup}
+     * @param options Options of the game
+     * @param tutorial Initial tutorial state if any
+     * @returns the initial state of the game
+     */
     MaterialGameSetup.prototype.setup = function (options, tutorial) {
         this.game = { players: getPlayerIds(options), items: {}, memory: {}, tutorial: tutorial };
         this.setupMaterial(options);
@@ -23,14 +39,31 @@ var MaterialGameSetup = (function () {
         return this.game;
     };
     Object.defineProperty(MaterialGameSetup.prototype, "players", {
+        /**
+         * @returns array of the player ids (shortcut for this.game.players)
+         */
         get: function () {
             return this.game.players;
         },
         enumerable: false,
         configurable: true
     });
+    /**
+     * Override this function if you need to set up some material before the game starts. Called by {@link setup}.
+     * @param _options Options of the game
+     */
     MaterialGameSetup.prototype.setupMaterial = function (_options) {
     };
+    /**
+     * Help function to execute a move immediately on the game state.
+     * When the game is on, the moves should never be played directly: the framework takes care of playing the moves when necessary
+     * (on te server, on the clients, during replays...).
+     * However, during the setup, the moves must be played immediately in the game state to provide the initial game state to the framework.
+     * This help function allows to easily play a {@link MaterialMove}, using the rules provided in {@link Rules}, including the consequences.
+     *
+     * @param move The MaterialMove to play
+     * @protected
+     */
     MaterialGameSetup.prototype.playMove = function (move) {
         if ((0, utils_1.hasRandomMove)(this.rules)) {
             move = this.rules.randomize(move);
@@ -38,26 +71,56 @@ var MaterialGameSetup = (function () {
         var consequences = this.rules.play(JSON.parse(JSON.stringify(move)));
         (0, utils_1.applyAutomaticMoves)(this.rules, consequences);
     };
+    /**
+     * Helper function to manipulate the items of the game. See {@link Material}.
+     * @param type The type of Material we want to work on
+     * @returns a Material instance to manipulate all the material of that type in current game state.
+     */
     MaterialGameSetup.prototype.material = function (type) {
         var _this = this;
-        if (!this.game.items[type])
-            this.game.items[type] = [];
-        var items = this.game.items[type];
-        return new items_1.Material(type, Array.from(items.entries()).filter(function (entry) { return entry[1].quantity !== 0; }), function (move) { return _this.playMove(move); });
+        return new items_1.Material(type, this.game.items[type], function (move) { return _this.playMove(move); });
     };
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     MaterialGameSetup.prototype.getMemory = function (player) {
         return player === undefined ? new memory_1.GameMemory(this.game) : new memory_1.PlayerMemory(this.game, player);
     };
+    /**
+     * Helper function to memorize some information that does not fit in an item or the rules state, in the game state
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param value Value to memorize
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     MaterialGameSetup.prototype.memorize = function (key, value, player) {
         this.getMemory(player).memorize(key, value);
     };
+    /**
+     * Helper function to play a {@link StartPlayerTurn} move on the game setup state.
+     * @param id Rule id to start
+     * @param player Player that starts the game (default value: this.game.players[0])
+     */
     MaterialGameSetup.prototype.startPlayerTurn = function (id, player) {
         if (player === void 0) { player = this.game.players[0]; }
         this.playMove(moves_1.MaterialMoveBuilder.startPlayerTurn(id, player));
     };
+    /**
+     * Helper function to play a {@link StartSimultaneousRule} move on the game setup state.
+     * @param id Rule id to start
+     * @param players Players that are active (all the players by default)
+     */
     MaterialGameSetup.prototype.startSimultaneousRule = function (id, players) {
         this.playMove(moves_1.MaterialMoveBuilder.startSimultaneousRule(id, players));
     };
+    /**
+     * Helper function to play a {@link StartRule} move on the game setup state.
+     * @param id Rule id to start
+     */
     MaterialGameSetup.prototype.startRule = function (id) {
         this.playMove(moves_1.MaterialMoveBuilder.startRule(id));
     };

package/dist/material/MaterialGameSetup.js.map

@@ -1 +1 @@
-{"version":3,"file":"MaterialGameSetup.js","sourceRoot":"","sources":["../../src/material/MaterialGameSetup.ts"],"names":[],"mappings":";;;AACA,kCAA6D;AAC7D,iCAAkC;AAGlC,mCAAmD;AACnD,iCAA2D;AAM3D;IAAA;QAYY,SAAI,GAA0B,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IAuHhF,CAAC;IAlHC,sBAAI,oCAAK;aAAT;YACE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC;;;OAAA;IAQD,iCAAK,GAAL,UAAM,OAAgB,EAAE,QAAwB;QAC9C,IAAI,CAAC,IAAI,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,UAAA,EAAE,CAAA;QAC/E,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACnB,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAKD,sBAAI,sCAAO;aAAX;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC1B,CAAC;;;OAAA;IAMD,yCAAa,GAAb,UAAc,QAAiB;IAC/B,CAAC;IAYS,oCAAQ,GAAlB,UAAmB,IAA2B;QAC5C,IAAI,IAAA,qBAAa,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QACD,IAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACtE,IAAA,2BAAmB,EAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAC/C,CAAC;IAOD,oCAAQ,GAAR,UAAS,IAAO;QAAhB,iBAIC;QAHC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,CAAA;QACtD,IAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAE,CAAA;QACpC,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC,CAAC,MAAM,CAAC,UAAA,KAAK,IAAI,OAAA,KAAK,CAAC,CAAC,CAAC,CAAC,QAAQ,KAAK,CAAC,EAAvB,CAAuB,CAAC,EAAE,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAA;IAC9H,CAAC;IAUS,qCAAS,GAAnB,UAAoB,MAAU;QAC5B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/F,CAAC;IAQD,oCAAQ,GAAR,UAAkB,GAAc,EAAE,KAAgC,EAAE,MAAU;QAC5E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC7C,CAAC;IAcD,2CAAe,GAAf,UAAgD,EAAU,EAAE,MAAgC;QAAhC,uBAAA,EAAA,SAAY,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAChE,CAAC;IAOD,iDAAqB,GAArB,UAAsD,EAAU,EAAE,OAAa;QAC7E,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAA;IACvE,CAAC;IAMD,qCAAS,GAAT,UAA0C,EAAU;QAClD,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAA;IAClD,CAAC;IACH,wBAAC;AAAD,CAAC,AAnID,IAmIC;AAnIqB,8CAAiB;AAqIvC,SAAS,YAAY,CAAiC,OAAY;;IAChE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnC,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,MAAW,EAAE,KAAa,YAAK,OAAA,MAAA,MAAM,CAAC,EAAE,mCAAI,KAAK,GAAG,CAAC,CAAA,EAAA,CAAC,CAAA;IACpF,CAAC;SAAM,CAAC;QACN,IAAM,eAAe,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,CAAC,CAAA;QAC5C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,CAAC,KAAK,GAAG,CAAC,CAAW,EAArB,CAAqB,CAAC,CAAA;IACtF,CAAC;AACH,CAAC"}
+{"version":3,"file":"MaterialGameSetup.js","sourceRoot":"","sources":["../../src/material/MaterialGameSetup.ts"],"names":[],"mappings":";;;AACA,kCAA6D;AAC7D,iCAAkC;AAGlC,mCAAmD;AACnD,iCAA2D;AAG3D;;GAEG;AACH;IAAA;QAQE;;;WAGG;QACO,SAAI,GAA0B,EAAE,OAAO,EAAE,EAAE,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAA;IAqHhF,CAAC;IAhHC,sBAAI,oCAAK;QAHT;;WAEG;aACH;YACE,OAAO,IAAI,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;QAClC,CAAC;;;OAAA;IAED;;;;;OAKG;IACH,iCAAK,GAAL,UAAM,OAAgB,EAAE,QAAwB;QAC9C,IAAI,CAAC,IAAI,GAAG,EAAE,OAAO,EAAE,YAAY,CAAC,OAAO,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,QAAQ,UAAA,EAAE,CAAA;QAC/E,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,CAAA;QAC3B,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAA;QACnB,OAAO,IAAI,CAAC,IAAI,CAAA;IAClB,CAAC;IAKD,sBAAI,sCAAO;QAHX;;WAEG;aACH;YACE,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,CAAA;QAC1B,CAAC;;;OAAA;IAED;;;OAGG;IACH,yCAAa,GAAb,UAAc,QAAiB;IAC/B,CAAC;IAED;;;;;;;;;OASG;IACO,oCAAQ,GAAlB,UAAmB,IAA2B;QAC5C,IAAI,IAAA,qBAAa,EAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;YAC9B,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAI,CAAC,CAAA;QACnC,CAAC;QACD,IAAM,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACtE,IAAA,2BAAmB,EAAC,IAAI,CAAC,KAAK,EAAE,YAAY,CAAC,CAAA;IAC/C,CAAC;IAED;;;;OAIG;IACH,oCAAQ,GAAR,UAAS,IAAO;QAAhB,iBAEC;QADC,OAAO,IAAI,gBAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,EAAE,UAAA,IAAI,IAAI,OAAA,KAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAnB,CAAmB,CAAC,CAAA;IAC/E,CAAC;IAED;;;;;;;OAOG;IACO,qCAAS,GAAnB,UAAoB,MAAU;QAC5B,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,mBAAU,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,qBAAY,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,CAAA;IAC/F,CAAC;IAED;;;;;OAKG;IACH,oCAAQ,GAAR,UAAkB,GAAc,EAAE,KAAgC,EAAE,MAAU;QAC5E,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC,QAAQ,CAAC,GAAG,EAAE,KAAK,CAAC,CAAA;IAC7C,CAAC;IASD;;;;OAIG;IACH,2CAAe,GAAf,UAAgD,EAAU,EAAE,MAAgC;QAAhC,uBAAA,EAAA,SAAY,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAC1F,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,eAAe,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC,CAAA;IAChE,CAAC;IAED;;;;OAIG;IACH,iDAAqB,GAArB,UAAsD,EAAU,EAAE,OAAa;QAC7E,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,qBAAqB,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC,CAAA;IACvE,CAAC;IAED;;;OAGG;IACH,qCAAS,GAAT,UAA0C,EAAU;QAClD,IAAI,CAAC,QAAQ,CAAC,2BAAmB,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC,CAAA;IAClD,CAAC;IACH,wBAAC;AAAD,CAAC,AAjID,IAiIC;AAjIqB,8CAAiB;AAmIvC,SAAS,YAAY,CAAiC,OAAY;;IAChE,IAAI,KAAK,CAAC,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACnC,OAAO,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,UAAC,MAAW,EAAE,KAAa,YAAK,OAAA,MAAA,MAAM,CAAC,EAAE,mCAAI,KAAK,GAAG,CAAC,CAAA,EAAA,CAAC,CAAA;IACpF,CAAC;SAAM,CAAC;QACN,IAAM,eAAe,GAAG,MAAA,OAAO,CAAC,OAAO,mCAAI,CAAC,CAAA;QAC5C,OAAO,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,GAAG,CAAC,UAAA,KAAK,IAAI,OAAA,CAAC,KAAK,GAAG,CAAC,CAAW,EAArB,CAAqB,CAAC,CAAA;IACtF,CAAC;AACH,CAAC"}

package/dist/material/MaterialRules.d.ts

@@ -1,6 +1,7 @@
 import { Action } from '../Action';
 import { RandomMove } from '../RandomMove';
 import { PlayMoveContext, Rules } from '../Rules';
+import { TimeLimit } from '../TimeLimit';
 import { Undo } from '../Undo';
 import { UnpredictableMoves } from '../UnpredictableMove';
 import { Material, MaterialMutator } from './items';
@@ -9,30 +10,161 @@ import { MaterialGame } from './MaterialGame';
 import { GameMemory, PlayerMemory } from './memory';
 import { MaterialMove, MaterialMoveRandomized, MaterialMoveView, RollItem } from './moves';
 import { MaterialRulesPart, MaterialRulesPartCreator } from './rules';
-export declare abstract class MaterialRules<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> extends Rules<MaterialGame<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> implements RandomMove<MaterialMove<Player, MaterialType, LocationType>, MaterialMoveRandomized<Player, MaterialType, LocationType>>, Undo<MaterialMove<Player, MaterialType, LocationType>, Player>, UnpredictableMoves<MaterialMove<Player, MaterialType, LocationType>> {
+/**
+ * The MaterialRules class is the main class to implement the rules of a board game with the "Material oriented" approach.
+ * With this approach, the game state and the game moves is structured around the game material items and their movements.
+ * The rules are also automatically split into small parts.
+ * Finally, a "memory" util is available to store temporary information which is not part of the material or the rules state.
+ * If you need to implement game with hidden information, see {@link HiddenMaterialRules} or {@link SecretMaterialRules}.
+ *
+ * @typeparam Player - identifier of a player. Either a number or a numeric enum (eg: PlayerColor)
+ * @typeparam MaterialType - Numeric enum of the types of material manipulated in the game
+ * @typeparam LocationType - Numeric enum of the types of location in the game where the material can be located
+ */
+export declare abstract class MaterialRules<Player extends number = number, MaterialType extends number = number, LocationType extends number = number> extends Rules<MaterialGame<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> implements RandomMove<MaterialMove<Player, MaterialType, LocationType>, MaterialMoveRandomized<Player, MaterialType, LocationType>, Player>, Undo<MaterialMove<Player, MaterialType, LocationType>, Player>, UnpredictableMoves<MaterialMove<Player, MaterialType, LocationType>>, TimeLimit<MaterialGame<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> {
+    /**
+     * When you implement a game using the "material" approach, you are also strongly advised to split the rules of the game into many small parts.
+     * You should usually create a numeric enum class "RuleId" that will list all those small parts.
+     * This "rules" property must be implemented to map each "rule id" with the corresponding MaterialRulesPart class.
+     * This way, the behavior of the rules can be delegated to the corresponding rule part at each step of the game.
+     */
     abstract readonly rules: Record<number, MaterialRulesPartCreator<Player, MaterialType, LocationType>>;
+    /**
+     * The "location strategies" are global rules that always apply in a game when we want to maintain a consistency in the position of the material.
+     * For example, we usually want the cards in a player hand to always go from x=0 to x=n without a gap, so we use a {@link PositiveSequenceStrategy} to enforce
+     * the rule once and for all. If we want to create a "river" of card we can use a {@link FillGapStrategy}.
+     * Games with more complex use cases can implement their own {@link LocationStrategy}.
+     */
     readonly locationsStrategies: Partial<Record<MaterialType, Partial<Record<LocationType, LocationStrategy<Player, MaterialType, LocationType>>>>>;
+    /**
+     * Helper function to manipulate the material items of the game. See {@link Material}.
+     *
+     * @param type The type of Material we want to work on
+     * @returns a Material instance to manipulate all the material of that type in current game state.
+     */
     material(type: MaterialType): Material<Player, MaterialType, LocationType>;
+    /**
+     * Shortcut for this.game.players
+     * @returns array of the players identifiers
+     */
     get players(): Player[];
+    /**
+     * Utility function to access the memory tool for the game or on player.
+     * this.game.memory can be used to store any data that is not available through the state of the material, or current rule.
+     *
+     * @param player Optional, identifier of the player if we want to manipulate a specific player's memory
+     * @returns {@link GameMemory} or {@link PlayerMemory} utility
+     * @protected
+     */
     protected getMemory(player?: Player): GameMemory<Player> | PlayerMemory<Player>;
+    /**
+     * Retrieve the value memorized under a given key.
+     * Shortcut for this.game.memory[key] or this.game.memory[key][player]
+     *
+     * @param key Key under which the memory is store. Usually a value of a numeric enum named "Memory".
+     * @param player optional, if we need to memorize a different value for each player.
+     */
     remind<T = any>(key: keyof any, player?: Player): T;
+    /**
+     * Instantiates the class that handled the rules of the game corresponding to the current rule id.
+     * This function reads the current value in this.game.rule.id and instantiate the corresponding class in the {@link rules} property.
+     *
+     * @returns the class that handled the rules of the game, at current specific game state.
+     */
     get rulesStep(): MaterialRulesPart<Player, MaterialType, LocationType> | undefined;
+    /**
+     * Returns a utility class to change the state of the items.
+     * Used by the framework to apply the Material moves on the items (should not be manipulated directly in the games).
+     *
+     * @param type MaterialType of the item we want to modify
+     * @returns a MaterialMutator to change the state of the items
+     */
     mutator(type: MaterialType): MaterialMutator<Player, MaterialType, LocationType>;
+    /**
+     * Items can sometime be stored with a quantity (for example, coins).
+     * By default, if you create or move similar items to the exact same location, they will merge into one item with a quantity.
+     * However, if you have 2 cards that can be at the same spot for a short time (swapping or replacing), you can override this function to prevent them to merge
+     *
+     * @param _type type of items
+     * @returns true if items can merge into one item with a quantity (default behavior)
+     */
     itemsCanMerge(_type: MaterialType): boolean;
+    /**
+     * In the material approach, the rules behavior is delegated to the current {@link rulesStep}. See {@link Rules.delegate}
+     */
     delegate(): Rules<MaterialGame<Player, MaterialType, LocationType>, MaterialMove<Player, MaterialType, LocationType>, Player> | undefined;
+    /**
+     * Randomize Shuffle of Roll moves (see {@link RandomMove.randomize})
+     * @param move The Material Move to randomize
+     * @returns the randomized move
+     */
     randomize(move: MaterialMove<Player, MaterialType, LocationType>): MaterialMove<Player, MaterialType, LocationType> & MaterialMoveRandomized<Player, MaterialType, LocationType>;
+    /**
+     * When a RollItem move is create, it has to be randomized on the server side before it is saved and shared.
+     * This function provides the random value. By default, it returns a value between 0 and 5 assuming a 6 sided dice is rolled.
+     * If you need to flip a coin or roll non-cubic dice, you need to override this function.
+     *
+     * @param _move The RollItem move to randomize
+     * @returns a random rolled value, by default a value between 0 and 5 (cubic dice result)
+     */
     roll(_move: RollItem<Player, MaterialType, LocationType>): number;
+    /**
+     * Execution of the Material Moves. See {@link Rules.play}.
+     *
+     * @param move Material move to play on the game state
+     * @param context Context in which the move was played
+     * @returns Consequences of the move
+     */
     play(move: MaterialMoveRandomized<Player, MaterialType, LocationType> | MaterialMoveView<Player, MaterialType, LocationType>, context?: PlayMoveContext): MaterialMove<Player, MaterialType, LocationType>[];
     private changeRule;
+    /**
+     * By default, a Material Move can be undone if no player became active and no dice was rolled.
+     * See {@link Undo.canUndo} and {@link HiddenMaterialRules.canUndo}
+     *
+     * @param action Action to consider
+     * @param consecutiveActions Action played in between
+     * @returns true if the action can be undone by the player that played it
+     */
     canUndo(action: Action<MaterialMove<Player, MaterialType, LocationType>, Player>, consecutiveActions: Action<MaterialMove<Player, MaterialType, LocationType>, Player>[]): boolean;
     private consecutiveActionBlocksUndo;
     private actionBlocksUndo;
     private actionActivatesPlayer;
+    /**
+     * @protected
+     * If a moves blocks the undo, any action with this move cannot be undone.
+     * By default, a move block the undo if it activates a player or exposes new information (roll result, hidden information revealed...)
+     *
+     * @param move The move to consider
+     * @returns true if the move blocks the undo
+     */
     protected moveBlocksUndo(move: MaterialMove<Player, MaterialType, LocationType>): boolean;
     private moveActivatesPlayer;
+    /**
+     * Random moves, or moves that reveals something to me, are unpredictable.
+     * Unpredictable moves cannot be precomputed on client side, the server side's response is necessary.
+     * See {@link Rules.isUnpredictableMove}
+     *
+     * @param move Material move to consider
+     * @param _player The player playing the move
+     * @returns true if the move outcome cannot be predicted on client side
+     */
     isUnpredictableMove(move: MaterialMove<Player, MaterialType, LocationType>, _player: Player): boolean;
+    /**
+     * A Material Game is over when there is no rule left to execute. This state results of a {@link EndGame} move.
+     *
+     * @returns true if game is over
+     */
     isOver(): boolean;
+    /**
+     * Amount of time given to a player everytime it is their turn to play.
+     * @param playerId Id of the player, if you want to give different time depending on the id for asymmetric games.
+     * @return number of seconds to add to the player's clock
+     */
+    giveTime(playerId: Player): number;
 }
+/**
+ * Signature interface of the constructor of a class that implements MaterialRules
+ */
 export interface MaterialRulesCreator<P extends number = number, M extends number = number, L extends number = number> {
     new (state: MaterialGame<P, M, L>, client?: {
         player?: P;