@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/alpha.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
|
*/
|
|
@@ -2867,6 +2770,10 @@ export declare interface IEvents {
|
|
|
2867
2770
|
sender: string;
|
|
2868
2771
|
message: string;
|
|
2869
2772
|
};
|
|
2773
|
+
/** Triggered when the player switches the client language. `locale` is a BCP-47 tag */
|
|
2774
|
+
localeChanged: {
|
|
2775
|
+
locale: string;
|
|
2776
|
+
};
|
|
2870
2777
|
/**
|
|
2871
2778
|
* This is triggered once the scene should start.
|
|
2872
2779
|
*/
|
|
@@ -3289,12 +3196,6 @@ export declare type Listeners = {
|
|
|
3289
3196
|
onMouseEnter?: Callback;
|
|
3290
3197
|
/** triggered on mouse leave event */
|
|
3291
3198
|
onMouseLeave?: Callback;
|
|
3292
|
-
/** triggered while the pointer is dragged after pressing on the element */
|
|
3293
|
-
onMouseDrag?: Callback;
|
|
3294
|
-
/** triggered while the pointer is dragged with the cursor locked in place */
|
|
3295
|
-
onMouseDragLocked?: Callback;
|
|
3296
|
-
/** triggered when a drag that started on the element ends */
|
|
3297
|
-
onMouseDragEnd?: Callback;
|
|
3298
3199
|
};
|
|
3299
3200
|
|
|
3300
3201
|
/**
|
|
@@ -4199,15 +4100,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4199
4100
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4200
4101
|
*/
|
|
4201
4102
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4202
|
-
/**
|
|
4203
|
-
* @public
|
|
4204
|
-
* Set a mesh from inside a gltf in the MeshCollider component
|
|
4205
|
-
* @param entity - entity to create or replace the MeshCollider component
|
|
4206
|
-
* @param source - the path to the gltf
|
|
4207
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4208
|
-
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4209
|
-
*/
|
|
4210
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4211
4103
|
}
|
|
4212
4104
|
|
|
4213
4105
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4244,14 +4136,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4244
4136
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4245
4137
|
*/
|
|
4246
4138
|
setSphere(entity: Entity): void;
|
|
4247
|
-
/**
|
|
4248
|
-
* @public
|
|
4249
|
-
* Set a mesh from inside a gltf in the MeshRenderer component
|
|
4250
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4251
|
-
* @param source - the path to the gltf
|
|
4252
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4253
|
-
*/
|
|
4254
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
4255
4139
|
}
|
|
4256
4140
|
|
|
4257
4141
|
/**
|
|
@@ -4300,39 +4184,6 @@ export declare namespace MoveContinuous {
|
|
|
4300
4184
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4301
4185
|
}
|
|
4302
4186
|
|
|
4303
|
-
/**
|
|
4304
|
-
* Describes the animation the movement scene wants the avatar to play.
|
|
4305
|
-
* One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
|
|
4306
|
-
* When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
|
|
4307
|
-
*/
|
|
4308
|
-
/**
|
|
4309
|
-
* @public
|
|
4310
|
-
*/
|
|
4311
|
-
export declare interface MovementAnimation {
|
|
4312
|
-
/** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
|
|
4313
|
-
src: string;
|
|
4314
|
-
/** whether the clip repeats once it reaches the end */
|
|
4315
|
-
loop: boolean;
|
|
4316
|
-
/** playback speed multiplier (1.0 = clip's native rate) */
|
|
4317
|
-
speed: number;
|
|
4318
|
-
/** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
|
|
4319
|
-
idle: boolean;
|
|
4320
|
-
/** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
|
|
4321
|
-
transitionSeconds?: number | undefined;
|
|
4322
|
-
/** if set, the engine seeks to this position (in seconds) this frame. Clear on subsequent frames to allow normal playback. The scene can read `AvatarAnimationState.playback_time` first to decide. */
|
|
4323
|
-
playbackTime?: number | undefined;
|
|
4324
|
-
/** scene-relative paths to audio clips (.mp3/.ogg) to play this frame on the avatar audio bus. Fire-and-forget: each listed clip plays once per frame it appears; leaving a clip set for multiple frames re-triggers it. No stop mechanism. Use `AvatarAnimationState.playback_time` to trigger sounds at the right point in the clip (e.g. foot plants). */
|
|
4325
|
-
sounds: string[];
|
|
4326
|
-
}
|
|
4327
|
-
|
|
4328
|
-
/**
|
|
4329
|
-
* @public
|
|
4330
|
-
*/
|
|
4331
|
-
export declare namespace MovementAnimation {
|
|
4332
|
-
export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
|
|
4333
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
|
|
4334
|
-
}
|
|
4335
|
-
|
|
4336
4187
|
/**
|
|
4337
4188
|
* @public
|
|
4338
4189
|
*/
|
|
@@ -4756,25 +4607,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4756
4607
|
totalVideoLength: number;
|
|
4757
4608
|
}>;
|
|
4758
4609
|
|
|
4759
|
-
/**
|
|
4760
|
-
* @public
|
|
4761
|
-
*/
|
|
4762
|
-
export declare interface Orthographic {
|
|
4763
|
-
/**
|
|
4764
|
-
* vertical extent of the visible range in meters
|
|
4765
|
-
* defaults to 4m
|
|
4766
|
-
*/
|
|
4767
|
-
verticalRange?: number | undefined;
|
|
4768
|
-
}
|
|
4769
|
-
|
|
4770
|
-
/**
|
|
4771
|
-
* @public
|
|
4772
|
-
*/
|
|
4773
|
-
export declare namespace Orthographic {
|
|
4774
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4775
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4776
|
-
}
|
|
4777
|
-
|
|
4778
4610
|
/**
|
|
4779
4611
|
* @public
|
|
4780
4612
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -5072,8 +4904,6 @@ export declare interface PBAvatarBase {
|
|
|
5072
4904
|
hairColor: PBColor3 | undefined;
|
|
5073
4905
|
bodyShapeUrn: string;
|
|
5074
4906
|
name: string;
|
|
5075
|
-
/** true while the player is speaking in voice chat; unset when the engine does not report voice activity */
|
|
5076
|
-
talking?: boolean | undefined;
|
|
5077
4907
|
}
|
|
5078
4908
|
|
|
5079
4909
|
/**
|
|
@@ -5124,8 +4954,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
5124
4954
|
export declare interface PBAvatarEquippedData {
|
|
5125
4955
|
wearableUrns: string[];
|
|
5126
4956
|
emoteUrns: string[];
|
|
5127
|
-
/** slots that will render even if hidden */
|
|
5128
|
-
forceRender: string[];
|
|
5129
4957
|
}
|
|
5130
4958
|
|
|
5131
4959
|
/**
|
|
@@ -5196,8 +5024,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
5196
5024
|
excludeIds: string[];
|
|
5197
5025
|
/** list of modifiers to apply */
|
|
5198
5026
|
modifiers: AvatarModifierType[];
|
|
5199
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5200
|
-
useColliderRange?: boolean | undefined;
|
|
5201
5027
|
}
|
|
5202
5028
|
|
|
5203
5029
|
/**
|
|
@@ -5208,64 +5034,6 @@ export declare namespace PBAvatarModifierArea {
|
|
|
5208
5034
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
|
|
5209
5035
|
}
|
|
5210
5036
|
|
|
5211
|
-
/**
|
|
5212
|
-
* @public
|
|
5213
|
-
*/
|
|
5214
|
-
export declare interface PBAvatarMovement {
|
|
5215
|
-
velocity: PBVector3 | undefined;
|
|
5216
|
-
/** 0-360, yaw only; this is the authoritative facing (other clients read it, and physics treats the avatar as upright). Lean is expressed separately via tilt_pitch/tilt_roll. */
|
|
5217
|
-
orientation: number;
|
|
5218
|
-
groundDirection?: PBVector3 | undefined;
|
|
5219
|
-
/** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
|
|
5220
|
-
walkSuccess?: boolean | undefined;
|
|
5221
|
-
/** if set, the engine plays this animation instead of selecting one from velocity heuristics */
|
|
5222
|
-
animation?: MovementAnimation | undefined;
|
|
5223
|
-
/** render-only forward/back lean in degrees, applied on top of `orientation` (rotation about the avatar's local X axis). Does not affect the physics capsule (stays upright) or the facing other clients read. Defaults to 0. */
|
|
5224
|
-
tiltPitch?: number | undefined;
|
|
5225
|
-
/** render-only sideways lean in degrees, applied on top of `orientation` (rotation about the avatar's local Z axis). Same constraints as tilt_pitch. Useful e.g. for glider banking. Defaults to 0. */
|
|
5226
|
-
tiltRoll?: number | undefined;
|
|
5227
|
-
}
|
|
5228
|
-
|
|
5229
|
-
/**
|
|
5230
|
-
* @public
|
|
5231
|
-
*/
|
|
5232
|
-
export declare namespace PBAvatarMovement {
|
|
5233
|
-
export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
|
|
5234
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
|
|
5235
|
-
}
|
|
5236
|
-
|
|
5237
|
-
/**
|
|
5238
|
-
* @public
|
|
5239
|
-
*/
|
|
5240
|
-
export declare interface PBAvatarMovementInfo {
|
|
5241
|
-
/** the length of time the current step velocity will apply for */
|
|
5242
|
-
stepTime: number;
|
|
5243
|
-
/** the length of time the previous step velocity applied for */
|
|
5244
|
-
previousStepTime: number;
|
|
5245
|
-
/** the velocity requested for the previous frame */
|
|
5246
|
-
requestedVelocity: PBVector3 | undefined;
|
|
5247
|
-
/** the resulting velocity taking collisions into account */
|
|
5248
|
-
actualVelocity: PBVector3 | undefined;
|
|
5249
|
-
/** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
|
|
5250
|
-
externalVelocity: PBVector3 | undefined;
|
|
5251
|
-
activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
|
|
5252
|
-
activeInputModifier: PBInputModifier | undefined;
|
|
5253
|
-
/** if set, the movement scene should walk the player to this scene-relative position */
|
|
5254
|
-
walkTarget?: PBVector3 | undefined;
|
|
5255
|
-
/** stop distance for walk_target; considered reached when within this distance */
|
|
5256
|
-
walkThreshold?: number | undefined;
|
|
5257
|
-
/** current state of a scene-driven movement animation. Absent when the engine is using its velocity-based fallback. `playback_time` freezes while a triggerSceneEmote is overriding the animation. */
|
|
5258
|
-
activeAnimationState?: AvatarAnimationState | undefined;
|
|
5259
|
-
}
|
|
5260
|
-
|
|
5261
|
-
/**
|
|
5262
|
-
* @public
|
|
5263
|
-
*/
|
|
5264
|
-
export declare namespace PBAvatarMovementInfo {
|
|
5265
|
-
export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
|
|
5266
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
|
|
5267
|
-
}
|
|
5268
|
-
|
|
5269
5037
|
/**
|
|
5270
5038
|
* The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
|
|
5271
5039
|
* for example to show a rank or a role that the scene assigns to that player.
|
|
@@ -5356,8 +5124,6 @@ export declare interface PBAvatarShape {
|
|
|
5356
5124
|
emotes: string[];
|
|
5357
5125
|
/** hides the skin + hair + facial features (default: false) */
|
|
5358
5126
|
showOnlyWearables?: boolean | undefined;
|
|
5359
|
-
/** slots that will render even if hidden */
|
|
5360
|
-
forceRender: string[];
|
|
5361
5127
|
}
|
|
5362
5128
|
|
|
5363
5129
|
/**
|
|
@@ -5399,51 +5165,6 @@ export declare namespace PBBillboard {
|
|
|
5399
5165
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
5400
5166
|
}
|
|
5401
5167
|
|
|
5402
|
-
/**
|
|
5403
|
-
* @public
|
|
5404
|
-
*/
|
|
5405
|
-
export declare interface PBCameraLayer {
|
|
5406
|
-
/**
|
|
5407
|
-
* layer to which these settings apply. must be > 0
|
|
5408
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
5409
|
-
*/
|
|
5410
|
-
layer: number;
|
|
5411
|
-
/** should the sun light affect this layer? default false */
|
|
5412
|
-
directionalLight?: boolean | undefined;
|
|
5413
|
-
/** should this layer show player avatars? default false */
|
|
5414
|
-
showAvatars?: boolean | undefined;
|
|
5415
|
-
/** should this layer show the sky? default false */
|
|
5416
|
-
showSkybox?: boolean | undefined;
|
|
5417
|
-
/** should this layer show distance fog? default false */
|
|
5418
|
-
showFog?: boolean | undefined;
|
|
5419
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
5420
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
5421
|
-
ambientBrightnessOverride?: number | undefined;
|
|
5422
|
-
}
|
|
5423
|
-
|
|
5424
|
-
/**
|
|
5425
|
-
* @public
|
|
5426
|
-
*/
|
|
5427
|
-
export declare namespace PBCameraLayer {
|
|
5428
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
5429
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
5430
|
-
}
|
|
5431
|
-
|
|
5432
|
-
/**
|
|
5433
|
-
* @public
|
|
5434
|
-
*/
|
|
5435
|
-
export declare interface PBCameraLayers {
|
|
5436
|
-
layers: number[];
|
|
5437
|
-
}
|
|
5438
|
-
|
|
5439
|
-
/**
|
|
5440
|
-
* @public
|
|
5441
|
-
*/
|
|
5442
|
-
export declare namespace PBCameraLayers {
|
|
5443
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5444
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5445
|
-
}
|
|
5446
|
-
|
|
5447
5168
|
/**
|
|
5448
5169
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5449
5170
|
* third-person view.
|
|
@@ -5485,8 +5206,6 @@ export declare interface PBCameraModeArea {
|
|
|
5485
5206
|
area: PBVector3 | undefined;
|
|
5486
5207
|
/** the camera mode to enforce */
|
|
5487
5208
|
mode: CameraType;
|
|
5488
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5489
|
-
useColliderRange?: boolean | undefined;
|
|
5490
5209
|
}
|
|
5491
5210
|
|
|
5492
5211
|
/**
|
|
@@ -5561,7 +5280,82 @@ export declare namespace PBEngineInfo {
|
|
|
5561
5280
|
}
|
|
5562
5281
|
|
|
5563
5282
|
/**
|
|
5564
|
-
*
|
|
5283
|
+
* Grow-only value set appended to the scene root entity.
|
|
5284
|
+
* Reports the outcome of an EU_ITEM_PURCHASE flow triggered via OpenExplorerUi.
|
|
5285
|
+
*/
|
|
5286
|
+
/**
|
|
5287
|
+
* @public
|
|
5288
|
+
*/
|
|
5289
|
+
export declare interface PBExplorerItemPurchaseResult {
|
|
5290
|
+
urn: string;
|
|
5291
|
+
/** The scene tick when the event occurred */
|
|
5292
|
+
timestamp: number;
|
|
5293
|
+
/** The OpenExplorerUiRequest.request_id that caused this event; 0 when the request carried none */
|
|
5294
|
+
requestId: number;
|
|
5295
|
+
status?: {
|
|
5296
|
+
$case: "purchased";
|
|
5297
|
+
purchased: PBExplorerItemPurchaseResult_Purchased;
|
|
5298
|
+
} | {
|
|
5299
|
+
$case: "dismissed";
|
|
5300
|
+
dismissed: PBExplorerItemPurchaseResult_Dismissed;
|
|
5301
|
+
} | {
|
|
5302
|
+
$case: "failed";
|
|
5303
|
+
failed: PBExplorerItemPurchaseResult_Failed;
|
|
5304
|
+
} | undefined;
|
|
5305
|
+
}
|
|
5306
|
+
|
|
5307
|
+
/**
|
|
5308
|
+
* @public
|
|
5309
|
+
*/
|
|
5310
|
+
export declare namespace PBExplorerItemPurchaseResult {
|
|
5311
|
+
export function encode(message: PBExplorerItemPurchaseResult, writer?: _m0.Writer): _m0.Writer;
|
|
5312
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult;
|
|
5313
|
+
}
|
|
5314
|
+
|
|
5315
|
+
/**
|
|
5316
|
+
* @public
|
|
5317
|
+
*/
|
|
5318
|
+
export declare interface PBExplorerItemPurchaseResult_Dismissed {
|
|
5319
|
+
}
|
|
5320
|
+
|
|
5321
|
+
/**
|
|
5322
|
+
* @public
|
|
5323
|
+
*/
|
|
5324
|
+
export declare namespace PBExplorerItemPurchaseResult_Dismissed {
|
|
5325
|
+
export function encode(_: PBExplorerItemPurchaseResult_Dismissed, writer?: _m0.Writer): _m0.Writer;
|
|
5326
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult_Dismissed;
|
|
5327
|
+
}
|
|
5328
|
+
|
|
5329
|
+
/**
|
|
5330
|
+
* @public
|
|
5331
|
+
*/
|
|
5332
|
+
export declare interface PBExplorerItemPurchaseResult_Failed {
|
|
5333
|
+
}
|
|
5334
|
+
|
|
5335
|
+
/**
|
|
5336
|
+
* @public
|
|
5337
|
+
*/
|
|
5338
|
+
export declare namespace PBExplorerItemPurchaseResult_Failed {
|
|
5339
|
+
export function encode(_: PBExplorerItemPurchaseResult_Failed, writer?: _m0.Writer): _m0.Writer;
|
|
5340
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult_Failed;
|
|
5341
|
+
}
|
|
5342
|
+
|
|
5343
|
+
/**
|
|
5344
|
+
* @public
|
|
5345
|
+
*/
|
|
5346
|
+
export declare interface PBExplorerItemPurchaseResult_Purchased {
|
|
5347
|
+
}
|
|
5348
|
+
|
|
5349
|
+
/**
|
|
5350
|
+
* @public
|
|
5351
|
+
*/
|
|
5352
|
+
export declare namespace PBExplorerItemPurchaseResult_Purchased {
|
|
5353
|
+
export function encode(_: PBExplorerItemPurchaseResult_Purchased, writer?: _m0.Writer): _m0.Writer;
|
|
5354
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerItemPurchaseResult_Purchased;
|
|
5355
|
+
}
|
|
5356
|
+
|
|
5357
|
+
/**
|
|
5358
|
+
* PBExplorerUiEventsResult transports the lifecycle events of explorer UI panels — a panel was
|
|
5565
5359
|
* opened, a panel was closed. It is a grow only value set appended to the scene root entity, so every
|
|
5566
5360
|
* event of a tick is delivered and none overwrites another.
|
|
5567
5361
|
*/
|
|
@@ -5573,6 +5367,8 @@ export declare interface PBExplorerUiEventsResult {
|
|
|
5573
5367
|
ui: ExplorerUi;
|
|
5574
5368
|
/** The scene tick when the event occurred */
|
|
5575
5369
|
timestamp: number;
|
|
5370
|
+
/** The OpenExplorerUiRequest.request_id that caused this event; 0 when the request carried none */
|
|
5371
|
+
requestId: number;
|
|
5576
5372
|
event?: {
|
|
5577
5373
|
$case: "opened";
|
|
5578
5374
|
opened: PBExplorerUiEventsResult_UiOpened;
|
|
@@ -5590,7 +5386,7 @@ export declare namespace PBExplorerUiEventsResult {
|
|
|
5590
5386
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult;
|
|
5591
5387
|
}
|
|
5592
5388
|
|
|
5593
|
-
/** Emitted when
|
|
5389
|
+
/** Emitted when an explorer panel is closed. */
|
|
5594
5390
|
/**
|
|
5595
5391
|
* @public
|
|
5596
5392
|
*/
|
|
@@ -5605,7 +5401,10 @@ export declare namespace PBExplorerUiEventsResult_UiClosed {
|
|
|
5605
5401
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiClosed;
|
|
5606
5402
|
}
|
|
5607
5403
|
|
|
5608
|
-
/**
|
|
5404
|
+
/**
|
|
5405
|
+
* Emitted when an explorer panel is opened. The OpenExplorerUi response carries the same fact,
|
|
5406
|
+
* but it reaches only the caller; this channel is scene wide.
|
|
5407
|
+
*/
|
|
5609
5408
|
/**
|
|
5610
5409
|
* @public
|
|
5611
5410
|
*/
|
|
@@ -5620,39 +5419,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
|
|
|
5620
5419
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
|
|
5621
5420
|
}
|
|
5622
5421
|
|
|
5623
|
-
/**
|
|
5624
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5625
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5626
|
-
*/
|
|
5627
|
-
/**
|
|
5628
|
-
* @public
|
|
5629
|
-
*/
|
|
5630
|
-
export declare interface PBGlobalLight {
|
|
5631
|
-
/**
|
|
5632
|
-
* the direction the directional light shines in.
|
|
5633
|
-
* default depends on time of day and explorer implementation
|
|
5634
|
-
*/
|
|
5635
|
-
direction?: PBVector3 | undefined;
|
|
5636
|
-
/**
|
|
5637
|
-
* ambient light color
|
|
5638
|
-
* default: White
|
|
5639
|
-
*/
|
|
5640
|
-
ambientColor?: PBColor3 | undefined;
|
|
5641
|
-
/**
|
|
5642
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5643
|
-
* default 1
|
|
5644
|
-
*/
|
|
5645
|
-
ambientBrightness?: number | undefined;
|
|
5646
|
-
}
|
|
5647
|
-
|
|
5648
|
-
/**
|
|
5649
|
-
* @public
|
|
5650
|
-
*/
|
|
5651
|
-
export declare namespace PBGlobalLight {
|
|
5652
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5653
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5654
|
-
}
|
|
5655
|
-
|
|
5656
5422
|
/**
|
|
5657
5423
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5658
5424
|
*
|
|
@@ -5688,25 +5454,6 @@ export declare namespace PBGltfContainer {
|
|
|
5688
5454
|
*/
|
|
5689
5455
|
export declare interface PBGltfContainerLoadingState {
|
|
5690
5456
|
currentState: LoadingState;
|
|
5691
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5692
|
-
nodePaths: string[];
|
|
5693
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5694
|
-
meshNames: string[];
|
|
5695
|
-
/**
|
|
5696
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5697
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5698
|
-
*/
|
|
5699
|
-
materialNames: string[];
|
|
5700
|
-
/**
|
|
5701
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5702
|
-
* sure all your materials are explicitly named.
|
|
5703
|
-
*/
|
|
5704
|
-
skinNames: string[];
|
|
5705
|
-
/**
|
|
5706
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5707
|
-
* your skins are explicitly named.
|
|
5708
|
-
*/
|
|
5709
|
-
animationNames: string[];
|
|
5710
5457
|
}
|
|
5711
5458
|
|
|
5712
5459
|
/**
|
|
@@ -5717,57 +5464,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5717
5464
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5718
5465
|
}
|
|
5719
5466
|
|
|
5720
|
-
/**
|
|
5721
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5722
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5723
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5724
|
-
* in the parent.
|
|
5725
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5726
|
-
*
|
|
5727
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5728
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5729
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5730
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5731
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5732
|
-
*
|
|
5733
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5734
|
-
*
|
|
5735
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5736
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5737
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5738
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5739
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5740
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5741
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5742
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5743
|
-
* used as a base, and any gltf features (e.g. occlusion maps) from the gtlf spec that the renderer supports but that are not exposed in the
|
|
5744
|
-
* PBMaterial will be maintained.
|
|
5745
|
-
*
|
|
5746
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5747
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5748
|
-
* change the state to `GNS_FAILED`.
|
|
5749
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5750
|
-
*
|
|
5751
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5752
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5753
|
-
* the gltf node will also be displayed.
|
|
5754
|
-
*/
|
|
5755
|
-
/**
|
|
5756
|
-
* @public
|
|
5757
|
-
*/
|
|
5758
|
-
export declare interface PBGltfNode {
|
|
5759
|
-
/** the path of the target node in the Gltf. */
|
|
5760
|
-
path: string;
|
|
5761
|
-
}
|
|
5762
|
-
|
|
5763
|
-
/**
|
|
5764
|
-
* @public
|
|
5765
|
-
*/
|
|
5766
|
-
export declare namespace PBGltfNode {
|
|
5767
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5768
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5769
|
-
}
|
|
5770
|
-
|
|
5771
5467
|
/**
|
|
5772
5468
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5773
5469
|
*
|
|
@@ -5813,26 +5509,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5813
5509
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5814
5510
|
}
|
|
5815
5511
|
|
|
5816
|
-
/**
|
|
5817
|
-
* The state of a linked gltf node.
|
|
5818
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5819
|
-
*/
|
|
5820
|
-
/**
|
|
5821
|
-
* @public
|
|
5822
|
-
*/
|
|
5823
|
-
export declare interface PBGltfNodeState {
|
|
5824
|
-
state: GltfNodeStateValue;
|
|
5825
|
-
error?: string | undefined;
|
|
5826
|
-
}
|
|
5827
|
-
|
|
5828
|
-
/**
|
|
5829
|
-
* @public
|
|
5830
|
-
*/
|
|
5831
|
-
export declare namespace PBGltfNodeState {
|
|
5832
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5833
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5834
|
-
}
|
|
5835
|
-
|
|
5836
5512
|
/**
|
|
5837
5513
|
* @public
|
|
5838
5514
|
*/
|
|
@@ -5970,14 +5646,6 @@ export declare interface PBMaterial {
|
|
|
5970
5646
|
$case: "pbr";
|
|
5971
5647
|
pbr: PBMaterial_PbrMaterial;
|
|
5972
5648
|
} | undefined;
|
|
5973
|
-
/**
|
|
5974
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
5975
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
5976
|
-
* supported by the PbMaterial.
|
|
5977
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
5978
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
5979
|
-
*/
|
|
5980
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
5981
5649
|
}
|
|
5982
5650
|
|
|
5983
5651
|
/**
|
|
@@ -5988,22 +5656,6 @@ export declare namespace PBMaterial {
|
|
|
5988
5656
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
5989
5657
|
}
|
|
5990
5658
|
|
|
5991
|
-
/**
|
|
5992
|
-
* @public
|
|
5993
|
-
*/
|
|
5994
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
5995
|
-
gltfSrc: string;
|
|
5996
|
-
name: string;
|
|
5997
|
-
}
|
|
5998
|
-
|
|
5999
|
-
/**
|
|
6000
|
-
* @public
|
|
6001
|
-
*/
|
|
6002
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
6003
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
6004
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
6005
|
-
}
|
|
6006
|
-
|
|
6007
5659
|
/**
|
|
6008
5660
|
* @public
|
|
6009
5661
|
*/
|
|
@@ -6100,9 +5752,6 @@ export declare interface PBMeshCollider {
|
|
|
6100
5752
|
} | {
|
|
6101
5753
|
$case: "plane";
|
|
6102
5754
|
plane: PBMeshCollider_PlaneMesh;
|
|
6103
|
-
} | {
|
|
6104
|
-
$case: "gltf";
|
|
6105
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
6106
5755
|
} | undefined;
|
|
6107
5756
|
}
|
|
6108
5757
|
|
|
@@ -6148,25 +5797,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
6148
5797
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
6149
5798
|
}
|
|
6150
5799
|
|
|
6151
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
6152
|
-
/**
|
|
6153
|
-
* @public
|
|
6154
|
-
*/
|
|
6155
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
6156
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6157
|
-
gltfSrc: string;
|
|
6158
|
-
/** the name of the mesh asset */
|
|
6159
|
-
name: string;
|
|
6160
|
-
}
|
|
6161
|
-
|
|
6162
|
-
/**
|
|
6163
|
-
* @public
|
|
6164
|
-
*/
|
|
6165
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
6166
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6167
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
6168
|
-
}
|
|
6169
|
-
|
|
6170
5800
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
6171
5801
|
/**
|
|
6172
5802
|
* @public
|
|
@@ -6199,11 +5829,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
6199
5829
|
|
|
6200
5830
|
/**
|
|
6201
5831
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
6202
|
-
* plane, a sphere
|
|
5832
|
+
* plane, a sphere or a cylinder.
|
|
6203
5833
|
*
|
|
6204
5834
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
6205
5835
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
6206
5836
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5837
|
+
*
|
|
5838
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
|
6207
5839
|
*/
|
|
6208
5840
|
/**
|
|
6209
5841
|
* @public
|
|
@@ -6221,9 +5853,6 @@ export declare interface PBMeshRenderer {
|
|
|
6221
5853
|
} | {
|
|
6222
5854
|
$case: "plane";
|
|
6223
5855
|
plane: PBMeshRenderer_PlaneMesh;
|
|
6224
|
-
} | {
|
|
6225
|
-
$case: "gltf";
|
|
6226
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
6227
5856
|
} | undefined;
|
|
6228
5857
|
}
|
|
6229
5858
|
|
|
@@ -6271,25 +5900,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
6271
5900
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
6272
5901
|
}
|
|
6273
5902
|
|
|
6274
|
-
/** A mesh from a Gltf. */
|
|
6275
|
-
/**
|
|
6276
|
-
* @public
|
|
6277
|
-
*/
|
|
6278
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
6279
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6280
|
-
gltfSrc: string;
|
|
6281
|
-
/** the name of the mesh asset */
|
|
6282
|
-
name: string;
|
|
6283
|
-
}
|
|
6284
|
-
|
|
6285
|
-
/**
|
|
6286
|
-
* @public
|
|
6287
|
-
*/
|
|
6288
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
6289
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6290
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
6291
|
-
}
|
|
6292
|
-
|
|
6293
5903
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
6294
5904
|
/**
|
|
6295
5905
|
* @public
|
|
@@ -6886,10 +6496,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
6886
6496
|
screenCoordinates?: PBVector2 | undefined;
|
|
6887
6497
|
/** Movement since last frame (pixels) */
|
|
6888
6498
|
screenDelta?: PBVector2 | undefined;
|
|
6889
|
-
/**
|
|
6890
|
-
* ray direction that can be used with the primary camera origin for
|
|
6891
|
-
* raycasting from the cursor into the world
|
|
6892
|
-
*/
|
|
6499
|
+
/** Direction vector for 3D ray casting */
|
|
6893
6500
|
worldRayDirection?: PBVector3 | undefined;
|
|
6894
6501
|
}
|
|
6895
6502
|
|
|
@@ -6960,10 +6567,6 @@ export declare interface PBRaycast {
|
|
|
6960
6567
|
continuous?: boolean | undefined;
|
|
6961
6568
|
/** Collision mask, by default CL_POINTER | CL_PHYSICS */
|
|
6962
6569
|
collisionMask?: number | undefined;
|
|
6963
|
-
/** shape to cast, default ray */
|
|
6964
|
-
shape?: RaycastShape | undefined;
|
|
6965
|
-
/** include hits with entities from other scenes */
|
|
6966
|
-
includeWorld?: boolean | undefined;
|
|
6967
6570
|
}
|
|
6968
6571
|
|
|
6969
6572
|
/**
|
|
@@ -7109,8 +6712,6 @@ export declare interface PBTextShape {
|
|
|
7109
6712
|
outlineColor?: PBColor3 | undefined;
|
|
7110
6713
|
/** text color (default [1.0, 1.0, 1.0]) */
|
|
7111
6714
|
textColor?: PBColor4 | undefined;
|
|
7112
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7113
|
-
fontSrc?: string | undefined;
|
|
7114
6715
|
}
|
|
7115
6716
|
|
|
7116
6717
|
/**
|
|
@@ -7121,46 +6722,6 @@ export declare namespace PBTextShape {
|
|
|
7121
6722
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
7122
6723
|
}
|
|
7123
6724
|
|
|
7124
|
-
/**
|
|
7125
|
-
* @public
|
|
7126
|
-
*/
|
|
7127
|
-
export declare interface PBTextureCamera {
|
|
7128
|
-
/** rendered texture width */
|
|
7129
|
-
width?: number | undefined;
|
|
7130
|
-
/** rendered texture height */
|
|
7131
|
-
height?: number | undefined;
|
|
7132
|
-
/**
|
|
7133
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
7134
|
-
* defaults to 0
|
|
7135
|
-
*/
|
|
7136
|
-
layer?: number | undefined;
|
|
7137
|
-
/** default black */
|
|
7138
|
-
clearColor?: PBColor4 | undefined;
|
|
7139
|
-
/** default infinity */
|
|
7140
|
-
farPlane?: number | undefined;
|
|
7141
|
-
mode?: {
|
|
7142
|
-
$case: "perspective";
|
|
7143
|
-
perspective: Perspective;
|
|
7144
|
-
} | {
|
|
7145
|
-
$case: "orthographic";
|
|
7146
|
-
orthographic: Orthographic;
|
|
7147
|
-
} | undefined;
|
|
7148
|
-
/**
|
|
7149
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
7150
|
-
* range: 0 (off) - 1 (full volume)
|
|
7151
|
-
* default: 0
|
|
7152
|
-
*/
|
|
7153
|
-
volume?: number | undefined;
|
|
7154
|
-
}
|
|
7155
|
-
|
|
7156
|
-
/**
|
|
7157
|
-
* @public
|
|
7158
|
-
*/
|
|
7159
|
-
export declare namespace PBTextureCamera {
|
|
7160
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
7161
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
7162
|
-
}
|
|
7163
|
-
|
|
7164
6725
|
/**
|
|
7165
6726
|
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
7166
6727
|
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
@@ -7406,25 +6967,6 @@ export declare namespace PBUiBackground {
|
|
|
7406
6967
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
7407
6968
|
}
|
|
7408
6969
|
|
|
7409
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
7410
|
-
/**
|
|
7411
|
-
* @public
|
|
7412
|
-
*/
|
|
7413
|
-
export declare interface PBUiCanvas {
|
|
7414
|
-
width: number;
|
|
7415
|
-
height: number;
|
|
7416
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
7417
|
-
color?: PBColor4 | undefined;
|
|
7418
|
-
}
|
|
7419
|
-
|
|
7420
|
-
/**
|
|
7421
|
-
* @public
|
|
7422
|
-
*/
|
|
7423
|
-
export declare namespace PBUiCanvas {
|
|
7424
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
7425
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
7426
|
-
}
|
|
7427
|
-
|
|
7428
6970
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
7429
6971
|
/**
|
|
7430
6972
|
* @public
|
|
@@ -7480,8 +7022,6 @@ export declare interface PBUiDropdown {
|
|
|
7480
7022
|
font?: Font | undefined;
|
|
7481
7023
|
/** default=10 */
|
|
7482
7024
|
fontSize?: number | undefined;
|
|
7483
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7484
|
-
fontSrc?: string | undefined;
|
|
7485
7025
|
}
|
|
7486
7026
|
|
|
7487
7027
|
/**
|
|
@@ -7524,12 +7064,6 @@ export declare interface PBUiInput {
|
|
|
7524
7064
|
/** default=10 */
|
|
7525
7065
|
fontSize?: number | undefined;
|
|
7526
7066
|
value?: string | undefined;
|
|
7527
|
-
/** default=false; when true, the input accepts newlines and behaves as a textarea */
|
|
7528
|
-
multiLine?: boolean | undefined;
|
|
7529
|
-
/** default=true; when false, the input value is preserved after pressing Enter */
|
|
7530
|
-
clearOnSubmit?: boolean | undefined;
|
|
7531
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7532
|
-
fontSrc?: string | undefined;
|
|
7533
7067
|
}
|
|
7534
7068
|
|
|
7535
7069
|
/**
|
|
@@ -7593,21 +7127,6 @@ export declare namespace PBUiInputResult {
|
|
|
7593
7127
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
7594
7128
|
}
|
|
7595
7129
|
|
|
7596
|
-
/**
|
|
7597
|
-
* @public
|
|
7598
|
-
*/
|
|
7599
|
-
export declare interface PBUiScrollResult {
|
|
7600
|
-
value: PBVector2 | undefined;
|
|
7601
|
-
}
|
|
7602
|
-
|
|
7603
|
-
/**
|
|
7604
|
-
* @public
|
|
7605
|
-
*/
|
|
7606
|
-
export declare namespace PBUiScrollResult {
|
|
7607
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
7608
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
7609
|
-
}
|
|
7610
|
-
|
|
7611
7130
|
/**
|
|
7612
7131
|
* @public
|
|
7613
7132
|
*/
|
|
@@ -7624,8 +7143,6 @@ export declare interface PBUiText {
|
|
|
7624
7143
|
fontSize?: number | undefined;
|
|
7625
7144
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
|
7626
7145
|
textWrap?: TextWrap | undefined;
|
|
7627
|
-
/** a font file in the scene, or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7628
|
-
fontSrc?: string | undefined;
|
|
7629
7146
|
}
|
|
7630
7147
|
|
|
7631
7148
|
/**
|
|
@@ -7753,12 +7270,6 @@ export declare interface PBUiTransform {
|
|
|
7753
7270
|
borderRightColor?: PBColor4 | undefined;
|
|
7754
7271
|
/** default: 1 */
|
|
7755
7272
|
opacity?: number | undefined;
|
|
7756
|
-
/** reference for scroll_position. default empty */
|
|
7757
|
-
elementId?: string | undefined;
|
|
7758
|
-
/** default position=(0,0) */
|
|
7759
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
7760
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
7761
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
7762
7273
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
7763
7274
|
zIndex?: number | undefined;
|
|
7764
7275
|
}
|
|
@@ -7911,25 +7422,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
7911
7422
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
7912
7423
|
}
|
|
7913
7424
|
|
|
7914
|
-
/**
|
|
7915
|
-
* @public
|
|
7916
|
-
*/
|
|
7917
|
-
export declare interface Perspective {
|
|
7918
|
-
/**
|
|
7919
|
-
* vertical field of view in radians
|
|
7920
|
-
* defaults to pi/4 = 45 degrees
|
|
7921
|
-
*/
|
|
7922
|
-
fieldOfView?: number | undefined;
|
|
7923
|
-
}
|
|
7924
|
-
|
|
7925
|
-
/**
|
|
7926
|
-
* @public
|
|
7927
|
-
*/
|
|
7928
|
-
export declare namespace Perspective {
|
|
7929
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
7930
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
7931
|
-
}
|
|
7932
|
-
|
|
7933
7425
|
/**
|
|
7934
7426
|
* @public
|
|
7935
7427
|
* Physics helpers for applying impulses and forces to the player.
|
|
@@ -8171,24 +7663,6 @@ export declare interface PointerEventsSystem {
|
|
|
8171
7663
|
* @param entity - Entity where the callback was attached
|
|
8172
7664
|
*/
|
|
8173
7665
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
8174
|
-
/**
|
|
8175
|
-
* @public
|
|
8176
|
-
* Remove the callback for onPointerDrag event
|
|
8177
|
-
* @param entity - Entity where the callback was attached
|
|
8178
|
-
*/
|
|
8179
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
8180
|
-
/**
|
|
8181
|
-
* @public
|
|
8182
|
-
* Remove the callback for onPointerDragLocked event
|
|
8183
|
-
* @param entity - Entity where the callback was attached
|
|
8184
|
-
*/
|
|
8185
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
8186
|
-
/**
|
|
8187
|
-
* @public
|
|
8188
|
-
* Remove the callback for onPointerDragEnd event
|
|
8189
|
-
* @param entity - Entity where the callback was attached
|
|
8190
|
-
*/
|
|
8191
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
8192
7666
|
/**
|
|
8193
7667
|
* @public
|
|
8194
7668
|
* Remove the callback for onProximityDown event
|
|
@@ -8267,36 +7741,6 @@ export declare interface PointerEventsSystem {
|
|
|
8267
7741
|
entity: Entity;
|
|
8268
7742
|
opts?: Partial<EventSystemOptions>;
|
|
8269
7743
|
}, cb: EventSystemCallback): void;
|
|
8270
|
-
/**
|
|
8271
|
-
* @public
|
|
8272
|
-
* Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
|
|
8273
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8274
|
-
* @param cb - Function to execute on every drag update
|
|
8275
|
-
*/
|
|
8276
|
-
onPointerDrag(pointerData: {
|
|
8277
|
-
entity: Entity;
|
|
8278
|
-
opts?: Partial<EventSystemOptions>;
|
|
8279
|
-
}, cb: EventSystemCallback): void;
|
|
8280
|
-
/**
|
|
8281
|
-
* @public
|
|
8282
|
-
* Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
|
|
8283
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8284
|
-
* @param cb - Function to execute on every drag update
|
|
8285
|
-
*/
|
|
8286
|
-
onPointerDragLocked(pointerData: {
|
|
8287
|
-
entity: Entity;
|
|
8288
|
-
opts?: Partial<EventSystemOptions>;
|
|
8289
|
-
}, cb: EventSystemCallback): void;
|
|
8290
|
-
/**
|
|
8291
|
-
* @public
|
|
8292
|
-
* Execute callback when the user releases the button after a drag that started on the entity
|
|
8293
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8294
|
-
* @param cb - Function to execute when the drag ends
|
|
8295
|
-
*/
|
|
8296
|
-
onPointerDragEnd(pointerData: {
|
|
8297
|
-
entity: Entity;
|
|
8298
|
-
opts?: Partial<EventSystemOptions>;
|
|
8299
|
-
}, cb: EventSystemCallback): void;
|
|
8300
7744
|
/**
|
|
8301
7745
|
* @public
|
|
8302
7746
|
* Execute callback when the user presses the proximity button on the entity
|
|
@@ -8355,10 +7799,7 @@ export declare const enum PointerEventType {
|
|
|
8355
7799
|
PET_HOVER_ENTER = 2,
|
|
8356
7800
|
PET_HOVER_LEAVE = 3,
|
|
8357
7801
|
PET_PROXIMITY_ENTER = 4,
|
|
8358
|
-
PET_PROXIMITY_LEAVE = 5
|
|
8359
|
-
PET_DRAG_LOCKED = 6,
|
|
8360
|
-
PET_DRAG = 7,
|
|
8361
|
-
PET_DRAG_END = 8
|
|
7802
|
+
PET_PROXIMITY_LEAVE = 5
|
|
8362
7803
|
}
|
|
8363
7804
|
|
|
8364
7805
|
/**
|
|
@@ -8389,10 +7830,7 @@ export declare const enum PointerType {
|
|
|
8389
7830
|
/** POT_NONE - No pointer input */
|
|
8390
7831
|
POT_NONE = 0,
|
|
8391
7832
|
/** POT_MOUSE - Traditional mouse input */
|
|
8392
|
-
POT_MOUSE = 1
|
|
8393
|
-
POT_PAD = 2,
|
|
8394
|
-
POT_TOUCH = 3,
|
|
8395
|
-
POT_WAND = 4
|
|
7833
|
+
POT_MOUSE = 1
|
|
8396
7834
|
}
|
|
8397
7835
|
|
|
8398
7836
|
/**
|
|
@@ -8849,16 +8287,6 @@ export declare const enum RaycastQueryType {
|
|
|
8849
8287
|
/** @public */
|
|
8850
8288
|
export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
|
|
8851
8289
|
|
|
8852
|
-
/**
|
|
8853
|
-
* @public
|
|
8854
|
-
*/
|
|
8855
|
-
export declare const enum RaycastShape {
|
|
8856
|
-
/** RS_RAY - cast a point, get collisions along a ray */
|
|
8857
|
-
RS_RAY = 0,
|
|
8858
|
-
/** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
|
|
8859
|
-
RS_AVATAR = 1
|
|
8860
|
-
}
|
|
8861
|
-
|
|
8862
8290
|
/**
|
|
8863
8291
|
* @public
|
|
8864
8292
|
*/
|
|
@@ -8991,10 +8419,6 @@ export declare type RaycastSystemOptions = {
|
|
|
8991
8419
|
queryType: RaycastQueryType;
|
|
8992
8420
|
continuous?: boolean | undefined;
|
|
8993
8421
|
collisionMask?: number | undefined;
|
|
8994
|
-
/** shape to sweep along the ray, default RS_RAY (a point) */
|
|
8995
|
-
shape?: RaycastShape | undefined;
|
|
8996
|
-
/** include colliders from other scenes, default false */
|
|
8997
|
-
includeWorld?: boolean | undefined;
|
|
8998
8422
|
};
|
|
8999
8423
|
|
|
9000
8424
|
/**
|
|
@@ -9043,20 +8467,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
9043
8467
|
* @param entity - The entity whose UI renderer should be removed
|
|
9044
8468
|
*/
|
|
9045
8469
|
removeUiRenderer(entity: Entity): void;
|
|
9046
|
-
/**
|
|
9047
|
-
* Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
|
|
9048
|
-
* describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
|
|
9049
|
-
* any texture renderer already set on the entity, and is torn down when the entity is removed.
|
|
9050
|
-
*
|
|
9051
|
-
* @param entity - The UiCanvas entity the UI tree hangs from
|
|
9052
|
-
* @param ui - The UI component to render
|
|
9053
|
-
*/
|
|
9054
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
9055
|
-
/**
|
|
9056
|
-
* Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
|
|
9057
|
-
* @param entity - The UiCanvas entity the renderer was set on
|
|
9058
|
-
*/
|
|
9059
|
-
removeTextureRenderer(entity: Entity): void;
|
|
9060
8470
|
}
|
|
9061
8471
|
|
|
9062
8472
|
/**
|
|
@@ -9220,7 +8630,7 @@ export declare type ReadOnlyLastWriteWinElementSetComponentDefinition<T> = Omit<
|
|
|
9220
8630
|
/**
|
|
9221
8631
|
* @public
|
|
9222
8632
|
*/
|
|
9223
|
-
export declare type ReadonlyPrimitive = number | string |
|
|
8633
|
+
export declare type ReadonlyPrimitive = number | string | boolean;
|
|
9224
8634
|
|
|
9225
8635
|
/** @public */
|
|
9226
8636
|
export declare const RealmInfo: LastWriteWinElementSetComponentDefinition<PBRealmInfo>;
|
|
@@ -9647,33 +9057,6 @@ export declare namespace Schemas {
|
|
|
9647
9057
|
*/
|
|
9648
9058
|
export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
|
|
9649
9059
|
|
|
9650
|
-
/**
|
|
9651
|
-
* @public
|
|
9652
|
-
*/
|
|
9653
|
-
export declare interface ScrollPositionValue {
|
|
9654
|
-
value?: {
|
|
9655
|
-
$case: "position";
|
|
9656
|
-
position: PBVector2;
|
|
9657
|
-
} | {
|
|
9658
|
-
$case: "reference";
|
|
9659
|
-
reference: string;
|
|
9660
|
-
} | undefined;
|
|
9661
|
-
}
|
|
9662
|
-
|
|
9663
|
-
/**
|
|
9664
|
-
* @public
|
|
9665
|
-
*/
|
|
9666
|
-
export declare namespace ScrollPositionValue {
|
|
9667
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
9668
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
9669
|
-
}
|
|
9670
|
-
|
|
9671
|
-
/**
|
|
9672
|
-
* Which scrollbars are shown when the overflow is scrollable
|
|
9673
|
-
* @public
|
|
9674
|
-
*/
|
|
9675
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
9676
|
-
|
|
9677
9060
|
/**
|
|
9678
9061
|
* Register the composite provider used to resolve composite files. Also registers
|
|
9679
9062
|
* any `provider.schemas` on the engine pre-seal so composites that reference those
|
|
@@ -9699,16 +9082,6 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
|
|
|
9699
9082
|
easingFunction?: EasingFunction;
|
|
9700
9083
|
}
|
|
9701
9084
|
|
|
9702
|
-
/**
|
|
9703
|
-
* @public
|
|
9704
|
-
*/
|
|
9705
|
-
export declare const enum ShowScrollBar {
|
|
9706
|
-
SSB_BOTH = 0,
|
|
9707
|
-
SSB_ONLY_VERTICAL = 1,
|
|
9708
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
9709
|
-
SSB_HIDDEN = 3
|
|
9710
|
-
}
|
|
9711
|
-
|
|
9712
9085
|
/** @public */
|
|
9713
9086
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
9714
9087
|
|
|
@@ -9820,9 +9193,6 @@ export declare namespace Texture {
|
|
|
9820
9193
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
9821
9194
|
}
|
|
9822
9195
|
|
|
9823
|
-
/** @public */
|
|
9824
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
9825
|
-
|
|
9826
9196
|
/**
|
|
9827
9197
|
* @public
|
|
9828
9198
|
*/
|
|
@@ -9933,9 +9303,6 @@ export declare interface TextureUnion {
|
|
|
9933
9303
|
} | {
|
|
9934
9304
|
$case: "videoTexture";
|
|
9935
9305
|
videoTexture: VideoTexture;
|
|
9936
|
-
} | {
|
|
9937
|
-
$case: "uiTexture";
|
|
9938
|
-
uiTexture: UiCanvasTexture;
|
|
9939
9306
|
} | undefined;
|
|
9940
9307
|
}
|
|
9941
9308
|
|
|
@@ -10474,8 +9841,6 @@ export declare interface UiBackgroundProps {
|
|
|
10474
9841
|
uvs?: number[];
|
|
10475
9842
|
/** AvatarTexture for the background */
|
|
10476
9843
|
avatarTexture?: UiAvatarTexture;
|
|
10477
|
-
/** VideoTexture for the background: the frames of a VideoPlayer on another entity */
|
|
10478
|
-
videoTexture?: UiVideoTexture;
|
|
10479
9844
|
/** Texture for the background */
|
|
10480
9845
|
texture?: UiTexture;
|
|
10481
9846
|
}
|
|
@@ -10495,31 +9860,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
10495
9860
|
disabled?: boolean;
|
|
10496
9861
|
}
|
|
10497
9862
|
|
|
10498
|
-
/** @public */
|
|
10499
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
10500
|
-
|
|
10501
9863
|
/** @public */
|
|
10502
9864
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
10503
9865
|
|
|
10504
|
-
/**
|
|
10505
|
-
* @public
|
|
10506
|
-
*/
|
|
10507
|
-
export declare interface UiCanvasTexture {
|
|
10508
|
-
uiCanvasEntity: number;
|
|
10509
|
-
/** default = TextureWrapMode.Clamp */
|
|
10510
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
10511
|
-
/** default = FilterMode.Bilinear */
|
|
10512
|
-
filterMode?: TextureFilterMode | undefined;
|
|
10513
|
-
}
|
|
10514
|
-
|
|
10515
|
-
/**
|
|
10516
|
-
* @public
|
|
10517
|
-
*/
|
|
10518
|
-
export declare namespace UiCanvasTexture {
|
|
10519
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
10520
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
10521
|
-
}
|
|
10522
|
-
|
|
10523
9866
|
/**
|
|
10524
9867
|
* @public
|
|
10525
9868
|
*/
|
|
@@ -10617,8 +9960,6 @@ export declare interface UiLabelProps {
|
|
|
10617
9960
|
font?: UiFontType | undefined;
|
|
10618
9961
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
10619
9962
|
textWrap?: UiTextWrapType | undefined;
|
|
10620
|
-
/** A font file in the scene, or a Google Fonts family name; `font` is the fallback. @defaultValue undefined */
|
|
10621
|
-
fontSrc?: string | undefined;
|
|
10622
9963
|
}
|
|
10623
9964
|
|
|
10624
9965
|
/**
|
|
@@ -10639,6 +9980,17 @@ export declare type UiRendererOptions = {
|
|
|
10639
9980
|
* can use different insets simultaneously.
|
|
10640
9981
|
*/
|
|
10641
9982
|
screenInset?: UiScreenInset;
|
|
9983
|
+
/**
|
|
9984
|
+
* Stacking order of this renderer's UI relative to the other renderers (the main
|
|
9985
|
+
* one and every `addUiRenderer`). Higher values render in front. When omitted,
|
|
9986
|
+
* renderers stack in the order they first render, later ones on top; among those
|
|
9987
|
+
* first rendered in the same tick the main UI goes at the back.
|
|
9988
|
+
*
|
|
9989
|
+
* It is applied to the renderer's root container entity, so it only orders whole
|
|
9990
|
+
* renderers against each other; a renderer zIndex of 0 is interpreted as "unset"
|
|
9991
|
+
* (positional order); elements inside a renderer keep their own `zIndex`.
|
|
9992
|
+
*/
|
|
9993
|
+
zIndex?: number;
|
|
10642
9994
|
};
|
|
10643
9995
|
|
|
10644
9996
|
/**
|
|
@@ -10674,9 +10026,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
|
|
|
10674
10026
|
uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
|
|
10675
10027
|
};
|
|
10676
10028
|
|
|
10677
|
-
/** @public */
|
|
10678
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
10679
|
-
|
|
10680
10029
|
/** @public */
|
|
10681
10030
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
10682
10031
|
|
|
@@ -10756,22 +10105,6 @@ export declare interface UiTransformProps {
|
|
|
10756
10105
|
opacity?: number;
|
|
10757
10106
|
/** default 0 */
|
|
10758
10107
|
zIndex?: number;
|
|
10759
|
-
/** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
|
|
10760
|
-
elementId?: string;
|
|
10761
|
-
/** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
|
|
10762
|
-
scrollPosition?: PBVector2 | string;
|
|
10763
|
-
/** Which scrollbars to show when overflow is 'scroll'. default 'both' */
|
|
10764
|
-
scrollVisible?: ScrollVisibleType;
|
|
10765
|
-
}
|
|
10766
|
-
|
|
10767
|
-
/**
|
|
10768
|
-
* Video Texture
|
|
10769
|
-
* @public
|
|
10770
|
-
*/
|
|
10771
|
-
export declare interface UiVideoTexture {
|
|
10772
|
-
videoPlayerEntity: Entity;
|
|
10773
|
-
wrapMode?: TextureWrapType;
|
|
10774
|
-
filterMode?: TextureFilterType;
|
|
10775
10108
|
}
|
|
10776
10109
|
|
|
10777
10110
|
/**
|