@dcl/playground-assets 7.29.1-35901015152.commit-d1b7b96 → 7.29.1-36041177279.commit-502e633
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 +139 -784
- package/dist/beta.d.ts +139 -784
- package/dist/index.bundled.d.ts +139 -784
- package/dist/index.js +7 -7
- package/dist/playground/sdk/apis.d.ts +2 -37
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +139 -784
- package/etc/playground-assets.api.json +5197 -12161
- package/etc/playground-assets.api.md +89 -510
- package/package.json +6 -5
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
|
-
|
|
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
|
-
|
|
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
|
|
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 = (
|
|
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
|
-
|
|
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
|
*/
|
|
@@ -2867,6 +2825,10 @@ export declare interface IEvents {
|
|
|
2867
2825
|
sender: string;
|
|
2868
2826
|
message: string;
|
|
2869
2827
|
};
|
|
2828
|
+
/** Triggered when the player switches the client language. `locale` is a BCP-47 tag */
|
|
2829
|
+
localeChanged: {
|
|
2830
|
+
locale: string;
|
|
2831
|
+
};
|
|
2870
2832
|
/**
|
|
2871
2833
|
* This is triggered once the scene should start.
|
|
2872
2834
|
*/
|
|
@@ -3086,6 +3048,35 @@ export declare const enum InteractionType {
|
|
|
3086
3048
|
PROXIMITY = 1
|
|
3087
3049
|
}
|
|
3088
3050
|
|
|
3051
|
+
/**
|
|
3052
|
+
* Internal component interface that exposes all internal methods for SDK use
|
|
3053
|
+
* This is not exposed to users, only for internal SDK operations
|
|
3054
|
+
*/
|
|
3055
|
+
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3056
|
+
/**
|
|
3057
|
+
* @public
|
|
3058
|
+
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3059
|
+
*/
|
|
3060
|
+
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3061
|
+
/**
|
|
3062
|
+
* @public
|
|
3063
|
+
* Get the iterator to every entity has the component
|
|
3064
|
+
*/
|
|
3065
|
+
iterator(): Iterable<[Entity, any]>;
|
|
3066
|
+
/**
|
|
3067
|
+
* @public
|
|
3068
|
+
*/
|
|
3069
|
+
dirtyIterator(): Iterable<Entity>;
|
|
3070
|
+
/**
|
|
3071
|
+
* @public
|
|
3072
|
+
*/
|
|
3073
|
+
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3074
|
+
/**
|
|
3075
|
+
* @public
|
|
3076
|
+
*/
|
|
3077
|
+
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3078
|
+
}
|
|
3079
|
+
|
|
3089
3080
|
/**
|
|
3090
3081
|
* @public
|
|
3091
3082
|
*/
|
|
@@ -3289,12 +3280,6 @@ export declare type Listeners = {
|
|
|
3289
3280
|
onMouseEnter?: Callback;
|
|
3290
3281
|
/** triggered on mouse leave event */
|
|
3291
3282
|
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
3283
|
};
|
|
3299
3284
|
|
|
3300
3285
|
/**
|
|
@@ -4199,15 +4184,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4199
4184
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4200
4185
|
*/
|
|
4201
4186
|
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
4187
|
}
|
|
4212
4188
|
|
|
4213
4189
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4244,14 +4220,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4244
4220
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4245
4221
|
*/
|
|
4246
4222
|
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
4223
|
}
|
|
4256
4224
|
|
|
4257
4225
|
/**
|
|
@@ -4300,39 +4268,6 @@ export declare namespace MoveContinuous {
|
|
|
4300
4268
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4301
4269
|
}
|
|
4302
4270
|
|
|
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
4271
|
/**
|
|
4337
4272
|
* @public
|
|
4338
4273
|
*/
|
|
@@ -4756,25 +4691,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4756
4691
|
totalVideoLength: number;
|
|
4757
4692
|
}>;
|
|
4758
4693
|
|
|
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
4694
|
/**
|
|
4779
4695
|
* @public
|
|
4780
4696
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -5072,8 +4988,6 @@ export declare interface PBAvatarBase {
|
|
|
5072
4988
|
hairColor: PBColor3 | undefined;
|
|
5073
4989
|
bodyShapeUrn: string;
|
|
5074
4990
|
name: string;
|
|
5075
|
-
/** true while the player is speaking in voice chat; unset when the engine does not report voice activity */
|
|
5076
|
-
talking?: boolean | undefined;
|
|
5077
4991
|
}
|
|
5078
4992
|
|
|
5079
4993
|
/**
|
|
@@ -5124,8 +5038,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
5124
5038
|
export declare interface PBAvatarEquippedData {
|
|
5125
5039
|
wearableUrns: string[];
|
|
5126
5040
|
emoteUrns: string[];
|
|
5127
|
-
/** slots that will render even if hidden */
|
|
5128
|
-
forceRender: string[];
|
|
5129
5041
|
}
|
|
5130
5042
|
|
|
5131
5043
|
/**
|
|
@@ -5196,8 +5108,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
5196
5108
|
excludeIds: string[];
|
|
5197
5109
|
/** list of modifiers to apply */
|
|
5198
5110
|
modifiers: AvatarModifierType[];
|
|
5199
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5200
|
-
useColliderRange?: boolean | undefined;
|
|
5201
5111
|
}
|
|
5202
5112
|
|
|
5203
5113
|
/**
|
|
@@ -5208,64 +5118,6 @@ export declare namespace PBAvatarModifierArea {
|
|
|
5208
5118
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
|
|
5209
5119
|
}
|
|
5210
5120
|
|
|
5211
|
-
/**
|
|
5212
|
-
* @public
|
|
5213
|
-
*/
|
|
5214
|
-
export declare interface PBAvatarMovement {
|
|
5215
|
-
velocity: PBVector3 | undefined;
|
|
5216
|
-
/** 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. */
|
|
5217
|
-
orientation: number;
|
|
5218
|
-
groundDirection?: PBVector3 | undefined;
|
|
5219
|
-
/** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
|
|
5220
|
-
walkSuccess?: boolean | undefined;
|
|
5221
|
-
/** if set, the engine plays this animation instead of selecting one from velocity heuristics */
|
|
5222
|
-
animation?: MovementAnimation | undefined;
|
|
5223
|
-
/** 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. */
|
|
5224
|
-
tiltPitch?: number | undefined;
|
|
5225
|
-
/** 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. */
|
|
5226
|
-
tiltRoll?: number | undefined;
|
|
5227
|
-
}
|
|
5228
|
-
|
|
5229
|
-
/**
|
|
5230
|
-
* @public
|
|
5231
|
-
*/
|
|
5232
|
-
export declare namespace PBAvatarMovement {
|
|
5233
|
-
export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
|
|
5234
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
|
|
5235
|
-
}
|
|
5236
|
-
|
|
5237
|
-
/**
|
|
5238
|
-
* @public
|
|
5239
|
-
*/
|
|
5240
|
-
export declare interface PBAvatarMovementInfo {
|
|
5241
|
-
/** the length of time the current step velocity will apply for */
|
|
5242
|
-
stepTime: number;
|
|
5243
|
-
/** the length of time the previous step velocity applied for */
|
|
5244
|
-
previousStepTime: number;
|
|
5245
|
-
/** the velocity requested for the previous frame */
|
|
5246
|
-
requestedVelocity: PBVector3 | undefined;
|
|
5247
|
-
/** the resulting velocity taking collisions into account */
|
|
5248
|
-
actualVelocity: PBVector3 | undefined;
|
|
5249
|
-
/** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
|
|
5250
|
-
externalVelocity: PBVector3 | undefined;
|
|
5251
|
-
activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
|
|
5252
|
-
activeInputModifier: PBInputModifier | undefined;
|
|
5253
|
-
/** if set, the movement scene should walk the player to this scene-relative position */
|
|
5254
|
-
walkTarget?: PBVector3 | undefined;
|
|
5255
|
-
/** stop distance for walk_target; considered reached when within this distance */
|
|
5256
|
-
walkThreshold?: number | undefined;
|
|
5257
|
-
/** 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. */
|
|
5258
|
-
activeAnimationState?: AvatarAnimationState | undefined;
|
|
5259
|
-
}
|
|
5260
|
-
|
|
5261
|
-
/**
|
|
5262
|
-
* @public
|
|
5263
|
-
*/
|
|
5264
|
-
export declare namespace PBAvatarMovementInfo {
|
|
5265
|
-
export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
|
|
5266
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
|
|
5267
|
-
}
|
|
5268
|
-
|
|
5269
5121
|
/**
|
|
5270
5122
|
* The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
|
|
5271
5123
|
* for example to show a rank or a role that the scene assigns to that player.
|
|
@@ -5356,8 +5208,6 @@ export declare interface PBAvatarShape {
|
|
|
5356
5208
|
emotes: string[];
|
|
5357
5209
|
/** hides the skin + hair + facial features (default: false) */
|
|
5358
5210
|
showOnlyWearables?: boolean | undefined;
|
|
5359
|
-
/** slots that will render even if hidden */
|
|
5360
|
-
forceRender: string[];
|
|
5361
5211
|
}
|
|
5362
5212
|
|
|
5363
5213
|
/**
|
|
@@ -5399,51 +5249,6 @@ export declare namespace PBBillboard {
|
|
|
5399
5249
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
5400
5250
|
}
|
|
5401
5251
|
|
|
5402
|
-
/**
|
|
5403
|
-
* @public
|
|
5404
|
-
*/
|
|
5405
|
-
export declare interface PBCameraLayer {
|
|
5406
|
-
/**
|
|
5407
|
-
* layer to which these settings apply. must be > 0
|
|
5408
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
5409
|
-
*/
|
|
5410
|
-
layer: number;
|
|
5411
|
-
/** should the sun light affect this layer? default false */
|
|
5412
|
-
directionalLight?: boolean | undefined;
|
|
5413
|
-
/** should this layer show player avatars? default false */
|
|
5414
|
-
showAvatars?: boolean | undefined;
|
|
5415
|
-
/** should this layer show the sky? default false */
|
|
5416
|
-
showSkybox?: boolean | undefined;
|
|
5417
|
-
/** should this layer show distance fog? default false */
|
|
5418
|
-
showFog?: boolean | undefined;
|
|
5419
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
5420
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
5421
|
-
ambientBrightnessOverride?: number | undefined;
|
|
5422
|
-
}
|
|
5423
|
-
|
|
5424
|
-
/**
|
|
5425
|
-
* @public
|
|
5426
|
-
*/
|
|
5427
|
-
export declare namespace PBCameraLayer {
|
|
5428
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
5429
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
5430
|
-
}
|
|
5431
|
-
|
|
5432
|
-
/**
|
|
5433
|
-
* @public
|
|
5434
|
-
*/
|
|
5435
|
-
export declare interface PBCameraLayers {
|
|
5436
|
-
layers: number[];
|
|
5437
|
-
}
|
|
5438
|
-
|
|
5439
|
-
/**
|
|
5440
|
-
* @public
|
|
5441
|
-
*/
|
|
5442
|
-
export declare namespace PBCameraLayers {
|
|
5443
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5444
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5445
|
-
}
|
|
5446
|
-
|
|
5447
5252
|
/**
|
|
5448
5253
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5449
5254
|
* third-person view.
|
|
@@ -5485,8 +5290,6 @@ export declare interface PBCameraModeArea {
|
|
|
5485
5290
|
area: PBVector3 | undefined;
|
|
5486
5291
|
/** the camera mode to enforce */
|
|
5487
5292
|
mode: CameraType;
|
|
5488
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5489
|
-
useColliderRange?: boolean | undefined;
|
|
5490
5293
|
}
|
|
5491
5294
|
|
|
5492
5295
|
/**
|
|
@@ -5620,39 +5423,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
|
|
|
5620
5423
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
|
|
5621
5424
|
}
|
|
5622
5425
|
|
|
5623
|
-
/**
|
|
5624
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5625
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5626
|
-
*/
|
|
5627
|
-
/**
|
|
5628
|
-
* @public
|
|
5629
|
-
*/
|
|
5630
|
-
export declare interface PBGlobalLight {
|
|
5631
|
-
/**
|
|
5632
|
-
* the direction the directional light shines in.
|
|
5633
|
-
* default depends on time of day and explorer implementation
|
|
5634
|
-
*/
|
|
5635
|
-
direction?: PBVector3 | undefined;
|
|
5636
|
-
/**
|
|
5637
|
-
* ambient light color
|
|
5638
|
-
* default: White
|
|
5639
|
-
*/
|
|
5640
|
-
ambientColor?: PBColor3 | undefined;
|
|
5641
|
-
/**
|
|
5642
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5643
|
-
* default 1
|
|
5644
|
-
*/
|
|
5645
|
-
ambientBrightness?: number | undefined;
|
|
5646
|
-
}
|
|
5647
|
-
|
|
5648
|
-
/**
|
|
5649
|
-
* @public
|
|
5650
|
-
*/
|
|
5651
|
-
export declare namespace PBGlobalLight {
|
|
5652
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5653
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5654
|
-
}
|
|
5655
|
-
|
|
5656
5426
|
/**
|
|
5657
5427
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5658
5428
|
*
|
|
@@ -5688,25 +5458,6 @@ export declare namespace PBGltfContainer {
|
|
|
5688
5458
|
*/
|
|
5689
5459
|
export declare interface PBGltfContainerLoadingState {
|
|
5690
5460
|
currentState: LoadingState;
|
|
5691
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5692
|
-
nodePaths: string[];
|
|
5693
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5694
|
-
meshNames: string[];
|
|
5695
|
-
/**
|
|
5696
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5697
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5698
|
-
*/
|
|
5699
|
-
materialNames: string[];
|
|
5700
|
-
/**
|
|
5701
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5702
|
-
* sure all your materials are explicitly named.
|
|
5703
|
-
*/
|
|
5704
|
-
skinNames: string[];
|
|
5705
|
-
/**
|
|
5706
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5707
|
-
* your skins are explicitly named.
|
|
5708
|
-
*/
|
|
5709
|
-
animationNames: string[];
|
|
5710
5461
|
}
|
|
5711
5462
|
|
|
5712
5463
|
/**
|
|
@@ -5717,57 +5468,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5717
5468
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5718
5469
|
}
|
|
5719
5470
|
|
|
5720
|
-
/**
|
|
5721
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5722
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5723
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5724
|
-
* in the parent.
|
|
5725
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5726
|
-
*
|
|
5727
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5728
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5729
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5730
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5731
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5732
|
-
*
|
|
5733
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5734
|
-
*
|
|
5735
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5736
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5737
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5738
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5739
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5740
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5741
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5742
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5743
|
-
* 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
|
|
5744
|
-
* PBMaterial will be maintained.
|
|
5745
|
-
*
|
|
5746
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5747
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5748
|
-
* change the state to `GNS_FAILED`.
|
|
5749
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5750
|
-
*
|
|
5751
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5752
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5753
|
-
* the gltf node will also be displayed.
|
|
5754
|
-
*/
|
|
5755
|
-
/**
|
|
5756
|
-
* @public
|
|
5757
|
-
*/
|
|
5758
|
-
export declare interface PBGltfNode {
|
|
5759
|
-
/** the path of the target node in the Gltf. */
|
|
5760
|
-
path: string;
|
|
5761
|
-
}
|
|
5762
|
-
|
|
5763
|
-
/**
|
|
5764
|
-
* @public
|
|
5765
|
-
*/
|
|
5766
|
-
export declare namespace PBGltfNode {
|
|
5767
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5768
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5769
|
-
}
|
|
5770
|
-
|
|
5771
5471
|
/**
|
|
5772
5472
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5773
5473
|
*
|
|
@@ -5813,26 +5513,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5813
5513
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5814
5514
|
}
|
|
5815
5515
|
|
|
5816
|
-
/**
|
|
5817
|
-
* The state of a linked gltf node.
|
|
5818
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5819
|
-
*/
|
|
5820
|
-
/**
|
|
5821
|
-
* @public
|
|
5822
|
-
*/
|
|
5823
|
-
export declare interface PBGltfNodeState {
|
|
5824
|
-
state: GltfNodeStateValue;
|
|
5825
|
-
error?: string | undefined;
|
|
5826
|
-
}
|
|
5827
|
-
|
|
5828
|
-
/**
|
|
5829
|
-
* @public
|
|
5830
|
-
*/
|
|
5831
|
-
export declare namespace PBGltfNodeState {
|
|
5832
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5833
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5834
|
-
}
|
|
5835
|
-
|
|
5836
5516
|
/**
|
|
5837
5517
|
* @public
|
|
5838
5518
|
*/
|
|
@@ -5970,14 +5650,6 @@ export declare interface PBMaterial {
|
|
|
5970
5650
|
$case: "pbr";
|
|
5971
5651
|
pbr: PBMaterial_PbrMaterial;
|
|
5972
5652
|
} | undefined;
|
|
5973
|
-
/**
|
|
5974
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
5975
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
5976
|
-
* supported by the PbMaterial.
|
|
5977
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
5978
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
5979
|
-
*/
|
|
5980
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
5981
5653
|
}
|
|
5982
5654
|
|
|
5983
5655
|
/**
|
|
@@ -5988,22 +5660,6 @@ export declare namespace PBMaterial {
|
|
|
5988
5660
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
5989
5661
|
}
|
|
5990
5662
|
|
|
5991
|
-
/**
|
|
5992
|
-
* @public
|
|
5993
|
-
*/
|
|
5994
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
5995
|
-
gltfSrc: string;
|
|
5996
|
-
name: string;
|
|
5997
|
-
}
|
|
5998
|
-
|
|
5999
|
-
/**
|
|
6000
|
-
* @public
|
|
6001
|
-
*/
|
|
6002
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
6003
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
6004
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
6005
|
-
}
|
|
6006
|
-
|
|
6007
5663
|
/**
|
|
6008
5664
|
* @public
|
|
6009
5665
|
*/
|
|
@@ -6100,9 +5756,6 @@ export declare interface PBMeshCollider {
|
|
|
6100
5756
|
} | {
|
|
6101
5757
|
$case: "plane";
|
|
6102
5758
|
plane: PBMeshCollider_PlaneMesh;
|
|
6103
|
-
} | {
|
|
6104
|
-
$case: "gltf";
|
|
6105
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
6106
5759
|
} | undefined;
|
|
6107
5760
|
}
|
|
6108
5761
|
|
|
@@ -6148,25 +5801,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
6148
5801
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
6149
5802
|
}
|
|
6150
5803
|
|
|
6151
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
6152
|
-
/**
|
|
6153
|
-
* @public
|
|
6154
|
-
*/
|
|
6155
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
6156
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6157
|
-
gltfSrc: string;
|
|
6158
|
-
/** the name of the mesh asset */
|
|
6159
|
-
name: string;
|
|
6160
|
-
}
|
|
6161
|
-
|
|
6162
|
-
/**
|
|
6163
|
-
* @public
|
|
6164
|
-
*/
|
|
6165
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
6166
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6167
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
6168
|
-
}
|
|
6169
|
-
|
|
6170
5804
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
6171
5805
|
/**
|
|
6172
5806
|
* @public
|
|
@@ -6199,11 +5833,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
6199
5833
|
|
|
6200
5834
|
/**
|
|
6201
5835
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
6202
|
-
* plane, a sphere
|
|
5836
|
+
* plane, a sphere or a cylinder.
|
|
6203
5837
|
*
|
|
6204
5838
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
6205
5839
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
6206
5840
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5841
|
+
*
|
|
5842
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
|
6207
5843
|
*/
|
|
6208
5844
|
/**
|
|
6209
5845
|
* @public
|
|
@@ -6221,9 +5857,6 @@ export declare interface PBMeshRenderer {
|
|
|
6221
5857
|
} | {
|
|
6222
5858
|
$case: "plane";
|
|
6223
5859
|
plane: PBMeshRenderer_PlaneMesh;
|
|
6224
|
-
} | {
|
|
6225
|
-
$case: "gltf";
|
|
6226
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
6227
5860
|
} | undefined;
|
|
6228
5861
|
}
|
|
6229
5862
|
|
|
@@ -6271,25 +5904,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
6271
5904
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
6272
5905
|
}
|
|
6273
5906
|
|
|
6274
|
-
/** A mesh from a Gltf. */
|
|
6275
|
-
/**
|
|
6276
|
-
* @public
|
|
6277
|
-
*/
|
|
6278
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
6279
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6280
|
-
gltfSrc: string;
|
|
6281
|
-
/** the name of the mesh asset */
|
|
6282
|
-
name: string;
|
|
6283
|
-
}
|
|
6284
|
-
|
|
6285
|
-
/**
|
|
6286
|
-
* @public
|
|
6287
|
-
*/
|
|
6288
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
6289
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6290
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
6291
|
-
}
|
|
6292
|
-
|
|
6293
5907
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
6294
5908
|
/**
|
|
6295
5909
|
* @public
|
|
@@ -6886,10 +6500,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
6886
6500
|
screenCoordinates?: PBVector2 | undefined;
|
|
6887
6501
|
/** Movement since last frame (pixels) */
|
|
6888
6502
|
screenDelta?: PBVector2 | undefined;
|
|
6889
|
-
/**
|
|
6890
|
-
* ray direction that can be used with the primary camera origin for
|
|
6891
|
-
* raycasting from the cursor into the world
|
|
6892
|
-
*/
|
|
6503
|
+
/** Direction vector for 3D ray casting */
|
|
6893
6504
|
worldRayDirection?: PBVector3 | undefined;
|
|
6894
6505
|
}
|
|
6895
6506
|
|
|
@@ -6960,10 +6571,6 @@ export declare interface PBRaycast {
|
|
|
6960
6571
|
continuous?: boolean | undefined;
|
|
6961
6572
|
/** Collision mask, by default CL_POINTER | CL_PHYSICS */
|
|
6962
6573
|
collisionMask?: number | undefined;
|
|
6963
|
-
/** shape to cast, default ray */
|
|
6964
|
-
shape?: RaycastShape | undefined;
|
|
6965
|
-
/** include hits with entities from other scenes */
|
|
6966
|
-
includeWorld?: boolean | undefined;
|
|
6967
6574
|
}
|
|
6968
6575
|
|
|
6969
6576
|
/**
|
|
@@ -7109,8 +6716,6 @@ export declare interface PBTextShape {
|
|
|
7109
6716
|
outlineColor?: PBColor3 | undefined;
|
|
7110
6717
|
/** text color (default [1.0, 1.0, 1.0]) */
|
|
7111
6718
|
textColor?: PBColor4 | undefined;
|
|
7112
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7113
|
-
fontSrc?: string | undefined;
|
|
7114
6719
|
}
|
|
7115
6720
|
|
|
7116
6721
|
/**
|
|
@@ -7121,46 +6726,6 @@ export declare namespace PBTextShape {
|
|
|
7121
6726
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
7122
6727
|
}
|
|
7123
6728
|
|
|
7124
|
-
/**
|
|
7125
|
-
* @public
|
|
7126
|
-
*/
|
|
7127
|
-
export declare interface PBTextureCamera {
|
|
7128
|
-
/** rendered texture width */
|
|
7129
|
-
width?: number | undefined;
|
|
7130
|
-
/** rendered texture height */
|
|
7131
|
-
height?: number | undefined;
|
|
7132
|
-
/**
|
|
7133
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
7134
|
-
* defaults to 0
|
|
7135
|
-
*/
|
|
7136
|
-
layer?: number | undefined;
|
|
7137
|
-
/** default black */
|
|
7138
|
-
clearColor?: PBColor4 | undefined;
|
|
7139
|
-
/** default infinity */
|
|
7140
|
-
farPlane?: number | undefined;
|
|
7141
|
-
mode?: {
|
|
7142
|
-
$case: "perspective";
|
|
7143
|
-
perspective: Perspective;
|
|
7144
|
-
} | {
|
|
7145
|
-
$case: "orthographic";
|
|
7146
|
-
orthographic: Orthographic;
|
|
7147
|
-
} | undefined;
|
|
7148
|
-
/**
|
|
7149
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
7150
|
-
* range: 0 (off) - 1 (full volume)
|
|
7151
|
-
* default: 0
|
|
7152
|
-
*/
|
|
7153
|
-
volume?: number | undefined;
|
|
7154
|
-
}
|
|
7155
|
-
|
|
7156
|
-
/**
|
|
7157
|
-
* @public
|
|
7158
|
-
*/
|
|
7159
|
-
export declare namespace PBTextureCamera {
|
|
7160
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
7161
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
7162
|
-
}
|
|
7163
|
-
|
|
7164
6729
|
/**
|
|
7165
6730
|
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
7166
6731
|
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
@@ -7406,25 +6971,6 @@ export declare namespace PBUiBackground {
|
|
|
7406
6971
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
7407
6972
|
}
|
|
7408
6973
|
|
|
7409
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
7410
|
-
/**
|
|
7411
|
-
* @public
|
|
7412
|
-
*/
|
|
7413
|
-
export declare interface PBUiCanvas {
|
|
7414
|
-
width: number;
|
|
7415
|
-
height: number;
|
|
7416
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
7417
|
-
color?: PBColor4 | undefined;
|
|
7418
|
-
}
|
|
7419
|
-
|
|
7420
|
-
/**
|
|
7421
|
-
* @public
|
|
7422
|
-
*/
|
|
7423
|
-
export declare namespace PBUiCanvas {
|
|
7424
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
7425
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
7426
|
-
}
|
|
7427
|
-
|
|
7428
6974
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
7429
6975
|
/**
|
|
7430
6976
|
* @public
|
|
@@ -7480,8 +7026,6 @@ export declare interface PBUiDropdown {
|
|
|
7480
7026
|
font?: Font | undefined;
|
|
7481
7027
|
/** default=10 */
|
|
7482
7028
|
fontSize?: number | undefined;
|
|
7483
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7484
|
-
fontSrc?: string | undefined;
|
|
7485
7029
|
}
|
|
7486
7030
|
|
|
7487
7031
|
/**
|
|
@@ -7524,12 +7068,6 @@ export declare interface PBUiInput {
|
|
|
7524
7068
|
/** default=10 */
|
|
7525
7069
|
fontSize?: number | undefined;
|
|
7526
7070
|
value?: string | undefined;
|
|
7527
|
-
/** default=false; when true, the input accepts newlines and behaves as a textarea */
|
|
7528
|
-
multiLine?: boolean | undefined;
|
|
7529
|
-
/** default=true; when false, the input value is preserved after pressing Enter */
|
|
7530
|
-
clearOnSubmit?: boolean | undefined;
|
|
7531
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7532
|
-
fontSrc?: string | undefined;
|
|
7533
7071
|
}
|
|
7534
7072
|
|
|
7535
7073
|
/**
|
|
@@ -7593,21 +7131,6 @@ export declare namespace PBUiInputResult {
|
|
|
7593
7131
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
7594
7132
|
}
|
|
7595
7133
|
|
|
7596
|
-
/**
|
|
7597
|
-
* @public
|
|
7598
|
-
*/
|
|
7599
|
-
export declare interface PBUiScrollResult {
|
|
7600
|
-
value: PBVector2 | undefined;
|
|
7601
|
-
}
|
|
7602
|
-
|
|
7603
|
-
/**
|
|
7604
|
-
* @public
|
|
7605
|
-
*/
|
|
7606
|
-
export declare namespace PBUiScrollResult {
|
|
7607
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
7608
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
7609
|
-
}
|
|
7610
|
-
|
|
7611
7134
|
/**
|
|
7612
7135
|
* @public
|
|
7613
7136
|
*/
|
|
@@ -7624,8 +7147,6 @@ export declare interface PBUiText {
|
|
|
7624
7147
|
fontSize?: number | undefined;
|
|
7625
7148
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
|
7626
7149
|
textWrap?: TextWrap | undefined;
|
|
7627
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7628
|
-
fontSrc?: string | undefined;
|
|
7629
7150
|
}
|
|
7630
7151
|
|
|
7631
7152
|
/**
|
|
@@ -7753,12 +7274,6 @@ export declare interface PBUiTransform {
|
|
|
7753
7274
|
borderRightColor?: PBColor4 | undefined;
|
|
7754
7275
|
/** default: 1 */
|
|
7755
7276
|
opacity?: number | undefined;
|
|
7756
|
-
/** reference for scroll_position. default empty */
|
|
7757
|
-
elementId?: string | undefined;
|
|
7758
|
-
/** default position=(0,0) */
|
|
7759
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
7760
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
7761
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
7762
7277
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
7763
7278
|
zIndex?: number | undefined;
|
|
7764
7279
|
}
|
|
@@ -7911,25 +7426,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
7911
7426
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
7912
7427
|
}
|
|
7913
7428
|
|
|
7914
|
-
/**
|
|
7915
|
-
* @public
|
|
7916
|
-
*/
|
|
7917
|
-
export declare interface Perspective {
|
|
7918
|
-
/**
|
|
7919
|
-
* vertical field of view in radians
|
|
7920
|
-
* defaults to pi/4 = 45 degrees
|
|
7921
|
-
*/
|
|
7922
|
-
fieldOfView?: number | undefined;
|
|
7923
|
-
}
|
|
7924
|
-
|
|
7925
|
-
/**
|
|
7926
|
-
* @public
|
|
7927
|
-
*/
|
|
7928
|
-
export declare namespace Perspective {
|
|
7929
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
7930
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
7931
|
-
}
|
|
7932
|
-
|
|
7933
7429
|
/**
|
|
7934
7430
|
* @public
|
|
7935
7431
|
* Physics helpers for applying impulses and forces to the player.
|
|
@@ -8171,24 +7667,6 @@ export declare interface PointerEventsSystem {
|
|
|
8171
7667
|
* @param entity - Entity where the callback was attached
|
|
8172
7668
|
*/
|
|
8173
7669
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
8174
|
-
/**
|
|
8175
|
-
* @public
|
|
8176
|
-
* Remove the callback for onPointerDrag event
|
|
8177
|
-
* @param entity - Entity where the callback was attached
|
|
8178
|
-
*/
|
|
8179
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
8180
|
-
/**
|
|
8181
|
-
* @public
|
|
8182
|
-
* Remove the callback for onPointerDragLocked event
|
|
8183
|
-
* @param entity - Entity where the callback was attached
|
|
8184
|
-
*/
|
|
8185
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
8186
|
-
/**
|
|
8187
|
-
* @public
|
|
8188
|
-
* Remove the callback for onPointerDragEnd event
|
|
8189
|
-
* @param entity - Entity where the callback was attached
|
|
8190
|
-
*/
|
|
8191
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
8192
7670
|
/**
|
|
8193
7671
|
* @public
|
|
8194
7672
|
* Remove the callback for onProximityDown event
|
|
@@ -8267,36 +7745,6 @@ export declare interface PointerEventsSystem {
|
|
|
8267
7745
|
entity: Entity;
|
|
8268
7746
|
opts?: Partial<EventSystemOptions>;
|
|
8269
7747
|
}, cb: EventSystemCallback): void;
|
|
8270
|
-
/**
|
|
8271
|
-
* @public
|
|
8272
|
-
* Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
|
|
8273
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8274
|
-
* @param cb - Function to execute on every drag update
|
|
8275
|
-
*/
|
|
8276
|
-
onPointerDrag(pointerData: {
|
|
8277
|
-
entity: Entity;
|
|
8278
|
-
opts?: Partial<EventSystemOptions>;
|
|
8279
|
-
}, cb: EventSystemCallback): void;
|
|
8280
|
-
/**
|
|
8281
|
-
* @public
|
|
8282
|
-
* Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
|
|
8283
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8284
|
-
* @param cb - Function to execute on every drag update
|
|
8285
|
-
*/
|
|
8286
|
-
onPointerDragLocked(pointerData: {
|
|
8287
|
-
entity: Entity;
|
|
8288
|
-
opts?: Partial<EventSystemOptions>;
|
|
8289
|
-
}, cb: EventSystemCallback): void;
|
|
8290
|
-
/**
|
|
8291
|
-
* @public
|
|
8292
|
-
* Execute callback when the user releases the button after a drag that started on the entity
|
|
8293
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8294
|
-
* @param cb - Function to execute when the drag ends
|
|
8295
|
-
*/
|
|
8296
|
-
onPointerDragEnd(pointerData: {
|
|
8297
|
-
entity: Entity;
|
|
8298
|
-
opts?: Partial<EventSystemOptions>;
|
|
8299
|
-
}, cb: EventSystemCallback): void;
|
|
8300
7748
|
/**
|
|
8301
7749
|
* @public
|
|
8302
7750
|
* Execute callback when the user presses the proximity button on the entity
|
|
@@ -8355,10 +7803,7 @@ export declare const enum PointerEventType {
|
|
|
8355
7803
|
PET_HOVER_ENTER = 2,
|
|
8356
7804
|
PET_HOVER_LEAVE = 3,
|
|
8357
7805
|
PET_PROXIMITY_ENTER = 4,
|
|
8358
|
-
PET_PROXIMITY_LEAVE = 5
|
|
8359
|
-
PET_DRAG_LOCKED = 6,
|
|
8360
|
-
PET_DRAG = 7,
|
|
8361
|
-
PET_DRAG_END = 8
|
|
7806
|
+
PET_PROXIMITY_LEAVE = 5
|
|
8362
7807
|
}
|
|
8363
7808
|
|
|
8364
7809
|
/**
|
|
@@ -8389,10 +7834,7 @@ export declare const enum PointerType {
|
|
|
8389
7834
|
/** POT_NONE - No pointer input */
|
|
8390
7835
|
POT_NONE = 0,
|
|
8391
7836
|
/** POT_MOUSE - Traditional mouse input */
|
|
8392
|
-
POT_MOUSE = 1
|
|
8393
|
-
POT_PAD = 2,
|
|
8394
|
-
POT_TOUCH = 3,
|
|
8395
|
-
POT_WAND = 4
|
|
7837
|
+
POT_MOUSE = 1
|
|
8396
7838
|
}
|
|
8397
7839
|
|
|
8398
7840
|
/**
|
|
@@ -8849,16 +8291,6 @@ export declare const enum RaycastQueryType {
|
|
|
8849
8291
|
/** @public */
|
|
8850
8292
|
export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
|
|
8851
8293
|
|
|
8852
|
-
/**
|
|
8853
|
-
* @public
|
|
8854
|
-
*/
|
|
8855
|
-
export declare const enum RaycastShape {
|
|
8856
|
-
/** RS_RAY - cast a point, get collisions along a ray */
|
|
8857
|
-
RS_RAY = 0,
|
|
8858
|
-
/** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
|
|
8859
|
-
RS_AVATAR = 1
|
|
8860
|
-
}
|
|
8861
|
-
|
|
8862
8294
|
/**
|
|
8863
8295
|
* @public
|
|
8864
8296
|
*/
|
|
@@ -8991,10 +8423,6 @@ export declare type RaycastSystemOptions = {
|
|
|
8991
8423
|
queryType: RaycastQueryType;
|
|
8992
8424
|
continuous?: boolean | undefined;
|
|
8993
8425
|
collisionMask?: number | undefined;
|
|
8994
|
-
/** shape to sweep along the ray, default RS_RAY (a point) */
|
|
8995
|
-
shape?: RaycastShape | undefined;
|
|
8996
|
-
/** include colliders from other scenes, default false */
|
|
8997
|
-
includeWorld?: boolean | undefined;
|
|
8998
8426
|
};
|
|
8999
8427
|
|
|
9000
8428
|
/**
|
|
@@ -9043,20 +8471,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
9043
8471
|
* @param entity - The entity whose UI renderer should be removed
|
|
9044
8472
|
*/
|
|
9045
8473
|
removeUiRenderer(entity: Entity): void;
|
|
9046
|
-
/**
|
|
9047
|
-
* Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
|
|
9048
|
-
* describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
|
|
9049
|
-
* any texture renderer already set on the entity, and is torn down when the entity is removed.
|
|
9050
|
-
*
|
|
9051
|
-
* @param entity - The UiCanvas entity the UI tree hangs from
|
|
9052
|
-
* @param ui - The UI component to render
|
|
9053
|
-
*/
|
|
9054
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
9055
|
-
/**
|
|
9056
|
-
* Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
|
|
9057
|
-
* @param entity - The UiCanvas entity the renderer was set on
|
|
9058
|
-
*/
|
|
9059
|
-
removeTextureRenderer(entity: Entity): void;
|
|
9060
8474
|
}
|
|
9061
8475
|
|
|
9062
8476
|
/**
|
|
@@ -9220,7 +8634,7 @@ export declare type ReadOnlyLastWriteWinElementSetComponentDefinition<T> = Omit<
|
|
|
9220
8634
|
/**
|
|
9221
8635
|
* @public
|
|
9222
8636
|
*/
|
|
9223
|
-
export declare type ReadonlyPrimitive = number | string |
|
|
8637
|
+
export declare type ReadonlyPrimitive = number | string | boolean;
|
|
9224
8638
|
|
|
9225
8639
|
/** @public */
|
|
9226
8640
|
export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;
|
|
@@ -9647,33 +9061,6 @@ export declare namespace Schemas {
|
|
|
9647
9061
|
*/
|
|
9648
9062
|
export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
|
|
9649
9063
|
|
|
9650
|
-
/**
|
|
9651
|
-
* @public
|
|
9652
|
-
*/
|
|
9653
|
-
export declare interface ScrollPositionValue {
|
|
9654
|
-
value?: {
|
|
9655
|
-
$case: "position";
|
|
9656
|
-
position: PBVector2;
|
|
9657
|
-
} | {
|
|
9658
|
-
$case: "reference";
|
|
9659
|
-
reference: string;
|
|
9660
|
-
} | undefined;
|
|
9661
|
-
}
|
|
9662
|
-
|
|
9663
|
-
/**
|
|
9664
|
-
* @public
|
|
9665
|
-
*/
|
|
9666
|
-
export declare namespace ScrollPositionValue {
|
|
9667
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
9668
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
9669
|
-
}
|
|
9670
|
-
|
|
9671
|
-
/**
|
|
9672
|
-
* Which scrollbars are shown when the overflow is scrollable
|
|
9673
|
-
* @public
|
|
9674
|
-
*/
|
|
9675
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
9676
|
-
|
|
9677
9064
|
/**
|
|
9678
9065
|
* Register the composite provider used to resolve composite files. Also registers
|
|
9679
9066
|
* any `provider.schemas` on the engine pre-seal so composites that reference those
|
|
@@ -9699,16 +9086,6 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
|
|
|
9699
9086
|
easingFunction?: EasingFunction;
|
|
9700
9087
|
}
|
|
9701
9088
|
|
|
9702
|
-
/**
|
|
9703
|
-
* @public
|
|
9704
|
-
*/
|
|
9705
|
-
export declare const enum ShowScrollBar {
|
|
9706
|
-
SSB_BOTH = 0,
|
|
9707
|
-
SSB_ONLY_VERTICAL = 1,
|
|
9708
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
9709
|
-
SSB_HIDDEN = 3
|
|
9710
|
-
}
|
|
9711
|
-
|
|
9712
9089
|
/** @public */
|
|
9713
9090
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
9714
9091
|
|
|
@@ -9820,9 +9197,6 @@ export declare namespace Texture {
|
|
|
9820
9197
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
9821
9198
|
}
|
|
9822
9199
|
|
|
9823
|
-
/** @public */
|
|
9824
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
9825
|
-
|
|
9826
9200
|
/**
|
|
9827
9201
|
* @public
|
|
9828
9202
|
*/
|
|
@@ -9933,9 +9307,6 @@ export declare interface TextureUnion {
|
|
|
9933
9307
|
} | {
|
|
9934
9308
|
$case: "videoTexture";
|
|
9935
9309
|
videoTexture: VideoTexture;
|
|
9936
|
-
} | {
|
|
9937
|
-
$case: "uiTexture";
|
|
9938
|
-
uiTexture: UiCanvasTexture;
|
|
9939
9310
|
} | undefined;
|
|
9940
9311
|
}
|
|
9941
9312
|
|
|
@@ -10166,6 +9537,16 @@ export declare type Transport = {
|
|
|
10166
9537
|
onmessage?(message: Uint8Array): void;
|
|
10167
9538
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
10168
9539
|
type?: string;
|
|
9540
|
+
/**
|
|
9541
|
+
* Whether this transport is allowed to mutate reserved-range entities
|
|
9542
|
+
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
9543
|
+
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
9544
|
+
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
9545
|
+
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
9546
|
+
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
9547
|
+
* `receiveMessages`.
|
|
9548
|
+
*/
|
|
9549
|
+
allowReservedEntities?: boolean;
|
|
10169
9550
|
};
|
|
10170
9551
|
|
|
10171
9552
|
/**
|
|
@@ -10474,8 +9855,6 @@ export declare interface UiBackgroundProps {
|
|
|
10474
9855
|
uvs?: number[];
|
|
10475
9856
|
/** AvatarTexture for the background */
|
|
10476
9857
|
avatarTexture?: UiAvatarTexture;
|
|
10477
|
-
/** VideoTexture for the background: the frames of a VideoPlayer on another entity */
|
|
10478
|
-
videoTexture?: UiVideoTexture;
|
|
10479
9858
|
/** Texture for the background */
|
|
10480
9859
|
texture?: UiTexture;
|
|
10481
9860
|
}
|
|
@@ -10495,31 +9874,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
10495
9874
|
disabled?: boolean;
|
|
10496
9875
|
}
|
|
10497
9876
|
|
|
10498
|
-
/** @public */
|
|
10499
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
10500
|
-
|
|
10501
9877
|
/** @public */
|
|
10502
9878
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
10503
9879
|
|
|
10504
|
-
/**
|
|
10505
|
-
* @public
|
|
10506
|
-
*/
|
|
10507
|
-
export declare interface UiCanvasTexture {
|
|
10508
|
-
uiCanvasEntity: number;
|
|
10509
|
-
/** default = TextureWrapMode.Clamp */
|
|
10510
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
10511
|
-
/** default = FilterMode.Bilinear */
|
|
10512
|
-
filterMode?: TextureFilterMode | undefined;
|
|
10513
|
-
}
|
|
10514
|
-
|
|
10515
|
-
/**
|
|
10516
|
-
* @public
|
|
10517
|
-
*/
|
|
10518
|
-
export declare namespace UiCanvasTexture {
|
|
10519
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
10520
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
10521
|
-
}
|
|
10522
|
-
|
|
10523
9880
|
/**
|
|
10524
9881
|
* @public
|
|
10525
9882
|
*/
|
|
@@ -10617,8 +9974,6 @@ export declare interface UiLabelProps {
|
|
|
10617
9974
|
font?: UiFontType | undefined;
|
|
10618
9975
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
10619
9976
|
textWrap?: UiTextWrapType | undefined;
|
|
10620
|
-
/** A font file in the scene, or a Google Fonts family name; `font` is the fallback. @defaultValue undefined */
|
|
10621
|
-
fontSrc?: string | undefined;
|
|
10622
9977
|
}
|
|
10623
9978
|
|
|
10624
9979
|
/**
|
|
@@ -10639,6 +9994,17 @@ export declare type UiRendererOptions = {
|
|
|
10639
9994
|
* can use different insets simultaneously.
|
|
10640
9995
|
*/
|
|
10641
9996
|
screenInset?: UiScreenInset;
|
|
9997
|
+
/**
|
|
9998
|
+
* Stacking order of this renderer's UI relative to the other renderers (the main
|
|
9999
|
+
* one and every `addUiRenderer`). Higher values render in front. When omitted,
|
|
10000
|
+
* renderers stack in the order they first render, later ones on top; among those
|
|
10001
|
+
* first rendered in the same tick the main UI goes at the back.
|
|
10002
|
+
*
|
|
10003
|
+
* It is applied to the renderer's root container entity, so it only orders whole
|
|
10004
|
+
* renderers against each other; a renderer zIndex of 0 is interpreted as "unset"
|
|
10005
|
+
* (positional order); elements inside a renderer keep their own `zIndex`.
|
|
10006
|
+
*/
|
|
10007
|
+
zIndex?: number;
|
|
10642
10008
|
};
|
|
10643
10009
|
|
|
10644
10010
|
/**
|
|
@@ -10674,9 +10040,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
|
|
|
10674
10040
|
uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
|
|
10675
10041
|
};
|
|
10676
10042
|
|
|
10677
|
-
/** @public */
|
|
10678
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
10679
|
-
|
|
10680
10043
|
/** @public */
|
|
10681
10044
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
10682
10045
|
|
|
@@ -10756,22 +10119,6 @@ export declare interface UiTransformProps {
|
|
|
10756
10119
|
opacity?: number;
|
|
10757
10120
|
/** default 0 */
|
|
10758
10121
|
zIndex?: number;
|
|
10759
|
-
/** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
|
|
10760
|
-
elementId?: string;
|
|
10761
|
-
/** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
|
|
10762
|
-
scrollPosition?: PBVector2 | string;
|
|
10763
|
-
/** Which scrollbars to show when overflow is 'scroll'. default 'both' */
|
|
10764
|
-
scrollVisible?: ScrollVisibleType;
|
|
10765
|
-
}
|
|
10766
|
-
|
|
10767
|
-
/**
|
|
10768
|
-
* Video Texture
|
|
10769
|
-
* @public
|
|
10770
|
-
*/
|
|
10771
|
-
export declare interface UiVideoTexture {
|
|
10772
|
-
videoPlayerEntity: Entity;
|
|
10773
|
-
wrapMode?: TextureWrapType;
|
|
10774
|
-
filterMode?: TextureFilterType;
|
|
10775
10122
|
}
|
|
10776
10123
|
|
|
10777
10124
|
/**
|
|
@@ -10779,6 +10126,14 @@ export declare interface UiVideoTexture {
|
|
|
10779
10126
|
*/
|
|
10780
10127
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10781
10128
|
|
|
10129
|
+
export declare type ValidateCallback<T> = (value: {
|
|
10130
|
+
entity: Entity;
|
|
10131
|
+
currentValue: T | undefined;
|
|
10132
|
+
newValue: T | undefined;
|
|
10133
|
+
senderAddress: string;
|
|
10134
|
+
createdBy: string;
|
|
10135
|
+
}) => boolean;
|
|
10136
|
+
|
|
10782
10137
|
/**
|
|
10783
10138
|
* @public
|
|
10784
10139
|
*/
|