@dcl/playground-assets 7.31.1-40604676255.commit-cb3ed84 → 7.31.1-40962203448.commit-c68a75f
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 +225 -768
- package/dist/beta.d.ts +225 -768
- package/dist/index.bundled.d.ts +225 -768
- package/dist/index.js +9 -9
- package/dist/playground/sdk/apis.d.ts +2 -37
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +225 -768
- package/etc/playground-assets.api.json +6162 -11812
- package/etc/playground-assets.api.md +134 -498
- 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>;
|
|
@@ -1459,6 +1387,44 @@ export declare type Color4Type = {
|
|
|
1459
1387
|
a: number;
|
|
1460
1388
|
};
|
|
1461
1389
|
|
|
1390
|
+
/**
|
|
1391
|
+
* Piecewise-linear, with keys interpolated in ascending order of `time`. Positions before the first key
|
|
1392
|
+
* or after the last key take that key's color. No keys means the gradient is unset.
|
|
1393
|
+
* If two keys have the same `time`, then the gradient keeps the key that comes later in `keys`.
|
|
1394
|
+
*/
|
|
1395
|
+
/**
|
|
1396
|
+
* @public
|
|
1397
|
+
*/
|
|
1398
|
+
export declare interface ColorGradient {
|
|
1399
|
+
keys: ColorKey[];
|
|
1400
|
+
}
|
|
1401
|
+
|
|
1402
|
+
/**
|
|
1403
|
+
* @public
|
|
1404
|
+
*/
|
|
1405
|
+
export declare namespace ColorGradient {
|
|
1406
|
+
export function encode(message: ColorGradient, writer?: _m0.Writer): _m0.Writer;
|
|
1407
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ColorGradient;
|
|
1408
|
+
}
|
|
1409
|
+
|
|
1410
|
+
/**
|
|
1411
|
+
* @public
|
|
1412
|
+
*/
|
|
1413
|
+
export declare interface ColorKey {
|
|
1414
|
+
/** position along the gradient, from 0 to 1. Values outside that range clamp to it */
|
|
1415
|
+
time: number;
|
|
1416
|
+
/** linear color. Values above 1 are allowed (HDR) */
|
|
1417
|
+
color: PBColor4 | undefined;
|
|
1418
|
+
}
|
|
1419
|
+
|
|
1420
|
+
/**
|
|
1421
|
+
* @public
|
|
1422
|
+
*/
|
|
1423
|
+
export declare namespace ColorKey {
|
|
1424
|
+
export function encode(message: ColorKey, writer?: _m0.Writer): _m0.Writer;
|
|
1425
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ColorKey;
|
|
1426
|
+
}
|
|
1427
|
+
|
|
1462
1428
|
/** A range of Color4 values. Randomized or lerped between start and end. */
|
|
1463
1429
|
/**
|
|
1464
1430
|
* @public
|
|
@@ -1519,24 +1485,18 @@ export declare const componentDefinitionByName: {
|
|
|
1519
1485
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1520
1486
|
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1521
1487
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1522
|
-
"core::AvatarMovement": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovement>>;
|
|
1523
|
-
"core::AvatarMovementInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>>;
|
|
1524
1488
|
"core::AvatarNametag": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarNametag>>;
|
|
1525
1489
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1526
1490
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
1527
|
-
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
|
1528
|
-
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
|
1529
1491
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
|
1530
1492
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
|
1531
1493
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
|
1494
|
+
"core::EnvironmentFog": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEnvironmentFog>>;
|
|
1532
1495
|
"core::ExplorerItemPurchaseResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerItemPurchaseResult>>;
|
|
1533
1496
|
"core::ExplorerUiEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>>;
|
|
1534
|
-
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
|
1535
1497
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
|
1536
1498
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
|
1537
|
-
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
|
1538
1499
|
"core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
|
|
1539
|
-
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
|
1540
1500
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
|
1541
1501
|
"core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
|
|
1542
1502
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
|
@@ -1555,9 +1515,10 @@ export declare const componentDefinitionByName: {
|
|
|
1555
1515
|
"core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
|
|
1556
1516
|
"core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
|
|
1557
1517
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1518
|
+
"core::Skybox": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkybox>>;
|
|
1558
1519
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1520
|
+
"core::Sun": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSun>>;
|
|
1559
1521
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1560
|
-
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
|
1561
1522
|
"core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
|
|
1562
1523
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1563
1524
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
@@ -1565,14 +1526,12 @@ export declare const componentDefinitionByName: {
|
|
|
1565
1526
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
|
1566
1527
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
|
1567
1528
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
|
1568
|
-
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
|
1569
1529
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
|
1570
1530
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1571
1531
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1572
1532
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1573
1533
|
"core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
|
|
1574
1534
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1575
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
|
1576
1535
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1577
1536
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
1578
1537
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
|
@@ -2192,9 +2151,6 @@ export declare type EntityComponents = {
|
|
|
2192
2151
|
onMouseUp: Callback;
|
|
2193
2152
|
onMouseEnter: Callback;
|
|
2194
2153
|
onMouseLeave: Callback;
|
|
2195
|
-
onMouseDrag: Callback;
|
|
2196
|
-
onMouseDragLocked: Callback;
|
|
2197
|
-
onMouseDragEnd: Callback;
|
|
2198
2154
|
};
|
|
2199
2155
|
|
|
2200
2156
|
/** @public */
|
|
@@ -2252,6 +2208,9 @@ export declare namespace EntityUtils {
|
|
|
2252
2208
|
export function toEntityId(entityNumber: number, entityVersion: number): Entity;
|
|
2253
2209
|
}
|
|
2254
2210
|
|
|
2211
|
+
/** @public */
|
|
2212
|
+
export declare const EnvironmentFog: LastWriteWinElementSetComponentDefinition<PBEnvironmentFog>;
|
|
2213
|
+
|
|
2255
2214
|
/**
|
|
2256
2215
|
* Constant used to define the minimal number value in Babylon.js
|
|
2257
2216
|
* @public
|
|
@@ -2554,9 +2513,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
|
2554
2513
|
direction?: PBVector3;
|
|
2555
2514
|
};
|
|
2556
2515
|
|
|
2557
|
-
/** @public */
|
|
2558
|
-
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
|
2559
|
-
|
|
2560
2516
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
|
2561
2517
|
|
|
2562
2518
|
export declare type GlobalTargetRaycastSystemOptions = {
|
|
@@ -2569,24 +2525,9 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
|
2569
2525
|
/** @public */
|
|
2570
2526
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
|
2571
2527
|
|
|
2572
|
-
/** @public */
|
|
2573
|
-
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
|
2574
|
-
|
|
2575
2528
|
/** @public */
|
|
2576
2529
|
export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
|
|
2577
2530
|
|
|
2578
|
-
/** @public */
|
|
2579
|
-
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
|
2580
|
-
|
|
2581
|
-
/**
|
|
2582
|
-
* @public
|
|
2583
|
-
*/
|
|
2584
|
-
export declare const enum GltfNodeStateValue {
|
|
2585
|
-
GNSV_PENDING = 0,
|
|
2586
|
-
GNSV_FAILED = 1,
|
|
2587
|
-
GNSV_READY = 2
|
|
2588
|
-
}
|
|
2589
|
-
|
|
2590
2531
|
/**
|
|
2591
2532
|
* @public
|
|
2592
2533
|
*/
|
|
@@ -3290,12 +3231,6 @@ export declare type Listeners = {
|
|
|
3290
3231
|
onMouseEnter?: Callback;
|
|
3291
3232
|
/** triggered on mouse leave event */
|
|
3292
3233
|
onMouseLeave?: Callback;
|
|
3293
|
-
/** triggered while the pointer is dragged after pressing on the element */
|
|
3294
|
-
onMouseDrag?: Callback;
|
|
3295
|
-
/** triggered while the pointer is dragged with the cursor locked in place */
|
|
3296
|
-
onMouseDragLocked?: Callback;
|
|
3297
|
-
/** triggered when a drag that started on the element ends */
|
|
3298
|
-
onMouseDragEnd?: Callback;
|
|
3299
3234
|
};
|
|
3300
3235
|
|
|
3301
3236
|
/**
|
|
@@ -4200,15 +4135,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4200
4135
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4201
4136
|
*/
|
|
4202
4137
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4203
|
-
/**
|
|
4204
|
-
* @public
|
|
4205
|
-
* Set a mesh from inside a gltf in the MeshCollider component
|
|
4206
|
-
* @param entity - entity to create or replace the MeshCollider component
|
|
4207
|
-
* @param source - the path to the gltf
|
|
4208
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4209
|
-
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4210
|
-
*/
|
|
4211
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4212
4138
|
}
|
|
4213
4139
|
|
|
4214
4140
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4245,14 +4171,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4245
4171
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4246
4172
|
*/
|
|
4247
4173
|
setSphere(entity: Entity): void;
|
|
4248
|
-
/**
|
|
4249
|
-
* @public
|
|
4250
|
-
* Set a mesh from inside a gltf in the MeshRenderer component
|
|
4251
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4252
|
-
* @param source - the path to the gltf
|
|
4253
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4254
|
-
*/
|
|
4255
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
4256
4174
|
}
|
|
4257
4175
|
|
|
4258
4176
|
/* Excluded from this release type: MessageBus */
|
|
@@ -4290,39 +4208,6 @@ export declare namespace MoveContinuous {
|
|
|
4290
4208
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4291
4209
|
}
|
|
4292
4210
|
|
|
4293
|
-
/**
|
|
4294
|
-
* Describes the animation the movement scene wants the avatar to play.
|
|
4295
|
-
* One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
|
|
4296
|
-
* When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
|
|
4297
|
-
*/
|
|
4298
|
-
/**
|
|
4299
|
-
* @public
|
|
4300
|
-
*/
|
|
4301
|
-
export declare interface MovementAnimation {
|
|
4302
|
-
/** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
|
|
4303
|
-
src: string;
|
|
4304
|
-
/** whether the clip repeats once it reaches the end */
|
|
4305
|
-
loop: boolean;
|
|
4306
|
-
/** playback speed multiplier (1.0 = clip's native rate) */
|
|
4307
|
-
speed: number;
|
|
4308
|
-
/** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
|
|
4309
|
-
idle: boolean;
|
|
4310
|
-
/** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
|
|
4311
|
-
transitionSeconds?: number | undefined;
|
|
4312
|
-
/** 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. */
|
|
4313
|
-
playbackTime?: number | undefined;
|
|
4314
|
-
/** 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). */
|
|
4315
|
-
sounds: string[];
|
|
4316
|
-
}
|
|
4317
|
-
|
|
4318
|
-
/**
|
|
4319
|
-
* @public
|
|
4320
|
-
*/
|
|
4321
|
-
export declare namespace MovementAnimation {
|
|
4322
|
-
export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
|
|
4323
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
|
|
4324
|
-
}
|
|
4325
|
-
|
|
4326
4211
|
/**
|
|
4327
4212
|
* @public
|
|
4328
4213
|
*/
|
|
@@ -4738,25 +4623,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4738
4623
|
totalVideoLength: number;
|
|
4739
4624
|
}>;
|
|
4740
4625
|
|
|
4741
|
-
/**
|
|
4742
|
-
* @public
|
|
4743
|
-
*/
|
|
4744
|
-
export declare interface Orthographic {
|
|
4745
|
-
/**
|
|
4746
|
-
* vertical extent of the visible range in meters
|
|
4747
|
-
* defaults to 4m
|
|
4748
|
-
*/
|
|
4749
|
-
verticalRange?: number | undefined;
|
|
4750
|
-
}
|
|
4751
|
-
|
|
4752
|
-
/**
|
|
4753
|
-
* @public
|
|
4754
|
-
*/
|
|
4755
|
-
export declare namespace Orthographic {
|
|
4756
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4757
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4758
|
-
}
|
|
4759
|
-
|
|
4760
4626
|
/**
|
|
4761
4627
|
* @public
|
|
4762
4628
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -5106,8 +4972,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
5106
4972
|
export declare interface PBAvatarEquippedData {
|
|
5107
4973
|
wearableUrns: string[];
|
|
5108
4974
|
emoteUrns: string[];
|
|
5109
|
-
/** slots that will render even if hidden */
|
|
5110
|
-
forceRender: string[];
|
|
5111
4975
|
}
|
|
5112
4976
|
|
|
5113
4977
|
/**
|
|
@@ -5178,8 +5042,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
5178
5042
|
excludeIds: string[];
|
|
5179
5043
|
/** list of modifiers to apply */
|
|
5180
5044
|
modifiers: AvatarModifierType[];
|
|
5181
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5182
|
-
useColliderRange?: boolean | undefined;
|
|
5183
5045
|
}
|
|
5184
5046
|
|
|
5185
5047
|
/**
|
|
@@ -5190,64 +5052,6 @@ export declare namespace PBAvatarModifierArea {
|
|
|
5190
5052
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
|
|
5191
5053
|
}
|
|
5192
5054
|
|
|
5193
|
-
/**
|
|
5194
|
-
* @public
|
|
5195
|
-
*/
|
|
5196
|
-
export declare interface PBAvatarMovement {
|
|
5197
|
-
velocity: PBVector3 | undefined;
|
|
5198
|
-
/** 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. */
|
|
5199
|
-
orientation: number;
|
|
5200
|
-
groundDirection?: PBVector3 | undefined;
|
|
5201
|
-
/** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
|
|
5202
|
-
walkSuccess?: boolean | undefined;
|
|
5203
|
-
/** if set, the engine plays this animation instead of selecting one from velocity heuristics */
|
|
5204
|
-
animation?: MovementAnimation | undefined;
|
|
5205
|
-
/** 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. */
|
|
5206
|
-
tiltPitch?: number | undefined;
|
|
5207
|
-
/** 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. */
|
|
5208
|
-
tiltRoll?: number | undefined;
|
|
5209
|
-
}
|
|
5210
|
-
|
|
5211
|
-
/**
|
|
5212
|
-
* @public
|
|
5213
|
-
*/
|
|
5214
|
-
export declare namespace PBAvatarMovement {
|
|
5215
|
-
export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
|
|
5216
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
|
|
5217
|
-
}
|
|
5218
|
-
|
|
5219
|
-
/**
|
|
5220
|
-
* @public
|
|
5221
|
-
*/
|
|
5222
|
-
export declare interface PBAvatarMovementInfo {
|
|
5223
|
-
/** the length of time the current step velocity will apply for */
|
|
5224
|
-
stepTime: number;
|
|
5225
|
-
/** the length of time the previous step velocity applied for */
|
|
5226
|
-
previousStepTime: number;
|
|
5227
|
-
/** the velocity requested for the previous frame */
|
|
5228
|
-
requestedVelocity: PBVector3 | undefined;
|
|
5229
|
-
/** the resulting velocity taking collisions into account */
|
|
5230
|
-
actualVelocity: PBVector3 | undefined;
|
|
5231
|
-
/** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
|
|
5232
|
-
externalVelocity: PBVector3 | undefined;
|
|
5233
|
-
activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
|
|
5234
|
-
activeInputModifier: PBInputModifier | undefined;
|
|
5235
|
-
/** if set, the movement scene should walk the player to this scene-relative position */
|
|
5236
|
-
walkTarget?: PBVector3 | undefined;
|
|
5237
|
-
/** stop distance for walk_target; considered reached when within this distance */
|
|
5238
|
-
walkThreshold?: number | undefined;
|
|
5239
|
-
/** 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. */
|
|
5240
|
-
activeAnimationState?: AvatarAnimationState | undefined;
|
|
5241
|
-
}
|
|
5242
|
-
|
|
5243
|
-
/**
|
|
5244
|
-
* @public
|
|
5245
|
-
*/
|
|
5246
|
-
export declare namespace PBAvatarMovementInfo {
|
|
5247
|
-
export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
|
|
5248
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
|
|
5249
|
-
}
|
|
5250
|
-
|
|
5251
5055
|
/**
|
|
5252
5056
|
* The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
|
|
5253
5057
|
* for example to show a rank or a role that the scene assigns to that player.
|
|
@@ -5338,8 +5142,6 @@ export declare interface PBAvatarShape {
|
|
|
5338
5142
|
emotes: string[];
|
|
5339
5143
|
/** hides the skin + hair + facial features (default: false) */
|
|
5340
5144
|
showOnlyWearables?: boolean | undefined;
|
|
5341
|
-
/** slots that will render even if hidden */
|
|
5342
|
-
forceRender: string[];
|
|
5343
5145
|
}
|
|
5344
5146
|
|
|
5345
5147
|
/**
|
|
@@ -5381,51 +5183,6 @@ export declare namespace PBBillboard {
|
|
|
5381
5183
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
5382
5184
|
}
|
|
5383
5185
|
|
|
5384
|
-
/**
|
|
5385
|
-
* @public
|
|
5386
|
-
*/
|
|
5387
|
-
export declare interface PBCameraLayer {
|
|
5388
|
-
/**
|
|
5389
|
-
* layer to which these settings apply. must be > 0
|
|
5390
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
5391
|
-
*/
|
|
5392
|
-
layer: number;
|
|
5393
|
-
/** should the sun light affect this layer? default false */
|
|
5394
|
-
directionalLight?: boolean | undefined;
|
|
5395
|
-
/** should this layer show player avatars? default false */
|
|
5396
|
-
showAvatars?: boolean | undefined;
|
|
5397
|
-
/** should this layer show the sky? default false */
|
|
5398
|
-
showSkybox?: boolean | undefined;
|
|
5399
|
-
/** should this layer show distance fog? default false */
|
|
5400
|
-
showFog?: boolean | undefined;
|
|
5401
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
5402
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
5403
|
-
ambientBrightnessOverride?: number | undefined;
|
|
5404
|
-
}
|
|
5405
|
-
|
|
5406
|
-
/**
|
|
5407
|
-
* @public
|
|
5408
|
-
*/
|
|
5409
|
-
export declare namespace PBCameraLayer {
|
|
5410
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
5411
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
5412
|
-
}
|
|
5413
|
-
|
|
5414
|
-
/**
|
|
5415
|
-
* @public
|
|
5416
|
-
*/
|
|
5417
|
-
export declare interface PBCameraLayers {
|
|
5418
|
-
layers: number[];
|
|
5419
|
-
}
|
|
5420
|
-
|
|
5421
|
-
/**
|
|
5422
|
-
* @public
|
|
5423
|
-
*/
|
|
5424
|
-
export declare namespace PBCameraLayers {
|
|
5425
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5426
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5427
|
-
}
|
|
5428
|
-
|
|
5429
5186
|
/**
|
|
5430
5187
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5431
5188
|
* third-person view.
|
|
@@ -5467,8 +5224,6 @@ export declare interface PBCameraModeArea {
|
|
|
5467
5224
|
area: PBVector3 | undefined;
|
|
5468
5225
|
/** the camera mode to enforce */
|
|
5469
5226
|
mode: CameraType;
|
|
5470
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5471
|
-
useColliderRange?: boolean | undefined;
|
|
5472
5227
|
}
|
|
5473
5228
|
|
|
5474
5229
|
/**
|
|
@@ -5542,6 +5297,34 @@ export declare namespace PBEngineInfo {
|
|
|
5542
5297
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
5543
5298
|
}
|
|
5544
5299
|
|
|
5300
|
+
/**
|
|
5301
|
+
* PBEnvironmentFog overrides the environment fog while the player is inside the scene.
|
|
5302
|
+
* Valid only on the scene root entity (`engine.RootEntity`).
|
|
5303
|
+
*
|
|
5304
|
+
* An unset field keeps the time-of-day default.
|
|
5305
|
+
* Gradient `time` is the normalized time of day: 0 = 00:00, 0.5 = 12:00, 1 = 24:00.
|
|
5306
|
+
* Gradients do not wrap around midnight.
|
|
5307
|
+
* A scene cannot turn fog on or off. That is a user quality setting.
|
|
5308
|
+
*
|
|
5309
|
+
* While active, the overrides are global: they also change how neighbouring parcels look from inside the scene.
|
|
5310
|
+
*/
|
|
5311
|
+
/**
|
|
5312
|
+
* @public
|
|
5313
|
+
*/
|
|
5314
|
+
export declare interface PBEnvironmentFog {
|
|
5315
|
+
color?: ColorGradient | undefined;
|
|
5316
|
+
/** default = 0.0005, per meter: fog = 1 - e^(-density * distance). Negative values clamp to 0 */
|
|
5317
|
+
density?: number | undefined;
|
|
5318
|
+
}
|
|
5319
|
+
|
|
5320
|
+
/**
|
|
5321
|
+
* @public
|
|
5322
|
+
*/
|
|
5323
|
+
export declare namespace PBEnvironmentFog {
|
|
5324
|
+
export function encode(message: PBEnvironmentFog, writer?: _m0.Writer): _m0.Writer;
|
|
5325
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEnvironmentFog;
|
|
5326
|
+
}
|
|
5327
|
+
|
|
5545
5328
|
/**
|
|
5546
5329
|
* Grow-only value set appended to the scene root entity.
|
|
5547
5330
|
* Reports the outcome of an EU_ITEM_PURCHASE flow triggered via OpenExplorerUi.
|
|
@@ -5682,39 +5465,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
|
|
|
5682
5465
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
|
|
5683
5466
|
}
|
|
5684
5467
|
|
|
5685
|
-
/**
|
|
5686
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5687
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5688
|
-
*/
|
|
5689
|
-
/**
|
|
5690
|
-
* @public
|
|
5691
|
-
*/
|
|
5692
|
-
export declare interface PBGlobalLight {
|
|
5693
|
-
/**
|
|
5694
|
-
* the direction the directional light shines in.
|
|
5695
|
-
* default depends on time of day and explorer implementation
|
|
5696
|
-
*/
|
|
5697
|
-
direction?: PBVector3 | undefined;
|
|
5698
|
-
/**
|
|
5699
|
-
* ambient light color
|
|
5700
|
-
* default: White
|
|
5701
|
-
*/
|
|
5702
|
-
ambientColor?: PBColor3 | undefined;
|
|
5703
|
-
/**
|
|
5704
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5705
|
-
* default 1
|
|
5706
|
-
*/
|
|
5707
|
-
ambientBrightness?: number | undefined;
|
|
5708
|
-
}
|
|
5709
|
-
|
|
5710
|
-
/**
|
|
5711
|
-
* @public
|
|
5712
|
-
*/
|
|
5713
|
-
export declare namespace PBGlobalLight {
|
|
5714
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5715
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5716
|
-
}
|
|
5717
|
-
|
|
5718
5468
|
/**
|
|
5719
5469
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5720
5470
|
*
|
|
@@ -5750,25 +5500,6 @@ export declare namespace PBGltfContainer {
|
|
|
5750
5500
|
*/
|
|
5751
5501
|
export declare interface PBGltfContainerLoadingState {
|
|
5752
5502
|
currentState: LoadingState;
|
|
5753
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5754
|
-
nodePaths: string[];
|
|
5755
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5756
|
-
meshNames: string[];
|
|
5757
|
-
/**
|
|
5758
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5759
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5760
|
-
*/
|
|
5761
|
-
materialNames: string[];
|
|
5762
|
-
/**
|
|
5763
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5764
|
-
* sure all your materials are explicitly named.
|
|
5765
|
-
*/
|
|
5766
|
-
skinNames: string[];
|
|
5767
|
-
/**
|
|
5768
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5769
|
-
* your skins are explicitly named.
|
|
5770
|
-
*/
|
|
5771
|
-
animationNames: string[];
|
|
5772
5503
|
}
|
|
5773
5504
|
|
|
5774
5505
|
/**
|
|
@@ -5779,57 +5510,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5779
5510
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5780
5511
|
}
|
|
5781
5512
|
|
|
5782
|
-
/**
|
|
5783
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5784
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5785
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5786
|
-
* in the parent.
|
|
5787
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5788
|
-
*
|
|
5789
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5790
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5791
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5792
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5793
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5794
|
-
*
|
|
5795
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5796
|
-
*
|
|
5797
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5798
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5799
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5800
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5801
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5802
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5803
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5804
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5805
|
-
* 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
|
|
5806
|
-
* PBMaterial will be maintained.
|
|
5807
|
-
*
|
|
5808
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5809
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5810
|
-
* change the state to `GNS_FAILED`.
|
|
5811
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5812
|
-
*
|
|
5813
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5814
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5815
|
-
* the gltf node will also be displayed.
|
|
5816
|
-
*/
|
|
5817
|
-
/**
|
|
5818
|
-
* @public
|
|
5819
|
-
*/
|
|
5820
|
-
export declare interface PBGltfNode {
|
|
5821
|
-
/** the path of the target node in the Gltf. */
|
|
5822
|
-
path: string;
|
|
5823
|
-
}
|
|
5824
|
-
|
|
5825
|
-
/**
|
|
5826
|
-
* @public
|
|
5827
|
-
*/
|
|
5828
|
-
export declare namespace PBGltfNode {
|
|
5829
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5830
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5831
|
-
}
|
|
5832
|
-
|
|
5833
5513
|
/**
|
|
5834
5514
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5835
5515
|
*
|
|
@@ -5875,26 +5555,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5875
5555
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5876
5556
|
}
|
|
5877
5557
|
|
|
5878
|
-
/**
|
|
5879
|
-
* The state of a linked gltf node.
|
|
5880
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5881
|
-
*/
|
|
5882
|
-
/**
|
|
5883
|
-
* @public
|
|
5884
|
-
*/
|
|
5885
|
-
export declare interface PBGltfNodeState {
|
|
5886
|
-
state: GltfNodeStateValue;
|
|
5887
|
-
error?: string | undefined;
|
|
5888
|
-
}
|
|
5889
|
-
|
|
5890
|
-
/**
|
|
5891
|
-
* @public
|
|
5892
|
-
*/
|
|
5893
|
-
export declare namespace PBGltfNodeState {
|
|
5894
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5895
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5896
|
-
}
|
|
5897
|
-
|
|
5898
5558
|
/**
|
|
5899
5559
|
* @public
|
|
5900
5560
|
*/
|
|
@@ -6032,14 +5692,6 @@ export declare interface PBMaterial {
|
|
|
6032
5692
|
$case: "pbr";
|
|
6033
5693
|
pbr: PBMaterial_PbrMaterial;
|
|
6034
5694
|
} | undefined;
|
|
6035
|
-
/**
|
|
6036
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
6037
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
6038
|
-
* supported by the PbMaterial.
|
|
6039
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
6040
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
6041
|
-
*/
|
|
6042
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
6043
5695
|
}
|
|
6044
5696
|
|
|
6045
5697
|
/**
|
|
@@ -6050,22 +5702,6 @@ export declare namespace PBMaterial {
|
|
|
6050
5702
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
6051
5703
|
}
|
|
6052
5704
|
|
|
6053
|
-
/**
|
|
6054
|
-
* @public
|
|
6055
|
-
*/
|
|
6056
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
6057
|
-
gltfSrc: string;
|
|
6058
|
-
name: string;
|
|
6059
|
-
}
|
|
6060
|
-
|
|
6061
|
-
/**
|
|
6062
|
-
* @public
|
|
6063
|
-
*/
|
|
6064
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
6065
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
6066
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
6067
|
-
}
|
|
6068
|
-
|
|
6069
5705
|
/**
|
|
6070
5706
|
* @public
|
|
6071
5707
|
*/
|
|
@@ -6162,9 +5798,6 @@ export declare interface PBMeshCollider {
|
|
|
6162
5798
|
} | {
|
|
6163
5799
|
$case: "plane";
|
|
6164
5800
|
plane: PBMeshCollider_PlaneMesh;
|
|
6165
|
-
} | {
|
|
6166
|
-
$case: "gltf";
|
|
6167
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
6168
5801
|
} | undefined;
|
|
6169
5802
|
}
|
|
6170
5803
|
|
|
@@ -6210,25 +5843,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
6210
5843
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
6211
5844
|
}
|
|
6212
5845
|
|
|
6213
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
6214
|
-
/**
|
|
6215
|
-
* @public
|
|
6216
|
-
*/
|
|
6217
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
6218
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6219
|
-
gltfSrc: string;
|
|
6220
|
-
/** the name of the mesh asset */
|
|
6221
|
-
name: string;
|
|
6222
|
-
}
|
|
6223
|
-
|
|
6224
|
-
/**
|
|
6225
|
-
* @public
|
|
6226
|
-
*/
|
|
6227
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
6228
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6229
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
6230
|
-
}
|
|
6231
|
-
|
|
6232
5846
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
6233
5847
|
/**
|
|
6234
5848
|
* @public
|
|
@@ -6261,11 +5875,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
6261
5875
|
|
|
6262
5876
|
/**
|
|
6263
5877
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
6264
|
-
* plane, a sphere
|
|
5878
|
+
* plane, a sphere or a cylinder.
|
|
6265
5879
|
*
|
|
6266
5880
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
6267
5881
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
6268
5882
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5883
|
+
*
|
|
5884
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
|
6269
5885
|
*/
|
|
6270
5886
|
/**
|
|
6271
5887
|
* @public
|
|
@@ -6283,9 +5899,6 @@ export declare interface PBMeshRenderer {
|
|
|
6283
5899
|
} | {
|
|
6284
5900
|
$case: "plane";
|
|
6285
5901
|
plane: PBMeshRenderer_PlaneMesh;
|
|
6286
|
-
} | {
|
|
6287
|
-
$case: "gltf";
|
|
6288
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
6289
5902
|
} | undefined;
|
|
6290
5903
|
}
|
|
6291
5904
|
|
|
@@ -6333,25 +5946,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
6333
5946
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
6334
5947
|
}
|
|
6335
5948
|
|
|
6336
|
-
/** A mesh from a Gltf. */
|
|
6337
|
-
/**
|
|
6338
|
-
* @public
|
|
6339
|
-
*/
|
|
6340
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
6341
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6342
|
-
gltfSrc: string;
|
|
6343
|
-
/** the name of the mesh asset */
|
|
6344
|
-
name: string;
|
|
6345
|
-
}
|
|
6346
|
-
|
|
6347
|
-
/**
|
|
6348
|
-
* @public
|
|
6349
|
-
*/
|
|
6350
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
6351
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6352
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
6353
|
-
}
|
|
6354
|
-
|
|
6355
5949
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
6356
5950
|
/**
|
|
6357
5951
|
* @public
|
|
@@ -6948,10 +6542,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
6948
6542
|
screenCoordinates?: PBVector2 | undefined;
|
|
6949
6543
|
/** Movement since last frame (pixels) */
|
|
6950
6544
|
screenDelta?: PBVector2 | undefined;
|
|
6951
|
-
/**
|
|
6952
|
-
* ray direction that can be used with the primary camera origin for
|
|
6953
|
-
* raycasting from the cursor into the world
|
|
6954
|
-
*/
|
|
6545
|
+
/** Direction vector for 3D ray casting */
|
|
6955
6546
|
worldRayDirection?: PBVector3 | undefined;
|
|
6956
6547
|
}
|
|
6957
6548
|
|
|
@@ -7022,10 +6613,6 @@ export declare interface PBRaycast {
|
|
|
7022
6613
|
continuous?: boolean | undefined;
|
|
7023
6614
|
/** Collision mask, by default CL_POINTER | CL_PHYSICS */
|
|
7024
6615
|
collisionMask?: number | undefined;
|
|
7025
|
-
/** shape to cast, default ray */
|
|
7026
|
-
shape?: RaycastShape | undefined;
|
|
7027
|
-
/** include hits with entities from other scenes */
|
|
7028
|
-
includeWorld?: boolean | undefined;
|
|
7029
6616
|
}
|
|
7030
6617
|
|
|
7031
6618
|
/**
|
|
@@ -7095,6 +6682,105 @@ export declare namespace PBRealmInfo {
|
|
|
7095
6682
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
|
7096
6683
|
}
|
|
7097
6684
|
|
|
6685
|
+
/**
|
|
6686
|
+
* PBSkybox overrides the visible sky while the player is inside the scene.
|
|
6687
|
+
* Valid only on the scene root entity (`engine.RootEntity`).
|
|
6688
|
+
*
|
|
6689
|
+
* An unset field keeps the time-of-day default.
|
|
6690
|
+
* Gradient `time` is the normalized time of day: 0 = 00:00, 0.5 = 12:00, 1 = 24:00.
|
|
6691
|
+
* Gradients do not wrap around midnight.
|
|
6692
|
+
* The sun is controlled by `PBSun` and the fog by `PBEnvironmentFog`.
|
|
6693
|
+
*
|
|
6694
|
+
* While active, the overrides are global: they also change how neighbouring parcels look from inside the scene.
|
|
6695
|
+
*/
|
|
6696
|
+
/**
|
|
6697
|
+
* @public
|
|
6698
|
+
*/
|
|
6699
|
+
export declare interface PBSkybox {
|
|
6700
|
+
/**
|
|
6701
|
+
* Replaces the visible sky with an image, given as its source path with the same rules as `Texture.src`.
|
|
6702
|
+
* It must be an equirectangular (latitude-longitude) image with a 2:1 aspect ratio:
|
|
6703
|
+
* the image centre faces +Z, the top row is the zenith and the bottom row the nadir.
|
|
6704
|
+
* Cube cross, 3x2 and six-face layouts are not supported.
|
|
6705
|
+
* The sun, the fog and the ambient lighting do not change: the ambient still follows `sky_colors`.
|
|
6706
|
+
*/
|
|
6707
|
+
skyboxTexture?: string | undefined;
|
|
6708
|
+
/**
|
|
6709
|
+
* Procedural sky colors. They also drive the ambient lighting, also while `skybox_texture` is set.
|
|
6710
|
+
* While `skybox_texture` is set they no longer color the visible sky.
|
|
6711
|
+
*/
|
|
6712
|
+
skyColors?: PBSkybox_SkyColors | undefined;
|
|
6713
|
+
/** Ignored while `skybox_texture` is set. */
|
|
6714
|
+
clouds?: PBSkybox_Clouds | undefined;
|
|
6715
|
+
/** Ignored while `skybox_texture` is set. */
|
|
6716
|
+
stars?: PBSkybox_Stars | undefined;
|
|
6717
|
+
}
|
|
6718
|
+
|
|
6719
|
+
/**
|
|
6720
|
+
* @public
|
|
6721
|
+
*/
|
|
6722
|
+
export declare namespace PBSkybox {
|
|
6723
|
+
export function encode(message: PBSkybox, writer?: _m0.Writer): _m0.Writer;
|
|
6724
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox;
|
|
6725
|
+
}
|
|
6726
|
+
|
|
6727
|
+
/**
|
|
6728
|
+
* @public
|
|
6729
|
+
*/
|
|
6730
|
+
export declare interface PBSkybox_Clouds {
|
|
6731
|
+
/** default = 1, from 0 to 1 */
|
|
6732
|
+
opacity?: number | undefined;
|
|
6733
|
+
/** default = 0.01, in radians per second around the sky axis (0.01 is one turn every ~10 minutes). 0 = static, negative reverses the direction */
|
|
6734
|
+
speed?: number | undefined;
|
|
6735
|
+
color?: ColorGradient | undefined;
|
|
6736
|
+
}
|
|
6737
|
+
|
|
6738
|
+
/**
|
|
6739
|
+
* @public
|
|
6740
|
+
*/
|
|
6741
|
+
export declare namespace PBSkybox_Clouds {
|
|
6742
|
+
export function encode(message: PBSkybox_Clouds, writer?: _m0.Writer): _m0.Writer;
|
|
6743
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox_Clouds;
|
|
6744
|
+
}
|
|
6745
|
+
|
|
6746
|
+
/**
|
|
6747
|
+
* @public
|
|
6748
|
+
*/
|
|
6749
|
+
export declare interface PBSkybox_SkyColors {
|
|
6750
|
+
/** the sky straight up */
|
|
6751
|
+
zenith?: ColorGradient | undefined;
|
|
6752
|
+
/** the broad band of sky around the horizon */
|
|
6753
|
+
horizon?: ColorGradient | undefined;
|
|
6754
|
+
/** The sky below the horizon, visible wherever no terrain covers it (landscape disabled, high altitude). */
|
|
6755
|
+
nadir?: ColorGradient | undefined;
|
|
6756
|
+
/** Narrow glow right on the horizon line, like a sunset glow. Unset = follows `horizon` when that is set. */
|
|
6757
|
+
rim?: ColorGradient | undefined;
|
|
6758
|
+
}
|
|
6759
|
+
|
|
6760
|
+
/**
|
|
6761
|
+
* @public
|
|
6762
|
+
*/
|
|
6763
|
+
export declare namespace PBSkybox_SkyColors {
|
|
6764
|
+
export function encode(message: PBSkybox_SkyColors, writer?: _m0.Writer): _m0.Writer;
|
|
6765
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox_SkyColors;
|
|
6766
|
+
}
|
|
6767
|
+
|
|
6768
|
+
/**
|
|
6769
|
+
* @public
|
|
6770
|
+
*/
|
|
6771
|
+
export declare interface PBSkybox_Stars {
|
|
6772
|
+
/** default = 4.62, multiplier on the star texture (1 = as authored, values above 1 are HDR). 0 hides the stars, negative values clamp to 0. Stars are visible only at night */
|
|
6773
|
+
brightness?: number | undefined;
|
|
6774
|
+
}
|
|
6775
|
+
|
|
6776
|
+
/**
|
|
6777
|
+
* @public
|
|
6778
|
+
*/
|
|
6779
|
+
export declare namespace PBSkybox_Stars {
|
|
6780
|
+
export function encode(message: PBSkybox_Stars, writer?: _m0.Writer): _m0.Writer;
|
|
6781
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox_Stars;
|
|
6782
|
+
}
|
|
6783
|
+
|
|
7098
6784
|
/**
|
|
7099
6785
|
* The SkyboxTime component allows controlling the time of day for the skybox,
|
|
7100
6786
|
* affecting the lighting and appearance of the sky in the scene.
|
|
@@ -7117,6 +6803,42 @@ export declare namespace PBSkyboxTime {
|
|
|
7117
6803
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
|
|
7118
6804
|
}
|
|
7119
6805
|
|
|
6806
|
+
/**
|
|
6807
|
+
* PBSun overrides the directional light (sun and moon) while the player is inside the scene.
|
|
6808
|
+
* Valid only on the scene root entity (`engine.RootEntity`).
|
|
6809
|
+
*
|
|
6810
|
+
* An unset field keeps the time-of-day default.
|
|
6811
|
+
* Gradient `time` is the normalized time of day: 0 = 00:00, 0.5 = 12:00, 1 = 24:00.
|
|
6812
|
+
* Gradients do not wrap around midnight.
|
|
6813
|
+
*
|
|
6814
|
+
* While active, the overrides are global: they also change how neighbouring parcels look from inside the scene.
|
|
6815
|
+
*/
|
|
6816
|
+
/**
|
|
6817
|
+
* @public
|
|
6818
|
+
*/
|
|
6819
|
+
export declare interface PBSun {
|
|
6820
|
+
/** tints the directional light and the sun disc */
|
|
6821
|
+
color?: ColorGradient | undefined;
|
|
6822
|
+
/** default = true. false hides the sun and moon discs and the lens flare, but not their light */
|
|
6823
|
+
visible?: boolean | undefined;
|
|
6824
|
+
/** default = 1, multiplier on the renderer's time-of-day light intensity. Negative values clamp to 0 */
|
|
6825
|
+
intensity?: number | undefined;
|
|
6826
|
+
/**
|
|
6827
|
+
* Direction the sunlight travels, in scene space: (0,-1,0) = sun straight overhead. Normalized by the renderer.
|
|
6828
|
+
* Set = the sun stays fixed at every time of day; its color and intensity still follow the time of day.
|
|
6829
|
+
* Unset or zero = the time-of-day path.
|
|
6830
|
+
*/
|
|
6831
|
+
direction?: PBVector3 | undefined;
|
|
6832
|
+
}
|
|
6833
|
+
|
|
6834
|
+
/**
|
|
6835
|
+
* @public
|
|
6836
|
+
*/
|
|
6837
|
+
export declare namespace PBSun {
|
|
6838
|
+
export function encode(message: PBSun, writer?: _m0.Writer): _m0.Writer;
|
|
6839
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSun;
|
|
6840
|
+
}
|
|
6841
|
+
|
|
7120
6842
|
/**
|
|
7121
6843
|
* The TextShape component renders customizable floating text.
|
|
7122
6844
|
*
|
|
@@ -7183,46 +6905,6 @@ export declare namespace PBTextShape {
|
|
|
7183
6905
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
7184
6906
|
}
|
|
7185
6907
|
|
|
7186
|
-
/**
|
|
7187
|
-
* @public
|
|
7188
|
-
*/
|
|
7189
|
-
export declare interface PBTextureCamera {
|
|
7190
|
-
/** rendered texture width */
|
|
7191
|
-
width?: number | undefined;
|
|
7192
|
-
/** rendered texture height */
|
|
7193
|
-
height?: number | undefined;
|
|
7194
|
-
/**
|
|
7195
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
7196
|
-
* defaults to 0
|
|
7197
|
-
*/
|
|
7198
|
-
layer?: number | undefined;
|
|
7199
|
-
/** default black */
|
|
7200
|
-
clearColor?: PBColor4 | undefined;
|
|
7201
|
-
/** default infinity */
|
|
7202
|
-
farPlane?: number | undefined;
|
|
7203
|
-
mode?: {
|
|
7204
|
-
$case: "perspective";
|
|
7205
|
-
perspective: Perspective;
|
|
7206
|
-
} | {
|
|
7207
|
-
$case: "orthographic";
|
|
7208
|
-
orthographic: Orthographic;
|
|
7209
|
-
} | undefined;
|
|
7210
|
-
/**
|
|
7211
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
7212
|
-
* range: 0 (off) - 1 (full volume)
|
|
7213
|
-
* default: 0
|
|
7214
|
-
*/
|
|
7215
|
-
volume?: number | undefined;
|
|
7216
|
-
}
|
|
7217
|
-
|
|
7218
|
-
/**
|
|
7219
|
-
* @public
|
|
7220
|
-
*/
|
|
7221
|
-
export declare namespace PBTextureCamera {
|
|
7222
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
7223
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
7224
|
-
}
|
|
7225
|
-
|
|
7226
6908
|
/**
|
|
7227
6909
|
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
7228
6910
|
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
@@ -7468,25 +7150,6 @@ export declare namespace PBUiBackground {
|
|
|
7468
7150
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
7469
7151
|
}
|
|
7470
7152
|
|
|
7471
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
7472
|
-
/**
|
|
7473
|
-
* @public
|
|
7474
|
-
*/
|
|
7475
|
-
export declare interface PBUiCanvas {
|
|
7476
|
-
width: number;
|
|
7477
|
-
height: number;
|
|
7478
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
7479
|
-
color?: PBColor4 | undefined;
|
|
7480
|
-
}
|
|
7481
|
-
|
|
7482
|
-
/**
|
|
7483
|
-
* @public
|
|
7484
|
-
*/
|
|
7485
|
-
export declare namespace PBUiCanvas {
|
|
7486
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
7487
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
7488
|
-
}
|
|
7489
|
-
|
|
7490
7153
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
7491
7154
|
/**
|
|
7492
7155
|
* @public
|
|
@@ -7586,10 +7249,6 @@ export declare interface PBUiInput {
|
|
|
7586
7249
|
/** default=10 */
|
|
7587
7250
|
fontSize?: number | undefined;
|
|
7588
7251
|
value?: string | undefined;
|
|
7589
|
-
/** default=false; when true, the input accepts newlines and behaves as a textarea */
|
|
7590
|
-
multiLine?: boolean | undefined;
|
|
7591
|
-
/** default=true; when false, the input value is preserved after pressing Enter */
|
|
7592
|
-
clearOnSubmit?: boolean | undefined;
|
|
7593
7252
|
/** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7594
7253
|
fontSrc?: string | undefined;
|
|
7595
7254
|
}
|
|
@@ -7655,21 +7314,6 @@ export declare namespace PBUiInputResult {
|
|
|
7655
7314
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
7656
7315
|
}
|
|
7657
7316
|
|
|
7658
|
-
/**
|
|
7659
|
-
* @public
|
|
7660
|
-
*/
|
|
7661
|
-
export declare interface PBUiScrollResult {
|
|
7662
|
-
value: PBVector2 | undefined;
|
|
7663
|
-
}
|
|
7664
|
-
|
|
7665
|
-
/**
|
|
7666
|
-
* @public
|
|
7667
|
-
*/
|
|
7668
|
-
export declare namespace PBUiScrollResult {
|
|
7669
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
7670
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
7671
|
-
}
|
|
7672
|
-
|
|
7673
7317
|
/**
|
|
7674
7318
|
* @public
|
|
7675
7319
|
*/
|
|
@@ -7815,12 +7459,6 @@ export declare interface PBUiTransform {
|
|
|
7815
7459
|
borderRightColor?: PBColor4 | undefined;
|
|
7816
7460
|
/** default: 1 */
|
|
7817
7461
|
opacity?: number | undefined;
|
|
7818
|
-
/** reference for scroll_position. default empty */
|
|
7819
|
-
elementId?: string | undefined;
|
|
7820
|
-
/** default position=(0,0) */
|
|
7821
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
7822
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
7823
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
7824
7462
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
7825
7463
|
zIndex?: number | undefined;
|
|
7826
7464
|
}
|
|
@@ -7973,25 +7611,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
7973
7611
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
7974
7612
|
}
|
|
7975
7613
|
|
|
7976
|
-
/**
|
|
7977
|
-
* @public
|
|
7978
|
-
*/
|
|
7979
|
-
export declare interface Perspective {
|
|
7980
|
-
/**
|
|
7981
|
-
* vertical field of view in radians
|
|
7982
|
-
* defaults to pi/4 = 45 degrees
|
|
7983
|
-
*/
|
|
7984
|
-
fieldOfView?: number | undefined;
|
|
7985
|
-
}
|
|
7986
|
-
|
|
7987
|
-
/**
|
|
7988
|
-
* @public
|
|
7989
|
-
*/
|
|
7990
|
-
export declare namespace Perspective {
|
|
7991
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
7992
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
7993
|
-
}
|
|
7994
|
-
|
|
7995
7614
|
/**
|
|
7996
7615
|
* @public
|
|
7997
7616
|
* Physics helpers for applying impulses and forces to the player.
|
|
@@ -8233,24 +7852,6 @@ export declare interface PointerEventsSystem {
|
|
|
8233
7852
|
* @param entity - Entity where the callback was attached
|
|
8234
7853
|
*/
|
|
8235
7854
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
8236
|
-
/**
|
|
8237
|
-
* @public
|
|
8238
|
-
* Remove the callback for onPointerDrag event
|
|
8239
|
-
* @param entity - Entity where the callback was attached
|
|
8240
|
-
*/
|
|
8241
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
8242
|
-
/**
|
|
8243
|
-
* @public
|
|
8244
|
-
* Remove the callback for onPointerDragLocked event
|
|
8245
|
-
* @param entity - Entity where the callback was attached
|
|
8246
|
-
*/
|
|
8247
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
8248
|
-
/**
|
|
8249
|
-
* @public
|
|
8250
|
-
* Remove the callback for onPointerDragEnd event
|
|
8251
|
-
* @param entity - Entity where the callback was attached
|
|
8252
|
-
*/
|
|
8253
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
8254
7855
|
/**
|
|
8255
7856
|
* @public
|
|
8256
7857
|
* Remove the callback for onProximityDown event
|
|
@@ -8329,36 +7930,6 @@ export declare interface PointerEventsSystem {
|
|
|
8329
7930
|
entity: Entity;
|
|
8330
7931
|
opts?: Partial<EventSystemOptions>;
|
|
8331
7932
|
}, cb: EventSystemCallback): void;
|
|
8332
|
-
/**
|
|
8333
|
-
* @public
|
|
8334
|
-
* Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
|
|
8335
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8336
|
-
* @param cb - Function to execute on every drag update
|
|
8337
|
-
*/
|
|
8338
|
-
onPointerDrag(pointerData: {
|
|
8339
|
-
entity: Entity;
|
|
8340
|
-
opts?: Partial<EventSystemOptions>;
|
|
8341
|
-
}, cb: EventSystemCallback): void;
|
|
8342
|
-
/**
|
|
8343
|
-
* @public
|
|
8344
|
-
* Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
|
|
8345
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8346
|
-
* @param cb - Function to execute on every drag update
|
|
8347
|
-
*/
|
|
8348
|
-
onPointerDragLocked(pointerData: {
|
|
8349
|
-
entity: Entity;
|
|
8350
|
-
opts?: Partial<EventSystemOptions>;
|
|
8351
|
-
}, cb: EventSystemCallback): void;
|
|
8352
|
-
/**
|
|
8353
|
-
* @public
|
|
8354
|
-
* Execute callback when the user releases the button after a drag that started on the entity
|
|
8355
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8356
|
-
* @param cb - Function to execute when the drag ends
|
|
8357
|
-
*/
|
|
8358
|
-
onPointerDragEnd(pointerData: {
|
|
8359
|
-
entity: Entity;
|
|
8360
|
-
opts?: Partial<EventSystemOptions>;
|
|
8361
|
-
}, cb: EventSystemCallback): void;
|
|
8362
7933
|
/**
|
|
8363
7934
|
* @public
|
|
8364
7935
|
* Execute callback when the user presses the proximity button on the entity
|
|
@@ -8417,10 +7988,7 @@ export declare const enum PointerEventType {
|
|
|
8417
7988
|
PET_HOVER_ENTER = 2,
|
|
8418
7989
|
PET_HOVER_LEAVE = 3,
|
|
8419
7990
|
PET_PROXIMITY_ENTER = 4,
|
|
8420
|
-
PET_PROXIMITY_LEAVE = 5
|
|
8421
|
-
PET_DRAG_LOCKED = 6,
|
|
8422
|
-
PET_DRAG = 7,
|
|
8423
|
-
PET_DRAG_END = 8
|
|
7991
|
+
PET_PROXIMITY_LEAVE = 5
|
|
8424
7992
|
}
|
|
8425
7993
|
|
|
8426
7994
|
/**
|
|
@@ -8451,10 +8019,7 @@ export declare const enum PointerType {
|
|
|
8451
8019
|
/** POT_NONE - No pointer input */
|
|
8452
8020
|
POT_NONE = 0,
|
|
8453
8021
|
/** POT_MOUSE - Traditional mouse input */
|
|
8454
|
-
POT_MOUSE = 1
|
|
8455
|
-
POT_PAD = 2,
|
|
8456
|
-
POT_TOUCH = 3,
|
|
8457
|
-
POT_WAND = 4
|
|
8022
|
+
POT_MOUSE = 1
|
|
8458
8023
|
}
|
|
8459
8024
|
|
|
8460
8025
|
/**
|
|
@@ -8911,16 +8476,6 @@ export declare const enum RaycastQueryType {
|
|
|
8911
8476
|
/** @public */
|
|
8912
8477
|
export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
|
|
8913
8478
|
|
|
8914
|
-
/**
|
|
8915
|
-
* @public
|
|
8916
|
-
*/
|
|
8917
|
-
export declare const enum RaycastShape {
|
|
8918
|
-
/** RS_RAY - cast a point, get collisions along a ray */
|
|
8919
|
-
RS_RAY = 0,
|
|
8920
|
-
/** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
|
|
8921
|
-
RS_AVATAR = 1
|
|
8922
|
-
}
|
|
8923
|
-
|
|
8924
8479
|
/**
|
|
8925
8480
|
* @public
|
|
8926
8481
|
*/
|
|
@@ -9053,10 +8608,6 @@ export declare type RaycastSystemOptions = {
|
|
|
9053
8608
|
queryType: RaycastQueryType;
|
|
9054
8609
|
continuous?: boolean | undefined;
|
|
9055
8610
|
collisionMask?: number | undefined;
|
|
9056
|
-
/** shape to sweep along the ray, default RS_RAY (a point) */
|
|
9057
|
-
shape?: RaycastShape | undefined;
|
|
9058
|
-
/** include colliders from other scenes, default false */
|
|
9059
|
-
includeWorld?: boolean | undefined;
|
|
9060
8611
|
};
|
|
9061
8612
|
|
|
9062
8613
|
/**
|
|
@@ -9105,20 +8656,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
9105
8656
|
* @param entity - The entity whose UI renderer should be removed
|
|
9106
8657
|
*/
|
|
9107
8658
|
removeUiRenderer(entity: Entity): void;
|
|
9108
|
-
/**
|
|
9109
|
-
* Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
|
|
9110
|
-
* describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
|
|
9111
|
-
* any texture renderer already set on the entity, and is torn down when the entity is removed.
|
|
9112
|
-
*
|
|
9113
|
-
* @param entity - The UiCanvas entity the UI tree hangs from
|
|
9114
|
-
* @param ui - The UI component to render
|
|
9115
|
-
*/
|
|
9116
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
9117
|
-
/**
|
|
9118
|
-
* Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
|
|
9119
|
-
* @param entity - The UiCanvas entity the renderer was set on
|
|
9120
|
-
*/
|
|
9121
|
-
removeTextureRenderer(entity: Entity): void;
|
|
9122
8659
|
}
|
|
9123
8660
|
|
|
9124
8661
|
/**
|
|
@@ -9709,33 +9246,6 @@ export declare namespace Schemas {
|
|
|
9709
9246
|
*/
|
|
9710
9247
|
export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
|
|
9711
9248
|
|
|
9712
|
-
/**
|
|
9713
|
-
* @public
|
|
9714
|
-
*/
|
|
9715
|
-
export declare interface ScrollPositionValue {
|
|
9716
|
-
value?: {
|
|
9717
|
-
$case: "position";
|
|
9718
|
-
position: PBVector2;
|
|
9719
|
-
} | {
|
|
9720
|
-
$case: "reference";
|
|
9721
|
-
reference: string;
|
|
9722
|
-
} | undefined;
|
|
9723
|
-
}
|
|
9724
|
-
|
|
9725
|
-
/**
|
|
9726
|
-
* @public
|
|
9727
|
-
*/
|
|
9728
|
-
export declare namespace ScrollPositionValue {
|
|
9729
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
9730
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
9731
|
-
}
|
|
9732
|
-
|
|
9733
|
-
/**
|
|
9734
|
-
* Which scrollbars are shown when the overflow is scrollable
|
|
9735
|
-
* @public
|
|
9736
|
-
*/
|
|
9737
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
9738
|
-
|
|
9739
9249
|
/**
|
|
9740
9250
|
* Register the composite provider used to resolve composite files. Also registers
|
|
9741
9251
|
* any `provider.schemas` on the engine pre-seal so composites that reference those
|
|
@@ -9761,15 +9271,8 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
|
|
|
9761
9271
|
easingFunction?: EasingFunction;
|
|
9762
9272
|
}
|
|
9763
9273
|
|
|
9764
|
-
/**
|
|
9765
|
-
|
|
9766
|
-
*/
|
|
9767
|
-
export declare const enum ShowScrollBar {
|
|
9768
|
-
SSB_BOTH = 0,
|
|
9769
|
-
SSB_ONLY_VERTICAL = 1,
|
|
9770
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
9771
|
-
SSB_HIDDEN = 3
|
|
9772
|
-
}
|
|
9274
|
+
/** @public */
|
|
9275
|
+
export declare const Skybox: LastWriteWinElementSetComponentDefinition<PBSkybox>;
|
|
9773
9276
|
|
|
9774
9277
|
/** @public */
|
|
9775
9278
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
@@ -9781,6 +9284,9 @@ export declare interface Spec {
|
|
|
9781
9284
|
[key: string]: ISchema;
|
|
9782
9285
|
}
|
|
9783
9286
|
|
|
9287
|
+
/** @public */
|
|
9288
|
+
export declare const Sun: LastWriteWinElementSetComponentDefinition<PBSun>;
|
|
9289
|
+
|
|
9784
9290
|
/* Excluded from this release type: SyncComponents */
|
|
9785
9291
|
|
|
9786
9292
|
/**
|
|
@@ -9877,9 +9383,6 @@ export declare namespace Texture {
|
|
|
9877
9383
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
9878
9384
|
}
|
|
9879
9385
|
|
|
9880
|
-
/** @public */
|
|
9881
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
9882
|
-
|
|
9883
9386
|
/**
|
|
9884
9387
|
* @public
|
|
9885
9388
|
*/
|
|
@@ -9990,9 +9493,6 @@ export declare interface TextureUnion {
|
|
|
9990
9493
|
} | {
|
|
9991
9494
|
$case: "videoTexture";
|
|
9992
9495
|
videoTexture: VideoTexture;
|
|
9993
|
-
} | {
|
|
9994
|
-
$case: "uiTexture";
|
|
9995
|
-
uiTexture: UiCanvasTexture;
|
|
9996
9496
|
} | undefined;
|
|
9997
9497
|
}
|
|
9998
9498
|
|
|
@@ -10531,8 +10031,6 @@ export declare interface UiBackgroundProps {
|
|
|
10531
10031
|
uvs?: number[];
|
|
10532
10032
|
/** AvatarTexture for the background */
|
|
10533
10033
|
avatarTexture?: UiAvatarTexture;
|
|
10534
|
-
/** VideoTexture for the background: the frames of a VideoPlayer on another entity */
|
|
10535
|
-
videoTexture?: UiVideoTexture;
|
|
10536
10034
|
/** Texture for the background */
|
|
10537
10035
|
texture?: UiTexture;
|
|
10538
10036
|
}
|
|
@@ -10552,31 +10050,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
10552
10050
|
disabled?: boolean;
|
|
10553
10051
|
}
|
|
10554
10052
|
|
|
10555
|
-
/** @public */
|
|
10556
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
10557
|
-
|
|
10558
10053
|
/** @public */
|
|
10559
10054
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
10560
10055
|
|
|
10561
|
-
/**
|
|
10562
|
-
* @public
|
|
10563
|
-
*/
|
|
10564
|
-
export declare interface UiCanvasTexture {
|
|
10565
|
-
uiCanvasEntity: number;
|
|
10566
|
-
/** default = TextureWrapMode.Clamp */
|
|
10567
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
10568
|
-
/** default = FilterMode.Bilinear */
|
|
10569
|
-
filterMode?: TextureFilterMode | undefined;
|
|
10570
|
-
}
|
|
10571
|
-
|
|
10572
|
-
/**
|
|
10573
|
-
* @public
|
|
10574
|
-
*/
|
|
10575
|
-
export declare namespace UiCanvasTexture {
|
|
10576
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
10577
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
10578
|
-
}
|
|
10579
|
-
|
|
10580
10056
|
/**
|
|
10581
10057
|
* @public
|
|
10582
10058
|
*/
|
|
@@ -10672,7 +10148,7 @@ export declare interface UiLabelProps {
|
|
|
10672
10148
|
textAlign?: TextAlignType | undefined;
|
|
10673
10149
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
10674
10150
|
font?: UiFontType | undefined;
|
|
10675
|
-
/**
|
|
10151
|
+
/** Path to a `.ttf` file in the scene content. `font` is used when it can't be loaded. */
|
|
10676
10152
|
fontSrc?: string | undefined;
|
|
10677
10153
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
10678
10154
|
textWrap?: UiTextWrapType | undefined;
|
|
@@ -10742,9 +10218,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
|
|
|
10742
10218
|
uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
|
|
10743
10219
|
};
|
|
10744
10220
|
|
|
10745
|
-
/** @public */
|
|
10746
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
10747
|
-
|
|
10748
10221
|
/** @public */
|
|
10749
10222
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
10750
10223
|
|
|
@@ -10824,22 +10297,6 @@ export declare interface UiTransformProps {
|
|
|
10824
10297
|
opacity?: number;
|
|
10825
10298
|
/** default 0 */
|
|
10826
10299
|
zIndex?: number;
|
|
10827
|
-
/** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
|
|
10828
|
-
elementId?: string;
|
|
10829
|
-
/** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
|
|
10830
|
-
scrollPosition?: PBVector2 | string;
|
|
10831
|
-
/** Which scrollbars to show when overflow is 'scroll'. default 'both' */
|
|
10832
|
-
scrollVisible?: ScrollVisibleType;
|
|
10833
|
-
}
|
|
10834
|
-
|
|
10835
|
-
/**
|
|
10836
|
-
* Video Texture
|
|
10837
|
-
* @public
|
|
10838
|
-
*/
|
|
10839
|
-
export declare interface UiVideoTexture {
|
|
10840
|
-
videoPlayerEntity: Entity;
|
|
10841
|
-
wrapMode?: TextureWrapType;
|
|
10842
|
-
filterMode?: TextureFilterType;
|
|
10843
10300
|
}
|
|
10844
10301
|
|
|
10845
10302
|
/**
|