@dcl/playground-assets 7.8.11 → 7.8.13-15759056248.commit-2d07483

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.
package/dist/beta.d.ts CHANGED
@@ -178,11 +178,31 @@ 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
 
184
- /** @public */
185
- export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
196
+ export declare const AvatarEquippedData: AvatarEquippedDataComponentDefinitionExtended;
197
+
198
+ /**
199
+ * @public
200
+ */
201
+ export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
202
+
203
+ export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
204
+ forceRender?: string[] | undefined;
205
+ };
186
206
 
187
207
  /** @public */
188
208
  export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
@@ -198,8 +218,47 @@ export declare const enum AvatarModifierType {
198
218
  AMT_DISABLE_PASSPORTS = 1
199
219
  }
200
220
 
201
- /** @public */
202
- export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
221
+ /**
222
+ * @public
223
+ */
224
+ export declare interface AvatarMovementSettings {
225
+ controlMode?: AvatarControlType | undefined;
226
+ /** if not explicitly set, the following properties default to user's preference settings */
227
+ runSpeed?: number | undefined;
228
+ /** how fast the player gets up to speed or comes to rest. higher = more responsive */
229
+ friction?: number | undefined;
230
+ /** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
231
+ gravity?: number | undefined;
232
+ /** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
233
+ jumpHeight?: number | undefined;
234
+ /** max fall speed in m/s. should normally be negative */
235
+ maxFallSpeed?: number | undefined;
236
+ /** speed the player turns in tank mode, in radians/s */
237
+ turnSpeed?: number | undefined;
238
+ /** speed the player walks at, in m/s */
239
+ walkSpeed?: number | undefined;
240
+ /** 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 */
241
+ allowWeightedMovement?: boolean | undefined;
242
+ }
243
+
244
+ /**
245
+ * @public
246
+ */
247
+ export declare namespace AvatarMovementSettings {
248
+ export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
249
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
250
+ }
251
+
252
+ export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
253
+
254
+ /**
255
+ * @public
256
+ */
257
+ export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
258
+
259
+ export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
260
+ forceRender?: string[] | undefined;
261
+ };
203
262
 
204
263
  /**
205
264
  * @public
@@ -473,6 +532,12 @@ export declare interface ByteBuffer {
473
532
  */
474
533
  export declare type Callback = () => void;
475
534
 
535
+ /** @public */
536
+ export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
537
+
538
+ /** @public */
539
+ export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
540
+
476
541
  /** @public */
477
542
  export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
478
543
 
@@ -530,6 +595,39 @@ export declare const enum CameraType {
530
595
 
531
596
  export declare type Children = ReactEcs.JSX.ReactNode;
532
597
 
598
+ /**
599
+ * @public
600
+ */
601
+ export declare interface CinematicSettings {
602
+ /** Entity that defines the cinematic camera transform. */
603
+ cameraEntity: number;
604
+ /**
605
+ * Position -> camera's position
606
+ * Rotation -> camera's direction
607
+ * scale.z -> zoom level
608
+ * scale.x and scale.y -> unused
609
+ */
610
+ allowManualRotation?: boolean | undefined;
611
+ /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
612
+ yawRange?: number | undefined;
613
+ /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
614
+ pitchRange?: number | undefined;
615
+ /** note: cameras can never look up/down further than Vec3::Y */
616
+ rollRange?: number | undefined;
617
+ /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
618
+ zoomMin?: number | undefined;
619
+ /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
620
+ zoomMax?: number | undefined;
621
+ }
622
+
623
+ /**
624
+ * @public
625
+ */
626
+ export declare namespace CinematicSettings {
627
+ export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
628
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
629
+ }
630
+
533
631
  /** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
534
632
  /**
535
633
  * @public
@@ -1303,12 +1401,18 @@ export declare const componentDefinitionByName: {
1303
1401
  "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
1304
1402
  "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
1305
1403
  "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
1404
+ "core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
1405
+ "core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
1306
1406
  "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
1307
1407
  "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
1308
1408
  "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
1409
+ "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
1309
1410
  "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
1310
1411
  "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
1412
+ "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
1413
+ "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
1311
1414
  "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
1415
+ "core::Light": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLight>>;
1312
1416
  "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
1313
1417
  "core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
1314
1418
  "core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
@@ -1322,16 +1426,20 @@ export declare const componentDefinitionByName: {
1322
1426
  "core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
1323
1427
  "core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
1324
1428
  "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
1429
+ "core::Spotlight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSpotlight>>;
1325
1430
  "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
1431
+ "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
1326
1432
  "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
1327
1433
  "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
1328
1434
  "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
1329
1435
  "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
1436
+ "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
1330
1437
  "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
1331
1438
  "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
1332
1439
  "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
1333
1440
  "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
1334
1441
  "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
1442
+ "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
1335
1443
  "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
1336
1444
  "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
1337
1445
  "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -1902,6 +2010,9 @@ export declare type EntityComponents = {
1902
2010
  onMouseUp: Callback;
1903
2011
  onMouseEnter: Callback;
1904
2012
  onMouseLeave: Callback;
2013
+ onMouseDrag: Callback;
2014
+ onMouseDragLocked: Callback;
2015
+ onMouseDragEnd: Callback;
1905
2016
  };
1906
2017
 
1907
2018
  /** @public */
@@ -2053,6 +2164,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
2053
2164
  direction?: PBVector3;
2054
2165
  };
2055
2166
 
2167
+ /** @public */
2168
+ export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
2169
+
2056
2170
  export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
2057
2171
 
2058
2172
  export declare type GlobalTargetRaycastSystemOptions = {
@@ -2065,6 +2179,21 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
2065
2179
  /** @public */
2066
2180
  export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
2067
2181
 
2182
+ /** @public */
2183
+ export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
2184
+
2185
+ /** @public */
2186
+ export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
2187
+
2188
+ /**
2189
+ * @public
2190
+ */
2191
+ export declare const enum GltfNodeStateValue {
2192
+ GNSV_PENDING = 0,
2193
+ GNSV_FAILED = 1,
2194
+ GNSV_READY = 2
2195
+ }
2196
+
2068
2197
  /**
2069
2198
  * @public
2070
2199
  */
@@ -2666,6 +2795,9 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
2666
2795
  getOrCreateMutable(entity: Entity, initialValue?: T): T;
2667
2796
  }
2668
2797
 
2798
+ /** @public */
2799
+ export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
2800
+
2669
2801
  /**
2670
2802
  * User key event Listeners
2671
2803
  * @public
@@ -2679,6 +2811,12 @@ export declare type Listeners = {
2679
2811
  onMouseEnter?: Callback;
2680
2812
  /** triggered on mouse leave event */
2681
2813
  onMouseLeave?: Callback;
2814
+ /** triggered on mouse drag event */
2815
+ onMouseDrag?: Callback;
2816
+ /** triggered on mouse drag event */
2817
+ onMouseDragLocked?: Callback;
2818
+ /** triggered on mouse drag event */
2819
+ onMouseDragEnd?: Callback;
2682
2820
  };
2683
2821
 
2684
2822
  /**
@@ -3547,6 +3685,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
3547
3685
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
3548
3686
  */
3549
3687
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3688
+ /**
3689
+ * @public
3690
+ * Set a gltf internal mesh in the MeshCollider component
3691
+ * @param entity - entity to create or replace the MeshRenderer component
3692
+ * @param source - the path to the gltf
3693
+ * @param meshName - the name of the mesh in the gltf
3694
+ */
3695
+ setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3550
3696
  }
3551
3697
 
3552
3698
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -3583,6 +3729,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
3583
3729
  * @param entity - entity to create or replace the MeshRenderer component
3584
3730
  */
3585
3731
  setSphere(entity: Entity): void;
3732
+ /**
3733
+ * @public
3734
+ * Set a gltf internal mesh in the MeshRenderer component
3735
+ * @param entity - entity to create or replace the MeshRenderer component
3736
+ * @param source - the path to the gltf
3737
+ * @param meshName - the name of the mesh in the gltf
3738
+ */
3739
+ setGltfMesh(entity: Entity, source: string, meshName: string): void;
3586
3740
  }
3587
3741
 
3588
3742
  /* Excluded from this release type: MessageBus */
@@ -3976,6 +4130,25 @@ export declare const onVideoEvent: Observable<{
3976
4130
  totalVideoLength: number;
3977
4131
  }>;
3978
4132
 
4133
+ /**
4134
+ * @public
4135
+ */
4136
+ export declare interface Orthographic {
4137
+ /**
4138
+ * vertical extent of the visible range in meters
4139
+ * defaults to 4m
4140
+ */
4141
+ verticalRange?: number | undefined;
4142
+ }
4143
+
4144
+ /**
4145
+ * @public
4146
+ */
4147
+ export declare namespace Orthographic {
4148
+ export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
4149
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
4150
+ }
4151
+
3979
4152
  /**
3980
4153
  * @public
3981
4154
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -4202,6 +4375,8 @@ export declare namespace PBAvatarEmoteCommand {
4202
4375
  export declare interface PBAvatarEquippedData {
4203
4376
  wearableUrns: string[];
4204
4377
  emoteUrns: string[];
4378
+ /** slots that will render even if hidden */
4379
+ forceRender: string[];
4205
4380
  }
4206
4381
 
4207
4382
  /**
@@ -4236,6 +4411,9 @@ export declare interface PBAvatarModifierArea {
4236
4411
  excludeIds: string[];
4237
4412
  /** list of modifiers to apply */
4238
4413
  modifiers: AvatarModifierType[];
4414
+ movementSettings?: AvatarMovementSettings | undefined;
4415
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4416
+ useColliderRange?: boolean | undefined;
4239
4417
  }
4240
4418
 
4241
4419
  /**
@@ -4292,6 +4470,8 @@ export declare interface PBAvatarShape {
4292
4470
  wearables: string[];
4293
4471
  /** available emotes (default empty) */
4294
4472
  emotes: string[];
4473
+ /** slots that will render even if hidden */
4474
+ forceRender: string[];
4295
4475
  }
4296
4476
 
4297
4477
  /**
@@ -4326,6 +4506,51 @@ export declare namespace PBBillboard {
4326
4506
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
4327
4507
  }
4328
4508
 
4509
+ /**
4510
+ * @public
4511
+ */
4512
+ export declare interface PBCameraLayer {
4513
+ /**
4514
+ * layer to which these settings apply. must be > 0
4515
+ * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
4516
+ */
4517
+ layer: number;
4518
+ /** should the sun light affect this layer? default false */
4519
+ directionalLight?: boolean | undefined;
4520
+ /** should this layer show player avatars? default false */
4521
+ showAvatars?: boolean | undefined;
4522
+ /** should this layer show the sky? default false */
4523
+ showSkybox?: boolean | undefined;
4524
+ /** should this layer show distance fog? default false */
4525
+ showFog?: boolean | undefined;
4526
+ /** ambient light overrides for this layer. default -> use same as main camera */
4527
+ ambientColorOverride?: PBColor3 | undefined;
4528
+ ambientBrightnessOverride?: number | undefined;
4529
+ }
4530
+
4531
+ /**
4532
+ * @public
4533
+ */
4534
+ export declare namespace PBCameraLayer {
4535
+ export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
4536
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
4537
+ }
4538
+
4539
+ /**
4540
+ * @public
4541
+ */
4542
+ export declare interface PBCameraLayers {
4543
+ layers: number[];
4544
+ }
4545
+
4546
+ /**
4547
+ * @public
4548
+ */
4549
+ export declare namespace PBCameraLayers {
4550
+ export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
4551
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
4552
+ }
4553
+
4329
4554
  /**
4330
4555
  * The CameraMode component can be used to determine whether the player is using a first-person o
4331
4556
  * third-person view.
@@ -4348,7 +4573,7 @@ export declare namespace PBCameraMode {
4348
4573
 
4349
4574
  /**
4350
4575
  * The CameraModeArea component can be attached to an Entity to define a region of space where
4351
- * the player's camera mode (1st-person or 3rd-person) is overridden.
4576
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
4352
4577
  *
4353
4578
  * The Entity's Transform position determines the center-point of the region, while its size is
4354
4579
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -4358,6 +4583,8 @@ export declare namespace PBCameraMode {
4358
4583
  *
4359
4584
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
4360
4585
  * is actually a 3D volume.
4586
+ *
4587
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
4361
4588
  */
4362
4589
  /**
4363
4590
  * @public
@@ -4367,6 +4594,9 @@ export declare interface PBCameraModeArea {
4367
4594
  area: PBVector3 | undefined;
4368
4595
  /** the camera mode to enforce */
4369
4596
  mode: CameraType;
4597
+ cinematicSettings?: CinematicSettings | undefined;
4598
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4599
+ useColliderRange?: boolean | undefined;
4370
4600
  }
4371
4601
 
4372
4602
  /**
@@ -4438,6 +4668,39 @@ export declare namespace PBEngineInfo {
4438
4668
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
4439
4669
  }
4440
4670
 
4671
+ /**
4672
+ * defines the global scene light settings. must be added to the scene root.
4673
+ * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
4674
+ */
4675
+ /**
4676
+ * @public
4677
+ */
4678
+ export declare interface PBGlobalLight {
4679
+ /**
4680
+ * the direction the directional light shines in.
4681
+ * default depends on time of day and explorer implementation
4682
+ */
4683
+ direction?: PBVector3 | undefined;
4684
+ /**
4685
+ * ambient light color
4686
+ * default: White
4687
+ */
4688
+ ambientColor?: PBColor3 | undefined;
4689
+ /**
4690
+ * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
4691
+ * default 1
4692
+ */
4693
+ ambientBrightness?: number | undefined;
4694
+ }
4695
+
4696
+ /**
4697
+ * @public
4698
+ */
4699
+ export declare namespace PBGlobalLight {
4700
+ export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
4701
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
4702
+ }
4703
+
4441
4704
  /**
4442
4705
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
4443
4706
  *
@@ -4473,6 +4736,25 @@ export declare namespace PBGltfContainer {
4473
4736
  */
4474
4737
  export declare interface PBGltfContainerLoadingState {
4475
4738
  currentState: LoadingState;
4739
+ /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
4740
+ nodePaths: string[];
4741
+ /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
4742
+ meshNames: string[];
4743
+ /**
4744
+ * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
4745
+ * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
4746
+ */
4747
+ materialNames: string[];
4748
+ /**
4749
+ * X is the material index. note this may conflict with manually named materials - to avoid any issues make
4750
+ * sure all your materials are explicitly named.
4751
+ */
4752
+ skinNames: string[];
4753
+ /**
4754
+ * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
4755
+ * your skins are explicitly named.
4756
+ */
4757
+ animationNames: string[];
4476
4758
  }
4477
4759
 
4478
4760
  /**
@@ -4483,6 +4765,77 @@ export declare namespace PBGltfContainerLoadingState {
4483
4765
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
4484
4766
  }
4485
4767
 
4768
+ /**
4769
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
4770
+ * This component must be added to a direct child of an entity with a PBGltfContainer component, or
4771
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
4772
+ * in the parent.
4773
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
4774
+ *
4775
+ * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
4776
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
4777
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
4778
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
4779
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
4780
+ *
4781
+ * After creation, if an animation moves the node, the `Transform` will be updated.
4782
+ *
4783
+ * From the scene, you can modify various components to alter the gltf node:
4784
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
4785
+ * regardless of any intermediate gltf node hierarchy.
4786
+ * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
4787
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
4788
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
4789
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
4790
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
4791
+ * 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
4792
+ * PBMaterial will be maintained.
4793
+ *
4794
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
4795
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
4796
+ * change the state to `GNS_FAILED`.
4797
+ * - deleting the scene entity will not delete the gltf node.
4798
+ *
4799
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
4800
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
4801
+ * the gltf node will also be displayed.
4802
+ */
4803
+ /**
4804
+ * @public
4805
+ */
4806
+ export declare interface PBGltfNode {
4807
+ /** the path of the target node in the Gltf. */
4808
+ path: string;
4809
+ }
4810
+
4811
+ /**
4812
+ * @public
4813
+ */
4814
+ export declare namespace PBGltfNode {
4815
+ export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
4816
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
4817
+ }
4818
+
4819
+ /**
4820
+ * The state of a linked gltf node.
4821
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
4822
+ */
4823
+ /**
4824
+ * @public
4825
+ */
4826
+ export declare interface PBGltfNodeState {
4827
+ state: GltfNodeStateValue;
4828
+ error?: string | undefined;
4829
+ }
4830
+
4831
+ /**
4832
+ * @public
4833
+ */
4834
+ export declare namespace PBGltfNodeState {
4835
+ export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
4836
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
4837
+ }
4838
+
4486
4839
  /**
4487
4840
  * @public
4488
4841
  */
@@ -4522,6 +4875,62 @@ export declare namespace PBInputModifier_StandardInput {
4522
4875
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
4523
4876
  }
4524
4877
 
4878
+ /**
4879
+ * defines a light source.
4880
+ * the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
4881
+ * a PBGlobalLight component can also be added to the root to control the directional light direction.
4882
+ * point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
4883
+ */
4884
+ /**
4885
+ * @public
4886
+ */
4887
+ export declare interface PBLight {
4888
+ /**
4889
+ * whether the light is on
4890
+ * default true
4891
+ */
4892
+ enabled?: boolean | undefined;
4893
+ /**
4894
+ * light brightness in lux (lumens/m^2).
4895
+ *
4896
+ * 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).
4897
+ * the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
4898
+ * for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
4899
+ *
4900
+ * for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
4901
+ * divide lumens by ~12 (4*pi).
4902
+ * e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
4903
+ * a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
4904
+ *
4905
+ * default
4906
+ * for point/spotlights: 10,000
4907
+ * for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
4908
+ */
4909
+ illuminance?: number | undefined;
4910
+ /**
4911
+ * whether the light should cast shadows.
4912
+ * note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
4913
+ * of lights depending on the implementation, platform, and user settings.
4914
+ * default
4915
+ * for point/spotlights: false / off
4916
+ * for global directional light: true / on
4917
+ */
4918
+ shadows?: boolean | undefined;
4919
+ /**
4920
+ * light color
4921
+ * default White
4922
+ */
4923
+ color?: PBColor3 | undefined;
4924
+ }
4925
+
4926
+ /**
4927
+ * @public
4928
+ */
4929
+ export declare namespace PBLight {
4930
+ export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
4931
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
4932
+ }
4933
+
4525
4934
  /**
4526
4935
  * PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
4527
4936
  * This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
@@ -4553,6 +4962,14 @@ export declare interface PBMaterial {
4553
4962
  $case: "pbr";
4554
4963
  pbr: PBMaterial_PbrMaterial;
4555
4964
  } | undefined;
4965
+ /**
4966
+ * A gltf material that may provide additional features not supported by the PbMaterial fields.
4967
+ * If both gltf and material fields are provided, the gltf will be used only for extended features not
4968
+ * supported by the PbMaterial.
4969
+ * If this is provided and the `material` field is not provided, the renderer will update the material
4970
+ * field with data that reflects the gltf material once it is loaded.
4971
+ */
4972
+ gltf?: PBMaterial_GltfMaterial | undefined;
4556
4973
  }
4557
4974
 
4558
4975
  /**
@@ -4563,6 +4980,22 @@ export declare namespace PBMaterial {
4563
4980
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
4564
4981
  }
4565
4982
 
4983
+ /**
4984
+ * @public
4985
+ */
4986
+ export declare interface PBMaterial_GltfMaterial {
4987
+ gltfSrc: string;
4988
+ name: string;
4989
+ }
4990
+
4991
+ /**
4992
+ * @public
4993
+ */
4994
+ export declare namespace PBMaterial_GltfMaterial {
4995
+ export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
4996
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
4997
+ }
4998
+
4566
4999
  /**
4567
5000
  * @public
4568
5001
  */
@@ -4659,6 +5092,9 @@ export declare interface PBMeshCollider {
4659
5092
  } | {
4660
5093
  $case: "plane";
4661
5094
  plane: PBMeshCollider_PlaneMesh;
5095
+ } | {
5096
+ $case: "gltf";
5097
+ gltf: PBMeshCollider_GltfMesh;
4662
5098
  } | undefined;
4663
5099
  }
4664
5100
 
@@ -4704,6 +5140,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
4704
5140
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
4705
5141
  }
4706
5142
 
5143
+ /** A collider constructed from a Gltf Mesh. */
5144
+ /**
5145
+ * @public
5146
+ */
5147
+ export declare interface PBMeshCollider_GltfMesh {
5148
+ /** the GLTF file path as listed in the scene's manifest. */
5149
+ gltfSrc: string;
5150
+ /** the name of the mesh asset */
5151
+ name: string;
5152
+ }
5153
+
5154
+ /**
5155
+ * @public
5156
+ */
5157
+ export declare namespace PBMeshCollider_GltfMesh {
5158
+ export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5159
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
5160
+ }
5161
+
4707
5162
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
4708
5163
  /**
4709
5164
  * @public
@@ -4736,13 +5191,11 @@ export declare namespace PBMeshCollider_SphereMesh {
4736
5191
 
4737
5192
  /**
4738
5193
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
4739
- * plane, a sphere or a cylinder.
5194
+ * plane, a sphere, a cylinder, or a Gltf mesh.
4740
5195
  *
4741
5196
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
4742
5197
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
4743
5198
  * `float` coordinates, one for each corner of each side of each face.
4744
- *
4745
- * More complex shapes require the use of a `GltfContainer` component.
4746
5199
  */
4747
5200
  /**
4748
5201
  * @public
@@ -4760,6 +5213,9 @@ export declare interface PBMeshRenderer {
4760
5213
  } | {
4761
5214
  $case: "plane";
4762
5215
  plane: PBMeshRenderer_PlaneMesh;
5216
+ } | {
5217
+ $case: "gltf";
5218
+ gltf: PBMeshRenderer_GltfMesh;
4763
5219
  } | undefined;
4764
5220
  }
4765
5221
 
@@ -4807,6 +5263,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
4807
5263
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
4808
5264
  }
4809
5265
 
5266
+ /** A mesh from a Gltf. */
5267
+ /**
5268
+ * @public
5269
+ */
5270
+ export declare interface PBMeshRenderer_GltfMesh {
5271
+ /** the GLTF file path as listed in the scene's manifest. */
5272
+ gltfSrc: string;
5273
+ /** the name of the mesh asset */
5274
+ name: string;
5275
+ }
5276
+
5277
+ /**
5278
+ * @public
5279
+ */
5280
+ export declare namespace PBMeshRenderer_GltfMesh {
5281
+ export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5282
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
5283
+ }
5284
+
4810
5285
  /** PlaneMesh renders a 2D rectangular shape. */
4811
5286
  /**
4812
5287
  * @public
@@ -5055,7 +5530,10 @@ export declare interface PBPrimaryPointerInfo {
5055
5530
  screenCoordinates?: PBVector2 | undefined;
5056
5531
  /** Movement since last frame (pixels) */
5057
5532
  screenDelta?: PBVector2 | undefined;
5058
- /** Direction vector for 3D ray casting */
5533
+ /**
5534
+ * ray direction that can be used with the primary camera origin for
5535
+ * raycasting from the cursor into the world
5536
+ */
5059
5537
  worldRayDirection?: PBVector3 | undefined;
5060
5538
  }
5061
5539
 
@@ -5195,6 +5673,39 @@ export declare namespace PBRealmInfo {
5195
5673
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
5196
5674
  }
5197
5675
 
5676
+ /**
5677
+ * defines a spotlight.
5678
+ * spotlights are point lights that emit light only in a cone around the transform's forward direction.
5679
+ * add this component together with the PBLight component to transform a point light into a spotlight.
5680
+ * note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
5681
+ * so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
5682
+ * a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
5683
+ * and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
5684
+ */
5685
+ /**
5686
+ * @public
5687
+ */
5688
+ export declare interface PBSpotlight {
5689
+ /**
5690
+ * the cone radius in radians. distance away from forward in which the light is visible.
5691
+ * for a torch a value around 0.15 is appropriate.
5692
+ */
5693
+ angle: number;
5694
+ /**
5695
+ * optional angle at which the light is brightest. should be <= outer angle.
5696
+ * if specified, the light will fall off smoothly between `inner_angle` and `angle`.
5697
+ */
5698
+ innerAngle?: number | undefined;
5699
+ }
5700
+
5701
+ /**
5702
+ * @public
5703
+ */
5704
+ export declare namespace PBSpotlight {
5705
+ export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
5706
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
5707
+ }
5708
+
5198
5709
  /**
5199
5710
  * The TextShape component renders customizable floating text.
5200
5711
  *
@@ -5259,6 +5770,46 @@ export declare namespace PBTextShape {
5259
5770
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
5260
5771
  }
5261
5772
 
5773
+ /**
5774
+ * @public
5775
+ */
5776
+ export declare interface PBTextureCamera {
5777
+ /** rendered texture width */
5778
+ width?: number | undefined;
5779
+ /** rendered texture height */
5780
+ height?: number | undefined;
5781
+ /**
5782
+ * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
5783
+ * defaults to 0
5784
+ */
5785
+ layer?: number | undefined;
5786
+ /** default black */
5787
+ clearColor?: PBColor4 | undefined;
5788
+ /** default infinity */
5789
+ farPlane?: number | undefined;
5790
+ mode?: {
5791
+ $case: "perspective";
5792
+ perspective: Perspective;
5793
+ } | {
5794
+ $case: "orthographic";
5795
+ orthographic: Orthographic;
5796
+ } | undefined;
5797
+ /**
5798
+ * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
5799
+ * range: 0 (off) - 1 (full volume)
5800
+ * default: 0
5801
+ */
5802
+ volume?: number | undefined;
5803
+ }
5804
+
5805
+ /**
5806
+ * @public
5807
+ */
5808
+ export declare namespace PBTextureCamera {
5809
+ export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
5810
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
5811
+ }
5812
+
5262
5813
  /**
5263
5814
  * @public
5264
5815
  */
@@ -5348,6 +5899,25 @@ export declare namespace PBUiBackground {
5348
5899
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
5349
5900
  }
5350
5901
 
5902
+ /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
5903
+ /**
5904
+ * @public
5905
+ */
5906
+ export declare interface PBUiCanvas {
5907
+ width: number;
5908
+ height: number;
5909
+ /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
5910
+ color?: PBColor4 | undefined;
5911
+ }
5912
+
5913
+ /**
5914
+ * @public
5915
+ */
5916
+ export declare namespace PBUiCanvas {
5917
+ export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
5918
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
5919
+ }
5920
+
5351
5921
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
5352
5922
  /**
5353
5923
  * @public
@@ -5464,6 +6034,21 @@ export declare namespace PBUiInputResult {
5464
6034
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
5465
6035
  }
5466
6036
 
6037
+ /**
6038
+ * @public
6039
+ */
6040
+ export declare interface PBUiScrollResult {
6041
+ value: PBVector2 | undefined;
6042
+ }
6043
+
6044
+ /**
6045
+ * @public
6046
+ */
6047
+ export declare namespace PBUiScrollResult {
6048
+ export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
6049
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
6050
+ }
6051
+
5467
6052
  /**
5468
6053
  * @public
5469
6054
  */
@@ -5480,6 +6065,10 @@ export declare interface PBUiText {
5480
6065
  fontSize?: number | undefined;
5481
6066
  /** wrap text when the border is reached (default: TW_WRAP) */
5482
6067
  textWrap?: TextWrap | undefined;
6068
+ /** width of the outline (default: 0) */
6069
+ outlineWidth?: number | undefined;
6070
+ /** RGBA color of the outline (default: opaque black) */
6071
+ outlineColor?: PBColor4 | undefined;
5483
6072
  }
5484
6073
 
5485
6074
  /**
@@ -5607,6 +6196,12 @@ export declare interface PBUiTransform {
5607
6196
  borderRightColor?: PBColor4 | undefined;
5608
6197
  /** default: 1 */
5609
6198
  opacity?: number | undefined;
6199
+ /** reference for scroll_position. default empty */
6200
+ elementId?: string | undefined;
6201
+ /** default position=(0,0) */
6202
+ scrollPosition?: ScrollPositionValue | undefined;
6203
+ /** default ShowScrollBar.SSB_BOTH */
6204
+ scrollVisible?: ShowScrollBar | undefined;
5610
6205
  /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
5611
6206
  zIndex?: number | undefined;
5612
6207
  }
@@ -5738,6 +6333,25 @@ export declare namespace PBVisibilityComponent {
5738
6333
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
5739
6334
  }
5740
6335
 
6336
+ /**
6337
+ * @public
6338
+ */
6339
+ export declare interface Perspective {
6340
+ /**
6341
+ * vertical field of view in radians
6342
+ * defaults to pi/4 = 45 degrees
6343
+ */
6344
+ fieldOfView?: number | undefined;
6345
+ }
6346
+
6347
+ /**
6348
+ * @public
6349
+ */
6350
+ export declare namespace Perspective {
6351
+ export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
6352
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
6353
+ }
6354
+
5741
6355
  /**
5742
6356
  * Represens a plane by the equation ax + by + cz + d = 0
5743
6357
  * @public
@@ -5893,6 +6507,24 @@ export declare interface PointerEventsSystem {
5893
6507
  * @param entity - Entity where the callback was attached
5894
6508
  */
5895
6509
  removeOnPointerHoverLeave(entity: Entity): void;
6510
+ /**
6511
+ * @public
6512
+ * Remove the callback for onPointerDrag event
6513
+ * @param entity - Entity where the callback was attached
6514
+ */
6515
+ removeOnPointerDrag(entity: Entity): void;
6516
+ /**
6517
+ * @public
6518
+ * Remove the callback for onPointerDragLocked event
6519
+ * @param entity - Entity where the callback was attached
6520
+ */
6521
+ removeOnPointerDragLocked(entity: Entity): void;
6522
+ /**
6523
+ * @public
6524
+ * Remove the callback for onPointerDragEnd event
6525
+ * @param entity - Entity where the callback was attached
6526
+ */
6527
+ removeOnPointerDragEnd(entity: Entity): void;
5896
6528
  /**
5897
6529
  * @public
5898
6530
  * Execute callback when the user press the InputButton pointing at the entity
@@ -5947,6 +6579,37 @@ export declare interface PointerEventsSystem {
5947
6579
  entity: Entity;
5948
6580
  opts?: Partial<EventSystemOptions>;
5949
6581
  }, cb: EventSystemCallback): void;
6582
+ /**
6583
+ * @public
6584
+ * Execute callback when the user clicks and drags the pointer from inside the entity
6585
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6586
+ * @param cb - Function to execute when click fires
6587
+ */
6588
+ onPointerDrag(pointerData: {
6589
+ entity: Entity;
6590
+ opts?: Partial<EventSystemOptions>;
6591
+ }, cb: EventSystemCallback): void;
6592
+ /**
6593
+ * @public
6594
+ * Execute callback when the user clicks and drags the pointer from inside the entity,
6595
+ * locking the cursor in place
6596
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6597
+ * @param cb - Function to execute when click fires
6598
+ */
6599
+ onPointerDragLocked(pointerData: {
6600
+ entity: Entity;
6601
+ opts?: Partial<EventSystemOptions>;
6602
+ }, cb: EventSystemCallback): void;
6603
+ /**
6604
+ * @public
6605
+ * Execute callback when the user releases the button after a drag
6606
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6607
+ * @param cb - Function to execute when click fires
6608
+ */
6609
+ onPointerDragEnd(pointerData: {
6610
+ entity: Entity;
6611
+ opts?: Partial<EventSystemOptions>;
6612
+ }, cb: EventSystemCallback): void;
5950
6613
  }
5951
6614
 
5952
6615
  /**
@@ -5963,7 +6626,10 @@ export declare const enum PointerEventType {
5963
6626
  PET_UP = 0,
5964
6627
  PET_DOWN = 1,
5965
6628
  PET_HOVER_ENTER = 2,
5966
- PET_HOVER_LEAVE = 3
6629
+ PET_HOVER_LEAVE = 3,
6630
+ PET_DRAG_LOCKED = 4,
6631
+ PET_DRAG = 5,
6632
+ PET_DRAG_END = 6
5967
6633
  }
5968
6634
 
5969
6635
  /**
@@ -5994,7 +6660,10 @@ export declare const enum PointerType {
5994
6660
  /** POT_NONE - No pointer input */
5995
6661
  POT_NONE = 0,
5996
6662
  /** POT_MOUSE - Traditional mouse input */
5997
- POT_MOUSE = 1
6663
+ POT_MOUSE = 1,
6664
+ POT_PAD = 2,
6665
+ POT_TOUCH = 3,
6666
+ POT_WAND = 4
5998
6667
  }
5999
6668
 
6000
6669
  /**
@@ -6591,6 +7260,7 @@ export declare type RaycastSystemOptions = {
6591
7260
  export declare interface ReactBasedUiSystem {
6592
7261
  destroy(): void;
6593
7262
  setUiRenderer(ui: UiComponent): void;
7263
+ setTextureRenderer(entity: Entity, ui: UiComponent): void;
6594
7264
  }
6595
7265
 
6596
7266
  /**
@@ -7053,6 +7723,43 @@ export declare namespace Schemas {
7053
7723
  }) => void;
7054
7724
  }
7055
7725
 
7726
+ /**
7727
+ * @public
7728
+ */
7729
+ export declare interface ScrollPositionValue {
7730
+ value?: {
7731
+ $case: "position";
7732
+ position: PBVector2;
7733
+ } | {
7734
+ $case: "reference";
7735
+ reference: string;
7736
+ } | undefined;
7737
+ }
7738
+
7739
+ /**
7740
+ * @public
7741
+ */
7742
+ export declare namespace ScrollPositionValue {
7743
+ export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
7744
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
7745
+ }
7746
+
7747
+ /**
7748
+ * @public
7749
+ * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
7750
+ */
7751
+ export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
7752
+
7753
+ /**
7754
+ * @public
7755
+ */
7756
+ export declare const enum ShowScrollBar {
7757
+ SSB_BOTH = 0,
7758
+ SSB_ONLY_VERTICAL = 1,
7759
+ SSB_ONLY_HORIZONTAL = 2,
7760
+ SSB_HIDDEN = 3
7761
+ }
7762
+
7056
7763
  /**
7057
7764
  * @public
7058
7765
  */
@@ -7060,6 +7767,9 @@ export declare interface Spec {
7060
7767
  [key: string]: ISchema;
7061
7768
  }
7062
7769
 
7770
+ /** @public */
7771
+ export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
7772
+
7063
7773
  /* Excluded from this release type: SyncComponents */
7064
7774
 
7065
7775
  /**
@@ -7129,6 +7839,9 @@ export declare namespace Texture {
7129
7839
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
7130
7840
  }
7131
7841
 
7842
+ /** @public */
7843
+ export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
7844
+
7132
7845
  /**
7133
7846
  * @public
7134
7847
  */
@@ -7221,6 +7934,9 @@ export declare interface TextureUnion {
7221
7934
  } | {
7222
7935
  $case: "videoTexture";
7223
7936
  videoTexture: VideoTexture;
7937
+ } | {
7938
+ $case: "uiTexture";
7939
+ uiTexture: UiCanvasTexture;
7224
7940
  } | undefined;
7225
7941
  }
7226
7942
 
@@ -7428,6 +8144,8 @@ export declare interface UiBackgroundProps {
7428
8144
  uvs?: number[];
7429
8145
  /** AvatarTexture for the background */
7430
8146
  avatarTexture?: UiAvatarTexture;
8147
+ /** VideoTexture for the background */
8148
+ videoTexture?: UiVideoTexture;
7431
8149
  /** Texture for the background */
7432
8150
  texture?: UiTexture;
7433
8151
  }
@@ -7447,9 +8165,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
7447
8165
  disabled?: boolean;
7448
8166
  }
7449
8167
 
8168
+ /** @public */
8169
+ export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
8170
+
7450
8171
  /** @public */
7451
8172
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
7452
8173
 
8174
+ /**
8175
+ * @public
8176
+ */
8177
+ export declare interface UiCanvasTexture {
8178
+ uiCanvasEntity: number;
8179
+ /** default = TextureWrapMode.Clamp */
8180
+ wrapMode?: TextureWrapMode | undefined;
8181
+ /** default = FilterMode.Bilinear */
8182
+ filterMode?: TextureFilterMode | undefined;
8183
+ }
8184
+
8185
+ /**
8186
+ * @public
8187
+ */
8188
+ export declare namespace UiCanvasTexture {
8189
+ export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
8190
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
8191
+ }
8192
+
7453
8193
  /**
7454
8194
  * @public
7455
8195
  */
@@ -7519,6 +8259,10 @@ export declare interface UiLabelProps {
7519
8259
  textAlign?: TextAlignType | undefined;
7520
8260
  /** Label font type. @defaultValue 'sans-serif' */
7521
8261
  font?: UiFontType | undefined;
8262
+ /** Outline width of the text. @defaultValue 0 */
8263
+ outlineWidth?: number | undefined;
8264
+ /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
8265
+ outlineColor?: PBColor4 | undefined;
7522
8266
  /** Behaviour when text reached. @defaultValue 'wrap' */
7523
8267
  textWrap?: UiTextWrapType | undefined;
7524
8268
  }
@@ -7528,6 +8272,9 @@ export declare interface UiLabelProps {
7528
8272
  */
7529
8273
  export declare type uint32 = number;
7530
8274
 
8275
+ /** @public */
8276
+ export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
8277
+
7531
8278
  /** @public */
7532
8279
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
7533
8280
 
@@ -7605,10 +8352,26 @@ export declare interface UiTransformProps {
7605
8352
  borderWidth?: Partial<Position> | PositionUnit;
7606
8353
  /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
7607
8354
  opacity?: number;
8355
+ /** A reference value to identify the element, default empty */
8356
+ elementId?: string;
8357
+ /** default position=(0,0) if it aplies, a vector or a reference-id */
8358
+ scrollPosition?: PBVector2 | string;
8359
+ /** default ShowScrollBar.SSB_BOTH */
8360
+ scrollVisible?: ScrollVisibleType;
7608
8361
  /** default 0 */
7609
8362
  zIndex?: number;
7610
8363
  }
7611
8364
 
8365
+ /**
8366
+ * Texture
8367
+ * @public
8368
+ */
8369
+ export declare interface UiVideoTexture {
8370
+ videoPlayerEntity: Entity;
8371
+ wrapMode?: TextureWrapType;
8372
+ filterMode?: TextureFilterType;
8373
+ }
8374
+
7612
8375
  /**
7613
8376
  * @public
7614
8377
  */