@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/alpha.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
|
*/
|
|
@@ -2621,6 +2778,12 @@ export declare type IInputSystem = {
|
|
|
2621
2778
|
* @returns the input command info or undefined if there is no command in the last tick-update
|
|
2622
2779
|
*/
|
|
2623
2780
|
getInputCommand: (inputAction: InputAction, pointerEventType: PointerEventType, entity?: Entity) => PBPointerEventsResult | null;
|
|
2781
|
+
/**
|
|
2782
|
+
* @public
|
|
2783
|
+
* Get an ordered iterator over events received within the current frame.
|
|
2784
|
+
* @returns the iterator
|
|
2785
|
+
*/
|
|
2786
|
+
getInputCommands: () => Generator<PBPointerEventsResult>;
|
|
2624
2787
|
};
|
|
2625
2788
|
|
|
2626
2789
|
/**
|
|
@@ -2916,13 +3079,29 @@ export declare interface LightSourceHelper {
|
|
|
2916
3079
|
*/
|
|
2917
3080
|
export declare type Listeners = {
|
|
2918
3081
|
/** triggered on mouse down event */
|
|
2919
|
-
onMouseDown?:
|
|
3082
|
+
onMouseDown?: EventSystemCallback;
|
|
2920
3083
|
/** triggered on mouse up event */
|
|
2921
|
-
onMouseUp?:
|
|
3084
|
+
onMouseUp?: EventSystemCallback;
|
|
2922
3085
|
/** triggered on mouse hover event */
|
|
2923
|
-
onMouseEnter?:
|
|
3086
|
+
onMouseEnter?: EventSystemCallback;
|
|
2924
3087
|
/** triggered on mouse leave event */
|
|
2925
|
-
onMouseLeave?:
|
|
3088
|
+
onMouseLeave?: EventSystemCallback;
|
|
3089
|
+
/** triggered on mouse drag event */
|
|
3090
|
+
onMouseDrag?: EventSystemCallback;
|
|
3091
|
+
/** triggered on mouse drag event */
|
|
3092
|
+
onMouseDragLocked?: EventSystemCallback;
|
|
3093
|
+
/** triggered on mouse drag event */
|
|
3094
|
+
onMouseDragEnd?: EventSystemCallback;
|
|
3095
|
+
/** triggered on input down event */
|
|
3096
|
+
onInputDown?: MultiCallback;
|
|
3097
|
+
/** triggered on input up event */
|
|
3098
|
+
onInputUp?: MultiCallback;
|
|
3099
|
+
/** triggered on input drag event */
|
|
3100
|
+
onInputDrag?: MultiCallback;
|
|
3101
|
+
/** triggered on input drag event */
|
|
3102
|
+
onInputDragLocked?: MultiCallback;
|
|
3103
|
+
/** triggered on input drag event */
|
|
3104
|
+
onInputDragEnd?: MultiCallback;
|
|
2926
3105
|
};
|
|
2927
3106
|
|
|
2928
3107
|
/**
|
|
@@ -3827,6 +4006,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
|
3827
4006
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
|
3828
4007
|
*/
|
|
3829
4008
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
4009
|
+
/**
|
|
4010
|
+
* @public
|
|
4011
|
+
* Set a gltf internal mesh in the MeshCollider component
|
|
4012
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
|
4013
|
+
* @param source - the path to the gltf
|
|
4014
|
+
* @param meshName - the name of the mesh in the gltf
|
|
4015
|
+
*/
|
|
4016
|
+
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
|
3830
4017
|
}
|
|
3831
4018
|
|
|
3832
4019
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
|
@@ -3863,6 +4050,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
|
3863
4050
|
* @param entity - entity to create or replace the MeshRenderer component
|
|
3864
4051
|
*/
|
|
3865
4052
|
setSphere(entity: Entity): void;
|
|
4053
|
+
/**
|
|
4054
|
+
* @public
|
|
4055
|
+
* Set a gltf internal mesh in the MeshRenderer component
|
|
4056
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
|
4057
|
+
* @param source - the path to the gltf
|
|
4058
|
+
* @param meshName - the name of the mesh in the gltf
|
|
4059
|
+
*/
|
|
4060
|
+
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
|
3866
4061
|
}
|
|
3867
4062
|
|
|
3868
4063
|
/**
|
|
@@ -3911,6 +4106,19 @@ export declare namespace MoveContinuous {
|
|
|
3911
4106
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): MoveContinuous;
|
|
3912
4107
|
}
|
|
3913
4108
|
|
|
4109
|
+
/**
|
|
4110
|
+
* a record object mapping `InputAction`s to functions.
|
|
4111
|
+
*
|
|
4112
|
+
* @example
|
|
4113
|
+
* onInputDown={{
|
|
4114
|
+
* [InputAction.IA_PRIMARY]: (eventData) => { console.log("primary") },
|
|
4115
|
+
* [InputAction.IA_SECONDARY]: () => { console.log("secondary") },
|
|
4116
|
+
* }}
|
|
4117
|
+
*
|
|
4118
|
+
* @public
|
|
4119
|
+
*/
|
|
4120
|
+
export declare type MultiCallback = Partial<Record<InputAction, EventSystemCallback>>;
|
|
4121
|
+
|
|
3914
4122
|
export declare const Name: NameComponent;
|
|
3915
4123
|
|
|
3916
4124
|
export declare type NameComponent = LastWriteWinElementSetComponentDefinition<NameType>;
|
|
@@ -4291,6 +4499,25 @@ export declare const onVideoEvent: Observable<{
|
|
|
4291
4499
|
totalVideoLength: number;
|
|
4292
4500
|
}>;
|
|
4293
4501
|
|
|
4502
|
+
/**
|
|
4503
|
+
* @public
|
|
4504
|
+
*/
|
|
4505
|
+
export declare interface Orthographic {
|
|
4506
|
+
/**
|
|
4507
|
+
* vertical extent of the visible range in meters
|
|
4508
|
+
* defaults to 4m
|
|
4509
|
+
*/
|
|
4510
|
+
verticalRange?: number | undefined;
|
|
4511
|
+
}
|
|
4512
|
+
|
|
4513
|
+
/**
|
|
4514
|
+
* @public
|
|
4515
|
+
*/
|
|
4516
|
+
export declare namespace Orthographic {
|
|
4517
|
+
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
|
4518
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
|
4519
|
+
}
|
|
4520
|
+
|
|
4294
4521
|
/**
|
|
4295
4522
|
* @public
|
|
4296
4523
|
* The overflow property controls what happens to content that is too big to fit into an area
|
|
@@ -4568,6 +4795,8 @@ export declare namespace PBAvatarEmoteCommand {
|
|
|
4568
4795
|
export declare interface PBAvatarEquippedData {
|
|
4569
4796
|
wearableUrns: string[];
|
|
4570
4797
|
emoteUrns: string[];
|
|
4798
|
+
/** slots that will render even if hidden */
|
|
4799
|
+
forceRender: string[];
|
|
4571
4800
|
}
|
|
4572
4801
|
|
|
4573
4802
|
/**
|
|
@@ -4578,6 +4807,36 @@ export declare namespace PBAvatarEquippedData {
|
|
|
4578
4807
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
|
|
4579
4808
|
}
|
|
4580
4809
|
|
|
4810
|
+
/**
|
|
4811
|
+
* The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
|
|
4812
|
+
* as the avatar movement speed, jump height etc.
|
|
4813
|
+
*/
|
|
4814
|
+
/**
|
|
4815
|
+
* @public
|
|
4816
|
+
*/
|
|
4817
|
+
export declare interface PBAvatarLocomotionSettings {
|
|
4818
|
+
/** Maximum speed when walking (in meters per second) */
|
|
4819
|
+
walkSpeed?: number | undefined;
|
|
4820
|
+
/** Maximum speed when jogging (in meters per second) */
|
|
4821
|
+
jogSpeed?: number | undefined;
|
|
4822
|
+
/** Maximum speed when running (in meters per second) */
|
|
4823
|
+
runSpeed?: number | undefined;
|
|
4824
|
+
/** Height of a regular jump (in meters) */
|
|
4825
|
+
jumpHeight?: number | undefined;
|
|
4826
|
+
/** Height of a jump while running (in meters) */
|
|
4827
|
+
runJumpHeight?: number | undefined;
|
|
4828
|
+
/** Cooldown time after a hard landing before the avatar can move again (in seconds) */
|
|
4829
|
+
hardLandingCooldown?: number | undefined;
|
|
4830
|
+
}
|
|
4831
|
+
|
|
4832
|
+
/**
|
|
4833
|
+
* @public
|
|
4834
|
+
*/
|
|
4835
|
+
export declare namespace PBAvatarLocomotionSettings {
|
|
4836
|
+
export function encode(message: PBAvatarLocomotionSettings, writer?: _m0.Writer): _m0.Writer;
|
|
4837
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarLocomotionSettings;
|
|
4838
|
+
}
|
|
4839
|
+
|
|
4581
4840
|
/**
|
|
4582
4841
|
* The AvatarModifierArea component can be attached to an Entity to define a region of space where
|
|
4583
4842
|
* avatar behavior changes.
|
|
@@ -4602,6 +4861,9 @@ export declare interface PBAvatarModifierArea {
|
|
|
4602
4861
|
excludeIds: string[];
|
|
4603
4862
|
/** list of modifiers to apply */
|
|
4604
4863
|
modifiers: AvatarModifierType[];
|
|
4864
|
+
movementSettings?: AvatarMovementSettings | undefined;
|
|
4865
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
4866
|
+
useColliderRange?: boolean | undefined;
|
|
4605
4867
|
}
|
|
4606
4868
|
|
|
4607
4869
|
/**
|
|
@@ -4660,6 +4922,8 @@ export declare interface PBAvatarShape {
|
|
|
4660
4922
|
emotes: string[];
|
|
4661
4923
|
/** hides the skin + hair + facial features (default: false) */
|
|
4662
4924
|
showOnlyWearables?: boolean | undefined;
|
|
4925
|
+
/** slots that will render even if hidden */
|
|
4926
|
+
forceRender: string[];
|
|
4663
4927
|
}
|
|
4664
4928
|
|
|
4665
4929
|
/**
|
|
@@ -4694,6 +4958,51 @@ export declare namespace PBBillboard {
|
|
|
4694
4958
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
|
4695
4959
|
}
|
|
4696
4960
|
|
|
4961
|
+
/**
|
|
4962
|
+
* @public
|
|
4963
|
+
*/
|
|
4964
|
+
export declare interface PBCameraLayer {
|
|
4965
|
+
/**
|
|
4966
|
+
* layer to which these settings apply. must be > 0
|
|
4967
|
+
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
|
4968
|
+
*/
|
|
4969
|
+
layer: number;
|
|
4970
|
+
/** should the sun light affect this layer? default false */
|
|
4971
|
+
directionalLight?: boolean | undefined;
|
|
4972
|
+
/** should this layer show player avatars? default false */
|
|
4973
|
+
showAvatars?: boolean | undefined;
|
|
4974
|
+
/** should this layer show the sky? default false */
|
|
4975
|
+
showSkybox?: boolean | undefined;
|
|
4976
|
+
/** should this layer show distance fog? default false */
|
|
4977
|
+
showFog?: boolean | undefined;
|
|
4978
|
+
/** ambient light overrides for this layer. default -> use same as main camera */
|
|
4979
|
+
ambientColorOverride?: PBColor3 | undefined;
|
|
4980
|
+
ambientBrightnessOverride?: number | undefined;
|
|
4981
|
+
}
|
|
4982
|
+
|
|
4983
|
+
/**
|
|
4984
|
+
* @public
|
|
4985
|
+
*/
|
|
4986
|
+
export declare namespace PBCameraLayer {
|
|
4987
|
+
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
|
4988
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
|
4989
|
+
}
|
|
4990
|
+
|
|
4991
|
+
/**
|
|
4992
|
+
* @public
|
|
4993
|
+
*/
|
|
4994
|
+
export declare interface PBCameraLayers {
|
|
4995
|
+
layers: number[];
|
|
4996
|
+
}
|
|
4997
|
+
|
|
4998
|
+
/**
|
|
4999
|
+
* @public
|
|
5000
|
+
*/
|
|
5001
|
+
export declare namespace PBCameraLayers {
|
|
5002
|
+
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
|
5003
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
|
5004
|
+
}
|
|
5005
|
+
|
|
4697
5006
|
/**
|
|
4698
5007
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
|
4699
5008
|
* third-person view.
|
|
@@ -4716,7 +5025,7 @@ export declare namespace PBCameraMode {
|
|
|
4716
5025
|
|
|
4717
5026
|
/**
|
|
4718
5027
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
|
4719
|
-
* the player's camera mode (1st-person
|
|
5028
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
|
4720
5029
|
*
|
|
4721
5030
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
|
4722
5031
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
|
@@ -4726,6 +5035,8 @@ export declare namespace PBCameraMode {
|
|
|
4726
5035
|
*
|
|
4727
5036
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
|
4728
5037
|
* is actually a 3D volume.
|
|
5038
|
+
*
|
|
5039
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
|
4729
5040
|
*/
|
|
4730
5041
|
/**
|
|
4731
5042
|
* @public
|
|
@@ -4735,6 +5046,9 @@ export declare interface PBCameraModeArea {
|
|
|
4735
5046
|
area: PBVector3 | undefined;
|
|
4736
5047
|
/** the camera mode to enforce */
|
|
4737
5048
|
mode: CameraType;
|
|
5049
|
+
cinematicSettings?: CinematicSettings | undefined;
|
|
5050
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
|
5051
|
+
useColliderRange?: boolean | undefined;
|
|
4738
5052
|
}
|
|
4739
5053
|
|
|
4740
5054
|
/**
|
|
@@ -4806,6 +5120,39 @@ export declare namespace PBEngineInfo {
|
|
|
4806
5120
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
|
4807
5121
|
}
|
|
4808
5122
|
|
|
5123
|
+
/**
|
|
5124
|
+
* defines the global scene light settings. must be added to the scene root.
|
|
5125
|
+
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
|
5126
|
+
*/
|
|
5127
|
+
/**
|
|
5128
|
+
* @public
|
|
5129
|
+
*/
|
|
5130
|
+
export declare interface PBGlobalLight {
|
|
5131
|
+
/**
|
|
5132
|
+
* the direction the directional light shines in.
|
|
5133
|
+
* default depends on time of day and explorer implementation
|
|
5134
|
+
*/
|
|
5135
|
+
direction?: PBVector3 | undefined;
|
|
5136
|
+
/**
|
|
5137
|
+
* ambient light color
|
|
5138
|
+
* default: White
|
|
5139
|
+
*/
|
|
5140
|
+
ambientColor?: PBColor3 | undefined;
|
|
5141
|
+
/**
|
|
5142
|
+
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
|
5143
|
+
* default 1
|
|
5144
|
+
*/
|
|
5145
|
+
ambientBrightness?: number | undefined;
|
|
5146
|
+
}
|
|
5147
|
+
|
|
5148
|
+
/**
|
|
5149
|
+
* @public
|
|
5150
|
+
*/
|
|
5151
|
+
export declare namespace PBGlobalLight {
|
|
5152
|
+
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
|
5153
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
|
5154
|
+
}
|
|
5155
|
+
|
|
4809
5156
|
/**
|
|
4810
5157
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
|
4811
5158
|
*
|
|
@@ -4841,6 +5188,25 @@ export declare namespace PBGltfContainer {
|
|
|
4841
5188
|
*/
|
|
4842
5189
|
export declare interface PBGltfContainerLoadingState {
|
|
4843
5190
|
currentState: LoadingState;
|
|
5191
|
+
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
|
5192
|
+
nodePaths: string[];
|
|
5193
|
+
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
|
5194
|
+
meshNames: string[];
|
|
5195
|
+
/**
|
|
5196
|
+
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
|
5197
|
+
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
|
5198
|
+
*/
|
|
5199
|
+
materialNames: string[];
|
|
5200
|
+
/**
|
|
5201
|
+
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
|
5202
|
+
* sure all your materials are explicitly named.
|
|
5203
|
+
*/
|
|
5204
|
+
skinNames: string[];
|
|
5205
|
+
/**
|
|
5206
|
+
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
|
5207
|
+
* your skins are explicitly named.
|
|
5208
|
+
*/
|
|
5209
|
+
animationNames: string[];
|
|
4844
5210
|
}
|
|
4845
5211
|
|
|
4846
5212
|
/**
|
|
@@ -4851,6 +5217,57 @@ export declare namespace PBGltfContainerLoadingState {
|
|
|
4851
5217
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
|
4852
5218
|
}
|
|
4853
5219
|
|
|
5220
|
+
/**
|
|
5221
|
+
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
|
5222
|
+
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
|
5223
|
+
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
|
5224
|
+
* in the parent.
|
|
5225
|
+
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
|
5226
|
+
*
|
|
5227
|
+
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
|
5228
|
+
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
|
5229
|
+
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
|
5230
|
+
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
|
5231
|
+
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
|
5232
|
+
*
|
|
5233
|
+
* After creation, if an animation moves the node, the `Transform` will be updated.
|
|
5234
|
+
*
|
|
5235
|
+
* From the scene, you can modify various components to alter the gltf node:
|
|
5236
|
+
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
|
5237
|
+
* regardless of any intermediate gltf node hierarchy.
|
|
5238
|
+
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
|
5239
|
+
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
|
5240
|
+
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
|
5241
|
+
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
|
5242
|
+
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
|
5243
|
+
* 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
|
|
5244
|
+
* PBMaterial will be maintained.
|
|
5245
|
+
*
|
|
5246
|
+
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
|
5247
|
+
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
|
5248
|
+
* change the state to `GNS_FAILED`.
|
|
5249
|
+
* - deleting the scene entity will not delete the gltf node.
|
|
5250
|
+
*
|
|
5251
|
+
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
|
5252
|
+
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
|
5253
|
+
* the gltf node will also be displayed.
|
|
5254
|
+
*/
|
|
5255
|
+
/**
|
|
5256
|
+
* @public
|
|
5257
|
+
*/
|
|
5258
|
+
export declare interface PBGltfNode {
|
|
5259
|
+
/** the path of the target node in the Gltf. */
|
|
5260
|
+
path: string;
|
|
5261
|
+
}
|
|
5262
|
+
|
|
5263
|
+
/**
|
|
5264
|
+
* @public
|
|
5265
|
+
*/
|
|
5266
|
+
export declare namespace PBGltfNode {
|
|
5267
|
+
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
|
5268
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
|
5269
|
+
}
|
|
5270
|
+
|
|
4854
5271
|
/**
|
|
4855
5272
|
* GltfNodeModifiers component is to be used attached to entities that have the GltfContainer component.
|
|
4856
5273
|
*
|
|
@@ -4896,6 +5313,26 @@ export declare namespace PBGltfNodeModifiers_GltfNodeModifier {
|
|
|
4896
5313
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeModifiers_GltfNodeModifier;
|
|
4897
5314
|
}
|
|
4898
5315
|
|
|
5316
|
+
/**
|
|
5317
|
+
* The state of a linked gltf node.
|
|
5318
|
+
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
|
5319
|
+
*/
|
|
5320
|
+
/**
|
|
5321
|
+
* @public
|
|
5322
|
+
*/
|
|
5323
|
+
export declare interface PBGltfNodeState {
|
|
5324
|
+
state: GltfNodeStateValue;
|
|
5325
|
+
error?: string | undefined;
|
|
5326
|
+
}
|
|
5327
|
+
|
|
5328
|
+
/**
|
|
5329
|
+
* @public
|
|
5330
|
+
*/
|
|
5331
|
+
export declare namespace PBGltfNodeState {
|
|
5332
|
+
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
|
5333
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
|
5334
|
+
}
|
|
5335
|
+
|
|
4899
5336
|
/**
|
|
4900
5337
|
* @public
|
|
4901
5338
|
*/
|
|
@@ -5031,6 +5468,14 @@ export declare interface PBMaterial {
|
|
|
5031
5468
|
$case: "pbr";
|
|
5032
5469
|
pbr: PBMaterial_PbrMaterial;
|
|
5033
5470
|
} | undefined;
|
|
5471
|
+
/**
|
|
5472
|
+
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
|
5473
|
+
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
|
5474
|
+
* supported by the PbMaterial.
|
|
5475
|
+
* If this is provided and the `material` field is not provided, the renderer will update the material
|
|
5476
|
+
* field with data that reflects the gltf material once it is loaded.
|
|
5477
|
+
*/
|
|
5478
|
+
gltf?: PBMaterial_GltfMaterial | undefined;
|
|
5034
5479
|
}
|
|
5035
5480
|
|
|
5036
5481
|
/**
|
|
@@ -5041,6 +5486,22 @@ export declare namespace PBMaterial {
|
|
|
5041
5486
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
|
5042
5487
|
}
|
|
5043
5488
|
|
|
5489
|
+
/**
|
|
5490
|
+
* @public
|
|
5491
|
+
*/
|
|
5492
|
+
export declare interface PBMaterial_GltfMaterial {
|
|
5493
|
+
gltfSrc: string;
|
|
5494
|
+
name: string;
|
|
5495
|
+
}
|
|
5496
|
+
|
|
5497
|
+
/**
|
|
5498
|
+
* @public
|
|
5499
|
+
*/
|
|
5500
|
+
export declare namespace PBMaterial_GltfMaterial {
|
|
5501
|
+
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
|
5502
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
|
5503
|
+
}
|
|
5504
|
+
|
|
5044
5505
|
/**
|
|
5045
5506
|
* @public
|
|
5046
5507
|
*/
|
|
@@ -5137,6 +5598,9 @@ export declare interface PBMeshCollider {
|
|
|
5137
5598
|
} | {
|
|
5138
5599
|
$case: "plane";
|
|
5139
5600
|
plane: PBMeshCollider_PlaneMesh;
|
|
5601
|
+
} | {
|
|
5602
|
+
$case: "gltf";
|
|
5603
|
+
gltf: PBMeshCollider_GltfMesh;
|
|
5140
5604
|
} | undefined;
|
|
5141
5605
|
}
|
|
5142
5606
|
|
|
@@ -5182,6 +5646,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
|
5182
5646
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
|
5183
5647
|
}
|
|
5184
5648
|
|
|
5649
|
+
/** A collider constructed from a Gltf Mesh. */
|
|
5650
|
+
/**
|
|
5651
|
+
* @public
|
|
5652
|
+
*/
|
|
5653
|
+
export declare interface PBMeshCollider_GltfMesh {
|
|
5654
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
|
5655
|
+
gltfSrc: string;
|
|
5656
|
+
/** the name of the mesh asset */
|
|
5657
|
+
name: string;
|
|
5658
|
+
}
|
|
5659
|
+
|
|
5660
|
+
/**
|
|
5661
|
+
* @public
|
|
5662
|
+
*/
|
|
5663
|
+
export declare namespace PBMeshCollider_GltfMesh {
|
|
5664
|
+
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5665
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
|
5666
|
+
}
|
|
5667
|
+
|
|
5185
5668
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
|
5186
5669
|
/**
|
|
5187
5670
|
* @public
|
|
@@ -5214,13 +5697,11 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
|
5214
5697
|
|
|
5215
5698
|
/**
|
|
5216
5699
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
|
5217
|
-
* plane, a sphere or a
|
|
5700
|
+
* plane, a sphere, a cylinder, or a Gltf mesh.
|
|
5218
5701
|
*
|
|
5219
5702
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
|
5220
5703
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
|
5221
5704
|
* `float` coordinates, one for each corner of each side of each face.
|
|
5222
|
-
*
|
|
5223
|
-
* More complex shapes require the use of a `GltfContainer` component.
|
|
5224
5705
|
*/
|
|
5225
5706
|
/**
|
|
5226
5707
|
* @public
|
|
@@ -5238,6 +5719,9 @@ export declare interface PBMeshRenderer {
|
|
|
5238
5719
|
} | {
|
|
5239
5720
|
$case: "plane";
|
|
5240
5721
|
plane: PBMeshRenderer_PlaneMesh;
|
|
5722
|
+
} | {
|
|
5723
|
+
$case: "gltf";
|
|
5724
|
+
gltf: PBMeshRenderer_GltfMesh;
|
|
5241
5725
|
} | undefined;
|
|
5242
5726
|
}
|
|
5243
5727
|
|
|
@@ -5285,6 +5769,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
|
5285
5769
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
|
5286
5770
|
}
|
|
5287
5771
|
|
|
5772
|
+
/** A mesh from a Gltf. */
|
|
5773
|
+
/**
|
|
5774
|
+
* @public
|
|
5775
|
+
*/
|
|
5776
|
+
export declare interface PBMeshRenderer_GltfMesh {
|
|
5777
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
|
5778
|
+
gltfSrc: string;
|
|
5779
|
+
/** the name of the mesh asset */
|
|
5780
|
+
name: string;
|
|
5781
|
+
}
|
|
5782
|
+
|
|
5783
|
+
/**
|
|
5784
|
+
* @public
|
|
5785
|
+
*/
|
|
5786
|
+
export declare namespace PBMeshRenderer_GltfMesh {
|
|
5787
|
+
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
|
5788
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
|
5789
|
+
}
|
|
5790
|
+
|
|
5288
5791
|
/** PlaneMesh renders a 2D rectangular shape. */
|
|
5289
5792
|
/**
|
|
5290
5793
|
* @public
|
|
@@ -5558,7 +6061,10 @@ export declare interface PBPrimaryPointerInfo {
|
|
|
5558
6061
|
screenCoordinates?: PBVector2 | undefined;
|
|
5559
6062
|
/** Movement since last frame (pixels) */
|
|
5560
6063
|
screenDelta?: PBVector2 | undefined;
|
|
5561
|
-
/**
|
|
6064
|
+
/**
|
|
6065
|
+
* ray direction that can be used with the primary camera origin for
|
|
6066
|
+
* raycasting from the cursor into the world
|
|
6067
|
+
*/
|
|
5562
6068
|
worldRayDirection?: PBVector3 | undefined;
|
|
5563
6069
|
}
|
|
5564
6070
|
|
|
@@ -5784,6 +6290,46 @@ export declare namespace PBTextShape {
|
|
|
5784
6290
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
|
5785
6291
|
}
|
|
5786
6292
|
|
|
6293
|
+
/**
|
|
6294
|
+
* @public
|
|
6295
|
+
*/
|
|
6296
|
+
export declare interface PBTextureCamera {
|
|
6297
|
+
/** rendered texture width */
|
|
6298
|
+
width?: number | undefined;
|
|
6299
|
+
/** rendered texture height */
|
|
6300
|
+
height?: number | undefined;
|
|
6301
|
+
/**
|
|
6302
|
+
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
|
6303
|
+
* defaults to 0
|
|
6304
|
+
*/
|
|
6305
|
+
layer?: number | undefined;
|
|
6306
|
+
/** default black */
|
|
6307
|
+
clearColor?: PBColor4 | undefined;
|
|
6308
|
+
/** default infinity */
|
|
6309
|
+
farPlane?: number | undefined;
|
|
6310
|
+
mode?: {
|
|
6311
|
+
$case: "perspective";
|
|
6312
|
+
perspective: Perspective;
|
|
6313
|
+
} | {
|
|
6314
|
+
$case: "orthographic";
|
|
6315
|
+
orthographic: Orthographic;
|
|
6316
|
+
} | undefined;
|
|
6317
|
+
/**
|
|
6318
|
+
* controls whether this camera acts as a receiver for audio on sources with matching `PBCameraLayers`.
|
|
6319
|
+
* range: 0 (off) - 1 (full volume)
|
|
6320
|
+
* default: 0
|
|
6321
|
+
*/
|
|
6322
|
+
volume?: number | undefined;
|
|
6323
|
+
}
|
|
6324
|
+
|
|
6325
|
+
/**
|
|
6326
|
+
* @public
|
|
6327
|
+
*/
|
|
6328
|
+
export declare namespace PBTextureCamera {
|
|
6329
|
+
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
|
6330
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
|
6331
|
+
}
|
|
6332
|
+
|
|
5787
6333
|
/**
|
|
5788
6334
|
* The PBTriggerArea component is used to raise collision triggering events (through the TriggerAreaResult component)
|
|
5789
6335
|
* when entities enter this component's defined area.
|
|
@@ -5962,6 +6508,25 @@ export declare namespace PBUiBackground {
|
|
|
5962
6508
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
|
5963
6509
|
}
|
|
5964
6510
|
|
|
6511
|
+
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
|
6512
|
+
/**
|
|
6513
|
+
* @public
|
|
6514
|
+
*/
|
|
6515
|
+
export declare interface PBUiCanvas {
|
|
6516
|
+
width: number;
|
|
6517
|
+
height: number;
|
|
6518
|
+
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
|
6519
|
+
color?: PBColor4 | undefined;
|
|
6520
|
+
}
|
|
6521
|
+
|
|
6522
|
+
/**
|
|
6523
|
+
* @public
|
|
6524
|
+
*/
|
|
6525
|
+
export declare namespace PBUiCanvas {
|
|
6526
|
+
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
|
6527
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
|
6528
|
+
}
|
|
6529
|
+
|
|
5965
6530
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
|
5966
6531
|
/**
|
|
5967
6532
|
* @public
|
|
@@ -6078,6 +6643,21 @@ export declare namespace PBUiInputResult {
|
|
|
6078
6643
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
|
6079
6644
|
}
|
|
6080
6645
|
|
|
6646
|
+
/**
|
|
6647
|
+
* @public
|
|
6648
|
+
*/
|
|
6649
|
+
export declare interface PBUiScrollResult {
|
|
6650
|
+
value: PBVector2 | undefined;
|
|
6651
|
+
}
|
|
6652
|
+
|
|
6653
|
+
/**
|
|
6654
|
+
* @public
|
|
6655
|
+
*/
|
|
6656
|
+
export declare namespace PBUiScrollResult {
|
|
6657
|
+
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
|
6658
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
|
6659
|
+
}
|
|
6660
|
+
|
|
6081
6661
|
/**
|
|
6082
6662
|
* @public
|
|
6083
6663
|
*/
|
|
@@ -6094,6 +6674,10 @@ export declare interface PBUiText {
|
|
|
6094
6674
|
fontSize?: number | undefined;
|
|
6095
6675
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
|
6096
6676
|
textWrap?: TextWrap | undefined;
|
|
6677
|
+
/** width of the outline (default: 0) */
|
|
6678
|
+
outlineWidth?: number | undefined;
|
|
6679
|
+
/** RGBA color of the outline (default: opaque black) */
|
|
6680
|
+
outlineColor?: PBColor4 | undefined;
|
|
6097
6681
|
}
|
|
6098
6682
|
|
|
6099
6683
|
/**
|
|
@@ -6221,6 +6805,12 @@ export declare interface PBUiTransform {
|
|
|
6221
6805
|
borderRightColor?: PBColor4 | undefined;
|
|
6222
6806
|
/** default: 1 */
|
|
6223
6807
|
opacity?: number | undefined;
|
|
6808
|
+
/** reference for scroll_position. default empty */
|
|
6809
|
+
elementId?: string | undefined;
|
|
6810
|
+
/** default position=(0,0) */
|
|
6811
|
+
scrollPosition?: ScrollPositionValue | undefined;
|
|
6812
|
+
/** default ShowScrollBar.SSB_BOTH */
|
|
6813
|
+
scrollVisible?: ShowScrollBar | undefined;
|
|
6224
6814
|
/** default: 0 — controls render stacking order. Higher values appear in front of lower values. */
|
|
6225
6815
|
zIndex?: number | undefined;
|
|
6226
6816
|
}
|
|
@@ -6370,6 +6960,25 @@ export declare namespace PBVisibilityComponent {
|
|
|
6370
6960
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
|
6371
6961
|
}
|
|
6372
6962
|
|
|
6963
|
+
/**
|
|
6964
|
+
* @public
|
|
6965
|
+
*/
|
|
6966
|
+
export declare interface Perspective {
|
|
6967
|
+
/**
|
|
6968
|
+
* vertical field of view in radians
|
|
6969
|
+
* defaults to pi/4 = 45 degrees
|
|
6970
|
+
*/
|
|
6971
|
+
fieldOfView?: number | undefined;
|
|
6972
|
+
}
|
|
6973
|
+
|
|
6974
|
+
/**
|
|
6975
|
+
* @public
|
|
6976
|
+
*/
|
|
6977
|
+
export declare namespace Perspective {
|
|
6978
|
+
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
|
6979
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
|
6980
|
+
}
|
|
6981
|
+
|
|
6373
6982
|
/**
|
|
6374
6983
|
* Represens a plane by the equation ax + by + cz + d = 0
|
|
6375
6984
|
* @public
|
|
@@ -6525,11 +7134,37 @@ export declare interface PointerEventsSystem {
|
|
|
6525
7134
|
* @param entity - Entity where the callback was attached
|
|
6526
7135
|
*/
|
|
6527
7136
|
removeOnPointerHoverLeave(entity: Entity): void;
|
|
7137
|
+
/**
|
|
7138
|
+
* @public
|
|
7139
|
+
* Remove the callback for onPointerDrag event
|
|
7140
|
+
* @param entity - Entity where the callback was attached
|
|
7141
|
+
*/
|
|
7142
|
+
removeOnPointerDrag(entity: Entity): void;
|
|
7143
|
+
/**
|
|
7144
|
+
* @public
|
|
7145
|
+
* Remove the callback for onPointerDragLocked event
|
|
7146
|
+
* @param entity - Entity where the callback was attached
|
|
7147
|
+
*/
|
|
7148
|
+
removeOnPointerDragLocked(entity: Entity): void;
|
|
7149
|
+
/**
|
|
7150
|
+
* @public
|
|
7151
|
+
* Remove the callback for onPointerDragEnd event
|
|
7152
|
+
* @param entity - Entity where the callback was attached
|
|
7153
|
+
*/
|
|
7154
|
+
removeOnPointerDragEnd(entity: Entity): void;
|
|
7155
|
+
/**
|
|
7156
|
+
* @public
|
|
7157
|
+
* Execute callbacks when the user presses one of the InputButtons pointing at the entity
|
|
7158
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7159
|
+
*/
|
|
7160
|
+
onPointerDown(pointerData: {
|
|
7161
|
+
entity: Entity;
|
|
7162
|
+
optsList: EventSystemOptionsCallback[];
|
|
7163
|
+
}): void;
|
|
6528
7164
|
/**
|
|
6529
7165
|
* @public
|
|
6530
7166
|
* Execute callback when the user press the InputButton pointing at the entity
|
|
6531
7167
|
* @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
|
|
6532
|
-
* @param cb - Function to execute when click fires
|
|
6533
7168
|
*/
|
|
6534
7169
|
onPointerDown(pointerData: {
|
|
6535
7170
|
entity: Entity;
|
|
@@ -6542,6 +7177,15 @@ export declare interface PointerEventsSystem {
|
|
|
6542
7177
|
* @param opts - Opts to trigger Feedback and Button
|
|
6543
7178
|
*/
|
|
6544
7179
|
onPointerDown(entity: Entity, cb: EventSystemCallback, opts?: Partial<EventSystemOptions>): void;
|
|
7180
|
+
/**
|
|
7181
|
+
* @public
|
|
7182
|
+
* Execute callbacks when the user releases one of the InputButtons pointing at the entity
|
|
7183
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7184
|
+
*/
|
|
7185
|
+
onPointerUp(pointerData: {
|
|
7186
|
+
entity: Entity;
|
|
7187
|
+
optsList: EventSystemOptionsCallback[];
|
|
7188
|
+
}): void;
|
|
6545
7189
|
/**
|
|
6546
7190
|
* @public
|
|
6547
7191
|
* Execute callback when the user releases the InputButton pointing at the entity
|
|
@@ -6579,6 +7223,64 @@ export declare interface PointerEventsSystem {
|
|
|
6579
7223
|
entity: Entity;
|
|
6580
7224
|
opts?: Partial<EventSystemOptions>;
|
|
6581
7225
|
}, cb: EventSystemCallback): void;
|
|
7226
|
+
/**
|
|
7227
|
+
* @public
|
|
7228
|
+
* Execute callbacks when the user drags the pointer from inside the entity
|
|
7229
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7230
|
+
*/
|
|
7231
|
+
onPointerDrag(pointerData: {
|
|
7232
|
+
entity: Entity;
|
|
7233
|
+
optsList: EventSystemOptionsCallback[];
|
|
7234
|
+
}): void;
|
|
7235
|
+
/**
|
|
7236
|
+
* @public
|
|
7237
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity
|
|
7238
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7239
|
+
* @param cb - Function to execute when click fires
|
|
7240
|
+
*/
|
|
7241
|
+
onPointerDrag(pointerData: {
|
|
7242
|
+
entity: Entity;
|
|
7243
|
+
opts?: Partial<EventSystemOptions>;
|
|
7244
|
+
}, cb: EventSystemCallback): void;
|
|
7245
|
+
/**
|
|
7246
|
+
* @public
|
|
7247
|
+
* Execute callbacks when the user drags the pointer from inside the entity, locking the cursor in place.
|
|
7248
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7249
|
+
*/
|
|
7250
|
+
onPointerDragLocked(pointerData: {
|
|
7251
|
+
entity: Entity;
|
|
7252
|
+
optsList: EventSystemOptionsCallback[];
|
|
7253
|
+
}): void;
|
|
7254
|
+
/**
|
|
7255
|
+
* @public
|
|
7256
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
|
7257
|
+
* locking the cursor in place
|
|
7258
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7259
|
+
* @param cb - Function to execute when click fires
|
|
7260
|
+
*/
|
|
7261
|
+
onPointerDragLocked(pointerData: {
|
|
7262
|
+
entity: Entity;
|
|
7263
|
+
opts?: Partial<EventSystemOptions>;
|
|
7264
|
+
}, cb: EventSystemCallback): void;
|
|
7265
|
+
/**
|
|
7266
|
+
* @public
|
|
7267
|
+
* Execute callbacks when the user releases a button after a drag
|
|
7268
|
+
* @param pointerData - Entity to attach the callbacks, list of options to trigger Feedback, Button, and Callback
|
|
7269
|
+
*/
|
|
7270
|
+
onPointerDragEnd(pointerData: {
|
|
7271
|
+
entity: Entity;
|
|
7272
|
+
optsList: EventSystemOptionsCallback[];
|
|
7273
|
+
}): void;
|
|
7274
|
+
/**
|
|
7275
|
+
* @public
|
|
7276
|
+
* Execute callback when the user releases the button after a drag
|
|
7277
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
|
7278
|
+
* @param cb - Function to execute when click fires
|
|
7279
|
+
*/
|
|
7280
|
+
onPointerDragEnd(pointerData: {
|
|
7281
|
+
entity: Entity;
|
|
7282
|
+
opts?: Partial<EventSystemOptions>;
|
|
7283
|
+
}, cb: EventSystemCallback): void;
|
|
6582
7284
|
}
|
|
6583
7285
|
|
|
6584
7286
|
/**
|
|
@@ -6595,7 +7297,10 @@ export declare const enum PointerEventType {
|
|
|
6595
7297
|
PET_UP = 0,
|
|
6596
7298
|
PET_DOWN = 1,
|
|
6597
7299
|
PET_HOVER_ENTER = 2,
|
|
6598
|
-
PET_HOVER_LEAVE = 3
|
|
7300
|
+
PET_HOVER_LEAVE = 3,
|
|
7301
|
+
PET_DRAG_LOCKED = 4,
|
|
7302
|
+
PET_DRAG = 5,
|
|
7303
|
+
PET_DRAG_END = 6
|
|
6599
7304
|
}
|
|
6600
7305
|
|
|
6601
7306
|
/**
|
|
@@ -6626,7 +7331,10 @@ export declare const enum PointerType {
|
|
|
6626
7331
|
/** POT_NONE - No pointer input */
|
|
6627
7332
|
POT_NONE = 0,
|
|
6628
7333
|
/** POT_MOUSE - Traditional mouse input */
|
|
6629
|
-
POT_MOUSE = 1
|
|
7334
|
+
POT_MOUSE = 1,
|
|
7335
|
+
POT_PAD = 2,
|
|
7336
|
+
POT_TOUCH = 3,
|
|
7337
|
+
POT_WAND = 4
|
|
6630
7338
|
}
|
|
6631
7339
|
|
|
6632
7340
|
/**
|
|
@@ -7229,6 +7937,11 @@ export declare interface ReactBasedUiSystem {
|
|
|
7229
7937
|
* Set the main UI renderer. Optional virtual size defines the global UI scale factor.
|
|
7230
7938
|
*/
|
|
7231
7939
|
setUiRenderer(ui: UiComponent, options?: UiRendererOptions): void;
|
|
7940
|
+
/**
|
|
7941
|
+
* Set a texture renderer for a specific entity.
|
|
7942
|
+
* @deprecated Use addUiRenderer instead
|
|
7943
|
+
*/
|
|
7944
|
+
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
|
7232
7945
|
/**
|
|
7233
7946
|
* Add a UI renderer associated with an entity. The UI will be automatically cleaned up
|
|
7234
7947
|
* when the entity is removed from the engine.
|
|
@@ -7812,6 +8525,49 @@ export declare namespace Schemas {
|
|
|
7812
8525
|
}) => void;
|
|
7813
8526
|
}
|
|
7814
8527
|
|
|
8528
|
+
/**
|
|
8529
|
+
* @public
|
|
8530
|
+
*/
|
|
8531
|
+
export declare interface ScrollPositionValue {
|
|
8532
|
+
value?: {
|
|
8533
|
+
$case: "position";
|
|
8534
|
+
position: PBVector2;
|
|
8535
|
+
} | {
|
|
8536
|
+
$case: "reference";
|
|
8537
|
+
reference: string;
|
|
8538
|
+
} | undefined;
|
|
8539
|
+
}
|
|
8540
|
+
|
|
8541
|
+
/**
|
|
8542
|
+
* @public
|
|
8543
|
+
*/
|
|
8544
|
+
export declare namespace ScrollPositionValue {
|
|
8545
|
+
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
|
8546
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
|
8547
|
+
}
|
|
8548
|
+
|
|
8549
|
+
/**
|
|
8550
|
+
* @public
|
|
8551
|
+
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
|
8552
|
+
*/
|
|
8553
|
+
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
|
8554
|
+
|
|
8555
|
+
/**
|
|
8556
|
+
* Sets a globalThis property as a polyfill (only if undefined/null).
|
|
8557
|
+
* @public
|
|
8558
|
+
*/
|
|
8559
|
+
export declare function setGlobalPolyfill<T>(key: string, value: T): void;
|
|
8560
|
+
|
|
8561
|
+
/**
|
|
8562
|
+
* @public
|
|
8563
|
+
*/
|
|
8564
|
+
export declare const enum ShowScrollBar {
|
|
8565
|
+
SSB_BOTH = 0,
|
|
8566
|
+
SSB_ONLY_VERTICAL = 1,
|
|
8567
|
+
SSB_ONLY_HORIZONTAL = 2,
|
|
8568
|
+
SSB_HIDDEN = 3
|
|
8569
|
+
}
|
|
8570
|
+
|
|
7815
8571
|
/** @public */
|
|
7816
8572
|
export declare const SkyboxTime: LastWriteWinElementSetComponentDefinition<PBSkyboxTime>;
|
|
7817
8573
|
|
|
@@ -7923,6 +8679,9 @@ export declare namespace Texture {
|
|
|
7923
8679
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
|
7924
8680
|
}
|
|
7925
8681
|
|
|
8682
|
+
/** @public */
|
|
8683
|
+
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
|
8684
|
+
|
|
7926
8685
|
/**
|
|
7927
8686
|
* @public
|
|
7928
8687
|
*/
|
|
@@ -8033,6 +8792,9 @@ export declare interface TextureUnion {
|
|
|
8033
8792
|
} | {
|
|
8034
8793
|
$case: "videoTexture";
|
|
8035
8794
|
videoTexture: VideoTexture;
|
|
8795
|
+
} | {
|
|
8796
|
+
$case: "uiTexture";
|
|
8797
|
+
uiTexture: UiCanvasTexture;
|
|
8036
8798
|
} | undefined;
|
|
8037
8799
|
}
|
|
8038
8800
|
|
|
@@ -8510,6 +9272,8 @@ export declare interface UiBackgroundProps {
|
|
|
8510
9272
|
uvs?: number[];
|
|
8511
9273
|
/** AvatarTexture for the background */
|
|
8512
9274
|
avatarTexture?: UiAvatarTexture;
|
|
9275
|
+
/** VideoTexture for the background */
|
|
9276
|
+
videoTexture?: UiVideoTexture;
|
|
8513
9277
|
/** Texture for the background */
|
|
8514
9278
|
texture?: UiTexture;
|
|
8515
9279
|
}
|
|
@@ -8529,9 +9293,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
|
8529
9293
|
disabled?: boolean;
|
|
8530
9294
|
}
|
|
8531
9295
|
|
|
9296
|
+
/** @public */
|
|
9297
|
+
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
|
9298
|
+
|
|
8532
9299
|
/** @public */
|
|
8533
9300
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
|
8534
9301
|
|
|
9302
|
+
/**
|
|
9303
|
+
* @public
|
|
9304
|
+
*/
|
|
9305
|
+
export declare interface UiCanvasTexture {
|
|
9306
|
+
uiCanvasEntity: number;
|
|
9307
|
+
/** default = TextureWrapMode.Clamp */
|
|
9308
|
+
wrapMode?: TextureWrapMode | undefined;
|
|
9309
|
+
/** default = FilterMode.Bilinear */
|
|
9310
|
+
filterMode?: TextureFilterMode | undefined;
|
|
9311
|
+
}
|
|
9312
|
+
|
|
9313
|
+
/**
|
|
9314
|
+
* @public
|
|
9315
|
+
*/
|
|
9316
|
+
export declare namespace UiCanvasTexture {
|
|
9317
|
+
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
|
9318
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
|
9319
|
+
}
|
|
9320
|
+
|
|
8535
9321
|
/**
|
|
8536
9322
|
* @public
|
|
8537
9323
|
*/
|
|
@@ -8601,6 +9387,10 @@ export declare interface UiLabelProps {
|
|
|
8601
9387
|
textAlign?: TextAlignType | undefined;
|
|
8602
9388
|
/** Label font type. @defaultValue 'sans-serif' */
|
|
8603
9389
|
font?: UiFontType | undefined;
|
|
9390
|
+
/** Outline width of the text. @defaultValue 0 */
|
|
9391
|
+
outlineWidth?: number | undefined;
|
|
9392
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
|
9393
|
+
outlineColor?: PBColor4 | undefined;
|
|
8604
9394
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
|
8605
9395
|
textWrap?: UiTextWrapType | undefined;
|
|
8606
9396
|
}
|
|
@@ -8618,6 +9408,9 @@ export declare type UiRendererOptions = {
|
|
|
8618
9408
|
virtualHeight: number;
|
|
8619
9409
|
};
|
|
8620
9410
|
|
|
9411
|
+
/** @public */
|
|
9412
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
|
9413
|
+
|
|
8621
9414
|
/** @public */
|
|
8622
9415
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
|
8623
9416
|
|
|
@@ -8695,10 +9488,26 @@ export declare interface UiTransformProps {
|
|
|
8695
9488
|
borderWidth?: Partial<Position> | PositionUnit;
|
|
8696
9489
|
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
|
8697
9490
|
opacity?: number;
|
|
9491
|
+
/** A reference value to identify the element, default empty */
|
|
9492
|
+
elementId?: string;
|
|
9493
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
|
9494
|
+
scrollPosition?: PBVector2 | string;
|
|
9495
|
+
/** default ShowScrollBar.SSB_BOTH */
|
|
9496
|
+
scrollVisible?: ScrollVisibleType;
|
|
8698
9497
|
/** default 0 */
|
|
8699
9498
|
zIndex?: number;
|
|
8700
9499
|
}
|
|
8701
9500
|
|
|
9501
|
+
/**
|
|
9502
|
+
* Texture
|
|
9503
|
+
* @public
|
|
9504
|
+
*/
|
|
9505
|
+
export declare interface UiVideoTexture {
|
|
9506
|
+
videoPlayerEntity: Entity;
|
|
9507
|
+
wrapMode?: TextureWrapType;
|
|
9508
|
+
filterMode?: TextureFilterType;
|
|
9509
|
+
}
|
|
9510
|
+
|
|
8702
9511
|
/**
|
|
8703
9512
|
* @public
|
|
8704
9513
|
*/
|