Docs correction. Move StateManagerWeapon utils to separate folder. Do…

… not use spawn_ini(), use global ini ref.
xray-forge · Aug 25, 2023 · d41b059 · d41b059
1 parent 3ea540c
commit d41b059
Show file tree

Hide file tree

Showing 24 changed files with 143 additions and 139 deletions.
diff --git a/src/engine/core/managers/interface/ActorInventoryMenuManager.ts b/src/engine/core/managers/interface/ActorInventoryMenuManager.ts
@@ -1,5 +1,4 @@
-import { system_ini } from "xray16";
-
+import { SYSTEM_INI } from "@/engine/core/database";
 import { AbstractCoreManager } from "@/engine/core/managers/base/AbstractCoreManager";
 import { executeConsoleCommand } from "@/engine/core/utils/game/game_console";
 import { readIniString } from "@/engine/core/utils/ini";
@@ -18,7 +17,7 @@ export class ActorInventoryMenuManager extends AbstractCoreManager {
    * todo: Description.
    */
   public override initialize(): void {
-    const ini: IniFile = system_ini();
+    const ini: IniFile = SYSTEM_INI;
 
     executeConsoleCommand(consoleCommands.slot_0, readIniString(ini, ACTOR, "quick_item_1", false, "", ""));
     executeConsoleCommand(consoleCommands.slot_1, readIniString(ini, ACTOR, "quick_item_2", false, "", ""));

diff --git a/src/engine/core/objects/ai/state/StalkerStateManager.ts b/src/engine/core/objects/ai/state/StalkerStateManager.ts
@@ -1,7 +1,6 @@
 import { action_planner, level, look, object, time_global } from "xray16";
 
 import { StalkerAnimationManager } from "@/engine/core/objects/ai/state/StalkerAnimationManager";
-import { getObjectAnimationWeapon } from "@/engine/core/objects/ai/state/weapon/StateManagerWeapon";
 import { EStateActionId, EStateEvaluatorId } from "@/engine/core/objects/ai/types";
 import { EAnimationType, EWeaponAnimation } from "@/engine/core/objects/animation/animation_types";
 import {
@@ -14,6 +13,7 @@ import {
 import { states } from "@/engine/core/objects/animation/states";
 import { assert } from "@/engine/core/utils/assertion";
 import { LuaLogger } from "@/engine/core/utils/logging";
+import { getObjectWeaponForAnimationState } from "@/engine/core/utils/object/object_weapon";
 import { areSameVectors, createVector, subVectors } from "@/engine/core/utils/vector";
 import { ZERO_VECTOR } from "@/engine/lib/constants/vectors";
 import {
@@ -120,7 +120,7 @@ export class StalkerStateManager {
       nextStateDescriptorWeapon !== EWeaponAnimation.SNIPER_FIRE
     ) {
       if (this.object.active_item() && this.object.best_weapon() && this.object.weapon_unstrapped()) {
-        this.object.set_item(object.idle, getObjectAnimationWeapon(this.object, state));
+        this.object.set_item(object.idle, getObjectWeaponForAnimationState(this.object, state));
       }
     }
 

diff --git a/src/engine/core/objects/ai/state/state/ActionStateEnd.ts b/src/engine/core/objects/ai/state/state/ActionStateEnd.ts
@@ -1,15 +1,17 @@
 import { action_base, level, LuabindClass, object, time_global } from "xray16";
 
 import { StalkerStateManager } from "@/engine/core/objects/ai/state/StalkerStateManager";
-import { getObjectIdleState, getStateQueueParams } from "@/engine/core/objects/ai/state/weapon/StateManagerWeapon";
 import { EWeaponAnimation } from "@/engine/core/objects/animation";
 import { states } from "@/engine/core/objects/animation/states";
 import { LuaLogger } from "@/engine/core/utils/logging";
+import { getObjectSmartCoverStateQueueParams } from "@/engine/core/utils/object";
 import { isStalker, isWeapon } from "@/engine/core/utils/object/object_class";
+import { getWeaponStateForAnimationState } from "@/engine/core/utils/object/object_weapon";
 import { ClientObject, EClientObjectRelation, Optional, TDuration, TRate, TTimestamp } from "@/engine/lib/types";
 
 const logger: LuaLogger = new LuaLogger($filename);
 
+// todo: Move out.
 const AIM_RATIO: TRate = 1000 / 50;
 const MIN_RATIO: TRate = 1500;
 const SNIPER_AIM_TIME: TDuration = 3000;
@@ -87,7 +89,10 @@ export class ActionStateEnd extends action_base {
 
             this.object.set_item(object.fire1, this.object.best_weapon(), 1, sniperAimDuration);
           } else {
-            const [value] = getStateQueueParams(this.object, states.get(this.stateManager.targetState!));
+            const [value] = getObjectSmartCoverStateQueueParams(
+              this.object,
+              states.get(this.stateManager.targetState!)
+            );
 
             this.object.set_item(object.fire1, this.object.best_weapon(), value);
           }
@@ -104,22 +109,22 @@ export class ActionStateEnd extends action_base {
         if (targetWeaponState === EWeaponAnimation.SNIPER_FIRE) {
           this.object.set_item(object.fire1, this.object.best_weapon(), 1, sniperAimDuration);
         } else {
-          const [value] = getStateQueueParams(this.object, states.get(this.stateManager.targetState!));
+          const [value] = getObjectSmartCoverStateQueueParams(this.object, states.get(this.stateManager.targetState!));
 
           this.object.set_item(object.fire1, this.object.best_weapon(), value);
         }
 
         return;
       }
 
-      const [value] = getStateQueueParams(this.object, states.get(this.stateManager.targetState!));
+      const [value] = getObjectSmartCoverStateQueueParams(this.object, states.get(this.stateManager.targetState!));
 
       this.object.set_item(object.fire1, this.object.best_weapon(), value);
 
       return;
     } else if (targetWeaponState === EWeaponAnimation.UNSTRAPPED) {
       // Unstrap weapon.
-      this.object.set_item(getObjectIdleState(this.stateManager.targetState), this.object.best_weapon());
+      this.object.set_item(getWeaponStateForAnimationState(this.stateManager.targetState), this.object.best_weapon());
     }
   }
 }
diff --git a/src/engine/core/objects/ai/state/state/ActionStateToIdle.ts b/src/engine/core/objects/ai/state/state/ActionStateToIdle.ts
@@ -26,8 +26,6 @@ export class ActionStateToIdle extends action_base {
    * Starting resetting state to idle for object.
    */
   public override initialize(): void {
-    logger.info("State to idle for:", this.object.name(), this.name);
-
     super.initialize();
 
     this.object.inactualize_patrol_path();
@@ -42,6 +40,7 @@ export class ActionStateToIdle extends action_base {
   public override execute(): void {
     super.execute();
 
+    // If any animation is active in state manager, reset everything for client object.
     if (this.stateManager.targetState !== EStalkerState.IDLE) {
       this.object.clear_animations();
       this.stateManager.setState(EStalkerState.IDLE, null, null, null, { isForced: true });

diff --git a/src/engine/core/objects/ai/state/weapon/ActionWeaponDrop.ts b/src/engine/core/objects/ai/state/weapon/ActionWeaponDrop.ts
@@ -1,16 +1,17 @@
 import { action_base, LuabindClass, object } from "xray16";
 
 import { StalkerStateManager } from "@/engine/core/objects/ai/state/StalkerStateManager";
-import { getObjectAnimationWeapon } from "@/engine/core/objects/ai/state/weapon/StateManagerWeapon";
 import { LuaLogger } from "@/engine/core/utils/logging";
 import { isStrappableWeapon, setItemCondition } from "@/engine/core/utils/object";
+import { getObjectWeaponForAnimationState } from "@/engine/core/utils/object/object_weapon";
 import { logicsConfig } from "@/engine/lib/configs/LogicsConfig";
 import { ClientObject, Optional } from "@/engine/lib/types";
 
 const logger: LuaLogger = new LuaLogger($filename);
 
 /**
- * todo;
+ * Action to drop active item.
+ * In case if item is not stappable, just hide all active items.
  */
 @LuabindClass()
 export class ActionWeaponDrop extends action_base {
@@ -26,15 +27,14 @@ export class ActionWeaponDrop extends action_base {
    * If object has no weapon, just select no weapon active.
    */
   public override initialize(): void {
-    logger.info("Drop weapon for:", this.object.name());
-
     super.initialize();
 
-    const weapon: Optional<ClientObject> = getObjectAnimationWeapon(this.object, this.stateManager.targetState);
+    const weapon: Optional<ClientObject> = getObjectWeaponForAnimationState(this.object, this.stateManager.targetState);
 
     if (isStrappableWeapon(weapon)) {
       this.object.set_item(object.drop, weapon);
 
+      // todo: Is it needed?
       setItemCondition(
         weapon,
         math.random(

diff --git a/src/engine/core/objects/ai/state/weapon/ActionWeaponNone.ts b/src/engine/core/objects/ai/state/weapon/ActionWeaponNone.ts
@@ -21,8 +21,6 @@ export class ActionWeaponNone extends action_base {
    * Select no weapon active.
    */
   public override initialize(): void {
-    logger.info("Set weapon none for:", this.object.name());
-
     super.initialize();
     this.object.set_item(object.idle, null);
   }

diff --git a/src/engine/core/objects/ai/state/weapon/ActionWeaponStrap.ts b/src/engine/core/objects/ai/state/weapon/ActionWeaponStrap.ts
@@ -1,15 +1,15 @@
 import { action_base, LuabindClass, object } from "xray16";
 
 import { StalkerStateManager } from "@/engine/core/objects/ai/state/StalkerStateManager";
-import { getObjectAnimationWeapon } from "@/engine/core/objects/ai/state/weapon/StateManagerWeapon";
 import { LuaLogger } from "@/engine/core/utils/logging";
 import { isStrappableWeapon } from "@/engine/core/utils/object";
+import { getObjectWeaponForAnimationState } from "@/engine/core/utils/object/object_weapon";
 import { ClientObject, Optional } from "@/engine/lib/types";
 
 const logger: LuaLogger = new LuaLogger($filename);
 
 /**
- * todo;
+ * Strap active weapon item if it is stapable.
  */
 @LuabindClass()
 export class ActionWeaponStrap extends action_base {
@@ -24,11 +24,9 @@ export class ActionWeaponStrap extends action_base {
    * Strap active weapon.
    */
   public override initialize(): void {
-    logger.info("Strap weapon for:", this.object.name());
-
     super.initialize();
 
-    const weapon: Optional<ClientObject> = getObjectAnimationWeapon(this.object, this.stateManager.targetState);
+    const weapon: Optional<ClientObject> = getObjectWeaponForAnimationState(this.object, this.stateManager.targetState);
 
     if (isStrappableWeapon(weapon)) {
       this.object.set_item(object.strap, weapon);

diff --git a/src/engine/core/objects/ai/state/weapon/ActionWeaponUnstrap.ts b/src/engine/core/objects/ai/state/weapon/ActionWeaponUnstrap.ts
@@ -1,13 +1,16 @@
 import { action_base, LuabindClass } from "xray16";
 
 import { StalkerStateManager } from "@/engine/core/objects/ai/state/StalkerStateManager";
-import { getObjectAnimationWeapon, getObjectIdleState } from "@/engine/core/objects/ai/state/weapon/StateManagerWeapon";
 import { LuaLogger } from "@/engine/core/utils/logging";
+import {
+  getObjectWeaponForAnimationState,
+  getWeaponStateForAnimationState,
+} from "@/engine/core/utils/object/object_weapon";
 
 const logger: LuaLogger = new LuaLogger($filename);
 
 /**
- * todo;
+ * Unstrap active weapon item.
  */
 @LuabindClass()
 export class ActionWeaponUnstrap extends action_base {
@@ -22,12 +25,11 @@ export class ActionWeaponUnstrap extends action_base {
    * Unstrap active animation weapon.
    */
   public override initialize(): void {
-    logger.info("Unstrap weapon for:", this.object.name());
-
     super.initialize();
+
     this.object.set_item(
-      getObjectIdleState(this.stateManager.targetState),
-      getObjectAnimationWeapon(this.object, this.stateManager.targetState)
+      getWeaponStateForAnimationState(this.stateManager.targetState),
+      getObjectWeaponForAnimationState(this.object, this.stateManager.targetState)
     );
   }
 }
diff --git a/src/engine/core/objects/ai/state/weapon/EvaluatorWeapon.ts b/src/engine/core/objects/ai/state/weapon/EvaluatorWeapon.ts
@@ -4,7 +4,7 @@ import { StalkerStateManager } from "@/engine/core/objects/ai/state/StalkerState
 import { EWeaponAnimation } from "@/engine/core/objects/animation";
 import { states } from "@/engine/core/objects/animation/states";
 import { LuaLogger } from "@/engine/core/utils/logging";
-import { isStrappableWeapon, isWeapon } from "@/engine/core/utils/object";
+import { isStrappableWeapon } from "@/engine/core/utils/object";
 import { ClientObject, Optional } from "@/engine/lib/types";
 
 const logger: LuaLogger = new LuaLogger($filename);

diff --git a/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponFire.ts b/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponFire.ts
@@ -8,7 +8,7 @@ import { LuaLogger } from "@/engine/core/utils/logging";
 const logger: LuaLogger = new LuaLogger($filename);
 
 /**
- * Whether object in fire weapon state.
+ * Whether object is in fire weapon state.
  */
 @LuabindClass()
 export class EvaluatorWeaponFire extends property_evaluator {

diff --git a/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponLocked.ts b/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponLocked.ts
@@ -7,7 +7,7 @@ import { isObjectWeaponLocked } from "@/engine/core/utils/object/object_weapon";
 const logger: LuaLogger = new LuaLogger($filename);
 
 /**
- * Whether weapon state is locked.
+ * Whether weapon state is locked and cannot be used.
  */
 @LuabindClass()
 export class EvaluatorWeaponLocked extends property_evaluator {

diff --git a/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponNone.ts b/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponNone.ts
@@ -8,7 +8,7 @@ import { LuaLogger } from "@/engine/core/utils/logging";
 const logger: LuaLogger = new LuaLogger($filename);
 
 /**
- * Whether object should hide weapon at all.
+ * Whether object should hide weapon.
  */
 @LuabindClass()
 export class EvaluatorWeaponNone extends property_evaluator {

diff --git a/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponNoneNow.ts b/src/engine/core/objects/ai/state/weapon/EvaluatorWeaponNoneNow.ts
@@ -6,7 +6,7 @@ import { LuaLogger } from "@/engine/core/utils/logging";
 const logger: LuaLogger = new LuaLogger($filename);
 
 /**
- * Whether have no weapon in hands at all.
+ * Whether object has no weapon in hands right now.
  */
 @LuabindClass()
 export class EvaluatorWeaponNoneNow extends property_evaluator {

diff --git a/src/engine/core/objects/ai/state/weapon/StateManagerWeapon.ts b/src/engine/core/objects/ai/state/weapon/StateManagerWeapon.ts
diff --git a/src/engine/core/objects/animation/state_types.ts b/src/engine/core/objects/animation/state_types.ts
@@ -217,7 +217,7 @@ export interface IStateDescriptor {
   bodystate: Optional<TMoveType>;
   animstate: Optional<TName>;
   animation: Optional<TName>;
-  weapon_slot?: Optional<TIndex>;
+  weaponSlot?: Optional<TIndex>;
   direction?: TLookType | TSightType;
   special_danger_move?: Optional<boolean>;
   isForced?: Optional<boolean>;

diff --git a/src/engine/core/objects/animation/states/base.ts b/src/engine/core/objects/animation/states/base.ts
@@ -829,7 +829,7 @@ export const baseStates: LuaTable<TName, IStateDescriptor> = $fromObject<TName,
   },
   [EStalkerState.PSY_SHOOT]: {
     weapon: EWeaponAnimation.FIRE,
-    weapon_slot: 1,
+    weaponSlot: 1,
     movement: move.stand,
     mental: anim.free,
     bodystate: move.standing,