@dcl/playground-assets 7.9.5 → 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.
package/dist/alpha.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
@@ -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
@@ -2418,6 +2554,12 @@ export declare type IInputSystem = {
2418
2554
  * @returns the input command info or undefined if there is no command in the last tick-update
2419
2555
  */
2420
2556
  getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
2557
+ /**
2558
+ * @public
2559
+ * Get an ordered iterator over events received within the current frame.
2560
+ * @returns the iterator
2561
+ */
2562
+ getInputCommands: () => Generator<PBPointerEventsResult>;
2421
2563
  };
2422
2564
 
2423
2565
  /**
@@ -2681,31 +2823,8 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
2681
2823
  getOrCreateMutable(entity: Entity, initialValue?: T): T;
2682
2824
  }
2683
2825
 
2684
- export declare const LightSource: LightSourceComponentDefinitionExtended;
2685
-
2686
- /**
2687
- * @public
2688
- */
2689
- export declare interface LightSourceComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBLightSource> {
2690
- /**
2691
- * LightSource helper with constructor
2692
- */
2693
- Type: LightSourceHelper;
2694
- }
2695
-
2696
- /**
2697
- * @public
2698
- */
2699
- export declare interface LightSourceHelper {
2700
- /**
2701
- * @returns a Light Source type
2702
- */
2703
- Point: (point: PBLightSource_Point) => PBLightSource['type'];
2704
- /**
2705
- * @returns a Light Source type
2706
- */
2707
- Spot: (spot: PBLightSource_Spot) => PBLightSource['type'];
2708
- }
2826
+ /** @public */
2827
+ export declare const LightSource: LastWriteWinElementSetComponentDefinition<PBLightSource>;
2709
2828
 
2710
2829
  /**
2711
2830
  * User key event Listeners
@@ -2713,13 +2832,29 @@ export declare interface LightSourceHelper {
2713
2832
  */
2714
2833
  export declare type Listeners = {
2715
2834
  /** triggered on mouse down event */
2716
- onMouseDown?: Callback;
2835
+ onMouseDown?: EventSystemCallback;
2717
2836
  /** triggered on mouse up event */
2718
- onMouseUp?: Callback;
2837
+ onMouseUp?: EventSystemCallback;
2719
2838
  /** triggered on mouse hover event */
2720
- onMouseEnter?: Callback;
2839
+ onMouseEnter?: EventSystemCallback;
2721
2840
  /** triggered on mouse leave event */
2722
- onMouseLeave?: Callback;
2841
+ onMouseLeave?: EventSystemCallback;
2842
+ /** triggered on mouse drag event */
2843
+ onMouseDrag?: EventSystemCallback;
2844
+ /** triggered on mouse drag event */
2845
+ onMouseDragLocked?: EventSystemCallback;
2846
+ /** triggered on mouse drag event */
2847
+ onMouseDragEnd?: EventSystemCallback;
2848
+ /** triggered on input down event */
2849
+ onInputDown?: MultiCallback;
2850
+ /** triggered on input up event */
2851
+ onInputUp?: MultiCallback;
2852
+ /** triggered on input drag event */
2853
+ onInputDrag?: MultiCallback;
2854
+ /** triggered on input drag event */
2855
+ onInputDragLocked?: MultiCallback;
2856
+ /** triggered on input drag event */
2857
+ onInputDragEnd?: MultiCallback;
2723
2858
  };
2724
2859
 
2725
2860
  /**
@@ -3588,6 +3723,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
3588
3723
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
3589
3724
  */
3590
3725
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3726
+ /**
3727
+ * @public
3728
+ * Set a gltf internal mesh in the MeshCollider component
3729
+ * @param entity - entity to create or replace the MeshRenderer component
3730
+ * @param source - the path to the gltf
3731
+ * @param meshName - the name of the mesh in the gltf
3732
+ */
3733
+ setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3591
3734
  }
3592
3735
 
3593
3736
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -3624,6 +3767,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
3624
3767
  * @param entity - entity to create or replace the MeshRenderer component
3625
3768
  */
3626
3769
  setSphere(entity: Entity): void;
3770
+ /**
3771
+ * @public
3772
+ * Set a gltf internal mesh in the MeshRenderer component
3773
+ * @param entity - entity to create or replace the MeshRenderer component
3774
+ * @param source - the path to the gltf
3775
+ * @param meshName - the name of the mesh in the gltf
3776
+ */
3777
+ setGltfMesh(entity: Entity, source: string, meshName: string): void;
3627
3778
  }
3628
3779
 
3629
3780
  /**
@@ -3656,6 +3807,19 @@ export declare namespace Move {
3656
3807
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Move;
3657
3808
  }
3658
3809
 
3810
+ /**
3811
+ * a record object mapping `InputAction`s to functions.
3812
+ *
3813
+ * @example
3814
+ * onInputDown={{
3815
+ * [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
3816
+ * [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
3817
+ * }}
3818
+ *
3819
+ * @public
3820
+ */
3821
+ export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
3822
+
3659
3823
  export declare const Name: NameComponent;
3660
3824
 
3661
3825
  export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
@@ -4036,6 +4200,25 @@ export declare const onVideoEvent: Observable<{
4036
4200
  totalVideoLength: number;
4037
4201
  }>;
4038
4202
 
4203
+ /**
4204
+ * @public
4205
+ */
4206
+ export declare interface Orthographic {
4207
+ /**
4208
+ * vertical extent of the visible range in meters
4209
+ * defaults to 4m
4210
+ */
4211
+ verticalRange?: number | undefined;
4212
+ }
4213
+
4214
+ /**
4215
+ * @public
4216
+ */
4217
+ export declare namespace Orthographic {
4218
+ export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
4219
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
4220
+ }
4221
+
4039
4222
  /**
4040
4223
  * @public
4041
4224
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -4262,6 +4445,8 @@ export declare namespace PBAvatarEmoteCommand {
4262
4445
  export declare interface PBAvatarEquippedData {
4263
4446
  wearableUrns: string[];
4264
4447
  emoteUrns: string[];
4448
+ /** slots that will render even if hidden */
4449
+ forceRender: string[];
4265
4450
  }
4266
4451
 
4267
4452
  /**
@@ -4296,6 +4481,9 @@ export declare interface PBAvatarModifierArea {
4296
4481
  excludeIds: string[];
4297
4482
  /** list of modifiers to apply */
4298
4483
  modifiers: AvatarModifierType[];
4484
+ movementSettings?: AvatarMovementSettings | undefined;
4485
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4486
+ useColliderRange?: boolean | undefined;
4299
4487
  }
4300
4488
 
4301
4489
  /**
@@ -4352,8 +4540,8 @@ export declare interface PBAvatarShape {
4352
4540
  wearables: string[];
4353
4541
  /** available emotes (default empty) */
4354
4542
  emotes: string[];
4355
- /** hides the skin + hair + facial features (default: false) */
4356
- showOnlyWearables?: boolean | undefined;
4543
+ /** slots that will render even if hidden */
4544
+ forceRender: string[];
4357
4545
  }
4358
4546
 
4359
4547
  /**
@@ -4388,6 +4576,51 @@ export declare namespace PBBillboard {
4388
4576
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
4389
4577
  }
4390
4578
 
4579
+ /**
4580
+ * @public
4581
+ */
4582
+ export declare interface PBCameraLayer {
4583
+ /**
4584
+ * layer to which these settings apply. must be > 0
4585
+ * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
4586
+ */
4587
+ layer: number;
4588
+ /** should the sun light affect this layer? default false */
4589
+ directionalLight?: boolean | undefined;
4590
+ /** should this layer show player avatars? default false */
4591
+ showAvatars?: boolean | undefined;
4592
+ /** should this layer show the sky? default false */
4593
+ showSkybox?: boolean | undefined;
4594
+ /** should this layer show distance fog? default false */
4595
+ showFog?: boolean | undefined;
4596
+ /** ambient light overrides for this layer. default -> use same as main camera */
4597
+ ambientColorOverride?: PBColor3 | undefined;
4598
+ ambientBrightnessOverride?: number | undefined;
4599
+ }
4600
+
4601
+ /**
4602
+ * @public
4603
+ */
4604
+ export declare namespace PBCameraLayer {
4605
+ export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
4606
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
4607
+ }
4608
+
4609
+ /**
4610
+ * @public
4611
+ */
4612
+ export declare interface PBCameraLayers {
4613
+ layers: number[];
4614
+ }
4615
+
4616
+ /**
4617
+ * @public
4618
+ */
4619
+ export declare namespace PBCameraLayers {
4620
+ export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
4621
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
4622
+ }
4623
+
4391
4624
  /**
4392
4625
  * The CameraMode component can be used to determine whether the player is using a first-person o
4393
4626
  * third-person view.
@@ -4410,7 +4643,7 @@ export declare namespace PBCameraMode {
4410
4643
 
4411
4644
  /**
4412
4645
  * The CameraModeArea component can be attached to an Entity to define a region of space where
4413
- * the player's camera mode (1st-person or 3rd-person) is overridden.
4646
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
4414
4647
  *
4415
4648
  * The Entity's Transform position determines the center-point of the region, while its size is
4416
4649
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -4420,6 +4653,8 @@ export declare namespace PBCameraMode {
4420
4653
  *
4421
4654
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
4422
4655
  * is actually a 3D volume.
4656
+ *
4657
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
4423
4658
  */
4424
4659
  /**
4425
4660
  * @public
@@ -4429,6 +4664,9 @@ export declare interface PBCameraModeArea {
4429
4664
  area: PBVector3 | undefined;
4430
4665
  /** the camera mode to enforce */
4431
4666
  mode: CameraType;
4667
+ cinematicSettings?: CinematicSettings | undefined;
4668
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4669
+ useColliderRange?: boolean | undefined;
4432
4670
  }
4433
4671
 
4434
4672
  /**
@@ -4500,6 +4738,39 @@ export declare namespace PBEngineInfo {
4500
4738
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
4501
4739
  }
4502
4740
 
4741
+ /**
4742
+ * defines the global scene light settings. must be added to the scene root.
4743
+ * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
4744
+ */
4745
+ /**
4746
+ * @public
4747
+ */
4748
+ export declare interface PBGlobalLight {
4749
+ /**
4750
+ * the direction the directional light shines in.
4751
+ * default depends on time of day and explorer implementation
4752
+ */
4753
+ direction?: PBVector3 | undefined;
4754
+ /**
4755
+ * ambient light color
4756
+ * default: White
4757
+ */
4758
+ ambientColor?: PBColor3 | undefined;
4759
+ /**
4760
+ * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
4761
+ * default 1
4762
+ */
4763
+ ambientBrightness?: number | undefined;
4764
+ }
4765
+
4766
+ /**
4767
+ * @public
4768
+ */
4769
+ export declare namespace PBGlobalLight {
4770
+ export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
4771
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
4772
+ }
4773
+
4503
4774
  /**
4504
4775
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
4505
4776
  *
@@ -4535,6 +4806,25 @@ export declare namespace PBGltfContainer {
4535
4806
  */
4536
4807
  export declare interface PBGltfContainerLoadingState {
4537
4808
  currentState: LoadingState;
4809
+ /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
4810
+ nodePaths: string[];
4811
+ /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
4812
+ meshNames: string[];
4813
+ /**
4814
+ * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
4815
+ * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
4816
+ */
4817
+ materialNames: string[];
4818
+ /**
4819
+ * X is the material index. note this may conflict with manually named materials - to avoid any issues make
4820
+ * sure all your materials are explicitly named.
4821
+ */
4822
+ skinNames: string[];
4823
+ /**
4824
+ * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
4825
+ * your skins are explicitly named.
4826
+ */
4827
+ animationNames: string[];
4538
4828
  }
4539
4829
 
4540
4830
  /**
@@ -4546,48 +4836,74 @@ export declare namespace PBGltfContainerLoadingState {
4546
4836
  }
4547
4837
 
4548
4838
  /**
4549
- * GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
4839
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
4840
+ * This component must be added to a direct child of an entity with a PBGltfContainer component, or
4841
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
4842
+ * in the parent.
4843
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
4844
+ *
4845
+ * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
4846
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
4847
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
4848
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
4849
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
4550
4850
  *
4551
- * This allows to override either the Material or the Casting Shadows behaviour of the target GLTF Node.
4851
+ * After creation, if an animation moves the node, the `Transform` will be updated.
4552
4852
  *
4553
- * * If the 'path' of the first modifier in the collection is an empty string: the configuration will
4554
- * affect all of the GLTF Nodes (as a global modifier).
4555
- * * Otherwise, for the modifiers whose 'path' is found in the GLTF hierarchy, the modifier will affect only
4556
- * the target Nodes.
4853
+ * From the scene, you can modify various components to alter the gltf node:
4854
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
4855
+ * regardless of any intermediate gltf node hierarchy.
4856
+ * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
4857
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
4858
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
4859
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
4860
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
4861
+ * 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
4862
+ * PBMaterial will be maintained.
4863
+ *
4864
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
4865
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
4866
+ * change the state to `GNS_FAILED`.
4867
+ * - deleting the scene entity will not delete the gltf node.
4868
+ *
4869
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
4870
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
4871
+ * the gltf node will also be displayed.
4557
4872
  */
4558
4873
  /**
4559
4874
  * @public
4560
4875
  */
4561
- export declare interface PBGltfNodeModifiers {
4562
- modifiers: PBGltfNodeModifiers_GltfNodeModifier[];
4876
+ export declare interface PBGltfNode {
4877
+ /** the path of the target node in the Gltf. */
4878
+ path: string;
4563
4879
  }
4564
4880
 
4565
4881
  /**
4566
4882
  * @public
4567
4883
  */
4568
- export declare namespace PBGltfNodeModifiers {
4569
- export function encode(message: PBGltfNodeModifiers, writer?: _m0.Writer): _m0.Writer;
4570
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers;
4884
+ export declare namespace PBGltfNode {
4885
+ export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
4886
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
4571
4887
  }
4572
4888
 
4889
+ /**
4890
+ * The state of a linked gltf node.
4891
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
4892
+ */
4573
4893
  /**
4574
4894
  * @public
4575
4895
  */
4576
- export declare interface PBGltfNodeModifiers_GltfNodeModifier {
4577
- /** The GLTF hierarchy path of the target Node to be affected */
4578
- path: string;
4579
- /** The casting shadows enabled override */
4580
- castShadows?: boolean | undefined;
4581
- /** The Material that will be overridden on the target Node */
4582
- material?: PBMaterial | undefined;
4896
+ export declare interface PBGltfNodeState {
4897
+ state: GltfNodeStateValue;
4898
+ error?: string | undefined;
4583
4899
  }
4584
4900
 
4585
4901
  /**
4586
4902
  * @public
4587
4903
  */
4588
- export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
4589
- export function encode(message: PBGltfNodeModifiers_GltfNodeModifier, writer?: _m0.Writer): _m0.Writer;
4590
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
4904
+ export declare namespace PBGltfNodeState {
4905
+ export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
4906
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
4591
4907
  }
4592
4908
 
4593
4909
  /**
@@ -4725,6 +5041,14 @@ export declare interface PBMaterial {
4725
5041
  $case: "pbr";
4726
5042
  pbr: PBMaterial_PbrMaterial;
4727
5043
  } | undefined;
5044
+ /**
5045
+ * A gltf material that may provide additional features not supported by the PbMaterial fields.
5046
+ * If both gltf and material fields are provided, the gltf will be used only for extended features not
5047
+ * supported by the PbMaterial.
5048
+ * If this is provided and the `material` field is not provided, the renderer will update the material
5049
+ * field with data that reflects the gltf material once it is loaded.
5050
+ */
5051
+ gltf?: PBMaterial_GltfMaterial | undefined;
4728
5052
  }
4729
5053
 
4730
5054
  /**
@@ -4735,6 +5059,22 @@ export declare namespace PBMaterial {
4735
5059
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
4736
5060
  }
4737
5061
 
5062
+ /**
5063
+ * @public
5064
+ */
5065
+ export declare interface PBMaterial_GltfMaterial {
5066
+ gltfSrc: string;
5067
+ name: string;
5068
+ }
5069
+
5070
+ /**
5071
+ * @public
5072
+ */
5073
+ export declare namespace PBMaterial_GltfMaterial {
5074
+ export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
5075
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
5076
+ }
5077
+
4738
5078
  /**
4739
5079
  * @public
4740
5080
  */
@@ -4831,6 +5171,9 @@ export declare interface PBMeshCollider {
4831
5171
  } | {
4832
5172
  $case: "plane";
4833
5173
  plane: PBMeshCollider_PlaneMesh;
5174
+ } | {
5175
+ $case: "gltf";
5176
+ gltf: PBMeshCollider_GltfMesh;
4834
5177
  } | undefined;
4835
5178
  }
4836
5179
 
@@ -4876,6 +5219,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
4876
5219
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
4877
5220
  }
4878
5221
 
5222
+ /** A collider constructed from a Gltf Mesh. */
5223
+ /**
5224
+ * @public
5225
+ */
5226
+ export declare interface PBMeshCollider_GltfMesh {
5227
+ /** the GLTF file path as listed in the scene's manifest. */
5228
+ gltfSrc: string;
5229
+ /** the name of the mesh asset */
5230
+ name: string;
5231
+ }
5232
+
5233
+ /**
5234
+ * @public
5235
+ */
5236
+ export declare namespace PBMeshCollider_GltfMesh {
5237
+ export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5238
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
5239
+ }
5240
+
4879
5241
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
4880
5242
  /**
4881
5243
  * @public
@@ -4908,13 +5270,11 @@ export declare namespace PBMeshCollider_SphereMesh {
4908
5270
 
4909
5271
  /**
4910
5272
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
4911
- * plane, a sphere or a cylinder.
5273
+ * plane, a sphere, a cylinder, or a Gltf mesh.
4912
5274
  *
4913
5275
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
4914
5276
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
4915
5277
  * `float` coordinates, one for each corner of each side of each face.
4916
- *
4917
- * More complex shapes require the use of a `GltfContainer` component.
4918
5278
  */
4919
5279
  /**
4920
5280
  * @public
@@ -4932,6 +5292,9 @@ export declare interface PBMeshRenderer {
4932
5292
  } | {
4933
5293
  $case: "plane";
4934
5294
  plane: PBMeshRenderer_PlaneMesh;
5295
+ } | {
5296
+ $case: "gltf";
5297
+ gltf: PBMeshRenderer_GltfMesh;
4935
5298
  } | undefined;
4936
5299
  }
4937
5300
 
@@ -4979,6 +5342,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
4979
5342
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
4980
5343
  }
4981
5344
 
5345
+ /** A mesh from a Gltf. */
5346
+ /**
5347
+ * @public
5348
+ */
5349
+ export declare interface PBMeshRenderer_GltfMesh {
5350
+ /** the GLTF file path as listed in the scene's manifest. */
5351
+ gltfSrc: string;
5352
+ /** the name of the mesh asset */
5353
+ name: string;
5354
+ }
5355
+
5356
+ /**
5357
+ * @public
5358
+ */
5359
+ export declare namespace PBMeshRenderer_GltfMesh {
5360
+ export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5361
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
5362
+ }
5363
+
4982
5364
  /** PlaneMesh renders a 2D rectangular shape. */
4983
5365
  /**
4984
5366
  * @public
@@ -5227,7 +5609,10 @@ export declare interface PBPrimaryPointerInfo {
5227
5609
  screenCoordinates?: PBVector2 | undefined;
5228
5610
  /** Movement since last frame (pixels) */
5229
5611
  screenDelta?: PBVector2 | undefined;
5230
- /** Direction vector for 3D ray casting */
5612
+ /**
5613
+ * ray direction that can be used with the primary camera origin for
5614
+ * raycasting from the cursor into the world
5615
+ */
5231
5616
  worldRayDirection?: PBVector3 | undefined;
5232
5617
  }
5233
5618
 
@@ -5367,28 +5752,6 @@ export declare namespace PBRealmInfo {
5367
5752
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
5368
5753
  }
5369
5754
 
5370
- /**
5371
- * The SkyboxTime component allows controlling the time of day for the skybox,
5372
- * affecting the lighting and appearance of the sky in the scene.
5373
- */
5374
- /**
5375
- * @public
5376
- */
5377
- export declare interface PBSkyboxTime {
5378
- /** 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 */
5379
- fixedTime: number;
5380
- /** default = TransitionMode.TM_FORWARD, controls the direction of time transitions */
5381
- transitionMode?: TransitionMode | undefined;
5382
- }
5383
-
5384
- /**
5385
- * @public
5386
- */
5387
- export declare namespace PBSkyboxTime {
5388
- export function encode(message: PBSkyboxTime, writer?: _m0.Writer): _m0.Writer;
5389
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
5390
- }
5391
-
5392
5755
  /**
5393
5756
  * The TextShape component renders customizable floating text.
5394
5757
  *
@@ -5453,6 +5816,46 @@ export declare namespace PBTextShape {
5453
5816
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
5454
5817
  }
5455
5818
 
5819
+ /**
5820
+ * @public
5821
+ */
5822
+ export declare interface PBTextureCamera {
5823
+ /** rendered texture width */
5824
+ width?: number | undefined;
5825
+ /** rendered texture height */
5826
+ height?: number | undefined;
5827
+ /**
5828
+ * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
5829
+ * defaults to 0
5830
+ */
5831
+ layer?: number | undefined;
5832
+ /** default black */
5833
+ clearColor?: PBColor4 | undefined;
5834
+ /** default infinity */
5835
+ farPlane?: number | undefined;
5836
+ mode?: {
5837
+ $case: "perspective";
5838
+ perspective: Perspective;
5839
+ } | {
5840
+ $case: "orthographic";
5841
+ orthographic: Orthographic;
5842
+ } | undefined;
5843
+ /**
5844
+ * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
5845
+ * range: 0 (off) - 1 (full volume)
5846
+ * default: 0
5847
+ */
5848
+ volume?: number | undefined;
5849
+ }
5850
+
5851
+ /**
5852
+ * @public
5853
+ */
5854
+ export declare namespace PBTextureCamera {
5855
+ export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
5856
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
5857
+ }
5858
+
5456
5859
  /**
5457
5860
  * @public
5458
5861
  */
@@ -5542,6 +5945,25 @@ export declare namespace PBUiBackground {
5542
5945
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
5543
5946
  }
5544
5947
 
5948
+ /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
5949
+ /**
5950
+ * @public
5951
+ */
5952
+ export declare interface PBUiCanvas {
5953
+ width: number;
5954
+ height: number;
5955
+ /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
5956
+ color?: PBColor4 | undefined;
5957
+ }
5958
+
5959
+ /**
5960
+ * @public
5961
+ */
5962
+ export declare namespace PBUiCanvas {
5963
+ export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
5964
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
5965
+ }
5966
+
5545
5967
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
5546
5968
  /**
5547
5969
  * @public
@@ -5658,6 +6080,21 @@ export declare namespace PBUiInputResult {
5658
6080
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
5659
6081
  }
5660
6082
 
6083
+ /**
6084
+ * @public
6085
+ */
6086
+ export declare interface PBUiScrollResult {
6087
+ value: PBVector2 | undefined;
6088
+ }
6089
+
6090
+ /**
6091
+ * @public
6092
+ */
6093
+ export declare namespace PBUiScrollResult {
6094
+ export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
6095
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
6096
+ }
6097
+
5661
6098
  /**
5662
6099
  * @public
5663
6100
  */
@@ -5674,6 +6111,10 @@ export declare interface PBUiText {
5674
6111
  fontSize?: number | undefined;
5675
6112
  /** wrap text when the border is reached (default: TW_WRAP) */
5676
6113
  textWrap?: TextWrap | undefined;
6114
+ /** width of the outline (default: 0) */
6115
+ outlineWidth?: number | undefined;
6116
+ /** RGBA color of the outline (default: opaque black) */
6117
+ outlineColor?: PBColor4 | undefined;
5677
6118
  }
5678
6119
 
5679
6120
  /**
@@ -5801,6 +6242,12 @@ export declare interface PBUiTransform {
5801
6242
  borderRightColor?: PBColor4 | undefined;
5802
6243
  /** default: 1 */
5803
6244
  opacity?: number | undefined;
6245
+ /** reference for scroll_position. default empty */
6246
+ elementId?: string | undefined;
6247
+ /** default position=(0,0) */
6248
+ scrollPosition?: ScrollPositionValue | undefined;
6249
+ /** default ShowScrollBar.SSB_BOTH */
6250
+ scrollVisible?: ShowScrollBar | undefined;
5804
6251
  /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
5805
6252
  zIndex?: number | undefined;
5806
6253
  }
@@ -5932,6 +6379,25 @@ export declare namespace PBVisibilityComponent {
5932
6379
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
5933
6380
  }
5934
6381
 
6382
+ /**
6383
+ * @public
6384
+ */
6385
+ export declare interface Perspective {
6386
+ /**
6387
+ * vertical field of view in radians
6388
+ * defaults to pi/4 = 45 degrees
6389
+ */
6390
+ fieldOfView?: number | undefined;
6391
+ }
6392
+
6393
+ /**
6394
+ * @public
6395
+ */
6396
+ export declare namespace Perspective {
6397
+ export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
6398
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
6399
+ }
6400
+
5935
6401
  /**
5936
6402
  * Represens a plane by the equation ax + by + cz + d = 0
5937
6403
  * @public
@@ -6087,11 +6553,37 @@ export declare interface PointerEventsSystem {
6087
6553
  * @param entity - Entity where the callback was attached
6088
6554
  */
6089
6555
  removeOnPointerHoverLeave(entity: Entity): void;
6556
+ /**
6557
+ * @public
6558
+ * Remove the callback for onPointerDrag event
6559
+ * @param entity - Entity where the callback was attached
6560
+ */
6561
+ removeOnPointerDrag(entity: Entity): void;
6562
+ /**
6563
+ * @public
6564
+ * Remove the callback for onPointerDragLocked event
6565
+ * @param entity - Entity where the callback was attached
6566
+ */
6567
+ removeOnPointerDragLocked(entity: Entity): void;
6568
+ /**
6569
+ * @public
6570
+ * Remove the callback for onPointerDragEnd event
6571
+ * @param entity - Entity where the callback was attached
6572
+ */
6573
+ removeOnPointerDragEnd(entity: Entity): void;
6574
+ /**
6575
+ * @public
6576
+ * Execute callbacks when the user presses one of the InputButtons pointing at the entity
6577
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6578
+ */
6579
+ onPointerDown(pointerData: {
6580
+ entity: Entity;
6581
+ optsList: EventSystemOptionsCallback[];
6582
+ }): void;
6090
6583
  /**
6091
6584
  * @public
6092
6585
  * Execute callback when the user press the InputButton pointing at the entity
6093
6586
  * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
6094
- * @param cb - Function to execute when click fires
6095
6587
  */
6096
6588
  onPointerDown(pointerData: {
6097
6589
  entity: Entity;
@@ -6104,6 +6596,15 @@ export declare interface PointerEventsSystem {
6104
6596
  * @param opts - Opts to trigger Feedback and Button
6105
6597
  */
6106
6598
  onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
6599
+ /**
6600
+ * @public
6601
+ * Execute callbacks when the user releases one of the InputButtons pointing at the entity
6602
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6603
+ */
6604
+ onPointerUp(pointerData: {
6605
+ entity: Entity;
6606
+ optsList: EventSystemOptionsCallback[];
6607
+ }): void;
6107
6608
  /**
6108
6609
  * @public
6109
6610
  * Execute callback when the user releases the InputButton pointing at the entity
@@ -6141,6 +6642,64 @@ export declare interface PointerEventsSystem {
6141
6642
  entity: Entity;
6142
6643
  opts?: Partial<EventSystemOptions>;
6143
6644
  }, cb: EventSystemCallback): void;
6645
+ /**
6646
+ * @public
6647
+ * Execute callbacks when the user drags the pointer from inside the entity
6648
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6649
+ */
6650
+ onPointerDrag(pointerData: {
6651
+ entity: Entity;
6652
+ optsList: EventSystemOptionsCallback[];
6653
+ }): void;
6654
+ /**
6655
+ * @public
6656
+ * Execute callback when the user clicks and drags the pointer from inside the entity
6657
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6658
+ * @param cb - Function to execute when click fires
6659
+ */
6660
+ onPointerDrag(pointerData: {
6661
+ entity: Entity;
6662
+ opts?: Partial<EventSystemOptions>;
6663
+ }, cb: EventSystemCallback): void;
6664
+ /**
6665
+ * @public
6666
+ * Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
6667
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6668
+ */
6669
+ onPointerDragLocked(pointerData: {
6670
+ entity: Entity;
6671
+ optsList: EventSystemOptionsCallback[];
6672
+ }): void;
6673
+ /**
6674
+ * @public
6675
+ * Execute callback when the user clicks and drags the pointer from inside the entity,
6676
+ * locking the cursor in place
6677
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6678
+ * @param cb - Function to execute when click fires
6679
+ */
6680
+ onPointerDragLocked(pointerData: {
6681
+ entity: Entity;
6682
+ opts?: Partial<EventSystemOptions>;
6683
+ }, cb: EventSystemCallback): void;
6684
+ /**
6685
+ * @public
6686
+ * Execute callbacks when the user releases a button after a drag
6687
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6688
+ */
6689
+ onPointerDragEnd(pointerData: {
6690
+ entity: Entity;
6691
+ optsList: EventSystemOptionsCallback[];
6692
+ }): void;
6693
+ /**
6694
+ * @public
6695
+ * Execute callback when the user releases the button after a drag
6696
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6697
+ * @param cb - Function to execute when click fires
6698
+ */
6699
+ onPointerDragEnd(pointerData: {
6700
+ entity: Entity;
6701
+ opts?: Partial<EventSystemOptions>;
6702
+ }, cb: EventSystemCallback): void;
6144
6703
  }
6145
6704
 
6146
6705
  /**
@@ -6157,7 +6716,10 @@ export declare const enum PointerEventType {
6157
6716
  PET_UP = 0,
6158
6717
  PET_DOWN = 1,
6159
6718
  PET_HOVER_ENTER = 2,
6160
- PET_HOVER_LEAVE = 3
6719
+ PET_HOVER_LEAVE = 3,
6720
+ PET_DRAG_LOCKED = 4,
6721
+ PET_DRAG = 5,
6722
+ PET_DRAG_END = 6
6161
6723
  }
6162
6724
 
6163
6725
  /**
@@ -6188,7 +6750,10 @@ export declare const enum PointerType {
6188
6750
  /** POT_NONE - No pointer input */
6189
6751
  POT_NONE = 0,
6190
6752
  /** POT_MOUSE - Traditional mouse input */
6191
- POT_MOUSE = 1
6753
+ POT_MOUSE = 1,
6754
+ POT_PAD = 2,
6755
+ POT_TOUCH = 3,
6756
+ POT_WAND = 4
6192
6757
  }
6193
6758
 
6194
6759
  /**
@@ -6785,6 +7350,7 @@ export declare type RaycastSystemOptions = {
6785
7350
  export declare interface ReactBasedUiSystem {
6786
7351
  destroy(): void;
6787
7352
  setUiRenderer(ui: UiComponent): void;
7353
+ setTextureRenderer(entity: Entity, ui: UiComponent): void;
6788
7354
  }
6789
7355
 
6790
7356
  /**
@@ -7247,8 +7813,42 @@ export declare namespace Schemas {
7247
7813
  }) => void;
7248
7814
  }
7249
7815
 
7250
- /** @public */
7251
- export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
7816
+ /**
7817
+ * @public
7818
+ */
7819
+ export declare interface ScrollPositionValue {
7820
+ value?: {
7821
+ $case: "position";
7822
+ position: PBVector2;
7823
+ } | {
7824
+ $case: "reference";
7825
+ reference: string;
7826
+ } | undefined;
7827
+ }
7828
+
7829
+ /**
7830
+ * @public
7831
+ */
7832
+ export declare namespace ScrollPositionValue {
7833
+ export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
7834
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
7835
+ }
7836
+
7837
+ /**
7838
+ * @public
7839
+ * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
7840
+ */
7841
+ export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
7842
+
7843
+ /**
7844
+ * @public
7845
+ */
7846
+ export declare const enum ShowScrollBar {
7847
+ SSB_BOTH = 0,
7848
+ SSB_ONLY_VERTICAL = 1,
7849
+ SSB_ONLY_HORIZONTAL = 2,
7850
+ SSB_HIDDEN = 3
7851
+ }
7252
7852
 
7253
7853
  /**
7254
7854
  * @public
@@ -7331,6 +7931,9 @@ export declare namespace Texture {
7331
7931
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
7332
7932
  }
7333
7933
 
7934
+ /** @public */
7935
+ export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
7936
+
7334
7937
  /**
7335
7938
  * @public
7336
7939
  */
@@ -7423,6 +8026,9 @@ export declare interface TextureUnion {
7423
8026
  } | {
7424
8027
  $case: "videoTexture";
7425
8028
  videoTexture: VideoTexture;
8029
+ } | {
8030
+ $case: "uiTexture";
8031
+ uiTexture: UiCanvasTexture;
7426
8032
  } | undefined;
7427
8033
  }
7428
8034
 
@@ -7516,17 +8122,6 @@ export declare type TransformType = {
7516
8122
  */
7517
8123
  export declare type TransformTypeWithOptionals = Partial<TransformType>;
7518
8124
 
7519
- /** Controls the direction for animated skybox transitions */
7520
- /**
7521
- * @public
7522
- */
7523
- export declare const enum TransitionMode {
7524
- /** TM_FORWARD - transitions forward (default) */
7525
- TM_FORWARD = 0,
7526
- /** TM_BACKWARD - transitions backward */
7527
- TM_BACKWARD = 1
7528
- }
7529
-
7530
8125
  /**
7531
8126
  * @public
7532
8127
  */
@@ -7641,6 +8236,8 @@ export declare interface UiBackgroundProps {
7641
8236
  uvs?: number[];
7642
8237
  /** AvatarTexture for the background */
7643
8238
  avatarTexture?: UiAvatarTexture;
8239
+ /** VideoTexture for the background */
8240
+ videoTexture?: UiVideoTexture;
7644
8241
  /** Texture for the background */
7645
8242
  texture?: UiTexture;
7646
8243
  }
@@ -7660,9 +8257,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
7660
8257
  disabled?: boolean;
7661
8258
  }
7662
8259
 
8260
+ /** @public */
8261
+ export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
8262
+
7663
8263
  /** @public */
7664
8264
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
7665
8265
 
8266
+ /**
8267
+ * @public
8268
+ */
8269
+ export declare interface UiCanvasTexture {
8270
+ uiCanvasEntity: number;
8271
+ /** default = TextureWrapMode.Clamp */
8272
+ wrapMode?: TextureWrapMode | undefined;
8273
+ /** default = FilterMode.Bilinear */
8274
+ filterMode?: TextureFilterMode | undefined;
8275
+ }
8276
+
8277
+ /**
8278
+ * @public
8279
+ */
8280
+ export declare namespace UiCanvasTexture {
8281
+ export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
8282
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
8283
+ }
8284
+
7666
8285
  /**
7667
8286
  * @public
7668
8287
  */
@@ -7732,6 +8351,10 @@ export declare interface UiLabelProps {
7732
8351
  textAlign?: TextAlignType | undefined;
7733
8352
  /** Label font type. @defaultValue 'sans-serif' */
7734
8353
  font?: UiFontType | undefined;
8354
+ /** Outline width of the text. @defaultValue 0 */
8355
+ outlineWidth?: number | undefined;
8356
+ /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
8357
+ outlineColor?: PBColor4 | undefined;
7735
8358
  /** Behaviour when text reached. @defaultValue 'wrap' */
7736
8359
  textWrap?: UiTextWrapType | undefined;
7737
8360
  }
@@ -7741,6 +8364,9 @@ export declare interface UiLabelProps {
7741
8364
  */
7742
8365
  export declare type uint32 = number;
7743
8366
 
8367
+ /** @public */
8368
+ export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
8369
+
7744
8370
  /** @public */
7745
8371
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
7746
8372
 
@@ -7818,10 +8444,26 @@ export declare interface UiTransformProps {
7818
8444
  borderWidth?: Partial<Position> | PositionUnit;
7819
8445
  /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
7820
8446
  opacity?: number;
8447
+ /** A reference value to identify the element, default empty */
8448
+ elementId?: string;
8449
+ /** default position=(0,0) if it aplies, a vector or a reference-id */
8450
+ scrollPosition?: PBVector2 | string;
8451
+ /** default ShowScrollBar.SSB_BOTH */
8452
+ scrollVisible?: ScrollVisibleType;
7821
8453
  /** default 0 */
7822
8454
  zIndex?: number;
7823
8455
  }
7824
8456
 
8457
+ /**
8458
+ * Texture
8459
+ * @public
8460
+ */
8461
+ export declare interface UiVideoTexture {
8462
+ videoPlayerEntity: Entity;
8463
+ wrapMode?: TextureWrapType;
8464
+ filterMode?: TextureFilterType;
8465
+ }
8466
+
7825
8467
  /**
7826
8468
  * @public
7827
8469
  */