@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/alpha.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
|
*/
|
|
@@ -3157,35 +3037,6 @@ export declare const enum InteractionType {
|
|
|
3157
3037
|
PROXIMITY = 1
|
|
3158
3038
|
}
|
|
3159
3039
|
|
|
3160
|
-
/**
|
|
3161
|
-
* Internal component interface that exposes all internal methods for SDK use
|
|
3162
|
-
* This is not exposed to users, only for internal SDK operations
|
|
3163
|
-
*/
|
|
3164
|
-
export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
|
|
3165
|
-
/**
|
|
3166
|
-
* @public
|
|
3167
|
-
* Dry run update to check if a CRDT message would be accepted without actually applying it
|
|
3168
|
-
*/
|
|
3169
|
-
__dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
|
|
3170
|
-
/**
|
|
3171
|
-
* @public
|
|
3172
|
-
* Get the iterator to every entity has the component
|
|
3173
|
-
*/
|
|
3174
|
-
iterator(): Iterable<[Entity, any]>;
|
|
3175
|
-
/**
|
|
3176
|
-
* @public
|
|
3177
|
-
*/
|
|
3178
|
-
dirtyIterator(): Iterable<Entity>;
|
|
3179
|
-
/**
|
|
3180
|
-
* @public
|
|
3181
|
-
*/
|
|
3182
|
-
__onChangeCallbacks(entity: Entity, value: T): void;
|
|
3183
|
-
/**
|
|
3184
|
-
* @public
|
|
3185
|
-
*/
|
|
3186
|
-
__run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
|
|
3187
|
-
}
|
|
3188
|
-
|
|
3189
3040
|
/**
|
|
3190
3041
|
* @public
|
|
3191
3042
|
*/
|
|
@@ -3389,12 +3240,6 @@ export declare type Listeners = {
|
|
|
3389
3240
|
onMouseEnter?: Callback;
|
|
3390
3241
|
/** triggered on mouse leave event */
|
|
3391
3242
|
onMouseLeave?: Callback;
|
|
3392
|
-
/** triggered while the pointer is dragged after pressing on the element */
|
|
3393
|
-
onMouseDrag?: Callback;
|
|
3394
|
-
/** triggered while the pointer is dragged with the cursor locked in place */
|
|
3395
|
-
onMouseDragLocked?: Callback;
|
|
3396
|
-
/** triggered when a drag that started on the element ends */
|
|
3397
|
-
onMouseDragEnd?: Callback;
|
|
3398
3243
|
};
|
|
3399
3244
|
|
|
3400
3245
|
/**
|
|
@@ -4299,15 +4144,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
4299
4144
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4300
4145
|
*/
|
|
4301
4146
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4302
|
-
/**
|
|
4303
|
-
* @public
|
|
4304
|
-
* Set a mesh from inside a gltf in the MeshCollider component
|
|
4305
|
-
* @param entity - entity to create or replace the MeshCollider component
|
|
4306
|
-
* @param source - the path to the gltf
|
|
4307
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4308
|
-
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
4309
|
-
*/
|
|
4310
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4311
4147
|
}
|
|
4312
4148
|
|
|
4313
4149
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -4344,14 +4180,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
4344
4180
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
4345
4181
|
*/
|
|
4346
4182
|
setSphere(entity: Entity): void;
|
|
4347
|
-
/**
|
|
4348
|
-
* @public
|
|
4349
|
-
* Set a mesh from inside a gltf in the MeshRenderer component
|
|
4350
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
|
4351
|
-
* @param source - the path to the gltf
|
|
4352
|
-
* @param meshName - the name of the mesh in the gltf (see GltfContainerLoadingState.meshNames)
|
|
4353
|
-
*/
|
|
4354
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
4355
4183
|
}
|
|
4356
4184
|
|
|
4357
4185
|
/**
|
|
@@ -4400,39 +4228,6 @@ export declare namespace MoveContinuous {
|
|
|
4400
4228
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
4401
4229
|
}
|
|
4402
4230
|
|
|
4403
|
-
/**
|
|
4404
|
-
* Describes the animation the movement scene wants the avatar to play.
|
|
4405
|
-
* One GLB = one clip (following the scene-emote convention: single clip, or a clip named with `_Avatar` suffix).
|
|
4406
|
-
* When absent the engine falls back to its built-in velocity-based selection (walk/run/jump/idle).
|
|
4407
|
-
*/
|
|
4408
|
-
/**
|
|
4409
|
-
* @public
|
|
4410
|
-
*/
|
|
4411
|
-
export declare interface MovementAnimation {
|
|
4412
|
-
/** scene-relative path to the gltf/glb asset (resolved via the scene content map) */
|
|
4413
|
-
src: string;
|
|
4414
|
-
/** whether the clip repeats once it reaches the end */
|
|
4415
|
-
loop: boolean;
|
|
4416
|
-
/** playback speed multiplier (1.0 = clip's native rate) */
|
|
4417
|
-
speed: number;
|
|
4418
|
-
/** true: a triggerSceneEmote may take over; false: emotes are suppressed while this animation plays */
|
|
4419
|
-
idle: boolean;
|
|
4420
|
-
/** cross-fade duration when `src` changes; defaults to 0.2 when unset. Not applied to loop/speed/idle changes. */
|
|
4421
|
-
transitionSeconds?: number | undefined;
|
|
4422
|
-
/** 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. */
|
|
4423
|
-
playbackTime?: number | undefined;
|
|
4424
|
-
/** 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). */
|
|
4425
|
-
sounds: string[];
|
|
4426
|
-
}
|
|
4427
|
-
|
|
4428
|
-
/**
|
|
4429
|
-
* @public
|
|
4430
|
-
*/
|
|
4431
|
-
export declare namespace MovementAnimation {
|
|
4432
|
-
export function encode(message: MovementAnimation, writer?: _m0.Writer): _m0.Writer;
|
|
4433
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): MovementAnimation;
|
|
4434
|
-
}
|
|
4435
|
-
|
|
4436
4231
|
/**
|
|
4437
4232
|
* @public
|
|
4438
4233
|
*/
|
|
@@ -4856,25 +4651,6 @@ export declare const onVideoEvent: Observable<{
|
|
|
4856
4651
|
totalVideoLength: number;
|
|
4857
4652
|
}>;
|
|
4858
4653
|
|
|
4859
|
-
/**
|
|
4860
|
-
* @public
|
|
4861
|
-
*/
|
|
4862
|
-
export declare interface Orthographic {
|
|
4863
|
-
/**
|
|
4864
|
-
* vertical extent of the visible range in meters
|
|
4865
|
-
* defaults to 4m
|
|
4866
|
-
*/
|
|
4867
|
-
verticalRange?: number | undefined;
|
|
4868
|
-
}
|
|
4869
|
-
|
|
4870
|
-
/**
|
|
4871
|
-
* @public
|
|
4872
|
-
*/
|
|
4873
|
-
export declare namespace Orthographic {
|
|
4874
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4875
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4876
|
-
}
|
|
4877
|
-
|
|
4878
4654
|
/**
|
|
4879
4655
|
* @public
|
|
4880
4656
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -5224,8 +5000,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
5224
5000
|
export declare interface PBAvatarEquippedData {
|
|
5225
5001
|
wearableUrns: string[];
|
|
5226
5002
|
emoteUrns: string[];
|
|
5227
|
-
/** slots that will render even if hidden */
|
|
5228
|
-
forceRender: string[];
|
|
5229
5003
|
}
|
|
5230
5004
|
|
|
5231
5005
|
/**
|
|
@@ -5296,8 +5070,6 @@ export declare interface PBAvatarModifierArea {
|
|
|
5296
5070
|
excludeIds: string[];
|
|
5297
5071
|
/** list of modifiers to apply */
|
|
5298
5072
|
modifiers: AvatarModifierType[];
|
|
5299
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5300
|
-
useColliderRange?: boolean | undefined;
|
|
5301
5073
|
}
|
|
5302
5074
|
|
|
5303
5075
|
/**
|
|
@@ -5308,64 +5080,6 @@ export declare namespace PBAvatarModifierArea {
|
|
|
5308
5080
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarModifierArea;
|
|
5309
5081
|
}
|
|
5310
5082
|
|
|
5311
|
-
/**
|
|
5312
|
-
* @public
|
|
5313
|
-
*/
|
|
5314
|
-
export declare interface PBAvatarMovement {
|
|
5315
|
-
velocity: PBVector3 | undefined;
|
|
5316
|
-
/** 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. */
|
|
5317
|
-
orientation: number;
|
|
5318
|
-
groundDirection?: PBVector3 | undefined;
|
|
5319
|
-
/** set for one frame when a walk_target ends: true = reached target, false = failed; absent = in progress or no walk */
|
|
5320
|
-
walkSuccess?: boolean | undefined;
|
|
5321
|
-
/** if set, the engine plays this animation instead of selecting one from velocity heuristics */
|
|
5322
|
-
animation?: MovementAnimation | undefined;
|
|
5323
|
-
/** 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. */
|
|
5324
|
-
tiltPitch?: number | undefined;
|
|
5325
|
-
/** 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. */
|
|
5326
|
-
tiltRoll?: number | undefined;
|
|
5327
|
-
}
|
|
5328
|
-
|
|
5329
|
-
/**
|
|
5330
|
-
* @public
|
|
5331
|
-
*/
|
|
5332
|
-
export declare namespace PBAvatarMovement {
|
|
5333
|
-
export function encode(message: PBAvatarMovement, writer?: _m0.Writer): _m0.Writer;
|
|
5334
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovement;
|
|
5335
|
-
}
|
|
5336
|
-
|
|
5337
|
-
/**
|
|
5338
|
-
* @public
|
|
5339
|
-
*/
|
|
5340
|
-
export declare interface PBAvatarMovementInfo {
|
|
5341
|
-
/** the length of time the current step velocity will apply for */
|
|
5342
|
-
stepTime: number;
|
|
5343
|
-
/** the length of time the previous step velocity applied for */
|
|
5344
|
-
previousStepTime: number;
|
|
5345
|
-
/** the velocity requested for the previous frame */
|
|
5346
|
-
requestedVelocity: PBVector3 | undefined;
|
|
5347
|
-
/** the resulting velocity taking collisions into account */
|
|
5348
|
-
actualVelocity: PBVector3 | undefined;
|
|
5349
|
-
/** the velocity imparted by movement of the "ground" platform or pushing from other moving colliders */
|
|
5350
|
-
externalVelocity: PBVector3 | undefined;
|
|
5351
|
-
activeAvatarLocomotionSettings: PBAvatarLocomotionSettings | undefined;
|
|
5352
|
-
activeInputModifier: PBInputModifier | undefined;
|
|
5353
|
-
/** if set, the movement scene should walk the player to this scene-relative position */
|
|
5354
|
-
walkTarget?: PBVector3 | undefined;
|
|
5355
|
-
/** stop distance for walk_target; considered reached when within this distance */
|
|
5356
|
-
walkThreshold?: number | undefined;
|
|
5357
|
-
/** 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. */
|
|
5358
|
-
activeAnimationState?: AvatarAnimationState | undefined;
|
|
5359
|
-
}
|
|
5360
|
-
|
|
5361
|
-
/**
|
|
5362
|
-
* @public
|
|
5363
|
-
*/
|
|
5364
|
-
export declare namespace PBAvatarMovementInfo {
|
|
5365
|
-
export function encode(message: PBAvatarMovementInfo, writer?: _m0.Writer): _m0.Writer;
|
|
5366
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarMovementInfo;
|
|
5367
|
-
}
|
|
5368
|
-
|
|
5369
5083
|
/**
|
|
5370
5084
|
* The AvatarNametag component adds a plate with scene-provided text above an avatar's nametag,
|
|
5371
5085
|
* for example to show a rank or a role that the scene assigns to that player.
|
|
@@ -5456,8 +5170,6 @@ export declare interface PBAvatarShape {
|
|
|
5456
5170
|
emotes: string[];
|
|
5457
5171
|
/** hides the skin + hair + facial features (default: false) */
|
|
5458
5172
|
showOnlyWearables?: boolean | undefined;
|
|
5459
|
-
/** slots that will render even if hidden */
|
|
5460
|
-
forceRender: string[];
|
|
5461
5173
|
}
|
|
5462
5174
|
|
|
5463
5175
|
/**
|
|
@@ -5499,51 +5211,6 @@ export declare namespace PBBillboard {
|
|
|
5499
5211
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
5500
5212
|
}
|
|
5501
5213
|
|
|
5502
|
-
/**
|
|
5503
|
-
* @public
|
|
5504
|
-
*/
|
|
5505
|
-
export declare interface PBCameraLayer {
|
|
5506
|
-
/**
|
|
5507
|
-
* layer to which these settings apply. must be > 0
|
|
5508
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
5509
|
-
*/
|
|
5510
|
-
layer: number;
|
|
5511
|
-
/** should the sun light affect this layer? default false */
|
|
5512
|
-
directionalLight?: boolean | undefined;
|
|
5513
|
-
/** should this layer show player avatars? default false */
|
|
5514
|
-
showAvatars?: boolean | undefined;
|
|
5515
|
-
/** should this layer show the sky? default false */
|
|
5516
|
-
showSkybox?: boolean | undefined;
|
|
5517
|
-
/** should this layer show distance fog? default false */
|
|
5518
|
-
showFog?: boolean | undefined;
|
|
5519
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
5520
|
-
ambientColorOverride?: PBColor3 | undefined;
|
|
5521
|
-
ambientBrightnessOverride?: number | undefined;
|
|
5522
|
-
}
|
|
5523
|
-
|
|
5524
|
-
/**
|
|
5525
|
-
* @public
|
|
5526
|
-
*/
|
|
5527
|
-
export declare namespace PBCameraLayer {
|
|
5528
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
5529
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
5530
|
-
}
|
|
5531
|
-
|
|
5532
|
-
/**
|
|
5533
|
-
* @public
|
|
5534
|
-
*/
|
|
5535
|
-
export declare interface PBCameraLayers {
|
|
5536
|
-
layers: number[];
|
|
5537
|
-
}
|
|
5538
|
-
|
|
5539
|
-
/**
|
|
5540
|
-
* @public
|
|
5541
|
-
*/
|
|
5542
|
-
export declare namespace PBCameraLayers {
|
|
5543
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5544
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5545
|
-
}
|
|
5546
|
-
|
|
5547
5214
|
/**
|
|
5548
5215
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
5549
5216
|
* third-person view.
|
|
@@ -5585,8 +5252,6 @@ export declare interface PBCameraModeArea {
|
|
|
5585
5252
|
area: PBVector3 | undefined;
|
|
5586
5253
|
/** the camera mode to enforce */
|
|
5587
5254
|
mode: CameraType;
|
|
5588
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5589
|
-
useColliderRange?: boolean | undefined;
|
|
5590
5255
|
}
|
|
5591
5256
|
|
|
5592
5257
|
/**
|
|
@@ -5660,6 +5325,34 @@ export declare namespace PBEngineInfo {
|
|
|
5660
5325
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
5661
5326
|
}
|
|
5662
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
|
+
|
|
5663
5356
|
/**
|
|
5664
5357
|
* Grow-only value set appended to the scene root entity.
|
|
5665
5358
|
* Reports the outcome of an EU_ITEM_PURCHASE flow triggered via OpenExplorerUi.
|
|
@@ -5800,39 +5493,6 @@ export declare namespace PBExplorerUiEventsResult_UiOpened {
|
|
|
5800
5493
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBExplorerUiEventsResult_UiOpened;
|
|
5801
5494
|
}
|
|
5802
5495
|
|
|
5803
|
-
/**
|
|
5804
|
-
* defines the global scene light settings. must be added to the scene root.
|
|
5805
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5806
|
-
*/
|
|
5807
|
-
/**
|
|
5808
|
-
* @public
|
|
5809
|
-
*/
|
|
5810
|
-
export declare interface PBGlobalLight {
|
|
5811
|
-
/**
|
|
5812
|
-
* the direction the directional light shines in.
|
|
5813
|
-
* default depends on time of day and explorer implementation
|
|
5814
|
-
*/
|
|
5815
|
-
direction?: PBVector3 | undefined;
|
|
5816
|
-
/**
|
|
5817
|
-
* ambient light color
|
|
5818
|
-
* default: White
|
|
5819
|
-
*/
|
|
5820
|
-
ambientColor?: PBColor3 | undefined;
|
|
5821
|
-
/**
|
|
5822
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5823
|
-
* default 1
|
|
5824
|
-
*/
|
|
5825
|
-
ambientBrightness?: number | undefined;
|
|
5826
|
-
}
|
|
5827
|
-
|
|
5828
|
-
/**
|
|
5829
|
-
* @public
|
|
5830
|
-
*/
|
|
5831
|
-
export declare namespace PBGlobalLight {
|
|
5832
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5833
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5834
|
-
}
|
|
5835
|
-
|
|
5836
5496
|
/**
|
|
5837
5497
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
5838
5498
|
*
|
|
@@ -5868,25 +5528,6 @@ export declare namespace PBGltfContainer {
|
|
|
5868
5528
|
*/
|
|
5869
5529
|
export declare interface PBGltfContainerLoadingState {
|
|
5870
5530
|
currentState: LoadingState;
|
|
5871
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5872
|
-
nodePaths: string[];
|
|
5873
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5874
|
-
meshNames: string[];
|
|
5875
|
-
/**
|
|
5876
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5877
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5878
|
-
*/
|
|
5879
|
-
materialNames: string[];
|
|
5880
|
-
/**
|
|
5881
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5882
|
-
* sure all your materials are explicitly named.
|
|
5883
|
-
*/
|
|
5884
|
-
skinNames: string[];
|
|
5885
|
-
/**
|
|
5886
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5887
|
-
* your skins are explicitly named.
|
|
5888
|
-
*/
|
|
5889
|
-
animationNames: string[];
|
|
5890
5531
|
}
|
|
5891
5532
|
|
|
5892
5533
|
/**
|
|
@@ -5897,57 +5538,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
5897
5538
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
5898
5539
|
}
|
|
5899
5540
|
|
|
5900
|
-
/**
|
|
5901
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5902
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5903
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5904
|
-
* in the parent.
|
|
5905
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5906
|
-
*
|
|
5907
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5908
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5909
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5910
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5911
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5912
|
-
*
|
|
5913
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5914
|
-
*
|
|
5915
|
-
* From the scene, you can modify various components to alter the gltf node:
|
|
5916
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5917
|
-
* regardless of any intermediate gltf node hierarchy.
|
|
5918
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5919
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5920
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5921
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5922
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5923
|
-
* 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
|
|
5924
|
-
* PBMaterial will be maintained.
|
|
5925
|
-
*
|
|
5926
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5927
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5928
|
-
* change the state to `GNS_FAILED`.
|
|
5929
|
-
* - deleting the scene entity will not delete the gltf node.
|
|
5930
|
-
*
|
|
5931
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5932
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5933
|
-
* the gltf node will also be displayed.
|
|
5934
|
-
*/
|
|
5935
|
-
/**
|
|
5936
|
-
* @public
|
|
5937
|
-
*/
|
|
5938
|
-
export declare interface PBGltfNode {
|
|
5939
|
-
/** the path of the target node in the Gltf. */
|
|
5940
|
-
path: string;
|
|
5941
|
-
}
|
|
5942
|
-
|
|
5943
|
-
/**
|
|
5944
|
-
* @public
|
|
5945
|
-
*/
|
|
5946
|
-
export declare namespace PBGltfNode {
|
|
5947
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5948
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5949
|
-
}
|
|
5950
|
-
|
|
5951
5541
|
/**
|
|
5952
5542
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
5953
5543
|
*
|
|
@@ -5993,26 +5583,6 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
5993
5583
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
5994
5584
|
}
|
|
5995
5585
|
|
|
5996
|
-
/**
|
|
5997
|
-
* The state of a linked gltf node.
|
|
5998
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5999
|
-
*/
|
|
6000
|
-
/**
|
|
6001
|
-
* @public
|
|
6002
|
-
*/
|
|
6003
|
-
export declare interface PBGltfNodeState {
|
|
6004
|
-
state: GltfNodeStateValue;
|
|
6005
|
-
error?: string | undefined;
|
|
6006
|
-
}
|
|
6007
|
-
|
|
6008
|
-
/**
|
|
6009
|
-
* @public
|
|
6010
|
-
*/
|
|
6011
|
-
export declare namespace PBGltfNodeState {
|
|
6012
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
6013
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
6014
|
-
}
|
|
6015
|
-
|
|
6016
5586
|
/**
|
|
6017
5587
|
* @public
|
|
6018
5588
|
*/
|
|
@@ -6150,14 +5720,6 @@ export declare interface PBMaterial {
|
|
|
6150
5720
|
$case: "pbr";
|
|
6151
5721
|
pbr: PBMaterial_PbrMaterial;
|
|
6152
5722
|
} | undefined;
|
|
6153
|
-
/**
|
|
6154
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
6155
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
6156
|
-
* supported by the PbMaterial.
|
|
6157
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
6158
|
-
* field with data that reflects the gltf material once it is loaded.
|
|
6159
|
-
*/
|
|
6160
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
6161
5723
|
}
|
|
6162
5724
|
|
|
6163
5725
|
/**
|
|
@@ -6168,22 +5730,6 @@ export declare namespace PBMaterial {
|
|
|
6168
5730
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
6169
5731
|
}
|
|
6170
5732
|
|
|
6171
|
-
/**
|
|
6172
|
-
* @public
|
|
6173
|
-
*/
|
|
6174
|
-
export declare interface PBMaterial_GltfMaterial {
|
|
6175
|
-
gltfSrc: string;
|
|
6176
|
-
name: string;
|
|
6177
|
-
}
|
|
6178
|
-
|
|
6179
|
-
/**
|
|
6180
|
-
* @public
|
|
6181
|
-
*/
|
|
6182
|
-
export declare namespace PBMaterial_GltfMaterial {
|
|
6183
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
6184
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
6185
|
-
}
|
|
6186
|
-
|
|
6187
5733
|
/**
|
|
6188
5734
|
* @public
|
|
6189
5735
|
*/
|
|
@@ -6280,9 +5826,6 @@ export declare interface PBMeshCollider {
|
|
|
6280
5826
|
} | {
|
|
6281
5827
|
$case: "plane";
|
|
6282
5828
|
plane: PBMeshCollider_PlaneMesh;
|
|
6283
|
-
} | {
|
|
6284
|
-
$case: "gltf";
|
|
6285
|
-
gltf: PBMeshCollider_GltfMesh;
|
|
6286
5829
|
} | undefined;
|
|
6287
5830
|
}
|
|
6288
5831
|
|
|
@@ -6328,25 +5871,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
6328
5871
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
6329
5872
|
}
|
|
6330
5873
|
|
|
6331
|
-
/** A collider constructed from a Gltf Mesh. */
|
|
6332
|
-
/**
|
|
6333
|
-
* @public
|
|
6334
|
-
*/
|
|
6335
|
-
export declare interface PBMeshCollider_GltfMesh {
|
|
6336
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6337
|
-
gltfSrc: string;
|
|
6338
|
-
/** the name of the mesh asset */
|
|
6339
|
-
name: string;
|
|
6340
|
-
}
|
|
6341
|
-
|
|
6342
|
-
/**
|
|
6343
|
-
* @public
|
|
6344
|
-
*/
|
|
6345
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
|
6346
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6347
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
6348
|
-
}
|
|
6349
|
-
|
|
6350
5874
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
6351
5875
|
/**
|
|
6352
5876
|
* @public
|
|
@@ -6379,11 +5903,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
6379
5903
|
|
|
6380
5904
|
/**
|
|
6381
5905
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
6382
|
-
* plane, a sphere
|
|
5906
|
+
* plane, a sphere or a cylinder.
|
|
6383
5907
|
*
|
|
6384
5908
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
6385
5909
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
6386
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.
|
|
6387
5913
|
*/
|
|
6388
5914
|
/**
|
|
6389
5915
|
* @public
|
|
@@ -6401,9 +5927,6 @@ export declare interface PBMeshRenderer {
|
|
|
6401
5927
|
} | {
|
|
6402
5928
|
$case: "plane";
|
|
6403
5929
|
plane: PBMeshRenderer_PlaneMesh;
|
|
6404
|
-
} | {
|
|
6405
|
-
$case: "gltf";
|
|
6406
|
-
gltf: PBMeshRenderer_GltfMesh;
|
|
6407
5930
|
} | undefined;
|
|
6408
5931
|
}
|
|
6409
5932
|
|
|
@@ -6451,25 +5974,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
6451
5974
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
6452
5975
|
}
|
|
6453
5976
|
|
|
6454
|
-
/** A mesh from a Gltf. */
|
|
6455
|
-
/**
|
|
6456
|
-
* @public
|
|
6457
|
-
*/
|
|
6458
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
|
6459
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
|
6460
|
-
gltfSrc: string;
|
|
6461
|
-
/** the name of the mesh asset */
|
|
6462
|
-
name: string;
|
|
6463
|
-
}
|
|
6464
|
-
|
|
6465
|
-
/**
|
|
6466
|
-
* @public
|
|
6467
|
-
*/
|
|
6468
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
|
6469
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
6470
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
6471
|
-
}
|
|
6472
|
-
|
|
6473
5977
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
6474
5978
|
/**
|
|
6475
5979
|
* @public
|
|
@@ -7066,10 +6570,7 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
7066
6570
|
screenCoordinates?: PBVector2 | undefined;
|
|
7067
6571
|
/** Movement since last frame (pixels) */
|
|
7068
6572
|
screenDelta?: PBVector2 | undefined;
|
|
7069
|
-
/**
|
|
7070
|
-
* ray direction that can be used with the primary camera origin for
|
|
7071
|
-
* raycasting from the cursor into the world
|
|
7072
|
-
*/
|
|
6573
|
+
/** Direction vector for 3D ray casting */
|
|
7073
6574
|
worldRayDirection?: PBVector3 | undefined;
|
|
7074
6575
|
}
|
|
7075
6576
|
|
|
@@ -7140,10 +6641,6 @@ export declare interface PBRaycast {
|
|
|
7140
6641
|
continuous?: boolean | undefined;
|
|
7141
6642
|
/** Collision mask, by default CL_POINTER | CL_PHYSICS */
|
|
7142
6643
|
collisionMask?: number | undefined;
|
|
7143
|
-
/** shape to cast, default ray */
|
|
7144
|
-
shape?: RaycastShape | undefined;
|
|
7145
|
-
/** include hits with entities from other scenes */
|
|
7146
|
-
includeWorld?: boolean | undefined;
|
|
7147
6644
|
}
|
|
7148
6645
|
|
|
7149
6646
|
/**
|
|
@@ -7213,6 +6710,105 @@ export declare namespace PBRealmInfo {
|
|
|
7213
6710
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
|
7214
6711
|
}
|
|
7215
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
|
+
|
|
7216
6812
|
/**
|
|
7217
6813
|
* The SkyboxTime component allows controlling the time of day for the skybox,
|
|
7218
6814
|
* affecting the lighting and appearance of the sky in the scene.
|
|
@@ -7235,6 +6831,42 @@ export declare namespace PBSkyboxTime {
|
|
|
7235
6831
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSkyboxTime;
|
|
7236
6832
|
}
|
|
7237
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
|
+
|
|
7238
6870
|
/**
|
|
7239
6871
|
* The TextShape component renders customizable floating text.
|
|
7240
6872
|
*
|
|
@@ -7301,46 +6933,6 @@ export declare namespace PBTextShape {
|
|
|
7301
6933
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
7302
6934
|
}
|
|
7303
6935
|
|
|
7304
|
-
/**
|
|
7305
|
-
* @public
|
|
7306
|
-
*/
|
|
7307
|
-
export declare interface PBTextureCamera {
|
|
7308
|
-
/** rendered texture width */
|
|
7309
|
-
width?: number | undefined;
|
|
7310
|
-
/** rendered texture height */
|
|
7311
|
-
height?: number | undefined;
|
|
7312
|
-
/**
|
|
7313
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
7314
|
-
* defaults to 0
|
|
7315
|
-
*/
|
|
7316
|
-
layer?: number | undefined;
|
|
7317
|
-
/** default black */
|
|
7318
|
-
clearColor?: PBColor4 | undefined;
|
|
7319
|
-
/** default infinity */
|
|
7320
|
-
farPlane?: number | undefined;
|
|
7321
|
-
mode?: {
|
|
7322
|
-
$case: "perspective";
|
|
7323
|
-
perspective: Perspective;
|
|
7324
|
-
} | {
|
|
7325
|
-
$case: "orthographic";
|
|
7326
|
-
orthographic: Orthographic;
|
|
7327
|
-
} | undefined;
|
|
7328
|
-
/**
|
|
7329
|
-
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
7330
|
-
* range: 0 (off) - 1 (full volume)
|
|
7331
|
-
* default: 0
|
|
7332
|
-
*/
|
|
7333
|
-
volume?: number | undefined;
|
|
7334
|
-
}
|
|
7335
|
-
|
|
7336
|
-
/**
|
|
7337
|
-
* @public
|
|
7338
|
-
*/
|
|
7339
|
-
export declare namespace PBTextureCamera {
|
|
7340
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
7341
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
7342
|
-
}
|
|
7343
|
-
|
|
7344
6936
|
/**
|
|
7345
6937
|
* The TouchScreenControls component lets a scene configure the native on-screen touch
|
|
7346
6938
|
* controls (the mobile joystick + gamepad). It must be set on the RootEntity.
|
|
@@ -7586,25 +7178,6 @@ export declare namespace PBUiBackground {
|
|
|
7586
7178
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
7587
7179
|
}
|
|
7588
7180
|
|
|
7589
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
7590
|
-
/**
|
|
7591
|
-
* @public
|
|
7592
|
-
*/
|
|
7593
|
-
export declare interface PBUiCanvas {
|
|
7594
|
-
width: number;
|
|
7595
|
-
height: number;
|
|
7596
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
7597
|
-
color?: PBColor4 | undefined;
|
|
7598
|
-
}
|
|
7599
|
-
|
|
7600
|
-
/**
|
|
7601
|
-
* @public
|
|
7602
|
-
*/
|
|
7603
|
-
export declare namespace PBUiCanvas {
|
|
7604
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
7605
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
7606
|
-
}
|
|
7607
|
-
|
|
7608
7181
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
7609
7182
|
/**
|
|
7610
7183
|
* @public
|
|
@@ -7704,10 +7277,6 @@ export declare interface PBUiInput {
|
|
|
7704
7277
|
/** default=10 */
|
|
7705
7278
|
fontSize?: number | undefined;
|
|
7706
7279
|
value?: string | undefined;
|
|
7707
|
-
/** default=false; when true, the input accepts newlines and behaves as a textarea */
|
|
7708
|
-
multiLine?: boolean | undefined;
|
|
7709
|
-
/** default=true; when false, the input value is preserved after pressing Enter */
|
|
7710
|
-
clearOnSubmit?: boolean | undefined;
|
|
7711
7280
|
/** a ttf font file in the scene content or a Google Fonts family name; `font` is the fallback (default: unset) */
|
|
7712
7281
|
fontSrc?: string | undefined;
|
|
7713
7282
|
}
|
|
@@ -7773,21 +7342,6 @@ export declare namespace PBUiInputResult {
|
|
|
7773
7342
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
7774
7343
|
}
|
|
7775
7344
|
|
|
7776
|
-
/**
|
|
7777
|
-
* @public
|
|
7778
|
-
*/
|
|
7779
|
-
export declare interface PBUiScrollResult {
|
|
7780
|
-
value: PBVector2 | undefined;
|
|
7781
|
-
}
|
|
7782
|
-
|
|
7783
|
-
/**
|
|
7784
|
-
* @public
|
|
7785
|
-
*/
|
|
7786
|
-
export declare namespace PBUiScrollResult {
|
|
7787
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
7788
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
7789
|
-
}
|
|
7790
|
-
|
|
7791
7345
|
/**
|
|
7792
7346
|
* @public
|
|
7793
7347
|
*/
|
|
@@ -7933,12 +7487,6 @@ export declare interface PBUiTransform {
|
|
|
7933
7487
|
borderRightColor?: PBColor4 | undefined;
|
|
7934
7488
|
/** default: 1 */
|
|
7935
7489
|
opacity?: number | undefined;
|
|
7936
|
-
/** reference for scroll_position. default empty */
|
|
7937
|
-
elementId?: string | undefined;
|
|
7938
|
-
/** default position=(0,0) */
|
|
7939
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
|
7940
|
-
/** default ShowScrollBar.SSB_BOTH */
|
|
7941
|
-
scrollVisible?: ShowScrollBar | undefined;
|
|
7942
7490
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
7943
7491
|
zIndex?: number | undefined;
|
|
7944
7492
|
}
|
|
@@ -8091,25 +7639,6 @@ export declare namespace PBVisibilityComponent {
|
|
|
8091
7639
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
8092
7640
|
}
|
|
8093
7641
|
|
|
8094
|
-
/**
|
|
8095
|
-
* @public
|
|
8096
|
-
*/
|
|
8097
|
-
export declare interface Perspective {
|
|
8098
|
-
/**
|
|
8099
|
-
* vertical field of view in radians
|
|
8100
|
-
* defaults to pi/4 = 45 degrees
|
|
8101
|
-
*/
|
|
8102
|
-
fieldOfView?: number | undefined;
|
|
8103
|
-
}
|
|
8104
|
-
|
|
8105
|
-
/**
|
|
8106
|
-
* @public
|
|
8107
|
-
*/
|
|
8108
|
-
export declare namespace Perspective {
|
|
8109
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
8110
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
8111
|
-
}
|
|
8112
|
-
|
|
8113
7642
|
/**
|
|
8114
7643
|
* @public
|
|
8115
7644
|
* Physics helpers for applying impulses and forces to the player.
|
|
@@ -8351,24 +7880,6 @@ export declare interface PointerEventsSystem {
|
|
|
8351
7880
|
* @param entity - Entity where the callback was attached
|
|
8352
7881
|
*/
|
|
8353
7882
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
8354
|
-
/**
|
|
8355
|
-
* @public
|
|
8356
|
-
* Remove the callback for onPointerDrag event
|
|
8357
|
-
* @param entity - Entity where the callback was attached
|
|
8358
|
-
*/
|
|
8359
|
-
removeOnPointerDrag(entity: Entity): void;
|
|
8360
|
-
/**
|
|
8361
|
-
* @public
|
|
8362
|
-
* Remove the callback for onPointerDragLocked event
|
|
8363
|
-
* @param entity - Entity where the callback was attached
|
|
8364
|
-
*/
|
|
8365
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
|
8366
|
-
/**
|
|
8367
|
-
* @public
|
|
8368
|
-
* Remove the callback for onPointerDragEnd event
|
|
8369
|
-
* @param entity - Entity where the callback was attached
|
|
8370
|
-
*/
|
|
8371
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
|
8372
7883
|
/**
|
|
8373
7884
|
* @public
|
|
8374
7885
|
* Remove the callback for onProximityDown event
|
|
@@ -8447,36 +7958,6 @@ export declare interface PointerEventsSystem {
|
|
|
8447
7958
|
entity: Entity;
|
|
8448
7959
|
opts?: Partial<EventSystemOptions>;
|
|
8449
7960
|
}, cb: EventSystemCallback): void;
|
|
8450
|
-
/**
|
|
8451
|
-
* @public
|
|
8452
|
-
* Execute callback while the user holds the button pressed and moves the pointer, having pressed it on the entity
|
|
8453
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8454
|
-
* @param cb - Function to execute on every drag update
|
|
8455
|
-
*/
|
|
8456
|
-
onPointerDrag(pointerData: {
|
|
8457
|
-
entity: Entity;
|
|
8458
|
-
opts?: Partial<EventSystemOptions>;
|
|
8459
|
-
}, cb: EventSystemCallback): void;
|
|
8460
|
-
/**
|
|
8461
|
-
* @public
|
|
8462
|
-
* Same as onPointerDrag, but the cursor is locked in place for the duration of the drag
|
|
8463
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8464
|
-
* @param cb - Function to execute on every drag update
|
|
8465
|
-
*/
|
|
8466
|
-
onPointerDragLocked(pointerData: {
|
|
8467
|
-
entity: Entity;
|
|
8468
|
-
opts?: Partial<EventSystemOptions>;
|
|
8469
|
-
}, cb: EventSystemCallback): void;
|
|
8470
|
-
/**
|
|
8471
|
-
* @public
|
|
8472
|
-
* Execute callback when the user releases the button after a drag that started on the entity
|
|
8473
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
8474
|
-
* @param cb - Function to execute when the drag ends
|
|
8475
|
-
*/
|
|
8476
|
-
onPointerDragEnd(pointerData: {
|
|
8477
|
-
entity: Entity;
|
|
8478
|
-
opts?: Partial<EventSystemOptions>;
|
|
8479
|
-
}, cb: EventSystemCallback): void;
|
|
8480
7961
|
/**
|
|
8481
7962
|
* @public
|
|
8482
7963
|
* Execute callback when the user presses the proximity button on the entity
|
|
@@ -8535,10 +8016,7 @@ export declare const enum PointerEventType {
|
|
|
8535
8016
|
PET_HOVER_ENTER = 2,
|
|
8536
8017
|
PET_HOVER_LEAVE = 3,
|
|
8537
8018
|
PET_PROXIMITY_ENTER = 4,
|
|
8538
|
-
PET_PROXIMITY_LEAVE = 5
|
|
8539
|
-
PET_DRAG_LOCKED = 6,
|
|
8540
|
-
PET_DRAG = 7,
|
|
8541
|
-
PET_DRAG_END = 8
|
|
8019
|
+
PET_PROXIMITY_LEAVE = 5
|
|
8542
8020
|
}
|
|
8543
8021
|
|
|
8544
8022
|
/**
|
|
@@ -8569,10 +8047,7 @@ export declare const enum PointerType {
|
|
|
8569
8047
|
/** POT_NONE - No pointer input */
|
|
8570
8048
|
POT_NONE = 0,
|
|
8571
8049
|
/** POT_MOUSE - Traditional mouse input */
|
|
8572
|
-
POT_MOUSE = 1
|
|
8573
|
-
POT_PAD = 2,
|
|
8574
|
-
POT_TOUCH = 3,
|
|
8575
|
-
POT_WAND = 4
|
|
8050
|
+
POT_MOUSE = 1
|
|
8576
8051
|
}
|
|
8577
8052
|
|
|
8578
8053
|
/**
|
|
@@ -9029,16 +8504,6 @@ export declare const enum RaycastQueryType {
|
|
|
9029
8504
|
/** @public */
|
|
9030
8505
|
export declare const RaycastResult: LastWriteWinElementSetComponentDefinition<PBRaycastResult>;
|
|
9031
8506
|
|
|
9032
|
-
/**
|
|
9033
|
-
* @public
|
|
9034
|
-
*/
|
|
9035
|
-
export declare const enum RaycastShape {
|
|
9036
|
-
/** RS_RAY - cast a point, get collisions along a ray */
|
|
9037
|
-
RS_RAY = 0,
|
|
9038
|
-
/** RS_AVATAR - cast the avatar collider shape, get collisions from sweeping the shape */
|
|
9039
|
-
RS_AVATAR = 1
|
|
9040
|
-
}
|
|
9041
|
-
|
|
9042
8507
|
/**
|
|
9043
8508
|
* @public
|
|
9044
8509
|
*/
|
|
@@ -9171,10 +8636,6 @@ export declare type RaycastSystemOptions = {
|
|
|
9171
8636
|
queryType: RaycastQueryType;
|
|
9172
8637
|
continuous?: boolean | undefined;
|
|
9173
8638
|
collisionMask?: number | undefined;
|
|
9174
|
-
/** shape to sweep along the ray, default RS_RAY (a point) */
|
|
9175
|
-
shape?: RaycastShape | undefined;
|
|
9176
|
-
/** include colliders from other scenes, default false */
|
|
9177
|
-
includeWorld?: boolean | undefined;
|
|
9178
8639
|
};
|
|
9179
8640
|
|
|
9180
8641
|
/**
|
|
@@ -9223,20 +8684,6 @@ export declare interface ReactBasedUiSystem {
|
|
|
9223
8684
|
* @param entity - The entity whose UI renderer should be removed
|
|
9224
8685
|
*/
|
|
9225
8686
|
removeUiRenderer(entity: Entity): void;
|
|
9226
|
-
/**
|
|
9227
|
-
* Render a UI tree to a texture. The tree is rooted at `entity`, which must carry a UiCanvas
|
|
9228
|
-
* describing the texture; the result can be sampled through `TextureUnion.uiTexture`. Replaces
|
|
9229
|
-
* any texture renderer already set on the entity, and is torn down when the entity is removed.
|
|
9230
|
-
*
|
|
9231
|
-
* @param entity - The UiCanvas entity the UI tree hangs from
|
|
9232
|
-
* @param ui - The UI component to render
|
|
9233
|
-
*/
|
|
9234
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
9235
|
-
/**
|
|
9236
|
-
* Remove a texture renderer previously set with setTextureRenderer(), destroying its entities.
|
|
9237
|
-
* @param entity - The UiCanvas entity the renderer was set on
|
|
9238
|
-
*/
|
|
9239
|
-
removeTextureRenderer(entity: Entity): void;
|
|
9240
8687
|
}
|
|
9241
8688
|
|
|
9242
8689
|
/**
|
|
@@ -9827,33 +9274,6 @@ export declare namespace Schemas {
|
|
|
9827
9274
|
*/
|
|
9828
9275
|
export declare function ScreenInsetArea(props: UiScreenInsetAreaProps): ReactEcs.JSX.Element;
|
|
9829
9276
|
|
|
9830
|
-
/**
|
|
9831
|
-
* @public
|
|
9832
|
-
*/
|
|
9833
|
-
export declare interface ScrollPositionValue {
|
|
9834
|
-
value?: {
|
|
9835
|
-
$case: "position";
|
|
9836
|
-
position: PBVector2;
|
|
9837
|
-
} | {
|
|
9838
|
-
$case: "reference";
|
|
9839
|
-
reference: string;
|
|
9840
|
-
} | undefined;
|
|
9841
|
-
}
|
|
9842
|
-
|
|
9843
|
-
/**
|
|
9844
|
-
* @public
|
|
9845
|
-
*/
|
|
9846
|
-
export declare namespace ScrollPositionValue {
|
|
9847
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
9848
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
9849
|
-
}
|
|
9850
|
-
|
|
9851
|
-
/**
|
|
9852
|
-
* Which scrollbars are shown when the overflow is scrollable
|
|
9853
|
-
* @public
|
|
9854
|
-
*/
|
|
9855
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
9856
|
-
|
|
9857
9277
|
/**
|
|
9858
9278
|
* Register the composite provider used to resolve composite files. Also registers
|
|
9859
9279
|
* any `provider.schemas` on the engine pre-seal so composites that reference those
|
|
@@ -9879,15 +9299,8 @@ export declare interface SetMoveRotateScaleParams extends MoveRotateScaleModePar
|
|
|
9879
9299
|
easingFunction?: EasingFunction;
|
|
9880
9300
|
}
|
|
9881
9301
|
|
|
9882
|
-
/**
|
|
9883
|
-
|
|
9884
|
-
*/
|
|
9885
|
-
export declare const enum ShowScrollBar {
|
|
9886
|
-
SSB_BOTH = 0,
|
|
9887
|
-
SSB_ONLY_VERTICAL = 1,
|
|
9888
|
-
SSB_ONLY_HORIZONTAL = 2,
|
|
9889
|
-
SSB_HIDDEN = 3
|
|
9890
|
-
}
|
|
9302
|
+
/** @public */
|
|
9303
|
+
export declare const Skybox: LastWriteWinElementSetComponentDefinition<PBSkybox>;
|
|
9891
9304
|
|
|
9892
9305
|
/** @public */
|
|
9893
9306
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
@@ -9899,6 +9312,9 @@ export declare interface Spec {
|
|
|
9899
9312
|
[key: string]: ISchema;
|
|
9900
9313
|
}
|
|
9901
9314
|
|
|
9315
|
+
/** @public */
|
|
9316
|
+
export declare const Sun: LastWriteWinElementSetComponentDefinition<PBSun>;
|
|
9317
|
+
|
|
9902
9318
|
/**
|
|
9903
9319
|
* @alpha
|
|
9904
9320
|
* This is going to be used for sync components through a server.
|
|
@@ -10000,9 +9416,6 @@ export declare namespace Texture {
|
|
|
10000
9416
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
10001
9417
|
}
|
|
10002
9418
|
|
|
10003
|
-
/** @public */
|
|
10004
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
10005
|
-
|
|
10006
9419
|
/**
|
|
10007
9420
|
* @public
|
|
10008
9421
|
*/
|
|
@@ -10113,9 +9526,6 @@ export declare interface TextureUnion {
|
|
|
10113
9526
|
} | {
|
|
10114
9527
|
$case: "videoTexture";
|
|
10115
9528
|
videoTexture: VideoTexture;
|
|
10116
|
-
} | {
|
|
10117
|
-
$case: "uiTexture";
|
|
10118
|
-
uiTexture: UiCanvasTexture;
|
|
10119
9529
|
} | undefined;
|
|
10120
9530
|
}
|
|
10121
9531
|
|
|
@@ -10346,16 +9756,6 @@ export declare type Transport = {
|
|
|
10346
9756
|
onmessage?(message: Uint8Array): void;
|
|
10347
9757
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
|
10348
9758
|
type?: string;
|
|
10349
|
-
/**
|
|
10350
|
-
* Whether this transport is allowed to mutate reserved-range entities
|
|
10351
|
-
* (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
|
|
10352
|
-
* Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
|
|
10353
|
-
* or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
|
|
10354
|
-
* AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
|
|
10355
|
-
* this flag (a comms peer, or any scene-added transport) is rejected — see
|
|
10356
|
-
* `receiveMessages`.
|
|
10357
|
-
*/
|
|
10358
|
-
allowReservedEntities?: boolean;
|
|
10359
9759
|
};
|
|
10360
9760
|
|
|
10361
9761
|
/**
|
|
@@ -10664,8 +10064,6 @@ export declare interface UiBackgroundProps {
|
|
|
10664
10064
|
uvs?: number[];
|
|
10665
10065
|
/** AvatarTexture for the background */
|
|
10666
10066
|
avatarTexture?: UiAvatarTexture;
|
|
10667
|
-
/** VideoTexture for the background: the frames of a VideoPlayer on another entity */
|
|
10668
|
-
videoTexture?: UiVideoTexture;
|
|
10669
10067
|
/** Texture for the background */
|
|
10670
10068
|
texture?: UiTexture;
|
|
10671
10069
|
}
|
|
@@ -10685,31 +10083,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
10685
10083
|
disabled?: boolean;
|
|
10686
10084
|
}
|
|
10687
10085
|
|
|
10688
|
-
/** @public */
|
|
10689
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
10690
|
-
|
|
10691
10086
|
/** @public */
|
|
10692
10087
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
10693
10088
|
|
|
10694
|
-
/**
|
|
10695
|
-
* @public
|
|
10696
|
-
*/
|
|
10697
|
-
export declare interface UiCanvasTexture {
|
|
10698
|
-
uiCanvasEntity: number;
|
|
10699
|
-
/** default = TextureWrapMode.Clamp */
|
|
10700
|
-
wrapMode?: TextureWrapMode | undefined;
|
|
10701
|
-
/** default = FilterMode.Bilinear */
|
|
10702
|
-
filterMode?: TextureFilterMode | undefined;
|
|
10703
|
-
}
|
|
10704
|
-
|
|
10705
|
-
/**
|
|
10706
|
-
* @public
|
|
10707
|
-
*/
|
|
10708
|
-
export declare namespace UiCanvasTexture {
|
|
10709
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
10710
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
10711
|
-
}
|
|
10712
|
-
|
|
10713
10089
|
/**
|
|
10714
10090
|
* @public
|
|
10715
10091
|
*/
|
|
@@ -10805,7 +10181,7 @@ export declare interface UiLabelProps {
|
|
|
10805
10181
|
textAlign?: TextAlignType | undefined;
|
|
10806
10182
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
10807
10183
|
font?: UiFontType | undefined;
|
|
10808
|
-
/**
|
|
10184
|
+
/** Path to a `.ttf` file in the scene content. `font` is used when it can't be loaded. */
|
|
10809
10185
|
fontSrc?: string | undefined;
|
|
10810
10186
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
10811
10187
|
textWrap?: UiTextWrapType | undefined;
|
|
@@ -10875,9 +10251,6 @@ export declare type UiScreenInsetAreaProps = Omit<EntityPropTypes, 'uiTransform'
|
|
|
10875
10251
|
uiTransform?: Omit<NonNullable<EntityPropTypes['uiTransform']>, 'positionType' | 'position'>;
|
|
10876
10252
|
};
|
|
10877
10253
|
|
|
10878
|
-
/** @public */
|
|
10879
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
10880
|
-
|
|
10881
10254
|
/** @public */
|
|
10882
10255
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
10883
10256
|
|
|
@@ -10957,22 +10330,6 @@ export declare interface UiTransformProps {
|
|
|
10957
10330
|
opacity?: number;
|
|
10958
10331
|
/** default 0 */
|
|
10959
10332
|
zIndex?: number;
|
|
10960
|
-
/** A reference id for the element, e.g. as a scrollPosition target or for SetUiFocus. default empty */
|
|
10961
|
-
elementId?: string;
|
|
10962
|
-
/** Scroll offset when overflow is 'scroll': a position, or the elementId of a child to scroll to. default (0, 0) */
|
|
10963
|
-
scrollPosition?: PBVector2 | string;
|
|
10964
|
-
/** Which scrollbars to show when overflow is 'scroll'. default 'both' */
|
|
10965
|
-
scrollVisible?: ScrollVisibleType;
|
|
10966
|
-
}
|
|
10967
|
-
|
|
10968
|
-
/**
|
|
10969
|
-
* Video Texture
|
|
10970
|
-
* @public
|
|
10971
|
-
*/
|
|
10972
|
-
export declare interface UiVideoTexture {
|
|
10973
|
-
videoPlayerEntity: Entity;
|
|
10974
|
-
wrapMode?: TextureWrapType;
|
|
10975
|
-
filterMode?: TextureFilterType;
|
|
10976
10333
|
}
|
|
10977
10334
|
|
|
10978
10335
|
/**
|
|
@@ -10980,14 +10337,6 @@ export declare interface UiVideoTexture {
|
|
|
10980
10337
|
*/
|
|
10981
10338
|
export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
|
|
10982
10339
|
|
|
10983
|
-
export declare type ValidateCallback<T> = (value: {
|
|
10984
|
-
entity: Entity;
|
|
10985
|
-
currentValue: T | undefined;
|
|
10986
|
-
newValue: T | undefined;
|
|
10987
|
-
senderAddress: string;
|
|
10988
|
-
createdBy: string;
|
|
10989
|
-
}) => boolean;
|
|
10990
|
-
|
|
10991
10340
|
/**
|
|
10992
10341
|
* @public
|
|
10993
10342
|
*/
|