@dcl/playground-assets 7.20.1-21915113771.commit-e132905 → 7.20.1-21988479316.commit-3b19265

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
@@ -163,6 +163,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
163
163
  getAudioState(entity: Entity): PBAudioEvent | undefined;
164
164
  }
165
165
 
166
+ /**
167
+ * @public
168
+ */
169
+ export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
170
+
171
+ /**
172
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
173
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
174
+ *
175
+ * @param entity - Uint32 number of the entity
176
+ * @param componentId - Uint32 number of id
177
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
178
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
179
+ * @public
180
+ */
181
+ export declare type AuthoritativePutComponentMessageBody = {
182
+ type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
183
+ entityId: Entity;
184
+ componentId: number;
185
+ timestamp: number;
186
+ data: Uint8Array;
187
+ };
188
+
189
+ /**
190
+ * @public
191
+ */
192
+ export declare namespace AuthoritativePutComponentOperation {
193
+ const MESSAGE_HEADER_LENGTH = 16;
194
+ /**
195
+ * Call this function for an optimal writing data passing the ByteBuffer
196
+ * already allocated
197
+ */
198
+ export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
199
+ export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
200
+ }
201
+
166
202
  /** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
167
203
  /**
168
204
  * @public
@@ -203,36 +239,12 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
203
239
  /** @public */
204
240
  export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
205
241
 
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
-
218
242
  /** @public */
219
243
  export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
220
244
 
221
245
  /** @public */
222
246
  export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
223
247
 
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
-
233
- /** @public */
234
- export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
235
-
236
248
  /** @public */
237
249
  export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
238
250
 
@@ -247,49 +259,9 @@ export declare const enum AvatarModifierType {
247
259
  AMT_DISABLE_PASSPORTS = 1
248
260
  }
249
261
 
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
-
281
262
  /** @public */
282
263
  export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
283
264
 
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
-
293
265
  /**
294
266
  * @public
295
267
  */
@@ -386,6 +358,22 @@ export declare interface BaseComponent<T> {
386
358
  * If the value is undefined, the component was deleted.
387
359
  */
388
360
  onChange(entity: Entity, cb: (value: T | undefined) => void): void;
361
+ /**
362
+ * @public
363
+ *
364
+ */
365
+ validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
366
+ validateBeforeChange(cb: ValidateCallback<T>): void;
367
+ /**
368
+ * Get the CRDT state for an entity (serialized data and timestamp)
369
+ * @param entity - Entity to get the CRDT state for
370
+ * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
371
+ * @public
372
+ */
373
+ getCrdtState(entity: Entity): {
374
+ data: Uint8Array;
375
+ timestamp: number;
376
+ } | null;
389
377
  }
390
378
 
391
379
  /** @public */
@@ -557,19 +545,11 @@ export declare interface ByteBuffer {
557
545
  }
558
546
 
559
547
  /**
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
548
+ * Callback function to be triggered on a specified event
549
+ * @public
564
550
  */
565
551
  export declare type Callback = () => void;
566
552
 
567
- /** @public */
568
- export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
569
-
570
- /** @public */
571
- export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
572
-
573
553
  /** @public */
574
554
  export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
575
555
 
@@ -627,39 +607,6 @@ export declare const enum CameraType {
627
607
 
628
608
  export declare type Children = ReactEcs.JSX.ReactNode;
629
609
 
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
-
663
610
  /** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
664
611
  /**
665
612
  * @public
@@ -1433,21 +1380,15 @@ export declare const componentDefinitionByName: {
1433
1380
  "core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
1434
1381
  "core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
1435
1382
  "core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
1436
- "core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
1437
1383
  "core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
1438
1384
  "core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
1439
1385
  "core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
1440
- "core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
1441
- "core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
1442
1386
  "core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
1443
1387
  "core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
1444
1388
  "core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
1445
- "core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
1446
1389
  "core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
1447
1390
  "core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
1448
- "core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
1449
1391
  "core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
1450
- "core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
1451
1392
  "core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
1452
1393
  "core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
1453
1394
  "core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
@@ -1465,20 +1406,17 @@ export declare const componentDefinitionByName: {
1465
1406
  "core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
1466
1407
  "core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
1467
1408
  "core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
1468
- "core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
1469
1409
  "core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
1470
1410
  "core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
1471
1411
  "core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
1472
1412
  "core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
1473
1413
  "core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
1474
1414
  "core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
1475
- "core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
1476
1415
  "core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
1477
1416
  "core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
1478
1417
  "core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
1479
1418
  "core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
1480
1419
  "core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
1481
- "core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
1482
1420
  "core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
1483
1421
  "core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
1484
1422
  "core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
@@ -1644,12 +1582,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
1644
1582
  /**
1645
1583
  * @public
1646
1584
  */
1647
- export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
1585
+ export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
1648
1586
 
1649
1587
  /**
1650
1588
  * @public
1651
1589
  */
1652
- export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
1590
+ export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
1653
1591
 
1654
1592
  /**
1655
1593
  * Min length = 8 bytes
@@ -1704,7 +1642,8 @@ export declare enum CrdtMessageType {
1704
1642
  PUT_COMPONENT_NETWORK = 5,
1705
1643
  DELETE_COMPONENT_NETWORK = 6,
1706
1644
  DELETE_ENTITY_NETWORK = 7,
1707
- MAX_MESSAGE_TYPE = 8
1645
+ AUTHORITATIVE_PUT_COMPONENT = 8,
1646
+ MAX_MESSAGE_TYPE = 9
1708
1647
  }
1709
1648
 
1710
1649
  /**
@@ -1712,6 +1651,8 @@ export declare enum CrdtMessageType {
1712
1651
  */
1713
1652
  export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
1714
1653
 
1654
+ export declare const CreatedBy: ICreatedBy;
1655
+
1715
1656
  /**
1716
1657
  * @public
1717
1658
  */
@@ -2066,18 +2007,10 @@ export declare type EntityComponents = {
2066
2007
  uiBackground: PBUiBackground;
2067
2008
  uiInput: PBUiInput;
2068
2009
  uiDropdown: PBUiDropdown;
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;
2010
+ onMouseDown: Callback;
2011
+ onMouseUp: Callback;
2012
+ onMouseEnter: Callback;
2013
+ onMouseLeave: Callback;
2081
2014
  };
2082
2015
 
2083
2016
  /** @public */
@@ -2156,13 +2089,6 @@ export declare type EventSystemOptions = {
2156
2089
  maxPlayerDistance?: number;
2157
2090
  };
2158
2091
 
2159
- /**
2160
- * @public
2161
- */
2162
- export declare type EventSystemOptionsCallback = EventSystemOptions & {
2163
- cb: EventSystemCallback;
2164
- };
2165
-
2166
2092
  /**
2167
2093
  * Excludes property keys from T where the property is assignable to U
2168
2094
  * @public
@@ -2332,16 +2258,6 @@ export declare const getDefaultOpts: (opts?: Partial<EventSystemOptions>) => Eve
2332
2258
  */
2333
2259
  export declare function getEntitiesWithParent(engine: Pick<IEngine, 'getEntitiesWith' | 'defineComponentFromSchema'>, parent: Entity): Entity[];
2334
2260
 
2335
- /**
2336
- * Utilities for standardized globalThis access.
2337
- * @public
2338
- */
2339
- /**
2340
- * Type-safe globalThis property access.
2341
- * @public
2342
- */
2343
- export declare function getGlobal<T>(key: string): T | undefined;
2344
-
2345
2261
  /**
2346
2262
  * Get the world position of an entity, taking into account the full parent hierarchy.
2347
2263
  * This computes the world-space position by accumulating all parent transforms
@@ -2391,9 +2307,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
2391
2307
  direction?: PBVector3;
2392
2308
  };
2393
2309
 
2394
- /** @public */
2395
- export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
2396
-
2397
2310
  export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
2398
2311
 
2399
2312
  export declare type GlobalTargetRaycastSystemOptions = {
@@ -2406,24 +2319,9 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
2406
2319
  /** @public */
2407
2320
  export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
2408
2321
 
2409
- /** @public */
2410
- export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
2411
-
2412
2322
  /** @public */
2413
2323
  export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
2414
2324
 
2415
- /** @public */
2416
- export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
2417
-
2418
- /**
2419
- * @public
2420
- */
2421
- export declare const enum GltfNodeStateValue {
2422
- GNSV_PENDING = 0,
2423
- GNSV_FAILED = 1,
2424
- GNSV_READY = 2
2425
- }
2426
-
2427
2325
  /**
2428
2326
  * @public
2429
2327
  */
@@ -2447,6 +2345,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
2447
2345
 
2448
2346
  export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
2449
2347
 
2348
+ export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
2349
+
2350
+ export declare interface ICreatedByType {
2351
+ address: string;
2352
+ }
2353
+
2450
2354
  /**
2451
2355
  * @public
2452
2356
  */
@@ -2769,12 +2673,6 @@ export declare type IInputSystem = {
2769
2673
  * @returns the input command info or undefined if there is no command in the last tick-update
2770
2674
  */
2771
2675
  getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
2772
- /**
2773
- * @public
2774
- * Get an ordered iterator over events received within the current frame.
2775
- * @returns the iterator
2776
- */
2777
- getInputCommands: () => Generator<PBPointerEventsResult>;
2778
2676
  };
2779
2677
 
2780
2678
  /**
@@ -2887,6 +2785,35 @@ export declare type InstanceCompositeOptions = {
2887
2785
  alreadyRequestedSrc?: Set<string>;
2888
2786
  };
2889
2787
 
2788
+ /**
2789
+ * Internal component interface that exposes all internal methods for SDK use
2790
+ * This is not exposed to users, only for internal SDK operations
2791
+ */
2792
+ export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
2793
+ /**
2794
+ * @public
2795
+ * Dry run update to check if a CRDT message would be accepted without actually applying it
2796
+ */
2797
+ __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
2798
+ /**
2799
+ * @public
2800
+ * Get the iterator to every entity has the component
2801
+ */
2802
+ iterator(): Iterable<[Entity, any]>;
2803
+ /**
2804
+ * @public
2805
+ */
2806
+ dirtyIterator(): Iterable<Entity>;
2807
+ /**
2808
+ * @public
2809
+ */
2810
+ __onChangeCallbacks(entity: Entity, value: T): void;
2811
+ /**
2812
+ * @public
2813
+ */
2814
+ __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
2815
+ }
2816
+
2890
2817
  /**
2891
2818
  * @public
2892
2819
  */
@@ -3070,29 +2997,13 @@ export declare interface LightSourceHelper {
3070
2997
  */
3071
2998
  export declare type Listeners = {
3072
2999
  /** triggered on mouse down event */
3073
- onMouseDown?: EventSystemCallback;
3000
+ onMouseDown?: Callback;
3074
3001
  /** triggered on mouse up event */
3075
- onMouseUp?: EventSystemCallback;
3002
+ onMouseUp?: Callback;
3076
3003
  /** triggered on mouse hover event */
3077
- onMouseEnter?: EventSystemCallback;
3004
+ onMouseEnter?: Callback;
3078
3005
  /** triggered on mouse leave event */
3079
- onMouseLeave?: EventSystemCallback;
3080
- /** triggered on mouse drag event */
3081
- onMouseDrag?: EventSystemCallback;
3082
- /** triggered on mouse drag event */
3083
- onMouseDragLocked?: EventSystemCallback;
3084
- /** triggered on mouse drag event */
3085
- onMouseDragEnd?: EventSystemCallback;
3086
- /** triggered on input down event */
3087
- onInputDown?: MultiCallback;
3088
- /** triggered on input up event */
3089
- onInputUp?: MultiCallback;
3090
- /** triggered on input drag event */
3091
- onInputDrag?: MultiCallback;
3092
- /** triggered on input drag event */
3093
- onInputDragLocked?: MultiCallback;
3094
- /** triggered on input drag event */
3095
- onInputDragEnd?: MultiCallback;
3006
+ onMouseLeave?: Callback;
3096
3007
  };
3097
3008
 
3098
3009
  /**
@@ -3997,14 +3908,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
3997
3908
  * @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
3998
3909
  */
3999
3910
  setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
4000
- /**
4001
- * @public
4002
- * Set a gltf internal mesh in the MeshCollider component
4003
- * @param entity - entity to create or replace the MeshRenderer component
4004
- * @param source - the path to the gltf
4005
- * @param meshName - the name of the mesh in the gltf
4006
- */
4007
- setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
4008
3911
  }
4009
3912
 
4010
3913
  export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
@@ -4041,14 +3944,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
4041
3944
  * @param entity - entity to create or replace the MeshRenderer component
4042
3945
  */
4043
3946
  setSphere(entity: Entity): void;
4044
- /**
4045
- * @public
4046
- * Set a gltf internal mesh in the MeshRenderer component
4047
- * @param entity - entity to create or replace the MeshRenderer component
4048
- * @param source - the path to the gltf
4049
- * @param meshName - the name of the mesh in the gltf
4050
- */
4051
- setGltfMesh(entity: Entity, source: string, meshName: string): void;
4052
3947
  }
4053
3948
 
4054
3949
  /* Excluded from this release type: MessageBus */
@@ -4086,19 +3981,6 @@ export declare namespace MoveContinuous {
4086
3981
  export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
4087
3982
  }
4088
3983
 
4089
- /**
4090
- * a record object mapping `InputAction`s to functions.
4091
- *
4092
- * @example
4093
- * onInputDown={{
4094
- * [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
4095
- * [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
4096
- * }}
4097
- *
4098
- * @public
4099
- */
4100
- export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
4101
-
4102
3984
  export declare const Name: NameComponent;
4103
3985
 
4104
3986
  export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
@@ -4471,25 +4353,6 @@ export declare const onVideoEvent: Observable<{
4471
4353
  totalVideoLength: number;
4472
4354
  }>;
4473
4355
 
4474
- /**
4475
- * @public
4476
- */
4477
- export declare interface Orthographic {
4478
- /**
4479
- * vertical extent of the visible range in meters
4480
- * defaults to 4m
4481
- */
4482
- verticalRange?: number | undefined;
4483
- }
4484
-
4485
- /**
4486
- * @public
4487
- */
4488
- export declare namespace Orthographic {
4489
- export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
4490
- export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
4491
- }
4492
-
4493
4356
  /**
4494
4357
  * @public
4495
4358
  * The overflow property controls what happens to content that is too big to fit into an area
@@ -4767,8 +4630,6 @@ export declare namespace PBAvatarEmoteCommand {
4767
4630
  export declare interface PBAvatarEquippedData {
4768
4631
  wearableUrns: string[];
4769
4632
  emoteUrns: string[];
4770
- /** slots that will render even if hidden */
4771
- forceRender: string[];
4772
4633
  }
4773
4634
 
4774
4635
  /**
@@ -4779,36 +4640,6 @@ export declare namespace PBAvatarEquippedData {
4779
4640
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
4780
4641
  }
4781
4642
 
4782
- /**
4783
- * The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
4784
- * as the avatar movement speed, jump height etc.
4785
- */
4786
- /**
4787
- * @public
4788
- */
4789
- export declare interface PBAvatarLocomotionSettings {
4790
- /** Maximum speed when walking (in meters per second) */
4791
- walkSpeed?: number | undefined;
4792
- /** Maximum speed when jogging (in meters per second) */
4793
- jogSpeed?: number | undefined;
4794
- /** Maximum speed when running (in meters per second) */
4795
- runSpeed?: number | undefined;
4796
- /** Height of a regular jump (in meters) */
4797
- jumpHeight?: number | undefined;
4798
- /** Height of a jump while running (in meters) */
4799
- runJumpHeight?: number | undefined;
4800
- /** Cooldown time after a hard landing before the avatar can move again (in seconds) */
4801
- hardLandingCooldown?: number | undefined;
4802
- }
4803
-
4804
- /**
4805
- * @public
4806
- */
4807
- export declare namespace PBAvatarLocomotionSettings {
4808
- export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
4809
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
4810
- }
4811
-
4812
4643
  /**
4813
4644
  * The AvatarModifierArea component can be attached to an Entity to define a region of space where
4814
4645
  * avatar behavior changes.
@@ -4833,9 +4664,6 @@ export declare interface PBAvatarModifierArea {
4833
4664
  excludeIds: string[];
4834
4665
  /** list of modifiers to apply */
4835
4666
  modifiers: AvatarModifierType[];
4836
- movementSettings?: AvatarMovementSettings | undefined;
4837
- /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
4838
- useColliderRange?: boolean | undefined;
4839
4667
  }
4840
4668
 
4841
4669
  /**
@@ -4894,8 +4722,6 @@ export declare interface PBAvatarShape {
4894
4722
  emotes: string[];
4895
4723
  /** hides the skin + hair + facial features (default: false) */
4896
4724
  showOnlyWearables?: boolean | undefined;
4897
- /** slots that will render even if hidden */
4898
- forceRender: string[];
4899
4725
  }
4900
4726
 
4901
4727
  /**
@@ -4930,51 +4756,6 @@ export declare namespace PBBillboard {
4930
4756
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
4931
4757
  }
4932
4758
 
4933
- /**
4934
- * @public
4935
- */
4936
- export declare interface PBCameraLayer {
4937
- /**
4938
- * layer to which these settings apply. must be > 0
4939
- * Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
4940
- */
4941
- layer: number;
4942
- /** should the sun light affect this layer? default false */
4943
- directionalLight?: boolean | undefined;
4944
- /** should this layer show player avatars? default false */
4945
- showAvatars?: boolean | undefined;
4946
- /** should this layer show the sky? default false */
4947
- showSkybox?: boolean | undefined;
4948
- /** should this layer show distance fog? default false */
4949
- showFog?: boolean | undefined;
4950
- /** ambient light overrides for this layer. default -> use same as main camera */
4951
- ambientColorOverride?: PBColor3 | undefined;
4952
- ambientBrightnessOverride?: number | undefined;
4953
- }
4954
-
4955
- /**
4956
- * @public
4957
- */
4958
- export declare namespace PBCameraLayer {
4959
- export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
4960
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
4961
- }
4962
-
4963
- /**
4964
- * @public
4965
- */
4966
- export declare interface PBCameraLayers {
4967
- layers: number[];
4968
- }
4969
-
4970
- /**
4971
- * @public
4972
- */
4973
- export declare namespace PBCameraLayers {
4974
- export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
4975
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
4976
- }
4977
-
4978
4759
  /**
4979
4760
  * The CameraMode component can be used to determine whether the player is using a first-person o
4980
4761
  * third-person view.
@@ -4997,7 +4778,7 @@ export declare namespace PBCameraMode {
4997
4778
 
4998
4779
  /**
4999
4780
  * The CameraModeArea component can be attached to an Entity to define a region of space where
5000
- * the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
4781
+ * the player's camera mode (1st-person or 3rd-person) is overridden.
5001
4782
  *
5002
4783
  * The Entity's Transform position determines the center-point of the region, while its size is
5003
4784
  * given as a vector in the `area` property below. The Transform rotation is applied, but the scale
@@ -5007,8 +4788,6 @@ export declare namespace PBCameraMode {
5007
4788
  *
5008
4789
  * Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
5009
4790
  * is actually a 3D volume.
5010
- *
5011
- * When mode is set to CtCinematic, the cinematic_settings field must also be provided.
5012
4791
  */
5013
4792
  /**
5014
4793
  * @public
@@ -5018,9 +4797,6 @@ export declare interface PBCameraModeArea {
5018
4797
  area: PBVector3 | undefined;
5019
4798
  /** the camera mode to enforce */
5020
4799
  mode: CameraType;
5021
- cinematicSettings?: CinematicSettings | undefined;
5022
- /** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
5023
- useColliderRange?: boolean | undefined;
5024
4800
  }
5025
4801
 
5026
4802
  /**
@@ -5092,39 +4868,6 @@ export declare namespace PBEngineInfo {
5092
4868
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
5093
4869
  }
5094
4870
 
5095
- /**
5096
- * defines the global scene light settings. must be added to the scene root.
5097
- * to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
5098
- */
5099
- /**
5100
- * @public
5101
- */
5102
- export declare interface PBGlobalLight {
5103
- /**
5104
- * the direction the directional light shines in.
5105
- * default depends on time of day and explorer implementation
5106
- */
5107
- direction?: PBVector3 | undefined;
5108
- /**
5109
- * ambient light color
5110
- * default: White
5111
- */
5112
- ambientColor?: PBColor3 | undefined;
5113
- /**
5114
- * ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
5115
- * default 1
5116
- */
5117
- ambientBrightness?: number | undefined;
5118
- }
5119
-
5120
- /**
5121
- * @public
5122
- */
5123
- export declare namespace PBGlobalLight {
5124
- export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
5125
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
5126
- }
5127
-
5128
4871
  /**
5129
4872
  * GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
5130
4873
  *
@@ -5160,25 +4903,6 @@ export declare namespace PBGltfContainer {
5160
4903
  */
5161
4904
  export declare interface PBGltfContainerLoadingState {
5162
4905
  currentState: LoadingState;
5163
- /** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
5164
- nodePaths: string[];
5165
- /** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
5166
- meshNames: string[];
5167
- /**
5168
- * where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
5169
- * conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
5170
- */
5171
- materialNames: string[];
5172
- /**
5173
- * X is the material index. note this may conflict with manually named materials - to avoid any issues make
5174
- * sure all your materials are explicitly named.
5175
- */
5176
- skinNames: string[];
5177
- /**
5178
- * X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
5179
- * your skins are explicitly named.
5180
- */
5181
- animationNames: string[];
5182
4906
  }
5183
4907
 
5184
4908
  /**
@@ -5189,57 +4913,6 @@ export declare namespace PBGltfContainerLoadingState {
5189
4913
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
5190
4914
  }
5191
4915
 
5192
- /**
5193
- * a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
5194
- * This component must be added to a direct child of an entity with a PBGltfContainer component, or
5195
- * to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
5196
- * in the parent.
5197
- * The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
5198
- *
5199
- * The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
5200
- * - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
5201
- * - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
5202
- * - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
5203
- * - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
5204
- *
5205
- * After creation, if an animation moves the node, the `Transform` will be updated.
5206
- *
5207
- * From the scene, you can modify various components to alter the gltf node:
5208
- * - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
5209
- * regardless of any intermediate gltf node hierarchy.
5210
- * If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
5211
- * - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
5212
- * - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
5213
- * - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
5214
- * - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
5215
- * 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
5216
- * PBMaterial will be maintained.
5217
- *
5218
- * The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
5219
- * - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
5220
- * change the state to `GNS_FAILED`.
5221
- * - deleting the scene entity will not delete the gltf node.
5222
- *
5223
- * Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
5224
- * are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
5225
- * the gltf node will also be displayed.
5226
- */
5227
- /**
5228
- * @public
5229
- */
5230
- export declare interface PBGltfNode {
5231
- /** the path of the target node in the Gltf. */
5232
- path: string;
5233
- }
5234
-
5235
- /**
5236
- * @public
5237
- */
5238
- export declare namespace PBGltfNode {
5239
- export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
5240
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
5241
- }
5242
-
5243
4916
  /**
5244
4917
  * GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
5245
4918
  *
@@ -5285,26 +4958,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
5285
4958
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
5286
4959
  }
5287
4960
 
5288
- /**
5289
- * The state of a linked gltf node.
5290
- * If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
5291
- */
5292
- /**
5293
- * @public
5294
- */
5295
- export declare interface PBGltfNodeState {
5296
- state: GltfNodeStateValue;
5297
- error?: string | undefined;
5298
- }
5299
-
5300
- /**
5301
- * @public
5302
- */
5303
- export declare namespace PBGltfNodeState {
5304
- export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
5305
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
5306
- }
5307
-
5308
4961
  /**
5309
4962
  * @public
5310
4963
  */
@@ -5440,14 +5093,6 @@ export declare interface PBMaterial {
5440
5093
  $case: "pbr";
5441
5094
  pbr: PBMaterial_PbrMaterial;
5442
5095
  } | undefined;
5443
- /**
5444
- * A gltf material that may provide additional features not supported by the PbMaterial fields.
5445
- * If both gltf and material fields are provided, the gltf will be used only for extended features not
5446
- * supported by the PbMaterial.
5447
- * If this is provided and the `material` field is not provided, the renderer will update the material
5448
- * field with data that reflects the gltf material once it is loaded.
5449
- */
5450
- gltf?: PBMaterial_GltfMaterial | undefined;
5451
5096
  }
5452
5097
 
5453
5098
  /**
@@ -5458,22 +5103,6 @@ export declare namespace PBMaterial {
5458
5103
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
5459
5104
  }
5460
5105
 
5461
- /**
5462
- * @public
5463
- */
5464
- export declare interface PBMaterial_GltfMaterial {
5465
- gltfSrc: string;
5466
- name: string;
5467
- }
5468
-
5469
- /**
5470
- * @public
5471
- */
5472
- export declare namespace PBMaterial_GltfMaterial {
5473
- export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
5474
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
5475
- }
5476
-
5477
5106
  /**
5478
5107
  * @public
5479
5108
  */
@@ -5570,9 +5199,6 @@ export declare interface PBMeshCollider {
5570
5199
  } | {
5571
5200
  $case: "plane";
5572
5201
  plane: PBMeshCollider_PlaneMesh;
5573
- } | {
5574
- $case: "gltf";
5575
- gltf: PBMeshCollider_GltfMesh;
5576
5202
  } | undefined;
5577
5203
  }
5578
5204
 
@@ -5618,25 +5244,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
5618
5244
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
5619
5245
  }
5620
5246
 
5621
- /** A collider constructed from a Gltf Mesh. */
5622
- /**
5623
- * @public
5624
- */
5625
- export declare interface PBMeshCollider_GltfMesh {
5626
- /** the GLTF file path as listed in the scene's manifest. */
5627
- gltfSrc: string;
5628
- /** the name of the mesh asset */
5629
- name: string;
5630
- }
5631
-
5632
- /**
5633
- * @public
5634
- */
5635
- export declare namespace PBMeshCollider_GltfMesh {
5636
- export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5637
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
5638
- }
5639
-
5640
5247
  /** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
5641
5248
  /**
5642
5249
  * @public
@@ -5669,11 +5276,13 @@ export declare namespace PBMeshCollider_SphereMesh {
5669
5276
 
5670
5277
  /**
5671
5278
  * The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
5672
- * plane, a sphere, a cylinder, or a Gltf mesh.
5279
+ * plane, a sphere or a cylinder.
5673
5280
  *
5674
5281
  * The cube and plane variants can include a UV texture mapping, so specific areas of a material
5675
5282
  * texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
5676
5283
  * `float` coordinates, one for each corner of each side of each face.
5284
+ *
5285
+ * More complex shapes require the use of a `GltfContainer` component.
5677
5286
  */
5678
5287
  /**
5679
5288
  * @public
@@ -5691,9 +5300,6 @@ export declare interface PBMeshRenderer {
5691
5300
  } | {
5692
5301
  $case: "plane";
5693
5302
  plane: PBMeshRenderer_PlaneMesh;
5694
- } | {
5695
- $case: "gltf";
5696
- gltf: PBMeshRenderer_GltfMesh;
5697
5303
  } | undefined;
5698
5304
  }
5699
5305
 
@@ -5741,25 +5347,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
5741
5347
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
5742
5348
  }
5743
5349
 
5744
- /** A mesh from a Gltf. */
5745
- /**
5746
- * @public
5747
- */
5748
- export declare interface PBMeshRenderer_GltfMesh {
5749
- /** the GLTF file path as listed in the scene's manifest. */
5750
- gltfSrc: string;
5751
- /** the name of the mesh asset */
5752
- name: string;
5753
- }
5754
-
5755
- /**
5756
- * @public
5757
- */
5758
- export declare namespace PBMeshRenderer_GltfMesh {
5759
- export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
5760
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
5761
- }
5762
-
5763
5350
  /** PlaneMesh renders a 2D rectangular shape. */
5764
5351
  /**
5765
5352
  * @public
@@ -6033,10 +5620,7 @@ export declare interface PBPrimaryPointerInfo {
6033
5620
  screenCoordinates?: PBVector2 | undefined;
6034
5621
  /** Movement since last frame (pixels) */
6035
5622
  screenDelta?: PBVector2 | undefined;
6036
- /**
6037
- * ray direction that can be used with the primary camera origin for
6038
- * raycasting from the cursor into the world
6039
- */
5623
+ /** Direction vector for 3D ray casting */
6040
5624
  worldRayDirection?: PBVector3 | undefined;
6041
5625
  }
6042
5626
 
@@ -6262,46 +5846,6 @@ export declare namespace PBTextShape {
6262
5846
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
6263
5847
  }
6264
5848
 
6265
- /**
6266
- * @public
6267
- */
6268
- export declare interface PBTextureCamera {
6269
- /** rendered texture width */
6270
- width?: number | undefined;
6271
- /** rendered texture height */
6272
- height?: number | undefined;
6273
- /**
6274
- * which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
6275
- * defaults to 0
6276
- */
6277
- layer?: number | undefined;
6278
- /** default black */
6279
- clearColor?: PBColor4 | undefined;
6280
- /** default infinity */
6281
- farPlane?: number | undefined;
6282
- mode?: {
6283
- $case: "perspective";
6284
- perspective: Perspective;
6285
- } | {
6286
- $case: "orthographic";
6287
- orthographic: Orthographic;
6288
- } | undefined;
6289
- /**
6290
- * controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
6291
- * range: 0 (off) - 1 (full volume)
6292
- * default: 0
6293
- */
6294
- volume?: number | undefined;
6295
- }
6296
-
6297
- /**
6298
- * @public
6299
- */
6300
- export declare namespace PBTextureCamera {
6301
- export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
6302
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
6303
- }
6304
-
6305
5849
  /**
6306
5850
  * The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
6307
5851
  * when entities enter this component's defined area.
@@ -6480,25 +6024,6 @@ export declare namespace PBUiBackground {
6480
6024
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
6481
6025
  }
6482
6026
 
6483
- /** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
6484
- /**
6485
- * @public
6486
- */
6487
- export declare interface PBUiCanvas {
6488
- width: number;
6489
- height: number;
6490
- /** default = (0.0, 0.0, 0.0, 0.0) / transparent */
6491
- color?: PBColor4 | undefined;
6492
- }
6493
-
6494
- /**
6495
- * @public
6496
- */
6497
- export declare namespace PBUiCanvas {
6498
- export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
6499
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
6500
- }
6501
-
6502
6027
  /** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
6503
6028
  /**
6504
6029
  * @public
@@ -6615,21 +6140,6 @@ export declare namespace PBUiInputResult {
6615
6140
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
6616
6141
  }
6617
6142
 
6618
- /**
6619
- * @public
6620
- */
6621
- export declare interface PBUiScrollResult {
6622
- value: PBVector2 | undefined;
6623
- }
6624
-
6625
- /**
6626
- * @public
6627
- */
6628
- export declare namespace PBUiScrollResult {
6629
- export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
6630
- export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
6631
- }
6632
-
6633
6143
  /**
6634
6144
  * @public
6635
6145
  */
@@ -6646,10 +6156,6 @@ export declare interface PBUiText {
6646
6156
  fontSize?: number | undefined;
6647
6157
  /** wrap text when the border is reached (default: TW_WRAP) */
6648
6158
  textWrap?: TextWrap | undefined;
6649
- /** width of the outline (default: 0) */
6650
- outlineWidth?: number | undefined;
6651
- /** RGBA color of the outline (default: opaque black) */
6652
- outlineColor?: PBColor4 | undefined;
6653
6159
  }
6654
6160
 
6655
6161
  /**
@@ -6777,12 +6283,6 @@ export declare interface PBUiTransform {
6777
6283
  borderRightColor?: PBColor4 | undefined;
6778
6284
  /** default: 1 */
6779
6285
  opacity?: number | undefined;
6780
- /** reference for scroll_position. default empty */
6781
- elementId?: string | undefined;
6782
- /** default position=(0,0) */
6783
- scrollPosition?: ScrollPositionValue | undefined;
6784
- /** default ShowScrollBar.SSB_BOTH */
6785
- scrollVisible?: ShowScrollBar | undefined;
6786
6286
  /** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
6787
6287
  zIndex?: number | undefined;
6788
6288
  }
@@ -6932,25 +6432,6 @@ export declare namespace PBVisibilityComponent {
6932
6432
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
6933
6433
  }
6934
6434
 
6935
- /**
6936
- * @public
6937
- */
6938
- export declare interface Perspective {
6939
- /**
6940
- * vertical field of view in radians
6941
- * defaults to pi/4 = 45 degrees
6942
- */
6943
- fieldOfView?: number | undefined;
6944
- }
6945
-
6946
- /**
6947
- * @public
6948
- */
6949
- export declare namespace Perspective {
6950
- export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
6951
- export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
6952
- }
6953
-
6954
6435
  /**
6955
6436
  * Represens a plane by the equation ax + by + cz + d = 0
6956
6437
  * @public
@@ -7106,37 +6587,11 @@ export declare interface PointerEventsSystem {
7106
6587
  * @param entity - Entity where the callback was attached
7107
6588
  */
7108
6589
  removeOnPointerHoverLeave(entity: Entity): void;
7109
- /**
7110
- * @public
7111
- * Remove the callback for onPointerDrag event
7112
- * @param entity - Entity where the callback was attached
7113
- */
7114
- removeOnPointerDrag(entity: Entity): void;
7115
- /**
7116
- * @public
7117
- * Remove the callback for onPointerDragLocked event
7118
- * @param entity - Entity where the callback was attached
7119
- */
7120
- removeOnPointerDragLocked(entity: Entity): void;
7121
- /**
7122
- * @public
7123
- * Remove the callback for onPointerDragEnd event
7124
- * @param entity - Entity where the callback was attached
7125
- */
7126
- removeOnPointerDragEnd(entity: Entity): void;
7127
- /**
7128
- * @public
7129
- * Execute callbacks when the user presses one of the InputButtons pointing at the entity
7130
- * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7131
- */
7132
- onPointerDown(pointerData: {
7133
- entity: Entity;
7134
- optsList: EventSystemOptionsCallback[];
7135
- }): void;
7136
6590
  /**
7137
6591
  * @public
7138
6592
  * Execute callback when the user press the InputButton pointing at the entity
7139
6593
  * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
6594
+ * @param cb - Function to execute when click fires
7140
6595
  */
7141
6596
  onPointerDown(pointerData: {
7142
6597
  entity: Entity;
@@ -7149,15 +6604,6 @@ export declare interface PointerEventsSystem {
7149
6604
  * @param opts - Opts to trigger Feedback and Button
7150
6605
  */
7151
6606
  onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
7152
- /**
7153
- * @public
7154
- * Execute callbacks when the user releases one of the InputButtons pointing at the entity
7155
- * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7156
- */
7157
- onPointerUp(pointerData: {
7158
- entity: Entity;
7159
- optsList: EventSystemOptionsCallback[];
7160
- }): void;
7161
6607
  /**
7162
6608
  * @public
7163
6609
  * Execute callback when the user releases the InputButton pointing at the entity
@@ -7195,64 +6641,6 @@ export declare interface PointerEventsSystem {
7195
6641
  entity: Entity;
7196
6642
  opts?: Partial<EventSystemOptions>;
7197
6643
  }, cb: EventSystemCallback): void;
7198
- /**
7199
- * @public
7200
- * Execute callbacks when the user drags the pointer from inside the entity
7201
- * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7202
- */
7203
- onPointerDrag(pointerData: {
7204
- entity: Entity;
7205
- optsList: EventSystemOptionsCallback[];
7206
- }): void;
7207
- /**
7208
- * @public
7209
- * Execute callback when the user clicks and drags the pointer from inside the entity
7210
- * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
7211
- * @param cb - Function to execute when click fires
7212
- */
7213
- onPointerDrag(pointerData: {
7214
- entity: Entity;
7215
- opts?: Partial<EventSystemOptions>;
7216
- }, cb: EventSystemCallback): void;
7217
- /**
7218
- * @public
7219
- * Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
7220
- * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7221
- */
7222
- onPointerDragLocked(pointerData: {
7223
- entity: Entity;
7224
- optsList: EventSystemOptionsCallback[];
7225
- }): void;
7226
- /**
7227
- * @public
7228
- * Execute callback when the user clicks and drags the pointer from inside the entity,
7229
- * locking the cursor in place
7230
- * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
7231
- * @param cb - Function to execute when click fires
7232
- */
7233
- onPointerDragLocked(pointerData: {
7234
- entity: Entity;
7235
- opts?: Partial<EventSystemOptions>;
7236
- }, cb: EventSystemCallback): void;
7237
- /**
7238
- * @public
7239
- * Execute callbacks when the user releases a button after a drag
7240
- * @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
7241
- */
7242
- onPointerDragEnd(pointerData: {
7243
- entity: Entity;
7244
- optsList: EventSystemOptionsCallback[];
7245
- }): void;
7246
- /**
7247
- * @public
7248
- * Execute callback when the user releases the button after a drag
7249
- * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
7250
- * @param cb - Function to execute when click fires
7251
- */
7252
- onPointerDragEnd(pointerData: {
7253
- entity: Entity;
7254
- opts?: Partial<EventSystemOptions>;
7255
- }, cb: EventSystemCallback): void;
7256
6644
  }
7257
6645
 
7258
6646
  /**
@@ -7269,10 +6657,7 @@ export declare const enum PointerEventType {
7269
6657
  PET_UP = 0,
7270
6658
  PET_DOWN = 1,
7271
6659
  PET_HOVER_ENTER = 2,
7272
- PET_HOVER_LEAVE = 3,
7273
- PET_DRAG_LOCKED = 4,
7274
- PET_DRAG = 5,
7275
- PET_DRAG_END = 6
6660
+ PET_HOVER_LEAVE = 3
7276
6661
  }
7277
6662
 
7278
6663
  /**
@@ -7303,10 +6688,7 @@ export declare const enum PointerType {
7303
6688
  /** POT_NONE - No pointer input */
7304
6689
  POT_NONE = 0,
7305
6690
  /** POT_MOUSE - Traditional mouse input */
7306
- POT_MOUSE = 1,
7307
- POT_PAD = 2,
7308
- POT_TOUCH = 3,
7309
- POT_WAND = 4
6691
+ POT_MOUSE = 1
7310
6692
  }
7311
6693
 
7312
6694
  /**
@@ -7909,11 +7291,6 @@ export declare interface ReactBasedUiSystem {
7909
7291
  * Set the main UI renderer. Optional virtual size defines the global UI scale factor.
7910
7292
  */
7911
7293
  setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
7912
- /**
7913
- * Set a texture renderer for a specific entity.
7914
- * @deprecated Use addUiRenderer instead
7915
- */
7916
- setTextureRenderer(entity: Entity, ui: UiComponent): void;
7917
7294
  /**
7918
7295
  * Add a UI renderer associated with an entity. The UI will be automatically cleaned up
7919
7296
  * when the entity is removed from the engine.
@@ -8497,49 +7874,6 @@ export declare namespace Schemas {
8497
7874
  }) => void;
8498
7875
  }
8499
7876
 
8500
- /**
8501
- * @public
8502
- */
8503
- export declare interface ScrollPositionValue {
8504
- value?: {
8505
- $case: "position";
8506
- position: PBVector2;
8507
- } | {
8508
- $case: "reference";
8509
- reference: string;
8510
- } | undefined;
8511
- }
8512
-
8513
- /**
8514
- * @public
8515
- */
8516
- export declare namespace ScrollPositionValue {
8517
- export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
8518
- export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
8519
- }
8520
-
8521
- /**
8522
- * @public
8523
- * The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
8524
- */
8525
- export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
8526
-
8527
- /**
8528
- * Sets a globalThis property as a polyfill (only if undefined/null).
8529
- * @public
8530
- */
8531
- export declare function setGlobalPolyfill<T>(key: string, value: T): void;
8532
-
8533
- /**
8534
- * @public
8535
- */
8536
- export declare const enum ShowScrollBar {
8537
- SSB_BOTH = 0,
8538
- SSB_ONLY_VERTICAL = 1,
8539
- SSB_ONLY_HORIZONTAL = 2,
8540
- SSB_HIDDEN = 3
8541
- }
8542
-
8543
7877
  /** @public */
8544
7878
  export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
8545
7879
 
@@ -8646,9 +7980,6 @@ export declare namespace Texture {
8646
7980
  export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
8647
7981
  }
8648
7982
 
8649
- /** @public */
8650
- export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
8651
-
8652
7983
  /**
8653
7984
  * @public
8654
7985
  */
@@ -8759,9 +8090,6 @@ export declare interface TextureUnion {
8759
8090
  } | {
8760
8091
  $case: "videoTexture";
8761
8092
  videoTexture: VideoTexture;
8762
- } | {
8763
- $case: "uiTexture";
8764
- uiTexture: UiCanvasTexture;
8765
8093
  } | undefined;
8766
8094
  }
8767
8095
 
@@ -9239,8 +8567,6 @@ export declare interface UiBackgroundProps {
9239
8567
  uvs?: number[];
9240
8568
  /** AvatarTexture for the background */
9241
8569
  avatarTexture?: UiAvatarTexture;
9242
- /** VideoTexture for the background */
9243
- videoTexture?: UiVideoTexture;
9244
8570
  /** Texture for the background */
9245
8571
  texture?: UiTexture;
9246
8572
  }
@@ -9260,31 +8586,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
9260
8586
  disabled?: boolean;
9261
8587
  }
9262
8588
 
9263
- /** @public */
9264
- export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
9265
-
9266
8589
  /** @public */
9267
8590
  export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
9268
8591
 
9269
- /**
9270
- * @public
9271
- */
9272
- export declare interface UiCanvasTexture {
9273
- uiCanvasEntity: number;
9274
- /** default = TextureWrapMode.Clamp */
9275
- wrapMode?: TextureWrapMode | undefined;
9276
- /** default = FilterMode.Bilinear */
9277
- filterMode?: TextureFilterMode | undefined;
9278
- }
9279
-
9280
- /**
9281
- * @public
9282
- */
9283
- export declare namespace UiCanvasTexture {
9284
- export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
9285
- export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
9286
- }
9287
-
9288
8592
  /**
9289
8593
  * @public
9290
8594
  */
@@ -9354,10 +8658,6 @@ export declare interface UiLabelProps {
9354
8658
  textAlign?: TextAlignType | undefined;
9355
8659
  /** Label font type. @defaultValue 'sans-serif' */
9356
8660
  font?: UiFontType | undefined;
9357
- /** Outline width of the text. @defaultValue 0 */
9358
- outlineWidth?: number | undefined;
9359
- /** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
9360
- outlineColor?: PBColor4 | undefined;
9361
8661
  /** Behaviour when text reached. @defaultValue 'wrap' */
9362
8662
  textWrap?: UiTextWrapType | undefined;
9363
8663
  }
@@ -9375,9 +8675,6 @@ export declare type UiRendererOptions = {
9375
8675
  virtualHeight: number;
9376
8676
  };
9377
8677
 
9378
- /** @public */
9379
- export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
9380
-
9381
8678
  /** @public */
9382
8679
  export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
9383
8680
 
@@ -9455,31 +8752,23 @@ export declare interface UiTransformProps {
9455
8752
  borderWidth?: Partial<Position> | PositionUnit;
9456
8753
  /** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
9457
8754
  opacity?: number;
9458
- /** A reference value to identify the element, default empty */
9459
- elementId?: string;
9460
- /** default position=(0,0) if it aplies, a vector or a reference-id */
9461
- scrollPosition?: PBVector2 | string;
9462
- /** default ShowScrollBar.SSB_BOTH */
9463
- scrollVisible?: ScrollVisibleType;
9464
8755
  /** default 0 */
9465
8756
  zIndex?: number;
9466
8757
  }
9467
8758
 
9468
- /**
9469
- * Texture
9470
- * @public
9471
- */
9472
- export declare interface UiVideoTexture {
9473
- videoPlayerEntity: Entity;
9474
- wrapMode?: TextureWrapType;
9475
- filterMode?: TextureFilterType;
9476
- }
9477
-
9478
8759
  /**
9479
8760
  * @public
9480
8761
  */
9481
8762
  export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
9482
8763
 
8764
+ export declare type ValidateCallback<T> = (value: {
8765
+ entity: Entity;
8766
+ currentValue: T | undefined;
8767
+ newValue: T | undefined;
8768
+ senderAddress: string;
8769
+ createdBy: string;
8770
+ }) => boolean;
8771
+
9483
8772
  /**
9484
8773
  * @public
9485
8774
  */