sci2-ts 0.6.1 → 0.8.0

package/CHANGELOG.md

@@ -4,6 +4,18 @@ All notable changes to this project. Versions follow [Semantic Versioning](https
 and the entries are generated from commit messages
 ([Conventional Commits](https://www.conventionalcommits.org/)) when a release is made.
 
+## [0.8.0](https://github.com/rlueder/sci-ts/compare/v0.7.0...v0.8.0) (2026-10-02)
+
+### Added
+
+* **content:** poses, idles and prop behaviours ([#7](https://github.com/rlueder/sci-ts/issues/7)) ([1413ca3](https://github.com/rlueder/sci-ts/commit/1413ca334a29255d9a67ca136f01607187e7bee6))
+
+## [0.7.0](https://github.com/rlueder/sci-ts/compare/v0.6.1...v0.7.0) (2026-10-01)
+
+### Added
+
+* **lib:** text speed, and dismissing a line from the keyboard ([#6](https://github.com/rlueder/sci-ts/issues/6)) ([3ab244b](https://github.com/rlueder/sci-ts/commit/3ab244b0d96a34dd0c3e7d13b1f52404fdceccfe))
+
 ## [0.6.1](https://github.com/rlueder/sci-ts/compare/v0.6.0...v0.6.1) (2026-10-01)
 
 ### Fixed

package/lib/992.sc

@@ -58,9 +58,17 @@
       add: SR_SAVE "Save the game"
       add: SR_RESTORE "Restore a game"
       add: SR_RESTART "Start again"
+      add: SR_TEXT (String STRING_FORMAT "Text speed: %s" (self textSpeedName:))
       add: 0 "Carry on"
       show: self))
 
+  (method (textSpeedName)
+    (switch textSpeed
+      (TEXT_SLOW (return "slow"))
+      (TEXT_FAST (return "fast"))
+      (TEXT_CLICK (return "until I click"))
+      (else (return "normal"))))
+
   ;; The saves there are now.
   (method (load)
     (self release:)
@@ -117,7 +125,15 @@
         (switch v
           (SR_SAVE (self save:))
           (SR_RESTORE (self restore:))
-          (SR_RESTART (RestartGame))))
+          (SR_RESTART (RestartGame))
+          ;; The next speed, slowest first; the menu again, showing it.
+          (SR_TEXT
+            (switch textSpeed
+              (TEXT_SLOW (= textSpeed TEXT_NORMAL))
+              (TEXT_NORMAL (= textSpeed TEXT_FAST))
+              (TEXT_FAST (= textSpeed TEXT_CLICK))
+              (else (= textSpeed TEXT_SLOW)))
+            (self showMenu:))))
       (SR_SAVE (if v (self askDescription: (- v 1))))
       (SR_RESTORE
         (if v

package/lib/996.sc

@@ -93,8 +93,9 @@
     (if bitmap (Bitmap BITMAP_DISPOSE bitmap) (= bitmap 0))
     (super dispose:)))
 
-;; Shows a line until it's been there long enough to read, or the player clicks; then
-;; cues whoever asked. The narrator speaks for no one in particular.
+;; Shows a line until it's been there long enough to read (as long as `textSpeed` says), or
+;; the player clicks or presses Enter, Space or "."; then cues whoever asked. The narrator
+;; speaks for no one in particular.
 (class Narrator of Obj
   (properties
     caller 0
@@ -119,15 +120,26 @@
         yourself:))
     (box init:)
     (= talking self)
-    ;; Two seconds, and more for longer lines.
-    (= until (+ gameTime 120 (* 3 (String STRING_LENGTH txt)))))
+    (= until (self readingTime: (String STRING_LENGTH txt))))
+
+  ;; Game time to read a line of n characters: normally two seconds, and more for longer
+  ;; lines; -1 is until the player dismisses it.
+  (method (readingTime n)
+    (switch textSpeed
+      (TEXT_SLOW (return (+ gameTime 180 (* 5 n))))
+      (TEXT_FAST (return (+ gameTime 70 (* 2 n))))
+      (TEXT_CLICK (return -1))
+      (else (return (+ gameTime 120 (* 3 n))))))
 
   (method (doit)
-    (if (and box (>= gameTime until)) (self done:)))
+    (if (and box (!= until -1) (>= gameTime until)) (self done:)))
 
-  ;; A click while a line is up dismisses it (and nothing else).
+  ;; A click, Enter, Space or "." while a line is up dismisses it (and nothing else).
   (method (handleEvent event)
-    (if (and box (== (event type?) EV_MOUSE_DOWN))
+    (if (and box
+          (or (== (event type?) EV_MOUSE_DOWN)
+            (and (== (event type?) EV_KEY_DOWN)
+              (or (== (event message?) KEY_ENTER) (== (event message?) KEY_SPACE) (== (event message?) KEY_PERIOD)))))
       (event claimed: TRUE)
       (self done:)
       (return TRUE))

package/lib/998.sc

@@ -207,9 +207,11 @@
     (if (not (and noun (messager say: noun verb 0 0 0 modNum)))
       (curRoom doVerb: verb))))
 
-;; A Feature drawn with a view: a screen item in the room's plane.
+;; A Feature drawn with a view: a screen item in the room's plane. One that's only there to
+;; look at (rain on a window, a sky) has clickable 0, and clicks go to what's behind it.
 (class View of Feature
   (properties
+    clickable 1
     view -1 loop 0 cel 0
     z 0
     priority 0 fixPriority 0
@@ -230,7 +232,7 @@
     (if (not (& signal SIG_HIDDEN)) (UpdateScreenItem self)))
 
   (method (onMe theX theY)
-    (return (and (not (& signal SIG_HIDDEN)) (IsOnMe theX theY self))))
+    (return (and clickable (not (& signal SIG_HIDDEN)) (IsOnMe theX theY self))))
 
   (method (hide)
     (|= signal SIG_HIDDEN)
@@ -364,13 +366,51 @@
     (if scaler (scaler dispose:) (= scaler 0))
     (super dispose:)))
 
-;; The hero: walks where the player clicks, and goes from room to room.
+;; The hero: walks where the player clicks, and goes from room to room. Standing still
+;; for idleAfter seconds while the player can act, he plays a loop of idleView once (a
+;; puff on the pipe, a glance at a watch), chosen at random, then stands again.
 (class Ego of Actor
-  ;; Back to walking: cycling as he moves, turning as he goes, seen.
+  (properties
+    normalView -1   ; the walking view (the first view he's normalized with)
+    idleView -1     ; -1: no idles
+    idleAfter 8
+    stillSince 0    ; the game time he was last busy
+    idling 0)
+
+  ;; Back to walking: his walking view, cycling as he moves, turning as he goes, seen.
   (method (normalize)
+    (if (== normalView -1) (= normalView view) else (= view normalView))
+    (= idling 0)
     (self setLoop: -1 setCycle: Walk show:)
     (return self))
 
+  (method (doit)
+    (super doit:)
+    (self checkIdle:))
+
+  (method (checkIdle)
+    (cond
+      ((== idleView -1) 0)
+      ;; Busy, or someone else is in charge: no idle, and one under way stops.
+      ((or mover talking dialog (not (user canInput?)) (and (not idling) (!= view normalView)))
+        (if idling (self normalize:))
+        (= stillSince gameTime))
+      (idling 0)
+      ((>= (- gameTime stillSince) (* idleAfter 60))
+        (= idling 1)
+        (= view idleView)
+        (self setLoop: (Random 0 (- (NumLoops self) 1)) setCel: 0 setCycle: End self))))
+
+  ;; An idle has played through.
+  (method (cue)
+    (if idling
+      (self normalize:)
+      (= stillSince gameTime)))
+
+  (method (setMotion)
+    (if idling (self normalize:))
+    (super setMotion: &rest))
+
   (method (roomDisposed)
     (self setMotion: 0)
     (DeleteScreenItem self)

package/lib/999.sc

@@ -31,7 +31,8 @@
   textStyle       ; how text boxes and menus look (a TextStyle)
   inventory       ; what the hero carries (an Inventory)
   theItem         ; the item picked to use, or 0
-  iconBar)        ; the icon bar (an IconBar)
+  iconBar         ; the icon bar (an IconBar)
+  textSpeed)      ; how long a line stays up: TEXT_NORMAL, TEXT_SLOW, TEXT_FAST, TEXT_CLICK
 
 (procedure (SetFlag n)
   (|= [gameFlags (/ n 16)] (<< 1 (mod n 16))))

package/lib/system.sh

@@ -44,6 +44,14 @@
 (define SR_RESTORE 3)
 (define SR_RESTART 4)
 (define SR_NAME 5)
+(define SR_TEXT 6)
+
+;; How long a line stays up (the textSpeed global): normal (the default), slow, fast, or
+;; until the player clicks.
+(define TEXT_NORMAL 0)
+(define TEXT_SLOW 1)
+(define TEXT_FAST 2)
+(define TEXT_CLICK 3)
 
 ;; Event types, as GetEvent reports them.
 (define EV_NULL 0)
@@ -54,6 +62,8 @@
 ;; Keys (an event's message).
 (define KEY_TAB 9)
 (define KEY_ENTER 13)
+(define KEY_SPACE 32)
+(define KEY_PERIOD 46)
 (define KEY_ESCAPE 27)
 (define KEY_F5 $3f00)
 (define KEY_F7 $4100)
@@ -78,6 +88,7 @@
 (define ARRAY_AT_PUT 3)
 (define ARRAY_FREE 4)
 (define STRING_LENGTH 10)
+(define STRING_FORMAT 11)
 (define STRING_FORMAT_INTO 12)
 (define ARRAY_COPY 6)
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "sci2-ts",
-  "version": "0.6.1",
+  "version": "0.8.0",
   "description": "An SCI2 adventure game engine in TypeScript, and the tools to make games with it",
   "license": "MIT",
   "type": "module",

package/packages/content/room.schema.json

@@ -222,6 +222,11 @@
           "moves": {
             "type": "boolean",
             "description": "It walks or floats about in cutscenes (<<walk name x y>>): an Actor instead of a Prop"
+          },
+          "script": {
+            "type": "string",
+            "pattern": "^[A-Z][A-Za-z0-9]*$",
+            "description": "A Script class of the game's: an instance of it runs on the prop, e.g. an ambient behaviour"
           }
         }
       }

package/packages/content/src/room.d.ts

@@ -82,6 +82,8 @@ interface PropSpec {
     /** forward: loop the animation forever. */
     cycle?: "forward";
     sightAngle?: number;
+    /** A Script class of the game's: an instance of it runs on the prop (ambient behaviour). */
+    script?: string;
 }
 export interface CompiledRoom {
     number: number;

package/packages/content/src/room.js

@@ -83,7 +83,9 @@ class SpecChecker {
                 names.add(name);
                 const t = this.map(value, path);
                 if (group === "props") {
-                    this.known(t, path, ["view", "at", "loop", "cel", "cycle", "sightAngle", "moves"]);
+                    this.known(t, path, ["view", "at", "loop", "cel", "cycle", "sightAngle", "moves", "script"]);
+                    if (t.script !== undefined && (typeof t.script !== "string" || !/^[A-Z][A-Za-z0-9]*$/.test(t.script)))
+                        this.fail([...path, "script"], "expected a class name, e.g. Scurry");
                     if (t.moves !== undefined && typeof t.moves !== "boolean")
                         this.fail([...path, "moves"], "expected true or false");
                     this.int(t.view, [...path, "view"], 0, 65535);
@@ -522,6 +524,14 @@ class RoomCompiler {
                     return [{ op: "code", code: send(to, [["setCycle", [{ cls: this.target.forwardCycle }]]]) }];
                 return fail("expected once or forever");
             }
+            case "view":
+                arity(2, "hero|<prop> view");
+                return [{ op: "code", code: send(who(args[0], false), [["view", [int(args[1], "view", 0, 65535)]], ["setCel", [0]]]) }];
+            case "normal":
+                arity(1, "hero");
+                if (args[0] !== "hero")
+                    fail("only the hero goes back to normal (walking, turning as he goes)");
+                return [{ op: "code", code: send({ global: g.ego }, [["normalize", []]]) }];
             case "stop":
                 arity(1, "<prop>");
                 return [{ op: "code", code: send(who(args[0], false), [["setCycle", [0]]]) }];
@@ -564,7 +574,7 @@ class RoomCompiler {
                 arity(1, "number");
                 return [{ op: "code", code: send({ global: g.curRoom }, [["newRoom", [int(args[0], "room", 0, 65535)]]]) }];
             default:
-                return fail("unknown command (known: walk, face, wait, hide, show, loop, cel, animate, stop, music, sound, closeup, get, drop, room; and set, if)");
+                return fail("unknown command (known: walk, face, wait, hide, show, view, loop, cel, animate, normal, stop, music, sound, closeup, get, drop, room; and set, if)");
         }
     }
     /** Loop music n, unless it's what's playing already. */
@@ -728,7 +738,12 @@ class RoomCompiler {
         for (const name of [...Object.keys(spec.features ?? {}), ...Object.keys(spec.exits ?? {})])
             c.push(...send({ obj: name }, [["init", []]]));
         for (const [name, p] of Object.entries(spec.props ?? {})) {
-            c.push(...send({ obj: name }, [["init", []], ...(p.cycle === "forward" ? [["setCycle", [{ cls: this.target.forwardCycle }]]] : [])]));
+            c.push(...send({ obj: name }, [
+                ["init", []],
+                ...(p.cycle === "forward" ? [["setCycle", [{ cls: this.target.forwardCycle }]]] : []),
+                // A new instance of the game's Script class, running on the prop.
+                ...(p.script ? [["setScript", [{ code: ["pushi #new", "push0", `class ${p.script}`, "send 4"] }]]] : []),
+            ]));
         }
         const polygons = [
             ...(spec.walkable ? [[3, spec.walkable]] : []),

package/packages/content/src/room.ts

@@ -85,6 +85,8 @@ interface PropSpec {
   /** forward: loop the animation forever. */
   cycle?: "forward";
   sightAngle?: number;
+  /** A Script class of the game's: an instance of it runs on the prop (ambient behaviour). */
+  script?: string;
 }
 
 export interface CompiledRoom {
@@ -186,7 +188,8 @@ class SpecChecker {
         names.add(name);
         const t = this.map(value, path);
         if (group === "props") {
-          this.known(t, path, ["view", "at", "loop", "cel", "cycle", "sightAngle", "moves"]);
+          this.known(t, path, ["view", "at", "loop", "cel", "cycle", "sightAngle", "moves", "script"]);
+          if (t.script !== undefined && (typeof t.script !== "string" || !/^[A-Z][A-Za-z0-9]*$/.test(t.script))) this.fail([...path, "script"], "expected a class name, e.g. Scurry");
           if (t.moves !== undefined && typeof t.moves !== "boolean") this.fail([...path, "moves"], "expected true or false");
           this.int(t.view, [...path, "view"], 0, 65535);
           this.point(t.at, [...path, "at"]);
@@ -622,6 +625,13 @@ class RoomCompiler {
         if (args[1] === "forever") return [{ op: "code", code: send(to, [["setCycle", [{ cls: this.target.forwardCycle }]]]) }];
         return fail("expected once or forever");
       }
+      case "view":
+        arity(2, "hero|<prop> view");
+        return [{ op: "code", code: send(who(args[0], false), [["view", [int(args[1], "view", 0, 65535)]], ["setCel", [0]]]) }];
+      case "normal":
+        arity(1, "hero");
+        if (args[0] !== "hero") fail("only the hero goes back to normal (walking, turning as he goes)");
+        return [{ op: "code", code: send({ global: g.ego }, [["normalize", []]]) }];
       case "stop":
         arity(1, "<prop>");
         return [{ op: "code", code: send(who(args[0], false), [["setCycle", [0]]]) }];
@@ -661,7 +671,7 @@ class RoomCompiler {
         arity(1, "number");
         return [{ op: "code", code: send({ global: g.curRoom }, [["newRoom", [int(args[0], "room", 0, 65535)]]]) }];
       default:
-        return fail("unknown command (known: walk, face, wait, hide, show, loop, cel, animate, stop, music, sound, closeup, get, drop, room; and set, if)");
+        return fail("unknown command (known: walk, face, wait, hide, show, view, loop, cel, animate, normal, stop, music, sound, closeup, get, drop, room; and set, if)");
     }
   }
 
@@ -831,7 +841,12 @@ class RoomCompiler {
     if (spec.music !== undefined) c.push(...this.playMusic(spec.music));
     for (const name of [...Object.keys(spec.features ?? {}), ...Object.keys(spec.exits ?? {})]) c.push(...send({ obj: name }, [["init", []]]));
     for (const [name, p] of Object.entries(spec.props ?? {})) {
-      c.push(...send({ obj: name }, [["init", []], ...(p.cycle === "forward" ? [["setCycle", [{ cls: this.target.forwardCycle }]] as [string, Val[]]] : [])]));
+      c.push(...send({ obj: name }, [
+        ["init", []],
+        ...(p.cycle === "forward" ? [["setCycle", [{ cls: this.target.forwardCycle }]] as [string, Val[]]] : []),
+        // A new instance of the game's Script class, running on the prop.
+        ...(p.script ? [["setScript", [{ code: ["pushi #new", "push0", `class ${p.script}`, "send 4"] }]] as [string, Val[]]] : []),
+      ]));
     }
     const polygons: [number, [number, number][]][] = [
       ...(spec.walkable ? [[3, spec.walkable] as [number, [number, number][]]] : []),