@dcl/playground-assets 7.7.3-13092882598.commit-32642df → 7.7.3-13119260146.commit-a60db93
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 +5 -783
- package/dist/beta.d.ts +5 -783
- package/dist/index.bundled.d.ts +5 -783
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +5 -783
- package/etc/playground-assets.api.json +1118 -9000
- package/etc/playground-assets.api.md +0 -502
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
@@ -178,18 +178,6 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
|
|
178
178
|
/** @public */
|
179
179
|
export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
|
180
180
|
|
181
|
-
/**
|
182
|
-
* @public
|
183
|
-
*/
|
184
|
-
export declare const enum AvatarControlType {
|
185
|
-
/** CCT_NONE - avatar cannot move */
|
186
|
-
CCT_NONE = 0,
|
187
|
-
/** CCT_RELATIVE - avatar moves relative to the camera origin */
|
188
|
-
CCT_RELATIVE = 1,
|
189
|
-
/** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
|
190
|
-
CCT_TANK = 2
|
191
|
-
}
|
192
|
-
|
193
181
|
/** @public */
|
194
182
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
195
183
|
|
@@ -210,37 +198,6 @@ export declare const enum AvatarModifierType {
|
|
210
198
|
AMT_DISABLE_PASSPORTS = 1
|
211
199
|
}
|
212
200
|
|
213
|
-
/**
|
214
|
-
* @public
|
215
|
-
*/
|
216
|
-
export declare interface AvatarMovementSettings {
|
217
|
-
controlMode?: AvatarControlType | undefined;
|
218
|
-
/** if not explicitly set, the following properties default to user's preference settings */
|
219
|
-
runSpeed?: number | undefined;
|
220
|
-
/** how fast the player gets up to speed or comes to rest. higher = more responsive */
|
221
|
-
friction?: number | undefined;
|
222
|
-
/** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
|
223
|
-
gravity?: number | undefined;
|
224
|
-
/** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
|
225
|
-
jumpHeight?: number | undefined;
|
226
|
-
/** max fall speed in m/s. should normally be negative */
|
227
|
-
maxFallSpeed?: number | undefined;
|
228
|
-
/** speed the player turns in tank mode, in radians/s */
|
229
|
-
turnSpeed?: number | undefined;
|
230
|
-
/** speed the player walks at, in m/s */
|
231
|
-
walkSpeed?: number | undefined;
|
232
|
-
/** 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 */
|
233
|
-
allowWeightedMovement?: boolean | undefined;
|
234
|
-
}
|
235
|
-
|
236
|
-
/**
|
237
|
-
* @public
|
238
|
-
*/
|
239
|
-
export declare namespace AvatarMovementSettings {
|
240
|
-
export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
|
241
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
242
|
-
}
|
243
|
-
|
244
201
|
/** @public */
|
245
202
|
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
246
203
|
|
@@ -505,12 +462,6 @@ export declare interface ByteBuffer {
|
|
505
462
|
*/
|
506
463
|
export declare type Callback = () => void;
|
507
464
|
|
508
|
-
/** @public */
|
509
|
-
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
510
|
-
|
511
|
-
/** @public */
|
512
|
-
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
513
|
-
|
514
465
|
/** @public */
|
515
466
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
516
467
|
|
@@ -568,39 +519,6 @@ export declare const enum CameraType {
|
|
568
519
|
|
569
520
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
570
521
|
|
571
|
-
/**
|
572
|
-
* @public
|
573
|
-
*/
|
574
|
-
export declare interface CinematicSettings {
|
575
|
-
/** Entity that defines the cinematic camera transform. */
|
576
|
-
cameraEntity: number;
|
577
|
-
/**
|
578
|
-
* Position -> camera's position
|
579
|
-
* Rotation -> camera's direction
|
580
|
-
* scale.z -> zoom level
|
581
|
-
* scale.x and scale.y -> unused
|
582
|
-
*/
|
583
|
-
allowManualRotation?: boolean | undefined;
|
584
|
-
/** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
|
585
|
-
yawRange?: number | undefined;
|
586
|
-
/** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
|
587
|
-
pitchRange?: number | undefined;
|
588
|
-
/** note: cameras can never look up/down further than Vec3::Y */
|
589
|
-
rollRange?: number | undefined;
|
590
|
-
/** minimum zoom level. must be greater than 0. defaults to the input zoom level */
|
591
|
-
zoomMin?: number | undefined;
|
592
|
-
/** maximum zoom level. must be greater than 0. defaults to the input zoom level */
|
593
|
-
zoomMax?: number | undefined;
|
594
|
-
}
|
595
|
-
|
596
|
-
/**
|
597
|
-
* @public
|
598
|
-
*/
|
599
|
-
export declare namespace CinematicSettings {
|
600
|
-
export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
|
601
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
|
602
|
-
}
|
603
|
-
|
604
522
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
605
523
|
/**
|
606
524
|
* @public
|
@@ -1374,18 +1292,12 @@ export declare const componentDefinitionByName: {
|
|
1374
1292
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
1375
1293
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
1376
1294
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
1377
|
-
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
1378
|
-
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
1379
1295
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
1380
1296
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
1381
1297
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
1382
|
-
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
1383
1298
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
1384
1299
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
1385
|
-
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
1386
|
-
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
1387
1300
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
1388
|
-
"core::Light": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLight>>;
|
1389
1301
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
1390
1302
|
"core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
|
1391
1303
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
@@ -1395,24 +1307,19 @@ export declare const componentDefinitionByName: {
|
|
1395
1307
|
"core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
|
1396
1308
|
"core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
|
1397
1309
|
"core::PointerLock": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerLock>>;
|
1398
|
-
"core::PrimaryPointerInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>>;
|
1399
1310
|
"core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
|
1400
1311
|
"core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
|
1401
1312
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
1402
|
-
"core::Spotlight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSpotlight>>;
|
1403
1313
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
1404
|
-
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
1405
1314
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
1406
1315
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
1407
1316
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
1408
1317
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
1409
|
-
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
1410
1318
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
1411
1319
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
1412
1320
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
1413
1321
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
1414
1322
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
1415
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
1416
1323
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
1417
1324
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
1418
1325
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
@@ -1978,9 +1885,6 @@ export declare type EntityComponents = {
|
|
1978
1885
|
onMouseUp: Callback;
|
1979
1886
|
onMouseEnter: Callback;
|
1980
1887
|
onMouseLeave: Callback;
|
1981
|
-
onMouseDrag: Callback;
|
1982
|
-
onMouseDragLocked: Callback;
|
1983
|
-
onMouseDragEnd: Callback;
|
1984
1888
|
};
|
1985
1889
|
|
1986
1890
|
/** @public */
|
@@ -2132,9 +2036,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
2132
2036
|
direction?: PBVector3;
|
2133
2037
|
};
|
2134
2038
|
|
2135
|
-
/** @public */
|
2136
|
-
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
2137
|
-
|
2138
2039
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
2139
2040
|
|
2140
2041
|
export declare type GlobalTargetRaycastSystemOptions = {
|
@@ -2147,21 +2048,6 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
2147
2048
|
/** @public */
|
2148
2049
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
2149
2050
|
|
2150
|
-
/** @public */
|
2151
|
-
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
2152
|
-
|
2153
|
-
/** @public */
|
2154
|
-
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
2155
|
-
|
2156
|
-
/**
|
2157
|
-
* @public
|
2158
|
-
*/
|
2159
|
-
export declare const enum GltfNodeStateValue {
|
2160
|
-
GNSV_PENDING = 0,
|
2161
|
-
GNSV_FAILED = 1,
|
2162
|
-
GNSV_READY = 2
|
2163
|
-
}
|
2164
|
-
|
2165
2051
|
/**
|
2166
2052
|
* @public
|
2167
2053
|
*/
|
@@ -2765,9 +2651,6 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
2765
2651
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
2766
2652
|
}
|
2767
2653
|
|
2768
|
-
/** @public */
|
2769
|
-
export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
|
2770
|
-
|
2771
2654
|
/**
|
2772
2655
|
* User key event Listeners
|
2773
2656
|
* @public
|
@@ -2781,12 +2664,6 @@ export declare type Listeners = {
|
|
2781
2664
|
onMouseEnter?: Callback;
|
2782
2665
|
/** triggered on mouse leave event */
|
2783
2666
|
onMouseLeave?: Callback;
|
2784
|
-
/** triggered on mouse drag event */
|
2785
|
-
onMouseDrag?: Callback;
|
2786
|
-
/** triggered on mouse drag event */
|
2787
|
-
onMouseDragLocked?: Callback;
|
2788
|
-
/** triggered on mouse drag event */
|
2789
|
-
onMouseDragEnd?: Callback;
|
2790
2667
|
};
|
2791
2668
|
|
2792
2669
|
/**
|
@@ -3655,14 +3532,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3655
3532
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3656
3533
|
*/
|
3657
3534
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3658
|
-
/**
|
3659
|
-
* @public
|
3660
|
-
* Set a gltf internal mesh in the MeshCollider component
|
3661
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3662
|
-
* @param source - the path to the gltf
|
3663
|
-
* @param meshName - the name of the mesh in the gltf
|
3664
|
-
*/
|
3665
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3666
3535
|
}
|
3667
3536
|
|
3668
3537
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3699,14 +3568,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3699
3568
|
* @param entity - entity to create or replace the MeshRenderer component
|
3700
3569
|
*/
|
3701
3570
|
setSphere(entity: Entity): void;
|
3702
|
-
/**
|
3703
|
-
* @public
|
3704
|
-
* Set a gltf internal mesh in the MeshRenderer component
|
3705
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3706
|
-
* @param source - the path to the gltf
|
3707
|
-
* @param meshName - the name of the mesh in the gltf
|
3708
|
-
*/
|
3709
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3710
3571
|
}
|
3711
3572
|
|
3712
3573
|
/**
|
@@ -4119,25 +3980,6 @@ export declare const onVideoEvent: Observable<{
|
|
4119
3980
|
totalVideoLength: number;
|
4120
3981
|
}>;
|
4121
3982
|
|
4122
|
-
/**
|
4123
|
-
* @public
|
4124
|
-
*/
|
4125
|
-
export declare interface Orthographic {
|
4126
|
-
/**
|
4127
|
-
* vertical extent of the visible range in meters
|
4128
|
-
* defaults to 4m
|
4129
|
-
*/
|
4130
|
-
verticalRange?: number | undefined;
|
4131
|
-
}
|
4132
|
-
|
4133
|
-
/**
|
4134
|
-
* @public
|
4135
|
-
*/
|
4136
|
-
export declare namespace Orthographic {
|
4137
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4138
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4139
|
-
}
|
4140
|
-
|
4141
3983
|
/**
|
4142
3984
|
* @public
|
4143
3985
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4398,9 +4240,6 @@ export declare interface PBAvatarModifierArea {
|
|
4398
4240
|
excludeIds: string[];
|
4399
4241
|
/** list of modifiers to apply */
|
4400
4242
|
modifiers: AvatarModifierType[];
|
4401
|
-
movementSettings?: AvatarMovementSettings | undefined;
|
4402
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4403
|
-
useColliderRange?: boolean | undefined;
|
4404
4243
|
}
|
4405
4244
|
|
4406
4245
|
/**
|
@@ -4491,51 +4330,6 @@ export declare namespace PBBillboard {
|
|
4491
4330
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4492
4331
|
}
|
4493
4332
|
|
4494
|
-
/**
|
4495
|
-
* @public
|
4496
|
-
*/
|
4497
|
-
export declare interface PBCameraLayer {
|
4498
|
-
/**
|
4499
|
-
* layer to which these settings apply. must be > 0
|
4500
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4501
|
-
*/
|
4502
|
-
layer: number;
|
4503
|
-
/** should the sun light affect this layer? default false */
|
4504
|
-
directionalLight?: boolean | undefined;
|
4505
|
-
/** should this layer show player avatars? default false */
|
4506
|
-
showAvatars?: boolean | undefined;
|
4507
|
-
/** should this layer show the sky? default false */
|
4508
|
-
showSkybox?: boolean | undefined;
|
4509
|
-
/** should this layer show distance fog? default false */
|
4510
|
-
showFog?: boolean | undefined;
|
4511
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
4512
|
-
ambientColorOverride?: PBColor3 | undefined;
|
4513
|
-
ambientBrightnessOverride?: number | undefined;
|
4514
|
-
}
|
4515
|
-
|
4516
|
-
/**
|
4517
|
-
* @public
|
4518
|
-
*/
|
4519
|
-
export declare namespace PBCameraLayer {
|
4520
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4521
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4522
|
-
}
|
4523
|
-
|
4524
|
-
/**
|
4525
|
-
* @public
|
4526
|
-
*/
|
4527
|
-
export declare interface PBCameraLayers {
|
4528
|
-
layers: number[];
|
4529
|
-
}
|
4530
|
-
|
4531
|
-
/**
|
4532
|
-
* @public
|
4533
|
-
*/
|
4534
|
-
export declare namespace PBCameraLayers {
|
4535
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4536
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4537
|
-
}
|
4538
|
-
|
4539
4333
|
/**
|
4540
4334
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4541
4335
|
* third-person view.
|
@@ -4558,7 +4352,7 @@ export declare namespace PBCameraMode {
|
|
4558
4352
|
|
4559
4353
|
/**
|
4560
4354
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4561
|
-
* the player's camera mode (1st-person
|
4355
|
+
* the player's camera mode (1st-person or 3rd-person) is overridden.
|
4562
4356
|
*
|
4563
4357
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4564
4358
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4568,8 +4362,6 @@ export declare namespace PBCameraMode {
|
|
4568
4362
|
*
|
4569
4363
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4570
4364
|
* is actually a 3D volume.
|
4571
|
-
*
|
4572
|
-
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4573
4365
|
*/
|
4574
4366
|
/**
|
4575
4367
|
* @public
|
@@ -4579,9 +4371,6 @@ export declare interface PBCameraModeArea {
|
|
4579
4371
|
area: PBVector3 | undefined;
|
4580
4372
|
/** the camera mode to enforce */
|
4581
4373
|
mode: CameraType;
|
4582
|
-
cinematicSettings?: CinematicSettings | undefined;
|
4583
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4584
|
-
useColliderRange?: boolean | undefined;
|
4585
4374
|
}
|
4586
4375
|
|
4587
4376
|
/**
|
@@ -4653,39 +4442,6 @@ export declare namespace PBEngineInfo {
|
|
4653
4442
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4654
4443
|
}
|
4655
4444
|
|
4656
|
-
/**
|
4657
|
-
* defines the global scene light settings. must be added to the scene root.
|
4658
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4659
|
-
*/
|
4660
|
-
/**
|
4661
|
-
* @public
|
4662
|
-
*/
|
4663
|
-
export declare interface PBGlobalLight {
|
4664
|
-
/**
|
4665
|
-
* the direction the directional light shines in.
|
4666
|
-
* default depends on time of day and explorer implementation
|
4667
|
-
*/
|
4668
|
-
direction?: PBVector3 | undefined;
|
4669
|
-
/**
|
4670
|
-
* ambient light color
|
4671
|
-
* default: White
|
4672
|
-
*/
|
4673
|
-
ambientColor?: PBColor3 | undefined;
|
4674
|
-
/**
|
4675
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4676
|
-
* default 1
|
4677
|
-
*/
|
4678
|
-
ambientBrightness?: number | undefined;
|
4679
|
-
}
|
4680
|
-
|
4681
|
-
/**
|
4682
|
-
* @public
|
4683
|
-
*/
|
4684
|
-
export declare namespace PBGlobalLight {
|
4685
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4686
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4687
|
-
}
|
4688
|
-
|
4689
4445
|
/**
|
4690
4446
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4691
4447
|
*
|
@@ -4721,25 +4477,6 @@ export declare namespace PBGltfContainer {
|
|
4721
4477
|
*/
|
4722
4478
|
export declare interface PBGltfContainerLoadingState {
|
4723
4479
|
currentState: LoadingState;
|
4724
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4725
|
-
nodePaths: string[];
|
4726
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4727
|
-
meshNames: string[];
|
4728
|
-
/**
|
4729
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4730
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4731
|
-
*/
|
4732
|
-
materialNames: string[];
|
4733
|
-
/**
|
4734
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4735
|
-
* sure all your materials are explicitly named.
|
4736
|
-
*/
|
4737
|
-
skinNames: string[];
|
4738
|
-
/**
|
4739
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4740
|
-
* your skins are explicitly named.
|
4741
|
-
*/
|
4742
|
-
animationNames: string[];
|
4743
4480
|
}
|
4744
4481
|
|
4745
4482
|
/**
|
@@ -4750,77 +4487,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4750
4487
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4751
4488
|
}
|
4752
4489
|
|
4753
|
-
/**
|
4754
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4755
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4756
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4757
|
-
* in the parent.
|
4758
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4759
|
-
*
|
4760
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4761
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4762
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4763
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4764
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4765
|
-
*
|
4766
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4767
|
-
*
|
4768
|
-
* From the scene, you can modify various components to alter the gltf node:
|
4769
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4770
|
-
* regardless of any intermediate gltf node hierarchy.
|
4771
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4772
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4773
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4774
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4775
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4776
|
-
* 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
|
4777
|
-
* PBMaterial will be maintained.
|
4778
|
-
*
|
4779
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4780
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4781
|
-
* change the state to `GNS_FAILED`.
|
4782
|
-
* - deleting the scene entity will not delete the gltf node.
|
4783
|
-
*
|
4784
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4785
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4786
|
-
* the gltf node will also be displayed.
|
4787
|
-
*/
|
4788
|
-
/**
|
4789
|
-
* @public
|
4790
|
-
*/
|
4791
|
-
export declare interface PBGltfNode {
|
4792
|
-
/** the path of the target node in the Gltf. */
|
4793
|
-
path: string;
|
4794
|
-
}
|
4795
|
-
|
4796
|
-
/**
|
4797
|
-
* @public
|
4798
|
-
*/
|
4799
|
-
export declare namespace PBGltfNode {
|
4800
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4801
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4802
|
-
}
|
4803
|
-
|
4804
|
-
/**
|
4805
|
-
* The state of a linked gltf node.
|
4806
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4807
|
-
*/
|
4808
|
-
/**
|
4809
|
-
* @public
|
4810
|
-
*/
|
4811
|
-
export declare interface PBGltfNodeState {
|
4812
|
-
state: GltfNodeStateValue;
|
4813
|
-
error?: string | undefined;
|
4814
|
-
}
|
4815
|
-
|
4816
|
-
/**
|
4817
|
-
* @public
|
4818
|
-
*/
|
4819
|
-
export declare namespace PBGltfNodeState {
|
4820
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4821
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4822
|
-
}
|
4823
|
-
|
4824
4490
|
/**
|
4825
4491
|
* @public
|
4826
4492
|
*/
|
@@ -4860,62 +4526,6 @@ export declare namespace PBInputModifier_StandardInput {
|
|
4860
4526
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4861
4527
|
}
|
4862
4528
|
|
4863
|
-
/**
|
4864
|
-
* defines a light source.
|
4865
|
-
* the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
|
4866
|
-
* a PBGlobalLight component can also be added to the root to control the directional light direction.
|
4867
|
-
* point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
|
4868
|
-
*/
|
4869
|
-
/**
|
4870
|
-
* @public
|
4871
|
-
*/
|
4872
|
-
export declare interface PBLight {
|
4873
|
-
/**
|
4874
|
-
* whether the light is on
|
4875
|
-
* default true
|
4876
|
-
*/
|
4877
|
-
enabled?: boolean | undefined;
|
4878
|
-
/**
|
4879
|
-
* light brightness in lux (lumens/m^2).
|
4880
|
-
*
|
4881
|
-
* for global directional light, this applies as a constant value at all surfaces and distances (though the effect on the surface still depends on incidence angle).
|
4882
|
-
* the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
|
4883
|
-
* for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
|
4884
|
-
*
|
4885
|
-
* for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
|
4886
|
-
* divide lumens by ~12 (4*pi).
|
4887
|
-
* e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
|
4888
|
-
* a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
|
4889
|
-
*
|
4890
|
-
* default
|
4891
|
-
* for point/spotlights: 10,000
|
4892
|
-
* for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
|
4893
|
-
*/
|
4894
|
-
illuminance?: number | undefined;
|
4895
|
-
/**
|
4896
|
-
* whether the light should cast shadows.
|
4897
|
-
* note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
|
4898
|
-
* of lights depending on the implementation, platform, and user settings.
|
4899
|
-
* default
|
4900
|
-
* for point/spotlights: false / off
|
4901
|
-
* for global directional light: true / on
|
4902
|
-
*/
|
4903
|
-
shadows?: boolean | undefined;
|
4904
|
-
/**
|
4905
|
-
* light color
|
4906
|
-
* default White
|
4907
|
-
*/
|
4908
|
-
color?: PBColor3 | undefined;
|
4909
|
-
}
|
4910
|
-
|
4911
|
-
/**
|
4912
|
-
* @public
|
4913
|
-
*/
|
4914
|
-
export declare namespace PBLight {
|
4915
|
-
export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
|
4916
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
|
4917
|
-
}
|
4918
|
-
|
4919
4529
|
/**
|
4920
4530
|
* PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
|
4921
4531
|
* This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
|
@@ -4947,14 +4557,6 @@ export declare interface PBMaterial {
|
|
4947
4557
|
$case: "pbr";
|
4948
4558
|
pbr: PBMaterial_PbrMaterial;
|
4949
4559
|
} | undefined;
|
4950
|
-
/**
|
4951
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
4952
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
4953
|
-
* supported by the PbMaterial.
|
4954
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
4955
|
-
* field with data that reflects the gltf material once it is loaded.
|
4956
|
-
*/
|
4957
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
4958
4560
|
}
|
4959
4561
|
|
4960
4562
|
/**
|
@@ -4965,22 +4567,6 @@ export declare namespace PBMaterial {
|
|
4965
4567
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4966
4568
|
}
|
4967
4569
|
|
4968
|
-
/**
|
4969
|
-
* @public
|
4970
|
-
*/
|
4971
|
-
export declare interface PBMaterial_GltfMaterial {
|
4972
|
-
gltfSrc: string;
|
4973
|
-
name: string;
|
4974
|
-
}
|
4975
|
-
|
4976
|
-
/**
|
4977
|
-
* @public
|
4978
|
-
*/
|
4979
|
-
export declare namespace PBMaterial_GltfMaterial {
|
4980
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
4981
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
4982
|
-
}
|
4983
|
-
|
4984
4570
|
/**
|
4985
4571
|
* @public
|
4986
4572
|
*/
|
@@ -5077,9 +4663,6 @@ export declare interface PBMeshCollider {
|
|
5077
4663
|
} | {
|
5078
4664
|
$case: "plane";
|
5079
4665
|
plane: PBMeshCollider_PlaneMesh;
|
5080
|
-
} | {
|
5081
|
-
$case: "gltf";
|
5082
|
-
gltf: PBMeshCollider_GltfMesh;
|
5083
4666
|
} | undefined;
|
5084
4667
|
}
|
5085
4668
|
|
@@ -5125,25 +4708,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
5125
4708
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
5126
4709
|
}
|
5127
4710
|
|
5128
|
-
/** A collider constructed from a Gltf Mesh. */
|
5129
|
-
/**
|
5130
|
-
* @public
|
5131
|
-
*/
|
5132
|
-
export declare interface PBMeshCollider_GltfMesh {
|
5133
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5134
|
-
gltfSrc: string;
|
5135
|
-
/** the name of the mesh asset */
|
5136
|
-
name: string;
|
5137
|
-
}
|
5138
|
-
|
5139
|
-
/**
|
5140
|
-
* @public
|
5141
|
-
*/
|
5142
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
5143
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5144
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5145
|
-
}
|
5146
|
-
|
5147
4711
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
5148
4712
|
/**
|
5149
4713
|
* @public
|
@@ -5176,11 +4740,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
5176
4740
|
|
5177
4741
|
/**
|
5178
4742
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
5179
|
-
* plane, a sphere
|
4743
|
+
* plane, a sphere or a cylinder.
|
5180
4744
|
*
|
5181
4745
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
5182
4746
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
5183
4747
|
* `float` coordinates, one for each corner of each side of each face.
|
4748
|
+
*
|
4749
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
5184
4750
|
*/
|
5185
4751
|
/**
|
5186
4752
|
* @public
|
@@ -5198,9 +4764,6 @@ export declare interface PBMeshRenderer {
|
|
5198
4764
|
} | {
|
5199
4765
|
$case: "plane";
|
5200
4766
|
plane: PBMeshRenderer_PlaneMesh;
|
5201
|
-
} | {
|
5202
|
-
$case: "gltf";
|
5203
|
-
gltf: PBMeshRenderer_GltfMesh;
|
5204
4767
|
} | undefined;
|
5205
4768
|
}
|
5206
4769
|
|
@@ -5248,25 +4811,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
5248
4811
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
5249
4812
|
}
|
5250
4813
|
|
5251
|
-
/** A mesh from a Gltf. */
|
5252
|
-
/**
|
5253
|
-
* @public
|
5254
|
-
*/
|
5255
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
5256
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5257
|
-
gltfSrc: string;
|
5258
|
-
/** the name of the mesh asset */
|
5259
|
-
name: string;
|
5260
|
-
}
|
5261
|
-
|
5262
|
-
/**
|
5263
|
-
* @public
|
5264
|
-
*/
|
5265
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
5266
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5267
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5268
|
-
}
|
5269
|
-
|
5270
4814
|
/** PlaneMesh renders a 2D rectangular shape. */
|
5271
4815
|
/**
|
5272
4816
|
* @public
|
@@ -5485,30 +5029,6 @@ export declare namespace PBPosition {
|
|
5485
5029
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
|
5486
5030
|
}
|
5487
5031
|
|
5488
|
-
/**
|
5489
|
-
* @public
|
5490
|
-
*/
|
5491
|
-
export declare interface PBPrimaryPointerInfo {
|
5492
|
-
pointerType?: PointerType | undefined;
|
5493
|
-
/** in pixels */
|
5494
|
-
screenCoordinates?: PBVector2 | undefined;
|
5495
|
-
/** in pixels */
|
5496
|
-
screenDelta?: PBVector2 | undefined;
|
5497
|
-
/**
|
5498
|
-
* ray direction that can be used with the primary camera origin for
|
5499
|
-
* raycasting from the cursor into the world
|
5500
|
-
*/
|
5501
|
-
worldRayDirection?: PBVector3 | undefined;
|
5502
|
-
}
|
5503
|
-
|
5504
|
-
/**
|
5505
|
-
* @public
|
5506
|
-
*/
|
5507
|
-
export declare namespace PBPrimaryPointerInfo {
|
5508
|
-
export function encode(message: PBPrimaryPointerInfo, writer?: _m0.Writer): _m0.Writer;
|
5509
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPrimaryPointerInfo;
|
5510
|
-
}
|
5511
|
-
|
5512
5032
|
/**
|
5513
5033
|
* @public
|
5514
5034
|
*/
|
@@ -5630,39 +5150,6 @@ export declare namespace PBRealmInfo {
|
|
5630
5150
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5631
5151
|
}
|
5632
5152
|
|
5633
|
-
/**
|
5634
|
-
* defines a spotlight.
|
5635
|
-
* spotlights are point lights that emit light only in a cone around the transform's forward direction.
|
5636
|
-
* add this component together with the PBLight component to transform a point light into a spotlight.
|
5637
|
-
* note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
|
5638
|
-
* so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
|
5639
|
-
* a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
|
5640
|
-
* and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
|
5641
|
-
*/
|
5642
|
-
/**
|
5643
|
-
* @public
|
5644
|
-
*/
|
5645
|
-
export declare interface PBSpotlight {
|
5646
|
-
/**
|
5647
|
-
* the cone radius in radians. distance away from forward in which the light is visible.
|
5648
|
-
* for a torch a value around 0.15 is appropriate.
|
5649
|
-
*/
|
5650
|
-
angle: number;
|
5651
|
-
/**
|
5652
|
-
* optional angle at which the light is brightest. should be <= outer angle.
|
5653
|
-
* if specified, the light will fall off smoothly between `inner_angle` and `angle`.
|
5654
|
-
*/
|
5655
|
-
innerAngle?: number | undefined;
|
5656
|
-
}
|
5657
|
-
|
5658
|
-
/**
|
5659
|
-
* @public
|
5660
|
-
*/
|
5661
|
-
export declare namespace PBSpotlight {
|
5662
|
-
export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
|
5663
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
|
5664
|
-
}
|
5665
|
-
|
5666
5153
|
/**
|
5667
5154
|
* The TextShape component renders customizable floating text.
|
5668
5155
|
*
|
@@ -5727,40 +5214,6 @@ export declare namespace PBTextShape {
|
|
5727
5214
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5728
5215
|
}
|
5729
5216
|
|
5730
|
-
/**
|
5731
|
-
* @public
|
5732
|
-
*/
|
5733
|
-
export declare interface PBTextureCamera {
|
5734
|
-
/** rendered texture width */
|
5735
|
-
width?: number | undefined;
|
5736
|
-
/** rendered texture height */
|
5737
|
-
height?: number | undefined;
|
5738
|
-
/**
|
5739
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5740
|
-
* defaults to 0
|
5741
|
-
*/
|
5742
|
-
layer?: number | undefined;
|
5743
|
-
/** default black */
|
5744
|
-
clearColor?: PBColor4 | undefined;
|
5745
|
-
/** default infinity */
|
5746
|
-
farPlane?: number | undefined;
|
5747
|
-
mode?: {
|
5748
|
-
$case: "perspective";
|
5749
|
-
perspective: Perspective;
|
5750
|
-
} | {
|
5751
|
-
$case: "orthographic";
|
5752
|
-
orthographic: Orthographic;
|
5753
|
-
} | undefined;
|
5754
|
-
}
|
5755
|
-
|
5756
|
-
/**
|
5757
|
-
* @public
|
5758
|
-
*/
|
5759
|
-
export declare namespace PBTextureCamera {
|
5760
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5761
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5762
|
-
}
|
5763
|
-
|
5764
5217
|
/**
|
5765
5218
|
* @public
|
5766
5219
|
*/
|
@@ -5850,25 +5303,6 @@ export declare namespace PBUiBackground {
|
|
5850
5303
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5851
5304
|
}
|
5852
5305
|
|
5853
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5854
|
-
/**
|
5855
|
-
* @public
|
5856
|
-
*/
|
5857
|
-
export declare interface PBUiCanvas {
|
5858
|
-
width: number;
|
5859
|
-
height: number;
|
5860
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5861
|
-
color?: PBColor4 | undefined;
|
5862
|
-
}
|
5863
|
-
|
5864
|
-
/**
|
5865
|
-
* @public
|
5866
|
-
*/
|
5867
|
-
export declare namespace PBUiCanvas {
|
5868
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5869
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5870
|
-
}
|
5871
|
-
|
5872
5306
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5873
5307
|
/**
|
5874
5308
|
* @public
|
@@ -5985,21 +5419,6 @@ export declare namespace PBUiInputResult {
|
|
5985
5419
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5986
5420
|
}
|
5987
5421
|
|
5988
|
-
/**
|
5989
|
-
* @public
|
5990
|
-
*/
|
5991
|
-
export declare interface PBUiScrollResult {
|
5992
|
-
value: PBVector2 | undefined;
|
5993
|
-
}
|
5994
|
-
|
5995
|
-
/**
|
5996
|
-
* @public
|
5997
|
-
*/
|
5998
|
-
export declare namespace PBUiScrollResult {
|
5999
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
6000
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
6001
|
-
}
|
6002
|
-
|
6003
5422
|
/**
|
6004
5423
|
* @public
|
6005
5424
|
*/
|
@@ -6016,10 +5435,6 @@ export declare interface PBUiText {
|
|
6016
5435
|
fontSize?: number | undefined;
|
6017
5436
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
6018
5437
|
textWrap?: TextWrap | undefined;
|
6019
|
-
/** width of the outline (default: 0) */
|
6020
|
-
outlineWidth?: number | undefined;
|
6021
|
-
/** RGBA color of the outline (default: opaque black) */
|
6022
|
-
outlineColor?: PBColor4 | undefined;
|
6023
5438
|
}
|
6024
5439
|
|
6025
5440
|
/**
|
@@ -6116,16 +5531,6 @@ export declare interface PBUiTransform {
|
|
6116
5531
|
paddingBottom: number;
|
6117
5532
|
/** default: PointerFilterMode.PFM_NONE */
|
6118
5533
|
pointerFilter?: PointerFilterMode | undefined;
|
6119
|
-
/** default: 1 */
|
6120
|
-
opacity?: number | undefined;
|
6121
|
-
/** default empty */
|
6122
|
-
elementId?: string | undefined;
|
6123
|
-
/** default position=(0,0) */
|
6124
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
6125
|
-
/** default ShowScrollBar.SSB_BOTH */
|
6126
|
-
scrollVisible?: ShowScrollBar | undefined;
|
6127
|
-
/** default 0 */
|
6128
|
-
zIndex?: number | undefined;
|
6129
5534
|
}
|
6130
5535
|
|
6131
5536
|
/**
|
@@ -6255,25 +5660,6 @@ export declare namespace PBVisibilityComponent {
|
|
6255
5660
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
6256
5661
|
}
|
6257
5662
|
|
6258
|
-
/**
|
6259
|
-
* @public
|
6260
|
-
*/
|
6261
|
-
export declare interface Perspective {
|
6262
|
-
/**
|
6263
|
-
* vertical field of view in radians
|
6264
|
-
* defaults to pi/4 = 45 degrees
|
6265
|
-
*/
|
6266
|
-
fieldOfView?: number | undefined;
|
6267
|
-
}
|
6268
|
-
|
6269
|
-
/**
|
6270
|
-
* @public
|
6271
|
-
*/
|
6272
|
-
export declare namespace Perspective {
|
6273
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6274
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6275
|
-
}
|
6276
|
-
|
6277
5663
|
/**
|
6278
5664
|
* Represens a plane by the equation ax + by + cz + d = 0
|
6279
5665
|
* @public
|
@@ -6429,24 +5815,6 @@ export declare interface PointerEventsSystem {
|
|
6429
5815
|
* @param entity - Entity where the callback was attached
|
6430
5816
|
*/
|
6431
5817
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6432
|
-
/**
|
6433
|
-
* @public
|
6434
|
-
* Remove the callback for onPointerDrag event
|
6435
|
-
* @param entity - Entity where the callback was attached
|
6436
|
-
*/
|
6437
|
-
removeOnPointerDrag(entity: Entity): void;
|
6438
|
-
/**
|
6439
|
-
* @public
|
6440
|
-
* Remove the callback for onPointerDragLocked event
|
6441
|
-
* @param entity - Entity where the callback was attached
|
6442
|
-
*/
|
6443
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
6444
|
-
/**
|
6445
|
-
* @public
|
6446
|
-
* Remove the callback for onPointerDragEnd event
|
6447
|
-
* @param entity - Entity where the callback was attached
|
6448
|
-
*/
|
6449
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
6450
5818
|
/**
|
6451
5819
|
* @public
|
6452
5820
|
* Execute callback when the user press the InputButton pointing at the entity
|
@@ -6501,37 +5869,6 @@ export declare interface PointerEventsSystem {
|
|
6501
5869
|
entity: Entity;
|
6502
5870
|
opts?: Partial<EventSystemOptions>;
|
6503
5871
|
}, cb: EventSystemCallback): void;
|
6504
|
-
/**
|
6505
|
-
* @public
|
6506
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6507
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6508
|
-
* @param cb - Function to execute when click fires
|
6509
|
-
*/
|
6510
|
-
onPointerDrag(pointerData: {
|
6511
|
-
entity: Entity;
|
6512
|
-
opts?: Partial<EventSystemOptions>;
|
6513
|
-
}, cb: EventSystemCallback): void;
|
6514
|
-
/**
|
6515
|
-
* @public
|
6516
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6517
|
-
* locking the cursor in place
|
6518
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6519
|
-
* @param cb - Function to execute when click fires
|
6520
|
-
*/
|
6521
|
-
onPointerDragLocked(pointerData: {
|
6522
|
-
entity: Entity;
|
6523
|
-
opts?: Partial<EventSystemOptions>;
|
6524
|
-
}, cb: EventSystemCallback): void;
|
6525
|
-
/**
|
6526
|
-
* @public
|
6527
|
-
* Execute callback when the user releases the button after a drag
|
6528
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6529
|
-
* @param cb - Function to execute when click fires
|
6530
|
-
*/
|
6531
|
-
onPointerDragEnd(pointerData: {
|
6532
|
-
entity: Entity;
|
6533
|
-
opts?: Partial<EventSystemOptions>;
|
6534
|
-
}, cb: EventSystemCallback): void;
|
6535
5872
|
}
|
6536
5873
|
|
6537
5874
|
/**
|
@@ -6548,10 +5885,7 @@ export declare const enum PointerEventType {
|
|
6548
5885
|
PET_UP = 0,
|
6549
5886
|
PET_DOWN = 1,
|
6550
5887
|
PET_HOVER_ENTER = 2,
|
6551
|
-
PET_HOVER_LEAVE = 3
|
6552
|
-
PET_DRAG_LOCKED = 4,
|
6553
|
-
PET_DRAG = 5,
|
6554
|
-
PET_DRAG_END = 6
|
5888
|
+
PET_HOVER_LEAVE = 3
|
6555
5889
|
}
|
6556
5890
|
|
6557
5891
|
/**
|
@@ -6571,17 +5905,6 @@ export declare type PointerFilterType = 'none' | 'block';
|
|
6571
5905
|
/** @public */
|
6572
5906
|
export declare const PointerLock: LastWriteWinElementSetComponentDefinition<PBPointerLock>;
|
6573
5907
|
|
6574
|
-
/**
|
6575
|
-
* @public
|
6576
|
-
*/
|
6577
|
-
export declare const enum PointerType {
|
6578
|
-
POT_NONE = 0,
|
6579
|
-
POT_MOUSE = 1,
|
6580
|
-
POT_PAD = 2,
|
6581
|
-
POT_TOUCH = 3,
|
6582
|
-
POT_WAND = 4
|
6583
|
-
}
|
6584
|
-
|
6585
5908
|
/**
|
6586
5909
|
* Type used for defining the position of the element. i.e. margin, padding
|
6587
5910
|
* @public
|
@@ -6619,9 +5942,6 @@ export declare type PositionType = 'absolute' | 'relative';
|
|
6619
5942
|
*/
|
6620
5943
|
export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
|
6621
5944
|
|
6622
|
-
/** @public */
|
6623
|
-
export declare const PrimaryPointerInfo: LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>;
|
6624
|
-
|
6625
5945
|
export declare enum ProcessMessageResultType {
|
6626
5946
|
/**
|
6627
5947
|
* Typical message and new state set.
|
@@ -7176,7 +6496,6 @@ export declare type RaycastSystemOptions = {
|
|
7176
6496
|
export declare interface ReactBasedUiSystem {
|
7177
6497
|
destroy(): void;
|
7178
6498
|
setUiRenderer(ui: UiComponent): void;
|
7179
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
7180
6499
|
}
|
7181
6500
|
|
7182
6501
|
/**
|
@@ -7630,43 +6949,6 @@ export declare namespace Schemas {
|
|
7630
6949
|
}) => void;
|
7631
6950
|
}
|
7632
6951
|
|
7633
|
-
/**
|
7634
|
-
* @public
|
7635
|
-
*/
|
7636
|
-
export declare interface ScrollPositionValue {
|
7637
|
-
value?: {
|
7638
|
-
$case: "position";
|
7639
|
-
position: PBVector2;
|
7640
|
-
} | {
|
7641
|
-
$case: "reference";
|
7642
|
-
reference: string;
|
7643
|
-
} | undefined;
|
7644
|
-
}
|
7645
|
-
|
7646
|
-
/**
|
7647
|
-
* @public
|
7648
|
-
*/
|
7649
|
-
export declare namespace ScrollPositionValue {
|
7650
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7651
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7652
|
-
}
|
7653
|
-
|
7654
|
-
/**
|
7655
|
-
* @public
|
7656
|
-
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7657
|
-
*/
|
7658
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7659
|
-
|
7660
|
-
/**
|
7661
|
-
* @public
|
7662
|
-
*/
|
7663
|
-
export declare const enum ShowScrollBar {
|
7664
|
-
SSB_BOTH = 0,
|
7665
|
-
SSB_ONLY_VERTICAL = 1,
|
7666
|
-
SSB_ONLY_HORIZONTAL = 2,
|
7667
|
-
SSB_HIDDEN = 3
|
7668
|
-
}
|
7669
|
-
|
7670
6952
|
/**
|
7671
6953
|
* @public
|
7672
6954
|
*/
|
@@ -7674,9 +6956,6 @@ export declare interface Spec {
|
|
7674
6956
|
[key: string]: ISchema;
|
7675
6957
|
}
|
7676
6958
|
|
7677
|
-
/** @public */
|
7678
|
-
export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
|
7679
|
-
|
7680
6959
|
/**
|
7681
6960
|
* @alpha
|
7682
6961
|
* This is going to be used for sync components through a server.
|
@@ -7751,9 +7030,6 @@ export declare namespace Texture {
|
|
7751
7030
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7752
7031
|
}
|
7753
7032
|
|
7754
|
-
/** @public */
|
7755
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7756
|
-
|
7757
7033
|
/**
|
7758
7034
|
* @public
|
7759
7035
|
*/
|
@@ -7846,9 +7122,6 @@ export declare interface TextureUnion {
|
|
7846
7122
|
} | {
|
7847
7123
|
$case: "videoTexture";
|
7848
7124
|
videoTexture: VideoTexture;
|
7849
|
-
} | {
|
7850
|
-
$case: "uiTexture";
|
7851
|
-
uiTexture: UiCanvasTexture;
|
7852
7125
|
} | undefined;
|
7853
7126
|
}
|
7854
7127
|
|
@@ -8056,8 +7329,6 @@ export declare interface UiBackgroundProps {
|
|
8056
7329
|
uvs?: number[];
|
8057
7330
|
/** AvatarTexture for the background */
|
8058
7331
|
avatarTexture?: UiAvatarTexture;
|
8059
|
-
/** VideoTexture for the background */
|
8060
|
-
videoTexture?: UiVideoTexture;
|
8061
7332
|
/** Texture for the background */
|
8062
7333
|
texture?: UiTexture;
|
8063
7334
|
}
|
@@ -8077,31 +7348,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
8077
7348
|
disabled?: boolean;
|
8078
7349
|
}
|
8079
7350
|
|
8080
|
-
/** @public */
|
8081
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8082
|
-
|
8083
7351
|
/** @public */
|
8084
7352
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
8085
7353
|
|
8086
|
-
/**
|
8087
|
-
* @public
|
8088
|
-
*/
|
8089
|
-
export declare interface UiCanvasTexture {
|
8090
|
-
uiCanvasEntity: number;
|
8091
|
-
/** default = TextureWrapMode.Clamp */
|
8092
|
-
wrapMode?: TextureWrapMode | undefined;
|
8093
|
-
/** default = FilterMode.Bilinear */
|
8094
|
-
filterMode?: TextureFilterMode | undefined;
|
8095
|
-
}
|
8096
|
-
|
8097
|
-
/**
|
8098
|
-
* @public
|
8099
|
-
*/
|
8100
|
-
export declare namespace UiCanvasTexture {
|
8101
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8102
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8103
|
-
}
|
8104
|
-
|
8105
7354
|
/**
|
8106
7355
|
* @public
|
8107
7356
|
*/
|
@@ -8171,10 +7420,6 @@ export declare interface UiLabelProps {
|
|
8171
7420
|
textAlign?: TextAlignType | undefined;
|
8172
7421
|
/** Label font type. @defaultValue 'sans-serif' */
|
8173
7422
|
font?: UiFontType | undefined;
|
8174
|
-
/** Outline width of the text. @defaultValue 0 */
|
8175
|
-
outlineWidth?: number | undefined;
|
8176
|
-
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8177
|
-
outlineColor?: PBColor4 | undefined;
|
8178
7423
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
8179
7424
|
textWrap?: UiTextWrapType | undefined;
|
8180
7425
|
}
|
@@ -8184,9 +7429,6 @@ export declare interface UiLabelProps {
|
|
8184
7429
|
*/
|
8185
7430
|
export declare type uint32 = number;
|
8186
7431
|
|
8187
|
-
/** @public */
|
8188
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8189
|
-
|
8190
7432
|
/** @public */
|
8191
7433
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
8192
7434
|
|
@@ -8259,26 +7501,6 @@ export declare interface UiTransformProps {
|
|
8259
7501
|
overflow?: OverflowType;
|
8260
7502
|
/** The pointer filter property determines if the ui element blocks the pointer or not (elements with pointer events always block the pointer regardless of this property) **/
|
8261
7503
|
pointerFilter?: PointerFilterType;
|
8262
|
-
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
8263
|
-
opacity?: number;
|
8264
|
-
/** A reference value to identify the element, default empty */
|
8265
|
-
elementId?: string;
|
8266
|
-
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8267
|
-
scrollPosition?: PBVector2 | string;
|
8268
|
-
/** default ShowScrollBar.SSB_BOTH */
|
8269
|
-
scrollVisible?: ScrollVisibleType;
|
8270
|
-
/** default 0 */
|
8271
|
-
zIndex?: number;
|
8272
|
-
}
|
8273
|
-
|
8274
|
-
/**
|
8275
|
-
* Texture
|
8276
|
-
* @public
|
8277
|
-
*/
|
8278
|
-
export declare interface UiVideoTexture {
|
8279
|
-
videoPlayerEntity: Entity;
|
8280
|
-
wrapMode?: TextureWrapType;
|
8281
|
-
filterMode?: TextureFilterType;
|
8282
7504
|
}
|
8283
7505
|
|
8284
7506
|
/**
|