Merge pull request #80 from LeXXik/fix-docs

Add new char callbacks
Gamebop · Sep 2, 2024 · f3be75f · f3be75f
2 parents 0bfe31e + 15871a9
commit f3be75f
Showing 1 changed file with 22 additions and 3 deletions.
diff --git a/src/physics/jolt/front/char/system.mjs b/src/physics/jolt/front/char/system.mjs
@@ -116,21 +116,40 @@ class CharComponentSystem extends ShapeComponentSystem {
  * @param {function} callbacks.OnContactValidate - Checks if a character can collide with
  * specified body. Return true if the contact is valid.
  * ```javascript
- * OnAdjustBodyVelocity: function (inCharacter, inBodyID2, inSubShapeID2) {}
+ * OnContactValidate: function (inCharacter, inBodyID2, inSubShapeID2) {}
+ * ```
+ * @param {function} callbacks.OnCharacterContactValidate - Same as `OnContactValidate`, but
+ * when colliding with another Character Virtual.
+ * ```javascript
+ * OnCharacterContactValidate: function (inCharacter, inBodyID2, inSubShapeID2,
+ * inContactPosition, inContactNormal, ioSettings) {}
  * ```
  * @param {function} callbacks.OnContactAdded - Called whenever the character collides with a
  * body.
  * ```javascript
- * OnAdjustBodyVelocity: function (inCharacter, inBodyID2, inSubShapeID2, inContactPosition,
+ * OnContactAdded: function (inCharacter, inBodyID2, inSubShapeID2, inContactPosition,
  * inContactNormal, ioSettings) {}
  * ```
+ * @param {function} callbacks.OnCharacterContactAdded - Same as `OnContactAdded` but when
+ * colliding with a Character Virtual.
+ * ```javascript
+ * OnCharacterContactAdded: function (inCharacter, inOtherCharacter, inSubShapeID2,
+ * inContactPosition, inContactNormal, ioSettings) {}
+ * ```
  * @param {function} callbacks.OnContactSolve - Called whenever a contact is being used by the
  * solver.
  * ```javascript
- * OnAdjustBodyVelocity: function (inCharacter, inBodyID2, inSubShapeID2, inContactPosition,
+ * OnContactSolve: function (inCharacter, inBodyID2, inSubShapeID2, inContactPosition,
  * inContactNormal, inContactVelocity, inContactMaterial, inCharacterVelocity,
  * ioNewCharacterVelocity) {}
  * ```
+ * @param {function} callbacks.OnCharacterContactSolve - Same as `OnContactSolve` but when
+ * colliding with a CharacterVirtual.
+ * ```javascript
+ * OnCharacterContactSolve: function (inCharacter, inOtherCharacter, inSubShapeID2,
+ * inContactPosition, inContactNormal, inContactVelocity, inContactMaterial,
+ * inCharacterVelocity, ioNewCharacterVelocity) {}
+ * ```
  */
  overrideContacts(callbacks = {}) {
  if ($_DEBUG) {