@dcl/playground-assets 7.19.1-21595262606.commit-a6f1c20 → 7.19.1-21654129874.commit-4307fca

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
@@ -115,61 +115,6 @@ export declare const assetLoadLoadingStateSystem: AssetLoadLoadingStateSystem;
115
115
  */
116
116
  export declare type AssetLoadLoadingStateSystemCallback = (event: DeepReadonlyObject<PBAssetLoadLoadingState>) => void;
117
117
 
118
- export declare const AudioAnalysis: AudioAnalysisComponentDefinitionExtended;
119
-
120
- export declare interface AudioAnalysisComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBAudioAnalysis> {
121
- /**
122
- * Reads the component data of `entity` into the provided `out` view.
123
- *
124
- * @throws Error if the entity does not have an AudioAnalysis component.
125
- * @param entity - The entity whose AudioAnalysis data will be read.
126
- * @param out - An existing AudioAnalysisView to populate with the latest values.
127
- */
128
- readIntoView(entity: Entity, out: AudioAnalysisView): void;
129
- /**
130
- * Attempts to read the component data of `entity` into the provided `out` view.
131
- *
132
- * @returns `true` if the component exists and data was written into `out`,
133
- * `false` if the entity does not have an AudioAnalysis component.
134
- * @param entity - The entity whose AudioAnalysis data will be read.
135
- * @param out - An existing AudioAnalysisView to populate.
136
- */
137
- tryReadIntoView(entity: Entity, out: AudioAnalysisView): boolean;
138
- /**
139
- * Creates an AudioAnalysis component for the given `entity`.
140
- *
141
- * If a component already exists on the entity, this call fails (does not replace).
142
- *
143
- * @param entity - The entity to attach the component to.
144
- * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
145
- * @param amplitudeGain - Optional amplitude gain multiplier.
146
- * @param bandsGain - Optional gain multiplier applied to all frequency bands.
147
- */
148
- createAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
149
- amplitudeGain?: number, bandsGain?: number): void;
150
- /**
151
- * Creates the AudioAnalysis component if missing, or replaces the existing one.
152
- *
153
- * @param entity - The target entity.
154
- * @param mode - Analysis mode. Defaults to `PBAudioAnalysisMode.MODE_LOGARITHMIC`.
155
- * @param amplitudeGain - Optional amplitude gain multiplier.
156
- * @param bandsGain - Optional gain multiplier applied to the frequency bands.
157
- */
158
- createOrReplaceAudioAnalysis(entity: Entity, mode?: PBAudioAnalysisMode, // default is PBAudioAnalysisMode.MODE_LOGARITHMIC
159
- amplitudeGain?: number, bandsGain?: number): void;
160
- }
161
-
162
- /**
163
- * A read-only JavaScript-friendly view of AudioAnalysis ECS data.
164
- *
165
- * `amplitude` represents the aggregated signal strength.
166
- * `bands` represents the processed frequency bands.
167
- */
168
- export declare type AudioAnalysisView = {
169
- amplitude: number;
170
- bands: number[];
171
- };
172
-
173
118
  /** @public */
174
119
  export declare const AudioEvent: GrowOnlyValueSetComponentDefinition<PBAudioEvent>;
175
120
 
@@ -258,12 +203,33 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
258
203
  /** @public */
259
204
  export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
260
205
 
206
+ /**
207
+ * @public
208
+ */
209
+ export declare const enum AvatarControlType {
210
+ /** CCT_NONE - avatar cannot move */
211
+ CCT_NONE = 0,
212
+ /** CCT_RELATIVE - avatar moves relative to the camera origin */
213
+ CCT_RELATIVE = 1,
214
+ /** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
215
+ CCT_TANK = 2
216
+ }
217
+
261
218
  /** @public */
262
219
  export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
263
220
 
264
221
  /** @public */
265
222
  export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
266
223
 
224
+ /**
225
+ * @public
226
+ */
227
+ export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
228
+
229
+ export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
230
+ forceRender?: string[] | undefined;
231
+ };
232
+
267
233
  /** @public */
268
234
  export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
269
235
 
@@ -281,9 +247,49 @@ export declare const enum AvatarModifierType {
281
247
  AMT_DISABLE_PASSPORTS = 1
282
248
  }
283
249
 
250
+ /**
251
+ * @public
252
+ */
253
+ export declare interface AvatarMovementSettings {
254
+ controlMode?: AvatarControlType | undefined;
255
+ /** if not explicitly set, the following properties default to user's preference settings */
256
+ runSpeed?: number | undefined;
257
+ /** how fast the player gets up to speed or comes to rest. higher = more responsive */
258
+ friction?: number | undefined;
259
+ /** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
260
+ gravity?: number | undefined;
261
+ /** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
262
+ jumpHeight?: number | undefined;
263
+ /** max fall speed in m/s. should normally be negative */
264
+ maxFallSpeed?: number | undefined;
265
+ /** speed the player turns in tank mode, in radians/s */
266
+ turnSpeed?: number | undefined;
267
+ /** speed the player walks at, in m/s */
268
+ walkSpeed?: number | undefined;
269
+ /** 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 */
270
+ allowWeightedMovement?: boolean | undefined;
271
+ }
272
+
273
+ /**
274
+ * @public
275
+ */
276
+ export declare namespace AvatarMovementSettings {
277
+ export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
278
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
279
+ }
280
+
284
281
  /** @public */
285
282
  export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
286
283
 
284
+ /**
285
+ * @public
286
+ */
287
+ export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
288
+
289
+ export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
290
+ forceRender?: string[] | undefined;
291
+ };
292
+
287
293
  /**
288
294
  * @public
289
295
  */
@@ -551,11 +557,19 @@ export declare interface ByteBuffer {
551
557
  }
552
558
 
553
559
  /**
554
- * Callback function to be triggered on a specified event
555
- * @public
560
+ * legacy Callback function
561
+ *
562
+ * @public @deprecated This type is no longer used in the sdk api, EventSystemCallback is
563
+ * used for listeners instead
556
564
  */
557
565
  export declare type Callback = () => void;
558
566
 
567
+ /** @public */
568
+ export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
569
+
570
+ /** @public */
571
+ export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
572
+
559
573
  /** @public */
560
574
  export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
561
575
 
@@ -613,6 +627,39 @@ export declare const enum CameraType {
613
627
 
614
628
  export declare type Children = ReactEcs.JSX.ReactNode;
615
629
 
630
+ /**
631
+ * @public
632
+ */
633
+ export declare interface CinematicSettings {
634
+ /** Entity that defines the cinematic camera transform. */
635
+ cameraEntity: number;
636
+ /**
637
+ * Position -> camera's position
638
+ * Rotation -> camera's direction
639
+ * scale.z -> zoom level
640
+ * scale.x and scale.y -> unused
641
+ */
642
+ allowManualRotation?: boolean | undefined;
643
+ /** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
644
+ yawRange?: number | undefined;
645
+ /** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
646
+ pitchRange?: number | undefined;
647
+ /** note: cameras can never look up/down further than Vec3::Y */
648
+ rollRange?: number | undefined;
649
+ /** minimum zoom level. must be greater than 0. defaults to the input zoom level */
650
+ zoomMin?: number | undefined;
651
+ /** maximum zoom level. must be greater than 0. defaults to the input zoom level */
652
+ zoomMax?: number | undefined;
653
+ }
654
+
655
+ /**
656
+ * @public
657
+ */
658
+ export declare namespace CinematicSettings {
659
+ export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
660
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
661
+ }
662
+
616
663
  /** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
617
664
  /**
618
665
  * @public
@@ -1379,7 +1426,6 @@ export declare const componentDefinitionByName: {
1379
1426
  "core::Animator": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAnimator>>;
1380
1427
  "core::AssetLoad": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAssetLoad>>;
1381
1428
  "core::AssetLoadLoadingState": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAssetLoadLoadingState>>;
1382
- "core::AudioAnalysis": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioAnalysis>>;
1383
1429
  "core::AudioEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAudioEvent>>;
1384
1430
  "core::AudioSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioSource>>;
1385
1431
  "core::AudioStream": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAudioStream>>;
@@ -1391,12 +1437,17 @@ export declare const componentDefinitionByName: {
1391
1437
  "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
1392
1438
  "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
1393
1439
  "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
1440
+ "core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
1441
+ "core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
1394
1442
  "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
1395
1443
  "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
1396
1444
  "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
1445
+ "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
1397
1446
  "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
1398
1447
  "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
1448
+ "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
1399
1449
  "core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
1450
+ "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
1400
1451
  "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
1401
1452
  "core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
1402
1453
  "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
@@ -1414,17 +1465,20 @@ export declare const componentDefinitionByName: {
1414
1465
  "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
1415
1466
  "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
1416
1467
  "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
1468
+ "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
1417
1469
  "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
1418
1470
  "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
1419
1471
  "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
1420
1472
  "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
1421
1473
  "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
1422
1474
  "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
1475
+ "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
1423
1476
  "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
1424
1477
  "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
1425
1478
  "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
1426
1479
  "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
1427
1480
  "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
1481
+ "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
1428
1482
  "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
1429
1483
  "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
1430
1484
  "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -2012,10 +2066,18 @@ export declare type EntityComponents = {
2012
2066
  uiBackground: PBUiBackground;
2013
2067
  uiInput: PBUiInput;
2014
2068
  uiDropdown: PBUiDropdown;
2015
- onMouseDown: Callback;
2016
- onMouseUp: Callback;
2017
- onMouseEnter: Callback;
2018
- onMouseLeave: Callback;
2069
+ onMouseDown: EventSystemCallback;
2070
+ onMouseUp: EventSystemCallback;
2071
+ onMouseEnter: EventSystemCallback;
2072
+ onMouseLeave: EventSystemCallback;
2073
+ onMouseDrag: EventSystemCallback;
2074
+ onMouseDragLocked: EventSystemCallback;
2075
+ onMouseDragEnd: EventSystemCallback;
2076
+ onInputDown: MultiCallback;
2077
+ onInputUp: MultiCallback;
2078
+ onInputDrag: MultiCallback;
2079
+ onInputDragLocked: MultiCallback;
2080
+ onInputDragEnd: MultiCallback;
2019
2081
  };
2020
2082
 
2021
2083
  /** @public */
@@ -2094,6 +2156,13 @@ export declare type EventSystemOptions = {
2094
2156
  maxPlayerDistance?: number;
2095
2157
  };
2096
2158
 
2159
+ /**
2160
+ * @public
2161
+ */
2162
+ export declare type EventSystemOptionsCallback = EventSystemOptions & {
2163
+ cb: EventSystemCallback;
2164
+ };
2165
+
2097
2166
  /**
2098
2167
  * Excludes property keys from T where the property is assignable to U
2099
2168
  * @public
@@ -2312,6 +2381,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
2312
2381
  direction?: PBVector3;
2313
2382
  };
2314
2383
 
2384
+ /** @public */
2385
+ export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
2386
+
2315
2387
  export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
2316
2388
 
2317
2389
  export declare type GlobalTargetRaycastSystemOptions = {
@@ -2324,9 +2396,24 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
2324
2396
  /** @public */
2325
2397
  export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
2326
2398
 
2399
+ /** @public */
2400
+ export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
2401
+
2327
2402
  /** @public */
2328
2403
  export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
2329
2404
 
2405
+ /** @public */
2406
+ export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
2407
+
2408
+ /**
2409
+ * @public
2410
+ */
2411
+ export declare const enum GltfNodeStateValue {
2412
+ GNSV_PENDING = 0,
2413
+ GNSV_FAILED = 1,
2414
+ GNSV_READY = 2
2415
+ }
2416
+
2330
2417
  /**
2331
2418
  * @public
2332
2419
  */
@@ -2672,6 +2759,12 @@ export declare type IInputSystem = {
2672
2759
  * @returns the input command info or undefined if there is no command in the last tick-update
2673
2760
  */
2674
2761
  getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
2762
+ /**
2763
+ * @public
2764
+ * Get an ordered iterator over events received within the current frame.
2765
+ * @returns the iterator
2766
+ */
2767
+ getInputCommands: () => Generator<PBPointerEventsResult>;
2675
2768
  };
2676
2769
 
2677
2770
  /**
@@ -2736,8 +2829,7 @@ export declare const enum InputAction {
2736
2829
  IA_ACTION_3 = 10,
2737
2830
  IA_ACTION_4 = 11,
2738
2831
  IA_ACTION_5 = 12,
2739
- IA_ACTION_6 = 13,
2740
- IA_MODIFIER = 14
2832
+ IA_ACTION_6 = 13
2741
2833
  }
2742
2834
 
2743
2835
  export declare const InputModifier: InputModifierComponentDefinitionExtended;
@@ -2968,13 +3060,29 @@ export declare interface LightSourceHelper {
2968
3060
  */
2969
3061
  export declare type Listeners = {
2970
3062
  /** triggered on mouse down event */
2971
- onMouseDown?: Callback;
3063
+ onMouseDown?: EventSystemCallback;
2972
3064
  /** triggered on mouse up event */
2973
- onMouseUp?: Callback;
3065
+ onMouseUp?: EventSystemCallback;
2974
3066
  /** triggered on mouse hover event */
2975
- onMouseEnter?: Callback;
3067
+ onMouseEnter?: EventSystemCallback;
2976
3068
  /** triggered on mouse leave event */
2977
- onMouseLeave?: Callback;
3069
+ onMouseLeave?: EventSystemCallback;
3070
+ /** triggered on mouse drag event */
3071
+ onMouseDrag?: EventSystemCallback;
3072
+ /** triggered on mouse drag event */
3073
+ onMouseDragLocked?: EventSystemCallback;
3074
+ /** triggered on mouse drag event */
3075
+ onMouseDragEnd?: EventSystemCallback;
3076
+ /** triggered on input down event */
3077
+ onInputDown?: MultiCallback;
3078
+ /** triggered on input up event */
3079
+ onInputUp?: MultiCallback;
3080
+ /** triggered on input drag event */
3081
+ onInputDrag?: MultiCallback;
3082
+ /** triggered on input drag event */
3083
+ onInputDragLocked?: MultiCallback;
3084
+ /** triggered on input drag event */
3085
+ onInputDragEnd?: MultiCallback;
2978
3086
  };
2979
3087
 
2980
3088
  /**
@@ -3879,6 +3987,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
3879
3987
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
3880
3988
  */
3881
3989
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3990
+ /**
3991
+ * @public
3992
+ * Set a gltf internal mesh in the MeshCollider component
3993
+ * @param entity - entity to create or replace the MeshRenderer component
3994
+ * @param source - the path to the gltf
3995
+ * @param meshName - the name of the mesh in the gltf
3996
+ */
3997
+ setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
3882
3998
  }
3883
3999
 
3884
4000
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -3915,6 +4031,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
3915
4031
  * @param entity - entity to create or replace the MeshRenderer component
3916
4032
  */
3917
4033
  setSphere(entity: Entity): void;
4034
+ /**
4035
+ * @public
4036
+ * Set a gltf internal mesh in the MeshRenderer component
4037
+ * @param entity - entity to create or replace the MeshRenderer component
4038
+ * @param source - the path to the gltf
4039
+ * @param meshName - the name of the mesh in the gltf
4040
+ */
4041
+ setGltfMesh(entity: Entity, source: string, meshName: string): void;
3918
4042
  }
3919
4043
 
3920
4044
  /* Excluded from this release type: MessageBus */
@@ -3952,6 +4076,19 @@ export declare namespace MoveContinuous {
3952
4076
  export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
3953
4077
  }
3954
4078
 
4079
+ /**
4080
+ * a record object mapping `InputAction`s to functions.
4081
+ *
4082
+ * @example
4083
+ * onInputDown={{
4084
+ * [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
4085
+ * [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
4086
+ * }}
4087
+ *
4088
+ * @public
4089
+ */
4090
+ export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
4091
+
3955
4092
  export declare const Name: NameComponent;
3956
4093
 
3957
4094
  export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
@@ -4324,6 +4461,25 @@ export declare const onVideoEvent: Observable<{
4324
4461
  totalVideoLength: number;
4325
4462
  }>;
4326
4463
 
4464
+ /**
4465
+ * @public
4466
+ */
4467
+ export declare interface Orthographic {
4468
+ /**
4469
+ * vertical extent of the visible range in meters
4470
+ * defaults to 4m
4471
+ */
4472
+ verticalRange?: number | undefined;
4473
+ }
4474
+
4475
+ /**
4476
+ * @public
4477
+ */
4478
+ export declare namespace Orthographic {
4479
+ export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
4480
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
4481
+ }
4482
+
4327
4483
  /**
4328
4484
  * @public
4329
4485
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -4422,45 +4578,6 @@ export declare namespace PBAssetLoadLoadingState {
4422
4578
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAssetLoadLoadingState;
4423
4579
  }
4424
4580
 
4425
- /**
4426
- * @public
4427
- */
4428
- export declare interface PBAudioAnalysis {
4429
- /** Parameters section */
4430
- mode: PBAudioAnalysisMode;
4431
- /** Used only when mode == MODE_LOGARITHMIC */
4432
- amplitudeGain?: number | undefined;
4433
- /** End when mode == MODE_LOGARITHMIC */
4434
- bandsGain?: number | undefined;
4435
- /** Result section */
4436
- amplitude: number;
4437
- /** Protobuf doesn't support fixed arrays -> 8 band fields */
4438
- band0: number;
4439
- band1: number;
4440
- band2: number;
4441
- band3: number;
4442
- band4: number;
4443
- band5: number;
4444
- band6: number;
4445
- band7: number;
4446
- }
4447
-
4448
- /**
4449
- * @public
4450
- */
4451
- export declare namespace PBAudioAnalysis {
4452
- export function encode(message: PBAudioAnalysis, writer?: _m0.Writer): _m0.Writer;
4453
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAudioAnalysis;
4454
- }
4455
-
4456
- /**
4457
- * @public
4458
- */
4459
- export declare const enum PBAudioAnalysisMode {
4460
- MODE_RAW = 0,
4461
- MODE_LOGARITHMIC = 1
4462
- }
4463
-
4464
4581
  /**
4465
4582
  * @public
4466
4583
  */
@@ -4640,6 +4757,8 @@ export declare namespace PBAvatarEmoteCommand {
4640
4757
  export declare interface PBAvatarEquippedData {
4641
4758
  wearableUrns: string[];
4642
4759
  emoteUrns: string[];
4760
+ /** slots that will render even if hidden */
4761
+ forceRender: string[];
4643
4762
  }
4644
4763
 
4645
4764
  /**
@@ -4704,6 +4823,9 @@ export declare interface PBAvatarModifierArea {
4704
4823
  excludeIds: string[];
4705
4824
  /** list of modifiers to apply */
4706
4825
  modifiers: AvatarModifierType[];
4826
+ movementSettings?: AvatarMovementSettings | undefined;
4827
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4828
+ useColliderRange?: boolean | undefined;
4707
4829
  }
4708
4830
 
4709
4831
  /**
@@ -4762,6 +4884,8 @@ export declare interface PBAvatarShape {
4762
4884
  emotes: string[];
4763
4885
  /** hides the skin + hair + facial features (default: false) */
4764
4886
  showOnlyWearables?: boolean | undefined;
4887
+ /** slots that will render even if hidden */
4888
+ forceRender: string[];
4765
4889
  }
4766
4890
 
4767
4891
  /**
@@ -4796,6 +4920,51 @@ export declare namespace PBBillboard {
4796
4920
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
4797
4921
  }
4798
4922
 
4923
+ /**
4924
+ * @public
4925
+ */
4926
+ export declare interface PBCameraLayer {
4927
+ /**
4928
+ * layer to which these settings apply. must be > 0
4929
+ * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
4930
+ */
4931
+ layer: number;
4932
+ /** should the sun light affect this layer? default false */
4933
+ directionalLight?: boolean | undefined;
4934
+ /** should this layer show player avatars? default false */
4935
+ showAvatars?: boolean | undefined;
4936
+ /** should this layer show the sky? default false */
4937
+ showSkybox?: boolean | undefined;
4938
+ /** should this layer show distance fog? default false */
4939
+ showFog?: boolean | undefined;
4940
+ /** ambient light overrides for this layer. default -> use same as main camera */
4941
+ ambientColorOverride?: PBColor3 | undefined;
4942
+ ambientBrightnessOverride?: number | undefined;
4943
+ }
4944
+
4945
+ /**
4946
+ * @public
4947
+ */
4948
+ export declare namespace PBCameraLayer {
4949
+ export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
4950
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
4951
+ }
4952
+
4953
+ /**
4954
+ * @public
4955
+ */
4956
+ export declare interface PBCameraLayers {
4957
+ layers: number[];
4958
+ }
4959
+
4960
+ /**
4961
+ * @public
4962
+ */
4963
+ export declare namespace PBCameraLayers {
4964
+ export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
4965
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
4966
+ }
4967
+
4799
4968
  /**
4800
4969
  * The CameraMode component can be used to determine whether the player is using a first-person o
4801
4970
  * third-person view.
@@ -4818,7 +4987,7 @@ export declare namespace PBCameraMode {
4818
4987
 
4819
4988
  /**
4820
4989
  * The CameraModeArea component can be attached to an Entity to define a region of space where
4821
- * the player's camera mode (1st-person or 3rd-person) is overridden.
4990
+ * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
4822
4991
  *
4823
4992
  * The Entity's Transform position determines the center-point of the region, while its size is
4824
4993
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -4828,6 +4997,8 @@ export declare namespace PBCameraMode {
4828
4997
  *
4829
4998
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
4830
4999
  * is actually a 3D volume.
5000
+ *
5001
+ * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
4831
5002
  */
4832
5003
  /**
4833
5004
  * @public
@@ -4837,6 +5008,9 @@ export declare interface PBCameraModeArea {
4837
5008
  area: PBVector3 | undefined;
4838
5009
  /** the camera mode to enforce */
4839
5010
  mode: CameraType;
5011
+ cinematicSettings?: CinematicSettings | undefined;
5012
+ /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
5013
+ useColliderRange?: boolean | undefined;
4840
5014
  }
4841
5015
 
4842
5016
  /**
@@ -4908,6 +5082,39 @@ export declare namespace PBEngineInfo {
4908
5082
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
4909
5083
  }
4910
5084
 
5085
+ /**
5086
+ * defines the global scene light settings. must be added to the scene root.
5087
+ * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
5088
+ */
5089
+ /**
5090
+ * @public
5091
+ */
5092
+ export declare interface PBGlobalLight {
5093
+ /**
5094
+ * the direction the directional light shines in.
5095
+ * default depends on time of day and explorer implementation
5096
+ */
5097
+ direction?: PBVector3 | undefined;
5098
+ /**
5099
+ * ambient light color
5100
+ * default: White
5101
+ */
5102
+ ambientColor?: PBColor3 | undefined;
5103
+ /**
5104
+ * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
5105
+ * default 1
5106
+ */
5107
+ ambientBrightness?: number | undefined;
5108
+ }
5109
+
5110
+ /**
5111
+ * @public
5112
+ */
5113
+ export declare namespace PBGlobalLight {
5114
+ export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
5115
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
5116
+ }
5117
+
4911
5118
  /**
4912
5119
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
4913
5120
  *
@@ -4943,6 +5150,25 @@ export declare namespace PBGltfContainer {
4943
5150
  */
4944
5151
  export declare interface PBGltfContainerLoadingState {
4945
5152
  currentState: LoadingState;
5153
+ /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
5154
+ nodePaths: string[];
5155
+ /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
5156
+ meshNames: string[];
5157
+ /**
5158
+ * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
5159
+ * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
5160
+ */
5161
+ materialNames: string[];
5162
+ /**
5163
+ * X is the material index. note this may conflict with manually named materials - to avoid any issues make
5164
+ * sure all your materials are explicitly named.
5165
+ */
5166
+ skinNames: string[];
5167
+ /**
5168
+ * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
5169
+ * your skins are explicitly named.
5170
+ */
5171
+ animationNames: string[];
4946
5172
  }
4947
5173
 
4948
5174
  /**
@@ -4953,6 +5179,57 @@ export declare namespace PBGltfContainerLoadingState {
4953
5179
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
4954
5180
  }
4955
5181
 
5182
+ /**
5183
+ * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
5184
+ * This component must be added to a direct child of an entity with a PBGltfContainer component, or
5185
+ * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
5186
+ * in the parent.
5187
+ * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
5188
+ *
5189
+ * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
5190
+ * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
5191
+ * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
5192
+ * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
5193
+ * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
5194
+ *
5195
+ * After creation, if an animation moves the node, the `Transform` will be updated.
5196
+ *
5197
+ * From the scene, you can modify various components to alter the gltf node:
5198
+ * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
5199
+ * regardless of any intermediate gltf node hierarchy.
5200
+ * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
5201
+ * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
5202
+ * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
5203
+ * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
5204
+ * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
5205
+ * 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
5206
+ * PBMaterial will be maintained.
5207
+ *
5208
+ * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
5209
+ * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
5210
+ * change the state to `GNS_FAILED`.
5211
+ * - deleting the scene entity will not delete the gltf node.
5212
+ *
5213
+ * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
5214
+ * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
5215
+ * the gltf node will also be displayed.
5216
+ */
5217
+ /**
5218
+ * @public
5219
+ */
5220
+ export declare interface PBGltfNode {
5221
+ /** the path of the target node in the Gltf. */
5222
+ path: string;
5223
+ }
5224
+
5225
+ /**
5226
+ * @public
5227
+ */
5228
+ export declare namespace PBGltfNode {
5229
+ export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
5230
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
5231
+ }
5232
+
4956
5233
  /**
4957
5234
  * GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
4958
5235
  *
@@ -4998,6 +5275,26 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
4998
5275
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
4999
5276
  }
5000
5277
 
5278
+ /**
5279
+ * The state of a linked gltf node.
5280
+ * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
5281
+ */
5282
+ /**
5283
+ * @public
5284
+ */
5285
+ export declare interface PBGltfNodeState {
5286
+ state: GltfNodeStateValue;
5287
+ error?: string | undefined;
5288
+ }
5289
+
5290
+ /**
5291
+ * @public
5292
+ */
5293
+ export declare namespace PBGltfNodeState {
5294
+ export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
5295
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
5296
+ }
5297
+
5001
5298
  /**
5002
5299
  * @public
5003
5300
  */
@@ -5133,6 +5430,14 @@ export declare interface PBMaterial {
5133
5430
  $case: "pbr";
5134
5431
  pbr: PBMaterial_PbrMaterial;
5135
5432
  } | undefined;
5433
+ /**
5434
+ * A gltf material that may provide additional features not supported by the PbMaterial fields.
5435
+ * If both gltf and material fields are provided, the gltf will be used only for extended features not
5436
+ * supported by the PbMaterial.
5437
+ * If this is provided and the `material` field is not provided, the renderer will update the material
5438
+ * field with data that reflects the gltf material once it is loaded.
5439
+ */
5440
+ gltf?: PBMaterial_GltfMaterial | undefined;
5136
5441
  }
5137
5442
 
5138
5443
  /**
@@ -5143,6 +5448,22 @@ export declare namespace PBMaterial {
5143
5448
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
5144
5449
  }
5145
5450
 
5451
+ /**
5452
+ * @public
5453
+ */
5454
+ export declare interface PBMaterial_GltfMaterial {
5455
+ gltfSrc: string;
5456
+ name: string;
5457
+ }
5458
+
5459
+ /**
5460
+ * @public
5461
+ */
5462
+ export declare namespace PBMaterial_GltfMaterial {
5463
+ export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
5464
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
5465
+ }
5466
+
5146
5467
  /**
5147
5468
  * @public
5148
5469
  */
@@ -5239,6 +5560,9 @@ export declare interface PBMeshCollider {
5239
5560
  } | {
5240
5561
  $case: "plane";
5241
5562
  plane: PBMeshCollider_PlaneMesh;
5563
+ } | {
5564
+ $case: "gltf";
5565
+ gltf: PBMeshCollider_GltfMesh;
5242
5566
  } | undefined;
5243
5567
  }
5244
5568
 
@@ -5284,6 +5608,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
5284
5608
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
5285
5609
  }
5286
5610
 
5611
+ /** A collider constructed from a Gltf Mesh. */
5612
+ /**
5613
+ * @public
5614
+ */
5615
+ export declare interface PBMeshCollider_GltfMesh {
5616
+ /** the GLTF file path as listed in the scene's manifest. */
5617
+ gltfSrc: string;
5618
+ /** the name of the mesh asset */
5619
+ name: string;
5620
+ }
5621
+
5622
+ /**
5623
+ * @public
5624
+ */
5625
+ export declare namespace PBMeshCollider_GltfMesh {
5626
+ export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5627
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
5628
+ }
5629
+
5287
5630
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
5288
5631
  /**
5289
5632
  * @public
@@ -5316,13 +5659,11 @@ export declare namespace PBMeshCollider_SphereMesh {
5316
5659
 
5317
5660
  /**
5318
5661
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
5319
- * plane, a sphere or a cylinder.
5662
+ * plane, a sphere, a cylinder, or a Gltf mesh.
5320
5663
  *
5321
5664
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
5322
5665
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
5323
5666
  * `float` coordinates, one for each corner of each side of each face.
5324
- *
5325
- * More complex shapes require the use of a `GltfContainer` component.
5326
5667
  */
5327
5668
  /**
5328
5669
  * @public
@@ -5340,6 +5681,9 @@ export declare interface PBMeshRenderer {
5340
5681
  } | {
5341
5682
  $case: "plane";
5342
5683
  plane: PBMeshRenderer_PlaneMesh;
5684
+ } | {
5685
+ $case: "gltf";
5686
+ gltf: PBMeshRenderer_GltfMesh;
5343
5687
  } | undefined;
5344
5688
  }
5345
5689
 
@@ -5387,6 +5731,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
5387
5731
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
5388
5732
  }
5389
5733
 
5734
+ /** A mesh from a Gltf. */
5735
+ /**
5736
+ * @public
5737
+ */
5738
+ export declare interface PBMeshRenderer_GltfMesh {
5739
+ /** the GLTF file path as listed in the scene's manifest. */
5740
+ gltfSrc: string;
5741
+ /** the name of the mesh asset */
5742
+ name: string;
5743
+ }
5744
+
5745
+ /**
5746
+ * @public
5747
+ */
5748
+ export declare namespace PBMeshRenderer_GltfMesh {
5749
+ export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5750
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
5751
+ }
5752
+
5390
5753
  /** PlaneMesh renders a 2D rectangular shape. */
5391
5754
  /**
5392
5755
  * @public
@@ -5660,7 +6023,10 @@ export declare interface PBPrimaryPointerInfo {
5660
6023
  screenCoordinates?: PBVector2 | undefined;
5661
6024
  /** Movement since last frame (pixels) */
5662
6025
  screenDelta?: PBVector2 | undefined;
5663
- /** Direction vector for 3D ray casting */
6026
+ /**
6027
+ * ray direction that can be used with the primary camera origin for
6028
+ * raycasting from the cursor into the world
6029
+ */
5664
6030
  worldRayDirection?: PBVector3 | undefined;
5665
6031
  }
5666
6032
 
@@ -5886,6 +6252,46 @@ export declare namespace PBTextShape {
5886
6252
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
5887
6253
  }
5888
6254
 
6255
+ /**
6256
+ * @public
6257
+ */
6258
+ export declare interface PBTextureCamera {
6259
+ /** rendered texture width */
6260
+ width?: number | undefined;
6261
+ /** rendered texture height */
6262
+ height?: number | undefined;
6263
+ /**
6264
+ * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
6265
+ * defaults to 0
6266
+ */
6267
+ layer?: number | undefined;
6268
+ /** default black */
6269
+ clearColor?: PBColor4 | undefined;
6270
+ /** default infinity */
6271
+ farPlane?: number | undefined;
6272
+ mode?: {
6273
+ $case: "perspective";
6274
+ perspective: Perspective;
6275
+ } | {
6276
+ $case: "orthographic";
6277
+ orthographic: Orthographic;
6278
+ } | undefined;
6279
+ /**
6280
+ * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
6281
+ * range: 0 (off) - 1 (full volume)
6282
+ * default: 0
6283
+ */
6284
+ volume?: number | undefined;
6285
+ }
6286
+
6287
+ /**
6288
+ * @public
6289
+ */
6290
+ export declare namespace PBTextureCamera {
6291
+ export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
6292
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
6293
+ }
6294
+
5889
6295
  /**
5890
6296
  * The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
5891
6297
  * when entities enter this component's defined area.
@@ -6064,6 +6470,25 @@ export declare namespace PBUiBackground {
6064
6470
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
6065
6471
  }
6066
6472
 
6473
+ /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
6474
+ /**
6475
+ * @public
6476
+ */
6477
+ export declare interface PBUiCanvas {
6478
+ width: number;
6479
+ height: number;
6480
+ /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
6481
+ color?: PBColor4 | undefined;
6482
+ }
6483
+
6484
+ /**
6485
+ * @public
6486
+ */
6487
+ export declare namespace PBUiCanvas {
6488
+ export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
6489
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
6490
+ }
6491
+
6067
6492
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
6068
6493
  /**
6069
6494
  * @public
@@ -6180,6 +6605,21 @@ export declare namespace PBUiInputResult {
6180
6605
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
6181
6606
  }
6182
6607
 
6608
+ /**
6609
+ * @public
6610
+ */
6611
+ export declare interface PBUiScrollResult {
6612
+ value: PBVector2 | undefined;
6613
+ }
6614
+
6615
+ /**
6616
+ * @public
6617
+ */
6618
+ export declare namespace PBUiScrollResult {
6619
+ export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
6620
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
6621
+ }
6622
+
6183
6623
  /**
6184
6624
  * @public
6185
6625
  */
@@ -6196,6 +6636,10 @@ export declare interface PBUiText {
6196
6636
  fontSize?: number | undefined;
6197
6637
  /** wrap text when the border is reached (default: TW_WRAP) */
6198
6638
  textWrap?: TextWrap | undefined;
6639
+ /** width of the outline (default: 0) */
6640
+ outlineWidth?: number | undefined;
6641
+ /** RGBA color of the outline (default: opaque black) */
6642
+ outlineColor?: PBColor4 | undefined;
6199
6643
  }
6200
6644
 
6201
6645
  /**
@@ -6323,6 +6767,12 @@ export declare interface PBUiTransform {
6323
6767
  borderRightColor?: PBColor4 | undefined;
6324
6768
  /** default: 1 */
6325
6769
  opacity?: number | undefined;
6770
+ /** reference for scroll_position. default empty */
6771
+ elementId?: string | undefined;
6772
+ /** default position=(0,0) */
6773
+ scrollPosition?: ScrollPositionValue | undefined;
6774
+ /** default ShowScrollBar.SSB_BOTH */
6775
+ scrollVisible?: ShowScrollBar | undefined;
6326
6776
  /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
6327
6777
  zIndex?: number | undefined;
6328
6778
  }
@@ -6431,7 +6881,6 @@ export declare namespace PBVideoPlayer {
6431
6881
  * an 'instant' transition (like using speed/time = 0)
6432
6882
  * * The lookAtEntity defines to which entity the Camera has to look at constantly (independent from
6433
6883
  * the holding entity transform).
6434
- * * The fov defines the Field of View of the virtual camera
6435
6884
  */
6436
6885
  /**
6437
6886
  * @public
@@ -6439,8 +6888,6 @@ export declare namespace PBVideoPlayer {
6439
6888
  export declare interface PBVirtualCamera {
6440
6889
  defaultTransition?: CameraTransition | undefined;
6441
6890
  lookAtEntity?: number | undefined;
6442
- /** default: 60 */
6443
- fov?: number | undefined;
6444
6891
  }
6445
6892
 
6446
6893
  /**
@@ -6475,6 +6922,25 @@ export declare namespace PBVisibilityComponent {
6475
6922
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
6476
6923
  }
6477
6924
 
6925
+ /**
6926
+ * @public
6927
+ */
6928
+ export declare interface Perspective {
6929
+ /**
6930
+ * vertical field of view in radians
6931
+ * defaults to pi/4 = 45 degrees
6932
+ */
6933
+ fieldOfView?: number | undefined;
6934
+ }
6935
+
6936
+ /**
6937
+ * @public
6938
+ */
6939
+ export declare namespace Perspective {
6940
+ export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
6941
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
6942
+ }
6943
+
6478
6944
  /**
6479
6945
  * Represens a plane by the equation ax + by + cz + d = 0
6480
6946
  * @public
@@ -6630,11 +7096,37 @@ export declare interface PointerEventsSystem {
6630
7096
  * @param entity - Entity where the callback was attached
6631
7097
  */
6632
7098
  removeOnPointerHoverLeave(entity: Entity): void;
7099
+ /**
7100
+ * @public
7101
+ * Remove the callback for onPointerDrag event
7102
+ * @param entity - Entity where the callback was attached
7103
+ */
7104
+ removeOnPointerDrag(entity: Entity): void;
7105
+ /**
7106
+ * @public
7107
+ * Remove the callback for onPointerDragLocked event
7108
+ * @param entity - Entity where the callback was attached
7109
+ */
7110
+ removeOnPointerDragLocked(entity: Entity): void;
7111
+ /**
7112
+ * @public
7113
+ * Remove the callback for onPointerDragEnd event
7114
+ * @param entity - Entity where the callback was attached
7115
+ */
7116
+ removeOnPointerDragEnd(entity: Entity): void;
7117
+ /**
7118
+ * @public
7119
+ * Execute callbacks when the user presses one of the InputButtons pointing at the entity
7120
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7121
+ */
7122
+ onPointerDown(pointerData: {
7123
+ entity: Entity;
7124
+ optsList: EventSystemOptionsCallback[];
7125
+ }): void;
6633
7126
  /**
6634
7127
  * @public
6635
7128
  * Execute callback when the user press the InputButton pointing at the entity
6636
7129
  * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
6637
- * @param cb - Function to execute when click fires
6638
7130
  */
6639
7131
  onPointerDown(pointerData: {
6640
7132
  entity: Entity;
@@ -6647,6 +7139,15 @@ export declare interface PointerEventsSystem {
6647
7139
  * @param opts - Opts to trigger Feedback and Button
6648
7140
  */
6649
7141
  onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
7142
+ /**
7143
+ * @public
7144
+ * Execute callbacks when the user releases one of the InputButtons pointing at the entity
7145
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7146
+ */
7147
+ onPointerUp(pointerData: {
7148
+ entity: Entity;
7149
+ optsList: EventSystemOptionsCallback[];
7150
+ }): void;
6650
7151
  /**
6651
7152
  * @public
6652
7153
  * Execute callback when the user releases the InputButton pointing at the entity
@@ -6684,6 +7185,64 @@ export declare interface PointerEventsSystem {
6684
7185
  entity: Entity;
6685
7186
  opts?: Partial<EventSystemOptions>;
6686
7187
  }, cb: EventSystemCallback): void;
7188
+ /**
7189
+ * @public
7190
+ * Execute callbacks when the user drags the pointer from inside the entity
7191
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7192
+ */
7193
+ onPointerDrag(pointerData: {
7194
+ entity: Entity;
7195
+ optsList: EventSystemOptionsCallback[];
7196
+ }): void;
7197
+ /**
7198
+ * @public
7199
+ * Execute callback when the user clicks and drags the pointer from inside the entity
7200
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
7201
+ * @param cb - Function to execute when click fires
7202
+ */
7203
+ onPointerDrag(pointerData: {
7204
+ entity: Entity;
7205
+ opts?: Partial<EventSystemOptions>;
7206
+ }, cb: EventSystemCallback): void;
7207
+ /**
7208
+ * @public
7209
+ * Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
7210
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7211
+ */
7212
+ onPointerDragLocked(pointerData: {
7213
+ entity: Entity;
7214
+ optsList: EventSystemOptionsCallback[];
7215
+ }): void;
7216
+ /**
7217
+ * @public
7218
+ * Execute callback when the user clicks and drags the pointer from inside the entity,
7219
+ * locking the cursor in place
7220
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
7221
+ * @param cb - Function to execute when click fires
7222
+ */
7223
+ onPointerDragLocked(pointerData: {
7224
+ entity: Entity;
7225
+ opts?: Partial<EventSystemOptions>;
7226
+ }, cb: EventSystemCallback): void;
7227
+ /**
7228
+ * @public
7229
+ * Execute callbacks when the user releases a button after a drag
7230
+ * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7231
+ */
7232
+ onPointerDragEnd(pointerData: {
7233
+ entity: Entity;
7234
+ optsList: EventSystemOptionsCallback[];
7235
+ }): void;
7236
+ /**
7237
+ * @public
7238
+ * Execute callback when the user releases the button after a drag
7239
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
7240
+ * @param cb - Function to execute when click fires
7241
+ */
7242
+ onPointerDragEnd(pointerData: {
7243
+ entity: Entity;
7244
+ opts?: Partial<EventSystemOptions>;
7245
+ }, cb: EventSystemCallback): void;
6687
7246
  }
6688
7247
 
6689
7248
  /**
@@ -6700,7 +7259,10 @@ export declare const enum PointerEventType {
6700
7259
  PET_UP = 0,
6701
7260
  PET_DOWN = 1,
6702
7261
  PET_HOVER_ENTER = 2,
6703
- PET_HOVER_LEAVE = 3
7262
+ PET_HOVER_LEAVE = 3,
7263
+ PET_DRAG_LOCKED = 4,
7264
+ PET_DRAG = 5,
7265
+ PET_DRAG_END = 6
6704
7266
  }
6705
7267
 
6706
7268
  /**
@@ -6731,7 +7293,10 @@ export declare const enum PointerType {
6731
7293
  /** POT_NONE - No pointer input */
6732
7294
  POT_NONE = 0,
6733
7295
  /** POT_MOUSE - Traditional mouse input */
6734
- POT_MOUSE = 1
7296
+ POT_MOUSE = 1,
7297
+ POT_PAD = 2,
7298
+ POT_TOUCH = 3,
7299
+ POT_WAND = 4
6735
7300
  }
6736
7301
 
6737
7302
  /**
@@ -7334,6 +7899,11 @@ export declare interface ReactBasedUiSystem {
7334
7899
  * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
7335
7900
  */
7336
7901
  setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
7902
+ /**
7903
+ * Set a texture renderer for a specific entity.
7904
+ * @deprecated Use addUiRenderer instead
7905
+ */
7906
+ setTextureRenderer(entity: Entity, ui: UiComponent): void;
7337
7907
  /**
7338
7908
  * Add a UI renderer associated with an entity. The UI will be automatically cleaned up
7339
7909
  * when the entity is removed from the engine.
@@ -7917,6 +8487,43 @@ export declare namespace Schemas {
7917
8487
  }) => void;
7918
8488
  }
7919
8489
 
8490
+ /**
8491
+ * @public
8492
+ */
8493
+ export declare interface ScrollPositionValue {
8494
+ value?: {
8495
+ $case: "position";
8496
+ position: PBVector2;
8497
+ } | {
8498
+ $case: "reference";
8499
+ reference: string;
8500
+ } | undefined;
8501
+ }
8502
+
8503
+ /**
8504
+ * @public
8505
+ */
8506
+ export declare namespace ScrollPositionValue {
8507
+ export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
8508
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
8509
+ }
8510
+
8511
+ /**
8512
+ * @public
8513
+ * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
8514
+ */
8515
+ export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
8516
+
8517
+ /**
8518
+ * @public
8519
+ */
8520
+ export declare const enum ShowScrollBar {
8521
+ SSB_BOTH = 0,
8522
+ SSB_ONLY_VERTICAL = 1,
8523
+ SSB_ONLY_HORIZONTAL = 2,
8524
+ SSB_HIDDEN = 3
8525
+ }
8526
+
7920
8527
  /** @public */
7921
8528
  export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
7922
8529
 
@@ -8023,6 +8630,9 @@ export declare namespace Texture {
8023
8630
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
8024
8631
  }
8025
8632
 
8633
+ /** @public */
8634
+ export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
8635
+
8026
8636
  /**
8027
8637
  * @public
8028
8638
  */
@@ -8133,6 +8743,9 @@ export declare interface TextureUnion {
8133
8743
  } | {
8134
8744
  $case: "videoTexture";
8135
8745
  videoTexture: VideoTexture;
8746
+ } | {
8747
+ $case: "uiTexture";
8748
+ uiTexture: UiCanvasTexture;
8136
8749
  } | undefined;
8137
8750
  }
8138
8751
 
@@ -8610,6 +9223,8 @@ export declare interface UiBackgroundProps {
8610
9223
  uvs?: number[];
8611
9224
  /** AvatarTexture for the background */
8612
9225
  avatarTexture?: UiAvatarTexture;
9226
+ /** VideoTexture for the background */
9227
+ videoTexture?: UiVideoTexture;
8613
9228
  /** Texture for the background */
8614
9229
  texture?: UiTexture;
8615
9230
  }
@@ -8629,9 +9244,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
8629
9244
  disabled?: boolean;
8630
9245
  }
8631
9246
 
9247
+ /** @public */
9248
+ export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
9249
+
8632
9250
  /** @public */
8633
9251
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
8634
9252
 
9253
+ /**
9254
+ * @public
9255
+ */
9256
+ export declare interface UiCanvasTexture {
9257
+ uiCanvasEntity: number;
9258
+ /** default = TextureWrapMode.Clamp */
9259
+ wrapMode?: TextureWrapMode | undefined;
9260
+ /** default = FilterMode.Bilinear */
9261
+ filterMode?: TextureFilterMode | undefined;
9262
+ }
9263
+
9264
+ /**
9265
+ * @public
9266
+ */
9267
+ export declare namespace UiCanvasTexture {
9268
+ export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
9269
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
9270
+ }
9271
+
8635
9272
  /**
8636
9273
  * @public
8637
9274
  */
@@ -8701,6 +9338,10 @@ export declare interface UiLabelProps {
8701
9338
  textAlign?: TextAlignType | undefined;
8702
9339
  /** Label font type. @defaultValue 'sans-serif' */
8703
9340
  font?: UiFontType | undefined;
9341
+ /** Outline width of the text. @defaultValue 0 */
9342
+ outlineWidth?: number | undefined;
9343
+ /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
9344
+ outlineColor?: PBColor4 | undefined;
8704
9345
  /** Behaviour when text reached. @defaultValue 'wrap' */
8705
9346
  textWrap?: UiTextWrapType | undefined;
8706
9347
  }
@@ -8718,6 +9359,9 @@ export declare type UiRendererOptions = {
8718
9359
  virtualHeight: number;
8719
9360
  };
8720
9361
 
9362
+ /** @public */
9363
+ export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
9364
+
8721
9365
  /** @public */
8722
9366
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
8723
9367
 
@@ -8795,10 +9439,26 @@ export declare interface UiTransformProps {
8795
9439
  borderWidth?: Partial<Position> | PositionUnit;
8796
9440
  /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
8797
9441
  opacity?: number;
9442
+ /** A reference value to identify the element, default empty */
9443
+ elementId?: string;
9444
+ /** default position=(0,0) if it aplies, a vector or a reference-id */
9445
+ scrollPosition?: PBVector2 | string;
9446
+ /** default ShowScrollBar.SSB_BOTH */
9447
+ scrollVisible?: ScrollVisibleType;
8798
9448
  /** default 0 */
8799
9449
  zIndex?: number;
8800
9450
  }
8801
9451
 
9452
+ /**
9453
+ * Texture
9454
+ * @public
9455
+ */
9456
+ export declare interface UiVideoTexture {
9457
+ videoPlayerEntity: Entity;
9458
+ wrapMode?: TextureWrapType;
9459
+ filterMode?: TextureFilterType;
9460
+ }
9461
+
8802
9462
  /**
8803
9463
  * @public
8804
9464
  */