feat: dynamic lights (#1049)

* Updated Makefile to improve the command update-protocol. Updated protocol to experimental branch

* Added LigthSource tests and helper method

* Regenerated playground-assets.api.md

* Updated snapshots

Author: AlejandroAlvarezMelucciDCL

Makefile

@@ -32,10 +32,19 @@ install:
 	make node_modules/.bin/protobuf/bin/protoc
 
 update-protocol:
-	npm i --save-exact @dcl/protocol@next
-	cd packages/@dcl/sdk-commands; npm i --save-exact @dcl/protocol@next
+	@PROTO_TAG=$(word 2,$(MAKECMDGOALS)); \
+	if [ -z "$$PROTO_TAG" ]; then PROTO_TAG=next; fi; \
+	if [ "$$PROTO_TAG" != "next" ] && [ "$$PROTO_TAG" != "experimental" ]; then \
+	  echo "$$PROTO_TAG is not a valid argument" && exit 1; \
+	fi; \
+	echo "Using protocol tag: $$PROTO_TAG"; \
+	npm i --save-exact @dcl/protocol@$$PROTO_TAG; \
+	(cd packages/@dcl/sdk-commands && npm i --save-exact @dcl/protocol@$$PROTO_TAG); \
 	$(MAKE) sync-deps compile_apis
 
+%:
+	@:
+
 update-renderer:
 	cd packages/@dcl/sdk; npm i --save-exact @dcl/explorer@latest
 
@@ -171,4 +180,4 @@ clean:
 
 init-test-scene:
 	git clone https://github.com/decentraland/sdk7-scene-template test-scene
-	cd test-scene && npm i ./../packages/@dcl/sdk  && npm i ./../packages/@dcl/sdk-commands  && npm i ./../packages/@dcl/js-runtime
+	cd test-scene && npm i ./../packages/@dcl/sdk  && npm i ./../packages/@dcl/sdk-commands  && npm i ./../packages/@dcl/js-runtime

package-lock.json

@@ -6,7 +6,7 @@
   "bugs": "https://github.com/decentraland/js-sdk-toolchain/issues",
   "dependencies": {
     "@actions/core": "^1.10.0",
-    "@dcl/protocol": "1.0.0-12891435340.commit-b3fea33",
+    "@dcl/protocol": "1.0.0-13143749736.commit-5fbeb3c",
     "@dcl/quickjs-emscripten": "^0.21.0-3680274614.commit-1808aa1",
     "@dcl/ts-proto": "1.153.0",
     "@types/fs-extra": "^9.0.12",

package.json

@@ -0,0 +1,55 @@
+import { IEngine, LastWriteWinElementSetComponentDefinition } from '../../engine'
+import { LightSource, PBLightSource_Point, PBLightSource_Spot, PBLightSource } from '../generated/index.gen'
+import {} from '../generated/LightSource.gen'
+
+/**
+ * @public
+ */
+export interface LightSourceHelper {
+  /**
+   * @returns a Light Source type
+   */
+  Point: (point: PBLightSource_Point) => PBLightSource['type']
+
+  /**
+   * @returns a Light Source type
+   */
+  Spot: (spot: PBLightSource_Spot) => PBLightSource['type']
+}
+
+/**
+ * @public
+ */
+export interface LightSourceComponentDefinitionExtended
+  extends LastWriteWinElementSetComponentDefinition<PBLightSource> {
+  /**
+   * LightSource helper with constructor
+   */
+  Type: LightSourceHelper
+}
+
+const LightSourceHelper: LightSourceHelper = {
+  Point(point) {
+    return {
+      $case: 'point',
+      point
+    }
+  },
+  Spot(spot) {
+    return {
+      $case: 'spot',
+      spot
+    }
+  }
+}
+
+export function defineLightSourceComponent(
+  engine: Pick<IEngine, 'defineComponentFromSchema'>
+): LightSourceComponentDefinitionExtended {
+  const theComponent = LightSource(engine)
+
+  return {
+    ...theComponent,
+    Type: LightSourceHelper
+  }
+}

packages/@dcl/ecs/src/components/extended/LightSource.ts

@@ -16,6 +16,7 @@ import { AudioStreamComponentDefinitionExtended, defineAudioStreamComponent } fr
 import { MediaState } from './generated/pb/decentraland/sdk/components/common/media_state.gen'
 import { defineVirtualCameraComponent, VirtualCameraComponentDefinitionExtended } from './extended/VirtualCamera'
 import { defineInputModifierComponent, InputModifierComponentDefinitionExtended } from './extended/InputModifier'
+import { defineLightSourceComponent, LightSourceComponentDefinitionExtended } from './extended/LightSource'
 
 export * from './generated/index.gen'
 
@@ -65,6 +66,10 @@ export const VirtualCamera: LwwComponentGetter<VirtualCameraComponentDefinitionE
 export const InputModifier: LwwComponentGetter<InputModifierComponentDefinitionExtended> = (engine) =>
   defineInputModifierComponent(engine)
 
+/* @__PURE__*/
+export const LightSource: LwwComponentGetter<LightSourceComponentDefinitionExtended> = (engine) =>
+  defineLightSourceComponent(engine)
+
 /**
  * @alpha
  */

packages/@dcl/ecs/src/components/index.ts

@@ -12,3 +12,4 @@ export type { ISyncComponents, ISyncComponentsType } from './manual/SyncComponen
 export type { INetowrkEntity, INetowrkEntityType } from './manual/NetworkEntity'
 export type { INetowrkParent, INetowrkParentType } from './manual/NetworkParent'
 export type { InputModifierHelper, InputModifierComponentDefinitionExtended } from './extended/InputModifier'
+export type { LightSourceHelper, LightSourceComponentDefinitionExtended } from './extended/LightSource'

packages/@dcl/ecs/src/components/types.ts

@@ -33,7 +33,8 @@ import {
   INetowrkEntity,
   INetowrkParent,
   VirtualCameraComponentDefinitionExtended,
-  InputModifierComponentDefinitionExtended
+  InputModifierComponentDefinitionExtended,
+  LightSourceComponentDefinitionExtended
 } from './components/types'
 import { NameComponent } from './components/manual/Name'
 
@@ -49,6 +50,7 @@ export const Name: NameComponent = components.Name(engine)
 export const Tween: TweenComponentDefinitionExtended = /* @__PURE__*/ components.Tween(engine)
 export const VirtualCamera: VirtualCameraComponentDefinitionExtended = /* @__PURE__*/ components.VirtualCamera(engine)
 export const InputModifier: InputModifierComponentDefinitionExtended = /* @__PURE__*/ components.InputModifier(engine)
+export const LightSource: LightSourceComponentDefinitionExtended = /* @__PURE__*/ components.LightSource(engine)
 
 /**
  * @alpha

packages/@dcl/ecs/src/index.ts

@@ -627,6 +627,7 @@ export const componentDefinitionByName: {
     "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
     "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
     "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
+    "core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
     "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
     "core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
     "core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
@@ -1556,6 +1557,24 @@ export interface LastWriteWinElementSetComponentDefinition<T> extends BaseCompon
     getOrNull(entity: Entity): DeepReadonly<T> | null;
 }
 
+// Warning: (ae-missing-release-tag) "LightSource" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public (undocumented)
+export const LightSource: LightSourceComponentDefinitionExtended;
+
+// @public (undocumented)
+export interface LightSourceComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBLightSource> {
+    Type: LightSourceHelper;
+}
+
+// @public (undocumented)
+export interface LightSourceHelper {
+    // (undocumented)
+    Point: (point: PBLightSource_Point) => PBLightSource['type'];
+    // (undocumented)
+    Spot: (spot: PBLightSource_Spot) => PBLightSource['type'];
+}
+
 // @public
 export type Listeners = {
     onMouseDown?: Callback;
@@ -2404,6 +2423,66 @@ export namespace PBInputModifier_StandardInput {
     export function encode(message: PBInputModifier_StandardInput, writer?: _m0.Writer): _m0.Writer;
 }
 
+// @public (undocumented)
+export interface PBLightSource {
+    active?: boolean | undefined;
+    brightness?: number | undefined;
+    color?: PBColor3 | undefined;
+    range?: number | undefined;
+    // (undocumented)
+    type?: {
+        $case: "point";
+        point: PBLightSource_Point;
+    } | {
+        $case: "spot";
+        spot: PBLightSource_Spot;
+    } | undefined;
+}
+
+// @public (undocumented)
+export namespace PBLightSource {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLightSource;
+    // (undocumented)
+    export function encode(message: PBLightSource, writer?: _m0.Writer): _m0.Writer;
+}
+
+// @public (undocumented)
+export interface PBLightSource_Point {
+    shadow?: PBLightSource_ShadowType | undefined;
+}
+
+// @public (undocumented)
+export namespace PBLightSource_Point {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLightSource_Point;
+    // (undocumented)
+    export function encode(message: PBLightSource_Point, writer?: _m0.Writer): _m0.Writer;
+}
+
+// @public (undocumented)
+export const enum PBLightSource_ShadowType {
+    ST_HARD = 2,
+    ST_NONE = 0,
+    ST_SOFT = 1
+}
+
+// @public (undocumented)
+export interface PBLightSource_Spot {
+    innerAngle?: number | undefined;
+    outerAngle?: number | undefined;
+    shadow?: PBLightSource_ShadowType | undefined;
+    shadowMaskTexture?: TextureUnion | undefined;
+}
+
+// @public (undocumented)
+export namespace PBLightSource_Spot {
+    // (undocumented)
+    export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLightSource_Spot;
+    // (undocumented)
+    export function encode(message: PBLightSource_Spot, writer?: _m0.Writer): _m0.Writer;
+}
+
 // @public (undocumented)
 export interface PBMainCamera {
     virtualCameraEntity?: number | undefined;

packages/@dcl/playground-assets/etc/playground-assets.api.md

@@ -13,7 +13,7 @@
     "@dcl/inspector": "file:../inspector",
     "@dcl/linker-dapp": "^0.14.2",
     "@dcl/mini-comms": "1.0.1-20230216163137.commit-a4c75be",
-    "@dcl/protocol": "1.0.0-12891435340.commit-b3fea33",
+    "@dcl/protocol": "1.0.0-13143749736.commit-5fbeb3c",
     "@dcl/quests-client": "^1.0.3",
     "@dcl/quests-manager": "^0.1.4",
     "@dcl/rpc": "^1.1.1",