@reldens/skills 0.10.0-beta.34 → 0.12.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -3,8 +3,8 @@
3
3
  # Reldens - Skills
4
4
 
5
5
  ## About
6
- The idea behind this package is to provide a skills and experience systems so you can relate these to a target owner.
7
- Note, though it is an opined implementation it provides a lot of flexibility and it could be implemented on any project.
6
+ The idea behind this package is to provide a skills and experience systems, so you can relate these to a target owner.
7
+ Note, though it is an opined implementation it provides a lot of flexibility, and it could be implemented on any project.
8
8
  The package base features can be used in both server or client side, but we additionally provide some server specific
9
9
  functions like storage models, SQL scripts for installation, sender and receiver support for communication between
10
10
  the server and the client.
package/lib/class-path.js CHANGED
@@ -30,16 +30,9 @@ class ClassPath extends LevelsSet
30
30
  this.skillsByLevel = sc.hasOwn(props, 'skillsByLevel') ? props.skillsByLevel : false;
31
31
  this.skillsByLevelKeys = this.getSkillsByLevelKeys();
32
32
  // the set of skills for the current object instance:
33
- if(sc.hasOwn(props, 'currentSkills')){
34
- this.currentSkills = props.currentSkills;
35
- } else {
36
- this.currentSkills = {};
37
- await this.setOwnerSkills();
38
- }
39
- if(sc.hasOwn(props, 'affectedProperty')){
40
- // the affected property is the one to which the damage calculation will have effect:
41
- this.affectedProperty = props.affectedProperty;
42
- }
33
+ await this.setOwnerSkills(sc.get(props, 'currentSkills', false));
34
+ // the affected property is the one to which the damage calculation will have effect:
35
+ this.affectedProperty = sc.get(props, 'affectedProperty', false);
43
36
  await this.fireEvent(SkillsEvents.INIT_CLASS_PATH_END, this);
44
37
  }
45
38
 
@@ -105,8 +98,13 @@ class ClassPath extends LevelsSet
105
98
  await this.fireEvent(SkillsEvents.REMOVE_SKILLS_AFTER, this, skills);
106
99
  }
107
100
 
108
- async setOwnerSkills()
101
+ async setOwnerSkills(skills)
109
102
  {
103
+ if(skills) {
104
+ this.currentSkills = skills;
105
+ return;
106
+ }
107
+ this.currentSkills = {};
110
108
  for(let i of Object.keys(this.levels)){
111
109
  let level = this.levels[i];
112
110
  if(this.skillsByLevel && sc.hasOwn(this.skillsByLevel, level.key) && level.key <= this.currentLevel){
@@ -68,7 +68,7 @@ class Receiver
68
68
  Logger.error('Skills action not found', message.act);
69
69
  return false;
70
70
  }
71
- if(typeof this[this.actions[message.act]] !== 'function'){
71
+ if('function' !== typeof this[this.actions[message.act]]){
72
72
  // for now I'm leaving this a silent return (will probably end up making the error log configurable):
73
73
  Logger.error('Skills action is not a function', message.act);
74
74
  return false;
@@ -78,7 +78,7 @@ class Receiver
78
78
 
79
79
  isValidMessage(message)
80
80
  {
81
- return (message.act.indexOf(SkillConst.ACTIONS_PREF) === 0);
81
+ return 0 === message.act.indexOf(SkillConst.ACTIONS_PREF);
82
82
  }
83
83
 
84
84
  }
package/lib/constants.js CHANGED
@@ -4,7 +4,7 @@
4
4
  *
5
5
  */
6
6
 
7
- let actionPref = 'rski.';
7
+ const actionPref = 'rski.';
8
8
 
9
9
  module.exports = {
10
10
  SKILL_TYPE_BASE: 1,
package/lib/levels-set.js CHANGED
@@ -11,9 +11,10 @@ const { EventsManagerSingleton, ErrorManager, Logger, sc } = require('@reldens/u
11
11
  class LevelsSet
12
12
  {
13
13
 
14
- constructor(props)
14
+ constructor(props = {})
15
15
  {
16
16
  this.events = sc.get(props, 'events', EventsManagerSingleton);
17
+ this.owner = sc.get(props, 'owner', false);
17
18
  }
18
19
 
19
20
  setOwner(props)
@@ -34,7 +35,7 @@ class LevelsSet
34
35
  if(!sc.hasOwn(this, 'owner')){
35
36
  ErrorManager.error('Undefined owner for levels.');
36
37
  }
37
- if(typeof props.owner.getPosition !== 'function'){
38
+ if(typeof this.owner.getPosition !== 'function'){
38
39
  ErrorManager.error('Undefined owner position method.');
39
40
  }
40
41
  if(!sc.hasOwn(props, 'levels') || !Object.keys(props.levels).length){
@@ -49,12 +50,13 @@ class LevelsSet
49
50
  this.autoFillExperienceMultiplier = sc.get(props, 'autoFillExperienceMultiplier', 1.5);
50
51
  this.currentLevel = sc.get(props, 'currentLevel', 0);
51
52
  this.currentExp = sc.get(props, 'currentExp', 0);
53
+ this.setRequiredExperienceLimit = sc.get(props, 'setRequiredExperienceLimit', false);
52
54
  // set levels is almost the last thing to happen here, first we need to validate all the other parameters:
53
55
  this.levels = await this.setLevels(props.levels);
54
- // @NOTE: if you setup levelsByExperience and autoFillRanges at the same time the levels autogenerated will be
55
- // skipped because the experience on those will be lower one. For example, level 1 required experience = 10p,
56
+ // @NOTE: if you set up levelsByExperience and autoFillRanges at the same time the levels autogenerated will be
57
+ // skipped because the experience on those will be lowed one. For example, level 1 required experience = 10p,
56
58
  // level 5 required experience = 20p, level 2, 3 and 4 are auto-generated with required exp. = 20p, so when the
57
- // player reach 20p of experience it will jump to level 5. In summary you shouldn't mix these options unless
59
+ // player reach 20p of experience it will jump to level 5. In summary, you shouldn't mix these options unless
58
60
  // you expect the described behavior.
59
61
  this.increaseLevelsWithExperience = sc.get(props, 'increaseLevelsWithExperience', true);
60
62
  // unless specified, levels by experience must just be sorted by their key attribute (without auto-fill):
@@ -64,30 +66,31 @@ class LevelsSet
64
66
 
65
67
  async setLevels(levels)
66
68
  {
67
- if(!this.autoFillRanges){
68
- this.levels = levels;
69
- } else {
70
- this.levels = {};
71
- let levelsKeys = Object.keys(levels);
72
- for(let i of levelsKeys){
73
- let level = levels[i];
74
- this.levels[i] = level;
75
- let levelsKeysNextIndex = levelsKeys.indexOf(i) + 1;
76
- let nextLevelKey = levelsKeys.length > levelsKeysNextIndex ? levelsKeys[levelsKeysNextIndex] : false;
77
- let nextLevel = false;
78
- if(sc.hasOwn(levels, (nextLevelKey))){
79
- nextLevel = levels[nextLevelKey];
80
- }
81
- if(sc.hasOwn(nextLevel, 'key') && (nextLevel.key - level.key) > 0){
82
- await this.generateLevels(level, nextLevel);
83
- }
84
- }
85
- }
69
+ !this.autoFillRanges ? (this.levels = levels) : await this.createLevels(levels);
86
70
  await this.fireEvent(SkillsEvents.SET_LEVELS, this, levels);
87
71
  return this.levels;
88
72
  }
89
73
 
90
- async generateLevels(level, nextLevel)
74
+ async createLevels(levels)
75
+ {
76
+ this.levels = {};
77
+ let levelsKeys = Object.keys(levels);
78
+ for(let i of levelsKeys){
79
+ let level = levels[i];
80
+ this.levels[i] = level;
81
+ let levelsKeysNextIndex = levelsKeys.indexOf(i) + 1;
82
+ let nextLevelKey = levelsKeys.length > levelsKeysNextIndex ? levelsKeys[levelsKeysNextIndex] : false;
83
+ let nextLevel = false;
84
+ if(sc.hasOwn(levels, (nextLevelKey))){
85
+ nextLevel = levels[nextLevelKey];
86
+ }
87
+ if(sc.hasOwn(nextLevel, 'key') && (nextLevel.key - level.key) > 0){
88
+ await this.createAndAutofillLevelsInstances(level, nextLevel);
89
+ }
90
+ }
91
+ }
92
+
93
+ async createAndAutofillLevelsInstances(level, nextLevel)
91
94
  {
92
95
  for(let n = level.key + 1; n < nextLevel.key; n++){
93
96
  let requiredExp = Math.round(this.levels[n-1].requiredExperience * this.autoFillExperienceMultiplier);
@@ -101,11 +104,8 @@ class LevelsSet
101
104
  }
102
105
  }
103
106
 
104
- sortLevelsBy(levels, sortField)
107
+ sortLevelsBy(levels, sortField = 'key')
105
108
  {
106
- if(!sortField){
107
- sortField = 'key';
108
- }
109
109
  return Object.keys(levels).sort((a,b) => {
110
110
  return (levels[a][sortField] > levels[b][sortField]) ? 1 : -1;
111
111
  });
@@ -127,7 +127,7 @@ class LevelsSet
127
127
 
128
128
  async levelDown()
129
129
  {
130
- if(this.currentLevel <= 1){
130
+ if(1 >= this.currentLevel){
131
131
  // reached first level:
132
132
  return false;
133
133
  }
@@ -147,23 +147,18 @@ class LevelsSet
147
147
  return false;
148
148
  }
149
149
  await this.fireEvent(SkillsEvents.LEVEL_APPLY_MODIFIERS, this, currentLevelInstance);
150
+ if(!currentLevelInstance.modifiers){
151
+ return false;
152
+ }
150
153
  for(let modifier of currentLevelInstance.modifiers){
151
- if(revert){
152
- modifier.revert(this.owner);
153
- } else {
154
- modifier.apply(this.owner);
155
- }
154
+ revert ? modifier.revert(this.owner) : modifier.apply(this.owner);
156
155
  }
157
156
  }
158
157
 
159
158
  getLevelInstance(level)
160
159
  {
161
160
  // @NOTE: if you only specify 1 level the same calculation will be used for all the levels.
162
- let currentLevelInstance = false;
163
- if(sc.hasOwn(this.levels, level)){
164
- currentLevelInstance = this.levels[level];
165
- }
166
- return currentLevelInstance;
161
+ return sc.get(this.levels, level, false);
167
162
  }
168
163
 
169
164
  async addExperience(number)
@@ -174,9 +169,11 @@ class LevelsSet
174
169
  let nextLevelKey = this.levelsByExperience[nextLevelIndex];
175
170
  let nextLevel = this.levels[nextLevelKey];
176
171
  let nextLevelExp = 0;
172
+ let isLevelUp = false;
177
173
  if(sc.hasOwn(this.levels, this.currentLevel) && nextLevel && newTotalExp >= nextLevel.requiredExperience){
178
174
  for(let levelByExp of this.levelsByExperience.slice(nextLevelIndex)){
179
175
  if(newTotalExp >= this.levels[levelByExp].requiredExperience){
176
+ isLevelUp = true;
180
177
  await this.levelUp();
181
178
  }
182
179
  if(newTotalExp < this.levels[levelByExp].requiredExperience){
@@ -185,6 +182,10 @@ class LevelsSet
185
182
  }
186
183
  }
187
184
  }
185
+ let expNextLevelIndex = !isLevelUp ? nextLevelIndex : (nextLevelIndex + 1)
186
+ if((!nextLevel || expNextLevelIndex === this.levelsByExperience.length) && this.setRequiredExperienceLimit){
187
+ newTotalExp = this.getLevelInstance(this.currentLevel).requiredExperience;
188
+ }
188
189
  this.currentExp = newTotalExp;
189
190
  await this.fireEvent(SkillsEvents.LEVEL_EXPERIENCE_ADDED,
190
191
  this,
@@ -205,23 +206,21 @@ class LevelsSet
205
206
  let nextLevelIndex = currentLevelIndex + 1;
206
207
  let nextLevelKey = this.levelsByExperience[nextLevelIndex];
207
208
  let nextLevel = this.getLevelInstance(nextLevelKey);
208
- let nextLevelExp = currentLevel.requiredExperience;
209
209
  if(!nextLevel){
210
- return nextLevelExp;
210
+ return currentLevel.requiredExperience;
211
211
  }
212
212
  if(nextLevel && this.currentExp < nextLevel.requiredExperience){
213
- nextLevelExp = nextLevel.requiredExperience;
214
- } else {
215
- if(sc.hasOwn(this.levels, this.currentLevel) && nextLevel){
216
- for(let levelByExp of this.levelsByExperience.slice(nextLevelIndex)){
217
- if(this.currentExp < this.levels[levelByExp].requiredExperience){
218
- nextLevelExp = this.levels[levelByExp].requiredExperience;
219
- break;
220
- }
221
- }
213
+ return nextLevel.requiredExperience;
214
+ }
215
+ if(!sc.hasOwn(this.levels, this.currentLevel) || !nextLevel){
216
+ return nextLevel.requiredExperience;
217
+ }
218
+ for(let levelByExp of this.levelsByExperience.slice(nextLevelIndex)){
219
+ if(this.currentExp < this.levels[levelByExp].requiredExperience){
220
+ return this.levels[levelByExp].requiredExperience;
222
221
  }
223
222
  }
224
- return nextLevelExp;
223
+ return nextLevel.requiredExperience;
225
224
  }
226
225
 
227
226
  getOwnerId()
@@ -1,30 +1,30 @@
1
- /**
2
- *
3
- * Reldens - Skills - DataServerValidator
4
- *
5
- */
6
-
7
- const { ErrorManager, sc } = require('@reldens/utils');
8
-
9
- class DataServerValidator
10
- {
11
-
12
- static getValidDataServer(props)
13
- {
14
- // @TODO - BETA - When moving to ES or TS dataServer will be typed and an interface.
15
- let dataServer = sc.get(props, 'dataServer', false);
16
- if(false === dataServer){
17
- ErrorManager.error('Data Server instance not found.', props);
18
- }
19
- if('function' !== typeof dataServer.connect || 'function' !== typeof dataServer.generateEntities){
20
- ErrorManager.error(
21
- 'Data Server property found but the instance required methods are not available.',
22
- dataServer
23
- );
24
- }
25
- return dataServer;
26
- }
27
-
28
- }
29
-
30
- module.exports.DataServerValidator = DataServerValidator;
1
+ /**
2
+ *
3
+ * Reldens - Skills - DataServerValidator
4
+ *
5
+ */
6
+
7
+ const { ErrorManager, sc } = require('@reldens/utils');
8
+
9
+ class DataServerValidator
10
+ {
11
+
12
+ static getValidDataServer(props)
13
+ {
14
+ // @TODO - BETA - When moving to ES or TS dataServer will be typed and an interface.
15
+ let dataServer = sc.get(props, 'dataServer', false);
16
+ if(false === dataServer){
17
+ ErrorManager.error('Data Server instance not found.', props);
18
+ }
19
+ if('function' !== typeof dataServer.connect || 'function' !== typeof dataServer.generateEntities){
20
+ ErrorManager.error(
21
+ 'Data Server property found but the instance required methods are not available.',
22
+ dataServer
23
+ );
24
+ }
25
+ return dataServer;
26
+ }
27
+
28
+ }
29
+
30
+ module.exports.DataServerValidator = DataServerValidator;
@@ -0,0 +1,47 @@
1
+ /**
2
+ *
3
+ * Reldens - Skills - ClassPathGenerator
4
+ *
5
+ */
6
+
7
+ const ClassPath = require('../../class-path');
8
+ const { LevelsGenerator } = require('./levels-generator');
9
+ const { sc } = require('@reldens/utils');
10
+
11
+ class ClassPathGenerator
12
+ {
13
+
14
+ static fromClassPathModels(classPathModels, classPathClasses)
15
+ {
16
+ if(!sc.isArray(classPathModels) || 0 === classPathModels.length) {
17
+ return {};
18
+ }
19
+ let classPathsById = {};
20
+ let classPathsByKey = {};
21
+ for(let classPathModel of classPathModels){
22
+ let classPathData = {class: sc.get(classPathClasses, classPathModel.key, ClassPath), data: classPathModel};
23
+ classPathModel.classPathLevels = LevelsGenerator.fromLevelsModels(
24
+ classPathModel.skills_levels_set.skills_levels_set_levels
25
+ );
26
+ classPathModel.labelsByLevel = this.extractLabelsByLevels(classPathModel.skills_class_path_level_labels);
27
+ classPathsById[classPathModel.id] = classPathData;
28
+ classPathsByKey[classPathModel.key] = classPathData;
29
+ }
30
+ return {classPathModels: classPathModels, classPathsById, classPathsByKey};
31
+ }
32
+
33
+ static extractLabelsByLevels(levelLabelsModel)
34
+ {
35
+ if(!sc.isArray(levelLabelsModel) || 0 === levelLabelsModel.length){
36
+ return {};
37
+ }
38
+ let labelsByLevel = {};
39
+ for(let labelData of levelLabelsModel){
40
+ labelsByLevel[labelData['label_level'].key] = labelData.label;
41
+ }
42
+ return labelsByLevel;
43
+ }
44
+
45
+ }
46
+
47
+ module.exports.ClassPathGenerator = ClassPathGenerator;
@@ -0,0 +1,29 @@
1
+ /**
2
+ *
3
+ * Reldens - Skills - ConditionsGenerator
4
+ *
5
+ */
6
+
7
+ const { Condition } = require('@reldens/modifiers');
8
+ const { sc } = require('@reldens/utils');
9
+
10
+ class ConditionsGenerator
11
+ {
12
+
13
+ static fromConditionsModels(conditionsModels)
14
+ {
15
+ if(!sc.isArray(conditionsModels) || 0 === conditionsModels.length){
16
+ return [];
17
+ }
18
+ let conditions = [];
19
+ for (let conditionModel of conditionsModels) {
20
+ conditionModel['propertyKey'] = conditionModel['property_key'];
21
+ let condition = new Condition(conditionModel);
22
+ conditions.push(condition);
23
+ }
24
+ return conditions;
25
+ }
26
+
27
+ }
28
+
29
+ module.exports.ConditionsGenerator = ConditionsGenerator;
@@ -0,0 +1,41 @@
1
+ /**
2
+ *
3
+ * Reldens - Skills - LevelsGenerator
4
+ *
5
+ */
6
+
7
+ const Level = require('../../level');
8
+ const { Modifier } = require('@reldens/modifiers');
9
+ const { sc } = require('@reldens/utils');
10
+
11
+ class LevelsGenerator
12
+ {
13
+
14
+ static fromLevelsModels(levelsModels)
15
+ {
16
+ let levels = {};
17
+ for(let levelData of levelsModels){
18
+ levelData.modifiers = this.extractModifiers(levelData['level_modifiers']);
19
+ let levelKey = parseInt(levelData['key']);
20
+ levelData.key = levelKey;
21
+ levels[levelKey] = new Level(levelData);
22
+ }
23
+ return levels;
24
+ }
25
+
26
+ static extractModifiers(modifiersModels)
27
+ {
28
+ if(!sc.isArray(modifiersModels) || 0 === modifiersModels.length){
29
+ return [];
30
+ }
31
+ let levelModifiers = [];
32
+ for(let modifierData of modifiersModels){
33
+ let modifier = new Modifier(modifierData);
34
+ levelModifiers.push(modifier);
35
+ }
36
+ return levelModifiers;
37
+ }
38
+
39
+ }
40
+
41
+ module.exports.LevelsGenerator = LevelsGenerator;
@@ -18,7 +18,7 @@ class LevelModel extends ObjectionJsRawModel
18
18
  static get relationMappings()
19
19
  {
20
20
  const { LevelsSetModel } = require('./levels-set-model');
21
- const { LevelModifiersModels } = require('./level-modifiers-model');
21
+ const { LevelModifiersModel } = require('./level-modifiers-model');
22
22
  return {
23
23
  level_set_id: {
24
24
  relation: this.BelongsToOneRelation,
@@ -30,10 +30,10 @@ class LevelModel extends ObjectionJsRawModel
30
30
  },
31
31
  level_modifiers: {
32
32
  relation: this.HasManyRelation,
33
- modelClass: LevelModifiersModels,
33
+ modelClass: LevelModifiersModel,
34
34
  join: {
35
35
  from: this.tableName+'.id',
36
- to: LevelModifiersModels.tableName+'.level_id'
36
+ to: LevelModifiersModel.tableName+'.level_id'
37
37
  }
38
38
  },
39
39
  };
@@ -1,6 +1,6 @@
1
1
  /**
2
2
  *
3
- * Reldens - Skills - LevelModifiersModels
3
+ * Reldens - Skills - LevelModifiersModel
4
4
  *
5
5
  */
6
6