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