@dcl/playground-assets 7.9.5-16891824780.commit-c2e52db → 7.9.6-16908909596.commit-3302d67

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,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
@@ -468,11 +527,19 @@ export declare interface ByteBuffer {
468
527
  }
469
528
 
470
529
  /**
471
- * Callback function to be triggered on a specified event
472
- * @public
530
+ * legacy Callback function
531
+ *
532
+ * @public @deprecated This type is no longer used in the sdk api, EventSystemCallback is
533
+ * used for listeners instead
473
534
  */
474
535
  export declare type Callback = () => void;
475
536
 
537
+ /** @public */
538
+ export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
539
+
540
+ /** @public */
541
+ export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
542
+
476
543
  /** @public */
477
544
  export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
478
545
 
@@ -530,6 +597,39 @@ export declare const enum CameraType {
530
597
 
531
598
  export declare type Children = ReactEcs.JSX.ReactNode;
532
599
 
600
+ /**
601
+ * @public
602
+ */
603
+ export declare interface CinematicSettings {
604
+ /** Entity that defines the cinematic camera transform. */
605
+ cameraEntity: number;
606
+ /**
607
+ * Position -> camera's position
608
+ * Rotation -> camera's direction
609
+ * scale.z -> zoom level
610
+ * scale.x and scale.y -> unused
611
+ */
612
+ allowManualRotation?: boolean | undefined;
613
+ /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
614
+ yawRange?: number | undefined;
615
+ /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
616
+ pitchRange?: number | undefined;
617
+ /** note: cameras can never look up/down further than Vec3::Y */
618
+ rollRange?: number | undefined;
619
+ /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
620
+ zoomMin?: number | undefined;
621
+ /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
622
+ zoomMax?: number | undefined;
623
+ }
624
+
625
+ /**
626
+ * @public
627
+ */
628
+ export declare namespace CinematicSettings {
629
+ export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
630
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
631
+ }
632
+
533
633
  /** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
534
634
  /**
535
635
  * @public
@@ -1303,12 +1403,16 @@ export declare const componentDefinitionByName: {
1303
1403
  "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
1304
1404
  "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
1305
1405
  "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
1406
+ "core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
1407
+ "core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
1306
1408
  "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
1307
1409
  "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
1308
1410
  "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
1411
+ "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
1309
1412
  "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
1310
1413
  "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
1311
- "core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
1414
+ "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
1415
+ "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
1312
1416
  "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
1313
1417
  "core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
1314
1418
  "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
@@ -1324,17 +1428,19 @@ export declare const componentDefinitionByName: {
1324
1428
  "core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
1325
1429
  "core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
1326
1430
  "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
1327
- "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
1328
1431
  "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
1432
+ "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
1329
1433
  "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
1330
1434
  "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
1331
1435
  "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
1332
1436
  "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
1437
+ "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
1333
1438
  "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
1334
1439
  "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
1335
1440
  "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
1336
1441
  "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
1337
1442
  "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
1443
+ "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
1338
1444
  "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
1339
1445
  "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
1340
1446
  "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -1901,10 +2007,18 @@ export declare type EntityComponents = {
1901
2007
  uiBackground: PBUiBackground;
1902
2008
  uiInput: PBUiInput;
1903
2009
  uiDropdown: PBUiDropdown;
1904
- onMouseDown: Callback;
1905
- onMouseUp: Callback;
1906
- onMouseEnter: Callback;
1907
- onMouseLeave: Callback;
2010
+ onMouseDown: EventSystemCallback;
2011
+ onMouseUp: EventSystemCallback;
2012
+ onMouseEnter: EventSystemCallback;
2013
+ onMouseLeave: EventSystemCallback;
2014
+ onMouseDrag: EventSystemCallback;
2015
+ onMouseDragLocked: EventSystemCallback;
2016
+ onMouseDragEnd: EventSystemCallback;
2017
+ onInputDown: MultiCallback;
2018
+ onInputUp: MultiCallback;
2019
+ onInputDrag: MultiCallback;
2020
+ onInputDragLocked: MultiCallback;
2021
+ onInputDragEnd: MultiCallback;
1908
2022
  };
1909
2023
 
1910
2024
  /** @public */
@@ -1982,6 +2096,13 @@ export declare type EventSystemOptions = {
1982
2096
  showHighlight?: boolean;
1983
2097
  };
1984
2098
 
2099
+ /**
2100
+ * @public
2101
+ */
2102
+ export declare type EventSystemOptionsCallback = EventSystemOptions & {
2103
+ cb: EventSystemCallback;
2104
+ };
2105
+
1985
2106
  /**
1986
2107
  * Excludes property keys from T where the property is assignable to U
1987
2108
  * @public
@@ -2056,6 +2177,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
2056
2177
  direction?: PBVector3;
2057
2178
  };
2058
2179
 
2180
+ /** @public */
2181
+ export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
2182
+
2059
2183
  export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
2060
2184
 
2061
2185
  export declare type GlobalTargetRaycastSystemOptions = {
@@ -2069,7 +2193,19 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
2069
2193
  export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
2070
2194
 
2071
2195
  /** @public */
2072
- export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
2196
+ export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
2197
+
2198
+ /** @public */
2199
+ export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
2200
+
2201
+ /**
2202
+ * @public
2203
+ */
2204
+ export declare const enum GltfNodeStateValue {
2205
+ GNSV_PENDING = 0,
2206
+ GNSV_FAILED = 1,
2207
+ GNSV_READY = 2
2208
+ }
2073
2209
 
2074
2210
  /**
2075
2211
  * @public
@@ -2409,6 +2545,12 @@ export declare type IInputSystem = {
2409
2545
  * @returns the input command info or undefined if there is no command in the last tick-update
2410
2546
  */
2411
2547
  getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
2548
+ /**
2549
+ * @public
2550
+ * Get an ordered iterator over events received within the current frame.
2551
+ * @returns the iterator
2552
+ */
2553
+ getInputCommands: () => Generator<PBPointerEventsResult>;
2412
2554
  };
2413
2555
 
2414
2556
  /**
@@ -2672,31 +2814,8 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
2672
2814
  getOrCreateMutable(entity: Entity, initialValue?: T): T;
2673
2815
  }
2674
2816
 
2675
- export declare const LightSource: LightSourceComponentDefinitionExtended;
2676
-
2677
- /**
2678
- * @public
2679
- */
2680
- export declare interface LightSourceComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBLightSource> {
2681
- /**
2682
- * LightSource helper with constructor
2683
- */
2684
- Type: LightSourceHelper;
2685
- }
2686
-
2687
- /**
2688
- * @public
2689
- */
2690
- export declare interface LightSourceHelper {
2691
- /**
2692
- * @returns a Light Source type
2693
- */
2694
- Point: (point: PBLightSource_Point) => PBLightSource['type'];
2695
- /**
2696
- * @returns a Light Source type
2697
- */
2698
- Spot: (spot: PBLightSource_Spot) => PBLightSource['type'];
2699
- }
2817
+ /** @public */
2818
+ export declare const LightSource: LastWriteWinElementSetComponentDefinition<PBLightSource>;
2700
2819
 
2701
2820
  /**
2702
2821
  * User key event Listeners
@@ -2704,13 +2823,29 @@ export declare interface LightSourceHelper {
2704
2823
  */
2705
2824
  export declare type Listeners = {
2706
2825
  /** triggered on mouse down event */
2707
- onMouseDown?: Callback;
2826
+ onMouseDown?: EventSystemCallback;
2708
2827
  /** triggered on mouse up event */
2709
- onMouseUp?: Callback;
2828
+ onMouseUp?: EventSystemCallback;
2710
2829
  /** triggered on mouse hover event */
2711
- onMouseEnter?: Callback;
2830
+ onMouseEnter?: EventSystemCallback;
2712
2831
  /** triggered on mouse leave event */
2713
- onMouseLeave?: Callback;
2832
+ onMouseLeave?: EventSystemCallback;
2833
+ /** triggered on mouse drag event */
2834
+ onMouseDrag?: EventSystemCallback;
2835
+ /** triggered on mouse drag event */
2836
+ onMouseDragLocked?: EventSystemCallback;
2837
+ /** triggered on mouse drag event */
2838
+ onMouseDragEnd?: EventSystemCallback;
2839
+ /** triggered on input down event */
2840
+ onInputDown?: MultiCallback;
2841
+ /** triggered on input up event */
2842
+ onInputUp?: MultiCallback;
2843
+ /** triggered on input drag event */
2844
+ onInputDrag?: MultiCallback;
2845
+ /** triggered on input drag event */
2846
+ onInputDragLocked?: MultiCallback;
2847
+ /** triggered on input drag event */
2848
+ onInputDragEnd?: MultiCallback;
2714
2849
  };
2715
2850
 
2716
2851
  /**
@@ -3579,6 +3714,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
3579
3714
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
3580
3715
  */
3581
3716
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3717
+ /**
3718
+ * @public
3719
+ * Set a gltf internal mesh in the MeshCollider component
3720
+ * @param entity - entity to create or replace the MeshRenderer component
3721
+ * @param source - the path to the gltf
3722
+ * @param meshName - the name of the mesh in the gltf
3723
+ */
3724
+ setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3582
3725
  }
3583
3726
 
3584
3727
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -3615,6 +3758,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
3615
3758
  * @param entity - entity to create or replace the MeshRenderer component
3616
3759
  */
3617
3760
  setSphere(entity: Entity): void;
3761
+ /**
3762
+ * @public
3763
+ * Set a gltf internal mesh in the MeshRenderer component
3764
+ * @param entity - entity to create or replace the MeshRenderer component
3765
+ * @param source - the path to the gltf
3766
+ * @param meshName - the name of the mesh in the gltf
3767
+ */
3768
+ setGltfMesh(entity: Entity, source: string, meshName: string): void;
3618
3769
  }
3619
3770
 
3620
3771
  /* Excluded from this release type: MessageBus */
@@ -3636,6 +3787,19 @@ export declare namespace Move {
3636
3787
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Move;
3637
3788
  }
3638
3789
 
3790
+ /**
3791
+ * a record object mapping `InputAction`s to functions.
3792
+ *
3793
+ * @example
3794
+ * onInputDown={{
3795
+ * [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
3796
+ * [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
3797
+ * }}
3798
+ *
3799
+ * @public
3800
+ */
3801
+ export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
3802
+
3639
3803
  export declare const Name: NameComponent;
3640
3804
 
3641
3805
  export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
@@ -4008,6 +4172,25 @@ export declare const onVideoEvent: Observable<{
4008
4172
  totalVideoLength: number;
4009
4173
  }>;
4010
4174
 
4175
+ /**
4176
+ * @public
4177
+ */
4178
+ export declare interface Orthographic {
4179
+ /**
4180
+ * vertical extent of the visible range in meters
4181
+ * defaults to 4m
4182
+ */
4183
+ verticalRange?: number | undefined;
4184
+ }
4185
+
4186
+ /**
4187
+ * @public
4188
+ */
4189
+ export declare namespace Orthographic {
4190
+ export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
4191
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
4192
+ }
4193
+
4011
4194
  /**
4012
4195
  * @public
4013
4196
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -4234,6 +4417,8 @@ export declare namespace PBAvatarEmoteCommand {
4234
4417
  export declare interface PBAvatarEquippedData {
4235
4418
  wearableUrns: string[];
4236
4419
  emoteUrns: string[];
4420
+ /** slots that will render even if hidden */
4421
+ forceRender: string[];
4237
4422
  }
4238
4423
 
4239
4424
  /**
@@ -4268,6 +4453,9 @@ export declare interface PBAvatarModifierArea {
4268
4453
  excludeIds: string[];
4269
4454
  /** list of modifiers to apply */
4270
4455
  modifiers: AvatarModifierType[];
4456
+ movementSettings?: AvatarMovementSettings | undefined;
4457
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4458
+ useColliderRange?: boolean | undefined;
4271
4459
  }
4272
4460
 
4273
4461
  /**
@@ -4324,8 +4512,8 @@ export declare interface PBAvatarShape {
4324
4512
  wearables: string[];
4325
4513
  /** available emotes (default empty) */
4326
4514
  emotes: string[];
4327
- /** hides the skin + hair + facial features (default: false) */
4328
- showOnlyWearables?: boolean | undefined;
4515
+ /** slots that will render even if hidden */
4516
+ forceRender: string[];
4329
4517
  }
4330
4518
 
4331
4519
  /**
@@ -4360,6 +4548,51 @@ export declare namespace PBBillboard {
4360
4548
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
4361
4549
  }
4362
4550
 
4551
+ /**
4552
+ * @public
4553
+ */
4554
+ export declare interface PBCameraLayer {
4555
+ /**
4556
+ * layer to which these settings apply. must be > 0
4557
+ * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
4558
+ */
4559
+ layer: number;
4560
+ /** should the sun light affect this layer? default false */
4561
+ directionalLight?: boolean | undefined;
4562
+ /** should this layer show player avatars? default false */
4563
+ showAvatars?: boolean | undefined;
4564
+ /** should this layer show the sky? default false */
4565
+ showSkybox?: boolean | undefined;
4566
+ /** should this layer show distance fog? default false */
4567
+ showFog?: boolean | undefined;
4568
+ /** ambient light overrides for this layer. default -> use same as main camera */
4569
+ ambientColorOverride?: PBColor3 | undefined;
4570
+ ambientBrightnessOverride?: number | undefined;
4571
+ }
4572
+
4573
+ /**
4574
+ * @public
4575
+ */
4576
+ export declare namespace PBCameraLayer {
4577
+ export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
4578
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
4579
+ }
4580
+
4581
+ /**
4582
+ * @public
4583
+ */
4584
+ export declare interface PBCameraLayers {
4585
+ layers: number[];
4586
+ }
4587
+
4588
+ /**
4589
+ * @public
4590
+ */
4591
+ export declare namespace PBCameraLayers {
4592
+ export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
4593
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
4594
+ }
4595
+
4363
4596
  /**
4364
4597
  * The CameraMode component can be used to determine whether the player is using a first-person o
4365
4598
  * third-person view.
@@ -4382,7 +4615,7 @@ export declare namespace PBCameraMode {
4382
4615
 
4383
4616
  /**
4384
4617
  * The CameraModeArea component can be attached to an Entity to define a region of space where
4385
- * the player's camera mode (1st-person or 3rd-person) is overridden.
4618
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
4386
4619
  *
4387
4620
  * The Entity's Transform position determines the center-point of the region, while its size is
4388
4621
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -4392,6 +4625,8 @@ export declare namespace PBCameraMode {
4392
4625
  *
4393
4626
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
4394
4627
  * is actually a 3D volume.
4628
+ *
4629
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
4395
4630
  */
4396
4631
  /**
4397
4632
  * @public
@@ -4401,6 +4636,9 @@ export declare interface PBCameraModeArea {
4401
4636
  area: PBVector3 | undefined;
4402
4637
  /** the camera mode to enforce */
4403
4638
  mode: CameraType;
4639
+ cinematicSettings?: CinematicSettings | undefined;
4640
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4641
+ useColliderRange?: boolean | undefined;
4404
4642
  }
4405
4643
 
4406
4644
  /**
@@ -4472,6 +4710,39 @@ export declare namespace PBEngineInfo {
4472
4710
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
4473
4711
  }
4474
4712
 
4713
+ /**
4714
+ * defines the global scene light settings. must be added to the scene root.
4715
+ * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
4716
+ */
4717
+ /**
4718
+ * @public
4719
+ */
4720
+ export declare interface PBGlobalLight {
4721
+ /**
4722
+ * the direction the directional light shines in.
4723
+ * default depends on time of day and explorer implementation
4724
+ */
4725
+ direction?: PBVector3 | undefined;
4726
+ /**
4727
+ * ambient light color
4728
+ * default: White
4729
+ */
4730
+ ambientColor?: PBColor3 | undefined;
4731
+ /**
4732
+ * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
4733
+ * default 1
4734
+ */
4735
+ ambientBrightness?: number | undefined;
4736
+ }
4737
+
4738
+ /**
4739
+ * @public
4740
+ */
4741
+ export declare namespace PBGlobalLight {
4742
+ export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
4743
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
4744
+ }
4745
+
4475
4746
  /**
4476
4747
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
4477
4748
  *
@@ -4507,6 +4778,25 @@ export declare namespace PBGltfContainer {
4507
4778
  */
4508
4779
  export declare interface PBGltfContainerLoadingState {
4509
4780
  currentState: LoadingState;
4781
+ /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
4782
+ nodePaths: string[];
4783
+ /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
4784
+ meshNames: string[];
4785
+ /**
4786
+ * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
4787
+ * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
4788
+ */
4789
+ materialNames: string[];
4790
+ /**
4791
+ * X is the material index. note this may conflict with manually named materials - to avoid any issues make
4792
+ * sure all your materials are explicitly named.
4793
+ */
4794
+ skinNames: string[];
4795
+ /**
4796
+ * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
4797
+ * your skins are explicitly named.
4798
+ */
4799
+ animationNames: string[];
4510
4800
  }
4511
4801
 
4512
4802
  /**
@@ -4518,48 +4808,74 @@ export declare namespace PBGltfContainerLoadingState {
4518
4808
  }
4519
4809
 
4520
4810
  /**
4521
- * GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
4811
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
4812
+ * This component must be added to a direct child of an entity with a PBGltfContainer component, or
4813
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
4814
+ * in the parent.
4815
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
4816
+ *
4817
+ * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
4818
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
4819
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
4820
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
4821
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
4522
4822
  *
4523
- * This allows to override either the Material or the Casting Shadows behaviour of the target GLTF Node.
4823
+ * After creation, if an animation moves the node, the `Transform` will be updated.
4524
4824
  *
4525
- * * If the 'path' of the first modifier in the collection is an empty string: the configuration will
4526
- * affect all of the GLTF Nodes (as a global modifier).
4527
- * * Otherwise, for the modifiers whose 'path' is found in the GLTF hierarchy, the modifier will affect only
4528
- * the target Nodes.
4825
+ * From the scene, you can modify various components to alter the gltf node:
4826
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
4827
+ * regardless of any intermediate gltf node hierarchy.
4828
+ * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
4829
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
4830
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
4831
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
4832
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
4833
+ * 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
4834
+ * PBMaterial will be maintained.
4835
+ *
4836
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
4837
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
4838
+ * change the state to `GNS_FAILED`.
4839
+ * - deleting the scene entity will not delete the gltf node.
4840
+ *
4841
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
4842
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
4843
+ * the gltf node will also be displayed.
4529
4844
  */
4530
4845
  /**
4531
4846
  * @public
4532
4847
  */
4533
- export declare interface PBGltfNodeModifiers {
4534
- modifiers: PBGltfNodeModifiers_GltfNodeModifier[];
4848
+ export declare interface PBGltfNode {
4849
+ /** the path of the target node in the Gltf. */
4850
+ path: string;
4535
4851
  }
4536
4852
 
4537
4853
  /**
4538
4854
  * @public
4539
4855
  */
4540
- export declare namespace PBGltfNodeModifiers {
4541
- export function encode(message: PBGltfNodeModifiers, writer?: _m0.Writer): _m0.Writer;
4542
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers;
4856
+ export declare namespace PBGltfNode {
4857
+ export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
4858
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
4543
4859
  }
4544
4860
 
4861
+ /**
4862
+ * The state of a linked gltf node.
4863
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
4864
+ */
4545
4865
  /**
4546
4866
  * @public
4547
4867
  */
4548
- export declare interface PBGltfNodeModifiers_GltfNodeModifier {
4549
- /** The GLTF hierarchy path of the target Node to be affected */
4550
- path: string;
4551
- /** The casting shadows enabled override */
4552
- castShadows?: boolean | undefined;
4553
- /** The Material that will be overridden on the target Node */
4554
- material?: PBMaterial | undefined;
4868
+ export declare interface PBGltfNodeState {
4869
+ state: GltfNodeStateValue;
4870
+ error?: string | undefined;
4555
4871
  }
4556
4872
 
4557
4873
  /**
4558
4874
  * @public
4559
4875
  */
4560
- export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
4561
- export function encode(message: PBGltfNodeModifiers_GltfNodeModifier, writer?: _m0.Writer): _m0.Writer;
4562
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
4876
+ export declare namespace PBGltfNodeState {
4877
+ export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
4878
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
4563
4879
  }
4564
4880
 
4565
4881
  /**
@@ -4697,6 +5013,14 @@ export declare interface PBMaterial {
4697
5013
  $case: "pbr";
4698
5014
  pbr: PBMaterial_PbrMaterial;
4699
5015
  } | undefined;
5016
+ /**
5017
+ * A gltf material that may provide additional features not supported by the PbMaterial fields.
5018
+ * If both gltf and material fields are provided, the gltf will be used only for extended features not
5019
+ * supported by the PbMaterial.
5020
+ * If this is provided and the `material` field is not provided, the renderer will update the material
5021
+ * field with data that reflects the gltf material once it is loaded.
5022
+ */
5023
+ gltf?: PBMaterial_GltfMaterial | undefined;
4700
5024
  }
4701
5025
 
4702
5026
  /**
@@ -4707,6 +5031,22 @@ export declare namespace PBMaterial {
4707
5031
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
4708
5032
  }
4709
5033
 
5034
+ /**
5035
+ * @public
5036
+ */
5037
+ export declare interface PBMaterial_GltfMaterial {
5038
+ gltfSrc: string;
5039
+ name: string;
5040
+ }
5041
+
5042
+ /**
5043
+ * @public
5044
+ */
5045
+ export declare namespace PBMaterial_GltfMaterial {
5046
+ export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
5047
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
5048
+ }
5049
+
4710
5050
  /**
4711
5051
  * @public
4712
5052
  */
@@ -4803,6 +5143,9 @@ export declare interface PBMeshCollider {
4803
5143
  } | {
4804
5144
  $case: "plane";
4805
5145
  plane: PBMeshCollider_PlaneMesh;
5146
+ } | {
5147
+ $case: "gltf";
5148
+ gltf: PBMeshCollider_GltfMesh;
4806
5149
  } | undefined;
4807
5150
  }
4808
5151
 
@@ -4848,6 +5191,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
4848
5191
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
4849
5192
  }
4850
5193
 
5194
+ /** A collider constructed from a Gltf Mesh. */
5195
+ /**
5196
+ * @public
5197
+ */
5198
+ export declare interface PBMeshCollider_GltfMesh {
5199
+ /** the GLTF file path as listed in the scene's manifest. */
5200
+ gltfSrc: string;
5201
+ /** the name of the mesh asset */
5202
+ name: string;
5203
+ }
5204
+
5205
+ /**
5206
+ * @public
5207
+ */
5208
+ export declare namespace PBMeshCollider_GltfMesh {
5209
+ export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5210
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
5211
+ }
5212
+
4851
5213
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
4852
5214
  /**
4853
5215
  * @public
@@ -4880,13 +5242,11 @@ export declare namespace PBMeshCollider_SphereMesh {
4880
5242
 
4881
5243
  /**
4882
5244
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
4883
- * plane, a sphere or a cylinder.
5245
+ * plane, a sphere, a cylinder, or a Gltf mesh.
4884
5246
  *
4885
5247
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
4886
5248
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
4887
5249
  * `float` coordinates, one for each corner of each side of each face.
4888
- *
4889
- * More complex shapes require the use of a `GltfContainer` component.
4890
5250
  */
4891
5251
  /**
4892
5252
  * @public
@@ -4904,6 +5264,9 @@ export declare interface PBMeshRenderer {
4904
5264
  } | {
4905
5265
  $case: "plane";
4906
5266
  plane: PBMeshRenderer_PlaneMesh;
5267
+ } | {
5268
+ $case: "gltf";
5269
+ gltf: PBMeshRenderer_GltfMesh;
4907
5270
  } | undefined;
4908
5271
  }
4909
5272
 
@@ -4951,6 +5314,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
4951
5314
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
4952
5315
  }
4953
5316
 
5317
+ /** A mesh from a Gltf. */
5318
+ /**
5319
+ * @public
5320
+ */
5321
+ export declare interface PBMeshRenderer_GltfMesh {
5322
+ /** the GLTF file path as listed in the scene's manifest. */
5323
+ gltfSrc: string;
5324
+ /** the name of the mesh asset */
5325
+ name: string;
5326
+ }
5327
+
5328
+ /**
5329
+ * @public
5330
+ */
5331
+ export declare namespace PBMeshRenderer_GltfMesh {
5332
+ export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5333
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
5334
+ }
5335
+
4954
5336
  /** PlaneMesh renders a 2D rectangular shape. */
4955
5337
  /**
4956
5338
  * @public
@@ -5199,7 +5581,10 @@ export declare interface PBPrimaryPointerInfo {
5199
5581
  screenCoordinates?: PBVector2 | undefined;
5200
5582
  /** Movement since last frame (pixels) */
5201
5583
  screenDelta?: PBVector2 | undefined;
5202
- /** Direction vector for 3D ray casting */
5584
+ /**
5585
+ * ray direction that can be used with the primary camera origin for
5586
+ * raycasting from the cursor into the world
5587
+ */
5203
5588
  worldRayDirection?: PBVector3 | undefined;
5204
5589
  }
5205
5590
 
@@ -5339,28 +5724,6 @@ export declare namespace PBRealmInfo {
5339
5724
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
5340
5725
  }
5341
5726
 
5342
- /**
5343
- * The SkyboxTime component allows controlling the time of day for the skybox,
5344
- * affecting the lighting and appearance of the sky in the scene.
5345
- */
5346
- /**
5347
- * @public
5348
- */
5349
- export declare interface PBSkyboxTime {
5350
- /** fixed time of day, represented as a number of seconds since the start of the day, where 0 is 00:00hs, 43200 is 12:00hs and 86400 is 24:00hs */
5351
- fixedTime: number;
5352
- /** default = TransitionMode.TM_FORWARD, controls the direction of time transitions */
5353
- transitionMode?: TransitionMode | undefined;
5354
- }
5355
-
5356
- /**
5357
- * @public
5358
- */
5359
- export declare namespace PBSkyboxTime {
5360
- export function encode(message: PBSkyboxTime, writer?: _m0.Writer): _m0.Writer;
5361
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
5362
- }
5363
-
5364
5727
  /**
5365
5728
  * The TextShape component renders customizable floating text.
5366
5729
  *
@@ -5425,6 +5788,46 @@ export declare namespace PBTextShape {
5425
5788
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
5426
5789
  }
5427
5790
 
5791
+ /**
5792
+ * @public
5793
+ */
5794
+ export declare interface PBTextureCamera {
5795
+ /** rendered texture width */
5796
+ width?: number | undefined;
5797
+ /** rendered texture height */
5798
+ height?: number | undefined;
5799
+ /**
5800
+ * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
5801
+ * defaults to 0
5802
+ */
5803
+ layer?: number | undefined;
5804
+ /** default black */
5805
+ clearColor?: PBColor4 | undefined;
5806
+ /** default infinity */
5807
+ farPlane?: number | undefined;
5808
+ mode?: {
5809
+ $case: "perspective";
5810
+ perspective: Perspective;
5811
+ } | {
5812
+ $case: "orthographic";
5813
+ orthographic: Orthographic;
5814
+ } | undefined;
5815
+ /**
5816
+ * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
5817
+ * range: 0 (off) - 1 (full volume)
5818
+ * default: 0
5819
+ */
5820
+ volume?: number | undefined;
5821
+ }
5822
+
5823
+ /**
5824
+ * @public
5825
+ */
5826
+ export declare namespace PBTextureCamera {
5827
+ export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
5828
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
5829
+ }
5830
+
5428
5831
  /**
5429
5832
  * @public
5430
5833
  */
@@ -5514,6 +5917,25 @@ export declare namespace PBUiBackground {
5514
5917
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
5515
5918
  }
5516
5919
 
5920
+ /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
5921
+ /**
5922
+ * @public
5923
+ */
5924
+ export declare interface PBUiCanvas {
5925
+ width: number;
5926
+ height: number;
5927
+ /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
5928
+ color?: PBColor4 | undefined;
5929
+ }
5930
+
5931
+ /**
5932
+ * @public
5933
+ */
5934
+ export declare namespace PBUiCanvas {
5935
+ export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
5936
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
5937
+ }
5938
+
5517
5939
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
5518
5940
  /**
5519
5941
  * @public
@@ -5630,6 +6052,21 @@ export declare namespace PBUiInputResult {
5630
6052
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
5631
6053
  }
5632
6054
 
6055
+ /**
6056
+ * @public
6057
+ */
6058
+ export declare interface PBUiScrollResult {
6059
+ value: PBVector2 | undefined;
6060
+ }
6061
+
6062
+ /**
6063
+ * @public
6064
+ */
6065
+ export declare namespace PBUiScrollResult {
6066
+ export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
6067
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
6068
+ }
6069
+
5633
6070
  /**
5634
6071
  * @public
5635
6072
  */
@@ -5646,6 +6083,10 @@ export declare interface PBUiText {
5646
6083
  fontSize?: number | undefined;
5647
6084
  /** wrap text when the border is reached (default: TW_WRAP) */
5648
6085
  textWrap?: TextWrap | undefined;
6086
+ /** width of the outline (default: 0) */
6087
+ outlineWidth?: number | undefined;
6088
+ /** RGBA color of the outline (default: opaque black) */
6089
+ outlineColor?: PBColor4 | undefined;
5649
6090
  }
5650
6091
 
5651
6092
  /**
@@ -5773,6 +6214,12 @@ export declare interface PBUiTransform {
5773
6214
  borderRightColor?: PBColor4 | undefined;
5774
6215
  /** default: 1 */
5775
6216
  opacity?: number | undefined;
6217
+ /** reference for scroll_position. default empty */
6218
+ elementId?: string | undefined;
6219
+ /** default position=(0,0) */
6220
+ scrollPosition?: ScrollPositionValue | undefined;
6221
+ /** default ShowScrollBar.SSB_BOTH */
6222
+ scrollVisible?: ShowScrollBar | undefined;
5776
6223
  /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
5777
6224
  zIndex?: number | undefined;
5778
6225
  }
@@ -5904,6 +6351,25 @@ export declare namespace PBVisibilityComponent {
5904
6351
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
5905
6352
  }
5906
6353
 
6354
+ /**
6355
+ * @public
6356
+ */
6357
+ export declare interface Perspective {
6358
+ /**
6359
+ * vertical field of view in radians
6360
+ * defaults to pi/4 = 45 degrees
6361
+ */
6362
+ fieldOfView?: number | undefined;
6363
+ }
6364
+
6365
+ /**
6366
+ * @public
6367
+ */
6368
+ export declare namespace Perspective {
6369
+ export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
6370
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
6371
+ }
6372
+
5907
6373
  /**
5908
6374
  * Represens a plane by the equation ax + by + cz + d = 0
5909
6375
  * @public
@@ -6059,11 +6525,37 @@ export declare interface PointerEventsSystem {
6059
6525
  * @param entity - Entity where the callback was attached
6060
6526
  */
6061
6527
  removeOnPointerHoverLeave(entity: Entity): void;
6528
+ /**
6529
+ * @public
6530
+ * Remove the callback for onPointerDrag event
6531
+ * @param entity - Entity where the callback was attached
6532
+ */
6533
+ removeOnPointerDrag(entity: Entity): void;
6534
+ /**
6535
+ * @public
6536
+ * Remove the callback for onPointerDragLocked event
6537
+ * @param entity - Entity where the callback was attached
6538
+ */
6539
+ removeOnPointerDragLocked(entity: Entity): void;
6540
+ /**
6541
+ * @public
6542
+ * Remove the callback for onPointerDragEnd event
6543
+ * @param entity - Entity where the callback was attached
6544
+ */
6545
+ removeOnPointerDragEnd(entity: Entity): void;
6546
+ /**
6547
+ * @public
6548
+ * Execute callbacks when the user presses one of the InputButtons pointing at the entity
6549
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6550
+ */
6551
+ onPointerDown(pointerData: {
6552
+ entity: Entity;
6553
+ optsList: EventSystemOptionsCallback[];
6554
+ }): void;
6062
6555
  /**
6063
6556
  * @public
6064
6557
  * Execute callback when the user press the InputButton pointing at the entity
6065
6558
  * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
6066
- * @param cb - Function to execute when click fires
6067
6559
  */
6068
6560
  onPointerDown(pointerData: {
6069
6561
  entity: Entity;
@@ -6076,6 +6568,15 @@ export declare interface PointerEventsSystem {
6076
6568
  * @param opts - Opts to trigger Feedback and Button
6077
6569
  */
6078
6570
  onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
6571
+ /**
6572
+ * @public
6573
+ * Execute callbacks when the user releases one of the InputButtons pointing at the entity
6574
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6575
+ */
6576
+ onPointerUp(pointerData: {
6577
+ entity: Entity;
6578
+ optsList: EventSystemOptionsCallback[];
6579
+ }): void;
6079
6580
  /**
6080
6581
  * @public
6081
6582
  * Execute callback when the user releases the InputButton pointing at the entity
@@ -6113,6 +6614,64 @@ export declare interface PointerEventsSystem {
6113
6614
  entity: Entity;
6114
6615
  opts?: Partial<EventSystemOptions>;
6115
6616
  }, cb: EventSystemCallback): void;
6617
+ /**
6618
+ * @public
6619
+ * Execute callbacks when the user drags the pointer from inside the entity
6620
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6621
+ */
6622
+ onPointerDrag(pointerData: {
6623
+ entity: Entity;
6624
+ optsList: EventSystemOptionsCallback[];
6625
+ }): void;
6626
+ /**
6627
+ * @public
6628
+ * Execute callback when the user clicks and drags the pointer from inside the entity
6629
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6630
+ * @param cb - Function to execute when click fires
6631
+ */
6632
+ onPointerDrag(pointerData: {
6633
+ entity: Entity;
6634
+ opts?: Partial<EventSystemOptions>;
6635
+ }, cb: EventSystemCallback): void;
6636
+ /**
6637
+ * @public
6638
+ * Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
6639
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6640
+ */
6641
+ onPointerDragLocked(pointerData: {
6642
+ entity: Entity;
6643
+ optsList: EventSystemOptionsCallback[];
6644
+ }): void;
6645
+ /**
6646
+ * @public
6647
+ * Execute callback when the user clicks and drags the pointer from inside the entity,
6648
+ * locking the cursor in place
6649
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6650
+ * @param cb - Function to execute when click fires
6651
+ */
6652
+ onPointerDragLocked(pointerData: {
6653
+ entity: Entity;
6654
+ opts?: Partial<EventSystemOptions>;
6655
+ }, cb: EventSystemCallback): void;
6656
+ /**
6657
+ * @public
6658
+ * Execute callbacks when the user releases a button after a drag
6659
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6660
+ */
6661
+ onPointerDragEnd(pointerData: {
6662
+ entity: Entity;
6663
+ optsList: EventSystemOptionsCallback[];
6664
+ }): void;
6665
+ /**
6666
+ * @public
6667
+ * Execute callback when the user releases the button after a drag
6668
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6669
+ * @param cb - Function to execute when click fires
6670
+ */
6671
+ onPointerDragEnd(pointerData: {
6672
+ entity: Entity;
6673
+ opts?: Partial<EventSystemOptions>;
6674
+ }, cb: EventSystemCallback): void;
6116
6675
  }
6117
6676
 
6118
6677
  /**
@@ -6129,7 +6688,10 @@ export declare const enum PointerEventType {
6129
6688
  PET_UP = 0,
6130
6689
  PET_DOWN = 1,
6131
6690
  PET_HOVER_ENTER = 2,
6132
- PET_HOVER_LEAVE = 3
6691
+ PET_HOVER_LEAVE = 3,
6692
+ PET_DRAG_LOCKED = 4,
6693
+ PET_DRAG = 5,
6694
+ PET_DRAG_END = 6
6133
6695
  }
6134
6696
 
6135
6697
  /**
@@ -6160,7 +6722,10 @@ export declare const enum PointerType {
6160
6722
  /** POT_NONE - No pointer input */
6161
6723
  POT_NONE = 0,
6162
6724
  /** POT_MOUSE - Traditional mouse input */
6163
- POT_MOUSE = 1
6725
+ POT_MOUSE = 1,
6726
+ POT_PAD = 2,
6727
+ POT_TOUCH = 3,
6728
+ POT_WAND = 4
6164
6729
  }
6165
6730
 
6166
6731
  /**
@@ -6757,6 +7322,7 @@ export declare type RaycastSystemOptions = {
6757
7322
  export declare interface ReactBasedUiSystem {
6758
7323
  destroy(): void;
6759
7324
  setUiRenderer(ui: UiComponent): void;
7325
+ setTextureRenderer(entity: Entity, ui: UiComponent): void;
6760
7326
  }
6761
7327
 
6762
7328
  /**
@@ -7219,8 +7785,42 @@ export declare namespace Schemas {
7219
7785
  }) => void;
7220
7786
  }
7221
7787
 
7222
- /** @public */
7223
- export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
7788
+ /**
7789
+ * @public
7790
+ */
7791
+ export declare interface ScrollPositionValue {
7792
+ value?: {
7793
+ $case: "position";
7794
+ position: PBVector2;
7795
+ } | {
7796
+ $case: "reference";
7797
+ reference: string;
7798
+ } | undefined;
7799
+ }
7800
+
7801
+ /**
7802
+ * @public
7803
+ */
7804
+ export declare namespace ScrollPositionValue {
7805
+ export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
7806
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
7807
+ }
7808
+
7809
+ /**
7810
+ * @public
7811
+ * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
7812
+ */
7813
+ export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
7814
+
7815
+ /**
7816
+ * @public
7817
+ */
7818
+ export declare const enum ShowScrollBar {
7819
+ SSB_BOTH = 0,
7820
+ SSB_ONLY_VERTICAL = 1,
7821
+ SSB_ONLY_HORIZONTAL = 2,
7822
+ SSB_HIDDEN = 3
7823
+ }
7224
7824
 
7225
7825
  /**
7226
7826
  * @public
@@ -7298,6 +7898,9 @@ export declare namespace Texture {
7298
7898
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
7299
7899
  }
7300
7900
 
7901
+ /** @public */
7902
+ export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
7903
+
7301
7904
  /**
7302
7905
  * @public
7303
7906
  */
@@ -7390,6 +7993,9 @@ export declare interface TextureUnion {
7390
7993
  } | {
7391
7994
  $case: "videoTexture";
7392
7995
  videoTexture: VideoTexture;
7996
+ } | {
7997
+ $case: "uiTexture";
7998
+ uiTexture: UiCanvasTexture;
7393
7999
  } | undefined;
7394
8000
  }
7395
8001
 
@@ -7483,17 +8089,6 @@ export declare type TransformType = {
7483
8089
  */
7484
8090
  export declare type TransformTypeWithOptionals = Partial<TransformType>;
7485
8091
 
7486
- /** Controls the direction for animated skybox transitions */
7487
- /**
7488
- * @public
7489
- */
7490
- export declare const enum TransitionMode {
7491
- /** TM_FORWARD - transitions forward (default) */
7492
- TM_FORWARD = 0,
7493
- /** TM_BACKWARD - transitions backward */
7494
- TM_BACKWARD = 1
7495
- }
7496
-
7497
8092
  /**
7498
8093
  * @public
7499
8094
  */
@@ -7608,6 +8203,8 @@ export declare interface UiBackgroundProps {
7608
8203
  uvs?: number[];
7609
8204
  /** AvatarTexture for the background */
7610
8205
  avatarTexture?: UiAvatarTexture;
8206
+ /** VideoTexture for the background */
8207
+ videoTexture?: UiVideoTexture;
7611
8208
  /** Texture for the background */
7612
8209
  texture?: UiTexture;
7613
8210
  }
@@ -7627,9 +8224,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
7627
8224
  disabled?: boolean;
7628
8225
  }
7629
8226
 
8227
+ /** @public */
8228
+ export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
8229
+
7630
8230
  /** @public */
7631
8231
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
7632
8232
 
8233
+ /**
8234
+ * @public
8235
+ */
8236
+ export declare interface UiCanvasTexture {
8237
+ uiCanvasEntity: number;
8238
+ /** default = TextureWrapMode.Clamp */
8239
+ wrapMode?: TextureWrapMode | undefined;
8240
+ /** default = FilterMode.Bilinear */
8241
+ filterMode?: TextureFilterMode | undefined;
8242
+ }
8243
+
8244
+ /**
8245
+ * @public
8246
+ */
8247
+ export declare namespace UiCanvasTexture {
8248
+ export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
8249
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
8250
+ }
8251
+
7633
8252
  /**
7634
8253
  * @public
7635
8254
  */
@@ -7699,6 +8318,10 @@ export declare interface UiLabelProps {
7699
8318
  textAlign?: TextAlignType | undefined;
7700
8319
  /** Label font type. @defaultValue 'sans-serif' */
7701
8320
  font?: UiFontType | undefined;
8321
+ /** Outline width of the text. @defaultValue 0 */
8322
+ outlineWidth?: number | undefined;
8323
+ /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
8324
+ outlineColor?: PBColor4 | undefined;
7702
8325
  /** Behaviour when text reached. @defaultValue 'wrap' */
7703
8326
  textWrap?: UiTextWrapType | undefined;
7704
8327
  }
@@ -7708,6 +8331,9 @@ export declare interface UiLabelProps {
7708
8331
  */
7709
8332
  export declare type uint32 = number;
7710
8333
 
8334
+ /** @public */
8335
+ export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
8336
+
7711
8337
  /** @public */
7712
8338
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
7713
8339
 
@@ -7785,10 +8411,26 @@ export declare interface UiTransformProps {
7785
8411
  borderWidth?: Partial<Position> | PositionUnit;
7786
8412
  /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
7787
8413
  opacity?: number;
8414
+ /** A reference value to identify the element, default empty */
8415
+ elementId?: string;
8416
+ /** default position=(0,0) if it aplies, a vector or a reference-id */
8417
+ scrollPosition?: PBVector2 | string;
8418
+ /** default ShowScrollBar.SSB_BOTH */
8419
+ scrollVisible?: ScrollVisibleType;
7788
8420
  /** default 0 */
7789
8421
  zIndex?: number;
7790
8422
  }
7791
8423
 
8424
+ /**
8425
+ * Texture
8426
+ * @public
8427
+ */
8428
+ export declare interface UiVideoTexture {
8429
+ videoPlayerEntity: Entity;
8430
+ wrapMode?: TextureWrapType;
8431
+ filterMode?: TextureFilterType;
8432
+ }
8433
+
7792
8434
  /**
7793
8435
  * @public
7794
8436
  */