@dcl/playground-assets 7.20.0 → 7.20.1-21915113771.commit-e132905
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 +827 -18
- package/dist/beta.d.ts +827 -18
- package/dist/index.bundled.d.ts +827 -18
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/apis.d.ts +17 -0
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +827 -18
- package/dist/tsdoc-metadata.json +1 -1
- package/etc/playground-assets.api.json +13739 -5729
- package/etc/playground-assets.api.md +541 -10
- package/package.json +4 -4
package/dist/beta.d.ts
CHANGED
|
@@ -203,12 +203,36 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
|
|
|
203
203
|
/** @public */
|
|
204
204
|
export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
|
|
205
205
|
|
|
206
|
+
/**
|
|
207
|
+
* @public
|
|
208
|
+
*/
|
|
209
|
+
export declare const enum AvatarControlType {
|
|
210
|
+
/** CCT_NONE - avatar cannot move */
|
|
211
|
+
CCT_NONE = 0,
|
|
212
|
+
/** CCT_RELATIVE - avatar moves relative to the camera origin */
|
|
213
|
+
CCT_RELATIVE = 1,
|
|
214
|
+
/** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
|
|
215
|
+
CCT_TANK = 2
|
|
216
|
+
}
|
|
217
|
+
|
|
206
218
|
/** @public */
|
|
207
219
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
208
220
|
|
|
209
221
|
/** @public */
|
|
210
222
|
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
211
223
|
|
|
224
|
+
/**
|
|
225
|
+
* @public
|
|
226
|
+
*/
|
|
227
|
+
export declare type AvatarEquippedDataComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType>;
|
|
228
|
+
|
|
229
|
+
export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
|
|
230
|
+
forceRender?: string[] | undefined;
|
|
231
|
+
};
|
|
232
|
+
|
|
233
|
+
/** @public */
|
|
234
|
+
export declare const AvatarLocomotionSettings: LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>;
|
|
235
|
+
|
|
212
236
|
/** @public */
|
|
213
237
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
|
214
238
|
|
|
@@ -223,9 +247,49 @@ export declare const enum AvatarModifierType {
|
|
|
223
247
|
AMT_DISABLE_PASSPORTS = 1
|
|
224
248
|
}
|
|
225
249
|
|
|
250
|
+
/**
|
|
251
|
+
* @public
|
|
252
|
+
*/
|
|
253
|
+
export declare interface AvatarMovementSettings {
|
|
254
|
+
controlMode?: AvatarControlType | undefined;
|
|
255
|
+
/** if not explicitly set, the following properties default to user's preference settings */
|
|
256
|
+
runSpeed?: number | undefined;
|
|
257
|
+
/** how fast the player gets up to speed or comes to rest. higher = more responsive */
|
|
258
|
+
friction?: number | undefined;
|
|
259
|
+
/** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
|
|
260
|
+
gravity?: number | undefined;
|
|
261
|
+
/** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
|
|
262
|
+
jumpHeight?: number | undefined;
|
|
263
|
+
/** max fall speed in m/s. should normally be negative */
|
|
264
|
+
maxFallSpeed?: number | undefined;
|
|
265
|
+
/** speed the player turns in tank mode, in radians/s */
|
|
266
|
+
turnSpeed?: number | undefined;
|
|
267
|
+
/** speed the player walks at, in m/s */
|
|
268
|
+
walkSpeed?: number | undefined;
|
|
269
|
+
/** whether to allow player to move at a slower speed (e.g. with a walk-key or when using a gamepad/joystick). defaults to true */
|
|
270
|
+
allowWeightedMovement?: boolean | undefined;
|
|
271
|
+
}
|
|
272
|
+
|
|
273
|
+
/**
|
|
274
|
+
* @public
|
|
275
|
+
*/
|
|
276
|
+
export declare namespace AvatarMovementSettings {
|
|
277
|
+
export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
|
|
278
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
|
279
|
+
}
|
|
280
|
+
|
|
226
281
|
/** @public */
|
|
227
282
|
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
|
228
283
|
|
|
284
|
+
/**
|
|
285
|
+
* @public
|
|
286
|
+
*/
|
|
287
|
+
export declare type AvatarShapeComponentDefinitionExtended = LastWriteWinElementSetComponentDefinition<AvatarShapeType>;
|
|
288
|
+
|
|
289
|
+
export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
|
|
290
|
+
forceRender?: string[] | undefined;
|
|
291
|
+
};
|
|
292
|
+
|
|
229
293
|
/**
|
|
230
294
|
* @public
|
|
231
295
|
*/
|
|
@@ -493,11 +557,19 @@ export declare interface ByteBuffer {
|
|
|
493
557
|
}
|
|
494
558
|
|
|
495
559
|
/**
|
|
496
|
-
* Callback function
|
|
497
|
-
*
|
|
560
|
+
* legacy Callback function
|
|
561
|
+
*
|
|
562
|
+
* @public @deprecated This type is no longer used in the sdk api, EventSystemCallback is
|
|
563
|
+
* used for listeners instead
|
|
498
564
|
*/
|
|
499
565
|
export declare type Callback = () => void;
|
|
500
566
|
|
|
567
|
+
/** @public */
|
|
568
|
+
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
|
569
|
+
|
|
570
|
+
/** @public */
|
|
571
|
+
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
|
572
|
+
|
|
501
573
|
/** @public */
|
|
502
574
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
|
503
575
|
|
|
@@ -555,6 +627,39 @@ export declare const enum CameraType {
|
|
|
555
627
|
|
|
556
628
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
|
557
629
|
|
|
630
|
+
/**
|
|
631
|
+
* @public
|
|
632
|
+
*/
|
|
633
|
+
export declare interface CinematicSettings {
|
|
634
|
+
/** Entity that defines the cinematic camera transform. */
|
|
635
|
+
cameraEntity: number;
|
|
636
|
+
/**
|
|
637
|
+
* Position -> camera's position
|
|
638
|
+
* Rotation -> camera's direction
|
|
639
|
+
* scale.z -> zoom level
|
|
640
|
+
* scale.x and scale.y -> unused
|
|
641
|
+
*/
|
|
642
|
+
allowManualRotation?: boolean | undefined;
|
|
643
|
+
/** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
|
|
644
|
+
yawRange?: number | undefined;
|
|
645
|
+
/** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
|
|
646
|
+
pitchRange?: number | undefined;
|
|
647
|
+
/** note: cameras can never look up/down further than Vec3::Y */
|
|
648
|
+
rollRange?: number | undefined;
|
|
649
|
+
/** minimum zoom level. must be greater than 0. defaults to the input zoom level */
|
|
650
|
+
zoomMin?: number | undefined;
|
|
651
|
+
/** maximum zoom level. must be greater than 0. defaults to the input zoom level */
|
|
652
|
+
zoomMax?: number | undefined;
|
|
653
|
+
}
|
|
654
|
+
|
|
655
|
+
/**
|
|
656
|
+
* @public
|
|
657
|
+
*/
|
|
658
|
+
export declare namespace CinematicSettings {
|
|
659
|
+
export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
|
|
660
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
|
|
661
|
+
}
|
|
662
|
+
|
|
558
663
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
|
559
664
|
/**
|
|
560
665
|
* @public
|
|
@@ -1328,15 +1433,21 @@ export declare const componentDefinitionByName: {
|
|
|
1328
1433
|
"core::AvatarBase": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarBase>>;
|
|
1329
1434
|
"core::AvatarEmoteCommand": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>>;
|
|
1330
1435
|
"core::AvatarEquippedData": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>>;
|
|
1436
|
+
"core::AvatarLocomotionSettings": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarLocomotionSettings>>;
|
|
1331
1437
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
|
1332
1438
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
|
1333
1439
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
|
1440
|
+
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
|
1441
|
+
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
|
1334
1442
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
|
1335
1443
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
|
1336
1444
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
|
1445
|
+
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
|
1337
1446
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
|
1338
1447
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
|
1448
|
+
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
|
1339
1449
|
"core::GltfNodeModifiers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>>;
|
|
1450
|
+
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
|
1340
1451
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
|
1341
1452
|
"core::LightSource": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLightSource>>;
|
|
1342
1453
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
|
@@ -1354,17 +1465,20 @@ export declare const componentDefinitionByName: {
|
|
|
1354
1465
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
|
1355
1466
|
"core::SkyboxTime": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSkyboxTime>>;
|
|
1356
1467
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1468
|
+
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
|
1357
1469
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1358
1470
|
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
1359
1471
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
|
1360
1472
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
|
1361
1473
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
|
1362
1474
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
|
1475
|
+
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
|
1363
1476
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
|
1364
1477
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
|
1365
1478
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
|
1366
1479
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
|
1367
1480
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
|
1481
|
+
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
|
1368
1482
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
|
1369
1483
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
|
1370
1484
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
|
@@ -1952,10 +2066,18 @@ export declare type EntityComponents = {
|
|
|
1952
2066
|
uiBackground: PBUiBackground;
|
|
1953
2067
|
uiInput: PBUiInput;
|
|
1954
2068
|
uiDropdown: PBUiDropdown;
|
|
1955
|
-
onMouseDown:
|
|
1956
|
-
onMouseUp:
|
|
1957
|
-
onMouseEnter:
|
|
1958
|
-
onMouseLeave:
|
|
2069
|
+
onMouseDown: EventSystemCallback;
|
|
2070
|
+
onMouseUp: EventSystemCallback;
|
|
2071
|
+
onMouseEnter: EventSystemCallback;
|
|
2072
|
+
onMouseLeave: EventSystemCallback;
|
|
2073
|
+
onMouseDrag: EventSystemCallback;
|
|
2074
|
+
onMouseDragLocked: EventSystemCallback;
|
|
2075
|
+
onMouseDragEnd: EventSystemCallback;
|
|
2076
|
+
onInputDown: MultiCallback;
|
|
2077
|
+
onInputUp: MultiCallback;
|
|
2078
|
+
onInputDrag: MultiCallback;
|
|
2079
|
+
onInputDragLocked: MultiCallback;
|
|
2080
|
+
onInputDragEnd: MultiCallback;
|
|
1959
2081
|
};
|
|
1960
2082
|
|
|
1961
2083
|
/** @public */
|
|
@@ -2034,6 +2156,13 @@ export declare type EventSystemOptions = {
|
|
|
2034
2156
|
maxPlayerDistance?: number;
|
|
2035
2157
|
};
|
|
2036
2158
|
|
|
2159
|
+
/**
|
|
2160
|
+
* @public
|
|
2161
|
+
*/
|
|
2162
|
+
export declare type EventSystemOptionsCallback = EventSystemOptions & {
|
|
2163
|
+
cb: EventSystemCallback;
|
|
2164
|
+
};
|
|
2165
|
+
|
|
2037
2166
|
/**
|
|
2038
2167
|
* Excludes property keys from T where the property is assignable to U
|
|
2039
2168
|
* @public
|
|
@@ -2203,6 +2332,16 @@ export declare const getDefaultOpts: (opts?: Partial<EventSystemOptions>) => Eve
|
|
|
2203
2332
|
*/
|
|
2204
2333
|
export declare function getEntitiesWithParent(engine: Pick<IEngine, 'getEntitiesWith' | 'defineComponentFromSchema'>, parent: Entity): Entity[];
|
|
2205
2334
|
|
|
2335
|
+
/**
|
|
2336
|
+
* Utilities for standardized globalThis access.
|
|
2337
|
+
* @public
|
|
2338
|
+
*/
|
|
2339
|
+
/**
|
|
2340
|
+
* Type-safe globalThis property access.
|
|
2341
|
+
* @public
|
|
2342
|
+
*/
|
|
2343
|
+
export declare function getGlobal<T>(key: string): T | undefined;
|
|
2344
|
+
|
|
2206
2345
|
/**
|
|
2207
2346
|
* Get the world position of an entity, taking into account the full parent hierarchy.
|
|
2208
2347
|
* This computes the world-space position by accumulating all parent transforms
|
|
@@ -2252,6 +2391,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
|
2252
2391
|
direction?: PBVector3;
|
|
2253
2392
|
};
|
|
2254
2393
|
|
|
2394
|
+
/** @public */
|
|
2395
|
+
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
|
2396
|
+
|
|
2255
2397
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
|
2256
2398
|
|
|
2257
2399
|
export declare type GlobalTargetRaycastSystemOptions = {
|
|
@@ -2264,9 +2406,24 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
|
2264
2406
|
/** @public */
|
|
2265
2407
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
|
2266
2408
|
|
|
2409
|
+
/** @public */
|
|
2410
|
+
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
|
2411
|
+
|
|
2267
2412
|
/** @public */
|
|
2268
2413
|
export declare const GltfNodeModifiers: LastWriteWinElementSetComponentDefinition<PBGltfNodeModifiers>;
|
|
2269
2414
|
|
|
2415
|
+
/** @public */
|
|
2416
|
+
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
|
2417
|
+
|
|
2418
|
+
/**
|
|
2419
|
+
* @public
|
|
2420
|
+
*/
|
|
2421
|
+
export declare const enum GltfNodeStateValue {
|
|
2422
|
+
GNSV_PENDING = 0,
|
|
2423
|
+
GNSV_FAILED = 1,
|
|
2424
|
+
GNSV_READY = 2
|
|
2425
|
+
}
|
|
2426
|
+
|
|
2270
2427
|
/**
|
|
2271
2428
|
* @public
|
|
2272
2429
|
*/
|
|
@@ -2612,6 +2769,12 @@ export declare type IInputSystem = {
|
|
|
2612
2769
|
* @returns the input command info or undefined if there is no command in the last tick-update
|
|
2613
2770
|
*/
|
|
2614
2771
|
getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
|
|
2772
|
+
/**
|
|
2773
|
+
* @public
|
|
2774
|
+
* Get an ordered iterator over events received within the current frame.
|
|
2775
|
+
* @returns the iterator
|
|
2776
|
+
*/
|
|
2777
|
+
getInputCommands: () => Generator<PBPointerEventsResult>;
|
|
2615
2778
|
};
|
|
2616
2779
|
|
|
2617
2780
|
/**
|
|
@@ -2907,13 +3070,29 @@ export declare interface LightSourceHelper {
|
|
|
2907
3070
|
*/
|
|
2908
3071
|
export declare type Listeners = {
|
|
2909
3072
|
/** triggered on mouse down event */
|
|
2910
|
-
onMouseDown?:
|
|
3073
|
+
onMouseDown?: EventSystemCallback;
|
|
2911
3074
|
/** triggered on mouse up event */
|
|
2912
|
-
onMouseUp?:
|
|
3075
|
+
onMouseUp?: EventSystemCallback;
|
|
2913
3076
|
/** triggered on mouse hover event */
|
|
2914
|
-
onMouseEnter?:
|
|
3077
|
+
onMouseEnter?: EventSystemCallback;
|
|
2915
3078
|
/** triggered on mouse leave event */
|
|
2916
|
-
onMouseLeave?:
|
|
3079
|
+
onMouseLeave?: EventSystemCallback;
|
|
3080
|
+
/** triggered on mouse drag event */
|
|
3081
|
+
onMouseDrag?: EventSystemCallback;
|
|
3082
|
+
/** triggered on mouse drag event */
|
|
3083
|
+
onMouseDragLocked?: EventSystemCallback;
|
|
3084
|
+
/** triggered on mouse drag event */
|
|
3085
|
+
onMouseDragEnd?: EventSystemCallback;
|
|
3086
|
+
/** triggered on input down event */
|
|
3087
|
+
onInputDown?: MultiCallback;
|
|
3088
|
+
/** triggered on input up event */
|
|
3089
|
+
onInputUp?: MultiCallback;
|
|
3090
|
+
/** triggered on input drag event */
|
|
3091
|
+
onInputDrag?: MultiCallback;
|
|
3092
|
+
/** triggered on input drag event */
|
|
3093
|
+
onInputDragLocked?: MultiCallback;
|
|
3094
|
+
/** triggered on input drag event */
|
|
3095
|
+
onInputDragEnd?: MultiCallback;
|
|
2917
3096
|
};
|
|
2918
3097
|
|
|
2919
3098
|
/**
|
|
@@ -3818,6 +3997,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
3818
3997
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
3819
3998
|
*/
|
|
3820
3999
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4000
|
+
/**
|
|
4001
|
+
* @public
|
|
4002
|
+
* Set a gltf internal mesh in the MeshCollider component
|
|
4003
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
|
4004
|
+
* @param source - the path to the gltf
|
|
4005
|
+
* @param meshName - the name of the mesh in the gltf
|
|
4006
|
+
*/
|
|
4007
|
+
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
3821
4008
|
}
|
|
3822
4009
|
|
|
3823
4010
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -3854,6 +4041,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
3854
4041
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
3855
4042
|
*/
|
|
3856
4043
|
setSphere(entity: Entity): void;
|
|
4044
|
+
/**
|
|
4045
|
+
* @public
|
|
4046
|
+
* Set a gltf internal mesh in the MeshRenderer component
|
|
4047
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
|
4048
|
+
* @param source - the path to the gltf
|
|
4049
|
+
* @param meshName - the name of the mesh in the gltf
|
|
4050
|
+
*/
|
|
4051
|
+
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
3857
4052
|
}
|
|
3858
4053
|
|
|
3859
4054
|
/* Excluded from this release type: MessageBus */
|
|
@@ -3891,6 +4086,19 @@ export declare namespace MoveContinuous {
|
|
|
3891
4086
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
3892
4087
|
}
|
|
3893
4088
|
|
|
4089
|
+
/**
|
|
4090
|
+
* a record object mapping `InputAction`s to functions.
|
|
4091
|
+
*
|
|
4092
|
+
* @example
|
|
4093
|
+
* onInputDown={{
|
|
4094
|
+
* [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
|
|
4095
|
+
* [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
|
|
4096
|
+
* }}
|
|
4097
|
+
*
|
|
4098
|
+
* @public
|
|
4099
|
+
*/
|
|
4100
|
+
export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
|
|
4101
|
+
|
|
3894
4102
|
export declare const Name: NameComponent;
|
|
3895
4103
|
|
|
3896
4104
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4263,6 +4471,25 @@ export declare const onVideoEvent: Observable<{
|
|
|
4263
4471
|
totalVideoLength: number;
|
|
4264
4472
|
}>;
|
|
4265
4473
|
|
|
4474
|
+
/**
|
|
4475
|
+
* @public
|
|
4476
|
+
*/
|
|
4477
|
+
export declare interface Orthographic {
|
|
4478
|
+
/**
|
|
4479
|
+
* vertical extent of the visible range in meters
|
|
4480
|
+
* defaults to 4m
|
|
4481
|
+
*/
|
|
4482
|
+
verticalRange?: number | undefined;
|
|
4483
|
+
}
|
|
4484
|
+
|
|
4485
|
+
/**
|
|
4486
|
+
* @public
|
|
4487
|
+
*/
|
|
4488
|
+
export declare namespace Orthographic {
|
|
4489
|
+
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4490
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4491
|
+
}
|
|
4492
|
+
|
|
4266
4493
|
/**
|
|
4267
4494
|
* @public
|
|
4268
4495
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -4540,6 +4767,8 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
4540
4767
|
export declare interface PBAvatarEquippedData {
|
|
4541
4768
|
wearableUrns: string[];
|
|
4542
4769
|
emoteUrns: string[];
|
|
4770
|
+
/** slots that will render even if hidden */
|
|
4771
|
+
forceRender: string[];
|
|
4543
4772
|
}
|
|
4544
4773
|
|
|
4545
4774
|
/**
|
|
@@ -4550,6 +4779,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4550
4779
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4551
4780
|
}
|
|
4552
4781
|
|
|
4782
|
+
/**
|
|
4783
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4784
|
+
* as the avatar movement speed, jump height etc.
|
|
4785
|
+
*/
|
|
4786
|
+
/**
|
|
4787
|
+
* @public
|
|
4788
|
+
*/
|
|
4789
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4790
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4791
|
+
walkSpeed?: number | undefined;
|
|
4792
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4793
|
+
jogSpeed?: number | undefined;
|
|
4794
|
+
/** Maximum speed when running (in meters per second) */
|
|
4795
|
+
runSpeed?: number | undefined;
|
|
4796
|
+
/** Height of a regular jump (in meters) */
|
|
4797
|
+
jumpHeight?: number | undefined;
|
|
4798
|
+
/** Height of a jump while running (in meters) */
|
|
4799
|
+
runJumpHeight?: number | undefined;
|
|
4800
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4801
|
+
hardLandingCooldown?: number | undefined;
|
|
4802
|
+
}
|
|
4803
|
+
|
|
4804
|
+
/**
|
|
4805
|
+
* @public
|
|
4806
|
+
*/
|
|
4807
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4808
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4809
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4810
|
+
}
|
|
4811
|
+
|
|
4553
4812
|
/**
|
|
4554
4813
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4555
4814
|
* avatar behavior changes.
|
|
@@ -4574,6 +4833,9 @@ export declare interface PBAvatarModifierArea {
|
|
|
4574
4833
|
excludeIds: string[];
|
|
4575
4834
|
/** list of modifiers to apply */
|
|
4576
4835
|
modifiers: AvatarModifierType[];
|
|
4836
|
+
movementSettings?: AvatarMovementSettings | undefined;
|
|
4837
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
4838
|
+
useColliderRange?: boolean | undefined;
|
|
4577
4839
|
}
|
|
4578
4840
|
|
|
4579
4841
|
/**
|
|
@@ -4632,6 +4894,8 @@ export declare interface PBAvatarShape {
|
|
|
4632
4894
|
emotes: string[];
|
|
4633
4895
|
/** hides the skin + hair + facial features (default: false) */
|
|
4634
4896
|
showOnlyWearables?: boolean | undefined;
|
|
4897
|
+
/** slots that will render even if hidden */
|
|
4898
|
+
forceRender: string[];
|
|
4635
4899
|
}
|
|
4636
4900
|
|
|
4637
4901
|
/**
|
|
@@ -4666,6 +4930,51 @@ export declare namespace PBBillboard {
|
|
|
4666
4930
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
4667
4931
|
}
|
|
4668
4932
|
|
|
4933
|
+
/**
|
|
4934
|
+
* @public
|
|
4935
|
+
*/
|
|
4936
|
+
export declare interface PBCameraLayer {
|
|
4937
|
+
/**
|
|
4938
|
+
* layer to which these settings apply. must be > 0
|
|
4939
|
+
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
4940
|
+
*/
|
|
4941
|
+
layer: number;
|
|
4942
|
+
/** should the sun light affect this layer? default false */
|
|
4943
|
+
directionalLight?: boolean | undefined;
|
|
4944
|
+
/** should this layer show player avatars? default false */
|
|
4945
|
+
showAvatars?: boolean | undefined;
|
|
4946
|
+
/** should this layer show the sky? default false */
|
|
4947
|
+
showSkybox?: boolean | undefined;
|
|
4948
|
+
/** should this layer show distance fog? default false */
|
|
4949
|
+
showFog?: boolean | undefined;
|
|
4950
|
+
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
4951
|
+
ambientColorOverride?: PBColor3 | undefined;
|
|
4952
|
+
ambientBrightnessOverride?: number | undefined;
|
|
4953
|
+
}
|
|
4954
|
+
|
|
4955
|
+
/**
|
|
4956
|
+
* @public
|
|
4957
|
+
*/
|
|
4958
|
+
export declare namespace PBCameraLayer {
|
|
4959
|
+
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
4960
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
4961
|
+
}
|
|
4962
|
+
|
|
4963
|
+
/**
|
|
4964
|
+
* @public
|
|
4965
|
+
*/
|
|
4966
|
+
export declare interface PBCameraLayers {
|
|
4967
|
+
layers: number[];
|
|
4968
|
+
}
|
|
4969
|
+
|
|
4970
|
+
/**
|
|
4971
|
+
* @public
|
|
4972
|
+
*/
|
|
4973
|
+
export declare namespace PBCameraLayers {
|
|
4974
|
+
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
4975
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
4976
|
+
}
|
|
4977
|
+
|
|
4669
4978
|
/**
|
|
4670
4979
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
4671
4980
|
* third-person view.
|
|
@@ -4688,7 +4997,7 @@ export declare namespace PBCameraMode {
|
|
|
4688
4997
|
|
|
4689
4998
|
/**
|
|
4690
4999
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
|
4691
|
-
* the player's camera mode (1st-person
|
|
5000
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
|
4692
5001
|
*
|
|
4693
5002
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
|
4694
5003
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
|
@@ -4698,6 +5007,8 @@ export declare namespace PBCameraMode {
|
|
|
4698
5007
|
*
|
|
4699
5008
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
|
4700
5009
|
* is actually a 3D volume.
|
|
5010
|
+
*
|
|
5011
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
|
4701
5012
|
*/
|
|
4702
5013
|
/**
|
|
4703
5014
|
* @public
|
|
@@ -4707,6 +5018,9 @@ export declare interface PBCameraModeArea {
|
|
|
4707
5018
|
area: PBVector3 | undefined;
|
|
4708
5019
|
/** the camera mode to enforce */
|
|
4709
5020
|
mode: CameraType;
|
|
5021
|
+
cinematicSettings?: CinematicSettings | undefined;
|
|
5022
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5023
|
+
useColliderRange?: boolean | undefined;
|
|
4710
5024
|
}
|
|
4711
5025
|
|
|
4712
5026
|
/**
|
|
@@ -4778,6 +5092,39 @@ export declare namespace PBEngineInfo {
|
|
|
4778
5092
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
4779
5093
|
}
|
|
4780
5094
|
|
|
5095
|
+
/**
|
|
5096
|
+
* defines the global scene light settings. must be added to the scene root.
|
|
5097
|
+
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5098
|
+
*/
|
|
5099
|
+
/**
|
|
5100
|
+
* @public
|
|
5101
|
+
*/
|
|
5102
|
+
export declare interface PBGlobalLight {
|
|
5103
|
+
/**
|
|
5104
|
+
* the direction the directional light shines in.
|
|
5105
|
+
* default depends on time of day and explorer implementation
|
|
5106
|
+
*/
|
|
5107
|
+
direction?: PBVector3 | undefined;
|
|
5108
|
+
/**
|
|
5109
|
+
* ambient light color
|
|
5110
|
+
* default: White
|
|
5111
|
+
*/
|
|
5112
|
+
ambientColor?: PBColor3 | undefined;
|
|
5113
|
+
/**
|
|
5114
|
+
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5115
|
+
* default 1
|
|
5116
|
+
*/
|
|
5117
|
+
ambientBrightness?: number | undefined;
|
|
5118
|
+
}
|
|
5119
|
+
|
|
5120
|
+
/**
|
|
5121
|
+
* @public
|
|
5122
|
+
*/
|
|
5123
|
+
export declare namespace PBGlobalLight {
|
|
5124
|
+
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5125
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5126
|
+
}
|
|
5127
|
+
|
|
4781
5128
|
/**
|
|
4782
5129
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
4783
5130
|
*
|
|
@@ -4813,6 +5160,25 @@ export declare namespace PBGltfContainer {
|
|
|
4813
5160
|
*/
|
|
4814
5161
|
export declare interface PBGltfContainerLoadingState {
|
|
4815
5162
|
currentState: LoadingState;
|
|
5163
|
+
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5164
|
+
nodePaths: string[];
|
|
5165
|
+
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5166
|
+
meshNames: string[];
|
|
5167
|
+
/**
|
|
5168
|
+
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5169
|
+
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5170
|
+
*/
|
|
5171
|
+
materialNames: string[];
|
|
5172
|
+
/**
|
|
5173
|
+
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5174
|
+
* sure all your materials are explicitly named.
|
|
5175
|
+
*/
|
|
5176
|
+
skinNames: string[];
|
|
5177
|
+
/**
|
|
5178
|
+
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5179
|
+
* your skins are explicitly named.
|
|
5180
|
+
*/
|
|
5181
|
+
animationNames: string[];
|
|
4816
5182
|
}
|
|
4817
5183
|
|
|
4818
5184
|
/**
|
|
@@ -4823,6 +5189,57 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
4823
5189
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
4824
5190
|
}
|
|
4825
5191
|
|
|
5192
|
+
/**
|
|
5193
|
+
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5194
|
+
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5195
|
+
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5196
|
+
* in the parent.
|
|
5197
|
+
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5198
|
+
*
|
|
5199
|
+
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5200
|
+
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5201
|
+
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5202
|
+
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5203
|
+
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5204
|
+
*
|
|
5205
|
+
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5206
|
+
*
|
|
5207
|
+
* From the scene, you can modify various components to alter the gltf node:
|
|
5208
|
+
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5209
|
+
* regardless of any intermediate gltf node hierarchy.
|
|
5210
|
+
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5211
|
+
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5212
|
+
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5213
|
+
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5214
|
+
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5215
|
+
* 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
|
|
5216
|
+
* PBMaterial will be maintained.
|
|
5217
|
+
*
|
|
5218
|
+
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5219
|
+
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5220
|
+
* change the state to `GNS_FAILED`.
|
|
5221
|
+
* - deleting the scene entity will not delete the gltf node.
|
|
5222
|
+
*
|
|
5223
|
+
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5224
|
+
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5225
|
+
* the gltf node will also be displayed.
|
|
5226
|
+
*/
|
|
5227
|
+
/**
|
|
5228
|
+
* @public
|
|
5229
|
+
*/
|
|
5230
|
+
export declare interface PBGltfNode {
|
|
5231
|
+
/** the path of the target node in the Gltf. */
|
|
5232
|
+
path: string;
|
|
5233
|
+
}
|
|
5234
|
+
|
|
5235
|
+
/**
|
|
5236
|
+
* @public
|
|
5237
|
+
*/
|
|
5238
|
+
export declare namespace PBGltfNode {
|
|
5239
|
+
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5240
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5241
|
+
}
|
|
5242
|
+
|
|
4826
5243
|
/**
|
|
4827
5244
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
4828
5245
|
*
|
|
@@ -4868,6 +5285,26 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
4868
5285
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
4869
5286
|
}
|
|
4870
5287
|
|
|
5288
|
+
/**
|
|
5289
|
+
* The state of a linked gltf node.
|
|
5290
|
+
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5291
|
+
*/
|
|
5292
|
+
/**
|
|
5293
|
+
* @public
|
|
5294
|
+
*/
|
|
5295
|
+
export declare interface PBGltfNodeState {
|
|
5296
|
+
state: GltfNodeStateValue;
|
|
5297
|
+
error?: string | undefined;
|
|
5298
|
+
}
|
|
5299
|
+
|
|
5300
|
+
/**
|
|
5301
|
+
* @public
|
|
5302
|
+
*/
|
|
5303
|
+
export declare namespace PBGltfNodeState {
|
|
5304
|
+
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5305
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5306
|
+
}
|
|
5307
|
+
|
|
4871
5308
|
/**
|
|
4872
5309
|
* @public
|
|
4873
5310
|
*/
|
|
@@ -5003,6 +5440,14 @@ export declare interface PBMaterial {
|
|
|
5003
5440
|
$case: "pbr";
|
|
5004
5441
|
pbr: PBMaterial_PbrMaterial;
|
|
5005
5442
|
} | undefined;
|
|
5443
|
+
/**
|
|
5444
|
+
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
5445
|
+
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
5446
|
+
* supported by the PbMaterial.
|
|
5447
|
+
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
5448
|
+
* field with data that reflects the gltf material once it is loaded.
|
|
5449
|
+
*/
|
|
5450
|
+
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
5006
5451
|
}
|
|
5007
5452
|
|
|
5008
5453
|
/**
|
|
@@ -5013,6 +5458,22 @@ export declare namespace PBMaterial {
|
|
|
5013
5458
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
5014
5459
|
}
|
|
5015
5460
|
|
|
5461
|
+
/**
|
|
5462
|
+
* @public
|
|
5463
|
+
*/
|
|
5464
|
+
export declare interface PBMaterial_GltfMaterial {
|
|
5465
|
+
gltfSrc: string;
|
|
5466
|
+
name: string;
|
|
5467
|
+
}
|
|
5468
|
+
|
|
5469
|
+
/**
|
|
5470
|
+
* @public
|
|
5471
|
+
*/
|
|
5472
|
+
export declare namespace PBMaterial_GltfMaterial {
|
|
5473
|
+
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
5474
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
5475
|
+
}
|
|
5476
|
+
|
|
5016
5477
|
/**
|
|
5017
5478
|
* @public
|
|
5018
5479
|
*/
|
|
@@ -5109,6 +5570,9 @@ export declare interface PBMeshCollider {
|
|
|
5109
5570
|
} | {
|
|
5110
5571
|
$case: "plane";
|
|
5111
5572
|
plane: PBMeshCollider_PlaneMesh;
|
|
5573
|
+
} | {
|
|
5574
|
+
$case: "gltf";
|
|
5575
|
+
gltf: PBMeshCollider_GltfMesh;
|
|
5112
5576
|
} | undefined;
|
|
5113
5577
|
}
|
|
5114
5578
|
|
|
@@ -5154,6 +5618,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
5154
5618
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
5155
5619
|
}
|
|
5156
5620
|
|
|
5621
|
+
/** A collider constructed from a Gltf Mesh. */
|
|
5622
|
+
/**
|
|
5623
|
+
* @public
|
|
5624
|
+
*/
|
|
5625
|
+
export declare interface PBMeshCollider_GltfMesh {
|
|
5626
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
|
5627
|
+
gltfSrc: string;
|
|
5628
|
+
/** the name of the mesh asset */
|
|
5629
|
+
name: string;
|
|
5630
|
+
}
|
|
5631
|
+
|
|
5632
|
+
/**
|
|
5633
|
+
* @public
|
|
5634
|
+
*/
|
|
5635
|
+
export declare namespace PBMeshCollider_GltfMesh {
|
|
5636
|
+
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5637
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
5638
|
+
}
|
|
5639
|
+
|
|
5157
5640
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
5158
5641
|
/**
|
|
5159
5642
|
* @public
|
|
@@ -5186,13 +5669,11 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
5186
5669
|
|
|
5187
5670
|
/**
|
|
5188
5671
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
5189
|
-
* plane, a sphere or a
|
|
5672
|
+
* plane, a sphere, a cylinder, or a Gltf mesh.
|
|
5190
5673
|
*
|
|
5191
5674
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
5192
5675
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
5193
5676
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5194
|
-
*
|
|
5195
|
-
* More complex shapes require the use of a `GltfContainer` component.
|
|
5196
5677
|
*/
|
|
5197
5678
|
/**
|
|
5198
5679
|
* @public
|
|
@@ -5210,6 +5691,9 @@ export declare interface PBMeshRenderer {
|
|
|
5210
5691
|
} | {
|
|
5211
5692
|
$case: "plane";
|
|
5212
5693
|
plane: PBMeshRenderer_PlaneMesh;
|
|
5694
|
+
} | {
|
|
5695
|
+
$case: "gltf";
|
|
5696
|
+
gltf: PBMeshRenderer_GltfMesh;
|
|
5213
5697
|
} | undefined;
|
|
5214
5698
|
}
|
|
5215
5699
|
|
|
@@ -5257,6 +5741,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
5257
5741
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
5258
5742
|
}
|
|
5259
5743
|
|
|
5744
|
+
/** A mesh from a Gltf. */
|
|
5745
|
+
/**
|
|
5746
|
+
* @public
|
|
5747
|
+
*/
|
|
5748
|
+
export declare interface PBMeshRenderer_GltfMesh {
|
|
5749
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
|
5750
|
+
gltfSrc: string;
|
|
5751
|
+
/** the name of the mesh asset */
|
|
5752
|
+
name: string;
|
|
5753
|
+
}
|
|
5754
|
+
|
|
5755
|
+
/**
|
|
5756
|
+
* @public
|
|
5757
|
+
*/
|
|
5758
|
+
export declare namespace PBMeshRenderer_GltfMesh {
|
|
5759
|
+
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5760
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
5761
|
+
}
|
|
5762
|
+
|
|
5260
5763
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
5261
5764
|
/**
|
|
5262
5765
|
* @public
|
|
@@ -5530,7 +6033,10 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
5530
6033
|
screenCoordinates?: PBVector2 | undefined;
|
|
5531
6034
|
/** Movement since last frame (pixels) */
|
|
5532
6035
|
screenDelta?: PBVector2 | undefined;
|
|
5533
|
-
/**
|
|
6036
|
+
/**
|
|
6037
|
+
* ray direction that can be used with the primary camera origin for
|
|
6038
|
+
* raycasting from the cursor into the world
|
|
6039
|
+
*/
|
|
5534
6040
|
worldRayDirection?: PBVector3 | undefined;
|
|
5535
6041
|
}
|
|
5536
6042
|
|
|
@@ -5756,6 +6262,46 @@ export declare namespace PBTextShape {
|
|
|
5756
6262
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
5757
6263
|
}
|
|
5758
6264
|
|
|
6265
|
+
/**
|
|
6266
|
+
* @public
|
|
6267
|
+
*/
|
|
6268
|
+
export declare interface PBTextureCamera {
|
|
6269
|
+
/** rendered texture width */
|
|
6270
|
+
width?: number | undefined;
|
|
6271
|
+
/** rendered texture height */
|
|
6272
|
+
height?: number | undefined;
|
|
6273
|
+
/**
|
|
6274
|
+
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
6275
|
+
* defaults to 0
|
|
6276
|
+
*/
|
|
6277
|
+
layer?: number | undefined;
|
|
6278
|
+
/** default black */
|
|
6279
|
+
clearColor?: PBColor4 | undefined;
|
|
6280
|
+
/** default infinity */
|
|
6281
|
+
farPlane?: number | undefined;
|
|
6282
|
+
mode?: {
|
|
6283
|
+
$case: "perspective";
|
|
6284
|
+
perspective: Perspective;
|
|
6285
|
+
} | {
|
|
6286
|
+
$case: "orthographic";
|
|
6287
|
+
orthographic: Orthographic;
|
|
6288
|
+
} | undefined;
|
|
6289
|
+
/**
|
|
6290
|
+
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
6291
|
+
* range: 0 (off) - 1 (full volume)
|
|
6292
|
+
* default: 0
|
|
6293
|
+
*/
|
|
6294
|
+
volume?: number | undefined;
|
|
6295
|
+
}
|
|
6296
|
+
|
|
6297
|
+
/**
|
|
6298
|
+
* @public
|
|
6299
|
+
*/
|
|
6300
|
+
export declare namespace PBTextureCamera {
|
|
6301
|
+
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
6302
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
6303
|
+
}
|
|
6304
|
+
|
|
5759
6305
|
/**
|
|
5760
6306
|
* The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
|
|
5761
6307
|
* when entities enter this component's defined area.
|
|
@@ -5934,6 +6480,25 @@ export declare namespace PBUiBackground {
|
|
|
5934
6480
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
5935
6481
|
}
|
|
5936
6482
|
|
|
6483
|
+
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
6484
|
+
/**
|
|
6485
|
+
* @public
|
|
6486
|
+
*/
|
|
6487
|
+
export declare interface PBUiCanvas {
|
|
6488
|
+
width: number;
|
|
6489
|
+
height: number;
|
|
6490
|
+
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
6491
|
+
color?: PBColor4 | undefined;
|
|
6492
|
+
}
|
|
6493
|
+
|
|
6494
|
+
/**
|
|
6495
|
+
* @public
|
|
6496
|
+
*/
|
|
6497
|
+
export declare namespace PBUiCanvas {
|
|
6498
|
+
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
6499
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
6500
|
+
}
|
|
6501
|
+
|
|
5937
6502
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
5938
6503
|
/**
|
|
5939
6504
|
* @public
|
|
@@ -6050,6 +6615,21 @@ export declare namespace PBUiInputResult {
|
|
|
6050
6615
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
6051
6616
|
}
|
|
6052
6617
|
|
|
6618
|
+
/**
|
|
6619
|
+
* @public
|
|
6620
|
+
*/
|
|
6621
|
+
export declare interface PBUiScrollResult {
|
|
6622
|
+
value: PBVector2 | undefined;
|
|
6623
|
+
}
|
|
6624
|
+
|
|
6625
|
+
/**
|
|
6626
|
+
* @public
|
|
6627
|
+
*/
|
|
6628
|
+
export declare namespace PBUiScrollResult {
|
|
6629
|
+
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
6630
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
6631
|
+
}
|
|
6632
|
+
|
|
6053
6633
|
/**
|
|
6054
6634
|
* @public
|
|
6055
6635
|
*/
|
|
@@ -6066,6 +6646,10 @@ export declare interface PBUiText {
|
|
|
6066
6646
|
fontSize?: number | undefined;
|
|
6067
6647
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
|
6068
6648
|
textWrap?: TextWrap | undefined;
|
|
6649
|
+
/** width of the outline (default: 0) */
|
|
6650
|
+
outlineWidth?: number | undefined;
|
|
6651
|
+
/** RGBA color of the outline (default: opaque black) */
|
|
6652
|
+
outlineColor?: PBColor4 | undefined;
|
|
6069
6653
|
}
|
|
6070
6654
|
|
|
6071
6655
|
/**
|
|
@@ -6193,6 +6777,12 @@ export declare interface PBUiTransform {
|
|
|
6193
6777
|
borderRightColor?: PBColor4 | undefined;
|
|
6194
6778
|
/** default: 1 */
|
|
6195
6779
|
opacity?: number | undefined;
|
|
6780
|
+
/** reference for scroll_position. default empty */
|
|
6781
|
+
elementId?: string | undefined;
|
|
6782
|
+
/** default position=(0,0) */
|
|
6783
|
+
scrollPosition?: ScrollPositionValue | undefined;
|
|
6784
|
+
/** default ShowScrollBar.SSB_BOTH */
|
|
6785
|
+
scrollVisible?: ShowScrollBar | undefined;
|
|
6196
6786
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
6197
6787
|
zIndex?: number | undefined;
|
|
6198
6788
|
}
|
|
@@ -6342,6 +6932,25 @@ export declare namespace PBVisibilityComponent {
|
|
|
6342
6932
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6343
6933
|
}
|
|
6344
6934
|
|
|
6935
|
+
/**
|
|
6936
|
+
* @public
|
|
6937
|
+
*/
|
|
6938
|
+
export declare interface Perspective {
|
|
6939
|
+
/**
|
|
6940
|
+
* vertical field of view in radians
|
|
6941
|
+
* defaults to pi/4 = 45 degrees
|
|
6942
|
+
*/
|
|
6943
|
+
fieldOfView?: number | undefined;
|
|
6944
|
+
}
|
|
6945
|
+
|
|
6946
|
+
/**
|
|
6947
|
+
* @public
|
|
6948
|
+
*/
|
|
6949
|
+
export declare namespace Perspective {
|
|
6950
|
+
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
6951
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
6952
|
+
}
|
|
6953
|
+
|
|
6345
6954
|
/**
|
|
6346
6955
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6347
6956
|
* @public
|
|
@@ -6497,11 +7106,37 @@ export declare interface PointerEventsSystem {
|
|
|
6497
7106
|
* @param entity - Entity where the callback was attached
|
|
6498
7107
|
*/
|
|
6499
7108
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
7109
|
+
/**
|
|
7110
|
+
* @public
|
|
7111
|
+
* Remove the callback for onPointerDrag event
|
|
7112
|
+
* @param entity - Entity where the callback was attached
|
|
7113
|
+
*/
|
|
7114
|
+
removeOnPointerDrag(entity: Entity): void;
|
|
7115
|
+
/**
|
|
7116
|
+
* @public
|
|
7117
|
+
* Remove the callback for onPointerDragLocked event
|
|
7118
|
+
* @param entity - Entity where the callback was attached
|
|
7119
|
+
*/
|
|
7120
|
+
removeOnPointerDragLocked(entity: Entity): void;
|
|
7121
|
+
/**
|
|
7122
|
+
* @public
|
|
7123
|
+
* Remove the callback for onPointerDragEnd event
|
|
7124
|
+
* @param entity - Entity where the callback was attached
|
|
7125
|
+
*/
|
|
7126
|
+
removeOnPointerDragEnd(entity: Entity): void;
|
|
7127
|
+
/**
|
|
7128
|
+
* @public
|
|
7129
|
+
* Execute callbacks when the user presses one of the InputButtons pointing at the entity
|
|
7130
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7131
|
+
*/
|
|
7132
|
+
onPointerDown(pointerData: {
|
|
7133
|
+
entity: Entity;
|
|
7134
|
+
optsList: EventSystemOptionsCallback[];
|
|
7135
|
+
}): void;
|
|
6500
7136
|
/**
|
|
6501
7137
|
* @public
|
|
6502
7138
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
6503
7139
|
* @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
|
|
6504
|
-
* @param cb - Function to execute when click fires
|
|
6505
7140
|
*/
|
|
6506
7141
|
onPointerDown(pointerData: {
|
|
6507
7142
|
entity: Entity;
|
|
@@ -6514,6 +7149,15 @@ export declare interface PointerEventsSystem {
|
|
|
6514
7149
|
* @param opts - Opts to trigger Feedback and Button
|
|
6515
7150
|
*/
|
|
6516
7151
|
onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
|
|
7152
|
+
/**
|
|
7153
|
+
* @public
|
|
7154
|
+
* Execute callbacks when the user releases one of the InputButtons pointing at the entity
|
|
7155
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7156
|
+
*/
|
|
7157
|
+
onPointerUp(pointerData: {
|
|
7158
|
+
entity: Entity;
|
|
7159
|
+
optsList: EventSystemOptionsCallback[];
|
|
7160
|
+
}): void;
|
|
6517
7161
|
/**
|
|
6518
7162
|
* @public
|
|
6519
7163
|
* Execute callback when the user releases the InputButton pointing at the entity
|
|
@@ -6551,6 +7195,64 @@ export declare interface PointerEventsSystem {
|
|
|
6551
7195
|
entity: Entity;
|
|
6552
7196
|
opts?: Partial<EventSystemOptions>;
|
|
6553
7197
|
}, cb: EventSystemCallback): void;
|
|
7198
|
+
/**
|
|
7199
|
+
* @public
|
|
7200
|
+
* Execute callbacks when the user drags the pointer from inside the entity
|
|
7201
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7202
|
+
*/
|
|
7203
|
+
onPointerDrag(pointerData: {
|
|
7204
|
+
entity: Entity;
|
|
7205
|
+
optsList: EventSystemOptionsCallback[];
|
|
7206
|
+
}): void;
|
|
7207
|
+
/**
|
|
7208
|
+
* @public
|
|
7209
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity
|
|
7210
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7211
|
+
* @param cb - Function to execute when click fires
|
|
7212
|
+
*/
|
|
7213
|
+
onPointerDrag(pointerData: {
|
|
7214
|
+
entity: Entity;
|
|
7215
|
+
opts?: Partial<EventSystemOptions>;
|
|
7216
|
+
}, cb: EventSystemCallback): void;
|
|
7217
|
+
/**
|
|
7218
|
+
* @public
|
|
7219
|
+
* Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
|
|
7220
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7221
|
+
*/
|
|
7222
|
+
onPointerDragLocked(pointerData: {
|
|
7223
|
+
entity: Entity;
|
|
7224
|
+
optsList: EventSystemOptionsCallback[];
|
|
7225
|
+
}): void;
|
|
7226
|
+
/**
|
|
7227
|
+
* @public
|
|
7228
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
|
7229
|
+
* locking the cursor in place
|
|
7230
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7231
|
+
* @param cb - Function to execute when click fires
|
|
7232
|
+
*/
|
|
7233
|
+
onPointerDragLocked(pointerData: {
|
|
7234
|
+
entity: Entity;
|
|
7235
|
+
opts?: Partial<EventSystemOptions>;
|
|
7236
|
+
}, cb: EventSystemCallback): void;
|
|
7237
|
+
/**
|
|
7238
|
+
* @public
|
|
7239
|
+
* Execute callbacks when the user releases a button after a drag
|
|
7240
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7241
|
+
*/
|
|
7242
|
+
onPointerDragEnd(pointerData: {
|
|
7243
|
+
entity: Entity;
|
|
7244
|
+
optsList: EventSystemOptionsCallback[];
|
|
7245
|
+
}): void;
|
|
7246
|
+
/**
|
|
7247
|
+
* @public
|
|
7248
|
+
* Execute callback when the user releases the button after a drag
|
|
7249
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7250
|
+
* @param cb - Function to execute when click fires
|
|
7251
|
+
*/
|
|
7252
|
+
onPointerDragEnd(pointerData: {
|
|
7253
|
+
entity: Entity;
|
|
7254
|
+
opts?: Partial<EventSystemOptions>;
|
|
7255
|
+
}, cb: EventSystemCallback): void;
|
|
6554
7256
|
}
|
|
6555
7257
|
|
|
6556
7258
|
/**
|
|
@@ -6567,7 +7269,10 @@ export declare const enum PointerEventType {
|
|
|
6567
7269
|
PET_UP = 0,
|
|
6568
7270
|
PET_DOWN = 1,
|
|
6569
7271
|
PET_HOVER_ENTER = 2,
|
|
6570
|
-
PET_HOVER_LEAVE = 3
|
|
7272
|
+
PET_HOVER_LEAVE = 3,
|
|
7273
|
+
PET_DRAG_LOCKED = 4,
|
|
7274
|
+
PET_DRAG = 5,
|
|
7275
|
+
PET_DRAG_END = 6
|
|
6571
7276
|
}
|
|
6572
7277
|
|
|
6573
7278
|
/**
|
|
@@ -6598,7 +7303,10 @@ export declare const enum PointerType {
|
|
|
6598
7303
|
/** POT_NONE - No pointer input */
|
|
6599
7304
|
POT_NONE = 0,
|
|
6600
7305
|
/** POT_MOUSE - Traditional mouse input */
|
|
6601
|
-
POT_MOUSE = 1
|
|
7306
|
+
POT_MOUSE = 1,
|
|
7307
|
+
POT_PAD = 2,
|
|
7308
|
+
POT_TOUCH = 3,
|
|
7309
|
+
POT_WAND = 4
|
|
6602
7310
|
}
|
|
6603
7311
|
|
|
6604
7312
|
/**
|
|
@@ -7201,6 +7909,11 @@ export declare interface ReactBasedUiSystem {
|
|
|
7201
7909
|
* Set the main UI renderer. Optional virtual size defines the global UI scale factor.
|
|
7202
7910
|
*/
|
|
7203
7911
|
setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
|
|
7912
|
+
/**
|
|
7913
|
+
* Set a texture renderer for a specific entity.
|
|
7914
|
+
* @deprecated Use addUiRenderer instead
|
|
7915
|
+
*/
|
|
7916
|
+
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
7204
7917
|
/**
|
|
7205
7918
|
* Add a UI renderer associated with an entity. The UI will be automatically cleaned up
|
|
7206
7919
|
* when the entity is removed from the engine.
|
|
@@ -7784,6 +8497,49 @@ export declare namespace Schemas {
|
|
|
7784
8497
|
}) => void;
|
|
7785
8498
|
}
|
|
7786
8499
|
|
|
8500
|
+
/**
|
|
8501
|
+
* @public
|
|
8502
|
+
*/
|
|
8503
|
+
export declare interface ScrollPositionValue {
|
|
8504
|
+
value?: {
|
|
8505
|
+
$case: "position";
|
|
8506
|
+
position: PBVector2;
|
|
8507
|
+
} | {
|
|
8508
|
+
$case: "reference";
|
|
8509
|
+
reference: string;
|
|
8510
|
+
} | undefined;
|
|
8511
|
+
}
|
|
8512
|
+
|
|
8513
|
+
/**
|
|
8514
|
+
* @public
|
|
8515
|
+
*/
|
|
8516
|
+
export declare namespace ScrollPositionValue {
|
|
8517
|
+
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
8518
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
8519
|
+
}
|
|
8520
|
+
|
|
8521
|
+
/**
|
|
8522
|
+
* @public
|
|
8523
|
+
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
|
8524
|
+
*/
|
|
8525
|
+
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
8526
|
+
|
|
8527
|
+
/**
|
|
8528
|
+
* Sets a globalThis property as a polyfill (only if undefined/null).
|
|
8529
|
+
* @public
|
|
8530
|
+
*/
|
|
8531
|
+
export declare function setGlobalPolyfill<T>(key: string, value: T): void;
|
|
8532
|
+
|
|
8533
|
+
/**
|
|
8534
|
+
* @public
|
|
8535
|
+
*/
|
|
8536
|
+
export declare const enum ShowScrollBar {
|
|
8537
|
+
SSB_BOTH = 0,
|
|
8538
|
+
SSB_ONLY_VERTICAL = 1,
|
|
8539
|
+
SSB_ONLY_HORIZONTAL = 2,
|
|
8540
|
+
SSB_HIDDEN = 3
|
|
8541
|
+
}
|
|
8542
|
+
|
|
7787
8543
|
/** @public */
|
|
7788
8544
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
7789
8545
|
|
|
@@ -7890,6 +8646,9 @@ export declare namespace Texture {
|
|
|
7890
8646
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
7891
8647
|
}
|
|
7892
8648
|
|
|
8649
|
+
/** @public */
|
|
8650
|
+
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
8651
|
+
|
|
7893
8652
|
/**
|
|
7894
8653
|
* @public
|
|
7895
8654
|
*/
|
|
@@ -8000,6 +8759,9 @@ export declare interface TextureUnion {
|
|
|
8000
8759
|
} | {
|
|
8001
8760
|
$case: "videoTexture";
|
|
8002
8761
|
videoTexture: VideoTexture;
|
|
8762
|
+
} | {
|
|
8763
|
+
$case: "uiTexture";
|
|
8764
|
+
uiTexture: UiCanvasTexture;
|
|
8003
8765
|
} | undefined;
|
|
8004
8766
|
}
|
|
8005
8767
|
|
|
@@ -8477,6 +9239,8 @@ export declare interface UiBackgroundProps {
|
|
|
8477
9239
|
uvs?: number[];
|
|
8478
9240
|
/** AvatarTexture for the background */
|
|
8479
9241
|
avatarTexture?: UiAvatarTexture;
|
|
9242
|
+
/** VideoTexture for the background */
|
|
9243
|
+
videoTexture?: UiVideoTexture;
|
|
8480
9244
|
/** Texture for the background */
|
|
8481
9245
|
texture?: UiTexture;
|
|
8482
9246
|
}
|
|
@@ -8496,9 +9260,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
8496
9260
|
disabled?: boolean;
|
|
8497
9261
|
}
|
|
8498
9262
|
|
|
9263
|
+
/** @public */
|
|
9264
|
+
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
9265
|
+
|
|
8499
9266
|
/** @public */
|
|
8500
9267
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
8501
9268
|
|
|
9269
|
+
/**
|
|
9270
|
+
* @public
|
|
9271
|
+
*/
|
|
9272
|
+
export declare interface UiCanvasTexture {
|
|
9273
|
+
uiCanvasEntity: number;
|
|
9274
|
+
/** default = TextureWrapMode.Clamp */
|
|
9275
|
+
wrapMode?: TextureWrapMode | undefined;
|
|
9276
|
+
/** default = FilterMode.Bilinear */
|
|
9277
|
+
filterMode?: TextureFilterMode | undefined;
|
|
9278
|
+
}
|
|
9279
|
+
|
|
9280
|
+
/**
|
|
9281
|
+
* @public
|
|
9282
|
+
*/
|
|
9283
|
+
export declare namespace UiCanvasTexture {
|
|
9284
|
+
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
9285
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
9286
|
+
}
|
|
9287
|
+
|
|
8502
9288
|
/**
|
|
8503
9289
|
* @public
|
|
8504
9290
|
*/
|
|
@@ -8568,6 +9354,10 @@ export declare interface UiLabelProps {
|
|
|
8568
9354
|
textAlign?: TextAlignType | undefined;
|
|
8569
9355
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
8570
9356
|
font?: UiFontType | undefined;
|
|
9357
|
+
/** Outline width of the text. @defaultValue 0 */
|
|
9358
|
+
outlineWidth?: number | undefined;
|
|
9359
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
|
9360
|
+
outlineColor?: PBColor4 | undefined;
|
|
8571
9361
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
8572
9362
|
textWrap?: UiTextWrapType | undefined;
|
|
8573
9363
|
}
|
|
@@ -8585,6 +9375,9 @@ export declare type UiRendererOptions = {
|
|
|
8585
9375
|
virtualHeight: number;
|
|
8586
9376
|
};
|
|
8587
9377
|
|
|
9378
|
+
/** @public */
|
|
9379
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
9380
|
+
|
|
8588
9381
|
/** @public */
|
|
8589
9382
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
8590
9383
|
|
|
@@ -8662,10 +9455,26 @@ export declare interface UiTransformProps {
|
|
|
8662
9455
|
borderWidth?: Partial<Position> | PositionUnit;
|
|
8663
9456
|
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
|
8664
9457
|
opacity?: number;
|
|
9458
|
+
/** A reference value to identify the element, default empty */
|
|
9459
|
+
elementId?: string;
|
|
9460
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
|
9461
|
+
scrollPosition?: PBVector2 | string;
|
|
9462
|
+
/** default ShowScrollBar.SSB_BOTH */
|
|
9463
|
+
scrollVisible?: ScrollVisibleType;
|
|
8665
9464
|
/** default 0 */
|
|
8666
9465
|
zIndex?: number;
|
|
8667
9466
|
}
|
|
8668
9467
|
|
|
9468
|
+
/**
|
|
9469
|
+
* Texture
|
|
9470
|
+
* @public
|
|
9471
|
+
*/
|
|
9472
|
+
export declare interface UiVideoTexture {
|
|
9473
|
+
videoPlayerEntity: Entity;
|
|
9474
|
+
wrapMode?: TextureWrapType;
|
|
9475
|
+
filterMode?: TextureFilterType;
|
|
9476
|
+
}
|
|
9477
|
+
|
|
8669
9478
|
/**
|
|
8670
9479
|
* @public
|
|
8671
9480
|
*/
|