@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/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>;
|
|
@@ -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
|
*/
|
|
@@ -3299,12 +3240,6 @@ export declare type Listeners = {
|
|
|
3299
3240
|
onMouseEnter?: Callback;
|
|
3300
3241
|
/** triggered on mouse leave event */
|
|
3301
3242
|
onMouseLeave?: Callback;
|
|
3302
|
-
/** triggered while the pointer is dragged after pressing on the element */
|
|
3303
|
-
onMouseDrag?: Callback;
|
|
3304
|
-
/** triggered while the pointer is dragged with the cursor locked in place */
|
|
3305
|
-
onMouseDragLocked?: Callback;
|
|
3306
|
-
/** triggered when a drag that started on the element ends */
|
|
3307
|
-
onMouseDragEnd?: Callback;
|
|
3308
3243
|
};
|
|
3309
3244
|
|
|
3310
3245
|
/**
|
|
@@ -4209,15 +4144,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4209
4144
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4210
4145
|
*/
|
|
4211
4146
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4212
|
-
/**
|
|
4213
|
-
* @public
|
|
4214
|
-
* Set a mesh from inside a gltf in the MeshCollider component
|
|
4215
|
-
* @param entity - entity to create or replace the MeshCollider component
|
|
4216
|
-
* @param source - the path to the gltf
|
|
4217
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4218
|
-
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4219
|
-
*/
|
|
4220
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4221
4147
|
}
|
|
4222
4148
|
|
|
4223
4149
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4254,14 +4180,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4254
4180
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4255
4181
|
*/
|
|
4256
4182
|
setSphere(entity: Entity): void;
|
|
4257
|
-
/**
|
|
4258
|
-
* @public
|
|
4259
|
-
* Set a mesh from inside a gltf in the MeshRenderer component
|
|
4260
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4261
|
-
* @param source - the path to the gltf
|
|
4262
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4263
|
-
*/
|
|
4264
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
4265
4183
|
}
|
|
4266
4184
|
|
|
4267
4185
|
/**
|
|
@@ -4310,39 +4228,6 @@ export declare namespace MoveContinuous {
|
|
|
4310
4228
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4311
4229
|
}
|
|
4312
4230
|
|
|
4313
|
-
/**
|
|
4314
|
-
* Describes the animation the movement scene wants the avatar to play.
|
|
4315
|
-
* One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
|
|
4316
|
-
* When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
|
|
4317
|
-
*/
|
|
4318
|
-
/**
|
|
4319
|
-
* @public
|
|
4320
|
-
*/
|
|
4321
|
-
export declare interface MovementAnimation {
|
|
4322
|
-
/** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
|
|
4323
|
-
src: string;
|
|
4324
|
-
/** whether the clip repeats once it reaches the end */
|
|
4325
|
-
loop: boolean;
|
|
4326
|
-
/** playback speed multiplier (1.0 = clip's native rate) */
|
|
4327
|
-
speed: number;
|
|
4328
|
-
/** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
|
|
4329
|
-
idle: boolean;
|
|
4330
|
-
/** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
|
|
4331
|
-
transitionSeconds?: number | undefined;
|
|
4332
|
-
/** 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. */
|
|
4333
|
-
playbackTime?: number | undefined;
|
|
4334
|
-
/** 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). */
|
|
4335
|
-
sounds: string[];
|
|
4336
|
-
}
|
|
4337
|
-
|
|
4338
|
-
/**
|
|
4339
|
-
* @public
|
|
4340
|
-
*/
|
|
4341
|
-
export declare namespace MovementAnimation {
|
|
4342
|
-
export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
|
|
4343
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
|
|
4344
|
-
}
|
|
4345
|
-
|
|
4346
4231
|
/**
|
|
4347
4232
|
* @public
|
|
4348
4233
|
*/
|
|
@@ -4766,25 +4651,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4766
4651
|
totalVideoLength: number;
|
|
4767
4652
|
}>;
|
|
4768
4653
|
|
|
4769
|
-
/**
|
|
4770
|
-
* @public
|
|
4771
|
-
*/
|
|
4772
|
-
export declare interface Orthographic {
|
|
4773
|
-
/**
|
|
4774
|
-
* vertical extent of the visible range in meters
|
|
4775
|
-
* defaults to 4m
|
|
4776
|
-
*/
|
|
4777
|
-
verticalRange?: number | undefined;
|
|
4778
|
-
}
|
|
4779
|
-
|
|
4780
|
-
/**
|
|
4781
|
-
* @public
|
|
4782
|
-
*/
|
|
4783
|
-
export declare namespace Orthographic {
|
|
4784
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4785
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4786
|
-
}
|
|
4787
|
-
|
|
4788
4654
|
/**
|
|
4789
4655
|
* @public
|
|
4790
4656
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -5134,8 +5000,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
5134
5000
|
export declare interface PBAvatarEquippedData {
|
|
5135
5001
|
wearableUrns: string[];
|
|
5136
5002
|
emoteUrns: string[];
|
|
5137
|
-
/** slots that will render even if hidden */
|
|
5138
|
-
forceRender: string[];
|
|
5139
5003
|
}
|
|
5140
5004
|
|
|
5141
5005
|
/**
|
|
@@ -5206,8 +5070,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
5206
5070
|
excludeIds: string[];
|
|
5207
5071
|
/** list of modifiers to apply */
|
|
5208
5072
|
modifiers: AvatarModifierType[];
|
|
5209
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5210
|
-
useColliderRange?: boolean | undefined;
|
|
5211
5073
|
}
|
|
5212
5074
|
|
|
5213
5075
|
/**
|
|
@@ -5218,64 +5080,6 @@ export declare namespace PBAvatarModifierArea {
|
|
|
5218
5080
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
|
|
5219
5081
|
}
|
|
5220
5082
|
|
|
5221
|
-
/**
|
|
5222
|
-
* @public
|
|
5223
|
-
*/
|
|
5224
|
-
export declare interface PBAvatarMovement {
|
|
5225
|
-
velocity: PBVector3 | undefined;
|
|
5226
|
-
/** 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. */
|
|
5227
|
-
orientation: number;
|
|
5228
|
-
groundDirection?: PBVector3 | undefined;
|
|
5229
|
-
/** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
|
|
5230
|
-
walkSuccess?: boolean | undefined;
|
|
5231
|
-
/** if set, the engine plays this animation instead of selecting one from velocity heuristics */
|
|
5232
|
-
animation?: MovementAnimation | undefined;
|
|
5233
|
-
/** 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. */
|
|
5234
|
-
tiltPitch?: number | undefined;
|
|
5235
|
-
/** 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. */
|
|
5236
|
-
tiltRoll?: number | undefined;
|
|
5237
|
-
}
|
|
5238
|
-
|
|
5239
|
-
/**
|
|
5240
|
-
* @public
|
|
5241
|
-
*/
|
|
5242
|
-
export declare namespace PBAvatarMovement {
|
|
5243
|
-
export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
|
|
5244
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
|
|
5245
|
-
}
|
|
5246
|
-
|
|
5247
|
-
/**
|
|
5248
|
-
* @public
|
|
5249
|
-
*/
|
|
5250
|
-
export declare interface PBAvatarMovementInfo {
|
|
5251
|
-
/** the length of time the current step velocity will apply for */
|
|
5252
|
-
stepTime: number;
|
|
5253
|
-
/** the length of time the previous step velocity applied for */
|
|
5254
|
-
previousStepTime: number;
|
|
5255
|
-
/** the velocity requested for the previous frame */
|
|
5256
|
-
requestedVelocity: PBVector3 | undefined;
|
|
5257
|
-
/** the resulting velocity taking collisions into account */
|
|
5258
|
-
actualVelocity: PBVector3 | undefined;
|
|
5259
|
-
/** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
|
|
5260
|
-
externalVelocity: PBVector3 | undefined;
|
|
5261
|
-
activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
|
|
5262
|
-
activeInputModifier: PBInputModifier | undefined;
|
|
5263
|
-
/** if set, the movement scene should walk the player to this scene-relative position */
|
|
5264
|
-
walkTarget?: PBVector3 | undefined;
|
|
5265
|
-
/** stop distance for walk_target; considered reached when within this distance */
|
|
5266
|
-
walkThreshold?: number | undefined;
|
|
5267
|
-
/** 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. */
|
|
5268
|
-
activeAnimationState?: AvatarAnimationState | undefined;
|
|
5269
|
-
}
|
|
5270
|
-
|
|
5271
|
-
/**
|
|
5272
|
-
* @public
|
|
5273
|
-
*/
|
|
5274
|
-
export declare namespace PBAvatarMovementInfo {
|
|
5275
|
-
export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
|
|
5276
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
|
|
5277
|
-
}
|
|
5278
|
-
|
|
5279
5083
|
/**
|
|
5280
5084
|
* The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
|
|
5281
5085
|
* for example to show a rank or a role that the scene assigns to that player.
|
|
@@ -5366,8 +5170,6 @@ export declare interface PBAvatarShape {
|
|
|
5366
5170
|
emotes: string[];
|
|
5367
5171
|
/** hides the skin + hair + facial features (default: false) */
|
|
5368
5172
|
showOnlyWearables?: boolean | undefined;
|
|
5369
|
-
/** slots that will render even if hidden */
|
|
5370
|
-
forceRender: string[];
|
|
5371
5173
|
}
|
|
5372
5174
|
|
|
5373
5175
|
/**
|
|
@@ -5409,51 +5211,6 @@ export declare namespace PBBillboard {
|
|
|
5409
5211
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
5410
5212
|
}
|
|
5411
5213
|
|
|
5412
|
-
/**
|
|
5413
|
-
* @public
|
|
5414
|
-
*/
|
|
5415
|
-
export declare interface PBCameraLayer {
|
|
5416
|
-
/**
|
|
5417
|
-
* layer to which these settings apply. must be > 0
|
|
5418
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
5419
|
-
*/
|
|
5420
|
-
layer: number;
|
|
5421
|
-
/** should the sun light affect this layer? default false */
|
|
5422
|
-
directionalLight?: boolean | undefined;
|
|
5423
|
-
/** should this layer show player avatars? default false */
|
|
5424
|
-
showAvatars?: boolean | undefined;
|
|
5425
|
-
/** should this layer show the sky? default false */
|
|
5426
|
-
showSkybox?: boolean | undefined;
|
|
5427
|
-
/** should this layer show distance fog? default false */
|
|
5428
|
-
showFog?: boolean | undefined;
|
|
5429
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
5430
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
5431
|
-
ambientBrightnessOverride?: number | undefined;
|
|
5432
|
-
}
|
|
5433
|
-
|
|
5434
|
-
/**
|
|
5435
|
-
* @public
|
|
5436
|
-
*/
|
|
5437
|
-
export declare namespace PBCameraLayer {
|
|
5438
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
5439
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
5440
|
-
}
|
|
5441
|
-
|
|
5442
|
-
/**
|
|
5443
|
-
* @public
|
|
5444
|
-
*/
|
|
5445
|
-
export declare interface PBCameraLayers {
|
|
5446
|
-
layers: number[];
|
|
5447
|
-
}
|
|
5448
|
-
|
|
5449
|
-
/**
|
|
5450
|
-
* @public
|
|
5451
|
-
*/
|
|
5452
|
-
export declare namespace PBCameraLayers {
|
|
5453
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5454
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5455
|
-
}
|
|
5456
|
-
|
|
5457
5214
|
/**
|
|
5458
5215
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5459
5216
|
* third-person view.
|
|
@@ -5495,8 +5252,6 @@ export declare interface PBCameraModeArea {
|
|
|
5495
5252
|
area: PBVector3 | undefined;
|
|
5496
5253
|
/** the camera mode to enforce */
|
|
5497
5254
|
mode: CameraType;
|
|
5498
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5499
|
-
useColliderRange?: boolean | undefined;
|
|
5500
5255
|
}
|
|
5501
5256
|
|
|
5502
5257
|
/**
|
|
@@ -5570,6 +5325,34 @@ export declare namespace PBEngineInfo {
|
|
|
5570
5325
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
5571
5326
|
}
|
|
5572
5327
|
|
|
5328
|
+
/**
|
|
5329
|
+
* PBEnvironmentFog overrides the environment fog while the player is inside the scene.
|
|
5330
|
+
* Valid only on the scene root entity (`engine.RootEntity`).
|
|
5331
|
+
*
|
|
5332
|
+
* An unset field keeps the time-of-day default.
|
|
5333
|
+
* Gradient `time` is the normalized time of day: 0 = 00:00, 0.5 = 12:00, 1 = 24:00.
|
|
5334
|
+
* Gradients do not wrap around midnight.
|
|
5335
|
+
* A scene cannot turn fog on or off. That is a user quality setting.
|
|
5336
|
+
*
|
|
5337
|
+
* While active, the overrides are global: they also change how neighbouring parcels look from inside the scene.
|
|
5338
|
+
*/
|
|
5339
|
+
/**
|
|
5340
|
+
* @public
|
|
5341
|
+
*/
|
|
5342
|
+
export declare interface PBEnvironmentFog {
|
|
5343
|
+
color?: ColorGradient | undefined;
|
|
5344
|
+
/** default = 0.0005, per meter: fog = 1 - e^(-density * distance). Negative values clamp to 0 */
|
|
5345
|
+
density?: number | undefined;
|
|
5346
|
+
}
|
|
5347
|
+
|
|
5348
|
+
/**
|
|
5349
|
+
* @public
|
|
5350
|
+
*/
|
|
5351
|
+
export declare namespace PBEnvironmentFog {
|
|
5352
|
+
export function encode(message: PBEnvironmentFog, writer?: _m0.Writer): _m0.Writer;
|
|
5353
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEnvironmentFog;
|
|
5354
|
+
}
|
|
5355
|
+
|
|
5573
5356
|
/**
|
|
5574
5357
|
* Grow-only value set appended to the scene root entity.
|
|
5575
5358
|
* Reports the outcome of an EU_ITEM_PURCHASE flow triggered via OpenExplorerUi.
|
|
@@ -5710,39 +5493,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
|
|
|
5710
5493
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
|
|
5711
5494
|
}
|
|
5712
5495
|
|
|
5713
|
-
/**
|
|
5714
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5715
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5716
|
-
*/
|
|
5717
|
-
/**
|
|
5718
|
-
* @public
|
|
5719
|
-
*/
|
|
5720
|
-
export declare interface PBGlobalLight {
|
|
5721
|
-
/**
|
|
5722
|
-
* the direction the directional light shines in.
|
|
5723
|
-
* default depends on time of day and explorer implementation
|
|
5724
|
-
*/
|
|
5725
|
-
direction?: PBVector3 | undefined;
|
|
5726
|
-
/**
|
|
5727
|
-
* ambient light color
|
|
5728
|
-
* default: White
|
|
5729
|
-
*/
|
|
5730
|
-
ambientColor?: PBColor3 | undefined;
|
|
5731
|
-
/**
|
|
5732
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5733
|
-
* default 1
|
|
5734
|
-
*/
|
|
5735
|
-
ambientBrightness?: number | undefined;
|
|
5736
|
-
}
|
|
5737
|
-
|
|
5738
|
-
/**
|
|
5739
|
-
* @public
|
|
5740
|
-
*/
|
|
5741
|
-
export declare namespace PBGlobalLight {
|
|
5742
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5743
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5744
|
-
}
|
|
5745
|
-
|
|
5746
5496
|
/**
|
|
5747
5497
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5748
5498
|
*
|
|
@@ -5778,25 +5528,6 @@ export declare namespace PBGltfContainer {
|
|
|
5778
5528
|
*/
|
|
5779
5529
|
export declare interface PBGltfContainerLoadingState {
|
|
5780
5530
|
currentState: LoadingState;
|
|
5781
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5782
|
-
nodePaths: string[];
|
|
5783
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5784
|
-
meshNames: string[];
|
|
5785
|
-
/**
|
|
5786
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5787
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5788
|
-
*/
|
|
5789
|
-
materialNames: string[];
|
|
5790
|
-
/**
|
|
5791
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5792
|
-
* sure all your materials are explicitly named.
|
|
5793
|
-
*/
|
|
5794
|
-
skinNames: string[];
|
|
5795
|
-
/**
|
|
5796
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5797
|
-
* your skins are explicitly named.
|
|
5798
|
-
*/
|
|
5799
|
-
animationNames: string[];
|
|
5800
5531
|
}
|
|
5801
5532
|
|
|
5802
5533
|
/**
|
|
@@ -5807,57 +5538,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5807
5538
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5808
5539
|
}
|
|
5809
5540
|
|
|
5810
|
-
/**
|
|
5811
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5812
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5813
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5814
|
-
* in the parent.
|
|
5815
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5816
|
-
*
|
|
5817
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5818
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5819
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5820
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5821
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5822
|
-
*
|
|
5823
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5824
|
-
*
|
|
5825
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5826
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5827
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5828
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5829
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5830
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5831
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5832
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5833
|
-
* 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
|
|
5834
|
-
* PBMaterial will be maintained.
|
|
5835
|
-
*
|
|
5836
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5837
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5838
|
-
* change the state to `GNS_FAILED`.
|
|
5839
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5840
|
-
*
|
|
5841
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5842
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5843
|
-
* the gltf node will also be displayed.
|
|
5844
|
-
*/
|
|
5845
|
-
/**
|
|
5846
|
-
* @public
|
|
5847
|
-
*/
|
|
5848
|
-
export declare interface PBGltfNode {
|
|
5849
|
-
/** the path of the target node in the Gltf. */
|
|
5850
|
-
path: string;
|
|
5851
|
-
}
|
|
5852
|
-
|
|
5853
|
-
/**
|
|
5854
|
-
* @public
|
|
5855
|
-
*/
|
|
5856
|
-
export declare namespace PBGltfNode {
|
|
5857
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5858
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5859
|
-
}
|
|
5860
|
-
|
|
5861
5541
|
/**
|
|
5862
5542
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5863
5543
|
*
|
|
@@ -5903,26 +5583,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5903
5583
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5904
5584
|
}
|
|
5905
5585
|
|
|
5906
|
-
/**
|
|
5907
|
-
* The state of a linked gltf node.
|
|
5908
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5909
|
-
*/
|
|
5910
|
-
/**
|
|
5911
|
-
* @public
|
|
5912
|
-
*/
|
|
5913
|
-
export declare interface PBGltfNodeState {
|
|
5914
|
-
state: GltfNodeStateValue;
|
|
5915
|
-
error?: string | undefined;
|
|
5916
|
-
}
|
|
5917
|
-
|
|
5918
|
-
/**
|
|
5919
|
-
* @public
|
|
5920
|
-
*/
|
|
5921
|
-
export declare namespace PBGltfNodeState {
|
|
5922
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5923
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5924
|
-
}
|
|
5925
|
-
|
|
5926
5586
|
/**
|
|
5927
5587
|
* @public
|
|
5928
5588
|
*/
|
|
@@ -6060,14 +5720,6 @@ export declare interface PBMaterial {
|
|
|
6060
5720
|
$case: "pbr";
|
|
6061
5721
|
pbr: PBMaterial_PbrMaterial;
|
|
6062
5722
|
} | undefined;
|
|
6063
|
-
/**
|
|
6064
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
6065
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
6066
|
-
* supported by the PbMaterial.
|
|
6067
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
6068
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
6069
|
-
*/
|
|
6070
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
6071
5723
|
}
|
|
6072
5724
|
|
|
6073
5725
|
/**
|
|
@@ -6078,22 +5730,6 @@ export declare namespace PBMaterial {
|
|
|
6078
5730
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
6079
5731
|
}
|
|
6080
5732
|
|
|
6081
|
-
/**
|
|
6082
|
-
* @public
|
|
6083
|
-
*/
|
|
6084
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
6085
|
-
gltfSrc: string;
|
|
6086
|
-
name: string;
|
|
6087
|
-
}
|
|
6088
|
-
|
|
6089
|
-
/**
|
|
6090
|
-
* @public
|
|
6091
|
-
*/
|
|
6092
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
6093
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
6094
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
6095
|
-
}
|
|
6096
|
-
|
|
6097
5733
|
/**
|
|
6098
5734
|
* @public
|
|
6099
5735
|
*/
|
|
@@ -6190,9 +5826,6 @@ export declare interface PBMeshCollider {
|
|
|
6190
5826
|
} | {
|
|
6191
5827
|
$case: "plane";
|
|
6192
5828
|
plane: PBMeshCollider_PlaneMesh;
|
|
6193
|
-
} | {
|
|
6194
|
-
$case: "gltf";
|
|
6195
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
6196
5829
|
} | undefined;
|
|
6197
5830
|
}
|
|
6198
5831
|
|
|
@@ -6238,25 +5871,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
6238
5871
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
6239
5872
|
}
|
|
6240
5873
|
|
|
6241
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
6242
|
-
/**
|
|
6243
|
-
* @public
|
|
6244
|
-
*/
|
|
6245
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
6246
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6247
|
-
gltfSrc: string;
|
|
6248
|
-
/** the name of the mesh asset */
|
|
6249
|
-
name: string;
|
|
6250
|
-
}
|
|
6251
|
-
|
|
6252
|
-
/**
|
|
6253
|
-
* @public
|
|
6254
|
-
*/
|
|
6255
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
6256
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6257
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
6258
|
-
}
|
|
6259
|
-
|
|
6260
5874
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
6261
5875
|
/**
|
|
6262
5876
|
* @public
|
|
@@ -6289,11 +5903,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
6289
5903
|
|
|
6290
5904
|
/**
|
|
6291
5905
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
6292
|
-
* plane, a sphere
|
|
5906
|
+
* plane, a sphere or a cylinder.
|
|
6293
5907
|
*
|
|
6294
5908
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
6295
5909
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
6296
5910
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5911
|
+
*
|
|
5912
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
|
6297
5913
|
*/
|
|
6298
5914
|
/**
|
|
6299
5915
|
* @public
|
|
@@ -6311,9 +5927,6 @@ export declare interface PBMeshRenderer {
|
|
|
6311
5927
|
} | {
|
|
6312
5928
|
$case: "plane";
|
|
6313
5929
|
plane: PBMeshRenderer_PlaneMesh;
|
|
6314
|
-
} | {
|
|
6315
|
-
$case: "gltf";
|
|
6316
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
6317
5930
|
} | undefined;
|
|
6318
5931
|
}
|
|
6319
5932
|
|
|
@@ -6361,25 +5974,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
6361
5974
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
6362
5975
|
}
|
|
6363
5976
|
|
|
6364
|
-
/** A mesh from a Gltf. */
|
|
6365
|
-
/**
|
|
6366
|
-
* @public
|
|
6367
|
-
*/
|
|
6368
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
6369
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6370
|
-
gltfSrc: string;
|
|
6371
|
-
/** the name of the mesh asset */
|
|
6372
|
-
name: string;
|
|
6373
|
-
}
|
|
6374
|
-
|
|
6375
|
-
/**
|
|
6376
|
-
* @public
|
|
6377
|
-
*/
|
|
6378
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
6379
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6380
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
6381
|
-
}
|
|
6382
|
-
|
|
6383
5977
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
6384
5978
|
/**
|
|
6385
5979
|
* @public
|
|
@@ -6976,10 +6570,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
6976
6570
|
screenCoordinates?: PBVector2 | undefined;
|
|
6977
6571
|
/** Movement since last frame (pixels) */
|
|
6978
6572
|
screenDelta?: PBVector2 | undefined;
|
|
6979
|
-
/**
|
|
6980
|
-
* ray direction that can be used with the primary camera origin for
|
|
6981
|
-
* raycasting from the cursor into the world
|
|
6982
|
-
*/
|
|
6573
|
+
/** Direction vector for 3D ray casting */
|
|
6983
6574
|
worldRayDirection?: PBVector3 | undefined;
|
|
6984
6575
|
}
|
|
6985
6576
|
|
|
@@ -7050,10 +6641,6 @@ export declare interface PBRaycast {
|
|
|
7050
6641
|
continuous?: boolean | undefined;
|
|
7051
6642
|
/** Collision mask, by default CL_POINTER | CL_PHYSICS */
|
|
7052
6643
|
collisionMask?: number | undefined;
|
|
7053
|
-
/** shape to cast, default ray */
|
|
7054
|
-
shape?: RaycastShape | undefined;
|
|
7055
|
-
/** include hits with entities from other scenes */
|
|
7056
|
-
includeWorld?: boolean | undefined;
|
|
7057
6644
|
}
|
|
7058
6645
|
|
|
7059
6646
|
/**
|
|
@@ -7123,6 +6710,105 @@ export declare namespace PBRealmInfo {
|
|
|
7123
6710
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
|
7124
6711
|
}
|
|
7125
6712
|
|
|
6713
|
+
/**
|
|
6714
|
+
* PBSkybox overrides the visible sky while the player is inside the scene.
|
|
6715
|
+
* Valid only on the scene root entity (`engine.RootEntity`).
|
|
6716
|
+
*
|
|
6717
|
+
* An unset field keeps the time-of-day default.
|
|
6718
|
+
* Gradient `time` is the normalized time of day: 0 = 00:00, 0.5 = 12:00, 1 = 24:00.
|
|
6719
|
+
* Gradients do not wrap around midnight.
|
|
6720
|
+
* The sun is controlled by `PBSun` and the fog by `PBEnvironmentFog`.
|
|
6721
|
+
*
|
|
6722
|
+
* While active, the overrides are global: they also change how neighbouring parcels look from inside the scene.
|
|
6723
|
+
*/
|
|
6724
|
+
/**
|
|
6725
|
+
* @public
|
|
6726
|
+
*/
|
|
6727
|
+
export declare interface PBSkybox {
|
|
6728
|
+
/**
|
|
6729
|
+
* Replaces the visible sky with an image, given as its source path with the same rules as `Texture.src`.
|
|
6730
|
+
* It must be an equirectangular (latitude-longitude) image with a 2:1 aspect ratio:
|
|
6731
|
+
* the image centre faces +Z, the top row is the zenith and the bottom row the nadir.
|
|
6732
|
+
* Cube cross, 3x2 and six-face layouts are not supported.
|
|
6733
|
+
* The sun, the fog and the ambient lighting do not change: the ambient still follows `sky_colors`.
|
|
6734
|
+
*/
|
|
6735
|
+
skyboxTexture?: string | undefined;
|
|
6736
|
+
/**
|
|
6737
|
+
* Procedural sky colors. They also drive the ambient lighting, also while `skybox_texture` is set.
|
|
6738
|
+
* While `skybox_texture` is set they no longer color the visible sky.
|
|
6739
|
+
*/
|
|
6740
|
+
skyColors?: PBSkybox_SkyColors | undefined;
|
|
6741
|
+
/** Ignored while `skybox_texture` is set. */
|
|
6742
|
+
clouds?: PBSkybox_Clouds | undefined;
|
|
6743
|
+
/** Ignored while `skybox_texture` is set. */
|
|
6744
|
+
stars?: PBSkybox_Stars | undefined;
|
|
6745
|
+
}
|
|
6746
|
+
|
|
6747
|
+
/**
|
|
6748
|
+
* @public
|
|
6749
|
+
*/
|
|
6750
|
+
export declare namespace PBSkybox {
|
|
6751
|
+
export function encode(message: PBSkybox, writer?: _m0.Writer): _m0.Writer;
|
|
6752
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox;
|
|
6753
|
+
}
|
|
6754
|
+
|
|
6755
|
+
/**
|
|
6756
|
+
* @public
|
|
6757
|
+
*/
|
|
6758
|
+
export declare interface PBSkybox_Clouds {
|
|
6759
|
+
/** default = 1, from 0 to 1 */
|
|
6760
|
+
opacity?: number | undefined;
|
|
6761
|
+
/** 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 */
|
|
6762
|
+
speed?: number | undefined;
|
|
6763
|
+
color?: ColorGradient | undefined;
|
|
6764
|
+
}
|
|
6765
|
+
|
|
6766
|
+
/**
|
|
6767
|
+
* @public
|
|
6768
|
+
*/
|
|
6769
|
+
export declare namespace PBSkybox_Clouds {
|
|
6770
|
+
export function encode(message: PBSkybox_Clouds, writer?: _m0.Writer): _m0.Writer;
|
|
6771
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox_Clouds;
|
|
6772
|
+
}
|
|
6773
|
+
|
|
6774
|
+
/**
|
|
6775
|
+
* @public
|
|
6776
|
+
*/
|
|
6777
|
+
export declare interface PBSkybox_SkyColors {
|
|
6778
|
+
/** the sky straight up */
|
|
6779
|
+
zenith?: ColorGradient | undefined;
|
|
6780
|
+
/** the broad band of sky around the horizon */
|
|
6781
|
+
horizon?: ColorGradient | undefined;
|
|
6782
|
+
/** The sky below the horizon, visible wherever no terrain covers it (landscape disabled, high altitude). */
|
|
6783
|
+
nadir?: ColorGradient | undefined;
|
|
6784
|
+
/** Narrow glow right on the horizon line, like a sunset glow. Unset = follows `horizon` when that is set. */
|
|
6785
|
+
rim?: ColorGradient | undefined;
|
|
6786
|
+
}
|
|
6787
|
+
|
|
6788
|
+
/**
|
|
6789
|
+
* @public
|
|
6790
|
+
*/
|
|
6791
|
+
export declare namespace PBSkybox_SkyColors {
|
|
6792
|
+
export function encode(message: PBSkybox_SkyColors, writer?: _m0.Writer): _m0.Writer;
|
|
6793
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox_SkyColors;
|
|
6794
|
+
}
|
|
6795
|
+
|
|
6796
|
+
/**
|
|
6797
|
+
* @public
|
|
6798
|
+
*/
|
|
6799
|
+
export declare interface PBSkybox_Stars {
|
|
6800
|
+
/** 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 */
|
|
6801
|
+
brightness?: number | undefined;
|
|
6802
|
+
}
|
|
6803
|
+
|
|
6804
|
+
/**
|
|
6805
|
+
* @public
|
|
6806
|
+
*/
|
|
6807
|
+
export declare namespace PBSkybox_Stars {
|
|
6808
|
+
export function encode(message: PBSkybox_Stars, writer?: _m0.Writer): _m0.Writer;
|
|
6809
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkybox_Stars;
|
|
6810
|
+
}
|
|
6811
|
+
|
|
7126
6812
|
/**
|
|
7127
6813
|
* The SkyboxTime component allows controlling the time of day for the skybox,
|
|
7128
6814
|
* affecting the lighting and appearance of the sky in the scene.
|
|
@@ -7145,6 +6831,42 @@ export declare namespace PBSkyboxTime {
|
|
|
7145
6831
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
|
|
7146
6832
|
}
|
|
7147
6833
|
|
|
6834
|
+
/**
|
|
6835
|
+
* PBSun overrides the directional light (sun and moon) while the player is inside the scene.
|
|
6836
|
+
* Valid only on the scene root entity (`engine.RootEntity`).
|
|
6837
|
+
*
|
|
6838
|
+
* An unset field keeps the time-of-day default.
|
|
6839
|
+
* Gradient `time` is the normalized time of day: 0 = 00:00, 0.5 = 12:00, 1 = 24:00.
|
|
6840
|
+
* Gradients do not wrap around midnight.
|
|
6841
|
+
*
|
|
6842
|
+
* While active, the overrides are global: they also change how neighbouring parcels look from inside the scene.
|
|
6843
|
+
*/
|
|
6844
|
+
/**
|
|
6845
|
+
* @public
|
|
6846
|
+
*/
|
|
6847
|
+
export declare interface PBSun {
|
|
6848
|
+
/** tints the directional light and the sun disc */
|
|
6849
|
+
color?: ColorGradient | undefined;
|
|
6850
|
+
/** default = true. false hides the sun and moon discs and the lens flare, but not their light */
|
|
6851
|
+
visible?: boolean | undefined;
|
|
6852
|
+
/** default = 1, multiplier on the renderer's time-of-day light intensity. Negative values clamp to 0 */
|
|
6853
|
+
intensity?: number | undefined;
|
|
6854
|
+
/**
|
|
6855
|
+
* Direction the sunlight travels, in scene space: (0,-1,0) = sun straight overhead. Normalized by the renderer.
|
|
6856
|
+
* Set = the sun stays fixed at every time of day; its color and intensity still follow the time of day.
|
|
6857
|
+
* Unset or zero = the time-of-day path.
|
|
6858
|
+
*/
|
|
6859
|
+
direction?: PBVector3 | undefined;
|
|
6860
|
+
}
|
|
6861
|
+
|
|
6862
|
+
/**
|
|
6863
|
+
* @public
|
|
6864
|
+
*/
|
|
6865
|
+
export declare namespace PBSun {
|
|
6866
|
+
export function encode(message: PBSun, writer?: _m0.Writer): _m0.Writer;
|
|
6867
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSun;
|
|
6868
|
+
}
|
|
6869
|
+
|
|
7148
6870
|
/**
|
|
7149
6871
|
* The TextShape component renders customizable floating text.
|
|
7150
6872
|
*
|
|
@@ -7211,46 +6933,6 @@ export declare namespace PBTextShape {
|
|
|
7211
6933
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
7212
6934
|
}
|
|
7213
6935
|
|
|
7214
|
-
/**
|
|
7215
|
-
* @public
|
|
7216
|
-
*/
|
|
7217
|
-
export declare interface PBTextureCamera {
|
|
7218
|
-
/** rendered texture width */
|
|
7219
|
-
width?: number | undefined;
|
|
7220
|
-
/** rendered texture height */
|
|
7221
|
-
height?: number | undefined;
|
|
7222
|
-
/**
|
|
7223
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
7224
|
-
* defaults to 0
|
|
7225
|
-
*/
|
|
7226
|
-
layer?: number | undefined;
|
|
7227
|
-
/** default black */
|
|
7228
|
-
clearColor?: PBColor4 | undefined;
|
|
7229
|
-
/** default infinity */
|
|
7230
|
-
farPlane?: number | undefined;
|
|
7231
|
-
mode?: {
|
|
7232
|
-
$case: "perspective";
|
|
7233
|
-
perspective: Perspective;
|
|
7234
|
-
} | {
|
|
7235
|
-
$case: "orthographic";
|
|
7236
|
-
orthographic: Orthographic;
|
|
7237
|
-
} | undefined;
|
|
7238
|
-
/**
|
|
7239
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
7240
|
-
* range: 0 (off) - 1 (full volume)
|
|
7241
|
-
* default: 0
|
|
7242
|
-
*/
|
|
7243
|
-
volume?: number | undefined;
|
|
7244
|
-
}
|
|
7245
|
-
|
|
7246
|
-
/**
|
|
7247
|
-
* @public
|
|
7248
|
-
*/
|
|
7249
|
-
export declare namespace PBTextureCamera {
|
|
7250
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
7251
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
7252
|
-
}
|
|
7253
|
-
|
|
7254
6936
|
/**
|
|
7255
6937
|
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
7256
6938
|
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
@@ -7496,25 +7178,6 @@ export declare namespace PBUiBackground {
|
|
|
7496
7178
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
7497
7179
|
}
|
|
7498
7180
|
|
|
7499
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
7500
|
-
/**
|
|
7501
|
-
* @public
|
|
7502
|
-
*/
|
|
7503
|
-
export declare interface PBUiCanvas {
|
|
7504
|
-
width: number;
|
|
7505
|
-
height: number;
|
|
7506
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
7507
|
-
color?: PBColor4 | undefined;
|
|
7508
|
-
}
|
|
7509
|
-
|
|
7510
|
-
/**
|
|
7511
|
-
* @public
|
|
7512
|
-
*/
|
|
7513
|
-
export declare namespace PBUiCanvas {
|
|
7514
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
7515
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
7516
|
-
}
|
|
7517
|
-
|
|
7518
7181
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
7519
7182
|
/**
|
|
7520
7183
|
* @public
|
|
@@ -7614,10 +7277,6 @@ export declare interface PBUiInput {
|
|
|
7614
7277
|
/** default=10 */
|
|
7615
7278
|
fontSize?: number | undefined;
|
|
7616
7279
|
value?: string | undefined;
|
|
7617
|
-
/** default=false; when true, the input accepts newlines and behaves as a textarea */
|
|
7618
|
-
multiLine?: boolean | undefined;
|
|
7619
|
-
/** default=true; when false, the input value is preserved after pressing Enter */
|
|
7620
|
-
clearOnSubmit?: boolean | undefined;
|
|
7621
7280
|
/** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7622
7281
|
fontSrc?: string | undefined;
|
|
7623
7282
|
}
|
|
@@ -7683,21 +7342,6 @@ export declare namespace PBUiInputResult {
|
|
|
7683
7342
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
7684
7343
|
}
|
|
7685
7344
|
|
|
7686
|
-
/**
|
|
7687
|
-
* @public
|
|
7688
|
-
*/
|
|
7689
|
-
export declare interface PBUiScrollResult {
|
|
7690
|
-
value: PBVector2 | undefined;
|
|
7691
|
-
}
|
|
7692
|
-
|
|
7693
|
-
/**
|
|
7694
|
-
* @public
|
|
7695
|
-
*/
|
|
7696
|
-
export declare namespace PBUiScrollResult {
|
|
7697
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
7698
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
7699
|
-
}
|
|
7700
|
-
|
|
7701
7345
|
/**
|
|
7702
7346
|
* @public
|
|
7703
7347
|
*/
|
|
@@ -7843,12 +7487,6 @@ export declare interface PBUiTransform {
|
|
|
7843
7487
|
borderRightColor?: PBColor4 | undefined;
|
|
7844
7488
|
/** default: 1 */
|
|
7845
7489
|
opacity?: number | undefined;
|
|
7846
|
-
/** reference for scroll_position. default empty */
|
|
7847
|
-
elementId?: string | undefined;
|
|
7848
|
-
/** default position=(0,0) */
|
|
7849
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
7850
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
7851
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
7852
7490
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
7853
7491
|
zIndex?: number | undefined;
|
|
7854
7492
|
}
|
|
@@ -8001,25 +7639,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
8001
7639
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
8002
7640
|
}
|
|
8003
7641
|
|
|
8004
|
-
/**
|
|
8005
|
-
* @public
|
|
8006
|
-
*/
|
|
8007
|
-
export declare interface Perspective {
|
|
8008
|
-
/**
|
|
8009
|
-
* vertical field of view in radians
|
|
8010
|
-
* defaults to pi/4 = 45 degrees
|
|
8011
|
-
*/
|
|
8012
|
-
fieldOfView?: number | undefined;
|
|
8013
|
-
}
|
|
8014
|
-
|
|
8015
|
-
/**
|
|
8016
|
-
* @public
|
|
8017
|
-
*/
|
|
8018
|
-
export declare namespace Perspective {
|
|
8019
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
8020
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
8021
|
-
}
|
|
8022
|
-
|
|
8023
7642
|
/**
|
|
8024
7643
|
* @public
|
|
8025
7644
|
* Physics helpers for applying impulses and forces to the player.
|
|
@@ -8261,24 +7880,6 @@ export declare interface PointerEventsSystem {
|
|
|
8261
7880
|
* @param entity - Entity where the callback was attached
|
|
8262
7881
|
*/
|
|
8263
7882
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
8264
|
-
/**
|
|
8265
|
-
* @public
|
|
8266
|
-
* Remove the callback for onPointerDrag event
|
|
8267
|
-
* @param entity - Entity where the callback was attached
|
|
8268
|
-
*/
|
|
8269
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
8270
|
-
/**
|
|
8271
|
-
* @public
|
|
8272
|
-
* Remove the callback for onPointerDragLocked event
|
|
8273
|
-
* @param entity - Entity where the callback was attached
|
|
8274
|
-
*/
|
|
8275
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
8276
|
-
/**
|
|
8277
|
-
* @public
|
|
8278
|
-
* Remove the callback for onPointerDragEnd event
|
|
8279
|
-
* @param entity - Entity where the callback was attached
|
|
8280
|
-
*/
|
|
8281
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
8282
7883
|
/**
|
|
8283
7884
|
* @public
|
|
8284
7885
|
* Remove the callback for onProximityDown event
|
|
@@ -8357,36 +7958,6 @@ export declare interface PointerEventsSystem {
|
|
|
8357
7958
|
entity: Entity;
|
|
8358
7959
|
opts?: Partial<EventSystemOptions>;
|
|
8359
7960
|
}, cb: EventSystemCallback): void;
|
|
8360
|
-
/**
|
|
8361
|
-
* @public
|
|
8362
|
-
* Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
|
|
8363
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8364
|
-
* @param cb - Function to execute on every drag update
|
|
8365
|
-
*/
|
|
8366
|
-
onPointerDrag(pointerData: {
|
|
8367
|
-
entity: Entity;
|
|
8368
|
-
opts?: Partial<EventSystemOptions>;
|
|
8369
|
-
}, cb: EventSystemCallback): void;
|
|
8370
|
-
/**
|
|
8371
|
-
* @public
|
|
8372
|
-
* Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
|
|
8373
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8374
|
-
* @param cb - Function to execute on every drag update
|
|
8375
|
-
*/
|
|
8376
|
-
onPointerDragLocked(pointerData: {
|
|
8377
|
-
entity: Entity;
|
|
8378
|
-
opts?: Partial<EventSystemOptions>;
|
|
8379
|
-
}, cb: EventSystemCallback): void;
|
|
8380
|
-
/**
|
|
8381
|
-
* @public
|
|
8382
|
-
* Execute callback when the user releases the button after a drag that started on the entity
|
|
8383
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8384
|
-
* @param cb - Function to execute when the drag ends
|
|
8385
|
-
*/
|
|
8386
|
-
onPointerDragEnd(pointerData: {
|
|
8387
|
-
entity: Entity;
|
|
8388
|
-
opts?: Partial<EventSystemOptions>;
|
|
8389
|
-
}, cb: EventSystemCallback): void;
|
|
8390
7961
|
/**
|
|
8391
7962
|
* @public
|
|
8392
7963
|
* Execute callback when the user presses the proximity button on the entity
|
|
@@ -8445,10 +8016,7 @@ export declare const enum PointerEventType {
|
|
|
8445
8016
|
PET_HOVER_ENTER = 2,
|
|
8446
8017
|
PET_HOVER_LEAVE = 3,
|
|
8447
8018
|
PET_PROXIMITY_ENTER = 4,
|
|
8448
|
-
PET_PROXIMITY_LEAVE = 5
|
|
8449
|
-
PET_DRAG_LOCKED = 6,
|
|
8450
|
-
PET_DRAG = 7,
|
|
8451
|
-
PET_DRAG_END = 8
|
|
8019
|
+
PET_PROXIMITY_LEAVE = 5
|
|
8452
8020
|
}
|
|
8453
8021
|
|
|
8454
8022
|
/**
|
|
@@ -8479,10 +8047,7 @@ export declare const enum PointerType {
|
|
|
8479
8047
|
/** POT_NONE - No pointer input */
|
|
8480
8048
|
POT_NONE = 0,
|
|
8481
8049
|
/** POT_MOUSE - Traditional mouse input */
|
|
8482
|
-
POT_MOUSE = 1
|
|
8483
|
-
POT_PAD = 2,
|
|
8484
|
-
POT_TOUCH = 3,
|
|
8485
|
-
POT_WAND = 4
|
|
8050
|
+
POT_MOUSE = 1
|
|
8486
8051
|
}
|
|
8487
8052
|
|
|
8488
8053
|
/**
|
|
@@ -8939,16 +8504,6 @@ export declare const enum RaycastQueryType {
|
|
|
8939
8504
|
/** @public */
|
|
8940
8505
|
export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
|
|
8941
8506
|
|
|
8942
|
-
/**
|
|
8943
|
-
* @public
|
|
8944
|
-
*/
|
|
8945
|
-
export declare const enum RaycastShape {
|
|
8946
|
-
/** RS_RAY - cast a point, get collisions along a ray */
|
|
8947
|
-
RS_RAY = 0,
|
|
8948
|
-
/** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
|
|
8949
|
-
RS_AVATAR = 1
|
|
8950
|
-
}
|
|
8951
|
-
|
|
8952
8507
|
/**
|
|
8953
8508
|
* @public
|
|
8954
8509
|
*/
|
|
@@ -9081,10 +8636,6 @@ export declare type RaycastSystemOptions = {
|
|
|
9081
8636
|
queryType: RaycastQueryType;
|
|
9082
8637
|
continuous?: boolean | undefined;
|
|
9083
8638
|
collisionMask?: number | undefined;
|
|
9084
|
-
/** shape to sweep along the ray, default RS_RAY (a point) */
|
|
9085
|
-
shape?: RaycastShape | undefined;
|
|
9086
|
-
/** include colliders from other scenes, default false */
|
|
9087
|
-
includeWorld?: boolean | undefined;
|
|
9088
8639
|
};
|
|
9089
8640
|
|
|
9090
8641
|
/**
|
|
@@ -9133,20 +8684,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
9133
8684
|
* @param entity - The entity whose UI renderer should be removed
|
|
9134
8685
|
*/
|
|
9135
8686
|
removeUiRenderer(entity: Entity): void;
|
|
9136
|
-
/**
|
|
9137
|
-
* Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
|
|
9138
|
-
* describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
|
|
9139
|
-
* any texture renderer already set on the entity, and is torn down when the entity is removed.
|
|
9140
|
-
*
|
|
9141
|
-
* @param entity - The UiCanvas entity the UI tree hangs from
|
|
9142
|
-
* @param ui - The UI component to render
|
|
9143
|
-
*/
|
|
9144
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
9145
|
-
/**
|
|
9146
|
-
* Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
|
|
9147
|
-
* @param entity - The UiCanvas entity the renderer was set on
|
|
9148
|
-
*/
|
|
9149
|
-
removeTextureRenderer(entity: Entity): void;
|
|
9150
8687
|
}
|
|
9151
8688
|
|
|
9152
8689
|
/**
|
|
@@ -9737,33 +9274,6 @@ export declare namespace Schemas {
|
|
|
9737
9274
|
*/
|
|
9738
9275
|
export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
|
|
9739
9276
|
|
|
9740
|
-
/**
|
|
9741
|
-
* @public
|
|
9742
|
-
*/
|
|
9743
|
-
export declare interface ScrollPositionValue {
|
|
9744
|
-
value?: {
|
|
9745
|
-
$case: "position";
|
|
9746
|
-
position: PBVector2;
|
|
9747
|
-
} | {
|
|
9748
|
-
$case: "reference";
|
|
9749
|
-
reference: string;
|
|
9750
|
-
} | undefined;
|
|
9751
|
-
}
|
|
9752
|
-
|
|
9753
|
-
/**
|
|
9754
|
-
* @public
|
|
9755
|
-
*/
|
|
9756
|
-
export declare namespace ScrollPositionValue {
|
|
9757
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
9758
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
9759
|
-
}
|
|
9760
|
-
|
|
9761
|
-
/**
|
|
9762
|
-
* Which scrollbars are shown when the overflow is scrollable
|
|
9763
|
-
* @public
|
|
9764
|
-
*/
|
|
9765
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
9766
|
-
|
|
9767
9277
|
/**
|
|
9768
9278
|
* Register the composite provider used to resolve composite files. Also registers
|
|
9769
9279
|
* any `provider.schemas` on the engine pre-seal so composites that reference those
|
|
@@ -9789,15 +9299,8 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
|
|
|
9789
9299
|
easingFunction?: EasingFunction;
|
|
9790
9300
|
}
|
|
9791
9301
|
|
|
9792
|
-
/**
|
|
9793
|
-
|
|
9794
|
-
*/
|
|
9795
|
-
export declare const enum ShowScrollBar {
|
|
9796
|
-
SSB_BOTH = 0,
|
|
9797
|
-
SSB_ONLY_VERTICAL = 1,
|
|
9798
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
9799
|
-
SSB_HIDDEN = 3
|
|
9800
|
-
}
|
|
9302
|
+
/** @public */
|
|
9303
|
+
export declare const Skybox: LastWriteWinElementSetComponentDefinition<PBSkybox>;
|
|
9801
9304
|
|
|
9802
9305
|
/** @public */
|
|
9803
9306
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
@@ -9809,6 +9312,9 @@ export declare interface Spec {
|
|
|
9809
9312
|
[key: string]: ISchema;
|
|
9810
9313
|
}
|
|
9811
9314
|
|
|
9315
|
+
/** @public */
|
|
9316
|
+
export declare const Sun: LastWriteWinElementSetComponentDefinition<PBSun>;
|
|
9317
|
+
|
|
9812
9318
|
/**
|
|
9813
9319
|
* @alpha
|
|
9814
9320
|
* This is going to be used for sync components through a server.
|
|
@@ -9910,9 +9416,6 @@ export declare namespace Texture {
|
|
|
9910
9416
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
9911
9417
|
}
|
|
9912
9418
|
|
|
9913
|
-
/** @public */
|
|
9914
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
9915
|
-
|
|
9916
9419
|
/**
|
|
9917
9420
|
* @public
|
|
9918
9421
|
*/
|
|
@@ -10023,9 +9526,6 @@ export declare interface TextureUnion {
|
|
|
10023
9526
|
} | {
|
|
10024
9527
|
$case: "videoTexture";
|
|
10025
9528
|
videoTexture: VideoTexture;
|
|
10026
|
-
} | {
|
|
10027
|
-
$case: "uiTexture";
|
|
10028
|
-
uiTexture: UiCanvasTexture;
|
|
10029
9529
|
} | undefined;
|
|
10030
9530
|
}
|
|
10031
9531
|
|
|
@@ -10564,8 +10064,6 @@ export declare interface UiBackgroundProps {
|
|
|
10564
10064
|
uvs?: number[];
|
|
10565
10065
|
/** AvatarTexture for the background */
|
|
10566
10066
|
avatarTexture?: UiAvatarTexture;
|
|
10567
|
-
/** VideoTexture for the background: the frames of a VideoPlayer on another entity */
|
|
10568
|
-
videoTexture?: UiVideoTexture;
|
|
10569
10067
|
/** Texture for the background */
|
|
10570
10068
|
texture?: UiTexture;
|
|
10571
10069
|
}
|
|
@@ -10585,31 +10083,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
10585
10083
|
disabled?: boolean;
|
|
10586
10084
|
}
|
|
10587
10085
|
|
|
10588
|
-
/** @public */
|
|
10589
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
10590
|
-
|
|
10591
10086
|
/** @public */
|
|
10592
10087
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
10593
10088
|
|
|
10594
|
-
/**
|
|
10595
|
-
* @public
|
|
10596
|
-
*/
|
|
10597
|
-
export declare interface UiCanvasTexture {
|
|
10598
|
-
uiCanvasEntity: number;
|
|
10599
|
-
/** default = TextureWrapMode.Clamp */
|
|
10600
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
10601
|
-
/** default = FilterMode.Bilinear */
|
|
10602
|
-
filterMode?: TextureFilterMode | undefined;
|
|
10603
|
-
}
|
|
10604
|
-
|
|
10605
|
-
/**
|
|
10606
|
-
* @public
|
|
10607
|
-
*/
|
|
10608
|
-
export declare namespace UiCanvasTexture {
|
|
10609
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
10610
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
10611
|
-
}
|
|
10612
|
-
|
|
10613
10089
|
/**
|
|
10614
10090
|
* @public
|
|
10615
10091
|
*/
|
|
@@ -10705,7 +10181,7 @@ export declare interface UiLabelProps {
|
|
|
10705
10181
|
textAlign?: TextAlignType | undefined;
|
|
10706
10182
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
10707
10183
|
font?: UiFontType | undefined;
|
|
10708
|
-
/**
|
|
10184
|
+
/** Path to a `.ttf` file in the scene content. `font` is used when it can't be loaded. */
|
|
10709
10185
|
fontSrc?: string | undefined;
|
|
10710
10186
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
10711
10187
|
textWrap?: UiTextWrapType | undefined;
|
|
@@ -10775,9 +10251,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
|
|
|
10775
10251
|
uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
|
|
10776
10252
|
};
|
|
10777
10253
|
|
|
10778
|
-
/** @public */
|
|
10779
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
10780
|
-
|
|
10781
10254
|
/** @public */
|
|
10782
10255
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
10783
10256
|
|
|
@@ -10857,22 +10330,6 @@ export declare interface UiTransformProps {
|
|
|
10857
10330
|
opacity?: number;
|
|
10858
10331
|
/** default 0 */
|
|
10859
10332
|
zIndex?: number;
|
|
10860
|
-
/** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
|
|
10861
|
-
elementId?: string;
|
|
10862
|
-
/** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
|
|
10863
|
-
scrollPosition?: PBVector2 | string;
|
|
10864
|
-
/** Which scrollbars to show when overflow is 'scroll'. default 'both' */
|
|
10865
|
-
scrollVisible?: ScrollVisibleType;
|
|
10866
|
-
}
|
|
10867
|
-
|
|
10868
|
-
/**
|
|
10869
|
-
* Video Texture
|
|
10870
|
-
* @public
|
|
10871
|
-
*/
|
|
10872
|
-
export declare interface UiVideoTexture {
|
|
10873
|
-
videoPlayerEntity: Entity;
|
|
10874
|
-
wrapMode?: TextureWrapType;
|
|
10875
|
-
filterMode?: TextureFilterType;
|
|
10876
10333
|
}
|
|
10877
10334
|
|
|
10878
10335
|
/**
|