@dcl/sdk 7.3.40-7698451743.commit-c9c61fe → 7.3.40-7717066166.commit-ece036d

package/package.json

@@ -1,15 +1,15 @@
 {
   "name": "@dcl/sdk",
   "description": "",
-  "version": "7.3.40-7698451743.commit-c9c61fe",
+  "version": "7.3.40-7717066166.commit-ece036d",
   "author": "Decentraland",
   "dependencies": {
-    "@dcl/ecs": "7.3.40-7698451743.commit-c9c61fe",
+    "@dcl/ecs": "7.3.40-7717066166.commit-ece036d",
     "@dcl/ecs-math": "2.0.2",
     "@dcl/explorer": "1.0.159327-20240122142059.commit-58ce257",
-    "@dcl/js-runtime": "7.3.40-7698451743.commit-c9c61fe",
-    "@dcl/react-ecs": "7.3.40-7698451743.commit-c9c61fe",
-    "@dcl/sdk-commands": "7.3.40-7698451743.commit-c9c61fe",
+    "@dcl/js-runtime": "7.3.40-7717066166.commit-ece036d",
+    "@dcl/react-ecs": "7.3.40-7717066166.commit-ece036d",
+    "@dcl/sdk-commands": "7.3.40-7717066166.commit-ece036d",
     "text-encoding": "0.7.0"
   },
   "keywords": [],
@@ -35,5 +35,5 @@
   },
   "types": "./index.d.ts",
   "typings": "./index.d.ts",
-  "commit": "c9c61fe791438f55937546344bdd16b4f8f0cd6c"
+  "commit": "ece036db9e954a6f07bc175aa6f139d48680be87"
 }

package/players/index.d.ts

@@ -0,0 +1,23 @@
+import { Entity, TransformType } from '@dcl/ecs';
+import { PBAvatarBase, PBAvatarEquippedData } from '@dcl/ecs/dist/components';
+type GetPlayerDataReq = {
+    userId: string;
+};
+type GetPlayerDataRes = {
+    entity: Entity;
+    name: string;
+    isGuest: boolean;
+    userId: string;
+    avatar?: PBAvatarBase;
+    wearables: PBAvatarEquippedData['wearableUrns'];
+    emotes: PBAvatarEquippedData['emoteUrns'];
+    position: TransformType['position'] | undefined;
+};
+declare const players: {
+    onEnterScene(cb: (player: GetPlayerDataRes) => void): void;
+    onLeaveScene(cb: (userId: string) => void): void;
+    getPlayer(user?: GetPlayerDataReq): GetPlayerDataRes | null;
+};
+declare const getPlayer: (user?: GetPlayerDataReq) => GetPlayerDataRes | null, onEnterScene: (cb: (player: GetPlayerDataRes) => void) => void, onLeaveScene: (cb: (userId: string) => void) => void;
+export { getPlayer, onEnterScene, onLeaveScene };
+export default players;

package/players/index.js

@@ -0,0 +1,73 @@
+import { engine } from '@dcl/ecs';
+import { PlayerIdentityData as definePlayerIdenityData, AvatarBase as defineAvatarBase, AvatarEquippedData as defineAvatarEquippedData, Transform as defineTransform } from '@dcl/ecs/dist/components';
+function definePlayerHelper(engine) {
+    const Transform = defineTransform(engine);
+    const PlayerIdentityData = definePlayerIdenityData(engine);
+    const AvatarEquippedData = defineAvatarEquippedData(engine);
+    const AvatarBase = defineAvatarBase(engine);
+    const playerEntities = new Map();
+    let onEnterSceneCb = undefined;
+    let onLeaveSceneCb = undefined;
+    engine.addSystem(() => {
+        const players = Array.from(engine.getEntitiesWith(PlayerIdentityData, AvatarBase));
+        if (players.length === playerEntities.size)
+            return;
+        for (const [entity, identity] of players) {
+            if (!playerEntities.has(entity)) {
+                playerEntities.set(entity, identity.address);
+                if (onEnterSceneCb) {
+                    onEnterSceneCb(getPlayer({ userId: identity.address }));
+                }
+                AvatarBase.onChange(entity, (value) => {
+                    if (!value && onLeaveSceneCb && playerEntities.get(entity)) {
+                        onLeaveSceneCb(playerEntities.get(entity));
+                        playerEntities.delete(entity);
+                    }
+                });
+            }
+        }
+    });
+    return {
+        onEnterScene(cb) {
+            onEnterSceneCb = cb;
+        },
+        onLeaveScene(cb) {
+            onLeaveSceneCb = cb;
+        },
+        getPlayer(user) {
+            function getEntity() {
+                if (!user?.userId)
+                    return engine.PlayerEntity;
+                for (const [entity, data] of engine.getEntitiesWith(PlayerIdentityData)) {
+                    if (data.address === user.userId) {
+                        return entity;
+                    }
+                }
+                return undefined;
+            }
+            const userEntity = getEntity();
+            if (!userEntity)
+                return null;
+            const playerData = PlayerIdentityData.getOrNull(userEntity);
+            const avatarData = AvatarBase.getOrNull(userEntity);
+            const wearablesData = AvatarEquippedData.getOrNull(userEntity);
+            if (!playerData && !avatarData && !wearablesData)
+                return null;
+            return {
+                entity: userEntity,
+                name: avatarData?.name ?? '',
+                isGuest: !!playerData?.isGuest ?? false,
+                userId: playerData?.address ?? '',
+                avatar: avatarData ?? undefined,
+                wearables: wearablesData?.wearableUrns ?? [],
+                emotes: wearablesData?.emoteUrns ?? [],
+                position: Transform.getOrNull(userEntity)?.position
+            };
+        }
+    };
+}
+const players = definePlayerHelper(engine);
+const { getPlayer, onEnterScene, onLeaveScene } = players;
+export { getPlayer, onEnterScene, onLeaveScene };
+export default players;
+//# sourceMappingURL=data:application/json;base64,{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/players/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAkC,MAAM,EAAE,MAAM,UAAU,CAAA;AACjE,OAAO,EACL,kBAAkB,IAAI,uBAAuB,EAC7C,UAAU,IAAI,gBAAgB,EAC9B,kBAAkB,IAAI,wBAAwB,EAG9C,SAAS,IAAI,eAAe,EAC7B,MAAM,0BAA0B,CAAA;AAgBjC,SAAS,kBAAkB,CAAC,MAAe;IACzC,MAAM,SAAS,GAAG,eAAe,CAAC,MAAM,CAAC,CAAA;IACzC,MAAM,kBAAkB,GAAG,uBAAuB,CAAC,MAAM,CAAC,CAAA;IAC1D,MAAM,kBAAkB,GAAG,wBAAwB,CAAC,MAAM,CAAC,CAAA;IAC3D,MAAM,UAAU,GAAG,gBAAgB,CAAC,MAAM,CAAC,CAAA;IAC3C,MAAM,cAAc,GAAG,IAAI,GAAG,EAAkB,CAAA;IAChD,IAAI,cAAc,GAAqD,SAAS,CAAA;IAChF,IAAI,cAAc,GAA2C,SAAS,CAAA;IAEtE,MAAM,CAAC,SAAS,CAAC,GAAG,EAAE;QACpB,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,eAAe,CAAC,kBAAkB,EAAE,UAAU,CAAC,CAAC,CAAA;QAClF,IAAI,OAAO,CAAC,MAAM,KAAK,cAAc,CAAC,IAAI;YAAE,OAAM;QAElD,KAAK,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,IAAI,OAAO,EAAE;YACxC,IAAI,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;gBAC/B,cAAc,CAAC,GAAG,CAAC,MAAM,EAAE,QAAQ,CAAC,OAAO,CAAC,CAAA;gBAG5C,IAAI,cAAc,EAAE;oBAClB,cAAc,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,OAAO,EAAE,CAAE,CAAC,CAAA;iBACzD;gBAGD,UAAU,CAAC,QAAQ,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;oBACpC,IAAI,CAAC,KAAK,IAAI,cAAc,IAAI,cAAc,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;wBAC1D,cAAc,CAAC,cAAc,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,CAAA;wBAC3C,cAAc,CAAC,MAAM,CAAC,MAAM,CAAC,CAAA;qBAC9B;gBACH,CAAC,CAAC,CAAA;aACH;SACF;IACH,CAAC,CAAC,CAAA;IAEF,OAAO;QACL,YAAY,CAAC,EAAsC;YACjD,cAAc,GAAG,EAAE,CAAA;QACrB,CAAC;QACD,YAAY,CAAC,EAA4B;YACvC,cAAc,GAAG,EAAE,CAAA;QACrB,CAAC;QAID,SAAS,CAAC,IAAuB;YAC/B,SAAS,SAAS;gBAChB,IAAI,CAAC,IAAI,EAAE,MAAM;oBAAE,OAAO,MAAM,CAAC,YAAY,CAAA;gBAC7C,KAAK,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,MAAM,CAAC,eAAe,CAAC,kBAAkB,CAAC,EAAE;oBACvE,IAAI,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,MAAM,EAAE;wBAChC,OAAO,MAAM,CAAA;qBACd;iBACF;gBACD,OAAO,SAAS,CAAA;YAClB,CAAC;YAED,MAAM,UAAU,GAAG,SAAS,EAAE,CAAA;YAC9B,IAAI,CAAC,UAAU;gBAAE,OAAO,IAAI,CAAA;YAE5B,MAAM,UAAU,GAAG,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;YAC3D,MAAM,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;YACnD,MAAM,aAAa,GAAG,kBAAkB,CAAC,SAAS,CAAC,UAAU,CAAC,CAAA;YAE9D,IAAI,CAAC,UAAU,IAAI,CAAC,UAAU,IAAI,CAAC,aAAa;gBAAE,OAAO,IAAI,CAAA;YAE7D,OAAO;gBACL,MAAM,EAAE,UAAU;gBAClB,IAAI,EAAE,UAAU,EAAE,IAAI,IAAI,EAAE;gBAC5B,OAAO,EAAE,CAAC,CAAC,UAAU,EAAE,OAAO,IAAI,KAAK;gBACvC,MAAM,EAAE,UAAU,EAAE,OAAO,IAAI,EAAE;gBACjC,MAAM,EAAE,UAAU,IAAI,SAAS;gBAC/B,SAAS,EAAE,aAAa,EAAE,YAAY,IAAI,EAAE;gBAC5C,MAAM,EAAE,aAAa,EAAE,SAAS,IAAI,EAAE;gBACtC,QAAQ,EAAE,SAAS,CAAC,SAAS,CAAC,UAAU,CAAC,EAAE,QAAQ;aACpD,CAAA;QACH,CAAC;KACF,CAAA;AACH,CAAC;AAED,MAAM,OAAO,GAAG,kBAAkB,CAAC,MAAM,CAAC,CAAA;AAC1C,MAAM,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,GAAG,OAAO,CAAA;AAEzD,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,YAAY,EAAE,CAAA;AAChD,eAAe,OAAO,CAAA","sourcesContent":["import { Entity, IEngine, TransformType, engine } from '@dcl/ecs'\nimport {\n  PlayerIdentityData as definePlayerIdenityData,\n  AvatarBase as defineAvatarBase,\n  AvatarEquippedData as defineAvatarEquippedData,\n  PBAvatarBase,\n  PBAvatarEquippedData,\n  Transform as defineTransform\n} from '@dcl/ecs/dist/components'\n\ntype GetPlayerDataReq = {\n  userId: string\n}\ntype GetPlayerDataRes = {\n  entity: Entity\n  name: string\n  isGuest: boolean\n  userId: string\n  avatar?: PBAvatarBase\n  wearables: PBAvatarEquippedData['wearableUrns']\n  emotes: PBAvatarEquippedData['emoteUrns']\n  position: TransformType['position'] | undefined\n}\n\nfunction definePlayerHelper(engine: IEngine) {\n  const Transform = defineTransform(engine)\n  const PlayerIdentityData = definePlayerIdenityData(engine)\n  const AvatarEquippedData = defineAvatarEquippedData(engine)\n  const AvatarBase = defineAvatarBase(engine)\n  const playerEntities = new Map<Entity, string>()\n  let onEnterSceneCb: ((player: GetPlayerDataRes) => void) | undefined = undefined\n  let onLeaveSceneCb: ((userId: string) => void) | undefined = undefined\n\n  engine.addSystem(() => {\n    const players = Array.from(engine.getEntitiesWith(PlayerIdentityData, AvatarBase))\n    if (players.length === playerEntities.size) return\n\n    for (const [entity, identity] of players) {\n      if (!playerEntities.has(entity)) {\n        playerEntities.set(entity, identity.address)\n\n        // Call onEnter callback\n        if (onEnterSceneCb) {\n          onEnterSceneCb(getPlayer({ userId: identity.address })!)\n        }\n\n        // Check for changes/remove callbacks\n        AvatarBase.onChange(entity, (value) => {\n          if (!value && onLeaveSceneCb && playerEntities.get(entity)) {\n            onLeaveSceneCb(playerEntities.get(entity)!)\n            playerEntities.delete(entity)\n          }\n        })\n      }\n    }\n  })\n\n  return {\n    onEnterScene(cb: (player: GetPlayerDataRes) => void) {\n      onEnterSceneCb = cb\n    },\n    onLeaveScene(cb: (userId: string) => void) {\n      onLeaveSceneCb = cb\n    },\n    /**\n     * Returns the info of the player if it's in the scene.\n     */\n    getPlayer(user?: GetPlayerDataReq): GetPlayerDataRes | null {\n      function getEntity() {\n        if (!user?.userId) return engine.PlayerEntity\n        for (const [entity, data] of engine.getEntitiesWith(PlayerIdentityData)) {\n          if (data.address === user.userId) {\n            return entity\n          }\n        }\n        return undefined\n      }\n\n      const userEntity = getEntity()\n      if (!userEntity) return null\n\n      const playerData = PlayerIdentityData.getOrNull(userEntity)\n      const avatarData = AvatarBase.getOrNull(userEntity)\n      const wearablesData = AvatarEquippedData.getOrNull(userEntity)\n\n      if (!playerData && !avatarData && !wearablesData) return null\n\n      return {\n        entity: userEntity,\n        name: avatarData?.name ?? '',\n        isGuest: !!playerData?.isGuest ?? false,\n        userId: playerData?.address ?? '',\n        avatar: avatarData ?? undefined,\n        wearables: wearablesData?.wearableUrns ?? [],\n        emotes: wearablesData?.emoteUrns ?? [],\n        position: Transform.getOrNull(userEntity)?.position\n      }\n    }\n  }\n}\n\nconst players = definePlayerHelper(engine)\nconst { getPlayer, onEnterScene, onLeaveScene } = players\n\nexport { getPlayer, onEnterScene, onLeaveScene }\nexport default players\n"]}

package/src/players/index.ts

@@ -0,0 +1,106 @@
+import { Entity, IEngine, TransformType, engine } from '@dcl/ecs'
+import {
+  PlayerIdentityData as definePlayerIdenityData,
+  AvatarBase as defineAvatarBase,
+  AvatarEquippedData as defineAvatarEquippedData,
+  PBAvatarBase,
+  PBAvatarEquippedData,
+  Transform as defineTransform
+} from '@dcl/ecs/dist/components'
+
+type GetPlayerDataReq = {
+  userId: string
+}
+type GetPlayerDataRes = {
+  entity: Entity
+  name: string
+  isGuest: boolean
+  userId: string
+  avatar?: PBAvatarBase
+  wearables: PBAvatarEquippedData['wearableUrns']
+  emotes: PBAvatarEquippedData['emoteUrns']
+  position: TransformType['position'] | undefined
+}
+
+function definePlayerHelper(engine: IEngine) {
+  const Transform = defineTransform(engine)
+  const PlayerIdentityData = definePlayerIdenityData(engine)
+  const AvatarEquippedData = defineAvatarEquippedData(engine)
+  const AvatarBase = defineAvatarBase(engine)
+  const playerEntities = new Map<Entity, string>()
+  let onEnterSceneCb: ((player: GetPlayerDataRes) => void) | undefined = undefined
+  let onLeaveSceneCb: ((userId: string) => void) | undefined = undefined
+
+  engine.addSystem(() => {
+    const players = Array.from(engine.getEntitiesWith(PlayerIdentityData, AvatarBase))
+    if (players.length === playerEntities.size) return
+
+    for (const [entity, identity] of players) {
+      if (!playerEntities.has(entity)) {
+        playerEntities.set(entity, identity.address)
+
+        // Call onEnter callback
+        if (onEnterSceneCb) {
+          onEnterSceneCb(getPlayer({ userId: identity.address })!)
+        }
+
+        // Check for changes/remove callbacks
+        AvatarBase.onChange(entity, (value) => {
+          if (!value && onLeaveSceneCb && playerEntities.get(entity)) {
+            onLeaveSceneCb(playerEntities.get(entity)!)
+            playerEntities.delete(entity)
+          }
+        })
+      }
+    }
+  })
+
+  return {
+    onEnterScene(cb: (player: GetPlayerDataRes) => void) {
+      onEnterSceneCb = cb
+    },
+    onLeaveScene(cb: (userId: string) => void) {
+      onLeaveSceneCb = cb
+    },
+    /**
+     * Returns the info of the player if it's in the scene.
+     */
+    getPlayer(user?: GetPlayerDataReq): GetPlayerDataRes | null {
+      function getEntity() {
+        if (!user?.userId) return engine.PlayerEntity
+        for (const [entity, data] of engine.getEntitiesWith(PlayerIdentityData)) {
+          if (data.address === user.userId) {
+            return entity
+          }
+        }
+        return undefined
+      }
+
+      const userEntity = getEntity()
+      if (!userEntity) return null
+
+      const playerData = PlayerIdentityData.getOrNull(userEntity)
+      const avatarData = AvatarBase.getOrNull(userEntity)
+      const wearablesData = AvatarEquippedData.getOrNull(userEntity)
+
+      if (!playerData && !avatarData && !wearablesData) return null
+
+      return {
+        entity: userEntity,
+        name: avatarData?.name ?? '',
+        isGuest: !!playerData?.isGuest ?? false,
+        userId: playerData?.address ?? '',
+        avatar: avatarData ?? undefined,
+        wearables: wearablesData?.wearableUrns ?? [],
+        emotes: wearablesData?.emoteUrns ?? [],
+        position: Transform.getOrNull(userEntity)?.position
+      }
+    }
+  }
+}
+
+const players = definePlayerHelper(engine)
+const { getPlayer, onEnterScene, onLeaveScene } = players
+
+export { getPlayer, onEnterScene, onLeaveScene }
+export default players