@dcl/playground-assets 7.29.1-35901015152.commit-d1b7b96 → 7.29.1-35917671376.commit-046b268
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 +119 -786
- package/dist/beta.d.ts +119 -786
- package/dist/index.bundled.d.ts +119 -786
- package/dist/index.js +7 -7
- package/dist/playground/sdk/apis.d.ts +13 -39
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +119 -786
- package/etc/playground-assets.api.json +4402 -11443
- package/etc/playground-assets.api.md +78 -507
- package/package.json +4 -4
package/dist/beta.d.ts
CHANGED
|
@@ -279,39 +279,6 @@ export declare const enum AvatarAnchorPointType {
|
|
|
279
279
|
AAPT_RIGHT_TOE_BASE = 25
|
|
280
280
|
}
|
|
281
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
|
-
|
|
315
282
|
/** @public */
|
|
316
283
|
export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBAvatarAttach>;
|
|
317
284
|
|
|
@@ -321,21 +288,8 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
321
288
|
/** @public */
|
|
322
289
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
323
290
|
|
|
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
|
-
};
|
|
291
|
+
/** @public */
|
|
292
|
+
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
339
293
|
|
|
340
294
|
/** @public */
|
|
341
295
|
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
@@ -364,30 +318,11 @@ export declare const enum AvatarModifierType {
|
|
|
364
318
|
AMT_HIDE_NAMETAGS = 2
|
|
365
319
|
}
|
|
366
320
|
|
|
367
|
-
/** @public */
|
|
368
|
-
export declare const AvatarMovement: LastWriteWinElementSetComponentDefinition<PBAvatarMovement>;
|
|
369
|
-
|
|
370
|
-
/** @public */
|
|
371
|
-
export declare const AvatarMovementInfo: LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>;
|
|
372
|
-
|
|
373
321
|
/** @public */
|
|
374
322
|
export declare const AvatarNametag: LastWriteWinElementSetComponentDefinition<PBAvatarNametag>;
|
|
375
323
|
|
|
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
|
-
};
|
|
324
|
+
/** @public */
|
|
325
|
+
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
|
391
326
|
|
|
392
327
|
/**
|
|
393
328
|
* @public
|
|
@@ -656,17 +591,10 @@ export declare interface ByteBuffer {
|
|
|
656
591
|
}
|
|
657
592
|
|
|
658
593
|
/**
|
|
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.
|
|
594
|
+
* Callback function to be triggered on a specified event
|
|
661
595
|
* @public
|
|
662
596
|
*/
|
|
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>;
|
|
597
|
+
export declare type Callback = () => void;
|
|
670
598
|
|
|
671
599
|
/** @public */
|
|
672
600
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
|
@@ -1519,23 +1447,17 @@ export declare const componentDefinitionByName: {
|
|
|
1519
1447
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1520
1448
|
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1521
1449
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1522
|
-
"core::AvatarMovement": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovement>>;
|
|
1523
|
-
"core::AvatarMovementInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>>;
|
|
1524
1450
|
"core::AvatarNametag": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarNametag>>;
|
|
1525
1451
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1526
1452
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
1527
|
-
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
|
1528
|
-
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
|
1529
1453
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
|
1530
1454
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
|
1531
1455
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
|
1456
|
+
"core::ExplorerItemPurchaseResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerItemPurchaseResult>>;
|
|
1532
1457
|
"core::ExplorerUiEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>>;
|
|
1533
|
-
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
|
1534
1458
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
|
1535
1459
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
|
1536
|
-
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
|
1537
1460
|
"core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
|
|
1538
|
-
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
|
1539
1461
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
|
1540
1462
|
"core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
|
|
1541
1463
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
|
@@ -1556,7 +1478,6 @@ export declare const componentDefinitionByName: {
|
|
|
1556
1478
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1557
1479
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1558
1480
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1559
|
-
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
|
1560
1481
|
"core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
|
|
1561
1482
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1562
1483
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
@@ -1564,14 +1485,12 @@ export declare const componentDefinitionByName: {
|
|
|
1564
1485
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
|
1565
1486
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
|
1566
1487
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
|
1567
|
-
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
|
1568
1488
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
|
1569
1489
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1570
1490
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1571
1491
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1572
1492
|
"core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
|
|
1573
1493
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1574
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
|
1575
1494
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1576
1495
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
1577
1496
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
|
@@ -2191,9 +2110,6 @@ export declare type EntityComponents = {
|
|
|
2191
2110
|
onMouseUp: Callback;
|
|
2192
2111
|
onMouseEnter: Callback;
|
|
2193
2112
|
onMouseLeave: Callback;
|
|
2194
|
-
onMouseDrag: Callback;
|
|
2195
|
-
onMouseDragLocked: Callback;
|
|
2196
|
-
onMouseDragEnd: Callback;
|
|
2197
2113
|
};
|
|
2198
2114
|
|
|
2199
2115
|
/** @public */
|
|
@@ -2291,8 +2207,11 @@ export declare type ExcludeUndefined<T> = {
|
|
|
2291
2207
|
*/
|
|
2292
2208
|
export declare const executeTask: (task: Task<unknown>) => void;
|
|
2293
2209
|
|
|
2210
|
+
/** @public */
|
|
2211
|
+
export declare const ExplorerItemPurchaseResult: GrowOnlyValueSetComponentDefinition<PBExplorerItemPurchaseResult>;
|
|
2212
|
+
|
|
2294
2213
|
/**
|
|
2295
|
-
* Identifies which
|
|
2214
|
+
* Identifies which explorer panel OpenExplorerUi targets. Panels are not all fullscreen.
|
|
2296
2215
|
* EU_SETTINGS holds 0 so an unset `ui` field defaults to the least-intrusive panel.
|
|
2297
2216
|
*/
|
|
2298
2217
|
/**
|
|
@@ -2305,7 +2224,9 @@ export declare const enum ExplorerUi {
|
|
|
2305
2224
|
EU_CAMERA_REEL = 3,
|
|
2306
2225
|
EU_COMMUNITIES = 4,
|
|
2307
2226
|
EU_PLACES = 5,
|
|
2308
|
-
EU_EVENTS = 6
|
|
2227
|
+
EU_EVENTS = 6,
|
|
2228
|
+
/** EU_ITEM_PURCHASE - the item-purchase confirmation modal; see OpenExplorerUi for its parameters and result component */
|
|
2229
|
+
EU_ITEM_PURCHASE = 7
|
|
2309
2230
|
}
|
|
2310
2231
|
|
|
2311
2232
|
/** @public */
|
|
@@ -2548,9 +2469,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
|
2548
2469
|
direction?: PBVector3;
|
|
2549
2470
|
};
|
|
2550
2471
|
|
|
2551
|
-
/** @public */
|
|
2552
|
-
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
|
2553
|
-
|
|
2554
2472
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
|
2555
2473
|
|
|
2556
2474
|
export declare type GlobalTargetRaycastSystemOptions = {
|
|
@@ -2563,24 +2481,9 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
|
2563
2481
|
/** @public */
|
|
2564
2482
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
|
2565
2483
|
|
|
2566
|
-
/** @public */
|
|
2567
|
-
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
|
2568
|
-
|
|
2569
2484
|
/** @public */
|
|
2570
2485
|
export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
|
|
2571
2486
|
|
|
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
2487
|
/**
|
|
2585
2488
|
* @public
|
|
2586
2489
|
*/
|
|
@@ -2858,6 +2761,10 @@ export declare interface IEvents {
|
|
|
2858
2761
|
sender: string;
|
|
2859
2762
|
message: string;
|
|
2860
2763
|
};
|
|
2764
|
+
/** Triggered when the player switches the client language. `locale` is a BCP-47 tag */
|
|
2765
|
+
localeChanged: {
|
|
2766
|
+
locale: string;
|
|
2767
|
+
};
|
|
2861
2768
|
/**
|
|
2862
2769
|
* This is triggered once the scene should start.
|
|
2863
2770
|
*/
|
|
@@ -3280,12 +3187,6 @@ export declare type Listeners = {
|
|
|
3280
3187
|
onMouseEnter?: Callback;
|
|
3281
3188
|
/** triggered on mouse leave event */
|
|
3282
3189
|
onMouseLeave?: Callback;
|
|
3283
|
-
/** triggered while the pointer is dragged after pressing on the element */
|
|
3284
|
-
onMouseDrag?: Callback;
|
|
3285
|
-
/** triggered while the pointer is dragged with the cursor locked in place */
|
|
3286
|
-
onMouseDragLocked?: Callback;
|
|
3287
|
-
/** triggered when a drag that started on the element ends */
|
|
3288
|
-
onMouseDragEnd?: Callback;
|
|
3289
3190
|
};
|
|
3290
3191
|
|
|
3291
3192
|
/**
|
|
@@ -4190,15 +4091,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4190
4091
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4191
4092
|
*/
|
|
4192
4093
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4193
|
-
/**
|
|
4194
|
-
* @public
|
|
4195
|
-
* Set a mesh from inside a gltf in the MeshCollider component
|
|
4196
|
-
* @param entity - entity to create or replace the MeshCollider component
|
|
4197
|
-
* @param source - the path to the gltf
|
|
4198
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4199
|
-
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4200
|
-
*/
|
|
4201
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4202
4094
|
}
|
|
4203
4095
|
|
|
4204
4096
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4235,14 +4127,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4235
4127
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4236
4128
|
*/
|
|
4237
4129
|
setSphere(entity: Entity): void;
|
|
4238
|
-
/**
|
|
4239
|
-
* @public
|
|
4240
|
-
* Set a mesh from inside a gltf in the MeshRenderer component
|
|
4241
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4242
|
-
* @param source - the path to the gltf
|
|
4243
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4244
|
-
*/
|
|
4245
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
4246
4130
|
}
|
|
4247
4131
|
|
|
4248
4132
|
/* Excluded from this release type: MessageBus */
|
|
@@ -4280,39 +4164,6 @@ export declare namespace MoveContinuous {
|
|
|
4280
4164
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4281
4165
|
}
|
|
4282
4166
|
|
|
4283
|
-
/**
|
|
4284
|
-
* Describes the animation the movement scene wants the avatar to play.
|
|
4285
|
-
* One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
|
|
4286
|
-
* When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
|
|
4287
|
-
*/
|
|
4288
|
-
/**
|
|
4289
|
-
* @public
|
|
4290
|
-
*/
|
|
4291
|
-
export declare interface MovementAnimation {
|
|
4292
|
-
/** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
|
|
4293
|
-
src: string;
|
|
4294
|
-
/** whether the clip repeats once it reaches the end */
|
|
4295
|
-
loop: boolean;
|
|
4296
|
-
/** playback speed multiplier (1.0 = clip's native rate) */
|
|
4297
|
-
speed: number;
|
|
4298
|
-
/** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
|
|
4299
|
-
idle: boolean;
|
|
4300
|
-
/** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
|
|
4301
|
-
transitionSeconds?: number | undefined;
|
|
4302
|
-
/** 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. */
|
|
4303
|
-
playbackTime?: number | undefined;
|
|
4304
|
-
/** 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). */
|
|
4305
|
-
sounds: string[];
|
|
4306
|
-
}
|
|
4307
|
-
|
|
4308
|
-
/**
|
|
4309
|
-
* @public
|
|
4310
|
-
*/
|
|
4311
|
-
export declare namespace MovementAnimation {
|
|
4312
|
-
export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
|
|
4313
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
|
|
4314
|
-
}
|
|
4315
|
-
|
|
4316
4167
|
/**
|
|
4317
4168
|
* @public
|
|
4318
4169
|
*/
|
|
@@ -4728,25 +4579,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4728
4579
|
totalVideoLength: number;
|
|
4729
4580
|
}>;
|
|
4730
4581
|
|
|
4731
|
-
/**
|
|
4732
|
-
* @public
|
|
4733
|
-
*/
|
|
4734
|
-
export declare interface Orthographic {
|
|
4735
|
-
/**
|
|
4736
|
-
* vertical extent of the visible range in meters
|
|
4737
|
-
* defaults to 4m
|
|
4738
|
-
*/
|
|
4739
|
-
verticalRange?: number | undefined;
|
|
4740
|
-
}
|
|
4741
|
-
|
|
4742
|
-
/**
|
|
4743
|
-
* @public
|
|
4744
|
-
*/
|
|
4745
|
-
export declare namespace Orthographic {
|
|
4746
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4747
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4748
|
-
}
|
|
4749
|
-
|
|
4750
4582
|
/**
|
|
4751
4583
|
* @public
|
|
4752
4584
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -5044,8 +4876,6 @@ export declare interface PBAvatarBase {
|
|
|
5044
4876
|
hairColor: PBColor3 | undefined;
|
|
5045
4877
|
bodyShapeUrn: string;
|
|
5046
4878
|
name: string;
|
|
5047
|
-
/** true while the player is speaking in voice chat; unset when the engine does not report voice activity */
|
|
5048
|
-
talking?: boolean | undefined;
|
|
5049
4879
|
}
|
|
5050
4880
|
|
|
5051
4881
|
/**
|
|
@@ -5096,8 +4926,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
5096
4926
|
export declare interface PBAvatarEquippedData {
|
|
5097
4927
|
wearableUrns: string[];
|
|
5098
4928
|
emoteUrns: string[];
|
|
5099
|
-
/** slots that will render even if hidden */
|
|
5100
|
-
forceRender: string[];
|
|
5101
4929
|
}
|
|
5102
4930
|
|
|
5103
4931
|
/**
|
|
@@ -5168,8 +4996,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
5168
4996
|
excludeIds: string[];
|
|
5169
4997
|
/** list of modifiers to apply */
|
|
5170
4998
|
modifiers: AvatarModifierType[];
|
|
5171
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5172
|
-
useColliderRange?: boolean | undefined;
|
|
5173
4999
|
}
|
|
5174
5000
|
|
|
5175
5001
|
/**
|
|
@@ -5180,64 +5006,6 @@ export declare namespace PBAvatarModifierArea {
|
|
|
5180
5006
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
|
|
5181
5007
|
}
|
|
5182
5008
|
|
|
5183
|
-
/**
|
|
5184
|
-
* @public
|
|
5185
|
-
*/
|
|
5186
|
-
export declare interface PBAvatarMovement {
|
|
5187
|
-
velocity: PBVector3 | undefined;
|
|
5188
|
-
/** 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. */
|
|
5189
|
-
orientation: number;
|
|
5190
|
-
groundDirection?: PBVector3 | undefined;
|
|
5191
|
-
/** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
|
|
5192
|
-
walkSuccess?: boolean | undefined;
|
|
5193
|
-
/** if set, the engine plays this animation instead of selecting one from velocity heuristics */
|
|
5194
|
-
animation?: MovementAnimation | undefined;
|
|
5195
|
-
/** 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. */
|
|
5196
|
-
tiltPitch?: number | undefined;
|
|
5197
|
-
/** 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. */
|
|
5198
|
-
tiltRoll?: number | undefined;
|
|
5199
|
-
}
|
|
5200
|
-
|
|
5201
|
-
/**
|
|
5202
|
-
* @public
|
|
5203
|
-
*/
|
|
5204
|
-
export declare namespace PBAvatarMovement {
|
|
5205
|
-
export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
|
|
5206
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
|
|
5207
|
-
}
|
|
5208
|
-
|
|
5209
|
-
/**
|
|
5210
|
-
* @public
|
|
5211
|
-
*/
|
|
5212
|
-
export declare interface PBAvatarMovementInfo {
|
|
5213
|
-
/** the length of time the current step velocity will apply for */
|
|
5214
|
-
stepTime: number;
|
|
5215
|
-
/** the length of time the previous step velocity applied for */
|
|
5216
|
-
previousStepTime: number;
|
|
5217
|
-
/** the velocity requested for the previous frame */
|
|
5218
|
-
requestedVelocity: PBVector3 | undefined;
|
|
5219
|
-
/** the resulting velocity taking collisions into account */
|
|
5220
|
-
actualVelocity: PBVector3 | undefined;
|
|
5221
|
-
/** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
|
|
5222
|
-
externalVelocity: PBVector3 | undefined;
|
|
5223
|
-
activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
|
|
5224
|
-
activeInputModifier: PBInputModifier | undefined;
|
|
5225
|
-
/** if set, the movement scene should walk the player to this scene-relative position */
|
|
5226
|
-
walkTarget?: PBVector3 | undefined;
|
|
5227
|
-
/** stop distance for walk_target; considered reached when within this distance */
|
|
5228
|
-
walkThreshold?: number | undefined;
|
|
5229
|
-
/** 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. */
|
|
5230
|
-
activeAnimationState?: AvatarAnimationState | undefined;
|
|
5231
|
-
}
|
|
5232
|
-
|
|
5233
|
-
/**
|
|
5234
|
-
* @public
|
|
5235
|
-
*/
|
|
5236
|
-
export declare namespace PBAvatarMovementInfo {
|
|
5237
|
-
export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
|
|
5238
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
|
|
5239
|
-
}
|
|
5240
|
-
|
|
5241
5009
|
/**
|
|
5242
5010
|
* The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
|
|
5243
5011
|
* for example to show a rank or a role that the scene assigns to that player.
|
|
@@ -5328,8 +5096,6 @@ export declare interface PBAvatarShape {
|
|
|
5328
5096
|
emotes: string[];
|
|
5329
5097
|
/** hides the skin + hair + facial features (default: false) */
|
|
5330
5098
|
showOnlyWearables?: boolean | undefined;
|
|
5331
|
-
/** slots that will render even if hidden */
|
|
5332
|
-
forceRender: string[];
|
|
5333
5099
|
}
|
|
5334
5100
|
|
|
5335
5101
|
/**
|
|
@@ -5371,51 +5137,6 @@ export declare namespace PBBillboard {
|
|
|
5371
5137
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
5372
5138
|
}
|
|
5373
5139
|
|
|
5374
|
-
/**
|
|
5375
|
-
* @public
|
|
5376
|
-
*/
|
|
5377
|
-
export declare interface PBCameraLayer {
|
|
5378
|
-
/**
|
|
5379
|
-
* layer to which these settings apply. must be > 0
|
|
5380
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
5381
|
-
*/
|
|
5382
|
-
layer: number;
|
|
5383
|
-
/** should the sun light affect this layer? default false */
|
|
5384
|
-
directionalLight?: boolean | undefined;
|
|
5385
|
-
/** should this layer show player avatars? default false */
|
|
5386
|
-
showAvatars?: boolean | undefined;
|
|
5387
|
-
/** should this layer show the sky? default false */
|
|
5388
|
-
showSkybox?: boolean | undefined;
|
|
5389
|
-
/** should this layer show distance fog? default false */
|
|
5390
|
-
showFog?: boolean | undefined;
|
|
5391
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
5392
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
5393
|
-
ambientBrightnessOverride?: number | undefined;
|
|
5394
|
-
}
|
|
5395
|
-
|
|
5396
|
-
/**
|
|
5397
|
-
* @public
|
|
5398
|
-
*/
|
|
5399
|
-
export declare namespace PBCameraLayer {
|
|
5400
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
5401
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
5402
|
-
}
|
|
5403
|
-
|
|
5404
|
-
/**
|
|
5405
|
-
* @public
|
|
5406
|
-
*/
|
|
5407
|
-
export declare interface PBCameraLayers {
|
|
5408
|
-
layers: number[];
|
|
5409
|
-
}
|
|
5410
|
-
|
|
5411
|
-
/**
|
|
5412
|
-
* @public
|
|
5413
|
-
*/
|
|
5414
|
-
export declare namespace PBCameraLayers {
|
|
5415
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5416
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5417
|
-
}
|
|
5418
|
-
|
|
5419
5140
|
/**
|
|
5420
5141
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5421
5142
|
* third-person view.
|
|
@@ -5457,8 +5178,6 @@ export declare interface PBCameraModeArea {
|
|
|
5457
5178
|
area: PBVector3 | undefined;
|
|
5458
5179
|
/** the camera mode to enforce */
|
|
5459
5180
|
mode: CameraType;
|
|
5460
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5461
|
-
useColliderRange?: boolean | undefined;
|
|
5462
5181
|
}
|
|
5463
5182
|
|
|
5464
5183
|
/**
|
|
@@ -5533,7 +5252,82 @@ export declare namespace PBEngineInfo {
|
|
|
5533
5252
|
}
|
|
5534
5253
|
|
|
5535
5254
|
/**
|
|
5536
|
-
*
|
|
5255
|
+
* Grow-only value set appended to the scene root entity.
|
|
5256
|
+
* Reports the outcome of an EU_ITEM_PURCHASE flow triggered via OpenExplorerUi.
|
|
5257
|
+
*/
|
|
5258
|
+
/**
|
|
5259
|
+
* @public
|
|
5260
|
+
*/
|
|
5261
|
+
export declare interface PBExplorerItemPurchaseResult {
|
|
5262
|
+
urn: string;
|
|
5263
|
+
/** The scene tick when the event occurred */
|
|
5264
|
+
timestamp: number;
|
|
5265
|
+
/** The OpenExplorerUiRequest.request_id that caused this event; 0 when the request carried none */
|
|
5266
|
+
requestId: number;
|
|
5267
|
+
status?: {
|
|
5268
|
+
$case: "purchased";
|
|
5269
|
+
purchased: PBExplorerItemPurchaseResult_Purchased;
|
|
5270
|
+
} | {
|
|
5271
|
+
$case: "dismissed";
|
|
5272
|
+
dismissed: PBExplorerItemPurchaseResult_Dismissed;
|
|
5273
|
+
} | {
|
|
5274
|
+
$case: "failed";
|
|
5275
|
+
failed: PBExplorerItemPurchaseResult_Failed;
|
|
5276
|
+
} | undefined;
|
|
5277
|
+
}
|
|
5278
|
+
|
|
5279
|
+
/**
|
|
5280
|
+
* @public
|
|
5281
|
+
*/
|
|
5282
|
+
export declare namespace PBExplorerItemPurchaseResult {
|
|
5283
|
+
export function encode(message: PBExplorerItemPurchaseResult, writer?: _m0.Writer): _m0.Writer;
|
|
5284
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult;
|
|
5285
|
+
}
|
|
5286
|
+
|
|
5287
|
+
/**
|
|
5288
|
+
* @public
|
|
5289
|
+
*/
|
|
5290
|
+
export declare interface PBExplorerItemPurchaseResult_Dismissed {
|
|
5291
|
+
}
|
|
5292
|
+
|
|
5293
|
+
/**
|
|
5294
|
+
* @public
|
|
5295
|
+
*/
|
|
5296
|
+
export declare namespace PBExplorerItemPurchaseResult_Dismissed {
|
|
5297
|
+
export function encode(_: PBExplorerItemPurchaseResult_Dismissed, writer?: _m0.Writer): _m0.Writer;
|
|
5298
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult_Dismissed;
|
|
5299
|
+
}
|
|
5300
|
+
|
|
5301
|
+
/**
|
|
5302
|
+
* @public
|
|
5303
|
+
*/
|
|
5304
|
+
export declare interface PBExplorerItemPurchaseResult_Failed {
|
|
5305
|
+
}
|
|
5306
|
+
|
|
5307
|
+
/**
|
|
5308
|
+
* @public
|
|
5309
|
+
*/
|
|
5310
|
+
export declare namespace PBExplorerItemPurchaseResult_Failed {
|
|
5311
|
+
export function encode(_: PBExplorerItemPurchaseResult_Failed, writer?: _m0.Writer): _m0.Writer;
|
|
5312
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult_Failed;
|
|
5313
|
+
}
|
|
5314
|
+
|
|
5315
|
+
/**
|
|
5316
|
+
* @public
|
|
5317
|
+
*/
|
|
5318
|
+
export declare interface PBExplorerItemPurchaseResult_Purchased {
|
|
5319
|
+
}
|
|
5320
|
+
|
|
5321
|
+
/**
|
|
5322
|
+
* @public
|
|
5323
|
+
*/
|
|
5324
|
+
export declare namespace PBExplorerItemPurchaseResult_Purchased {
|
|
5325
|
+
export function encode(_: PBExplorerItemPurchaseResult_Purchased, writer?: _m0.Writer): _m0.Writer;
|
|
5326
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult_Purchased;
|
|
5327
|
+
}
|
|
5328
|
+
|
|
5329
|
+
/**
|
|
5330
|
+
* PBExplorerUiEventsResult transports the lifecycle events of explorer UI panels — a panel was
|
|
5537
5331
|
* opened, a panel was closed. It is a grow only value set appended to the scene root entity, so every
|
|
5538
5332
|
* event of a tick is delivered and none overwrites another.
|
|
5539
5333
|
*/
|
|
@@ -5545,6 +5339,8 @@ export declare interface PBExplorerUiEventsResult {
|
|
|
5545
5339
|
ui: ExplorerUi;
|
|
5546
5340
|
/** The scene tick when the event occurred */
|
|
5547
5341
|
timestamp: number;
|
|
5342
|
+
/** The OpenExplorerUiRequest.request_id that caused this event; 0 when the request carried none */
|
|
5343
|
+
requestId: number;
|
|
5548
5344
|
event?: {
|
|
5549
5345
|
$case: "opened";
|
|
5550
5346
|
opened: PBExplorerUiEventsResult_UiOpened;
|
|
@@ -5562,7 +5358,7 @@ export declare namespace PBExplorerUiEventsResult {
|
|
|
5562
5358
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult;
|
|
5563
5359
|
}
|
|
5564
5360
|
|
|
5565
|
-
/** Emitted when
|
|
5361
|
+
/** Emitted when an explorer panel is closed. */
|
|
5566
5362
|
/**
|
|
5567
5363
|
* @public
|
|
5568
5364
|
*/
|
|
@@ -5577,7 +5373,10 @@ export declare namespace PBExplorerUiEventsResult_UiClosed {
|
|
|
5577
5373
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiClosed;
|
|
5578
5374
|
}
|
|
5579
5375
|
|
|
5580
|
-
/**
|
|
5376
|
+
/**
|
|
5377
|
+
* Emitted when an explorer panel is opened. The OpenExplorerUi response carries the same fact,
|
|
5378
|
+
* but it reaches only the caller; this channel is scene wide.
|
|
5379
|
+
*/
|
|
5581
5380
|
/**
|
|
5582
5381
|
* @public
|
|
5583
5382
|
*/
|
|
@@ -5592,39 +5391,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
|
|
|
5592
5391
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
|
|
5593
5392
|
}
|
|
5594
5393
|
|
|
5595
|
-
/**
|
|
5596
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5597
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5598
|
-
*/
|
|
5599
|
-
/**
|
|
5600
|
-
* @public
|
|
5601
|
-
*/
|
|
5602
|
-
export declare interface PBGlobalLight {
|
|
5603
|
-
/**
|
|
5604
|
-
* the direction the directional light shines in.
|
|
5605
|
-
* default depends on time of day and explorer implementation
|
|
5606
|
-
*/
|
|
5607
|
-
direction?: PBVector3 | undefined;
|
|
5608
|
-
/**
|
|
5609
|
-
* ambient light color
|
|
5610
|
-
* default: White
|
|
5611
|
-
*/
|
|
5612
|
-
ambientColor?: PBColor3 | undefined;
|
|
5613
|
-
/**
|
|
5614
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5615
|
-
* default 1
|
|
5616
|
-
*/
|
|
5617
|
-
ambientBrightness?: number | undefined;
|
|
5618
|
-
}
|
|
5619
|
-
|
|
5620
|
-
/**
|
|
5621
|
-
* @public
|
|
5622
|
-
*/
|
|
5623
|
-
export declare namespace PBGlobalLight {
|
|
5624
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5625
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5626
|
-
}
|
|
5627
|
-
|
|
5628
5394
|
/**
|
|
5629
5395
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5630
5396
|
*
|
|
@@ -5660,25 +5426,6 @@ export declare namespace PBGltfContainer {
|
|
|
5660
5426
|
*/
|
|
5661
5427
|
export declare interface PBGltfContainerLoadingState {
|
|
5662
5428
|
currentState: LoadingState;
|
|
5663
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5664
|
-
nodePaths: string[];
|
|
5665
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5666
|
-
meshNames: string[];
|
|
5667
|
-
/**
|
|
5668
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5669
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5670
|
-
*/
|
|
5671
|
-
materialNames: string[];
|
|
5672
|
-
/**
|
|
5673
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5674
|
-
* sure all your materials are explicitly named.
|
|
5675
|
-
*/
|
|
5676
|
-
skinNames: string[];
|
|
5677
|
-
/**
|
|
5678
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5679
|
-
* your skins are explicitly named.
|
|
5680
|
-
*/
|
|
5681
|
-
animationNames: string[];
|
|
5682
5429
|
}
|
|
5683
5430
|
|
|
5684
5431
|
/**
|
|
@@ -5689,57 +5436,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5689
5436
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5690
5437
|
}
|
|
5691
5438
|
|
|
5692
|
-
/**
|
|
5693
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5694
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5695
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5696
|
-
* in the parent.
|
|
5697
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5698
|
-
*
|
|
5699
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5700
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5701
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5702
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5703
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5704
|
-
*
|
|
5705
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5706
|
-
*
|
|
5707
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5708
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5709
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5710
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5711
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5712
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5713
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5714
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5715
|
-
* 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
|
|
5716
|
-
* PBMaterial will be maintained.
|
|
5717
|
-
*
|
|
5718
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5719
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5720
|
-
* change the state to `GNS_FAILED`.
|
|
5721
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5722
|
-
*
|
|
5723
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5724
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5725
|
-
* the gltf node will also be displayed.
|
|
5726
|
-
*/
|
|
5727
|
-
/**
|
|
5728
|
-
* @public
|
|
5729
|
-
*/
|
|
5730
|
-
export declare interface PBGltfNode {
|
|
5731
|
-
/** the path of the target node in the Gltf. */
|
|
5732
|
-
path: string;
|
|
5733
|
-
}
|
|
5734
|
-
|
|
5735
|
-
/**
|
|
5736
|
-
* @public
|
|
5737
|
-
*/
|
|
5738
|
-
export declare namespace PBGltfNode {
|
|
5739
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5740
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5741
|
-
}
|
|
5742
|
-
|
|
5743
5439
|
/**
|
|
5744
5440
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5745
5441
|
*
|
|
@@ -5785,26 +5481,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5785
5481
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5786
5482
|
}
|
|
5787
5483
|
|
|
5788
|
-
/**
|
|
5789
|
-
* The state of a linked gltf node.
|
|
5790
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5791
|
-
*/
|
|
5792
|
-
/**
|
|
5793
|
-
* @public
|
|
5794
|
-
*/
|
|
5795
|
-
export declare interface PBGltfNodeState {
|
|
5796
|
-
state: GltfNodeStateValue;
|
|
5797
|
-
error?: string | undefined;
|
|
5798
|
-
}
|
|
5799
|
-
|
|
5800
|
-
/**
|
|
5801
|
-
* @public
|
|
5802
|
-
*/
|
|
5803
|
-
export declare namespace PBGltfNodeState {
|
|
5804
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5805
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5806
|
-
}
|
|
5807
|
-
|
|
5808
5484
|
/**
|
|
5809
5485
|
* @public
|
|
5810
5486
|
*/
|
|
@@ -5942,14 +5618,6 @@ export declare interface PBMaterial {
|
|
|
5942
5618
|
$case: "pbr";
|
|
5943
5619
|
pbr: PBMaterial_PbrMaterial;
|
|
5944
5620
|
} | undefined;
|
|
5945
|
-
/**
|
|
5946
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
5947
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
5948
|
-
* supported by the PbMaterial.
|
|
5949
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
5950
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
5951
|
-
*/
|
|
5952
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
5953
5621
|
}
|
|
5954
5622
|
|
|
5955
5623
|
/**
|
|
@@ -5960,22 +5628,6 @@ export declare namespace PBMaterial {
|
|
|
5960
5628
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
5961
5629
|
}
|
|
5962
5630
|
|
|
5963
|
-
/**
|
|
5964
|
-
* @public
|
|
5965
|
-
*/
|
|
5966
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
5967
|
-
gltfSrc: string;
|
|
5968
|
-
name: string;
|
|
5969
|
-
}
|
|
5970
|
-
|
|
5971
|
-
/**
|
|
5972
|
-
* @public
|
|
5973
|
-
*/
|
|
5974
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
5975
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
5976
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
5977
|
-
}
|
|
5978
|
-
|
|
5979
5631
|
/**
|
|
5980
5632
|
* @public
|
|
5981
5633
|
*/
|
|
@@ -6072,9 +5724,6 @@ export declare interface PBMeshCollider {
|
|
|
6072
5724
|
} | {
|
|
6073
5725
|
$case: "plane";
|
|
6074
5726
|
plane: PBMeshCollider_PlaneMesh;
|
|
6075
|
-
} | {
|
|
6076
|
-
$case: "gltf";
|
|
6077
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
6078
5727
|
} | undefined;
|
|
6079
5728
|
}
|
|
6080
5729
|
|
|
@@ -6120,25 +5769,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
6120
5769
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
6121
5770
|
}
|
|
6122
5771
|
|
|
6123
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
6124
|
-
/**
|
|
6125
|
-
* @public
|
|
6126
|
-
*/
|
|
6127
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
6128
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6129
|
-
gltfSrc: string;
|
|
6130
|
-
/** the name of the mesh asset */
|
|
6131
|
-
name: string;
|
|
6132
|
-
}
|
|
6133
|
-
|
|
6134
|
-
/**
|
|
6135
|
-
* @public
|
|
6136
|
-
*/
|
|
6137
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
6138
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6139
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
6140
|
-
}
|
|
6141
|
-
|
|
6142
5772
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
6143
5773
|
/**
|
|
6144
5774
|
* @public
|
|
@@ -6171,11 +5801,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
6171
5801
|
|
|
6172
5802
|
/**
|
|
6173
5803
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
6174
|
-
* plane, a sphere
|
|
5804
|
+
* plane, a sphere or a cylinder.
|
|
6175
5805
|
*
|
|
6176
5806
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
6177
5807
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
6178
5808
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5809
|
+
*
|
|
5810
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
|
6179
5811
|
*/
|
|
6180
5812
|
/**
|
|
6181
5813
|
* @public
|
|
@@ -6193,9 +5825,6 @@ export declare interface PBMeshRenderer {
|
|
|
6193
5825
|
} | {
|
|
6194
5826
|
$case: "plane";
|
|
6195
5827
|
plane: PBMeshRenderer_PlaneMesh;
|
|
6196
|
-
} | {
|
|
6197
|
-
$case: "gltf";
|
|
6198
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
6199
5828
|
} | undefined;
|
|
6200
5829
|
}
|
|
6201
5830
|
|
|
@@ -6243,25 +5872,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
6243
5872
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
6244
5873
|
}
|
|
6245
5874
|
|
|
6246
|
-
/** A mesh from a Gltf. */
|
|
6247
|
-
/**
|
|
6248
|
-
* @public
|
|
6249
|
-
*/
|
|
6250
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
6251
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6252
|
-
gltfSrc: string;
|
|
6253
|
-
/** the name of the mesh asset */
|
|
6254
|
-
name: string;
|
|
6255
|
-
}
|
|
6256
|
-
|
|
6257
|
-
/**
|
|
6258
|
-
* @public
|
|
6259
|
-
*/
|
|
6260
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
6261
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6262
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
6263
|
-
}
|
|
6264
|
-
|
|
6265
5875
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
6266
5876
|
/**
|
|
6267
5877
|
* @public
|
|
@@ -6858,10 +6468,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
6858
6468
|
screenCoordinates?: PBVector2 | undefined;
|
|
6859
6469
|
/** Movement since last frame (pixels) */
|
|
6860
6470
|
screenDelta?: PBVector2 | undefined;
|
|
6861
|
-
/**
|
|
6862
|
-
* ray direction that can be used with the primary camera origin for
|
|
6863
|
-
* raycasting from the cursor into the world
|
|
6864
|
-
*/
|
|
6471
|
+
/** Direction vector for 3D ray casting */
|
|
6865
6472
|
worldRayDirection?: PBVector3 | undefined;
|
|
6866
6473
|
}
|
|
6867
6474
|
|
|
@@ -6932,10 +6539,6 @@ export declare interface PBRaycast {
|
|
|
6932
6539
|
continuous?: boolean | undefined;
|
|
6933
6540
|
/** Collision mask, by default CL_POINTER | CL_PHYSICS */
|
|
6934
6541
|
collisionMask?: number | undefined;
|
|
6935
|
-
/** shape to cast, default ray */
|
|
6936
|
-
shape?: RaycastShape | undefined;
|
|
6937
|
-
/** include hits with entities from other scenes */
|
|
6938
|
-
includeWorld?: boolean | undefined;
|
|
6939
6542
|
}
|
|
6940
6543
|
|
|
6941
6544
|
/**
|
|
@@ -7081,8 +6684,6 @@ export declare interface PBTextShape {
|
|
|
7081
6684
|
outlineColor?: PBColor3 | undefined;
|
|
7082
6685
|
/** text color (default [1.0, 1.0, 1.0]) */
|
|
7083
6686
|
textColor?: PBColor4 | undefined;
|
|
7084
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7085
|
-
fontSrc?: string | undefined;
|
|
7086
6687
|
}
|
|
7087
6688
|
|
|
7088
6689
|
/**
|
|
@@ -7093,46 +6694,6 @@ export declare namespace PBTextShape {
|
|
|
7093
6694
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
7094
6695
|
}
|
|
7095
6696
|
|
|
7096
|
-
/**
|
|
7097
|
-
* @public
|
|
7098
|
-
*/
|
|
7099
|
-
export declare interface PBTextureCamera {
|
|
7100
|
-
/** rendered texture width */
|
|
7101
|
-
width?: number | undefined;
|
|
7102
|
-
/** rendered texture height */
|
|
7103
|
-
height?: number | undefined;
|
|
7104
|
-
/**
|
|
7105
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
7106
|
-
* defaults to 0
|
|
7107
|
-
*/
|
|
7108
|
-
layer?: number | undefined;
|
|
7109
|
-
/** default black */
|
|
7110
|
-
clearColor?: PBColor4 | undefined;
|
|
7111
|
-
/** default infinity */
|
|
7112
|
-
farPlane?: number | undefined;
|
|
7113
|
-
mode?: {
|
|
7114
|
-
$case: "perspective";
|
|
7115
|
-
perspective: Perspective;
|
|
7116
|
-
} | {
|
|
7117
|
-
$case: "orthographic";
|
|
7118
|
-
orthographic: Orthographic;
|
|
7119
|
-
} | undefined;
|
|
7120
|
-
/**
|
|
7121
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
7122
|
-
* range: 0 (off) - 1 (full volume)
|
|
7123
|
-
* default: 0
|
|
7124
|
-
*/
|
|
7125
|
-
volume?: number | undefined;
|
|
7126
|
-
}
|
|
7127
|
-
|
|
7128
|
-
/**
|
|
7129
|
-
* @public
|
|
7130
|
-
*/
|
|
7131
|
-
export declare namespace PBTextureCamera {
|
|
7132
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
7133
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
7134
|
-
}
|
|
7135
|
-
|
|
7136
6697
|
/**
|
|
7137
6698
|
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
7138
6699
|
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
@@ -7378,25 +6939,6 @@ export declare namespace PBUiBackground {
|
|
|
7378
6939
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
7379
6940
|
}
|
|
7380
6941
|
|
|
7381
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
7382
|
-
/**
|
|
7383
|
-
* @public
|
|
7384
|
-
*/
|
|
7385
|
-
export declare interface PBUiCanvas {
|
|
7386
|
-
width: number;
|
|
7387
|
-
height: number;
|
|
7388
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
7389
|
-
color?: PBColor4 | undefined;
|
|
7390
|
-
}
|
|
7391
|
-
|
|
7392
|
-
/**
|
|
7393
|
-
* @public
|
|
7394
|
-
*/
|
|
7395
|
-
export declare namespace PBUiCanvas {
|
|
7396
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
7397
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
7398
|
-
}
|
|
7399
|
-
|
|
7400
6942
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
7401
6943
|
/**
|
|
7402
6944
|
* @public
|
|
@@ -7452,8 +6994,6 @@ export declare interface PBUiDropdown {
|
|
|
7452
6994
|
font?: Font | undefined;
|
|
7453
6995
|
/** default=10 */
|
|
7454
6996
|
fontSize?: number | undefined;
|
|
7455
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7456
|
-
fontSrc?: string | undefined;
|
|
7457
6997
|
}
|
|
7458
6998
|
|
|
7459
6999
|
/**
|
|
@@ -7496,12 +7036,6 @@ export declare interface PBUiInput {
|
|
|
7496
7036
|
/** default=10 */
|
|
7497
7037
|
fontSize?: number | undefined;
|
|
7498
7038
|
value?: string | undefined;
|
|
7499
|
-
/** default=false; when true, the input accepts newlines and behaves as a textarea */
|
|
7500
|
-
multiLine?: boolean | undefined;
|
|
7501
|
-
/** default=true; when false, the input value is preserved after pressing Enter */
|
|
7502
|
-
clearOnSubmit?: boolean | undefined;
|
|
7503
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7504
|
-
fontSrc?: string | undefined;
|
|
7505
7039
|
}
|
|
7506
7040
|
|
|
7507
7041
|
/**
|
|
@@ -7565,21 +7099,6 @@ export declare namespace PBUiInputResult {
|
|
|
7565
7099
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
7566
7100
|
}
|
|
7567
7101
|
|
|
7568
|
-
/**
|
|
7569
|
-
* @public
|
|
7570
|
-
*/
|
|
7571
|
-
export declare interface PBUiScrollResult {
|
|
7572
|
-
value: PBVector2 | undefined;
|
|
7573
|
-
}
|
|
7574
|
-
|
|
7575
|
-
/**
|
|
7576
|
-
* @public
|
|
7577
|
-
*/
|
|
7578
|
-
export declare namespace PBUiScrollResult {
|
|
7579
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
7580
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
7581
|
-
}
|
|
7582
|
-
|
|
7583
7102
|
/**
|
|
7584
7103
|
* @public
|
|
7585
7104
|
*/
|
|
@@ -7596,8 +7115,6 @@ export declare interface PBUiText {
|
|
|
7596
7115
|
fontSize?: number | undefined;
|
|
7597
7116
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
|
7598
7117
|
textWrap?: TextWrap | undefined;
|
|
7599
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7600
|
-
fontSrc?: string | undefined;
|
|
7601
7118
|
}
|
|
7602
7119
|
|
|
7603
7120
|
/**
|
|
@@ -7725,12 +7242,6 @@ export declare interface PBUiTransform {
|
|
|
7725
7242
|
borderRightColor?: PBColor4 | undefined;
|
|
7726
7243
|
/** default: 1 */
|
|
7727
7244
|
opacity?: number | undefined;
|
|
7728
|
-
/** reference for scroll_position. default empty */
|
|
7729
|
-
elementId?: string | undefined;
|
|
7730
|
-
/** default position=(0,0) */
|
|
7731
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
7732
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
7733
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
7734
7245
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
7735
7246
|
zIndex?: number | undefined;
|
|
7736
7247
|
}
|
|
@@ -7883,25 +7394,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
7883
7394
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
7884
7395
|
}
|
|
7885
7396
|
|
|
7886
|
-
/**
|
|
7887
|
-
* @public
|
|
7888
|
-
*/
|
|
7889
|
-
export declare interface Perspective {
|
|
7890
|
-
/**
|
|
7891
|
-
* vertical field of view in radians
|
|
7892
|
-
* defaults to pi/4 = 45 degrees
|
|
7893
|
-
*/
|
|
7894
|
-
fieldOfView?: number | undefined;
|
|
7895
|
-
}
|
|
7896
|
-
|
|
7897
|
-
/**
|
|
7898
|
-
* @public
|
|
7899
|
-
*/
|
|
7900
|
-
export declare namespace Perspective {
|
|
7901
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
7902
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
7903
|
-
}
|
|
7904
|
-
|
|
7905
7397
|
/**
|
|
7906
7398
|
* @public
|
|
7907
7399
|
* Physics helpers for applying impulses and forces to the player.
|
|
@@ -8143,24 +7635,6 @@ export declare interface PointerEventsSystem {
|
|
|
8143
7635
|
* @param entity - Entity where the callback was attached
|
|
8144
7636
|
*/
|
|
8145
7637
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
8146
|
-
/**
|
|
8147
|
-
* @public
|
|
8148
|
-
* Remove the callback for onPointerDrag event
|
|
8149
|
-
* @param entity - Entity where the callback was attached
|
|
8150
|
-
*/
|
|
8151
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
8152
|
-
/**
|
|
8153
|
-
* @public
|
|
8154
|
-
* Remove the callback for onPointerDragLocked event
|
|
8155
|
-
* @param entity - Entity where the callback was attached
|
|
8156
|
-
*/
|
|
8157
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
8158
|
-
/**
|
|
8159
|
-
* @public
|
|
8160
|
-
* Remove the callback for onPointerDragEnd event
|
|
8161
|
-
* @param entity - Entity where the callback was attached
|
|
8162
|
-
*/
|
|
8163
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
8164
7638
|
/**
|
|
8165
7639
|
* @public
|
|
8166
7640
|
* Remove the callback for onProximityDown event
|
|
@@ -8239,36 +7713,6 @@ export declare interface PointerEventsSystem {
|
|
|
8239
7713
|
entity: Entity;
|
|
8240
7714
|
opts?: Partial<EventSystemOptions>;
|
|
8241
7715
|
}, cb: EventSystemCallback): void;
|
|
8242
|
-
/**
|
|
8243
|
-
* @public
|
|
8244
|
-
* Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
|
|
8245
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8246
|
-
* @param cb - Function to execute on every drag update
|
|
8247
|
-
*/
|
|
8248
|
-
onPointerDrag(pointerData: {
|
|
8249
|
-
entity: Entity;
|
|
8250
|
-
opts?: Partial<EventSystemOptions>;
|
|
8251
|
-
}, cb: EventSystemCallback): void;
|
|
8252
|
-
/**
|
|
8253
|
-
* @public
|
|
8254
|
-
* Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
|
|
8255
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8256
|
-
* @param cb - Function to execute on every drag update
|
|
8257
|
-
*/
|
|
8258
|
-
onPointerDragLocked(pointerData: {
|
|
8259
|
-
entity: Entity;
|
|
8260
|
-
opts?: Partial<EventSystemOptions>;
|
|
8261
|
-
}, cb: EventSystemCallback): void;
|
|
8262
|
-
/**
|
|
8263
|
-
* @public
|
|
8264
|
-
* Execute callback when the user releases the button after a drag that started on the entity
|
|
8265
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8266
|
-
* @param cb - Function to execute when the drag ends
|
|
8267
|
-
*/
|
|
8268
|
-
onPointerDragEnd(pointerData: {
|
|
8269
|
-
entity: Entity;
|
|
8270
|
-
opts?: Partial<EventSystemOptions>;
|
|
8271
|
-
}, cb: EventSystemCallback): void;
|
|
8272
7716
|
/**
|
|
8273
7717
|
* @public
|
|
8274
7718
|
* Execute callback when the user presses the proximity button on the entity
|
|
@@ -8327,10 +7771,7 @@ export declare const enum PointerEventType {
|
|
|
8327
7771
|
PET_HOVER_ENTER = 2,
|
|
8328
7772
|
PET_HOVER_LEAVE = 3,
|
|
8329
7773
|
PET_PROXIMITY_ENTER = 4,
|
|
8330
|
-
PET_PROXIMITY_LEAVE = 5
|
|
8331
|
-
PET_DRAG_LOCKED = 6,
|
|
8332
|
-
PET_DRAG = 7,
|
|
8333
|
-
PET_DRAG_END = 8
|
|
7774
|
+
PET_PROXIMITY_LEAVE = 5
|
|
8334
7775
|
}
|
|
8335
7776
|
|
|
8336
7777
|
/**
|
|
@@ -8361,10 +7802,7 @@ export declare const enum PointerType {
|
|
|
8361
7802
|
/** POT_NONE - No pointer input */
|
|
8362
7803
|
POT_NONE = 0,
|
|
8363
7804
|
/** POT_MOUSE - Traditional mouse input */
|
|
8364
|
-
POT_MOUSE = 1
|
|
8365
|
-
POT_PAD = 2,
|
|
8366
|
-
POT_TOUCH = 3,
|
|
8367
|
-
POT_WAND = 4
|
|
7805
|
+
POT_MOUSE = 1
|
|
8368
7806
|
}
|
|
8369
7807
|
|
|
8370
7808
|
/**
|
|
@@ -8821,16 +8259,6 @@ export declare const enum RaycastQueryType {
|
|
|
8821
8259
|
/** @public */
|
|
8822
8260
|
export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
|
|
8823
8261
|
|
|
8824
|
-
/**
|
|
8825
|
-
* @public
|
|
8826
|
-
*/
|
|
8827
|
-
export declare const enum RaycastShape {
|
|
8828
|
-
/** RS_RAY - cast a point, get collisions along a ray */
|
|
8829
|
-
RS_RAY = 0,
|
|
8830
|
-
/** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
|
|
8831
|
-
RS_AVATAR = 1
|
|
8832
|
-
}
|
|
8833
|
-
|
|
8834
8262
|
/**
|
|
8835
8263
|
* @public
|
|
8836
8264
|
*/
|
|
@@ -8963,10 +8391,6 @@ export declare type RaycastSystemOptions = {
|
|
|
8963
8391
|
queryType: RaycastQueryType;
|
|
8964
8392
|
continuous?: boolean | undefined;
|
|
8965
8393
|
collisionMask?: number | undefined;
|
|
8966
|
-
/** shape to sweep along the ray, default RS_RAY (a point) */
|
|
8967
|
-
shape?: RaycastShape | undefined;
|
|
8968
|
-
/** include colliders from other scenes, default false */
|
|
8969
|
-
includeWorld?: boolean | undefined;
|
|
8970
8394
|
};
|
|
8971
8395
|
|
|
8972
8396
|
/**
|
|
@@ -9015,20 +8439,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
9015
8439
|
* @param entity - The entity whose UI renderer should be removed
|
|
9016
8440
|
*/
|
|
9017
8441
|
removeUiRenderer(entity: Entity): void;
|
|
9018
|
-
/**
|
|
9019
|
-
* Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
|
|
9020
|
-
* describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
|
|
9021
|
-
* any texture renderer already set on the entity, and is torn down when the entity is removed.
|
|
9022
|
-
*
|
|
9023
|
-
* @param entity - The UiCanvas entity the UI tree hangs from
|
|
9024
|
-
* @param ui - The UI component to render
|
|
9025
|
-
*/
|
|
9026
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
9027
|
-
/**
|
|
9028
|
-
* Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
|
|
9029
|
-
* @param entity - The UiCanvas entity the renderer was set on
|
|
9030
|
-
*/
|
|
9031
|
-
removeTextureRenderer(entity: Entity): void;
|
|
9032
8442
|
}
|
|
9033
8443
|
|
|
9034
8444
|
/**
|
|
@@ -9192,7 +8602,7 @@ export declare type ReadOnlyLastWriteWinElementSetComponentDefinition<T> = Omit<
|
|
|
9192
8602
|
/**
|
|
9193
8603
|
* @public
|
|
9194
8604
|
*/
|
|
9195
|
-
export declare type ReadonlyPrimitive = number | string |
|
|
8605
|
+
export declare type ReadonlyPrimitive = number | string | boolean;
|
|
9196
8606
|
|
|
9197
8607
|
/** @public */
|
|
9198
8608
|
export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;
|
|
@@ -9619,33 +9029,6 @@ export declare namespace Schemas {
|
|
|
9619
9029
|
*/
|
|
9620
9030
|
export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
|
|
9621
9031
|
|
|
9622
|
-
/**
|
|
9623
|
-
* @public
|
|
9624
|
-
*/
|
|
9625
|
-
export declare interface ScrollPositionValue {
|
|
9626
|
-
value?: {
|
|
9627
|
-
$case: "position";
|
|
9628
|
-
position: PBVector2;
|
|
9629
|
-
} | {
|
|
9630
|
-
$case: "reference";
|
|
9631
|
-
reference: string;
|
|
9632
|
-
} | undefined;
|
|
9633
|
-
}
|
|
9634
|
-
|
|
9635
|
-
/**
|
|
9636
|
-
* @public
|
|
9637
|
-
*/
|
|
9638
|
-
export declare namespace ScrollPositionValue {
|
|
9639
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
9640
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
9641
|
-
}
|
|
9642
|
-
|
|
9643
|
-
/**
|
|
9644
|
-
* Which scrollbars are shown when the overflow is scrollable
|
|
9645
|
-
* @public
|
|
9646
|
-
*/
|
|
9647
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
9648
|
-
|
|
9649
9032
|
/**
|
|
9650
9033
|
* Register the composite provider used to resolve composite files. Also registers
|
|
9651
9034
|
* any `provider.schemas` on the engine pre-seal so composites that reference those
|
|
@@ -9671,16 +9054,6 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
|
|
|
9671
9054
|
easingFunction?: EasingFunction;
|
|
9672
9055
|
}
|
|
9673
9056
|
|
|
9674
|
-
/**
|
|
9675
|
-
* @public
|
|
9676
|
-
*/
|
|
9677
|
-
export declare const enum ShowScrollBar {
|
|
9678
|
-
SSB_BOTH = 0,
|
|
9679
|
-
SSB_ONLY_VERTICAL = 1,
|
|
9680
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
9681
|
-
SSB_HIDDEN = 3
|
|
9682
|
-
}
|
|
9683
|
-
|
|
9684
9057
|
/** @public */
|
|
9685
9058
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
9686
9059
|
|
|
@@ -9787,9 +9160,6 @@ export declare namespace Texture {
|
|
|
9787
9160
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
9788
9161
|
}
|
|
9789
9162
|
|
|
9790
|
-
/** @public */
|
|
9791
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
9792
|
-
|
|
9793
9163
|
/**
|
|
9794
9164
|
* @public
|
|
9795
9165
|
*/
|
|
@@ -9900,9 +9270,6 @@ export declare interface TextureUnion {
|
|
|
9900
9270
|
} | {
|
|
9901
9271
|
$case: "videoTexture";
|
|
9902
9272
|
videoTexture: VideoTexture;
|
|
9903
|
-
} | {
|
|
9904
|
-
$case: "uiTexture";
|
|
9905
|
-
uiTexture: UiCanvasTexture;
|
|
9906
9273
|
} | undefined;
|
|
9907
9274
|
}
|
|
9908
9275
|
|
|
@@ -10441,8 +9808,6 @@ export declare interface UiBackgroundProps {
|
|
|
10441
9808
|
uvs?: number[];
|
|
10442
9809
|
/** AvatarTexture for the background */
|
|
10443
9810
|
avatarTexture?: UiAvatarTexture;
|
|
10444
|
-
/** VideoTexture for the background: the frames of a VideoPlayer on another entity */
|
|
10445
|
-
videoTexture?: UiVideoTexture;
|
|
10446
9811
|
/** Texture for the background */
|
|
10447
9812
|
texture?: UiTexture;
|
|
10448
9813
|
}
|
|
@@ -10462,31 +9827,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
10462
9827
|
disabled?: boolean;
|
|
10463
9828
|
}
|
|
10464
9829
|
|
|
10465
|
-
/** @public */
|
|
10466
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
10467
|
-
|
|
10468
9830
|
/** @public */
|
|
10469
9831
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
10470
9832
|
|
|
10471
|
-
/**
|
|
10472
|
-
* @public
|
|
10473
|
-
*/
|
|
10474
|
-
export declare interface UiCanvasTexture {
|
|
10475
|
-
uiCanvasEntity: number;
|
|
10476
|
-
/** default = TextureWrapMode.Clamp */
|
|
10477
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
10478
|
-
/** default = FilterMode.Bilinear */
|
|
10479
|
-
filterMode?: TextureFilterMode | undefined;
|
|
10480
|
-
}
|
|
10481
|
-
|
|
10482
|
-
/**
|
|
10483
|
-
* @public
|
|
10484
|
-
*/
|
|
10485
|
-
export declare namespace UiCanvasTexture {
|
|
10486
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
10487
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
10488
|
-
}
|
|
10489
|
-
|
|
10490
9833
|
/**
|
|
10491
9834
|
* @public
|
|
10492
9835
|
*/
|
|
@@ -10584,8 +9927,6 @@ export declare interface UiLabelProps {
|
|
|
10584
9927
|
font?: UiFontType | undefined;
|
|
10585
9928
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
10586
9929
|
textWrap?: UiTextWrapType | undefined;
|
|
10587
|
-
/** A font file in the scene, or a Google Fonts family name; `font` is the fallback. @defaultValue undefined */
|
|
10588
|
-
fontSrc?: string | undefined;
|
|
10589
9930
|
}
|
|
10590
9931
|
|
|
10591
9932
|
/**
|
|
@@ -10606,6 +9947,17 @@ export declare type UiRendererOptions = {
|
|
|
10606
9947
|
* can use different insets simultaneously.
|
|
10607
9948
|
*/
|
|
10608
9949
|
screenInset?: UiScreenInset;
|
|
9950
|
+
/**
|
|
9951
|
+
* Stacking order of this renderer's UI relative to the other renderers (the main
|
|
9952
|
+
* one and every `addUiRenderer`). Higher values render in front. When omitted,
|
|
9953
|
+
* renderers stack in the order they first render, later ones on top; among those
|
|
9954
|
+
* first rendered in the same tick the main UI goes at the back.
|
|
9955
|
+
*
|
|
9956
|
+
* It is applied to the renderer's root container entity, so it only orders whole
|
|
9957
|
+
* renderers against each other; a renderer zIndex of 0 is interpreted as "unset"
|
|
9958
|
+
* (positional order); elements inside a renderer keep their own `zIndex`.
|
|
9959
|
+
*/
|
|
9960
|
+
zIndex?: number;
|
|
10609
9961
|
};
|
|
10610
9962
|
|
|
10611
9963
|
/**
|
|
@@ -10641,9 +9993,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
|
|
|
10641
9993
|
uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
|
|
10642
9994
|
};
|
|
10643
9995
|
|
|
10644
|
-
/** @public */
|
|
10645
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
10646
|
-
|
|
10647
9996
|
/** @public */
|
|
10648
9997
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
10649
9998
|
|
|
@@ -10723,22 +10072,6 @@ export declare interface UiTransformProps {
|
|
|
10723
10072
|
opacity?: number;
|
|
10724
10073
|
/** default 0 */
|
|
10725
10074
|
zIndex?: number;
|
|
10726
|
-
/** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
|
|
10727
|
-
elementId?: string;
|
|
10728
|
-
/** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
|
|
10729
|
-
scrollPosition?: PBVector2 | string;
|
|
10730
|
-
/** Which scrollbars to show when overflow is 'scroll'. default 'both' */
|
|
10731
|
-
scrollVisible?: ScrollVisibleType;
|
|
10732
|
-
}
|
|
10733
|
-
|
|
10734
|
-
/**
|
|
10735
|
-
* Video Texture
|
|
10736
|
-
* @public
|
|
10737
|
-
*/
|
|
10738
|
-
export declare interface UiVideoTexture {
|
|
10739
|
-
videoPlayerEntity: Entity;
|
|
10740
|
-
wrapMode?: TextureWrapType;
|
|
10741
|
-
filterMode?: TextureFilterType;
|
|
10742
10075
|
}
|
|
10743
10076
|
|
|
10744
10077
|
/**
|