@dcl/playground-assets 7.28.1-34901226656.commit-44656ea → 7.28.1-34955459026.commit-7db2d46

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/alpha.d.ts CHANGED
@@ -245,6 +245,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
245
245
  getAudioState(entity: Entity): PBAudioEvent | undefined;
246
246
  }
247
247
 
248
+ /**
249
+ * @public
250
+ */
251
+ export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
252
+
253
+ /**
254
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
255
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
256
+ *
257
+ * @param entity - Uint32 number of the entity
258
+ * @param componentId - Uint32 number of id
259
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
260
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
261
+ * @public
262
+ */
263
+ export declare type AuthoritativePutComponentMessageBody = {
264
+ type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
265
+ entityId: Entity;
266
+ componentId: number;
267
+ timestamp: number;
268
+ data: Uint8Array;
269
+ };
270
+
271
+ /**
272
+ * @public
273
+ */
274
+ export declare namespace AuthoritativePutComponentOperation {
275
+ const MESSAGE_HEADER_LENGTH = 16;
276
+ /**
277
+ * Call this function for an optimal writing data passing the ByteBuffer
278
+ * already allocated
279
+ */
280
+ export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
281
+ export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
282
+ }
283
+
248
284
  /** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
249
285
  /**
250
286
  * @public
@@ -279,39 +315,6 @@ export declare const enum AvatarAnchorPointType {
279
315
  AAPT_RIGHT_TOE_BASE = 25
280
316
  }
281
317
 
282
- /**
283
- * Mirror of the scene-driven movement animation currently playing, reported by the engine.
284
- * Readable by any scene (not just the controller) so niche effects (e.g. dust cloud on landing) can react.
285
- * Active emotes are not represented here — scenes already have their own way to read them.
286
- */
287
- /**
288
- * @public
289
- */
290
- export declare interface AvatarAnimationState {
291
- /** same scene-relative path the controlling scene supplied */
292
- src: string;
293
- /** mirrors the request */
294
- loop: boolean;
295
- /** mirrors the request */
296
- speed: number;
297
- /** mirrors the request */
298
- idle: boolean;
299
- /** seconds into the clip; wraps on loop; frozen while an emote override is playing */
300
- playbackTime: number;
301
- /** total clip length in seconds */
302
- duration: number;
303
- /** how many times the clip has completed since it started */
304
- loopCount: number;
305
- }
306
-
307
- /**
308
- * @public
309
- */
310
- export declare namespace AvatarAnimationState {
311
- export function encode(message: AvatarAnimationState, writer?: _m0.Writer): _m0.Writer;
312
- export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarAnimationState;
313
- }
314
-
315
318
  /** @public */
316
319
  export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBAvatarAttach>;
317
320
 
@@ -321,21 +324,8 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
321
324
  /** @public */
322
325
  export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
323
326
 
324
- export declare const AvatarEquippedData: AvatarEquippedDataComponentDefinitionExtended;
325
-
326
- /**
327
- * @public
328
- */
329
- export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
330
-
331
- /**
332
- * @public
333
- * AvatarEquippedData with `forceRender` optional: the wire type is a repeated field (always present, so the
334
- * generated type requires it), but a scene rarely needs it and shouldn't have to pass `[]`.
335
- */
336
- export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
337
- forceRender?: string[] | undefined;
338
- };
327
+ /** @public */
328
+ export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
339
329
 
340
330
  /** @public */
341
331
  export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
@@ -364,30 +354,11 @@ export declare const enum AvatarModifierType {
364
354
  AMT_HIDE_NAMETAGS = 2
365
355
  }
366
356
 
367
- /** @public */
368
- export declare const AvatarMovement: LastWriteWinElementSetComponentDefinition<PBAvatarMovement>;
369
-
370
- /** @public */
371
- export declare const AvatarMovementInfo: LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>;
372
-
373
357
  /** @public */
374
358
  export declare const AvatarNametag: LastWriteWinElementSetComponentDefinition<PBAvatarNametag>;
375
359
 
376
- export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
377
-
378
- /**
379
- * @public
380
- */
381
- export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
382
-
383
- /**
384
- * @public
385
- * AvatarShape with `forceRender` optional: the wire type is a repeated field (always present, so the
386
- * generated type requires it), but a scene rarely needs it and shouldn't have to pass `[]`.
387
- */
388
- export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
389
- forceRender?: string[] | undefined;
390
- };
360
+ /** @public */
361
+ export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
391
362
 
392
363
  /**
393
364
  * @public
@@ -485,6 +456,22 @@ export declare interface BaseComponent<T> {
485
456
  * If the value is undefined, the component was deleted.
486
457
  */
487
458
  onChange(entity: Entity, cb: (value: T | undefined) => void): void;
459
+ /**
460
+ * @public
461
+ *
462
+ */
463
+ validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
464
+ validateBeforeChange(cb: ValidateCallback<T>): void;
465
+ /**
466
+ * Get the CRDT state for an entity (serialized data and timestamp)
467
+ * @param entity - Entity to get the CRDT state for
468
+ * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
469
+ * @public
470
+ */
471
+ getCrdtState(entity: Entity): {
472
+ data: Uint8Array;
473
+ timestamp: number;
474
+ } | null;
488
475
  }
489
476
 
490
477
  /** @public */
@@ -656,17 +643,10 @@ export declare interface ByteBuffer {
656
643
  }
657
644
 
658
645
  /**
659
- * Callback function to be triggered on a specified event. Receives the pointer event that
660
- * fired it (button, hit, and for drags the pointer delta), which handlers may ignore.
646
+ * Callback function to be triggered on a specified event
661
647
  * @public
662
648
  */
663
- export declare type Callback = (event: PBPointerEventsResult) => void;
664
-
665
- /** @public */
666
- export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
667
-
668
- /** @public */
669
- export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
649
+ export declare type Callback = () => void;
670
650
 
671
651
  /** @public */
672
652
  export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
@@ -1519,23 +1499,16 @@ export declare const componentDefinitionByName: {
1519
1499
  "core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
1520
1500
  "core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
1521
1501
  "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
1522
- "core::AvatarMovement": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovement>>;
1523
- "core::AvatarMovementInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>>;
1524
1502
  "core::AvatarNametag": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarNametag>>;
1525
1503
  "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
1526
1504
  "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
1527
- "core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
1528
- "core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
1529
1505
  "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
1530
1506
  "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
1531
1507
  "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
1532
1508
  "core::ExplorerUiEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>>;
1533
- "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
1534
1509
  "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
1535
1510
  "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
1536
- "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
1537
1511
  "core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
1538
- "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
1539
1512
  "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
1540
1513
  "core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
1541
1514
  "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
@@ -1556,7 +1529,6 @@ export declare const componentDefinitionByName: {
1556
1529
  "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
1557
1530
  "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
1558
1531
  "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
1559
- "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
1560
1532
  "core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
1561
1533
  "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
1562
1534
  "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
@@ -1564,14 +1536,12 @@ export declare const componentDefinitionByName: {
1564
1536
  "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
1565
1537
  "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
1566
1538
  "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
1567
- "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
1568
1539
  "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
1569
1540
  "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
1570
1541
  "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
1571
1542
  "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
1572
1543
  "core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
1573
1544
  "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
1574
- "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
1575
1545
  "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
1576
1546
  "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
1577
1547
  "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -1744,12 +1714,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
1744
1714
  /**
1745
1715
  * @public
1746
1716
  */
1747
- export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
1717
+ export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
1748
1718
 
1749
1719
  /**
1750
1720
  * @public
1751
1721
  */
1752
- export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
1722
+ export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
1753
1723
 
1754
1724
  /**
1755
1725
  * Min length = 8 bytes
@@ -1804,7 +1774,8 @@ export declare enum CrdtMessageType {
1804
1774
  PUT_COMPONENT_NETWORK = 5,
1805
1775
  DELETE_COMPONENT_NETWORK = 6,
1806
1776
  DELETE_ENTITY_NETWORK = 7,
1807
- MAX_MESSAGE_TYPE = 8
1777
+ AUTHORITATIVE_PUT_COMPONENT = 8,
1778
+ MAX_MESSAGE_TYPE = 9
1808
1779
  }
1809
1780
 
1810
1781
  /**
@@ -1812,6 +1783,8 @@ export declare enum CrdtMessageType {
1812
1783
  */
1813
1784
  export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
1814
1785
 
1786
+ export declare const CreatedBy: ICreatedBy;
1787
+
1815
1788
  /**
1816
1789
  * @public
1817
1790
  */
@@ -2191,9 +2164,6 @@ export declare type EntityComponents = {
2191
2164
  onMouseUp: Callback;
2192
2165
  onMouseEnter: Callback;
2193
2166
  onMouseLeave: Callback;
2194
- onMouseDrag: Callback;
2195
- onMouseDragLocked: Callback;
2196
- onMouseDragEnd: Callback;
2197
2167
  };
2198
2168
 
2199
2169
  /** @public */
@@ -2548,9 +2518,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
2548
2518
  direction?: PBVector3;
2549
2519
  };
2550
2520
 
2551
- /** @public */
2552
- export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
2553
-
2554
2521
  export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
2555
2522
 
2556
2523
  export declare type GlobalTargetRaycastSystemOptions = {
@@ -2563,24 +2530,9 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
2563
2530
  /** @public */
2564
2531
  export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
2565
2532
 
2566
- /** @public */
2567
- export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
2568
-
2569
2533
  /** @public */
2570
2534
  export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
2571
2535
 
2572
- /** @public */
2573
- export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
2574
-
2575
- /**
2576
- * @public
2577
- */
2578
- export declare const enum GltfNodeStateValue {
2579
- GNSV_PENDING = 0,
2580
- GNSV_FAILED = 1,
2581
- GNSV_READY = 2
2582
- }
2583
-
2584
2536
  /**
2585
2537
  * @public
2586
2538
  */
@@ -2604,6 +2556,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
2604
2556
 
2605
2557
  export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
2606
2558
 
2559
+ export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
2560
+
2561
+ export declare interface ICreatedByType {
2562
+ address: string;
2563
+ }
2564
+
2607
2565
  /**
2608
2566
  * @public
2609
2567
  */
@@ -3086,6 +3044,35 @@ export declare const enum InteractionType {
3086
3044
  PROXIMITY = 1
3087
3045
  }
3088
3046
 
3047
+ /**
3048
+ * Internal component interface that exposes all internal methods for SDK use
3049
+ * This is not exposed to users, only for internal SDK operations
3050
+ */
3051
+ export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
3052
+ /**
3053
+ * @public
3054
+ * Dry run update to check if a CRDT message would be accepted without actually applying it
3055
+ */
3056
+ __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
3057
+ /**
3058
+ * @public
3059
+ * Get the iterator to every entity has the component
3060
+ */
3061
+ iterator(): Iterable<[Entity, any]>;
3062
+ /**
3063
+ * @public
3064
+ */
3065
+ dirtyIterator(): Iterable<Entity>;
3066
+ /**
3067
+ * @public
3068
+ */
3069
+ __onChangeCallbacks(entity: Entity, value: T): void;
3070
+ /**
3071
+ * @public
3072
+ */
3073
+ __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
3074
+ }
3075
+
3089
3076
  /**
3090
3077
  * @public
3091
3078
  */
@@ -3289,12 +3276,6 @@ export declare type Listeners = {
3289
3276
  onMouseEnter?: Callback;
3290
3277
  /** triggered on mouse leave event */
3291
3278
  onMouseLeave?: Callback;
3292
- /** triggered while the pointer is dragged after pressing on the element */
3293
- onMouseDrag?: Callback;
3294
- /** triggered while the pointer is dragged with the cursor locked in place */
3295
- onMouseDragLocked?: Callback;
3296
- /** triggered when a drag that started on the element ends */
3297
- onMouseDragEnd?: Callback;
3298
3279
  };
3299
3280
 
3300
3281
  /**
@@ -4199,15 +4180,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
4199
4180
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
4200
4181
  */
4201
4182
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
4202
- /**
4203
- * @public
4204
- * Set a mesh from inside a gltf in the MeshCollider component
4205
- * @param entity - entity to create or replace the MeshCollider component
4206
- * @param source - the path to the gltf
4207
- * @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
4208
- * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
4209
- */
4210
- setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
4211
4183
  }
4212
4184
 
4213
4185
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -4244,14 +4216,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
4244
4216
  * @param entity - entity to create or replace the MeshRenderer component
4245
4217
  */
4246
4218
  setSphere(entity: Entity): void;
4247
- /**
4248
- * @public
4249
- * Set a mesh from inside a gltf in the MeshRenderer component
4250
- * @param entity - entity to create or replace the MeshRenderer component
4251
- * @param source - the path to the gltf
4252
- * @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
4253
- */
4254
- setGltfMesh(entity: Entity, source: string, meshName: string): void;
4255
4219
  }
4256
4220
 
4257
4221
  /**
@@ -4300,39 +4264,6 @@ export declare namespace MoveContinuous {
4300
4264
  export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
4301
4265
  }
4302
4266
 
4303
- /**
4304
- * Describes the animation the movement scene wants the avatar to play.
4305
- * One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
4306
- * When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
4307
- */
4308
- /**
4309
- * @public
4310
- */
4311
- export declare interface MovementAnimation {
4312
- /** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
4313
- src: string;
4314
- /** whether the clip repeats once it reaches the end */
4315
- loop: boolean;
4316
- /** playback speed multiplier (1.0 = clip's native rate) */
4317
- speed: number;
4318
- /** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
4319
- idle: boolean;
4320
- /** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
4321
- transitionSeconds?: number | undefined;
4322
- /** if set, the engine seeks to this position (in seconds) this frame. Clear on subsequent frames to allow normal playback. The scene can read `AvatarAnimationState.playback_time` first to decide. */
4323
- playbackTime?: number | undefined;
4324
- /** scene-relative paths to audio clips (.mp3/.ogg) to play this frame on the avatar audio bus. Fire-and-forget: each listed clip plays once per frame it appears; leaving a clip set for multiple frames re-triggers it. No stop mechanism. Use `AvatarAnimationState.playback_time` to trigger sounds at the right point in the clip (e.g. foot plants). */
4325
- sounds: string[];
4326
- }
4327
-
4328
- /**
4329
- * @public
4330
- */
4331
- export declare namespace MovementAnimation {
4332
- export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
4333
- export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
4334
- }
4335
-
4336
4267
  /**
4337
4268
  * @public
4338
4269
  */
@@ -4756,25 +4687,6 @@ export declare const onVideoEvent: Observable<{
4756
4687
  totalVideoLength: number;
4757
4688
  }>;
4758
4689
 
4759
- /**
4760
- * @public
4761
- */
4762
- export declare interface Orthographic {
4763
- /**
4764
- * vertical extent of the visible range in meters
4765
- * defaults to 4m
4766
- */
4767
- verticalRange?: number | undefined;
4768
- }
4769
-
4770
- /**
4771
- * @public
4772
- */
4773
- export declare namespace Orthographic {
4774
- export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
4775
- export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
4776
- }
4777
-
4778
4690
  /**
4779
4691
  * @public
4780
4692
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -5122,8 +5034,6 @@ export declare namespace PBAvatarEmoteCommand {
5122
5034
  export declare interface PBAvatarEquippedData {
5123
5035
  wearableUrns: string[];
5124
5036
  emoteUrns: string[];
5125
- /** slots that will render even if hidden */
5126
- forceRender: string[];
5127
5037
  }
5128
5038
 
5129
5039
  /**
@@ -5194,8 +5104,6 @@ export declare interface PBAvatarModifierArea {
5194
5104
  excludeIds: string[];
5195
5105
  /** list of modifiers to apply */
5196
5106
  modifiers: AvatarModifierType[];
5197
- /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
5198
- useColliderRange?: boolean | undefined;
5199
5107
  }
5200
5108
 
5201
5109
  /**
@@ -5206,64 +5114,6 @@ export declare namespace PBAvatarModifierArea {
5206
5114
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
5207
5115
  }
5208
5116
 
5209
- /**
5210
- * @public
5211
- */
5212
- export declare interface PBAvatarMovement {
5213
- velocity: PBVector3 | undefined;
5214
- /** 0-360, yaw only; this is the authoritative facing (other clients read it, and physics treats the avatar as upright). Lean is expressed separately via tilt_pitch/tilt_roll. */
5215
- orientation: number;
5216
- groundDirection?: PBVector3 | undefined;
5217
- /** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
5218
- walkSuccess?: boolean | undefined;
5219
- /** if set, the engine plays this animation instead of selecting one from velocity heuristics */
5220
- animation?: MovementAnimation | undefined;
5221
- /** render-only forward/back lean in degrees, applied on top of `orientation` (rotation about the avatar's local X axis). Does not affect the physics capsule (stays upright) or the facing other clients read. Defaults to 0. */
5222
- tiltPitch?: number | undefined;
5223
- /** render-only sideways lean in degrees, applied on top of `orientation` (rotation about the avatar's local Z axis). Same constraints as tilt_pitch. Useful e.g. for glider banking. Defaults to 0. */
5224
- tiltRoll?: number | undefined;
5225
- }
5226
-
5227
- /**
5228
- * @public
5229
- */
5230
- export declare namespace PBAvatarMovement {
5231
- export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
5232
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
5233
- }
5234
-
5235
- /**
5236
- * @public
5237
- */
5238
- export declare interface PBAvatarMovementInfo {
5239
- /** the length of time the current step velocity will apply for */
5240
- stepTime: number;
5241
- /** the length of time the previous step velocity applied for */
5242
- previousStepTime: number;
5243
- /** the velocity requested for the previous frame */
5244
- requestedVelocity: PBVector3 | undefined;
5245
- /** the resulting velocity taking collisions into account */
5246
- actualVelocity: PBVector3 | undefined;
5247
- /** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
5248
- externalVelocity: PBVector3 | undefined;
5249
- activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
5250
- activeInputModifier: PBInputModifier | undefined;
5251
- /** if set, the movement scene should walk the player to this scene-relative position */
5252
- walkTarget?: PBVector3 | undefined;
5253
- /** stop distance for walk_target; considered reached when within this distance */
5254
- walkThreshold?: number | undefined;
5255
- /** current state of a scene-driven movement animation. Absent when the engine is using its velocity-based fallback. `playback_time` freezes while a triggerSceneEmote is overriding the animation. */
5256
- activeAnimationState?: AvatarAnimationState | undefined;
5257
- }
5258
-
5259
- /**
5260
- * @public
5261
- */
5262
- export declare namespace PBAvatarMovementInfo {
5263
- export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
5264
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
5265
- }
5266
-
5267
5117
  /**
5268
5118
  * The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
5269
5119
  * for example to show a rank or a role that the scene assigns to that player.
@@ -5354,8 +5204,6 @@ export declare interface PBAvatarShape {
5354
5204
  emotes: string[];
5355
5205
  /** hides the skin + hair + facial features (default: false) */
5356
5206
  showOnlyWearables?: boolean | undefined;
5357
- /** slots that will render even if hidden */
5358
- forceRender: string[];
5359
5207
  }
5360
5208
 
5361
5209
  /**
@@ -5397,51 +5245,6 @@ export declare namespace PBBillboard {
5397
5245
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
5398
5246
  }
5399
5247
 
5400
- /**
5401
- * @public
5402
- */
5403
- export declare interface PBCameraLayer {
5404
- /**
5405
- * layer to which these settings apply. must be > 0
5406
- * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
5407
- */
5408
- layer: number;
5409
- /** should the sun light affect this layer? default false */
5410
- directionalLight?: boolean | undefined;
5411
- /** should this layer show player avatars? default false */
5412
- showAvatars?: boolean | undefined;
5413
- /** should this layer show the sky? default false */
5414
- showSkybox?: boolean | undefined;
5415
- /** should this layer show distance fog? default false */
5416
- showFog?: boolean | undefined;
5417
- /** ambient light overrides for this layer. default -> use same as main camera */
5418
- ambientColorOverride?: PBColor3 | undefined;
5419
- ambientBrightnessOverride?: number | undefined;
5420
- }
5421
-
5422
- /**
5423
- * @public
5424
- */
5425
- export declare namespace PBCameraLayer {
5426
- export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
5427
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
5428
- }
5429
-
5430
- /**
5431
- * @public
5432
- */
5433
- export declare interface PBCameraLayers {
5434
- layers: number[];
5435
- }
5436
-
5437
- /**
5438
- * @public
5439
- */
5440
- export declare namespace PBCameraLayers {
5441
- export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
5442
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
5443
- }
5444
-
5445
5248
  /**
5446
5249
  * The CameraMode component can be used to determine whether the player is using a first-person o
5447
5250
  * third-person view.
@@ -5483,8 +5286,6 @@ export declare interface PBCameraModeArea {
5483
5286
  area: PBVector3 | undefined;
5484
5287
  /** the camera mode to enforce */
5485
5288
  mode: CameraType;
5486
- /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
5487
- useColliderRange?: boolean | undefined;
5488
5289
  }
5489
5290
 
5490
5291
  /**
@@ -5618,39 +5419,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
5618
5419
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
5619
5420
  }
5620
5421
 
5621
- /**
5622
- * defines the global scene light settings. must be added to the scene root.
5623
- * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
5624
- */
5625
- /**
5626
- * @public
5627
- */
5628
- export declare interface PBGlobalLight {
5629
- /**
5630
- * the direction the directional light shines in.
5631
- * default depends on time of day and explorer implementation
5632
- */
5633
- direction?: PBVector3 | undefined;
5634
- /**
5635
- * ambient light color
5636
- * default: White
5637
- */
5638
- ambientColor?: PBColor3 | undefined;
5639
- /**
5640
- * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
5641
- * default 1
5642
- */
5643
- ambientBrightness?: number | undefined;
5644
- }
5645
-
5646
- /**
5647
- * @public
5648
- */
5649
- export declare namespace PBGlobalLight {
5650
- export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
5651
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
5652
- }
5653
-
5654
5422
  /**
5655
5423
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
5656
5424
  *
@@ -5686,25 +5454,6 @@ export declare namespace PBGltfContainer {
5686
5454
  */
5687
5455
  export declare interface PBGltfContainerLoadingState {
5688
5456
  currentState: LoadingState;
5689
- /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
5690
- nodePaths: string[];
5691
- /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
5692
- meshNames: string[];
5693
- /**
5694
- * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
5695
- * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
5696
- */
5697
- materialNames: string[];
5698
- /**
5699
- * X is the material index. note this may conflict with manually named materials - to avoid any issues make
5700
- * sure all your materials are explicitly named.
5701
- */
5702
- skinNames: string[];
5703
- /**
5704
- * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
5705
- * your skins are explicitly named.
5706
- */
5707
- animationNames: string[];
5708
5457
  }
5709
5458
 
5710
5459
  /**
@@ -5715,57 +5464,6 @@ export declare namespace PBGltfContainerLoadingState {
5715
5464
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
5716
5465
  }
5717
5466
 
5718
- /**
5719
- * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
5720
- * This component must be added to a direct child of an entity with a PBGltfContainer component, or
5721
- * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
5722
- * in the parent.
5723
- * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
5724
- *
5725
- * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
5726
- * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
5727
- * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
5728
- * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
5729
- * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
5730
- *
5731
- * After creation, if an animation moves the node, the `Transform` will be updated.
5732
- *
5733
- * From the scene, you can modify various components to alter the gltf node:
5734
- * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
5735
- * regardless of any intermediate gltf node hierarchy.
5736
- * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
5737
- * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
5738
- * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
5739
- * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
5740
- * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
5741
- * 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
5742
- * PBMaterial will be maintained.
5743
- *
5744
- * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
5745
- * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
5746
- * change the state to `GNS_FAILED`.
5747
- * - deleting the scene entity will not delete the gltf node.
5748
- *
5749
- * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
5750
- * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
5751
- * the gltf node will also be displayed.
5752
- */
5753
- /**
5754
- * @public
5755
- */
5756
- export declare interface PBGltfNode {
5757
- /** the path of the target node in the Gltf. */
5758
- path: string;
5759
- }
5760
-
5761
- /**
5762
- * @public
5763
- */
5764
- export declare namespace PBGltfNode {
5765
- export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
5766
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
5767
- }
5768
-
5769
5467
  /**
5770
5468
  * GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
5771
5469
  *
@@ -5811,26 +5509,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
5811
5509
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
5812
5510
  }
5813
5511
 
5814
- /**
5815
- * The state of a linked gltf node.
5816
- * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
5817
- */
5818
- /**
5819
- * @public
5820
- */
5821
- export declare interface PBGltfNodeState {
5822
- state: GltfNodeStateValue;
5823
- error?: string | undefined;
5824
- }
5825
-
5826
- /**
5827
- * @public
5828
- */
5829
- export declare namespace PBGltfNodeState {
5830
- export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
5831
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
5832
- }
5833
-
5834
5512
  /**
5835
5513
  * @public
5836
5514
  */
@@ -5968,14 +5646,6 @@ export declare interface PBMaterial {
5968
5646
  $case: "pbr";
5969
5647
  pbr: PBMaterial_PbrMaterial;
5970
5648
  } | undefined;
5971
- /**
5972
- * A gltf material that may provide additional features not supported by the PbMaterial fields.
5973
- * If both gltf and material fields are provided, the gltf will be used only for extended features not
5974
- * supported by the PbMaterial.
5975
- * If this is provided and the `material` field is not provided, the renderer will update the material
5976
- * field with data that reflects the gltf material once it is loaded.
5977
- */
5978
- gltf?: PBMaterial_GltfMaterial | undefined;
5979
5649
  }
5980
5650
 
5981
5651
  /**
@@ -5986,22 +5656,6 @@ export declare namespace PBMaterial {
5986
5656
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
5987
5657
  }
5988
5658
 
5989
- /**
5990
- * @public
5991
- */
5992
- export declare interface PBMaterial_GltfMaterial {
5993
- gltfSrc: string;
5994
- name: string;
5995
- }
5996
-
5997
- /**
5998
- * @public
5999
- */
6000
- export declare namespace PBMaterial_GltfMaterial {
6001
- export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
6002
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
6003
- }
6004
-
6005
5659
  /**
6006
5660
  * @public
6007
5661
  */
@@ -6098,9 +5752,6 @@ export declare interface PBMeshCollider {
6098
5752
  } | {
6099
5753
  $case: "plane";
6100
5754
  plane: PBMeshCollider_PlaneMesh;
6101
- } | {
6102
- $case: "gltf";
6103
- gltf: PBMeshCollider_GltfMesh;
6104
5755
  } | undefined;
6105
5756
  }
6106
5757
 
@@ -6146,25 +5797,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
6146
5797
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
6147
5798
  }
6148
5799
 
6149
- /** A collider constructed from a Gltf Mesh. */
6150
- /**
6151
- * @public
6152
- */
6153
- export declare interface PBMeshCollider_GltfMesh {
6154
- /** the GLTF file path as listed in the scene's manifest. */
6155
- gltfSrc: string;
6156
- /** the name of the mesh asset */
6157
- name: string;
6158
- }
6159
-
6160
- /**
6161
- * @public
6162
- */
6163
- export declare namespace PBMeshCollider_GltfMesh {
6164
- export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
6165
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
6166
- }
6167
-
6168
5800
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
6169
5801
  /**
6170
5802
  * @public
@@ -6197,11 +5829,13 @@ export declare namespace PBMeshCollider_SphereMesh {
6197
5829
 
6198
5830
  /**
6199
5831
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
6200
- * plane, a sphere, a cylinder, or a Gltf mesh.
5832
+ * plane, a sphere or a cylinder.
6201
5833
  *
6202
5834
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
6203
5835
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
6204
5836
  * `float` coordinates, one for each corner of each side of each face.
5837
+ *
5838
+ * More complex shapes require the use of a `GltfContainer` component.
6205
5839
  */
6206
5840
  /**
6207
5841
  * @public
@@ -6219,9 +5853,6 @@ export declare interface PBMeshRenderer {
6219
5853
  } | {
6220
5854
  $case: "plane";
6221
5855
  plane: PBMeshRenderer_PlaneMesh;
6222
- } | {
6223
- $case: "gltf";
6224
- gltf: PBMeshRenderer_GltfMesh;
6225
5856
  } | undefined;
6226
5857
  }
6227
5858
 
@@ -6269,25 +5900,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
6269
5900
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
6270
5901
  }
6271
5902
 
6272
- /** A mesh from a Gltf. */
6273
- /**
6274
- * @public
6275
- */
6276
- export declare interface PBMeshRenderer_GltfMesh {
6277
- /** the GLTF file path as listed in the scene's manifest. */
6278
- gltfSrc: string;
6279
- /** the name of the mesh asset */
6280
- name: string;
6281
- }
6282
-
6283
- /**
6284
- * @public
6285
- */
6286
- export declare namespace PBMeshRenderer_GltfMesh {
6287
- export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
6288
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
6289
- }
6290
-
6291
5903
  /** PlaneMesh renders a 2D rectangular shape. */
6292
5904
  /**
6293
5905
  * @public
@@ -6884,10 +6496,7 @@ export declare interface PBPrimaryPointerInfo {
6884
6496
  screenCoordinates?: PBVector2 | undefined;
6885
6497
  /** Movement since last frame (pixels) */
6886
6498
  screenDelta?: PBVector2 | undefined;
6887
- /**
6888
- * ray direction that can be used with the primary camera origin for
6889
- * raycasting from the cursor into the world
6890
- */
6499
+ /** Direction vector for 3D ray casting */
6891
6500
  worldRayDirection?: PBVector3 | undefined;
6892
6501
  }
6893
6502
 
@@ -6958,10 +6567,6 @@ export declare interface PBRaycast {
6958
6567
  continuous?: boolean | undefined;
6959
6568
  /** Collision mask, by default CL_POINTER | CL_PHYSICS */
6960
6569
  collisionMask?: number | undefined;
6961
- /** shape to cast, default ray */
6962
- shape?: RaycastShape | undefined;
6963
- /** include hits with entities from other scenes */
6964
- includeWorld?: boolean | undefined;
6965
6570
  }
6966
6571
 
6967
6572
  /**
@@ -7107,8 +6712,6 @@ export declare interface PBTextShape {
7107
6712
  outlineColor?: PBColor3 | undefined;
7108
6713
  /** text color (default [1.0, 1.0, 1.0]) */
7109
6714
  textColor?: PBColor4 | undefined;
7110
- /** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
7111
- fontSrc?: string | undefined;
7112
6715
  }
7113
6716
 
7114
6717
  /**
@@ -7119,46 +6722,6 @@ export declare namespace PBTextShape {
7119
6722
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
7120
6723
  }
7121
6724
 
7122
- /**
7123
- * @public
7124
- */
7125
- export declare interface PBTextureCamera {
7126
- /** rendered texture width */
7127
- width?: number | undefined;
7128
- /** rendered texture height */
7129
- height?: number | undefined;
7130
- /**
7131
- * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
7132
- * defaults to 0
7133
- */
7134
- layer?: number | undefined;
7135
- /** default black */
7136
- clearColor?: PBColor4 | undefined;
7137
- /** default infinity */
7138
- farPlane?: number | undefined;
7139
- mode?: {
7140
- $case: "perspective";
7141
- perspective: Perspective;
7142
- } | {
7143
- $case: "orthographic";
7144
- orthographic: Orthographic;
7145
- } | undefined;
7146
- /**
7147
- * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
7148
- * range: 0 (off) - 1 (full volume)
7149
- * default: 0
7150
- */
7151
- volume?: number | undefined;
7152
- }
7153
-
7154
- /**
7155
- * @public
7156
- */
7157
- export declare namespace PBTextureCamera {
7158
- export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
7159
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
7160
- }
7161
-
7162
6725
  /**
7163
6726
  * The TouchScreenControls component lets a scene configure the native on-screen touch
7164
6727
  * controls (the mobile joystick + gamepad). It must be set on the RootEntity.
@@ -7404,25 +6967,6 @@ export declare namespace PBUiBackground {
7404
6967
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
7405
6968
  }
7406
6969
 
7407
- /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
7408
- /**
7409
- * @public
7410
- */
7411
- export declare interface PBUiCanvas {
7412
- width: number;
7413
- height: number;
7414
- /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
7415
- color?: PBColor4 | undefined;
7416
- }
7417
-
7418
- /**
7419
- * @public
7420
- */
7421
- export declare namespace PBUiCanvas {
7422
- export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
7423
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
7424
- }
7425
-
7426
6970
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
7427
6971
  /**
7428
6972
  * @public
@@ -7478,8 +7022,6 @@ export declare interface PBUiDropdown {
7478
7022
  font?: Font | undefined;
7479
7023
  /** default=10 */
7480
7024
  fontSize?: number | undefined;
7481
- /** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
7482
- fontSrc?: string | undefined;
7483
7025
  }
7484
7026
 
7485
7027
  /**
@@ -7522,12 +7064,6 @@ export declare interface PBUiInput {
7522
7064
  /** default=10 */
7523
7065
  fontSize?: number | undefined;
7524
7066
  value?: string | undefined;
7525
- /** default=false; when true, the input accepts newlines and behaves as a textarea */
7526
- multiLine?: boolean | undefined;
7527
- /** default=true; when false, the input value is preserved after pressing Enter */
7528
- clearOnSubmit?: boolean | undefined;
7529
- /** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
7530
- fontSrc?: string | undefined;
7531
7067
  }
7532
7068
 
7533
7069
  /**
@@ -7591,21 +7127,6 @@ export declare namespace PBUiInputResult {
7591
7127
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
7592
7128
  }
7593
7129
 
7594
- /**
7595
- * @public
7596
- */
7597
- export declare interface PBUiScrollResult {
7598
- value: PBVector2 | undefined;
7599
- }
7600
-
7601
- /**
7602
- * @public
7603
- */
7604
- export declare namespace PBUiScrollResult {
7605
- export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
7606
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
7607
- }
7608
-
7609
7130
  /**
7610
7131
  * @public
7611
7132
  */
@@ -7622,8 +7143,6 @@ export declare interface PBUiText {
7622
7143
  fontSize?: number | undefined;
7623
7144
  /** wrap text when the border is reached (default: TW_WRAP) */
7624
7145
  textWrap?: TextWrap | undefined;
7625
- /** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
7626
- fontSrc?: string | undefined;
7627
7146
  }
7628
7147
 
7629
7148
  /**
@@ -7751,12 +7270,6 @@ export declare interface PBUiTransform {
7751
7270
  borderRightColor?: PBColor4 | undefined;
7752
7271
  /** default: 1 */
7753
7272
  opacity?: number | undefined;
7754
- /** reference for scroll_position. default empty */
7755
- elementId?: string | undefined;
7756
- /** default position=(0,0) */
7757
- scrollPosition?: ScrollPositionValue | undefined;
7758
- /** default ShowScrollBar.SSB_BOTH */
7759
- scrollVisible?: ShowScrollBar | undefined;
7760
7273
  /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
7761
7274
  zIndex?: number | undefined;
7762
7275
  }
@@ -7909,25 +7422,6 @@ export declare namespace PBVisibilityComponent {
7909
7422
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
7910
7423
  }
7911
7424
 
7912
- /**
7913
- * @public
7914
- */
7915
- export declare interface Perspective {
7916
- /**
7917
- * vertical field of view in radians
7918
- * defaults to pi/4 = 45 degrees
7919
- */
7920
- fieldOfView?: number | undefined;
7921
- }
7922
-
7923
- /**
7924
- * @public
7925
- */
7926
- export declare namespace Perspective {
7927
- export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
7928
- export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
7929
- }
7930
-
7931
7425
  /**
7932
7426
  * @public
7933
7427
  * Physics helpers for applying impulses and forces to the player.
@@ -8169,24 +7663,6 @@ export declare interface PointerEventsSystem {
8169
7663
  * @param entity - Entity where the callback was attached
8170
7664
  */
8171
7665
  removeOnPointerHoverLeave(entity: Entity): void;
8172
- /**
8173
- * @public
8174
- * Remove the callback for onPointerDrag event
8175
- * @param entity - Entity where the callback was attached
8176
- */
8177
- removeOnPointerDrag(entity: Entity): void;
8178
- /**
8179
- * @public
8180
- * Remove the callback for onPointerDragLocked event
8181
- * @param entity - Entity where the callback was attached
8182
- */
8183
- removeOnPointerDragLocked(entity: Entity): void;
8184
- /**
8185
- * @public
8186
- * Remove the callback for onPointerDragEnd event
8187
- * @param entity - Entity where the callback was attached
8188
- */
8189
- removeOnPointerDragEnd(entity: Entity): void;
8190
7666
  /**
8191
7667
  * @public
8192
7668
  * Remove the callback for onProximityDown event
@@ -8265,36 +7741,6 @@ export declare interface PointerEventsSystem {
8265
7741
  entity: Entity;
8266
7742
  opts?: Partial<EventSystemOptions>;
8267
7743
  }, cb: EventSystemCallback): void;
8268
- /**
8269
- * @public
8270
- * Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
8271
- * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
8272
- * @param cb - Function to execute on every drag update
8273
- */
8274
- onPointerDrag(pointerData: {
8275
- entity: Entity;
8276
- opts?: Partial<EventSystemOptions>;
8277
- }, cb: EventSystemCallback): void;
8278
- /**
8279
- * @public
8280
- * Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
8281
- * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
8282
- * @param cb - Function to execute on every drag update
8283
- */
8284
- onPointerDragLocked(pointerData: {
8285
- entity: Entity;
8286
- opts?: Partial<EventSystemOptions>;
8287
- }, cb: EventSystemCallback): void;
8288
- /**
8289
- * @public
8290
- * Execute callback when the user releases the button after a drag that started on the entity
8291
- * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
8292
- * @param cb - Function to execute when the drag ends
8293
- */
8294
- onPointerDragEnd(pointerData: {
8295
- entity: Entity;
8296
- opts?: Partial<EventSystemOptions>;
8297
- }, cb: EventSystemCallback): void;
8298
7744
  /**
8299
7745
  * @public
8300
7746
  * Execute callback when the user presses the proximity button on the entity
@@ -8353,10 +7799,7 @@ export declare const enum PointerEventType {
8353
7799
  PET_HOVER_ENTER = 2,
8354
7800
  PET_HOVER_LEAVE = 3,
8355
7801
  PET_PROXIMITY_ENTER = 4,
8356
- PET_PROXIMITY_LEAVE = 5,
8357
- PET_DRAG_LOCKED = 6,
8358
- PET_DRAG = 7,
8359
- PET_DRAG_END = 8
7802
+ PET_PROXIMITY_LEAVE = 5
8360
7803
  }
8361
7804
 
8362
7805
  /**
@@ -8387,10 +7830,7 @@ export declare const enum PointerType {
8387
7830
  /** POT_NONE - No pointer input */
8388
7831
  POT_NONE = 0,
8389
7832
  /** POT_MOUSE - Traditional mouse input */
8390
- POT_MOUSE = 1,
8391
- POT_PAD = 2,
8392
- POT_TOUCH = 3,
8393
- POT_WAND = 4
7833
+ POT_MOUSE = 1
8394
7834
  }
8395
7835
 
8396
7836
  /**
@@ -8847,16 +8287,6 @@ export declare const enum RaycastQueryType {
8847
8287
  /** @public */
8848
8288
  export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
8849
8289
 
8850
- /**
8851
- * @public
8852
- */
8853
- export declare const enum RaycastShape {
8854
- /** RS_RAY - cast a point, get collisions along a ray */
8855
- RS_RAY = 0,
8856
- /** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
8857
- RS_AVATAR = 1
8858
- }
8859
-
8860
8290
  /**
8861
8291
  * @public
8862
8292
  */
@@ -8989,10 +8419,6 @@ export declare type RaycastSystemOptions = {
8989
8419
  queryType: RaycastQueryType;
8990
8420
  continuous?: boolean | undefined;
8991
8421
  collisionMask?: number | undefined;
8992
- /** shape to sweep along the ray, default RS_RAY (a point) */
8993
- shape?: RaycastShape | undefined;
8994
- /** include colliders from other scenes, default false */
8995
- includeWorld?: boolean | undefined;
8996
8422
  };
8997
8423
 
8998
8424
  /**
@@ -9041,20 +8467,6 @@ export declare interface ReactBasedUiSystem {
9041
8467
  * @param entity - The entity whose UI renderer should be removed
9042
8468
  */
9043
8469
  removeUiRenderer(entity: Entity): void;
9044
- /**
9045
- * Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
9046
- * describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
9047
- * any texture renderer already set on the entity, and is torn down when the entity is removed.
9048
- *
9049
- * @param entity - The UiCanvas entity the UI tree hangs from
9050
- * @param ui - The UI component to render
9051
- */
9052
- setTextureRenderer(entity: Entity, ui: UiComponent): void;
9053
- /**
9054
- * Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
9055
- * @param entity - The UiCanvas entity the renderer was set on
9056
- */
9057
- removeTextureRenderer(entity: Entity): void;
9058
8470
  }
9059
8471
 
9060
8472
  /**
@@ -9218,7 +8630,7 @@ export declare type ReadOnlyLastWriteWinElementSetComponentDefinition<T> = Omit<
9218
8630
  /**
9219
8631
  * @public
9220
8632
  */
9221
- export declare type ReadonlyPrimitive = number | string | number[] | string[] | boolean | boolean[];
8633
+ export declare type ReadonlyPrimitive = number | string | boolean;
9222
8634
 
9223
8635
  /** @public */
9224
8636
  export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;
@@ -9645,33 +9057,6 @@ export declare namespace Schemas {
9645
9057
  */
9646
9058
  export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
9647
9059
 
9648
- /**
9649
- * @public
9650
- */
9651
- export declare interface ScrollPositionValue {
9652
- value?: {
9653
- $case: "position";
9654
- position: PBVector2;
9655
- } | {
9656
- $case: "reference";
9657
- reference: string;
9658
- } | undefined;
9659
- }
9660
-
9661
- /**
9662
- * @public
9663
- */
9664
- export declare namespace ScrollPositionValue {
9665
- export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
9666
- export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
9667
- }
9668
-
9669
- /**
9670
- * Which scrollbars are shown when the overflow is scrollable
9671
- * @public
9672
- */
9673
- export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
9674
-
9675
9060
  /**
9676
9061
  * Register the composite provider used to resolve composite files. Also registers
9677
9062
  * any `provider.schemas` on the engine pre-seal so composites that reference those
@@ -9697,16 +9082,6 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
9697
9082
  easingFunction?: EasingFunction;
9698
9083
  }
9699
9084
 
9700
- /**
9701
- * @public
9702
- */
9703
- export declare const enum ShowScrollBar {
9704
- SSB_BOTH = 0,
9705
- SSB_ONLY_VERTICAL = 1,
9706
- SSB_ONLY_HORIZONTAL = 2,
9707
- SSB_HIDDEN = 3
9708
- }
9709
-
9710
9085
  /** @public */
9711
9086
  export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
9712
9087
 
@@ -9818,9 +9193,6 @@ export declare namespace Texture {
9818
9193
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
9819
9194
  }
9820
9195
 
9821
- /** @public */
9822
- export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
9823
-
9824
9196
  /**
9825
9197
  * @public
9826
9198
  */
@@ -9931,9 +9303,6 @@ export declare interface TextureUnion {
9931
9303
  } | {
9932
9304
  $case: "videoTexture";
9933
9305
  videoTexture: VideoTexture;
9934
- } | {
9935
- $case: "uiTexture";
9936
- uiTexture: UiCanvasTexture;
9937
9306
  } | undefined;
9938
9307
  }
9939
9308
 
@@ -10164,6 +9533,16 @@ export declare type Transport = {
10164
9533
  onmessage?(message: Uint8Array): void;
10165
9534
  filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
10166
9535
  type?: string;
9536
+ /**
9537
+ * Whether this transport is allowed to mutate reserved-range entities
9538
+ * (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
9539
+ * Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
9540
+ * or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
9541
+ * AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
9542
+ * this flag (a comms peer, or any scene-added transport) is rejected — see
9543
+ * `receiveMessages`.
9544
+ */
9545
+ allowReservedEntities?: boolean;
10167
9546
  };
10168
9547
 
10169
9548
  /**
@@ -10472,8 +9851,6 @@ export declare interface UiBackgroundProps {
10472
9851
  uvs?: number[];
10473
9852
  /** AvatarTexture for the background */
10474
9853
  avatarTexture?: UiAvatarTexture;
10475
- /** VideoTexture for the background: the frames of a VideoPlayer on another entity */
10476
- videoTexture?: UiVideoTexture;
10477
9854
  /** Texture for the background */
10478
9855
  texture?: UiTexture;
10479
9856
  }
@@ -10493,31 +9870,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
10493
9870
  disabled?: boolean;
10494
9871
  }
10495
9872
 
10496
- /** @public */
10497
- export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
10498
-
10499
9873
  /** @public */
10500
9874
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
10501
9875
 
10502
- /**
10503
- * @public
10504
- */
10505
- export declare interface UiCanvasTexture {
10506
- uiCanvasEntity: number;
10507
- /** default = TextureWrapMode.Clamp */
10508
- wrapMode?: TextureWrapMode | undefined;
10509
- /** default = FilterMode.Bilinear */
10510
- filterMode?: TextureFilterMode | undefined;
10511
- }
10512
-
10513
- /**
10514
- * @public
10515
- */
10516
- export declare namespace UiCanvasTexture {
10517
- export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
10518
- export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
10519
- }
10520
-
10521
9876
  /**
10522
9877
  * @public
10523
9878
  */
@@ -10615,8 +9970,6 @@ export declare interface UiLabelProps {
10615
9970
  font?: UiFontType | undefined;
10616
9971
  /** Behaviour when text reached. @defaultValue 'wrap' */
10617
9972
  textWrap?: UiTextWrapType | undefined;
10618
- /** A font file in the scene, or a Google Fonts family name; `font` is the fallback. @defaultValue undefined */
10619
- fontSrc?: string | undefined;
10620
9973
  }
10621
9974
 
10622
9975
  /**
@@ -10672,9 +10025,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
10672
10025
  uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
10673
10026
  };
10674
10027
 
10675
- /** @public */
10676
- export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
10677
-
10678
10028
  /** @public */
10679
10029
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
10680
10030
 
@@ -10754,22 +10104,6 @@ export declare interface UiTransformProps {
10754
10104
  opacity?: number;
10755
10105
  /** default 0 */
10756
10106
  zIndex?: number;
10757
- /** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
10758
- elementId?: string;
10759
- /** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
10760
- scrollPosition?: PBVector2 | string;
10761
- /** Which scrollbars to show when overflow is 'scroll'. default 'both' */
10762
- scrollVisible?: ScrollVisibleType;
10763
- }
10764
-
10765
- /**
10766
- * Video Texture
10767
- * @public
10768
- */
10769
- export declare interface UiVideoTexture {
10770
- videoPlayerEntity: Entity;
10771
- wrapMode?: TextureWrapType;
10772
- filterMode?: TextureFilterType;
10773
10107
  }
10774
10108
 
10775
10109
  /**
@@ -10777,6 +10111,14 @@ export declare interface UiVideoTexture {
10777
10111
  */
10778
10112
  export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
10779
10113
 
10114
+ export declare type ValidateCallback<T> = (value: {
10115
+ entity: Entity;
10116
+ currentValue: T | undefined;
10117
+ newValue: T | undefined;
10118
+ senderAddress: string;
10119
+ createdBy: string;
10120
+ }) => boolean;
10121
+
10780
10122
  /**
10781
10123
  * @public
10782
10124
  */