1. 1 : /**
  2. 2 : * Base class for all concrete steering behaviors. They produce a force that describes
  3. 3 : * where an agent should move and how fast it should travel to get there.
  4. 4 : *
  5. 5 : * Note: All built-in steering behaviors assume a {@link Vehicle#mass} of one. Different values can lead to an unexpected results.
  6. 6 : *
  7. 7 : * @author {@link https://github.com/Mugen87|Mugen87}
  8. 8 : */
  9. 9 : class SteeringBehavior {
  10. 10 : 
  11. 11 : 	/**
  12. 12 : 	* Constructs a new steering behavior.
  13. 13 : 	*/
  14. 14 : 	constructor() {
  15. 15 : 
  16. 16 : 		/**
  17. 17 : 		* Whether this steering behavior is active or not.
  18. 18 : 		* @type {Boolean}
  19. 19 : 		* @default true
  20. 20 : 		*/
  21. 21 : 		this.active = true;
  22. 22 : 
  23. 23 : 		/**
  24. 24 : 		* Can be used to tweak the amount that a steering force contributes to the total steering force.
  25. 25 : 		* @type {Number}
  26. 26 : 		* @default 1
  27. 27 : 		*/
  28. 28 : 		this.weight = 1;
  29. 29 : 
  30. 30 : 	}
  31. 31 : 
  32. 32 : 	/**
  33. 33 : 	* Calculates the steering force for a single simulation step.
  34. 34 : 	*
  35. 35 : 	* @param {Vehicle} vehicle - The game entity the force is produced for.
  36. 36 : 	* @param {Vector3} force - The force/result vector.
  37. 37 : 	* @param {Number} delta - The time delta.
  38. 38 : 	* @return {Vector3} The force/result vector.
  39. 39 : 	*/
  40. 40 : 	calculate( /* vehicle, force, delta */ ) {}
  41. 41 : 
  42. 42 : 	/**
  43. 43 : 	* Transforms this instance into a JSON object.
  44. 44 : 	*
  45. 45 : 	* @return {Object} The JSON object.
  46. 46 : 	*/
  47. 47 : 	toJSON() {
  48. 48 : 
  49. 49 : 		return {
  50. 50 : 			type: this.constructor.name,
  51. 51 : 			active: this.active,
  52. 52 : 			weight: this.weight
  53. 53 : 		};
  54. 54 : 
  55. 55 : 	}
  56. 56 : 
  57. 57 : 	/**
  58. 58 : 	* Restores this instance from the given JSON object.
  59. 59 : 	*
  60. 60 : 	* @param {Object} json - The JSON object.
  61. 61 : 	* @return {SteeringBehavior} A reference to this steering behavior.
  62. 62 : 	*/
  63. 63 : 	fromJSON( json ) {
  64. 64 : 
  65. 65 : 		this.active = json.active;
  66. 66 : 		this.weight = json.weight;
  67. 67 : 
  68. 68 : 		return this;
  69. 69 : 
  70. 70 : 	}
  71. 71 : 
  72. 72 : 	/**
  73. 73 : 	* Restores UUIDs with references to GameEntity objects.
  74. 74 : 	*
  75. 75 : 	* @param {Map<String,GameEntity>} entities - Maps game entities to UUIDs.
  76. 76 : 	* @return {SteeringBehavior} A reference to this steering behavior.
  77. 77 : 	*/
  78. 78 : 	resolveReferences( /* entities */ ) {}
  79. 79 : 
  80. 80 : }
  81. 81 : 
  82. 82 : export { SteeringBehavior };