feat: higher falling gravity, max falling velocity

Author: ErdongChen-Andrew

example/CharacterModel.tsx

@@ -9,7 +9,7 @@ import { useControls } from "leva";
 import { Suspense, useEffect, useRef, useMemo, useState } from "react";
 import * as THREE from "three";
 import { useGame } from "../src/stores/useGame";
-import { BallCollider, RapierCollider } from "@react-three/rapier";
+import { BallCollider, RapierCollider, vec3 } from "@react-three/rapier";
 import { useFrame } from "@react-three/fiber";
 import type { GLTF } from "three/examples/jsm/loaders/GLTFLoader";
 
@@ -129,24 +129,21 @@ export default function CharacterModel(props: CharacterModelProps) {
   });
 
   useFrame(() => {
-    if (rightHand && leftHand) {
-      rightHand.getWorldPosition(rightHandPos);
-      leftHand.getWorldPosition(leftHandPos);
-      rightHandRef.current.parent.getWorldPosition(bodyPos);
-    }
-
-    // Apply both hands position to hand colliders
-    if (rightHandColliderRef.current && leftHandColliderRef.current) {
-      rightHandRef.current.position.copy(rightHandPos).sub(bodyPos);
-      rightHandColliderRef.current.setTranslationWrtParent(
-        rightHandRef.current.position
-      );
+    if (curAnimation === animationSet.action4) {
+      if (rightHand && leftHand) {
+        rightHand.getWorldPosition(rightHandPos);
+        leftHand.getWorldPosition(leftHandPos);
+        rightHandRef.current.parent.getWorldPosition(bodyPos);
+      }
 
-      leftHandRef.current.position.copy(leftHandPos).sub(bodyPos);
-      leftHandColliderRef.current.setTranslationWrtParent(
-        leftHandRef.current.position
-      );
-    }
+      // Apply both hands position to hand colliders
+      if (rightHandColliderRef.current && leftHandColliderRef.current) {
+        rightHandRef.current.position.copy(rightHandPos).sub(bodyPos);
+        rightHandColliderRef.current.setTranslationWrtParent(
+          rightHandRef.current.position
+        );
+      }
+    } 
   });
 
   useEffect(() => {
@@ -191,6 +188,13 @@ export default function CharacterModel(props: CharacterModelProps) {
         resetAnimation()
       );
       (action as any)._mixer._listeners = [];
+
+      // Move hand collider back to initial position after action
+      if (curAnimation===animationSet.action4) {
+        if (rightHandColliderRef.current) {
+          rightHandColliderRef.current.setTranslationWrtParent(vec3({ x: 0, y: 0, z: 0 }))
+        }
+      }
     };
   }, [curAnimation]);
 

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ecctrl",
-  "version": "1.0.45",
+  "version": "1.0.46",
   "author": "Erdong Chen",
   "license": "MIT",
   "description": "A floating rigibody character controller for R3F",

readme.md

@@ -148,6 +148,8 @@ EcctrlProps: {
   rejectVelMult: 4, // Reject velocity multiplier
   moveImpulsePointY: 0.5, // Move impulse point Y offset
   camFollowMult: 11, // Camera follow speed multiplier
+  fallingGravityScale: 2.5, // Character is falling, apply higher gravity
+  fallingMaxVel: -20, // Limit character max falling velocity
   // Floating Ray setups
   rayOriginOffest: { x: 0, y: -capsuleHalfHeight, z: 0 }, // Ray origin offset
   rayHitForgiveness: 0.1, // Ray hit forgiveness

src/Ecctrl.tsx

@@ -79,6 +79,8 @@ const Ecctrl = forwardRef<RapierRigidBody, EcctrlProps>(({
   rejectVelMult = 4,
   moveImpulsePointY = 0.5,
   camFollowMult = 11,
+  fallingGravityScale = 2.5,
+  fallingMaxVel = -20,
   // Floating Ray setups
   rayOriginOffest = { x: 0, y: -capsuleHalfHeight, z: 0 },
   rayHitForgiveness = 0.1,
@@ -404,6 +406,7 @@ const Ecctrl = forwardRef<RapierRigidBody, EcctrlProps>(({
 
   // can jump setup
   let canJump = false;
+  let isFalling = false;
 
   // on moving object state
   let isOnMovingObject = false;
@@ -646,6 +649,13 @@ const Ecctrl = forwardRef<RapierRigidBody, EcctrlProps>(({
     characterRef.current.applyTorqueImpulse(dragAngForce, false)
   };
 
+  /**
+   * Character sleep function
+   */
+  const sleepCharacter = () => {
+    characterRef.current.sleep()
+  }
+
   useEffect(() => {
     // Initialize directional light
     if (followLight) {
@@ -768,6 +778,12 @@ const Ecctrl = forwardRef<RapierRigidBody, EcctrlProps>(({
     pivot.rotation.x = camInitDir.x
     pivot.rotation.y = camInitDir.y
     pivot.rotation.z = camInitDir.z
+
+    window.addEventListener("blur", sleepCharacter);
+
+    return () => {
+      window.removeEventListener("blur", sleepCharacter);
+    }
   }, [])
 
   useFrame((state, delta) => {
@@ -1068,6 +1084,21 @@ const Ecctrl = forwardRef<RapierRigidBody, EcctrlProps>(({
       }
     }
 
+    /**
+     * Detect character falling state
+     */
+    isFalling = (currentVel.y < 0 && !canJump) ? true : false
+
+    /**
+     * Apply larger gravity when falling
+     */
+    if (characterRef.current) {
+      characterRef.current.setGravityScale(
+        currentVel.y > fallingMaxVel ? (isFalling ? fallingGravityScale : 1) : 0,
+        true
+      )
+    }
+
     /**
      * Apply auto balance force to the character
      */
@@ -1103,7 +1134,7 @@ const Ecctrl = forwardRef<RapierRigidBody, EcctrlProps>(({
         jumpIdleAnimation();
       }
       // On high sky, play falling animation
-      if (rayHit == null && currentVel.y < 0) {
+      if (rayHit == null && isFalling) {
         fallAnimation();
       }
     }
@@ -1176,6 +1207,8 @@ export interface EcctrlProps extends RigidBodyProps {
   rejectVelMult?: number;
   moveImpulsePointY?: number;
   camFollowMult?: number;
+  fallingGravityScale?: number;
+  fallingMaxVel?: number;
   // Floating Ray setups
   rayOriginOffest?: { x: number; y: number; z: number };
   rayHitForgiveness?: number;

src/stores/useGame.ts

@@ -151,10 +151,10 @@ export type AnimationSet = {
   jumpLand: string;
   fall: string;
   // Currently support four additional animations
-  action1: string;
-  action2: string;
-  action3: string;
-  action4: string;
+  action1?: string;
+  action2?: string;
+  action3?: string;
+  action4?: string;
 };
 
 type State = {