@dcl/playground-assets 7.13.1-19324737285.commit-cb42004 → 7.13.1-19516109426.commit-e1e79aa

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/beta.d.ts CHANGED
@@ -178,12 +178,33 @@ 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
196
  /** @public */
185
197
  export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
186
198
 
199
+ /**
200
+ * @public
201
+ */
202
+ export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
203
+
204
+ export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
205
+ forceRender?: string[] | undefined;
206
+ };
207
+
187
208
  /** @public */
188
209
  export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
189
210
 
@@ -198,9 +219,49 @@ export declare const enum AvatarModifierType {
198
219
  AMT_DISABLE_PASSPORTS = 1
199
220
  }
200
221
 
222
+ /**
223
+ * @public
224
+ */
225
+ export declare interface AvatarMovementSettings {
226
+ controlMode?: AvatarControlType | undefined;
227
+ /** if not explicitly set, the following properties default to user's preference settings */
228
+ runSpeed?: number | undefined;
229
+ /** how fast the player gets up to speed or comes to rest. higher = more responsive */
230
+ friction?: number | undefined;
231
+ /** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
232
+ gravity?: number | undefined;
233
+ /** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
234
+ jumpHeight?: number | undefined;
235
+ /** max fall speed in m/s. should normally be negative */
236
+ maxFallSpeed?: number | undefined;
237
+ /** speed the player turns in tank mode, in radians/s */
238
+ turnSpeed?: number | undefined;
239
+ /** speed the player walks at, in m/s */
240
+ walkSpeed?: number | undefined;
241
+ /** 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 */
242
+ allowWeightedMovement?: boolean | undefined;
243
+ }
244
+
245
+ /**
246
+ * @public
247
+ */
248
+ export declare namespace AvatarMovementSettings {
249
+ export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
250
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
251
+ }
252
+
201
253
  /** @public */
202
254
  export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
203
255
 
256
+ /**
257
+ * @public
258
+ */
259
+ export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
260
+
261
+ export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
262
+ forceRender?: string[] | undefined;
263
+ };
264
+
204
265
  /**
205
266
  * @public
206
267
  */
@@ -468,11 +529,19 @@ export declare interface ByteBuffer {
468
529
  }
469
530
 
470
531
  /**
471
- * Callback function to be triggered on a specified event
472
- * @public
532
+ * legacy Callback function
533
+ *
534
+ * @public @deprecated This type is no longer used in the sdk api, EventSystemCallback is
535
+ * used for listeners instead
473
536
  */
474
537
  export declare type Callback = () => void;
475
538
 
539
+ /** @public */
540
+ export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
541
+
542
+ /** @public */
543
+ export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
544
+
476
545
  /** @public */
477
546
  export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
478
547
 
@@ -530,6 +599,39 @@ export declare const enum CameraType {
530
599
 
531
600
  export declare type Children = ReactEcs.JSX.ReactNode;
532
601
 
602
+ /**
603
+ * @public
604
+ */
605
+ export declare interface CinematicSettings {
606
+ /** Entity that defines the cinematic camera transform. */
607
+ cameraEntity: number;
608
+ /**
609
+ * Position -> camera's position
610
+ * Rotation -> camera's direction
611
+ * scale.z -> zoom level
612
+ * scale.x and scale.y -> unused
613
+ */
614
+ allowManualRotation?: boolean | undefined;
615
+ /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
616
+ yawRange?: number | undefined;
617
+ /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
618
+ pitchRange?: number | undefined;
619
+ /** note: cameras can never look up/down further than Vec3::Y */
620
+ rollRange?: number | undefined;
621
+ /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
622
+ zoomMin?: number | undefined;
623
+ /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
624
+ zoomMax?: number | undefined;
625
+ }
626
+
627
+ /**
628
+ * @public
629
+ */
630
+ export declare namespace CinematicSettings {
631
+ export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
632
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
633
+ }
634
+
533
635
  /** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
534
636
  /**
535
637
  * @public
@@ -1304,12 +1406,17 @@ export declare const componentDefinitionByName: {
1304
1406
  "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
1305
1407
  "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
1306
1408
  "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
1409
+ "core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
1410
+ "core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
1307
1411
  "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
1308
1412
  "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
1309
1413
  "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
1414
+ "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
1310
1415
  "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
1311
1416
  "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
1417
+ "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
1312
1418
  "core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
1419
+ "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
1313
1420
  "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
1314
1421
  "core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
1315
1422
  "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
@@ -1327,17 +1434,20 @@ export declare const componentDefinitionByName: {
1327
1434
  "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
1328
1435
  "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
1329
1436
  "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
1437
+ "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
1330
1438
  "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
1331
1439
  "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
1332
1440
  "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
1333
1441
  "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
1334
1442
  "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
1335
1443
  "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
1444
+ "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
1336
1445
  "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
1337
1446
  "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
1338
1447
  "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
1339
1448
  "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
1340
1449
  "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
1450
+ "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
1341
1451
  "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
1342
1452
  "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
1343
1453
  "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -1904,10 +2014,18 @@ export declare type EntityComponents = {
1904
2014
  uiBackground: PBUiBackground;
1905
2015
  uiInput: PBUiInput;
1906
2016
  uiDropdown: PBUiDropdown;
1907
- onMouseDown: Callback;
1908
- onMouseUp: Callback;
1909
- onMouseEnter: Callback;
1910
- onMouseLeave: Callback;
2017
+ onMouseDown: EventSystemCallback;
2018
+ onMouseUp: EventSystemCallback;
2019
+ onMouseEnter: EventSystemCallback;
2020
+ onMouseLeave: EventSystemCallback;
2021
+ onMouseDrag: EventSystemCallback;
2022
+ onMouseDragLocked: EventSystemCallback;
2023
+ onMouseDragEnd: EventSystemCallback;
2024
+ onInputDown: MultiCallback;
2025
+ onInputUp: MultiCallback;
2026
+ onInputDrag: MultiCallback;
2027
+ onInputDragLocked: MultiCallback;
2028
+ onInputDragEnd: MultiCallback;
1911
2029
  };
1912
2030
 
1913
2031
  /** @public */
@@ -1985,6 +2103,13 @@ export declare type EventSystemOptions = {
1985
2103
  showHighlight?: boolean;
1986
2104
  };
1987
2105
 
2106
+ /**
2107
+ * @public
2108
+ */
2109
+ export declare type EventSystemOptionsCallback = EventSystemOptions & {
2110
+ cb: EventSystemCallback;
2111
+ };
2112
+
1988
2113
  /**
1989
2114
  * Excludes property keys from T where the property is assignable to U
1990
2115
  * @public
@@ -2059,6 +2184,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
2059
2184
  direction?: PBVector3;
2060
2185
  };
2061
2186
 
2187
+ /** @public */
2188
+ export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
2189
+
2062
2190
  export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
2063
2191
 
2064
2192
  export declare type GlobalTargetRaycastSystemOptions = {
@@ -2071,9 +2199,24 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
2071
2199
  /** @public */
2072
2200
  export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
2073
2201
 
2202
+ /** @public */
2203
+ export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
2204
+
2074
2205
  /** @public */
2075
2206
  export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
2076
2207
 
2208
+ /** @public */
2209
+ export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
2210
+
2211
+ /**
2212
+ * @public
2213
+ */
2214
+ export declare const enum GltfNodeStateValue {
2215
+ GNSV_PENDING = 0,
2216
+ GNSV_FAILED = 1,
2217
+ GNSV_READY = 2
2218
+ }
2219
+
2077
2220
  /**
2078
2221
  * @public
2079
2222
  */
@@ -2419,6 +2562,12 @@ export declare type IInputSystem = {
2419
2562
  * @returns the input command info or undefined if there is no command in the last tick-update
2420
2563
  */
2421
2564
  getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
2565
+ /**
2566
+ * @public
2567
+ * Get an ordered iterator over events received within the current frame.
2568
+ * @returns the iterator
2569
+ */
2570
+ getInputCommands: () => Generator<PBPointerEventsResult>;
2422
2571
  };
2423
2572
 
2424
2573
  /**
@@ -2714,13 +2863,29 @@ export declare interface LightSourceHelper {
2714
2863
  */
2715
2864
  export declare type Listeners = {
2716
2865
  /** triggered on mouse down event */
2717
- onMouseDown?: Callback;
2866
+ onMouseDown?: EventSystemCallback;
2718
2867
  /** triggered on mouse up event */
2719
- onMouseUp?: Callback;
2868
+ onMouseUp?: EventSystemCallback;
2720
2869
  /** triggered on mouse hover event */
2721
- onMouseEnter?: Callback;
2870
+ onMouseEnter?: EventSystemCallback;
2722
2871
  /** triggered on mouse leave event */
2723
- onMouseLeave?: Callback;
2872
+ onMouseLeave?: EventSystemCallback;
2873
+ /** triggered on mouse drag event */
2874
+ onMouseDrag?: EventSystemCallback;
2875
+ /** triggered on mouse drag event */
2876
+ onMouseDragLocked?: EventSystemCallback;
2877
+ /** triggered on mouse drag event */
2878
+ onMouseDragEnd?: EventSystemCallback;
2879
+ /** triggered on input down event */
2880
+ onInputDown?: MultiCallback;
2881
+ /** triggered on input up event */
2882
+ onInputUp?: MultiCallback;
2883
+ /** triggered on input drag event */
2884
+ onInputDrag?: MultiCallback;
2885
+ /** triggered on input drag event */
2886
+ onInputDragLocked?: MultiCallback;
2887
+ /** triggered on input drag event */
2888
+ onInputDragEnd?: MultiCallback;
2724
2889
  };
2725
2890
 
2726
2891
  /**
@@ -3589,6 +3754,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
3589
3754
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
3590
3755
  */
3591
3756
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3757
+ /**
3758
+ * @public
3759
+ * Set a gltf internal mesh in the MeshCollider component
3760
+ * @param entity - entity to create or replace the MeshRenderer component
3761
+ * @param source - the path to the gltf
3762
+ * @param meshName - the name of the mesh in the gltf
3763
+ */
3764
+ setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3592
3765
  }
3593
3766
 
3594
3767
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -3625,6 +3798,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
3625
3798
  * @param entity - entity to create or replace the MeshRenderer component
3626
3799
  */
3627
3800
  setSphere(entity: Entity): void;
3801
+ /**
3802
+ * @public
3803
+ * Set a gltf internal mesh in the MeshRenderer component
3804
+ * @param entity - entity to create or replace the MeshRenderer component
3805
+ * @param source - the path to the gltf
3806
+ * @param meshName - the name of the mesh in the gltf
3807
+ */
3808
+ setGltfMesh(entity: Entity, source: string, meshName: string): void;
3628
3809
  }
3629
3810
 
3630
3811
  /* Excluded from this release type: MessageBus */
@@ -3662,6 +3843,19 @@ export declare namespace MoveContinuous {
3662
3843
  export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
3663
3844
  }
3664
3845
 
3846
+ /**
3847
+ * a record object mapping `InputAction`s to functions.
3848
+ *
3849
+ * @example
3850
+ * onInputDown={{
3851
+ * [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
3852
+ * [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
3853
+ * }}
3854
+ *
3855
+ * @public
3856
+ */
3857
+ export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
3858
+
3665
3859
  export declare const Name: NameComponent;
3666
3860
 
3667
3861
  export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
@@ -4034,6 +4228,25 @@ export declare const onVideoEvent: Observable<{
4034
4228
  totalVideoLength: number;
4035
4229
  }>;
4036
4230
 
4231
+ /**
4232
+ * @public
4233
+ */
4234
+ export declare interface Orthographic {
4235
+ /**
4236
+ * vertical extent of the visible range in meters
4237
+ * defaults to 4m
4238
+ */
4239
+ verticalRange?: number | undefined;
4240
+ }
4241
+
4242
+ /**
4243
+ * @public
4244
+ */
4245
+ export declare namespace Orthographic {
4246
+ export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
4247
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
4248
+ }
4249
+
4037
4250
  /**
4038
4251
  * @public
4039
4252
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -4260,6 +4473,8 @@ export declare namespace PBAvatarEmoteCommand {
4260
4473
  export declare interface PBAvatarEquippedData {
4261
4474
  wearableUrns: string[];
4262
4475
  emoteUrns: string[];
4476
+ /** slots that will render even if hidden */
4477
+ forceRender: string[];
4263
4478
  }
4264
4479
 
4265
4480
  /**
@@ -4294,6 +4509,9 @@ export declare interface PBAvatarModifierArea {
4294
4509
  excludeIds: string[];
4295
4510
  /** list of modifiers to apply */
4296
4511
  modifiers: AvatarModifierType[];
4512
+ movementSettings?: AvatarMovementSettings | undefined;
4513
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4514
+ useColliderRange?: boolean | undefined;
4297
4515
  }
4298
4516
 
4299
4517
  /**
@@ -4352,6 +4570,8 @@ export declare interface PBAvatarShape {
4352
4570
  emotes: string[];
4353
4571
  /** hides the skin + hair + facial features (default: false) */
4354
4572
  showOnlyWearables?: boolean | undefined;
4573
+ /** slots that will render even if hidden */
4574
+ forceRender: string[];
4355
4575
  }
4356
4576
 
4357
4577
  /**
@@ -4386,6 +4606,51 @@ export declare namespace PBBillboard {
4386
4606
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
4387
4607
  }
4388
4608
 
4609
+ /**
4610
+ * @public
4611
+ */
4612
+ export declare interface PBCameraLayer {
4613
+ /**
4614
+ * layer to which these settings apply. must be > 0
4615
+ * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
4616
+ */
4617
+ layer: number;
4618
+ /** should the sun light affect this layer? default false */
4619
+ directionalLight?: boolean | undefined;
4620
+ /** should this layer show player avatars? default false */
4621
+ showAvatars?: boolean | undefined;
4622
+ /** should this layer show the sky? default false */
4623
+ showSkybox?: boolean | undefined;
4624
+ /** should this layer show distance fog? default false */
4625
+ showFog?: boolean | undefined;
4626
+ /** ambient light overrides for this layer. default -> use same as main camera */
4627
+ ambientColorOverride?: PBColor3 | undefined;
4628
+ ambientBrightnessOverride?: number | undefined;
4629
+ }
4630
+
4631
+ /**
4632
+ * @public
4633
+ */
4634
+ export declare namespace PBCameraLayer {
4635
+ export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
4636
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
4637
+ }
4638
+
4639
+ /**
4640
+ * @public
4641
+ */
4642
+ export declare interface PBCameraLayers {
4643
+ layers: number[];
4644
+ }
4645
+
4646
+ /**
4647
+ * @public
4648
+ */
4649
+ export declare namespace PBCameraLayers {
4650
+ export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
4651
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
4652
+ }
4653
+
4389
4654
  /**
4390
4655
  * The CameraMode component can be used to determine whether the player is using a first-person o
4391
4656
  * third-person view.
@@ -4408,7 +4673,7 @@ export declare namespace PBCameraMode {
4408
4673
 
4409
4674
  /**
4410
4675
  * The CameraModeArea component can be attached to an Entity to define a region of space where
4411
- * the player's camera mode (1st-person or 3rd-person) is overridden.
4676
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
4412
4677
  *
4413
4678
  * The Entity's Transform position determines the center-point of the region, while its size is
4414
4679
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -4418,6 +4683,8 @@ export declare namespace PBCameraMode {
4418
4683
  *
4419
4684
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
4420
4685
  * is actually a 3D volume.
4686
+ *
4687
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
4421
4688
  */
4422
4689
  /**
4423
4690
  * @public
@@ -4427,6 +4694,9 @@ export declare interface PBCameraModeArea {
4427
4694
  area: PBVector3 | undefined;
4428
4695
  /** the camera mode to enforce */
4429
4696
  mode: CameraType;
4697
+ cinematicSettings?: CinematicSettings | undefined;
4698
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4699
+ useColliderRange?: boolean | undefined;
4430
4700
  }
4431
4701
 
4432
4702
  /**
@@ -4498,6 +4768,39 @@ export declare namespace PBEngineInfo {
4498
4768
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
4499
4769
  }
4500
4770
 
4771
+ /**
4772
+ * defines the global scene light settings. must be added to the scene root.
4773
+ * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
4774
+ */
4775
+ /**
4776
+ * @public
4777
+ */
4778
+ export declare interface PBGlobalLight {
4779
+ /**
4780
+ * the direction the directional light shines in.
4781
+ * default depends on time of day and explorer implementation
4782
+ */
4783
+ direction?: PBVector3 | undefined;
4784
+ /**
4785
+ * ambient light color
4786
+ * default: White
4787
+ */
4788
+ ambientColor?: PBColor3 | undefined;
4789
+ /**
4790
+ * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
4791
+ * default 1
4792
+ */
4793
+ ambientBrightness?: number | undefined;
4794
+ }
4795
+
4796
+ /**
4797
+ * @public
4798
+ */
4799
+ export declare namespace PBGlobalLight {
4800
+ export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
4801
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
4802
+ }
4803
+
4501
4804
  /**
4502
4805
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
4503
4806
  *
@@ -4533,6 +4836,25 @@ export declare namespace PBGltfContainer {
4533
4836
  */
4534
4837
  export declare interface PBGltfContainerLoadingState {
4535
4838
  currentState: LoadingState;
4839
+ /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
4840
+ nodePaths: string[];
4841
+ /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
4842
+ meshNames: string[];
4843
+ /**
4844
+ * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
4845
+ * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
4846
+ */
4847
+ materialNames: string[];
4848
+ /**
4849
+ * X is the material index. note this may conflict with manually named materials - to avoid any issues make
4850
+ * sure all your materials are explicitly named.
4851
+ */
4852
+ skinNames: string[];
4853
+ /**
4854
+ * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
4855
+ * your skins are explicitly named.
4856
+ */
4857
+ animationNames: string[];
4536
4858
  }
4537
4859
 
4538
4860
  /**
@@ -4543,6 +4865,57 @@ export declare namespace PBGltfContainerLoadingState {
4543
4865
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
4544
4866
  }
4545
4867
 
4868
+ /**
4869
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
4870
+ * This component must be added to a direct child of an entity with a PBGltfContainer component, or
4871
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
4872
+ * in the parent.
4873
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
4874
+ *
4875
+ * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
4876
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
4877
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
4878
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
4879
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
4880
+ *
4881
+ * After creation, if an animation moves the node, the `Transform` will be updated.
4882
+ *
4883
+ * From the scene, you can modify various components to alter the gltf node:
4884
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
4885
+ * regardless of any intermediate gltf node hierarchy.
4886
+ * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
4887
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
4888
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
4889
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
4890
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
4891
+ * 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
4892
+ * PBMaterial will be maintained.
4893
+ *
4894
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
4895
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
4896
+ * change the state to `GNS_FAILED`.
4897
+ * - deleting the scene entity will not delete the gltf node.
4898
+ *
4899
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
4900
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
4901
+ * the gltf node will also be displayed.
4902
+ */
4903
+ /**
4904
+ * @public
4905
+ */
4906
+ export declare interface PBGltfNode {
4907
+ /** the path of the target node in the Gltf. */
4908
+ path: string;
4909
+ }
4910
+
4911
+ /**
4912
+ * @public
4913
+ */
4914
+ export declare namespace PBGltfNode {
4915
+ export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
4916
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
4917
+ }
4918
+
4546
4919
  /**
4547
4920
  * GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
4548
4921
  *
@@ -4588,6 +4961,26 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
4588
4961
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
4589
4962
  }
4590
4963
 
4964
+ /**
4965
+ * The state of a linked gltf node.
4966
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
4967
+ */
4968
+ /**
4969
+ * @public
4970
+ */
4971
+ export declare interface PBGltfNodeState {
4972
+ state: GltfNodeStateValue;
4973
+ error?: string | undefined;
4974
+ }
4975
+
4976
+ /**
4977
+ * @public
4978
+ */
4979
+ export declare namespace PBGltfNodeState {
4980
+ export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
4981
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
4982
+ }
4983
+
4591
4984
  /**
4592
4985
  * @public
4593
4986
  */
@@ -4723,6 +5116,14 @@ export declare interface PBMaterial {
4723
5116
  $case: "pbr";
4724
5117
  pbr: PBMaterial_PbrMaterial;
4725
5118
  } | undefined;
5119
+ /**
5120
+ * A gltf material that may provide additional features not supported by the PbMaterial fields.
5121
+ * If both gltf and material fields are provided, the gltf will be used only for extended features not
5122
+ * supported by the PbMaterial.
5123
+ * If this is provided and the `material` field is not provided, the renderer will update the material
5124
+ * field with data that reflects the gltf material once it is loaded.
5125
+ */
5126
+ gltf?: PBMaterial_GltfMaterial | undefined;
4726
5127
  }
4727
5128
 
4728
5129
  /**
@@ -4733,6 +5134,22 @@ export declare namespace PBMaterial {
4733
5134
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
4734
5135
  }
4735
5136
 
5137
+ /**
5138
+ * @public
5139
+ */
5140
+ export declare interface PBMaterial_GltfMaterial {
5141
+ gltfSrc: string;
5142
+ name: string;
5143
+ }
5144
+
5145
+ /**
5146
+ * @public
5147
+ */
5148
+ export declare namespace PBMaterial_GltfMaterial {
5149
+ export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
5150
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
5151
+ }
5152
+
4736
5153
  /**
4737
5154
  * @public
4738
5155
  */
@@ -4829,6 +5246,9 @@ export declare interface PBMeshCollider {
4829
5246
  } | {
4830
5247
  $case: "plane";
4831
5248
  plane: PBMeshCollider_PlaneMesh;
5249
+ } | {
5250
+ $case: "gltf";
5251
+ gltf: PBMeshCollider_GltfMesh;
4832
5252
  } | undefined;
4833
5253
  }
4834
5254
 
@@ -4874,6 +5294,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
4874
5294
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
4875
5295
  }
4876
5296
 
5297
+ /** A collider constructed from a Gltf Mesh. */
5298
+ /**
5299
+ * @public
5300
+ */
5301
+ export declare interface PBMeshCollider_GltfMesh {
5302
+ /** the GLTF file path as listed in the scene's manifest. */
5303
+ gltfSrc: string;
5304
+ /** the name of the mesh asset */
5305
+ name: string;
5306
+ }
5307
+
5308
+ /**
5309
+ * @public
5310
+ */
5311
+ export declare namespace PBMeshCollider_GltfMesh {
5312
+ export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5313
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
5314
+ }
5315
+
4877
5316
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
4878
5317
  /**
4879
5318
  * @public
@@ -4906,13 +5345,11 @@ export declare namespace PBMeshCollider_SphereMesh {
4906
5345
 
4907
5346
  /**
4908
5347
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
4909
- * plane, a sphere or a cylinder.
5348
+ * plane, a sphere, a cylinder, or a Gltf mesh.
4910
5349
  *
4911
5350
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
4912
5351
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
4913
5352
  * `float` coordinates, one for each corner of each side of each face.
4914
- *
4915
- * More complex shapes require the use of a `GltfContainer` component.
4916
5353
  */
4917
5354
  /**
4918
5355
  * @public
@@ -4930,6 +5367,9 @@ export declare interface PBMeshRenderer {
4930
5367
  } | {
4931
5368
  $case: "plane";
4932
5369
  plane: PBMeshRenderer_PlaneMesh;
5370
+ } | {
5371
+ $case: "gltf";
5372
+ gltf: PBMeshRenderer_GltfMesh;
4933
5373
  } | undefined;
4934
5374
  }
4935
5375
 
@@ -4977,6 +5417,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
4977
5417
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
4978
5418
  }
4979
5419
 
5420
+ /** A mesh from a Gltf. */
5421
+ /**
5422
+ * @public
5423
+ */
5424
+ export declare interface PBMeshRenderer_GltfMesh {
5425
+ /** the GLTF file path as listed in the scene's manifest. */
5426
+ gltfSrc: string;
5427
+ /** the name of the mesh asset */
5428
+ name: string;
5429
+ }
5430
+
5431
+ /**
5432
+ * @public
5433
+ */
5434
+ export declare namespace PBMeshRenderer_GltfMesh {
5435
+ export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5436
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
5437
+ }
5438
+
4980
5439
  /** PlaneMesh renders a 2D rectangular shape. */
4981
5440
  /**
4982
5441
  * @public
@@ -5225,7 +5684,10 @@ export declare interface PBPrimaryPointerInfo {
5225
5684
  screenCoordinates?: PBVector2 | undefined;
5226
5685
  /** Movement since last frame (pixels) */
5227
5686
  screenDelta?: PBVector2 | undefined;
5228
- /** Direction vector for 3D ray casting */
5687
+ /**
5688
+ * ray direction that can be used with the primary camera origin for
5689
+ * raycasting from the cursor into the world
5690
+ */
5229
5691
  worldRayDirection?: PBVector3 | undefined;
5230
5692
  }
5231
5693
 
@@ -5451,6 +5913,46 @@ export declare namespace PBTextShape {
5451
5913
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
5452
5914
  }
5453
5915
 
5916
+ /**
5917
+ * @public
5918
+ */
5919
+ export declare interface PBTextureCamera {
5920
+ /** rendered texture width */
5921
+ width?: number | undefined;
5922
+ /** rendered texture height */
5923
+ height?: number | undefined;
5924
+ /**
5925
+ * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
5926
+ * defaults to 0
5927
+ */
5928
+ layer?: number | undefined;
5929
+ /** default black */
5930
+ clearColor?: PBColor4 | undefined;
5931
+ /** default infinity */
5932
+ farPlane?: number | undefined;
5933
+ mode?: {
5934
+ $case: "perspective";
5935
+ perspective: Perspective;
5936
+ } | {
5937
+ $case: "orthographic";
5938
+ orthographic: Orthographic;
5939
+ } | undefined;
5940
+ /**
5941
+ * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
5942
+ * range: 0 (off) - 1 (full volume)
5943
+ * default: 0
5944
+ */
5945
+ volume?: number | undefined;
5946
+ }
5947
+
5948
+ /**
5949
+ * @public
5950
+ */
5951
+ export declare namespace PBTextureCamera {
5952
+ export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
5953
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
5954
+ }
5955
+
5454
5956
  /**
5455
5957
  * The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
5456
5958
  * when entities enter this component's defined area.
@@ -5629,6 +6131,25 @@ export declare namespace PBUiBackground {
5629
6131
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
5630
6132
  }
5631
6133
 
6134
+ /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
6135
+ /**
6136
+ * @public
6137
+ */
6138
+ export declare interface PBUiCanvas {
6139
+ width: number;
6140
+ height: number;
6141
+ /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
6142
+ color?: PBColor4 | undefined;
6143
+ }
6144
+
6145
+ /**
6146
+ * @public
6147
+ */
6148
+ export declare namespace PBUiCanvas {
6149
+ export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
6150
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
6151
+ }
6152
+
5632
6153
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
5633
6154
  /**
5634
6155
  * @public
@@ -5745,6 +6266,21 @@ export declare namespace PBUiInputResult {
5745
6266
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
5746
6267
  }
5747
6268
 
6269
+ /**
6270
+ * @public
6271
+ */
6272
+ export declare interface PBUiScrollResult {
6273
+ value: PBVector2 | undefined;
6274
+ }
6275
+
6276
+ /**
6277
+ * @public
6278
+ */
6279
+ export declare namespace PBUiScrollResult {
6280
+ export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
6281
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
6282
+ }
6283
+
5748
6284
  /**
5749
6285
  * @public
5750
6286
  */
@@ -5761,6 +6297,10 @@ export declare interface PBUiText {
5761
6297
  fontSize?: number | undefined;
5762
6298
  /** wrap text when the border is reached (default: TW_WRAP) */
5763
6299
  textWrap?: TextWrap | undefined;
6300
+ /** width of the outline (default: 0) */
6301
+ outlineWidth?: number | undefined;
6302
+ /** RGBA color of the outline (default: opaque black) */
6303
+ outlineColor?: PBColor4 | undefined;
5764
6304
  }
5765
6305
 
5766
6306
  /**
@@ -5888,6 +6428,12 @@ export declare interface PBUiTransform {
5888
6428
  borderRightColor?: PBColor4 | undefined;
5889
6429
  /** default: 1 */
5890
6430
  opacity?: number | undefined;
6431
+ /** reference for scroll_position. default empty */
6432
+ elementId?: string | undefined;
6433
+ /** default position=(0,0) */
6434
+ scrollPosition?: ScrollPositionValue | undefined;
6435
+ /** default ShowScrollBar.SSB_BOTH */
6436
+ scrollVisible?: ShowScrollBar | undefined;
5891
6437
  /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
5892
6438
  zIndex?: number | undefined;
5893
6439
  }
@@ -5986,7 +6532,6 @@ export declare namespace PBVideoPlayer {
5986
6532
  * an 'instant' transition (like using speed/time = 0)
5987
6533
  * * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
5988
6534
  * the holding entity transform).
5989
- * * The fov defines the Field of View of the virtual camera
5990
6535
  */
5991
6536
  /**
5992
6537
  * @public
@@ -5994,8 +6539,6 @@ export declare namespace PBVideoPlayer {
5994
6539
  export declare interface PBVirtualCamera {
5995
6540
  defaultTransition?: CameraTransition | undefined;
5996
6541
  lookAtEntity?: number | undefined;
5997
- /** default: 60 */
5998
- fov?: number | undefined;
5999
6542
  }
6000
6543
 
6001
6544
  /**
@@ -6022,6 +6565,25 @@ export declare namespace PBVisibilityComponent {
6022
6565
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
6023
6566
  }
6024
6567
 
6568
+ /**
6569
+ * @public
6570
+ */
6571
+ export declare interface Perspective {
6572
+ /**
6573
+ * vertical field of view in radians
6574
+ * defaults to pi/4 = 45 degrees
6575
+ */
6576
+ fieldOfView?: number | undefined;
6577
+ }
6578
+
6579
+ /**
6580
+ * @public
6581
+ */
6582
+ export declare namespace Perspective {
6583
+ export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
6584
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
6585
+ }
6586
+
6025
6587
  /**
6026
6588
  * Represens a plane by the equation ax + by + cz + d = 0
6027
6589
  * @public
@@ -6177,11 +6739,37 @@ export declare interface PointerEventsSystem {
6177
6739
  * @param entity - Entity where the callback was attached
6178
6740
  */
6179
6741
  removeOnPointerHoverLeave(entity: Entity): void;
6742
+ /**
6743
+ * @public
6744
+ * Remove the callback for onPointerDrag event
6745
+ * @param entity - Entity where the callback was attached
6746
+ */
6747
+ removeOnPointerDrag(entity: Entity): void;
6748
+ /**
6749
+ * @public
6750
+ * Remove the callback for onPointerDragLocked event
6751
+ * @param entity - Entity where the callback was attached
6752
+ */
6753
+ removeOnPointerDragLocked(entity: Entity): void;
6754
+ /**
6755
+ * @public
6756
+ * Remove the callback for onPointerDragEnd event
6757
+ * @param entity - Entity where the callback was attached
6758
+ */
6759
+ removeOnPointerDragEnd(entity: Entity): void;
6760
+ /**
6761
+ * @public
6762
+ * Execute callbacks when the user presses one of the InputButtons pointing at the entity
6763
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6764
+ */
6765
+ onPointerDown(pointerData: {
6766
+ entity: Entity;
6767
+ optsList: EventSystemOptionsCallback[];
6768
+ }): void;
6180
6769
  /**
6181
6770
  * @public
6182
6771
  * Execute callback when the user press the InputButton pointing at the entity
6183
6772
  * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
6184
- * @param cb - Function to execute when click fires
6185
6773
  */
6186
6774
  onPointerDown(pointerData: {
6187
6775
  entity: Entity;
@@ -6194,6 +6782,15 @@ export declare interface PointerEventsSystem {
6194
6782
  * @param opts - Opts to trigger Feedback and Button
6195
6783
  */
6196
6784
  onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
6785
+ /**
6786
+ * @public
6787
+ * Execute callbacks when the user releases one of the InputButtons pointing at the entity
6788
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6789
+ */
6790
+ onPointerUp(pointerData: {
6791
+ entity: Entity;
6792
+ optsList: EventSystemOptionsCallback[];
6793
+ }): void;
6197
6794
  /**
6198
6795
  * @public
6199
6796
  * Execute callback when the user releases the InputButton pointing at the entity
@@ -6231,6 +6828,64 @@ export declare interface PointerEventsSystem {
6231
6828
  entity: Entity;
6232
6829
  opts?: Partial<EventSystemOptions>;
6233
6830
  }, cb: EventSystemCallback): void;
6831
+ /**
6832
+ * @public
6833
+ * Execute callbacks when the user drags the pointer from inside the entity
6834
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6835
+ */
6836
+ onPointerDrag(pointerData: {
6837
+ entity: Entity;
6838
+ optsList: EventSystemOptionsCallback[];
6839
+ }): void;
6840
+ /**
6841
+ * @public
6842
+ * Execute callback when the user clicks and drags the pointer from inside the entity
6843
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6844
+ * @param cb - Function to execute when click fires
6845
+ */
6846
+ onPointerDrag(pointerData: {
6847
+ entity: Entity;
6848
+ opts?: Partial<EventSystemOptions>;
6849
+ }, cb: EventSystemCallback): void;
6850
+ /**
6851
+ * @public
6852
+ * Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
6853
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6854
+ */
6855
+ onPointerDragLocked(pointerData: {
6856
+ entity: Entity;
6857
+ optsList: EventSystemOptionsCallback[];
6858
+ }): void;
6859
+ /**
6860
+ * @public
6861
+ * Execute callback when the user clicks and drags the pointer from inside the entity,
6862
+ * locking the cursor in place
6863
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6864
+ * @param cb - Function to execute when click fires
6865
+ */
6866
+ onPointerDragLocked(pointerData: {
6867
+ entity: Entity;
6868
+ opts?: Partial<EventSystemOptions>;
6869
+ }, cb: EventSystemCallback): void;
6870
+ /**
6871
+ * @public
6872
+ * Execute callbacks when the user releases a button after a drag
6873
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
6874
+ */
6875
+ onPointerDragEnd(pointerData: {
6876
+ entity: Entity;
6877
+ optsList: EventSystemOptionsCallback[];
6878
+ }): void;
6879
+ /**
6880
+ * @public
6881
+ * Execute callback when the user releases the button after a drag
6882
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
6883
+ * @param cb - Function to execute when click fires
6884
+ */
6885
+ onPointerDragEnd(pointerData: {
6886
+ entity: Entity;
6887
+ opts?: Partial<EventSystemOptions>;
6888
+ }, cb: EventSystemCallback): void;
6234
6889
  }
6235
6890
 
6236
6891
  /**
@@ -6247,7 +6902,10 @@ export declare const enum PointerEventType {
6247
6902
  PET_UP = 0,
6248
6903
  PET_DOWN = 1,
6249
6904
  PET_HOVER_ENTER = 2,
6250
- PET_HOVER_LEAVE = 3
6905
+ PET_HOVER_LEAVE = 3,
6906
+ PET_DRAG_LOCKED = 4,
6907
+ PET_DRAG = 5,
6908
+ PET_DRAG_END = 6
6251
6909
  }
6252
6910
 
6253
6911
  /**
@@ -6278,7 +6936,10 @@ export declare const enum PointerType {
6278
6936
  /** POT_NONE - No pointer input */
6279
6937
  POT_NONE = 0,
6280
6938
  /** POT_MOUSE - Traditional mouse input */
6281
- POT_MOUSE = 1
6939
+ POT_MOUSE = 1,
6940
+ POT_PAD = 2,
6941
+ POT_TOUCH = 3,
6942
+ POT_WAND = 4
6282
6943
  }
6283
6944
 
6284
6945
  /**
@@ -6875,6 +7536,7 @@ export declare type RaycastSystemOptions = {
6875
7536
  export declare interface ReactBasedUiSystem {
6876
7537
  destroy(): void;
6877
7538
  setUiRenderer(ui: UiComponent): void;
7539
+ setTextureRenderer(entity: Entity, ui: UiComponent): void;
6878
7540
  }
6879
7541
 
6880
7542
  /**
@@ -7353,6 +8015,43 @@ export declare namespace Schemas {
7353
8015
  }) => void;
7354
8016
  }
7355
8017
 
8018
+ /**
8019
+ * @public
8020
+ */
8021
+ export declare interface ScrollPositionValue {
8022
+ value?: {
8023
+ $case: "position";
8024
+ position: PBVector2;
8025
+ } | {
8026
+ $case: "reference";
8027
+ reference: string;
8028
+ } | undefined;
8029
+ }
8030
+
8031
+ /**
8032
+ * @public
8033
+ */
8034
+ export declare namespace ScrollPositionValue {
8035
+ export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
8036
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
8037
+ }
8038
+
8039
+ /**
8040
+ * @public
8041
+ * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
8042
+ */
8043
+ export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
8044
+
8045
+ /**
8046
+ * @public
8047
+ */
8048
+ export declare const enum ShowScrollBar {
8049
+ SSB_BOTH = 0,
8050
+ SSB_ONLY_VERTICAL = 1,
8051
+ SSB_ONLY_HORIZONTAL = 2,
8052
+ SSB_HIDDEN = 3
8053
+ }
8054
+
7356
8055
  /** @public */
7357
8056
  export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
7358
8057
 
@@ -7459,6 +8158,9 @@ export declare namespace Texture {
7459
8158
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
7460
8159
  }
7461
8160
 
8161
+ /** @public */
8162
+ export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
8163
+
7462
8164
  /**
7463
8165
  * @public
7464
8166
  */
@@ -7569,6 +8271,9 @@ export declare interface TextureUnion {
7569
8271
  } | {
7570
8272
  $case: "videoTexture";
7571
8273
  videoTexture: VideoTexture;
8274
+ } | {
8275
+ $case: "uiTexture";
8276
+ uiTexture: UiCanvasTexture;
7572
8277
  } | undefined;
7573
8278
  }
7574
8279
 
@@ -7941,7 +8646,7 @@ export declare type TweenSystem = {
7941
8646
 
7942
8647
  /**
7943
8648
  * @public
7944
- * Register callback functions to a particular entity on tween events.
8649
+ * Register callback functions to a particular entity on video events.
7945
8650
  */
7946
8651
  export declare const tweenSystem: TweenSystem;
7947
8652
 
@@ -7973,6 +8678,8 @@ export declare interface UiBackgroundProps {
7973
8678
  uvs?: number[];
7974
8679
  /** AvatarTexture for the background */
7975
8680
  avatarTexture?: UiAvatarTexture;
8681
+ /** VideoTexture for the background */
8682
+ videoTexture?: UiVideoTexture;
7976
8683
  /** Texture for the background */
7977
8684
  texture?: UiTexture;
7978
8685
  }
@@ -7992,9 +8699,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
7992
8699
  disabled?: boolean;
7993
8700
  }
7994
8701
 
8702
+ /** @public */
8703
+ export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
8704
+
7995
8705
  /** @public */
7996
8706
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
7997
8707
 
8708
+ /**
8709
+ * @public
8710
+ */
8711
+ export declare interface UiCanvasTexture {
8712
+ uiCanvasEntity: number;
8713
+ /** default = TextureWrapMode.Clamp */
8714
+ wrapMode?: TextureWrapMode | undefined;
8715
+ /** default = FilterMode.Bilinear */
8716
+ filterMode?: TextureFilterMode | undefined;
8717
+ }
8718
+
8719
+ /**
8720
+ * @public
8721
+ */
8722
+ export declare namespace UiCanvasTexture {
8723
+ export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
8724
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
8725
+ }
8726
+
7998
8727
  /**
7999
8728
  * @public
8000
8729
  */
@@ -8064,6 +8793,10 @@ export declare interface UiLabelProps {
8064
8793
  textAlign?: TextAlignType | undefined;
8065
8794
  /** Label font type. @defaultValue 'sans-serif' */
8066
8795
  font?: UiFontType | undefined;
8796
+ /** Outline width of the text. @defaultValue 0 */
8797
+ outlineWidth?: number | undefined;
8798
+ /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
8799
+ outlineColor?: PBColor4 | undefined;
8067
8800
  /** Behaviour when text reached. @defaultValue 'wrap' */
8068
8801
  textWrap?: UiTextWrapType | undefined;
8069
8802
  }
@@ -8073,6 +8806,9 @@ export declare interface UiLabelProps {
8073
8806
  */
8074
8807
  export declare type uint32 = number;
8075
8808
 
8809
+ /** @public */
8810
+ export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
8811
+
8076
8812
  /** @public */
8077
8813
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
8078
8814
 
@@ -8150,10 +8886,26 @@ export declare interface UiTransformProps {
8150
8886
  borderWidth?: Partial<Position> | PositionUnit;
8151
8887
  /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
8152
8888
  opacity?: number;
8889
+ /** A reference value to identify the element, default empty */
8890
+ elementId?: string;
8891
+ /** default position=(0,0) if it aplies, a vector or a reference-id */
8892
+ scrollPosition?: PBVector2 | string;
8893
+ /** default ShowScrollBar.SSB_BOTH */
8894
+ scrollVisible?: ScrollVisibleType;
8153
8895
  /** default 0 */
8154
8896
  zIndex?: number;
8155
8897
  }
8156
8898
 
8899
+ /**
8900
+ * Texture
8901
+ * @public
8902
+ */
8903
+ export declare interface UiVideoTexture {
8904
+ videoPlayerEntity: Entity;
8905
+ wrapMode?: TextureWrapType;
8906
+ filterMode?: TextureFilterType;
8907
+ }
8908
+
8157
8909
  /**
8158
8910
  * @public
8159
8911
  */