@dcl/playground-assets 7.31.1-40606969412.commit-24c05c3 → 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 +228 -879
- package/dist/beta.d.ts +228 -879
- package/dist/index.bundled.d.ts +228 -879
- package/dist/index.js +7 -7
- 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 +228 -879
- package/etc/playground-assets.api.json +6378 -13025
- package/etc/playground-assets.api.md +137 -578
- package/package.json +5 -6
package/dist/index.bundled.d.ts
CHANGED
|
@@ -245,42 +245,6 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
|
245
245
|
getAudioState(entity: Entity): PBAudioEvent | undefined;
|
|
246
246
|
}
|
|
247
247
|
|
|
248
|
-
/**
|
|
249
|
-
* @public
|
|
250
|
-
*/
|
|
251
|
-
export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
|
|
252
|
-
|
|
253
|
-
/**
|
|
254
|
-
* Server authoritative message - identical to PutComponentMessageBody but with forced processing
|
|
255
|
-
* Min. length = header (8 bytes) + 16 bytes = 24 bytes
|
|
256
|
-
*
|
|
257
|
-
* @param entity - Uint32 number of the entity
|
|
258
|
-
* @param componentId - Uint32 number of id
|
|
259
|
-
* @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
|
|
260
|
-
* @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
|
|
261
|
-
* @public
|
|
262
|
-
*/
|
|
263
|
-
export declare type AuthoritativePutComponentMessageBody = {
|
|
264
|
-
type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
|
|
265
|
-
entityId: Entity;
|
|
266
|
-
componentId: number;
|
|
267
|
-
timestamp: number;
|
|
268
|
-
data: Uint8Array;
|
|
269
|
-
};
|
|
270
|
-
|
|
271
|
-
/**
|
|
272
|
-
* @public
|
|
273
|
-
*/
|
|
274
|
-
export declare namespace AuthoritativePutComponentOperation {
|
|
275
|
-
const MESSAGE_HEADER_LENGTH = 16;
|
|
276
|
-
/**
|
|
277
|
-
* Call this function for an optimal writing data passing the ByteBuffer
|
|
278
|
-
* already allocated
|
|
279
|
-
*/
|
|
280
|
-
export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
|
|
281
|
-
export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
|
|
282
|
-
}
|
|
283
|
-
|
|
284
248
|
/** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
|
|
285
249
|
/**
|
|
286
250
|
* @public
|
|
@@ -315,39 +279,6 @@ export declare const enum AvatarAnchorPointType {
|
|
|
315
279
|
AAPT_RIGHT_TOE_BASE = 25
|
|
316
280
|
}
|
|
317
281
|
|
|
318
|
-
/**
|
|
319
|
-
* Mirror of the scene-driven movement animation currently playing, reported by the engine.
|
|
320
|
-
* Readable by any scene (not just the controller) so niche effects (e.g. dust cloud on landing) can react.
|
|
321
|
-
* Active emotes are not represented here — scenes already have their own way to read them.
|
|
322
|
-
*/
|
|
323
|
-
/**
|
|
324
|
-
* @public
|
|
325
|
-
*/
|
|
326
|
-
export declare interface AvatarAnimationState {
|
|
327
|
-
/** same scene-relative path the controlling scene supplied */
|
|
328
|
-
src: string;
|
|
329
|
-
/** mirrors the request */
|
|
330
|
-
loop: boolean;
|
|
331
|
-
/** mirrors the request */
|
|
332
|
-
speed: number;
|
|
333
|
-
/** mirrors the request */
|
|
334
|
-
idle: boolean;
|
|
335
|
-
/** seconds into the clip; wraps on loop; frozen while an emote override is playing */
|
|
336
|
-
playbackTime: number;
|
|
337
|
-
/** total clip length in seconds */
|
|
338
|
-
duration: number;
|
|
339
|
-
/** how many times the clip has completed since it started */
|
|
340
|
-
loopCount: number;
|
|
341
|
-
}
|
|
342
|
-
|
|
343
|
-
/**
|
|
344
|
-
* @public
|
|
345
|
-
*/
|
|
346
|
-
export declare namespace AvatarAnimationState {
|
|
347
|
-
export function encode(message: AvatarAnimationState, writer?: _m0.Writer): _m0.Writer;
|
|
348
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarAnimationState;
|
|
349
|
-
}
|
|
350
|
-
|
|
351
282
|
/** @public */
|
|
352
283
|
export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBAvatarAttach>;
|
|
353
284
|
|
|
@@ -357,21 +288,8 @@ export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAva
|
|
|
357
288
|
/** @public */
|
|
358
289
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
359
290
|
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
/**
|
|
363
|
-
* @public
|
|
364
|
-
*/
|
|
365
|
-
export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
|
|
366
|
-
|
|
367
|
-
/**
|
|
368
|
-
* @public
|
|
369
|
-
* AvatarEquippedData with `forceRender` optional: the wire type is a repeated field (always present, so the
|
|
370
|
-
* generated type requires it), but a scene rarely needs it and shouldn't have to pass `[]`.
|
|
371
|
-
*/
|
|
372
|
-
export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
|
|
373
|
-
forceRender?: string[] | undefined;
|
|
374
|
-
};
|
|
291
|
+
/** @public */
|
|
292
|
+
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
375
293
|
|
|
376
294
|
/** @public */
|
|
377
295
|
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
@@ -400,30 +318,11 @@ export declare const enum AvatarModifierType {
|
|
|
400
318
|
AMT_HIDE_NAMETAGS = 2
|
|
401
319
|
}
|
|
402
320
|
|
|
403
|
-
/** @public */
|
|
404
|
-
export declare const AvatarMovement: LastWriteWinElementSetComponentDefinition<PBAvatarMovement>;
|
|
405
|
-
|
|
406
|
-
/** @public */
|
|
407
|
-
export declare const AvatarMovementInfo: LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>;
|
|
408
|
-
|
|
409
321
|
/** @public */
|
|
410
322
|
export declare const AvatarNametag: LastWriteWinElementSetComponentDefinition<PBAvatarNametag>;
|
|
411
323
|
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
/**
|
|
415
|
-
* @public
|
|
416
|
-
*/
|
|
417
|
-
export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
|
|
418
|
-
|
|
419
|
-
/**
|
|
420
|
-
* @public
|
|
421
|
-
* AvatarShape with `forceRender` optional: the wire type is a repeated field (always present, so the
|
|
422
|
-
* generated type requires it), but a scene rarely needs it and shouldn't have to pass `[]`.
|
|
423
|
-
*/
|
|
424
|
-
export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
|
|
425
|
-
forceRender?: string[] | undefined;
|
|
426
|
-
};
|
|
324
|
+
/** @public */
|
|
325
|
+
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
|
427
326
|
|
|
428
327
|
/**
|
|
429
328
|
* @public
|
|
@@ -521,22 +420,6 @@ export declare interface BaseComponent<T> {
|
|
|
521
420
|
* If the value is undefined, the component was deleted.
|
|
522
421
|
*/
|
|
523
422
|
onChange(entity: Entity, cb: (value: T | undefined) => void): void;
|
|
524
|
-
/**
|
|
525
|
-
* @public
|
|
526
|
-
*
|
|
527
|
-
*/
|
|
528
|
-
validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
|
|
529
|
-
validateBeforeChange(cb: ValidateCallback<T>): void;
|
|
530
|
-
/**
|
|
531
|
-
* Get the CRDT state for an entity (serialized data and timestamp)
|
|
532
|
-
* @param entity - Entity to get the CRDT state for
|
|
533
|
-
* @returns Object with serialized data and timestamp, or null if entity doesn't have the component
|
|
534
|
-
* @public
|
|
535
|
-
*/
|
|
536
|
-
getCrdtState(entity: Entity): {
|
|
537
|
-
data: Uint8Array;
|
|
538
|
-
timestamp: number;
|
|
539
|
-
} | null;
|
|
540
423
|
}
|
|
541
424
|
|
|
542
425
|
/** @public */
|
|
@@ -708,17 +591,10 @@ export declare interface ByteBuffer {
|
|
|
708
591
|
}
|
|
709
592
|
|
|
710
593
|
/**
|
|
711
|
-
* Callback function to be triggered on a specified event
|
|
712
|
-
* fired it (button, hit, and for drags the pointer delta), which handlers may ignore.
|
|
594
|
+
* Callback function to be triggered on a specified event
|
|
713
595
|
* @public
|
|
714
596
|
*/
|
|
715
|
-
export declare type Callback = (
|
|
716
|
-
|
|
717
|
-
/** @public */
|
|
718
|
-
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
|
719
|
-
|
|
720
|
-
/** @public */
|
|
721
|
-
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
|
597
|
+
export declare type Callback = () => void;
|
|
722
598
|
|
|
723
599
|
/** @public */
|
|
724
600
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
|
@@ -1511,6 +1387,44 @@ export declare type Color4Type = {
|
|
|
1511
1387
|
a: number;
|
|
1512
1388
|
};
|
|
1513
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
|
+
|
|
1514
1428
|
/** A range of Color4 values. Randomized or lerped between start and end. */
|
|
1515
1429
|
/**
|
|
1516
1430
|
* @public
|
|
@@ -1571,24 +1485,18 @@ export declare const componentDefinitionByName: {
|
|
|
1571
1485
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1572
1486
|
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1573
1487
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1574
|
-
"core::AvatarMovement": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovement>>;
|
|
1575
|
-
"core::AvatarMovementInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarMovementInfo>>;
|
|
1576
1488
|
"core::AvatarNametag": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarNametag>>;
|
|
1577
1489
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1578
1490
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
1579
|
-
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
|
1580
|
-
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
|
1581
1491
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
|
1582
1492
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
|
1583
1493
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
|
1494
|
+
"core::EnvironmentFog": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEnvironmentFog>>;
|
|
1584
1495
|
"core::ExplorerItemPurchaseResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerItemPurchaseResult>>;
|
|
1585
1496
|
"core::ExplorerUiEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBExplorerUiEventsResult>>;
|
|
1586
|
-
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
|
1587
1497
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
|
1588
1498
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
|
1589
|
-
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
|
1590
1499
|
"core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
|
|
1591
|
-
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
|
1592
1500
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
|
1593
1501
|
"core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
|
|
1594
1502
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
|
@@ -1607,9 +1515,10 @@ export declare const componentDefinitionByName: {
|
|
|
1607
1515
|
"core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
|
|
1608
1516
|
"core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
|
|
1609
1517
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1518
|
+
"core::Skybox": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkybox>>;
|
|
1610
1519
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1520
|
+
"core::Sun": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSun>>;
|
|
1611
1521
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1612
|
-
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
|
1613
1522
|
"core::TouchScreenControls": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTouchScreenControls>>;
|
|
1614
1523
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1615
1524
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
@@ -1617,14 +1526,12 @@ export declare const componentDefinitionByName: {
|
|
|
1617
1526
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
|
1618
1527
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
|
1619
1528
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
|
1620
|
-
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
|
1621
1529
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
|
1622
1530
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1623
1531
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1624
1532
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1625
1533
|
"core::UiInputBinding": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputBinding>>;
|
|
1626
1534
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1627
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
|
1628
1535
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1629
1536
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
1630
1537
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
|
@@ -1797,12 +1704,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
|
|
|
1797
1704
|
/**
|
|
1798
1705
|
* @public
|
|
1799
1706
|
*/
|
|
1800
|
-
export declare type CrdtMessage = PutComponentMessage |
|
|
1707
|
+
export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
|
|
1801
1708
|
|
|
1802
1709
|
/**
|
|
1803
1710
|
* @public
|
|
1804
1711
|
*/
|
|
1805
|
-
export declare type CrdtMessageBody = PutComponentMessageBody |
|
|
1712
|
+
export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
|
|
1806
1713
|
|
|
1807
1714
|
/**
|
|
1808
1715
|
* Min length = 8 bytes
|
|
@@ -1857,8 +1764,7 @@ export declare enum CrdtMessageType {
|
|
|
1857
1764
|
PUT_COMPONENT_NETWORK = 5,
|
|
1858
1765
|
DELETE_COMPONENT_NETWORK = 6,
|
|
1859
1766
|
DELETE_ENTITY_NETWORK = 7,
|
|
1860
|
-
|
|
1861
|
-
MAX_MESSAGE_TYPE = 9
|
|
1767
|
+
MAX_MESSAGE_TYPE = 8
|
|
1862
1768
|
}
|
|
1863
1769
|
|
|
1864
1770
|
/**
|
|
@@ -1866,8 +1772,6 @@ export declare enum CrdtMessageType {
|
|
|
1866
1772
|
*/
|
|
1867
1773
|
export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
|
|
1868
1774
|
|
|
1869
|
-
export declare const CreatedBy: ICreatedBy;
|
|
1870
|
-
|
|
1871
1775
|
/**
|
|
1872
1776
|
* @public
|
|
1873
1777
|
*/
|
|
@@ -2247,9 +2151,6 @@ export declare type EntityComponents = {
|
|
|
2247
2151
|
onMouseUp: Callback;
|
|
2248
2152
|
onMouseEnter: Callback;
|
|
2249
2153
|
onMouseLeave: Callback;
|
|
2250
|
-
onMouseDrag: Callback;
|
|
2251
|
-
onMouseDragLocked: Callback;
|
|
2252
|
-
onMouseDragEnd: Callback;
|
|
2253
2154
|
};
|
|
2254
2155
|
|
|
2255
2156
|
/** @public */
|
|
@@ -2307,6 +2208,9 @@ export declare namespace EntityUtils {
|
|
|
2307
2208
|
export function toEntityId(entityNumber: number, entityVersion: number): Entity;
|
|
2308
2209
|
}
|
|
2309
2210
|
|
|
2211
|
+
/** @public */
|
|
2212
|
+
export declare const EnvironmentFog: LastWriteWinElementSetComponentDefinition<PBEnvironmentFog>;
|
|
2213
|
+
|
|
2310
2214
|
/**
|
|
2311
2215
|
* Constant used to define the minimal number value in Babylon.js
|
|
2312
2216
|
* @public
|
|
@@ -2609,9 +2513,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
|
2609
2513
|
direction?: PBVector3;
|
|
2610
2514
|
};
|
|
2611
2515
|
|
|
2612
|
-
/** @public */
|
|
2613
|
-
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
|
2614
|
-
|
|
2615
2516
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
|
2616
2517
|
|
|
2617
2518
|
export declare type GlobalTargetRaycastSystemOptions = {
|
|
@@ -2624,24 +2525,9 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
|
2624
2525
|
/** @public */
|
|
2625
2526
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
|
2626
2527
|
|
|
2627
|
-
/** @public */
|
|
2628
|
-
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
|
2629
|
-
|
|
2630
2528
|
/** @public */
|
|
2631
2529
|
export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
|
|
2632
2530
|
|
|
2633
|
-
/** @public */
|
|
2634
|
-
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
|
2635
|
-
|
|
2636
|
-
/**
|
|
2637
|
-
* @public
|
|
2638
|
-
*/
|
|
2639
|
-
export declare const enum GltfNodeStateValue {
|
|
2640
|
-
GNSV_PENDING = 0,
|
|
2641
|
-
GNSV_FAILED = 1,
|
|
2642
|
-
GNSV_READY = 2
|
|
2643
|
-
}
|
|
2644
|
-
|
|
2645
2531
|
/**
|
|
2646
2532
|
* @public
|
|
2647
2533
|
*/
|
|
@@ -2665,12 +2551,6 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
|
|
|
2665
2551
|
|
|
2666
2552
|
export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
|
|
2667
2553
|
|
|
2668
|
-
export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
|
|
2669
|
-
|
|
2670
|
-
export declare interface ICreatedByType {
|
|
2671
|
-
address: string;
|
|
2672
|
-
}
|
|
2673
|
-
|
|
2674
2554
|
/**
|
|
2675
2555
|
* @public
|
|
2676
2556
|
*/
|
|
@@ -3148,35 +3028,6 @@ export declare const enum InteractionType {
|
|
|
3148
3028
|
PROXIMITY = 1
|
|
3149
3029
|
}
|
|
3150
3030
|
|
|
3151
|
-
/**
|
|
3152
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
3153
|
-
* This is not exposed to users, only for internal SDK operations
|
|
3154
|
-
*/
|
|
3155
|
-
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3156
|
-
/**
|
|
3157
|
-
* @public
|
|
3158
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3159
|
-
*/
|
|
3160
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3161
|
-
/**
|
|
3162
|
-
* @public
|
|
3163
|
-
* Get the iterator to every entity has the component
|
|
3164
|
-
*/
|
|
3165
|
-
iterator(): Iterable<[Entity, any]>;
|
|
3166
|
-
/**
|
|
3167
|
-
* @public
|
|
3168
|
-
*/
|
|
3169
|
-
dirtyIterator(): Iterable<Entity>;
|
|
3170
|
-
/**
|
|
3171
|
-
* @public
|
|
3172
|
-
*/
|
|
3173
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3174
|
-
/**
|
|
3175
|
-
* @public
|
|
3176
|
-
*/
|
|
3177
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3178
|
-
}
|
|
3179
|
-
|
|
3180
3031
|
/**
|
|
3181
3032
|
* @public
|
|
3182
3033
|
*/
|
|
@@ -3380,12 +3231,6 @@ export declare type Listeners = {
|
|
|
3380
3231
|
onMouseEnter?: Callback;
|
|
3381
3232
|
/** triggered on mouse leave event */
|
|
3382
3233
|
onMouseLeave?: Callback;
|
|
3383
|
-
/** triggered while the pointer is dragged after pressing on the element */
|
|
3384
|
-
onMouseDrag?: Callback;
|
|
3385
|
-
/** triggered while the pointer is dragged with the cursor locked in place */
|
|
3386
|
-
onMouseDragLocked?: Callback;
|
|
3387
|
-
/** triggered when a drag that started on the element ends */
|
|
3388
|
-
onMouseDragEnd?: Callback;
|
|
3389
3234
|
};
|
|
3390
3235
|
|
|
3391
3236
|
/**
|
|
@@ -4290,15 +4135,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4290
4135
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4291
4136
|
*/
|
|
4292
4137
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4293
|
-
/**
|
|
4294
|
-
* @public
|
|
4295
|
-
* Set a mesh from inside a gltf in the MeshCollider component
|
|
4296
|
-
* @param entity - entity to create or replace the MeshCollider component
|
|
4297
|
-
* @param source - the path to the gltf
|
|
4298
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4299
|
-
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4300
|
-
*/
|
|
4301
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4302
4138
|
}
|
|
4303
4139
|
|
|
4304
4140
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4335,14 +4171,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4335
4171
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4336
4172
|
*/
|
|
4337
4173
|
setSphere(entity: Entity): void;
|
|
4338
|
-
/**
|
|
4339
|
-
* @public
|
|
4340
|
-
* Set a mesh from inside a gltf in the MeshRenderer component
|
|
4341
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4342
|
-
* @param source - the path to the gltf
|
|
4343
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4344
|
-
*/
|
|
4345
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
4346
4174
|
}
|
|
4347
4175
|
|
|
4348
4176
|
/* Excluded from this release type: MessageBus */
|
|
@@ -4380,39 +4208,6 @@ export declare namespace MoveContinuous {
|
|
|
4380
4208
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4381
4209
|
}
|
|
4382
4210
|
|
|
4383
|
-
/**
|
|
4384
|
-
* Describes the animation the movement scene wants the avatar to play.
|
|
4385
|
-
* One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
|
|
4386
|
-
* When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
|
|
4387
|
-
*/
|
|
4388
|
-
/**
|
|
4389
|
-
* @public
|
|
4390
|
-
*/
|
|
4391
|
-
export declare interface MovementAnimation {
|
|
4392
|
-
/** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
|
|
4393
|
-
src: string;
|
|
4394
|
-
/** whether the clip repeats once it reaches the end */
|
|
4395
|
-
loop: boolean;
|
|
4396
|
-
/** playback speed multiplier (1.0 = clip's native rate) */
|
|
4397
|
-
speed: number;
|
|
4398
|
-
/** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
|
|
4399
|
-
idle: boolean;
|
|
4400
|
-
/** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
|
|
4401
|
-
transitionSeconds?: number | undefined;
|
|
4402
|
-
/** 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. */
|
|
4403
|
-
playbackTime?: number | undefined;
|
|
4404
|
-
/** 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). */
|
|
4405
|
-
sounds: string[];
|
|
4406
|
-
}
|
|
4407
|
-
|
|
4408
|
-
/**
|
|
4409
|
-
* @public
|
|
4410
|
-
*/
|
|
4411
|
-
export declare namespace MovementAnimation {
|
|
4412
|
-
export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
|
|
4413
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
|
|
4414
|
-
}
|
|
4415
|
-
|
|
4416
4211
|
/**
|
|
4417
4212
|
* @public
|
|
4418
4213
|
*/
|
|
@@ -4828,25 +4623,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4828
4623
|
totalVideoLength: number;
|
|
4829
4624
|
}>;
|
|
4830
4625
|
|
|
4831
|
-
/**
|
|
4832
|
-
* @public
|
|
4833
|
-
*/
|
|
4834
|
-
export declare interface Orthographic {
|
|
4835
|
-
/**
|
|
4836
|
-
* vertical extent of the visible range in meters
|
|
4837
|
-
* defaults to 4m
|
|
4838
|
-
*/
|
|
4839
|
-
verticalRange?: number | undefined;
|
|
4840
|
-
}
|
|
4841
|
-
|
|
4842
|
-
/**
|
|
4843
|
-
* @public
|
|
4844
|
-
*/
|
|
4845
|
-
export declare namespace Orthographic {
|
|
4846
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4847
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4848
|
-
}
|
|
4849
|
-
|
|
4850
4626
|
/**
|
|
4851
4627
|
* @public
|
|
4852
4628
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -5196,8 +4972,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
5196
4972
|
export declare interface PBAvatarEquippedData {
|
|
5197
4973
|
wearableUrns: string[];
|
|
5198
4974
|
emoteUrns: string[];
|
|
5199
|
-
/** slots that will render even if hidden */
|
|
5200
|
-
forceRender: string[];
|
|
5201
4975
|
}
|
|
5202
4976
|
|
|
5203
4977
|
/**
|
|
@@ -5268,8 +5042,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
5268
5042
|
excludeIds: string[];
|
|
5269
5043
|
/** list of modifiers to apply */
|
|
5270
5044
|
modifiers: AvatarModifierType[];
|
|
5271
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5272
|
-
useColliderRange?: boolean | undefined;
|
|
5273
5045
|
}
|
|
5274
5046
|
|
|
5275
5047
|
/**
|
|
@@ -5280,64 +5052,6 @@ export declare namespace PBAvatarModifierArea {
|
|
|
5280
5052
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
|
|
5281
5053
|
}
|
|
5282
5054
|
|
|
5283
|
-
/**
|
|
5284
|
-
* @public
|
|
5285
|
-
*/
|
|
5286
|
-
export declare interface PBAvatarMovement {
|
|
5287
|
-
velocity: PBVector3 | undefined;
|
|
5288
|
-
/** 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. */
|
|
5289
|
-
orientation: number;
|
|
5290
|
-
groundDirection?: PBVector3 | undefined;
|
|
5291
|
-
/** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
|
|
5292
|
-
walkSuccess?: boolean | undefined;
|
|
5293
|
-
/** if set, the engine plays this animation instead of selecting one from velocity heuristics */
|
|
5294
|
-
animation?: MovementAnimation | undefined;
|
|
5295
|
-
/** 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. */
|
|
5296
|
-
tiltPitch?: number | undefined;
|
|
5297
|
-
/** 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. */
|
|
5298
|
-
tiltRoll?: number | undefined;
|
|
5299
|
-
}
|
|
5300
|
-
|
|
5301
|
-
/**
|
|
5302
|
-
* @public
|
|
5303
|
-
*/
|
|
5304
|
-
export declare namespace PBAvatarMovement {
|
|
5305
|
-
export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
|
|
5306
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
|
|
5307
|
-
}
|
|
5308
|
-
|
|
5309
|
-
/**
|
|
5310
|
-
* @public
|
|
5311
|
-
*/
|
|
5312
|
-
export declare interface PBAvatarMovementInfo {
|
|
5313
|
-
/** the length of time the current step velocity will apply for */
|
|
5314
|
-
stepTime: number;
|
|
5315
|
-
/** the length of time the previous step velocity applied for */
|
|
5316
|
-
previousStepTime: number;
|
|
5317
|
-
/** the velocity requested for the previous frame */
|
|
5318
|
-
requestedVelocity: PBVector3 | undefined;
|
|
5319
|
-
/** the resulting velocity taking collisions into account */
|
|
5320
|
-
actualVelocity: PBVector3 | undefined;
|
|
5321
|
-
/** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
|
|
5322
|
-
externalVelocity: PBVector3 | undefined;
|
|
5323
|
-
activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
|
|
5324
|
-
activeInputModifier: PBInputModifier | undefined;
|
|
5325
|
-
/** if set, the movement scene should walk the player to this scene-relative position */
|
|
5326
|
-
walkTarget?: PBVector3 | undefined;
|
|
5327
|
-
/** stop distance for walk_target; considered reached when within this distance */
|
|
5328
|
-
walkThreshold?: number | undefined;
|
|
5329
|
-
/** 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. */
|
|
5330
|
-
activeAnimationState?: AvatarAnimationState | undefined;
|
|
5331
|
-
}
|
|
5332
|
-
|
|
5333
|
-
/**
|
|
5334
|
-
* @public
|
|
5335
|
-
*/
|
|
5336
|
-
export declare namespace PBAvatarMovementInfo {
|
|
5337
|
-
export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
|
|
5338
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
|
|
5339
|
-
}
|
|
5340
|
-
|
|
5341
5055
|
/**
|
|
5342
5056
|
* The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
|
|
5343
5057
|
* for example to show a rank or a role that the scene assigns to that player.
|
|
@@ -5428,8 +5142,6 @@ export declare interface PBAvatarShape {
|
|
|
5428
5142
|
emotes: string[];
|
|
5429
5143
|
/** hides the skin + hair + facial features (default: false) */
|
|
5430
5144
|
showOnlyWearables?: boolean | undefined;
|
|
5431
|
-
/** slots that will render even if hidden */
|
|
5432
|
-
forceRender: string[];
|
|
5433
5145
|
}
|
|
5434
5146
|
|
|
5435
5147
|
/**
|
|
@@ -5471,51 +5183,6 @@ export declare namespace PBBillboard {
|
|
|
5471
5183
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
5472
5184
|
}
|
|
5473
5185
|
|
|
5474
|
-
/**
|
|
5475
|
-
* @public
|
|
5476
|
-
*/
|
|
5477
|
-
export declare interface PBCameraLayer {
|
|
5478
|
-
/**
|
|
5479
|
-
* layer to which these settings apply. must be > 0
|
|
5480
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
5481
|
-
*/
|
|
5482
|
-
layer: number;
|
|
5483
|
-
/** should the sun light affect this layer? default false */
|
|
5484
|
-
directionalLight?: boolean | undefined;
|
|
5485
|
-
/** should this layer show player avatars? default false */
|
|
5486
|
-
showAvatars?: boolean | undefined;
|
|
5487
|
-
/** should this layer show the sky? default false */
|
|
5488
|
-
showSkybox?: boolean | undefined;
|
|
5489
|
-
/** should this layer show distance fog? default false */
|
|
5490
|
-
showFog?: boolean | undefined;
|
|
5491
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
5492
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
5493
|
-
ambientBrightnessOverride?: number | undefined;
|
|
5494
|
-
}
|
|
5495
|
-
|
|
5496
|
-
/**
|
|
5497
|
-
* @public
|
|
5498
|
-
*/
|
|
5499
|
-
export declare namespace PBCameraLayer {
|
|
5500
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
5501
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
5502
|
-
}
|
|
5503
|
-
|
|
5504
|
-
/**
|
|
5505
|
-
* @public
|
|
5506
|
-
*/
|
|
5507
|
-
export declare interface PBCameraLayers {
|
|
5508
|
-
layers: number[];
|
|
5509
|
-
}
|
|
5510
|
-
|
|
5511
|
-
/**
|
|
5512
|
-
* @public
|
|
5513
|
-
*/
|
|
5514
|
-
export declare namespace PBCameraLayers {
|
|
5515
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5516
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5517
|
-
}
|
|
5518
|
-
|
|
5519
5186
|
/**
|
|
5520
5187
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5521
5188
|
* third-person view.
|
|
@@ -5557,8 +5224,6 @@ export declare interface PBCameraModeArea {
|
|
|
5557
5224
|
area: PBVector3 | undefined;
|
|
5558
5225
|
/** the camera mode to enforce */
|
|
5559
5226
|
mode: CameraType;
|
|
5560
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5561
|
-
useColliderRange?: boolean | undefined;
|
|
5562
5227
|
}
|
|
5563
5228
|
|
|
5564
5229
|
/**
|
|
@@ -5632,6 +5297,34 @@ export declare namespace PBEngineInfo {
|
|
|
5632
5297
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
5633
5298
|
}
|
|
5634
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
|
+
|
|
5635
5328
|
/**
|
|
5636
5329
|
* Grow-only value set appended to the scene root entity.
|
|
5637
5330
|
* Reports the outcome of an EU_ITEM_PURCHASE flow triggered via OpenExplorerUi.
|
|
@@ -5772,39 +5465,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
|
|
|
5772
5465
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
|
|
5773
5466
|
}
|
|
5774
5467
|
|
|
5775
|
-
/**
|
|
5776
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5777
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5778
|
-
*/
|
|
5779
|
-
/**
|
|
5780
|
-
* @public
|
|
5781
|
-
*/
|
|
5782
|
-
export declare interface PBGlobalLight {
|
|
5783
|
-
/**
|
|
5784
|
-
* the direction the directional light shines in.
|
|
5785
|
-
* default depends on time of day and explorer implementation
|
|
5786
|
-
*/
|
|
5787
|
-
direction?: PBVector3 | undefined;
|
|
5788
|
-
/**
|
|
5789
|
-
* ambient light color
|
|
5790
|
-
* default: White
|
|
5791
|
-
*/
|
|
5792
|
-
ambientColor?: PBColor3 | undefined;
|
|
5793
|
-
/**
|
|
5794
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5795
|
-
* default 1
|
|
5796
|
-
*/
|
|
5797
|
-
ambientBrightness?: number | undefined;
|
|
5798
|
-
}
|
|
5799
|
-
|
|
5800
|
-
/**
|
|
5801
|
-
* @public
|
|
5802
|
-
*/
|
|
5803
|
-
export declare namespace PBGlobalLight {
|
|
5804
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5805
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5806
|
-
}
|
|
5807
|
-
|
|
5808
5468
|
/**
|
|
5809
5469
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5810
5470
|
*
|
|
@@ -5840,25 +5500,6 @@ export declare namespace PBGltfContainer {
|
|
|
5840
5500
|
*/
|
|
5841
5501
|
export declare interface PBGltfContainerLoadingState {
|
|
5842
5502
|
currentState: LoadingState;
|
|
5843
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5844
|
-
nodePaths: string[];
|
|
5845
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5846
|
-
meshNames: string[];
|
|
5847
|
-
/**
|
|
5848
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5849
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5850
|
-
*/
|
|
5851
|
-
materialNames: string[];
|
|
5852
|
-
/**
|
|
5853
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5854
|
-
* sure all your materials are explicitly named.
|
|
5855
|
-
*/
|
|
5856
|
-
skinNames: string[];
|
|
5857
|
-
/**
|
|
5858
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5859
|
-
* your skins are explicitly named.
|
|
5860
|
-
*/
|
|
5861
|
-
animationNames: string[];
|
|
5862
5503
|
}
|
|
5863
5504
|
|
|
5864
5505
|
/**
|
|
@@ -5869,57 +5510,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5869
5510
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5870
5511
|
}
|
|
5871
5512
|
|
|
5872
|
-
/**
|
|
5873
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5874
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5875
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5876
|
-
* in the parent.
|
|
5877
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5878
|
-
*
|
|
5879
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5880
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5881
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5882
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5883
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5884
|
-
*
|
|
5885
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5886
|
-
*
|
|
5887
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5888
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5889
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5890
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5891
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5892
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5893
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5894
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5895
|
-
* 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
|
|
5896
|
-
* PBMaterial will be maintained.
|
|
5897
|
-
*
|
|
5898
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5899
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5900
|
-
* change the state to `GNS_FAILED`.
|
|
5901
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5902
|
-
*
|
|
5903
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5904
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5905
|
-
* the gltf node will also be displayed.
|
|
5906
|
-
*/
|
|
5907
|
-
/**
|
|
5908
|
-
* @public
|
|
5909
|
-
*/
|
|
5910
|
-
export declare interface PBGltfNode {
|
|
5911
|
-
/** the path of the target node in the Gltf. */
|
|
5912
|
-
path: string;
|
|
5913
|
-
}
|
|
5914
|
-
|
|
5915
|
-
/**
|
|
5916
|
-
* @public
|
|
5917
|
-
*/
|
|
5918
|
-
export declare namespace PBGltfNode {
|
|
5919
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5920
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5921
|
-
}
|
|
5922
|
-
|
|
5923
5513
|
/**
|
|
5924
5514
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5925
5515
|
*
|
|
@@ -5965,26 +5555,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5965
5555
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5966
5556
|
}
|
|
5967
5557
|
|
|
5968
|
-
/**
|
|
5969
|
-
* The state of a linked gltf node.
|
|
5970
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5971
|
-
*/
|
|
5972
|
-
/**
|
|
5973
|
-
* @public
|
|
5974
|
-
*/
|
|
5975
|
-
export declare interface PBGltfNodeState {
|
|
5976
|
-
state: GltfNodeStateValue;
|
|
5977
|
-
error?: string | undefined;
|
|
5978
|
-
}
|
|
5979
|
-
|
|
5980
|
-
/**
|
|
5981
|
-
* @public
|
|
5982
|
-
*/
|
|
5983
|
-
export declare namespace PBGltfNodeState {
|
|
5984
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5985
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5986
|
-
}
|
|
5987
|
-
|
|
5988
5558
|
/**
|
|
5989
5559
|
* @public
|
|
5990
5560
|
*/
|
|
@@ -6122,14 +5692,6 @@ export declare interface PBMaterial {
|
|
|
6122
5692
|
$case: "pbr";
|
|
6123
5693
|
pbr: PBMaterial_PbrMaterial;
|
|
6124
5694
|
} | undefined;
|
|
6125
|
-
/**
|
|
6126
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
6127
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
6128
|
-
* supported by the PbMaterial.
|
|
6129
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
6130
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
6131
|
-
*/
|
|
6132
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
6133
5695
|
}
|
|
6134
5696
|
|
|
6135
5697
|
/**
|
|
@@ -6140,22 +5702,6 @@ export declare namespace PBMaterial {
|
|
|
6140
5702
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
6141
5703
|
}
|
|
6142
5704
|
|
|
6143
|
-
/**
|
|
6144
|
-
* @public
|
|
6145
|
-
*/
|
|
6146
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
6147
|
-
gltfSrc: string;
|
|
6148
|
-
name: string;
|
|
6149
|
-
}
|
|
6150
|
-
|
|
6151
|
-
/**
|
|
6152
|
-
* @public
|
|
6153
|
-
*/
|
|
6154
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
6155
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
6156
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
6157
|
-
}
|
|
6158
|
-
|
|
6159
5705
|
/**
|
|
6160
5706
|
* @public
|
|
6161
5707
|
*/
|
|
@@ -6252,9 +5798,6 @@ export declare interface PBMeshCollider {
|
|
|
6252
5798
|
} | {
|
|
6253
5799
|
$case: "plane";
|
|
6254
5800
|
plane: PBMeshCollider_PlaneMesh;
|
|
6255
|
-
} | {
|
|
6256
|
-
$case: "gltf";
|
|
6257
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
6258
5801
|
} | undefined;
|
|
6259
5802
|
}
|
|
6260
5803
|
|
|
@@ -6300,25 +5843,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
6300
5843
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
6301
5844
|
}
|
|
6302
5845
|
|
|
6303
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
6304
|
-
/**
|
|
6305
|
-
* @public
|
|
6306
|
-
*/
|
|
6307
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
6308
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6309
|
-
gltfSrc: string;
|
|
6310
|
-
/** the name of the mesh asset */
|
|
6311
|
-
name: string;
|
|
6312
|
-
}
|
|
6313
|
-
|
|
6314
|
-
/**
|
|
6315
|
-
* @public
|
|
6316
|
-
*/
|
|
6317
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
6318
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6319
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
6320
|
-
}
|
|
6321
|
-
|
|
6322
5846
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
6323
5847
|
/**
|
|
6324
5848
|
* @public
|
|
@@ -6351,11 +5875,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
6351
5875
|
|
|
6352
5876
|
/**
|
|
6353
5877
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
6354
|
-
* plane, a sphere
|
|
5878
|
+
* plane, a sphere or a cylinder.
|
|
6355
5879
|
*
|
|
6356
5880
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
6357
5881
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
6358
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.
|
|
6359
5885
|
*/
|
|
6360
5886
|
/**
|
|
6361
5887
|
* @public
|
|
@@ -6373,9 +5899,6 @@ export declare interface PBMeshRenderer {
|
|
|
6373
5899
|
} | {
|
|
6374
5900
|
$case: "plane";
|
|
6375
5901
|
plane: PBMeshRenderer_PlaneMesh;
|
|
6376
|
-
} | {
|
|
6377
|
-
$case: "gltf";
|
|
6378
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
6379
5902
|
} | undefined;
|
|
6380
5903
|
}
|
|
6381
5904
|
|
|
@@ -6423,25 +5946,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
6423
5946
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
6424
5947
|
}
|
|
6425
5948
|
|
|
6426
|
-
/** A mesh from a Gltf. */
|
|
6427
|
-
/**
|
|
6428
|
-
* @public
|
|
6429
|
-
*/
|
|
6430
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
6431
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6432
|
-
gltfSrc: string;
|
|
6433
|
-
/** the name of the mesh asset */
|
|
6434
|
-
name: string;
|
|
6435
|
-
}
|
|
6436
|
-
|
|
6437
|
-
/**
|
|
6438
|
-
* @public
|
|
6439
|
-
*/
|
|
6440
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
6441
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6442
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
6443
|
-
}
|
|
6444
|
-
|
|
6445
5949
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
6446
5950
|
/**
|
|
6447
5951
|
* @public
|
|
@@ -7038,10 +6542,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
7038
6542
|
screenCoordinates?: PBVector2 | undefined;
|
|
7039
6543
|
/** Movement since last frame (pixels) */
|
|
7040
6544
|
screenDelta?: PBVector2 | undefined;
|
|
7041
|
-
/**
|
|
7042
|
-
* ray direction that can be used with the primary camera origin for
|
|
7043
|
-
* raycasting from the cursor into the world
|
|
7044
|
-
*/
|
|
6545
|
+
/** Direction vector for 3D ray casting */
|
|
7045
6546
|
worldRayDirection?: PBVector3 | undefined;
|
|
7046
6547
|
}
|
|
7047
6548
|
|
|
@@ -7112,10 +6613,6 @@ export declare interface PBRaycast {
|
|
|
7112
6613
|
continuous?: boolean | undefined;
|
|
7113
6614
|
/** Collision mask, by default CL_POINTER | CL_PHYSICS */
|
|
7114
6615
|
collisionMask?: number | undefined;
|
|
7115
|
-
/** shape to cast, default ray */
|
|
7116
|
-
shape?: RaycastShape | undefined;
|
|
7117
|
-
/** include hits with entities from other scenes */
|
|
7118
|
-
includeWorld?: boolean | undefined;
|
|
7119
6616
|
}
|
|
7120
6617
|
|
|
7121
6618
|
/**
|
|
@@ -7185,6 +6682,105 @@ export declare namespace PBRealmInfo {
|
|
|
7185
6682
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
|
7186
6683
|
}
|
|
7187
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
|
+
|
|
7188
6784
|
/**
|
|
7189
6785
|
* The SkyboxTime component allows controlling the time of day for the skybox,
|
|
7190
6786
|
* affecting the lighting and appearance of the sky in the scene.
|
|
@@ -7207,6 +6803,42 @@ export declare namespace PBSkyboxTime {
|
|
|
7207
6803
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
|
|
7208
6804
|
}
|
|
7209
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
|
+
|
|
7210
6842
|
/**
|
|
7211
6843
|
* The TextShape component renders customizable floating text.
|
|
7212
6844
|
*
|
|
@@ -7273,46 +6905,6 @@ export declare namespace PBTextShape {
|
|
|
7273
6905
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
7274
6906
|
}
|
|
7275
6907
|
|
|
7276
|
-
/**
|
|
7277
|
-
* @public
|
|
7278
|
-
*/
|
|
7279
|
-
export declare interface PBTextureCamera {
|
|
7280
|
-
/** rendered texture width */
|
|
7281
|
-
width?: number | undefined;
|
|
7282
|
-
/** rendered texture height */
|
|
7283
|
-
height?: number | undefined;
|
|
7284
|
-
/**
|
|
7285
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
7286
|
-
* defaults to 0
|
|
7287
|
-
*/
|
|
7288
|
-
layer?: number | undefined;
|
|
7289
|
-
/** default black */
|
|
7290
|
-
clearColor?: PBColor4 | undefined;
|
|
7291
|
-
/** default infinity */
|
|
7292
|
-
farPlane?: number | undefined;
|
|
7293
|
-
mode?: {
|
|
7294
|
-
$case: "perspective";
|
|
7295
|
-
perspective: Perspective;
|
|
7296
|
-
} | {
|
|
7297
|
-
$case: "orthographic";
|
|
7298
|
-
orthographic: Orthographic;
|
|
7299
|
-
} | undefined;
|
|
7300
|
-
/**
|
|
7301
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
7302
|
-
* range: 0 (off) - 1 (full volume)
|
|
7303
|
-
* default: 0
|
|
7304
|
-
*/
|
|
7305
|
-
volume?: number | undefined;
|
|
7306
|
-
}
|
|
7307
|
-
|
|
7308
|
-
/**
|
|
7309
|
-
* @public
|
|
7310
|
-
*/
|
|
7311
|
-
export declare namespace PBTextureCamera {
|
|
7312
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
7313
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
7314
|
-
}
|
|
7315
|
-
|
|
7316
6908
|
/**
|
|
7317
6909
|
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
7318
6910
|
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
@@ -7558,25 +7150,6 @@ export declare namespace PBUiBackground {
|
|
|
7558
7150
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
7559
7151
|
}
|
|
7560
7152
|
|
|
7561
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
7562
|
-
/**
|
|
7563
|
-
* @public
|
|
7564
|
-
*/
|
|
7565
|
-
export declare interface PBUiCanvas {
|
|
7566
|
-
width: number;
|
|
7567
|
-
height: number;
|
|
7568
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
7569
|
-
color?: PBColor4 | undefined;
|
|
7570
|
-
}
|
|
7571
|
-
|
|
7572
|
-
/**
|
|
7573
|
-
* @public
|
|
7574
|
-
*/
|
|
7575
|
-
export declare namespace PBUiCanvas {
|
|
7576
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
7577
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
7578
|
-
}
|
|
7579
|
-
|
|
7580
7153
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
7581
7154
|
/**
|
|
7582
7155
|
* @public
|
|
@@ -7676,10 +7249,6 @@ export declare interface PBUiInput {
|
|
|
7676
7249
|
/** default=10 */
|
|
7677
7250
|
fontSize?: number | undefined;
|
|
7678
7251
|
value?: string | undefined;
|
|
7679
|
-
/** default=false; when true, the input accepts newlines and behaves as a textarea */
|
|
7680
|
-
multiLine?: boolean | undefined;
|
|
7681
|
-
/** default=true; when false, the input value is preserved after pressing Enter */
|
|
7682
|
-
clearOnSubmit?: boolean | undefined;
|
|
7683
7252
|
/** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7684
7253
|
fontSrc?: string | undefined;
|
|
7685
7254
|
}
|
|
@@ -7745,21 +7314,6 @@ export declare namespace PBUiInputResult {
|
|
|
7745
7314
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
7746
7315
|
}
|
|
7747
7316
|
|
|
7748
|
-
/**
|
|
7749
|
-
* @public
|
|
7750
|
-
*/
|
|
7751
|
-
export declare interface PBUiScrollResult {
|
|
7752
|
-
value: PBVector2 | undefined;
|
|
7753
|
-
}
|
|
7754
|
-
|
|
7755
|
-
/**
|
|
7756
|
-
* @public
|
|
7757
|
-
*/
|
|
7758
|
-
export declare namespace PBUiScrollResult {
|
|
7759
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
7760
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
7761
|
-
}
|
|
7762
|
-
|
|
7763
7317
|
/**
|
|
7764
7318
|
* @public
|
|
7765
7319
|
*/
|
|
@@ -7905,12 +7459,6 @@ export declare interface PBUiTransform {
|
|
|
7905
7459
|
borderRightColor?: PBColor4 | undefined;
|
|
7906
7460
|
/** default: 1 */
|
|
7907
7461
|
opacity?: number | undefined;
|
|
7908
|
-
/** reference for scroll_position. default empty */
|
|
7909
|
-
elementId?: string | undefined;
|
|
7910
|
-
/** default position=(0,0) */
|
|
7911
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
7912
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
7913
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
7914
7462
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
7915
7463
|
zIndex?: number | undefined;
|
|
7916
7464
|
}
|
|
@@ -8063,25 +7611,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
8063
7611
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
8064
7612
|
}
|
|
8065
7613
|
|
|
8066
|
-
/**
|
|
8067
|
-
* @public
|
|
8068
|
-
*/
|
|
8069
|
-
export declare interface Perspective {
|
|
8070
|
-
/**
|
|
8071
|
-
* vertical field of view in radians
|
|
8072
|
-
* defaults to pi/4 = 45 degrees
|
|
8073
|
-
*/
|
|
8074
|
-
fieldOfView?: number | undefined;
|
|
8075
|
-
}
|
|
8076
|
-
|
|
8077
|
-
/**
|
|
8078
|
-
* @public
|
|
8079
|
-
*/
|
|
8080
|
-
export declare namespace Perspective {
|
|
8081
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
8082
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
8083
|
-
}
|
|
8084
|
-
|
|
8085
7614
|
/**
|
|
8086
7615
|
* @public
|
|
8087
7616
|
* Physics helpers for applying impulses and forces to the player.
|
|
@@ -8323,24 +7852,6 @@ export declare interface PointerEventsSystem {
|
|
|
8323
7852
|
* @param entity - Entity where the callback was attached
|
|
8324
7853
|
*/
|
|
8325
7854
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
8326
|
-
/**
|
|
8327
|
-
* @public
|
|
8328
|
-
* Remove the callback for onPointerDrag event
|
|
8329
|
-
* @param entity - Entity where the callback was attached
|
|
8330
|
-
*/
|
|
8331
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
8332
|
-
/**
|
|
8333
|
-
* @public
|
|
8334
|
-
* Remove the callback for onPointerDragLocked event
|
|
8335
|
-
* @param entity - Entity where the callback was attached
|
|
8336
|
-
*/
|
|
8337
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
8338
|
-
/**
|
|
8339
|
-
* @public
|
|
8340
|
-
* Remove the callback for onPointerDragEnd event
|
|
8341
|
-
* @param entity - Entity where the callback was attached
|
|
8342
|
-
*/
|
|
8343
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
8344
7855
|
/**
|
|
8345
7856
|
* @public
|
|
8346
7857
|
* Remove the callback for onProximityDown event
|
|
@@ -8419,36 +7930,6 @@ export declare interface PointerEventsSystem {
|
|
|
8419
7930
|
entity: Entity;
|
|
8420
7931
|
opts?: Partial<EventSystemOptions>;
|
|
8421
7932
|
}, cb: EventSystemCallback): void;
|
|
8422
|
-
/**
|
|
8423
|
-
* @public
|
|
8424
|
-
* Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
|
|
8425
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8426
|
-
* @param cb - Function to execute on every drag update
|
|
8427
|
-
*/
|
|
8428
|
-
onPointerDrag(pointerData: {
|
|
8429
|
-
entity: Entity;
|
|
8430
|
-
opts?: Partial<EventSystemOptions>;
|
|
8431
|
-
}, cb: EventSystemCallback): void;
|
|
8432
|
-
/**
|
|
8433
|
-
* @public
|
|
8434
|
-
* Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
|
|
8435
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8436
|
-
* @param cb - Function to execute on every drag update
|
|
8437
|
-
*/
|
|
8438
|
-
onPointerDragLocked(pointerData: {
|
|
8439
|
-
entity: Entity;
|
|
8440
|
-
opts?: Partial<EventSystemOptions>;
|
|
8441
|
-
}, cb: EventSystemCallback): void;
|
|
8442
|
-
/**
|
|
8443
|
-
* @public
|
|
8444
|
-
* Execute callback when the user releases the button after a drag that started on the entity
|
|
8445
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8446
|
-
* @param cb - Function to execute when the drag ends
|
|
8447
|
-
*/
|
|
8448
|
-
onPointerDragEnd(pointerData: {
|
|
8449
|
-
entity: Entity;
|
|
8450
|
-
opts?: Partial<EventSystemOptions>;
|
|
8451
|
-
}, cb: EventSystemCallback): void;
|
|
8452
7933
|
/**
|
|
8453
7934
|
* @public
|
|
8454
7935
|
* Execute callback when the user presses the proximity button on the entity
|
|
@@ -8507,10 +7988,7 @@ export declare const enum PointerEventType {
|
|
|
8507
7988
|
PET_HOVER_ENTER = 2,
|
|
8508
7989
|
PET_HOVER_LEAVE = 3,
|
|
8509
7990
|
PET_PROXIMITY_ENTER = 4,
|
|
8510
|
-
PET_PROXIMITY_LEAVE = 5
|
|
8511
|
-
PET_DRAG_LOCKED = 6,
|
|
8512
|
-
PET_DRAG = 7,
|
|
8513
|
-
PET_DRAG_END = 8
|
|
7991
|
+
PET_PROXIMITY_LEAVE = 5
|
|
8514
7992
|
}
|
|
8515
7993
|
|
|
8516
7994
|
/**
|
|
@@ -8541,10 +8019,7 @@ export declare const enum PointerType {
|
|
|
8541
8019
|
/** POT_NONE - No pointer input */
|
|
8542
8020
|
POT_NONE = 0,
|
|
8543
8021
|
/** POT_MOUSE - Traditional mouse input */
|
|
8544
|
-
POT_MOUSE = 1
|
|
8545
|
-
POT_PAD = 2,
|
|
8546
|
-
POT_TOUCH = 3,
|
|
8547
|
-
POT_WAND = 4
|
|
8022
|
+
POT_MOUSE = 1
|
|
8548
8023
|
}
|
|
8549
8024
|
|
|
8550
8025
|
/**
|
|
@@ -9001,16 +8476,6 @@ export declare const enum RaycastQueryType {
|
|
|
9001
8476
|
/** @public */
|
|
9002
8477
|
export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
|
|
9003
8478
|
|
|
9004
|
-
/**
|
|
9005
|
-
* @public
|
|
9006
|
-
*/
|
|
9007
|
-
export declare const enum RaycastShape {
|
|
9008
|
-
/** RS_RAY - cast a point, get collisions along a ray */
|
|
9009
|
-
RS_RAY = 0,
|
|
9010
|
-
/** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
|
|
9011
|
-
RS_AVATAR = 1
|
|
9012
|
-
}
|
|
9013
|
-
|
|
9014
8479
|
/**
|
|
9015
8480
|
* @public
|
|
9016
8481
|
*/
|
|
@@ -9143,10 +8608,6 @@ export declare type RaycastSystemOptions = {
|
|
|
9143
8608
|
queryType: RaycastQueryType;
|
|
9144
8609
|
continuous?: boolean | undefined;
|
|
9145
8610
|
collisionMask?: number | undefined;
|
|
9146
|
-
/** shape to sweep along the ray, default RS_RAY (a point) */
|
|
9147
|
-
shape?: RaycastShape | undefined;
|
|
9148
|
-
/** include colliders from other scenes, default false */
|
|
9149
|
-
includeWorld?: boolean | undefined;
|
|
9150
8611
|
};
|
|
9151
8612
|
|
|
9152
8613
|
/**
|
|
@@ -9195,20 +8656,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
9195
8656
|
* @param entity - The entity whose UI renderer should be removed
|
|
9196
8657
|
*/
|
|
9197
8658
|
removeUiRenderer(entity: Entity): void;
|
|
9198
|
-
/**
|
|
9199
|
-
* Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
|
|
9200
|
-
* describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
|
|
9201
|
-
* any texture renderer already set on the entity, and is torn down when the entity is removed.
|
|
9202
|
-
*
|
|
9203
|
-
* @param entity - The UiCanvas entity the UI tree hangs from
|
|
9204
|
-
* @param ui - The UI component to render
|
|
9205
|
-
*/
|
|
9206
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
9207
|
-
/**
|
|
9208
|
-
* Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
|
|
9209
|
-
* @param entity - The UiCanvas entity the renderer was set on
|
|
9210
|
-
*/
|
|
9211
|
-
removeTextureRenderer(entity: Entity): void;
|
|
9212
8659
|
}
|
|
9213
8660
|
|
|
9214
8661
|
/**
|
|
@@ -9799,33 +9246,6 @@ export declare namespace Schemas {
|
|
|
9799
9246
|
*/
|
|
9800
9247
|
export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
|
|
9801
9248
|
|
|
9802
|
-
/**
|
|
9803
|
-
* @public
|
|
9804
|
-
*/
|
|
9805
|
-
export declare interface ScrollPositionValue {
|
|
9806
|
-
value?: {
|
|
9807
|
-
$case: "position";
|
|
9808
|
-
position: PBVector2;
|
|
9809
|
-
} | {
|
|
9810
|
-
$case: "reference";
|
|
9811
|
-
reference: string;
|
|
9812
|
-
} | undefined;
|
|
9813
|
-
}
|
|
9814
|
-
|
|
9815
|
-
/**
|
|
9816
|
-
* @public
|
|
9817
|
-
*/
|
|
9818
|
-
export declare namespace ScrollPositionValue {
|
|
9819
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
9820
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
9821
|
-
}
|
|
9822
|
-
|
|
9823
|
-
/**
|
|
9824
|
-
* Which scrollbars are shown when the overflow is scrollable
|
|
9825
|
-
* @public
|
|
9826
|
-
*/
|
|
9827
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
9828
|
-
|
|
9829
9249
|
/**
|
|
9830
9250
|
* Register the composite provider used to resolve composite files. Also registers
|
|
9831
9251
|
* any `provider.schemas` on the engine pre-seal so composites that reference those
|
|
@@ -9851,15 +9271,8 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
|
|
|
9851
9271
|
easingFunction?: EasingFunction;
|
|
9852
9272
|
}
|
|
9853
9273
|
|
|
9854
|
-
/**
|
|
9855
|
-
|
|
9856
|
-
*/
|
|
9857
|
-
export declare const enum ShowScrollBar {
|
|
9858
|
-
SSB_BOTH = 0,
|
|
9859
|
-
SSB_ONLY_VERTICAL = 1,
|
|
9860
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
9861
|
-
SSB_HIDDEN = 3
|
|
9862
|
-
}
|
|
9274
|
+
/** @public */
|
|
9275
|
+
export declare const Skybox: LastWriteWinElementSetComponentDefinition<PBSkybox>;
|
|
9863
9276
|
|
|
9864
9277
|
/** @public */
|
|
9865
9278
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
@@ -9871,6 +9284,9 @@ export declare interface Spec {
|
|
|
9871
9284
|
[key: string]: ISchema;
|
|
9872
9285
|
}
|
|
9873
9286
|
|
|
9287
|
+
/** @public */
|
|
9288
|
+
export declare const Sun: LastWriteWinElementSetComponentDefinition<PBSun>;
|
|
9289
|
+
|
|
9874
9290
|
/* Excluded from this release type: SyncComponents */
|
|
9875
9291
|
|
|
9876
9292
|
/**
|
|
@@ -9967,9 +9383,6 @@ export declare namespace Texture {
|
|
|
9967
9383
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
9968
9384
|
}
|
|
9969
9385
|
|
|
9970
|
-
/** @public */
|
|
9971
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
9972
|
-
|
|
9973
9386
|
/**
|
|
9974
9387
|
* @public
|
|
9975
9388
|
*/
|
|
@@ -10080,9 +9493,6 @@ export declare interface TextureUnion {
|
|
|
10080
9493
|
} | {
|
|
10081
9494
|
$case: "videoTexture";
|
|
10082
9495
|
videoTexture: VideoTexture;
|
|
10083
|
-
} | {
|
|
10084
|
-
$case: "uiTexture";
|
|
10085
|
-
uiTexture: UiCanvasTexture;
|
|
10086
9496
|
} | undefined;
|
|
10087
9497
|
}
|
|
10088
9498
|
|
|
@@ -10313,16 +9723,6 @@ export declare type Transport = {
|
|
|
10313
9723
|
onmessage?(message: Uint8Array): void;
|
|
10314
9724
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
10315
9725
|
type?: string;
|
|
10316
|
-
/**
|
|
10317
|
-
* Whether this transport is allowed to mutate reserved-range entities
|
|
10318
|
-
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
10319
|
-
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
10320
|
-
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
10321
|
-
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
10322
|
-
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
10323
|
-
* `receiveMessages`.
|
|
10324
|
-
*/
|
|
10325
|
-
allowReservedEntities?: boolean;
|
|
10326
9726
|
};
|
|
10327
9727
|
|
|
10328
9728
|
/**
|
|
@@ -10631,8 +10031,6 @@ export declare interface UiBackgroundProps {
|
|
|
10631
10031
|
uvs?: number[];
|
|
10632
10032
|
/** AvatarTexture for the background */
|
|
10633
10033
|
avatarTexture?: UiAvatarTexture;
|
|
10634
|
-
/** VideoTexture for the background: the frames of a VideoPlayer on another entity */
|
|
10635
|
-
videoTexture?: UiVideoTexture;
|
|
10636
10034
|
/** Texture for the background */
|
|
10637
10035
|
texture?: UiTexture;
|
|
10638
10036
|
}
|
|
@@ -10652,31 +10050,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
10652
10050
|
disabled?: boolean;
|
|
10653
10051
|
}
|
|
10654
10052
|
|
|
10655
|
-
/** @public */
|
|
10656
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
10657
|
-
|
|
10658
10053
|
/** @public */
|
|
10659
10054
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
10660
10055
|
|
|
10661
|
-
/**
|
|
10662
|
-
* @public
|
|
10663
|
-
*/
|
|
10664
|
-
export declare interface UiCanvasTexture {
|
|
10665
|
-
uiCanvasEntity: number;
|
|
10666
|
-
/** default = TextureWrapMode.Clamp */
|
|
10667
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
10668
|
-
/** default = FilterMode.Bilinear */
|
|
10669
|
-
filterMode?: TextureFilterMode | undefined;
|
|
10670
|
-
}
|
|
10671
|
-
|
|
10672
|
-
/**
|
|
10673
|
-
* @public
|
|
10674
|
-
*/
|
|
10675
|
-
export declare namespace UiCanvasTexture {
|
|
10676
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
10677
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
10678
|
-
}
|
|
10679
|
-
|
|
10680
10056
|
/**
|
|
10681
10057
|
* @public
|
|
10682
10058
|
*/
|
|
@@ -10772,7 +10148,7 @@ export declare interface UiLabelProps {
|
|
|
10772
10148
|
textAlign?: TextAlignType | undefined;
|
|
10773
10149
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
10774
10150
|
font?: UiFontType | undefined;
|
|
10775
|
-
/**
|
|
10151
|
+
/** Path to a `.ttf` file in the scene content. `font` is used when it can't be loaded. */
|
|
10776
10152
|
fontSrc?: string | undefined;
|
|
10777
10153
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
10778
10154
|
textWrap?: UiTextWrapType | undefined;
|
|
@@ -10842,9 +10218,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
|
|
|
10842
10218
|
uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
|
|
10843
10219
|
};
|
|
10844
10220
|
|
|
10845
|
-
/** @public */
|
|
10846
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
10847
|
-
|
|
10848
10221
|
/** @public */
|
|
10849
10222
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
10850
10223
|
|
|
@@ -10924,22 +10297,6 @@ export declare interface UiTransformProps {
|
|
|
10924
10297
|
opacity?: number;
|
|
10925
10298
|
/** default 0 */
|
|
10926
10299
|
zIndex?: number;
|
|
10927
|
-
/** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
|
|
10928
|
-
elementId?: string;
|
|
10929
|
-
/** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
|
|
10930
|
-
scrollPosition?: PBVector2 | string;
|
|
10931
|
-
/** Which scrollbars to show when overflow is 'scroll'. default 'both' */
|
|
10932
|
-
scrollVisible?: ScrollVisibleType;
|
|
10933
|
-
}
|
|
10934
|
-
|
|
10935
|
-
/**
|
|
10936
|
-
* Video Texture
|
|
10937
|
-
* @public
|
|
10938
|
-
*/
|
|
10939
|
-
export declare interface UiVideoTexture {
|
|
10940
|
-
videoPlayerEntity: Entity;
|
|
10941
|
-
wrapMode?: TextureWrapType;
|
|
10942
|
-
filterMode?: TextureFilterType;
|
|
10943
10300
|
}
|
|
10944
10301
|
|
|
10945
10302
|
/**
|
|
@@ -10947,14 +10304,6 @@ export declare interface UiVideoTexture {
|
|
|
10947
10304
|
*/
|
|
10948
10305
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10949
10306
|
|
|
10950
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10951
|
-
entity: Entity;
|
|
10952
|
-
currentValue: T | undefined;
|
|
10953
|
-
newValue: T | undefined;
|
|
10954
|
-
senderAddress: string;
|
|
10955
|
-
createdBy: string;
|
|
10956
|
-
}) => boolean;
|
|
10957
|
-
|
|
10958
10307
|
/**
|
|
10959
10308
|
* @public
|
|
10960
10309
|
*/
|