@dcl/playground-assets 7.6.5-11817605002.commit-499b43b → 7.6.5-11859795746.commit-4bc5ec9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -178,6 +178,18 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
178
178
  /** @public */
179
179
  export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
180
180
 
181
+ /**
182
+ * @public
183
+ */
184
+ export declare const enum AvatarControlType {
185
+ /** CCT_NONE - avatar cannot move */
186
+ CCT_NONE = 0,
187
+ /** CCT_RELATIVE - avatar moves relative to the camera origin */
188
+ CCT_RELATIVE = 1,
189
+ /** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
190
+ CCT_TANK = 2
191
+ }
192
+
181
193
  /** @public */
182
194
  export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
183
195
 
@@ -198,6 +210,37 @@ export declare const enum AvatarModifierType {
198
210
  AMT_DISABLE_PASSPORTS = 1
199
211
  }
200
212
 
213
+ /**
214
+ * @public
215
+ */
216
+ export declare interface AvatarMovementSettings {
217
+ controlMode?: AvatarControlType | undefined;
218
+ /** if not explicitly set, the following properties default to user's preference settings */
219
+ runSpeed?: number | undefined;
220
+ /** how fast the player gets up to speed or comes to rest. higher = more responsive */
221
+ friction?: number | undefined;
222
+ /** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
223
+ gravity?: number | undefined;
224
+ /** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
225
+ jumpHeight?: number | undefined;
226
+ /** max fall speed in m/s. should normally be negative */
227
+ maxFallSpeed?: number | undefined;
228
+ /** speed the player turns in tank mode, in radians/s */
229
+ turnSpeed?: number | undefined;
230
+ /** speed the player walks at, in m/s */
231
+ walkSpeed?: number | undefined;
232
+ /** whether to allow player to move at a slower speed (e.g. with a walk-key or when using a gamepad/joystick). defaults to true */
233
+ allowWeightedMovement?: boolean | undefined;
234
+ }
235
+
236
+ /**
237
+ * @public
238
+ */
239
+ export declare namespace AvatarMovementSettings {
240
+ export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
241
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
242
+ }
243
+
201
244
  /** @public */
202
245
  export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
203
246
 
@@ -519,6 +562,39 @@ export declare const enum CameraType {
519
562
 
520
563
  export declare type Children = ReactEcs.JSX.ReactNode;
521
564
 
565
+ /**
566
+ * @public
567
+ */
568
+ export declare interface CinematicSettings {
569
+ /** Entity that defines the cinematic camera transform. */
570
+ cameraEntity: number;
571
+ /**
572
+ * Position -> camera's position
573
+ * Rotation -> camera's direction
574
+ * scale.z -> zoom level
575
+ * scale.x and scale.y -> unused
576
+ */
577
+ allowManualRotation?: boolean | undefined;
578
+ /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
579
+ yawRange?: number | undefined;
580
+ /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
581
+ pitchRange?: number | undefined;
582
+ /** note: cameras can never look up/down further than Vec3::Y */
583
+ rollRange?: number | undefined;
584
+ /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
585
+ zoomMin?: number | undefined;
586
+ /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
587
+ zoomMax?: number | undefined;
588
+ }
589
+
590
+ /**
591
+ * @public
592
+ */
593
+ export declare namespace CinematicSettings {
594
+ export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
595
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
596
+ }
597
+
522
598
  /** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
523
599
  /**
524
600
  * @public
@@ -1295,9 +1371,13 @@ export declare const componentDefinitionByName: {
1295
1371
  "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
1296
1372
  "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
1297
1373
  "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
1374
+ "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
1298
1375
  "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
1299
1376
  "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
1377
+ "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
1378
+ "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
1300
1379
  "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
1380
+ "core::Light": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLight>>;
1301
1381
  "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
1302
1382
  "core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
1303
1383
  "core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
@@ -1310,16 +1390,19 @@ export declare const componentDefinitionByName: {
1310
1390
  "core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
1311
1391
  "core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
1312
1392
  "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
1393
+ "core::Spotlight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSpotlight>>;
1313
1394
  "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
1314
1395
  "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
1315
1396
  "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
1316
1397
  "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
1317
1398
  "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
1399
+ "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
1318
1400
  "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
1319
1401
  "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
1320
1402
  "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
1321
1403
  "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
1322
1404
  "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
1405
+ "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
1323
1406
  "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
1324
1407
  "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
1325
1408
  "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -2034,6 +2117,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
2034
2117
  direction?: PBVector3;
2035
2118
  };
2036
2119
 
2120
+ /** @public */
2121
+ export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
2122
+
2037
2123
  export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
2038
2124
 
2039
2125
  export declare type GlobalTargetRaycastSystemOptions = {
@@ -2046,6 +2132,21 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
2046
2132
  /** @public */
2047
2133
  export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
2048
2134
 
2135
+ /** @public */
2136
+ export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
2137
+
2138
+ /** @public */
2139
+ export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
2140
+
2141
+ /**
2142
+ * @public
2143
+ */
2144
+ export declare const enum GltfNodeStateValue {
2145
+ GNSV_PENDING = 0,
2146
+ GNSV_FAILED = 1,
2147
+ GNSV_READY = 2
2148
+ }
2149
+
2049
2150
  /**
2050
2151
  * @public
2051
2152
  */
@@ -2621,6 +2722,9 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
2621
2722
  getOrCreateMutable(entity: Entity, initialValue?: T): T;
2622
2723
  }
2623
2724
 
2725
+ /** @public */
2726
+ export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
2727
+
2624
2728
  /**
2625
2729
  * User key event Listeners
2626
2730
  * @public
@@ -3498,6 +3602,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
3498
3602
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
3499
3603
  */
3500
3604
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3605
+ /**
3606
+ * @public
3607
+ * Set a gltf internal mesh in the MeshCollider component
3608
+ * @param entity - entity to create or replace the MeshRenderer component
3609
+ * @param source - the path to the gltf
3610
+ * @param meshName - the name of the mesh in the gltf
3611
+ */
3612
+ setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3501
3613
  }
3502
3614
 
3503
3615
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -3534,6 +3646,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
3534
3646
  * @param entity - entity to create or replace the MeshRenderer component
3535
3647
  */
3536
3648
  setSphere(entity: Entity): void;
3649
+ /**
3650
+ * @public
3651
+ * Set a gltf internal mesh in the MeshRenderer component
3652
+ * @param entity - entity to create or replace the MeshRenderer component
3653
+ * @param source - the path to the gltf
3654
+ * @param meshName - the name of the mesh in the gltf
3655
+ */
3656
+ setGltfMesh(entity: Entity, source: string, meshName: string): void;
3537
3657
  }
3538
3658
 
3539
3659
  /* Excluded from this release type: MessageBus */
@@ -4187,6 +4307,9 @@ export declare interface PBAvatarModifierArea {
4187
4307
  excludeIds: string[];
4188
4308
  /** list of modifiers to apply */
4189
4309
  modifiers: AvatarModifierType[];
4310
+ movementSettings?: AvatarMovementSettings | undefined;
4311
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4312
+ useColliderRange?: boolean | undefined;
4190
4313
  }
4191
4314
 
4192
4315
  /**
@@ -4299,7 +4422,7 @@ export declare namespace PBCameraMode {
4299
4422
 
4300
4423
  /**
4301
4424
  * The CameraModeArea component can be attached to an Entity to define a region of space where
4302
- * the player's camera mode (1st-person or 3rd-person) is overridden.
4425
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
4303
4426
  *
4304
4427
  * The Entity's Transform position determines the center-point of the region, while its size is
4305
4428
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -4309,6 +4432,8 @@ export declare namespace PBCameraMode {
4309
4432
  *
4310
4433
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
4311
4434
  * is actually a 3D volume.
4435
+ *
4436
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
4312
4437
  */
4313
4438
  /**
4314
4439
  * @public
@@ -4318,6 +4443,9 @@ export declare interface PBCameraModeArea {
4318
4443
  area: PBVector3 | undefined;
4319
4444
  /** the camera mode to enforce */
4320
4445
  mode: CameraType;
4446
+ cinematicSettings?: CinematicSettings | undefined;
4447
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4448
+ useColliderRange?: boolean | undefined;
4321
4449
  }
4322
4450
 
4323
4451
  /**
@@ -4389,6 +4517,39 @@ export declare namespace PBEngineInfo {
4389
4517
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
4390
4518
  }
4391
4519
 
4520
+ /**
4521
+ * defines the global scene light settings. must be added to the scene root.
4522
+ * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
4523
+ */
4524
+ /**
4525
+ * @public
4526
+ */
4527
+ export declare interface PBGlobalLight {
4528
+ /**
4529
+ * the direction the directional light shines in.
4530
+ * default depends on time of day and explorer implementation
4531
+ */
4532
+ direction?: PBVector3 | undefined;
4533
+ /**
4534
+ * ambient light color
4535
+ * default: White
4536
+ */
4537
+ ambientColor?: PBColor3 | undefined;
4538
+ /**
4539
+ * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
4540
+ * default 1
4541
+ */
4542
+ ambientBrightness?: number | undefined;
4543
+ }
4544
+
4545
+ /**
4546
+ * @public
4547
+ */
4548
+ export declare namespace PBGlobalLight {
4549
+ export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
4550
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
4551
+ }
4552
+
4392
4553
  /**
4393
4554
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
4394
4555
  *
@@ -4424,6 +4585,25 @@ export declare namespace PBGltfContainer {
4424
4585
  */
4425
4586
  export declare interface PBGltfContainerLoadingState {
4426
4587
  currentState: LoadingState;
4588
+ /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
4589
+ nodePaths: string[];
4590
+ /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
4591
+ meshNames: string[];
4592
+ /**
4593
+ * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
4594
+ * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
4595
+ */
4596
+ materialNames: string[];
4597
+ /**
4598
+ * X is the material index. note this may conflict with manually named materials - to avoid any issues make
4599
+ * sure all your materials are explicitly named.
4600
+ */
4601
+ skinNames: string[];
4602
+ /**
4603
+ * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
4604
+ * your skins are explicitly named.
4605
+ */
4606
+ animationNames: string[];
4427
4607
  }
4428
4608
 
4429
4609
  /**
@@ -4434,6 +4614,77 @@ export declare namespace PBGltfContainerLoadingState {
4434
4614
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
4435
4615
  }
4436
4616
 
4617
+ /**
4618
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
4619
+ * This component must be added to a direct child of an entity with a PBGltfContainer component, or
4620
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
4621
+ * in the parent.
4622
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
4623
+ *
4624
+ * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
4625
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
4626
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
4627
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
4628
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
4629
+ *
4630
+ * After creation, if an animation moves the node, the `Transform` will be updated.
4631
+ *
4632
+ * From the scene, you can modify various components to alter the gltf node:
4633
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
4634
+ * regardless of any intermediate gltf node hierarchy.
4635
+ * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
4636
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
4637
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
4638
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
4639
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
4640
+ * used as a base, and any gltf features (e.g. occlusion maps) from the gtlf spec that the renderer supports but that are not exposed in the
4641
+ * PBMaterial will be maintained.
4642
+ *
4643
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
4644
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
4645
+ * change the state to `GNS_FAILED`.
4646
+ * - deleting the scene entity will not delete the gltf node.
4647
+ *
4648
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
4649
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
4650
+ * the gltf node will also be displayed.
4651
+ */
4652
+ /**
4653
+ * @public
4654
+ */
4655
+ export declare interface PBGltfNode {
4656
+ /** the path of the target node in the Gltf. */
4657
+ path: string;
4658
+ }
4659
+
4660
+ /**
4661
+ * @public
4662
+ */
4663
+ export declare namespace PBGltfNode {
4664
+ export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
4665
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
4666
+ }
4667
+
4668
+ /**
4669
+ * The state of a linked gltf node.
4670
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
4671
+ */
4672
+ /**
4673
+ * @public
4674
+ */
4675
+ export declare interface PBGltfNodeState {
4676
+ state: GltfNodeStateValue;
4677
+ error?: string | undefined;
4678
+ }
4679
+
4680
+ /**
4681
+ * @public
4682
+ */
4683
+ export declare namespace PBGltfNodeState {
4684
+ export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
4685
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
4686
+ }
4687
+
4437
4688
  /**
4438
4689
  * @public
4439
4690
  */
@@ -4473,6 +4724,62 @@ export declare namespace PBInputModifier_StandardInput {
4473
4724
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
4474
4725
  }
4475
4726
 
4727
+ /**
4728
+ * defines a light source.
4729
+ * the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
4730
+ * a PBGlobalLight component can also be added to the root to control the directional light direction.
4731
+ * point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
4732
+ */
4733
+ /**
4734
+ * @public
4735
+ */
4736
+ export declare interface PBLight {
4737
+ /**
4738
+ * whether the light is on
4739
+ * default true
4740
+ */
4741
+ enabled?: boolean | undefined;
4742
+ /**
4743
+ * light brightness in lux (lumens/m^2).
4744
+ *
4745
+ * for global directional light, this applies as a constant value at all surfaces and distances (though the effect on the surface still depends on incidence angle).
4746
+ * the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
4747
+ * for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
4748
+ *
4749
+ * for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
4750
+ * divide lumens by ~12 (4*pi).
4751
+ * e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
4752
+ * a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
4753
+ *
4754
+ * default
4755
+ * for point/spotlights: 10,000
4756
+ * for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
4757
+ */
4758
+ illuminance?: number | undefined;
4759
+ /**
4760
+ * whether the light should cast shadows.
4761
+ * note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
4762
+ * of lights depending on the implementation, platform, and user settings.
4763
+ * default
4764
+ * for point/spotlights: false / off
4765
+ * for global directional light: true / on
4766
+ */
4767
+ shadows?: boolean | undefined;
4768
+ /**
4769
+ * light color
4770
+ * default White
4771
+ */
4772
+ color?: PBColor3 | undefined;
4773
+ }
4774
+
4775
+ /**
4776
+ * @public
4777
+ */
4778
+ export declare namespace PBLight {
4779
+ export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
4780
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
4781
+ }
4782
+
4476
4783
  /**
4477
4784
  * PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
4478
4785
  * This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
@@ -4504,6 +4811,14 @@ export declare interface PBMaterial {
4504
4811
  $case: "pbr";
4505
4812
  pbr: PBMaterial_PbrMaterial;
4506
4813
  } | undefined;
4814
+ /**
4815
+ * A gltf material that may provide additional features not supported by the PbMaterial fields.
4816
+ * If both gltf and material fields are provided, the gltf will be used only for extended features not
4817
+ * supported by the PbMaterial.
4818
+ * If this is provided and the `material` field is not provided, the renderer will update the material
4819
+ * field with data that reflects the gltf material once it is loaded.
4820
+ */
4821
+ gltf?: PBMaterial_GltfMaterial | undefined;
4507
4822
  }
4508
4823
 
4509
4824
  /**
@@ -4514,6 +4829,22 @@ export declare namespace PBMaterial {
4514
4829
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
4515
4830
  }
4516
4831
 
4832
+ /**
4833
+ * @public
4834
+ */
4835
+ export declare interface PBMaterial_GltfMaterial {
4836
+ gltfSrc: string;
4837
+ name: string;
4838
+ }
4839
+
4840
+ /**
4841
+ * @public
4842
+ */
4843
+ export declare namespace PBMaterial_GltfMaterial {
4844
+ export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
4845
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
4846
+ }
4847
+
4517
4848
  /**
4518
4849
  * @public
4519
4850
  */
@@ -4610,6 +4941,9 @@ export declare interface PBMeshCollider {
4610
4941
  } | {
4611
4942
  $case: "plane";
4612
4943
  plane: PBMeshCollider_PlaneMesh;
4944
+ } | {
4945
+ $case: "gltf";
4946
+ gltf: PBMeshCollider_GltfMesh;
4613
4947
  } | undefined;
4614
4948
  }
4615
4949
 
@@ -4655,6 +4989,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
4655
4989
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
4656
4990
  }
4657
4991
 
4992
+ /** A collider constructed from a Gltf Mesh. */
4993
+ /**
4994
+ * @public
4995
+ */
4996
+ export declare interface PBMeshCollider_GltfMesh {
4997
+ /** the GLTF file path as listed in the scene's manifest. */
4998
+ gltfSrc: string;
4999
+ /** the name of the mesh asset */
5000
+ name: string;
5001
+ }
5002
+
5003
+ /**
5004
+ * @public
5005
+ */
5006
+ export declare namespace PBMeshCollider_GltfMesh {
5007
+ export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5008
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
5009
+ }
5010
+
4658
5011
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
4659
5012
  /**
4660
5013
  * @public
@@ -4687,13 +5040,11 @@ export declare namespace PBMeshCollider_SphereMesh {
4687
5040
 
4688
5041
  /**
4689
5042
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
4690
- * plane, a sphere or a cylinder.
5043
+ * plane, a sphere, a cylinder, or a Gltf mesh.
4691
5044
  *
4692
5045
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
4693
5046
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
4694
5047
  * `float` coordinates, one for each corner of each side of each face.
4695
- *
4696
- * More complex shapes require the use of a `GltfContainer` component.
4697
5048
  */
4698
5049
  /**
4699
5050
  * @public
@@ -4711,6 +5062,9 @@ export declare interface PBMeshRenderer {
4711
5062
  } | {
4712
5063
  $case: "plane";
4713
5064
  plane: PBMeshRenderer_PlaneMesh;
5065
+ } | {
5066
+ $case: "gltf";
5067
+ gltf: PBMeshRenderer_GltfMesh;
4714
5068
  } | undefined;
4715
5069
  }
4716
5070
 
@@ -4758,6 +5112,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
4758
5112
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
4759
5113
  }
4760
5114
 
5115
+ /** A mesh from a Gltf. */
5116
+ /**
5117
+ * @public
5118
+ */
5119
+ export declare interface PBMeshRenderer_GltfMesh {
5120
+ /** the GLTF file path as listed in the scene's manifest. */
5121
+ gltfSrc: string;
5122
+ /** the name of the mesh asset */
5123
+ name: string;
5124
+ }
5125
+
5126
+ /**
5127
+ * @public
5128
+ */
5129
+ export declare namespace PBMeshRenderer_GltfMesh {
5130
+ export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5131
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
5132
+ }
5133
+
4761
5134
  /** PlaneMesh renders a 2D rectangular shape. */
4762
5135
  /**
4763
5136
  * @public
@@ -5097,6 +5470,39 @@ export declare namespace PBRealmInfo {
5097
5470
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
5098
5471
  }
5099
5472
 
5473
+ /**
5474
+ * defines a spotlight.
5475
+ * spotlights are point lights that emit light only in a cone around the transform's forward direction.
5476
+ * add this component together with the PBLight component to transform a point light into a spotlight.
5477
+ * note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
5478
+ * so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
5479
+ * a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
5480
+ * and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
5481
+ */
5482
+ /**
5483
+ * @public
5484
+ */
5485
+ export declare interface PBSpotlight {
5486
+ /**
5487
+ * the cone radius in radians. distance away from forward in which the light is visible.
5488
+ * for a torch a value around 0.15 is appropriate.
5489
+ */
5490
+ angle: number;
5491
+ /**
5492
+ * optional angle at which the light is brightest. should be <= outer angle.
5493
+ * if specified, the light will fall off smoothly between `inner_angle` and `angle`.
5494
+ */
5495
+ innerAngle?: number | undefined;
5496
+ }
5497
+
5498
+ /**
5499
+ * @public
5500
+ */
5501
+ export declare namespace PBSpotlight {
5502
+ export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
5503
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
5504
+ }
5505
+
5100
5506
  /**
5101
5507
  * The TextShape component renders customizable floating text.
5102
5508
  *
@@ -5247,6 +5653,25 @@ export declare namespace PBUiBackground {
5247
5653
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
5248
5654
  }
5249
5655
 
5656
+ /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
5657
+ /**
5658
+ * @public
5659
+ */
5660
+ export declare interface PBUiCanvas {
5661
+ width: number;
5662
+ height: number;
5663
+ /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
5664
+ color?: PBColor4 | undefined;
5665
+ }
5666
+
5667
+ /**
5668
+ * @public
5669
+ */
5670
+ export declare namespace PBUiCanvas {
5671
+ export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
5672
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
5673
+ }
5674
+
5250
5675
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
5251
5676
  /**
5252
5677
  * @public
@@ -5363,6 +5788,21 @@ export declare namespace PBUiInputResult {
5363
5788
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
5364
5789
  }
5365
5790
 
5791
+ /**
5792
+ * @public
5793
+ */
5794
+ export declare interface PBUiScrollResult {
5795
+ value: PBVector2 | undefined;
5796
+ }
5797
+
5798
+ /**
5799
+ * @public
5800
+ */
5801
+ export declare namespace PBUiScrollResult {
5802
+ export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
5803
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
5804
+ }
5805
+
5366
5806
  /**
5367
5807
  * @public
5368
5808
  */
@@ -5379,6 +5819,10 @@ export declare interface PBUiText {
5379
5819
  fontSize?: number | undefined;
5380
5820
  /** wrap text when the border is reached (default: TW_WRAP) */
5381
5821
  textWrap?: TextWrap | undefined;
5822
+ /** width of the outline (default: 0) */
5823
+ outlineWidth?: number | undefined;
5824
+ /** RGBA color of the outline (default: opaque black) */
5825
+ outlineColor?: PBColor4 | undefined;
5382
5826
  }
5383
5827
 
5384
5828
  /**
@@ -5475,6 +5919,14 @@ export declare interface PBUiTransform {
5475
5919
  paddingBottom: number;
5476
5920
  /** default: PointerFilterMode.PFM_NONE */
5477
5921
  pointerFilter?: PointerFilterMode | undefined;
5922
+ /** default: 1 */
5923
+ opacity?: number | undefined;
5924
+ /** default empty */
5925
+ elementId?: string | undefined;
5926
+ /** default position=(0,0) */
5927
+ scrollPosition?: ScrollPositionValue | undefined;
5928
+ /** default ShowScrollBar.SSB_BOTH */
5929
+ scrollVisible?: ShowScrollBar | undefined;
5478
5930
  }
5479
5931
 
5480
5932
  /**
@@ -6408,6 +6860,7 @@ export declare type RaycastSystemOptions = {
6408
6860
  export declare interface ReactBasedUiSystem {
6409
6861
  destroy(): void;
6410
6862
  setUiRenderer(ui: UiComponent): void;
6863
+ setTextureRenderer(entity: Entity, ui: UiComponent): void;
6411
6864
  }
6412
6865
 
6413
6866
  /**
@@ -6861,6 +7314,43 @@ export declare namespace Schemas {
6861
7314
  }) => void;
6862
7315
  }
6863
7316
 
7317
+ /**
7318
+ * @public
7319
+ */
7320
+ export declare interface ScrollPositionValue {
7321
+ value?: {
7322
+ $case: "position";
7323
+ position: PBVector2;
7324
+ } | {
7325
+ $case: "reference";
7326
+ reference: string;
7327
+ } | undefined;
7328
+ }
7329
+
7330
+ /**
7331
+ * @public
7332
+ */
7333
+ export declare namespace ScrollPositionValue {
7334
+ export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
7335
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
7336
+ }
7337
+
7338
+ /**
7339
+ * @public
7340
+ * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
7341
+ */
7342
+ export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
7343
+
7344
+ /**
7345
+ * @public
7346
+ */
7347
+ export declare const enum ShowScrollBar {
7348
+ SSB_BOTH = 0,
7349
+ SSB_ONLY_VERTICAL = 1,
7350
+ SSB_ONLY_HORIZONTAL = 2,
7351
+ SSB_HIDDEN = 3
7352
+ }
7353
+
6864
7354
  /**
6865
7355
  * @public
6866
7356
  */
@@ -6868,6 +7358,9 @@ export declare interface Spec {
6868
7358
  [key: string]: ISchema;
6869
7359
  }
6870
7360
 
7361
+ /** @public */
7362
+ export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
7363
+
6871
7364
  /* Excluded from this release type: SyncComponents */
6872
7365
 
6873
7366
  /**
@@ -6923,6 +7416,13 @@ export declare interface Texture {
6923
7416
  wrapMode?: TextureWrapMode | undefined;
6924
7417
  /** default = FilterMode.Bilinear */
6925
7418
  filterMode?: TextureFilterMode | undefined;
7419
+ /**
7420
+ * Final uv = offset + (input_uv * tiling)
7421
+ * Offset for texture positioning.
7422
+ */
7423
+ offset?: PBVector2 | undefined;
7424
+ /** Tiling multiplier for texture repetition. */
7425
+ tiling?: PBVector2 | undefined;
6926
7426
  }
6927
7427
 
6928
7428
  /**
@@ -6994,6 +7494,9 @@ export declare interface TextureUnion {
6994
7494
  } | {
6995
7495
  $case: "videoTexture";
6996
7496
  videoTexture: VideoTexture;
7497
+ } | {
7498
+ $case: "uiTexture";
7499
+ uiTexture: UiCanvasTexture;
6997
7500
  } | undefined;
6998
7501
  }
6999
7502
 
@@ -7212,9 +7715,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
7212
7715
  disabled?: boolean;
7213
7716
  }
7214
7717
 
7718
+ /** @public */
7719
+ export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
7720
+
7215
7721
  /** @public */
7216
7722
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
7217
7723
 
7724
+ /**
7725
+ * @public
7726
+ */
7727
+ export declare interface UiCanvasTexture {
7728
+ uiCanvasEntity: number;
7729
+ /** default = TextureWrapMode.Clamp */
7730
+ wrapMode?: TextureWrapMode | undefined;
7731
+ /** default = FilterMode.Bilinear */
7732
+ filterMode?: TextureFilterMode | undefined;
7733
+ }
7734
+
7735
+ /**
7736
+ * @public
7737
+ */
7738
+ export declare namespace UiCanvasTexture {
7739
+ export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
7740
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
7741
+ }
7742
+
7218
7743
  /**
7219
7744
  * @public
7220
7745
  */
@@ -7284,6 +7809,10 @@ export declare interface UiLabelProps {
7284
7809
  textAlign?: TextAlignType | undefined;
7285
7810
  /** Label font type. @defaultValue 'sans-serif' */
7286
7811
  font?: UiFontType | undefined;
7812
+ /** Outline width of the text. @defaultValue 0 */
7813
+ outlineWidth?: number | undefined;
7814
+ /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
7815
+ outlineColor?: PBColor4 | undefined;
7287
7816
  /** Behaviour when text reached. @defaultValue 'wrap' */
7288
7817
  textWrap?: UiTextWrapType | undefined;
7289
7818
  }
@@ -7293,6 +7822,9 @@ export declare interface UiLabelProps {
7293
7822
  */
7294
7823
  export declare type uint32 = number;
7295
7824
 
7825
+ /** @public */
7826
+ export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
7827
+
7296
7828
  /** @public */
7297
7829
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
7298
7830
 
@@ -7365,6 +7897,14 @@ export declare interface UiTransformProps {
7365
7897
  overflow?: OverflowType;
7366
7898
  /** The pointer filter property determines if the ui element blocks the pointer or not (elements with pointer events always block the pointer regardless of this property) **/
7367
7899
  pointerFilter?: PointerFilterType;
7900
+ /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
7901
+ opacity?: number;
7902
+ /** A reference value to identify the element, default empty */
7903
+ elementId?: string;
7904
+ /** default position=(0,0) if it aplies, a vector or a reference-id */
7905
+ scrollPosition?: PBVector2 | string;
7906
+ /** default ShowScrollBar.SSB_BOTH */
7907
+ scrollVisible?: ScrollVisibleType;
7368
7908
  }
7369
7909
 
7370
7910
  /**