fix(command): filter hit messages (fixes #82)

ssube · May 29, 2021 · 28c239b · 28c239b
1 parent 13858ea
commit 28c239b
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 21 deletions.
diff --git a/src/script/common/ActorStep.ts b/src/script/common/ActorStep.ts
@@ -3,7 +3,7 @@ import { InvalidArgumentError, isNil, mustExist } from '@apextoaster/js-utils';
 import { Actor, ActorType, isActor } from '../../model/entity/Actor';
 import { isItem } from '../../model/entity/Item';
 import { isRoom } from '../../model/entity/Room';
-import { ScriptContext, ScriptTarget } from '../../service/script';
+import { ScriptContext, ScriptTarget, ShowMessageVolume } from '../../service/script';
 import {
   SLOT_HIT,
   SLOT_USE,
@@ -117,17 +117,26 @@ export async function ActorStepHit(this: Actor, context: ScriptContext): Promise
   const target = indexEntity(results, command.index, isActor);
 
   if (isNil(target)) {
-    await context.focus.show('actor.step.hit.type', { command });
+    await context.focus.show('actor.step.hit.type', { command }, {
+      source: this,
+      volume: ShowMessageVolume.SELF,
+    });
     return;
   }
 
   if (this === target) {
-    await context.focus.show('actor.step.hit.self', { command });
+    await context.focus.show('actor.step.hit.self', { command }, {
+      source: this,
+      volume: ShowMessageVolume.SELF,
+    });
     return;
   }
 
   if (this.items.length === 0) {
-    await context.focus.show('actor.step.hit.item', { target });
+    await context.focus.show('actor.step.hit.item', { target }, {
+      source: this,
+      volume: ShowMessageVolume.SELF,
+    });
     return;
   }
 
@@ -244,7 +253,13 @@ export async function ActorStepMove(this: Actor, context: ScriptContext): Promis
   }
 
   // move the actor and focus
-  await context.focus.show('actor.step.move.portal', { actor: this, portal: targetPortal });
+  await context.focus.show('actor.step.move.portal', {
+    actor: this,
+    portal: targetPortal,
+  }, {
+    source: this,
+    volume: ShowMessageVolume.SELF,
+  });
   await context.transfer.moveActor({
     moving: this,
     source: currentRoom.meta.id,

diff --git a/src/service/script/index.ts b/src/service/script/index.ts
@@ -11,6 +11,17 @@ import { SearchParams } from '../../util/state';
 import { Immutable, ScriptData } from '../../util/types';
 import { RandomGenerator } from '../random';
 
+export enum ShowMessageVolume {
+  SELF = 'self', // narrowest scope
+  ROOM = 'room',
+  WORLD = 'world',
+}
+
+export interface ShowSource {
+  source: WorldEntity;
+  volume: ShowMessageVolume;
+}
+
 export interface ScriptFocus {
   /**
    * Set the currently-focused room.
@@ -25,7 +36,7 @@ export interface ScriptFocus {
   /**
    * Display a message from an entity.
    */
-  show(msg: string, context?: LocaleContext): Promise<void>;
+  show(msg: string, context?: LocaleContext, source?: ShowSource): Promise<void>;
 }
 
 export interface TransferParams<TEntity extends WorldEntity> {

diff --git a/src/util/state/FocusResolver.ts b/src/util/state/FocusResolver.ts
@@ -2,13 +2,11 @@ import { doesExist, InvalidArgumentError, mustExist } from '@apextoaster/js-util
 import { BaseOptions } from 'noicejs';
 
 import { findRoom, searchState } from '.';
-import { WorldEntity } from '../../model/entity';
 import { Actor, ACTOR_TYPE, isActor } from '../../model/entity/Actor';
-import { ITEM_TYPE } from '../../model/entity/Item';
 import { isRoom, Room, ROOM_TYPE } from '../../model/entity/Room';
 import { State } from '../../model/State';
 import { LocaleContext } from '../../service/locale';
-import { ScriptFocus } from '../../service/script';
+import { ScriptFocus, ShowMessageVolume, ShowSource } from '../../service/script';
 
 export type FocusChangeRoom = (room: Room) => Promise<void>;
 export type FocusChangeActor = (actor: Actor) => Promise<void>;
@@ -25,17 +23,6 @@ interface StateFocusResolverOptions extends BaseOptions {
   state?: State;
 }
 
-export enum ShowMessageVolume {
-  SELF = 'self', // narrowest scope
-  ROOM = 'room',
-  WORLD = 'world',
-}
-
-interface ShowSource {
-  source: WorldEntity;
-  volume: ShowMessageVolume;
-}
-
 /**
  * Manages the `focus` field within world state, along with filtering output based on the current focus.
  */

diff --git a/test/util/state/TestFocus.ts b/test/util/state/TestFocus.ts
@@ -8,7 +8,8 @@ import { ITEM_TYPE } from '../../../src/model/entity/Item';
 import { ROOM_TYPE } from '../../../src/model/entity/Room';
 import { State } from '../../../src/model/State';
 import { LocalModule } from '../../../src/module/LocalModule';
-import { ShowMessageVolume, StateFocusResolver } from '../../../src/util/state/FocusResolver';
+import { ShowMessageVolume } from '../../../src/service/script';
+import { StateFocusResolver } from '../../../src/util/state/FocusResolver';
 
 const TEST_STATE: State = {
   focus: {