Enhance NightStalker model animation handling

- Introduced `NightStalkerAnimationKeys` enum and `nightStalkerAnimationMap` for better organization of animation keys and their corresponding file paths.
- Updated `nightStalkerModelMetadata` to utilize the new animation mapping, improving clarity and maintainability.
- Adjusted `useModelDebug` to ensure proper handling of debug mode settings.
- Removed the `isStatic` property from `IAnimationConfig` to streamline animation configuration.

Author: jonit-dev

src/config/assets/nightStalkerAssetsMetadata.ts

@@ -1,5 +1,18 @@
 import { AssetKeys, IModelAssetMetadata, IModelConfig } from '@/core/types/assets';
 
+// Animation keys for NightStalker
+export enum NightStalkerAnimationKeys {
+  StandingIdle = 'StandingIdle',
+  // Add more animation keys as needed
+}
+
+// Animation key-value mapping for NightStalker
+export const nightStalkerAnimationMap: Record<NightStalkerAnimationKeys, string> = {
+  [NightStalkerAnimationKeys.StandingIdle]:
+    '/assets/models/NightStalker/animations/NightStalker_Standing_Idle.glb',
+  // Add more mappings as needed
+};
+
 export const nightStalkerModelMetadata: IModelAssetMetadata = {
   key: AssetKeys.NightStalkerModel,
   type: 'gltf',
@@ -9,15 +22,13 @@ export const nightStalkerModelMetadata: IModelAssetMetadata = {
     position: [0, 0, 0],
     rotation: [0, 0, 0],
     offset: [0, 0, 0],
-    animations: ['/assets/models/NightStalker/animations/NightStalker_Standing_Idle.glb'],
+    animations: [NightStalkerAnimationKeys.StandingIdle],
     animationConfig: {
-      isStatic: false,
       loop: true,
       timeScale: 1.0,
       clampWhenFinished: false,
       blendDuration: 0.5,
       crossFadeEnabled: true,
-      disableAnimations: false,
     },
     collision: {
       enabled: true,
@@ -30,7 +41,7 @@ export const nightStalkerModelMetadata: IModelAssetMetadata = {
       layer: 'character',
     },
     debugMode: {
-      enabled: true,
+      enabled: false,
       showBoundingBox: true,
       showColliders: true,
       showWireframe: false,

src/core/configs/model-example.config.ts

@@ -13,7 +13,6 @@ export const exampleCharacterConfig: IModelConfig = {
   initialAnimation: 'Idle',
   animations: ['Idle', 'Walk', 'Run', 'Jump'],
   animationConfig: {
-    isStatic: false,
     loop: true,
     timeScale: 1.0,
     clampWhenFinished: false,

src/core/hooks/useModelDebug.tsx

@@ -15,7 +15,7 @@ export function useModelDebug({ model, config, debug = false }: IUseModelDebugOp
   const boxRef = useRef<THREE.Box3>(new THREE.Box3());
 
   // Check if debugMode is enabled
-  const debugMode = config?.debugMode?.enabled || debug;
+  const debugMode = config?.debugMode ? config.debugMode.enabled : debug;
   const debugSettings = config?.debugMode;
   const debugColor = debugSettings?.debugColor
     ? new THREE.Color(

src/core/types/assets.ts

@@ -15,7 +15,6 @@ export interface IBaseAssetMetadata {
 
 // Animation configuration
 export interface IAnimationConfig {
-  isStatic: boolean; // Whether the model has animations
   loop: boolean; // Whether to loop the animation
   timeScale: number; // Playback speed (1.0 = normal, 0.5 = half speed, etc.)
   clampWhenFinished: boolean; // Hold the last frame when animation completes

src/game/models/NightStalkerModel.tsx

@@ -1,7 +1,11 @@
 import { useEffect, useMemo, useRef } from 'react';
 import * as THREE from 'three';
 
-import { nightStalkerModelMetadata } from '@/config/assets/nightStalkerAssetsMetadata';
+import {
+  NightStalkerAnimationKeys,
+  nightStalkerAnimationMap,
+  nightStalkerModelMetadata,
+} from '@/config/assets/nightStalkerAssetsMetadata';
 import { useAnimationFromAsset } from '@/core/hooks/useAnimationFromAsset';
 import { useAsset } from '@/core/hooks/useAsset';
 import { useModelDebug } from '@/core/hooks/useModelDebug';
@@ -31,8 +35,11 @@ export function NightStalkerModel({ debug = true, onAnimationsReady }: INightSta
   // Memoize animationUrls array to prevent re-renders
   const animationSources = useMemo(() => {
     if (!modelConfig?.animations) return [];
-    // Default to 'gltf' type for all animations; adjust if you support more types
-    return modelConfig.animations.map((anim: string) => ({ url: anim, type: 'gltf' as const }));
+    // Map animation keys to URLs using the animation map
+    return modelConfig.animations.map((animKey) => ({
+      url: nightStalkerAnimationMap[animKey as NightStalkerAnimationKeys],
+      type: 'gltf' as const,
+    }));
   }, [modelConfig?.animations]);
 
   // Check if model is loaded