@dcl-regenesislabs/web-editor 0.3.20 → 0.3.21

package/prefabs/pickup-item/data.json

@@ -0,0 +1,26 @@
+{
+  "id": "3dd512ef-86ba-4ca2-8974-dc7629ded037",
+  "name": "Pickup Item",
+  "description": "Something players pick up with E (or the phone's action button), carry in the right hand, drop and throw. The Multiplayer Server decides who holds it, and the player sees it in hand at once. Works with: Work Station.",
+  "category": "custom",
+  "tags": [
+    "pickup",
+    "carry",
+    "hold",
+    "item",
+    "ingredient",
+    "throw",
+    "multiplayer"
+  ],
+  "requiresSdk": "auth-server",
+  "version": "1.0.0",
+  "changelog": [
+    {
+      "version": "1.0.0",
+      "notes": "Initial release: one holder at a time decided by the Multiplayer Server, held in the right hand and shown at once, a floating prompt with the device's own control, drop, optional throw, endless supply crates, and a script API to read, give and take what players carry."
+    }
+  ],
+  "origin": {
+    "source": "builtin"
+  }
+}

package/prefabs/pickup-item/scripts/pickup-item.ts

@@ -0,0 +1,43 @@
+import type { Entity } from '@dcl/sdk/ecs'
+import { isServer } from '@dcl/sdk/network'
+import { registerPickup } from '~runtime/carry'
+import { declareInteractButtons } from '~runtime/interactPrompt'
+
+export class PickupItem {
+  constructor(
+    public src: string,
+    public entity: Entity,
+    /** What this is, e.g. "Tomato". Stations, recipes and scripts match items by this word. */
+    public kind: string = 'Item',
+    /** "one item" is this thing itself; "endless" hands out a new one every time (a crate); "look only" is hidden and only gives the kind its look. */
+    public supply: 'one item' | 'endless' | 'look only' = 'one item',
+    /** The prompt's verb; "{item}" marks where the kind goes, otherwise it follows the verb. */
+    public pickVerb: string = 'Pick up',
+    public dropVerb: string = 'Drop',
+    public throwable: boolean = false,
+    public throwVerb: string = 'Throw',
+    /** Metres a player can be from it to pick it up. */
+    public range: number = 2,
+    /** Size in the hand, relative to the placed size. */
+    public heldScale: number = 1,
+    /** After a script uses it up, it comes back home after this many seconds; 0 waits for the next round. */
+    public returnSeconds: number = 0
+  ) {}
+
+  start(): void {
+    registerPickup({
+      entity: this.entity,
+      kind: this.kind,
+      supply: this.supply,
+      range: this.range,
+      pickVerb: this.pickVerb,
+      dropVerb: this.dropVerb,
+      throwVerb: this.throwVerb,
+      throwable: this.throwable,
+      heldScale: this.heldScale,
+      returnSeconds: this.returnSeconds
+    })
+    if (isServer() || this.supply === 'look only') return
+    declareInteractButtons(this.throwable ? 'throw' : undefined)
+  }
+}

package/prefabs/work-station/ai.md

@@ -0,0 +1,91 @@
+---
+prefab: work-station
+---
+
+# Work Station — AI guide
+
+A spot where a carried item is put down and taken back, and optionally worked
+on until it becomes another kind: chop, wash, cook. The Multiplayer Server
+decides; the player sees the result at once.
+
+The project copy is normally custom/work_station/ — check what is on disk.
+Items come from the Pickup Item prefab; read custom/pickup_item/ai.md too.
+
+## When to use
+
+Counters, chopping boards, sinks, stoves, ovens, delivery windows, crafting
+benches: anything that holds one carried item. Never write your own put-down /
+progress-bar / hold-F code: this prefab does all of it, on phones too.
+
+## API
+
+Params (set them in the placePrefab request):
+
+- `mode`: "counter" (holds one item), "hold to work" (progress only while a
+  player holds F / the phone's second button and stays near; letting go keeps
+  the progress), "timed" (progress runs by itself once the item is down —
+  cooking; after one turn it continues into the next recipe, so
+  "Soup > Burnt Soup" burns it).
+- `turns`: recipes, "Tomato > Chopped Tomato, Lettuce > Chopped Lettuce".
+- `seconds`: seconds each turn takes.
+- `accepts`: comma-separated kinds it takes; empty takes anything.
+- `combines`: putting one kind on another, "Bread + Cheese > Sandwich" (either
+  order). Without a combine, an occupied station refuses a second item.
+- `putVerb`, `takeVerb`, `workVerb`: prompt words ("{item}" places the kind),
+  in the scene's language. `workVerb` defaults to "Chop": set "Wash", "Knead"…
+- `range`: metres to use it (default 2).
+- `itemHeight`: where the item sits above the station's origin (the default
+  box top is at 0.9).
+
+The station's Name is its id. Its look is the "Work Station Top" child: replace
+that box with a model (or put a model on it). A progress bar floats over the
+station while work runs. Every round start empties every station.
+
+Each kind a station makes needs a look: place a Pickup Item with `supply` "look
+only" and that `kind` (e.g. "Chopped Tomato" with its model) anywhere.
+
+Script hooks live in `src/scripts/runtime/carry.ts` (`./runtime/carry`) — read
+the module header there: `onStation(name, fn)` for put/take/combine/done events,
+`setRecipe` / `setCombine` (call on BOTH sides, outside `isServer()`),
+`putOnStation` / `takeFromStation` / `stationItem` / `stationProgress`.
+
+## Do / Don't
+
+- DON'T count progress or swap kinds in your own `game.every`; use `turns` or
+  `setRecipe`.
+- DO react to a delivery with `onStation` inside `if (isServer())`, then clear
+  the station with `takeFromStation`.
+- DON'T put one Work Station on top of another; give each its own Name.
+
+## Example
+
+"Overcooked-style: chop tomatoes and serve them for points". Place:
+Pickup Item "Tomato Crate" (`kind` "Tomato", `supply` "endless"); Pickup Item
+"Chopped Tomato Look" (`kind` "Chopped Tomato", `supply` "look only"); Work
+Station "Chopping Board" (`mode` "hold to work", `turns` "Tomato > Chopped
+Tomato", `seconds` 3); Work Station "Serving Window" (`accepts` "Chopped
+Tomato", `putVerb` "Serve"). Then src/scripts/Serving.ts:
+
+```ts
+import { Entity } from '@dcl/sdk/ecs'
+import { isServer } from '@dcl/sdk/network'
+import { game } from './runtime/game'
+import { onStation, takeFromStation } from './runtime/carry'
+
+export class Serving {
+  constructor(public src: string, public entity: Entity) {}
+  start(): void {
+    if (!isServer()) return
+    onStation('Serving Window', (event) => {
+      if (event.type !== 'put' || event.player === undefined) return
+      takeFromStation('Serving Window')
+      const rows = (Array.isArray(game.state.served) ? game.state.served : []) as Array<{ player: string; score: number }>
+      const mine = rows.find((row) => row.player === event.player)
+      const others = rows.filter((row) => row !== mine)
+      game.setState({ served: [...others, { player: event.player, score: (mine?.score ?? 0) + 10 }] })
+    })
+  }
+}
+```
+
+A Leaderboard with `boardKey` "served" shows it.

package/prefabs/work-station/composite.json

@@ -0,0 +1,52 @@
+{
+  "version": 1,
+  "components": [
+    {
+      "name": "core-schema::Name",
+      "data": {
+        "512": { "json": { "value": "Work Station" } },
+        "513": { "json": { "value": "Work Station Top" } }
+      }
+    },
+    {
+      "name": "core::Transform",
+      "data": {
+        "513": {
+          "json": {
+            "position": { "x": 0, "y": 0.45, "z": 0 },
+            "rotation": { "x": 0, "y": 0, "z": 0, "w": 1 },
+            "scale": { "x": 1, "y": 0.9, "z": 0.8 },
+            "parent": 512
+          }
+        }
+      }
+    },
+    { "name": "core::MeshRenderer", "data": { "513": { "json": { "mesh": { "$case": "box", "box": { "uvs": [] } } } } } },
+    { "name": "core::MeshCollider", "data": { "513": { "json": { "mesh": { "$case": "box", "box": {} } } } } },
+    {
+      "name": "core::Material",
+      "data": {
+        "513": {
+          "json": {
+            "material": {
+              "$case": "pbr",
+              "pbr": { "albedoColor": { "r": 0.55, "g": 0.4, "b": 0.27, "a": 1 } }
+            }
+          }
+        }
+      }
+    },
+    {
+      "name": "asset-packs::Script",
+      "data": {
+        "512": {
+          "json": {
+            "value": [
+              { "path": "{assetPath}/scripts/work-station.ts", "priority": 0, "layout": "{\"params\":{},\"actions\":[]}" }
+            ]
+          }
+        }
+      }
+    }
+  ]
+}

package/prefabs/work-station/data.json

@@ -0,0 +1,26 @@
+{
+  "id": "500b804b-8d35-420a-b323-243df2e0eaa9",
+  "name": "Work Station",
+  "description": "A spot where a carried item is put down and taken back, and optionally worked on: hold F (or the phone's second button) to chop or wash it, or let it cook by itself, with a progress bar over it. Works with: Pickup Item.",
+  "category": "custom",
+  "tags": [
+    "station",
+    "counter",
+    "craft",
+    "cook",
+    "chop",
+    "progress",
+    "multiplayer"
+  ],
+  "requiresSdk": "auth-server",
+  "version": "1.0.0",
+  "changelog": [
+    {
+      "version": "1.0.0",
+      "notes": "Initial release: put down and take back one carried item, hold-to-work and timed modes that turn one kind into another with a progress bar, combining two kinds, and station events a script reacts to by the station's Name."
+    }
+  ],
+  "origin": {
+    "source": "builtin"
+  }
+}

package/prefabs/work-station/scripts/work-station.ts

@@ -0,0 +1,46 @@
+import type { Entity } from '@dcl/sdk/ecs'
+import { isServer } from '@dcl/sdk/network'
+import { registerStation } from '~runtime/carry'
+import { declareInteractButtons } from '~runtime/interactPrompt'
+
+export class WorkStation {
+  constructor(
+    public src: string,
+    public entity: Entity,
+    /** "counter" holds one item; "hold to work" turns it while a player holds F (the phone's second button); "timed" turns it by itself (cooking). */
+    public mode: 'counter' | 'hold to work' | 'timed' = 'counter',
+    /** What work turns into what, e.g. "Tomato > Chopped Tomato, Lettuce > Chopped Lettuce". */
+    public turns: string = '',
+    /** Seconds of work (or of waiting, when timed) each turn takes. */
+    public seconds: number = 3,
+    /** Kinds this station takes, comma-separated; empty takes anything. */
+    public accepts: string = '',
+    /** Putting one kind on another makes a third, e.g. "Bread + Cheese > Sandwich". */
+    public combines: string = '',
+    public putVerb: string = 'Put down',
+    public takeVerb: string = 'Take',
+    public workVerb: string = 'Chop',
+    /** Metres a player can be from it to use it. */
+    public range: number = 2,
+    /** Height above the station's origin where an item sits. */
+    public itemHeight: number = 1.05
+  ) {}
+
+  start(): void {
+    registerStation({
+      entity: this.entity,
+      mode: this.mode === 'hold to work' ? 'hold' : this.mode,
+      accepts: this.accepts,
+      turns: this.turns,
+      combines: this.combines,
+      seconds: this.seconds,
+      range: this.range,
+      itemHeight: this.itemHeight,
+      putVerb: this.putVerb,
+      takeVerb: this.takeVerb,
+      workVerb: this.workVerb
+    })
+    if (isServer()) return
+    declareInteractButtons(this.mode === 'hold to work' ? 'chop' : undefined)
+  }
+}

package/scene/about

@@ -5,7 +5,7 @@
     "networkId": 0,
     "globalScenesUrn": [],
     "scenesUrn": [
-      "urn:decentraland:entity:bafkreidloe2ozo4x2bmsjzt7svco43amj6pmj5zo7sisjnubj5w4et4sjm"
+      "urn:decentraland:entity:bafkreihd3gtmg3p2azy5yfmzwihyk2pwunwuqkhrjybqzdp6vavsosna4y"
     ],
     "realmName": "editor-scene"
   },

package/scene/{bafkreidloe2ozo4x2bmsjzt7svco43amj6pmj5zo7sisjnubj5w4et4sjm → bafkreihd3gtmg3p2azy5yfmzwihyk2pwunwuqkhrjybqzdp6vavsosna4y}

@@ -1 +1 @@
-{"content":[{"file":"scene.json","hash":"bafkreiby2gmthtauf7cckttphmhpecsueyypi2hzlke4lcodg7fm4cm2sq"},{"file":"bin/index.js","hash":"bafybeid4ndp7yylj3crls72kctre6gtc4hggnrxf7qqutw5giym2rr4qba"}],"pointers":[],"timestamp":0,"type":"scene","metadata":{"ecs7":true,"runtimeVersion":"7","display":{"title":"Component Inspector","description":"Inspect and modify component state of the current scene"},"owner":"","contact":{"name":"","email":""},"main":"bin/index.js","tags":[],"scene":{"parcels":["0,0"],"base":"0,0"},"spawnPoints":[],"featureToggles":{"portableExperiences":"enabled"}},"version":"v3"}
+{"content":[{"file":"scene.json","hash":"bafkreiby2gmthtauf7cckttphmhpecsueyypi2hzlke4lcodg7fm4cm2sq"},{"file":"bin/index.js","hash":"bafybeifiaotfpb4kis6f46xdw6a2rm6c534wewr55bq7zwcidmthvd4y7m"}],"pointers":[],"timestamp":0,"type":"scene","metadata":{"ecs7":true,"runtimeVersion":"7","display":{"title":"Component Inspector","description":"Inspect and modify component state of the current scene"},"owner":"","contact":{"name":"","email":""},"main":"bin/index.js","tags":[],"scene":{"parcels":["0,0"],"base":"0,0"},"spawnPoints":[],"featureToggles":{"portableExperiences":"enabled"}},"version":"v3"}