@dcl/playground-assets 7.7.3-13093143335.commit-dc52da3 → 7.7.3-13143833757.commit-551d432
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/beta.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
|
*/
|
@@ -2756,9 +2642,6 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
2756
2642
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
2757
2643
|
}
|
2758
2644
|
|
2759
|
-
/** @public */
|
2760
|
-
export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
|
2761
|
-
|
2762
2645
|
/**
|
2763
2646
|
* User key event Listeners
|
2764
2647
|
* @public
|
@@ -2772,12 +2655,6 @@ export declare type Listeners = {
|
|
2772
2655
|
onMouseEnter?: Callback;
|
2773
2656
|
/** triggered on mouse leave event */
|
2774
2657
|
onMouseLeave?: Callback;
|
2775
|
-
/** triggered on mouse drag event */
|
2776
|
-
onMouseDrag?: Callback;
|
2777
|
-
/** triggered on mouse drag event */
|
2778
|
-
onMouseDragLocked?: Callback;
|
2779
|
-
/** triggered on mouse drag event */
|
2780
|
-
onMouseDragEnd?: Callback;
|
2781
2658
|
};
|
2782
2659
|
|
2783
2660
|
/**
|
@@ -3646,14 +3523,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3646
3523
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3647
3524
|
*/
|
3648
3525
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3649
|
-
/**
|
3650
|
-
* @public
|
3651
|
-
* Set a gltf internal mesh in the MeshCollider component
|
3652
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3653
|
-
* @param source - the path to the gltf
|
3654
|
-
* @param meshName - the name of the mesh in the gltf
|
3655
|
-
*/
|
3656
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3657
3526
|
}
|
3658
3527
|
|
3659
3528
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3690,14 +3559,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3690
3559
|
* @param entity - entity to create or replace the MeshRenderer component
|
3691
3560
|
*/
|
3692
3561
|
setSphere(entity: Entity): void;
|
3693
|
-
/**
|
3694
|
-
* @public
|
3695
|
-
* Set a gltf internal mesh in the MeshRenderer component
|
3696
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3697
|
-
* @param source - the path to the gltf
|
3698
|
-
* @param meshName - the name of the mesh in the gltf
|
3699
|
-
*/
|
3700
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3701
3562
|
}
|
3702
3563
|
|
3703
3564
|
/* Excluded from this release type: MessageBus */
|
@@ -4091,25 +3952,6 @@ export declare const onVideoEvent: Observable<{
|
|
4091
3952
|
totalVideoLength: number;
|
4092
3953
|
}>;
|
4093
3954
|
|
4094
|
-
/**
|
4095
|
-
* @public
|
4096
|
-
*/
|
4097
|
-
export declare interface Orthographic {
|
4098
|
-
/**
|
4099
|
-
* vertical extent of the visible range in meters
|
4100
|
-
* defaults to 4m
|
4101
|
-
*/
|
4102
|
-
verticalRange?: number | undefined;
|
4103
|
-
}
|
4104
|
-
|
4105
|
-
/**
|
4106
|
-
* @public
|
4107
|
-
*/
|
4108
|
-
export declare namespace Orthographic {
|
4109
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4110
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4111
|
-
}
|
4112
|
-
|
4113
3955
|
/**
|
4114
3956
|
* @public
|
4115
3957
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4370,9 +4212,6 @@ export declare interface PBAvatarModifierArea {
|
|
4370
4212
|
excludeIds: string[];
|
4371
4213
|
/** list of modifiers to apply */
|
4372
4214
|
modifiers: AvatarModifierType[];
|
4373
|
-
movementSettings?: AvatarMovementSettings | undefined;
|
4374
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4375
|
-
useColliderRange?: boolean | undefined;
|
4376
4215
|
}
|
4377
4216
|
|
4378
4217
|
/**
|
@@ -4463,51 +4302,6 @@ export declare namespace PBBillboard {
|
|
4463
4302
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4464
4303
|
}
|
4465
4304
|
|
4466
|
-
/**
|
4467
|
-
* @public
|
4468
|
-
*/
|
4469
|
-
export declare interface PBCameraLayer {
|
4470
|
-
/**
|
4471
|
-
* layer to which these settings apply. must be > 0
|
4472
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4473
|
-
*/
|
4474
|
-
layer: number;
|
4475
|
-
/** should the sun light affect this layer? default false */
|
4476
|
-
directionalLight?: boolean | undefined;
|
4477
|
-
/** should this layer show player avatars? default false */
|
4478
|
-
showAvatars?: boolean | undefined;
|
4479
|
-
/** should this layer show the sky? default false */
|
4480
|
-
showSkybox?: boolean | undefined;
|
4481
|
-
/** should this layer show distance fog? default false */
|
4482
|
-
showFog?: boolean | undefined;
|
4483
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
4484
|
-
ambientColorOverride?: PBColor3 | undefined;
|
4485
|
-
ambientBrightnessOverride?: number | undefined;
|
4486
|
-
}
|
4487
|
-
|
4488
|
-
/**
|
4489
|
-
* @public
|
4490
|
-
*/
|
4491
|
-
export declare namespace PBCameraLayer {
|
4492
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4493
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4494
|
-
}
|
4495
|
-
|
4496
|
-
/**
|
4497
|
-
* @public
|
4498
|
-
*/
|
4499
|
-
export declare interface PBCameraLayers {
|
4500
|
-
layers: number[];
|
4501
|
-
}
|
4502
|
-
|
4503
|
-
/**
|
4504
|
-
* @public
|
4505
|
-
*/
|
4506
|
-
export declare namespace PBCameraLayers {
|
4507
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4508
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4509
|
-
}
|
4510
|
-
|
4511
4305
|
/**
|
4512
4306
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4513
4307
|
* third-person view.
|
@@ -4530,7 +4324,7 @@ export declare namespace PBCameraMode {
|
|
4530
4324
|
|
4531
4325
|
/**
|
4532
4326
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4533
|
-
* the player's camera mode (1st-person
|
4327
|
+
* the player's camera mode (1st-person or 3rd-person) is overridden.
|
4534
4328
|
*
|
4535
4329
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4536
4330
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4540,8 +4334,6 @@ export declare namespace PBCameraMode {
|
|
4540
4334
|
*
|
4541
4335
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4542
4336
|
* is actually a 3D volume.
|
4543
|
-
*
|
4544
|
-
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4545
4337
|
*/
|
4546
4338
|
/**
|
4547
4339
|
* @public
|
@@ -4551,9 +4343,6 @@ export declare interface PBCameraModeArea {
|
|
4551
4343
|
area: PBVector3 | undefined;
|
4552
4344
|
/** the camera mode to enforce */
|
4553
4345
|
mode: CameraType;
|
4554
|
-
cinematicSettings?: CinematicSettings | undefined;
|
4555
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4556
|
-
useColliderRange?: boolean | undefined;
|
4557
4346
|
}
|
4558
4347
|
|
4559
4348
|
/**
|
@@ -4625,39 +4414,6 @@ export declare namespace PBEngineInfo {
|
|
4625
4414
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4626
4415
|
}
|
4627
4416
|
|
4628
|
-
/**
|
4629
|
-
* defines the global scene light settings. must be added to the scene root.
|
4630
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4631
|
-
*/
|
4632
|
-
/**
|
4633
|
-
* @public
|
4634
|
-
*/
|
4635
|
-
export declare interface PBGlobalLight {
|
4636
|
-
/**
|
4637
|
-
* the direction the directional light shines in.
|
4638
|
-
* default depends on time of day and explorer implementation
|
4639
|
-
*/
|
4640
|
-
direction?: PBVector3 | undefined;
|
4641
|
-
/**
|
4642
|
-
* ambient light color
|
4643
|
-
* default: White
|
4644
|
-
*/
|
4645
|
-
ambientColor?: PBColor3 | undefined;
|
4646
|
-
/**
|
4647
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4648
|
-
* default 1
|
4649
|
-
*/
|
4650
|
-
ambientBrightness?: number | undefined;
|
4651
|
-
}
|
4652
|
-
|
4653
|
-
/**
|
4654
|
-
* @public
|
4655
|
-
*/
|
4656
|
-
export declare namespace PBGlobalLight {
|
4657
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4658
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4659
|
-
}
|
4660
|
-
|
4661
4417
|
/**
|
4662
4418
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4663
4419
|
*
|
@@ -4693,25 +4449,6 @@ export declare namespace PBGltfContainer {
|
|
4693
4449
|
*/
|
4694
4450
|
export declare interface PBGltfContainerLoadingState {
|
4695
4451
|
currentState: LoadingState;
|
4696
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4697
|
-
nodePaths: string[];
|
4698
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4699
|
-
meshNames: string[];
|
4700
|
-
/**
|
4701
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4702
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4703
|
-
*/
|
4704
|
-
materialNames: string[];
|
4705
|
-
/**
|
4706
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4707
|
-
* sure all your materials are explicitly named.
|
4708
|
-
*/
|
4709
|
-
skinNames: string[];
|
4710
|
-
/**
|
4711
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4712
|
-
* your skins are explicitly named.
|
4713
|
-
*/
|
4714
|
-
animationNames: string[];
|
4715
4452
|
}
|
4716
4453
|
|
4717
4454
|
/**
|
@@ -4722,77 +4459,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4722
4459
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4723
4460
|
}
|
4724
4461
|
|
4725
|
-
/**
|
4726
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4727
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4728
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4729
|
-
* in the parent.
|
4730
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4731
|
-
*
|
4732
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4733
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4734
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4735
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4736
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4737
|
-
*
|
4738
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4739
|
-
*
|
4740
|
-
* From the scene, you can modify various components to alter the gltf node:
|
4741
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4742
|
-
* regardless of any intermediate gltf node hierarchy.
|
4743
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4744
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4745
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4746
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4747
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4748
|
-
* 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
|
4749
|
-
* PBMaterial will be maintained.
|
4750
|
-
*
|
4751
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4752
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4753
|
-
* change the state to `GNS_FAILED`.
|
4754
|
-
* - deleting the scene entity will not delete the gltf node.
|
4755
|
-
*
|
4756
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4757
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4758
|
-
* the gltf node will also be displayed.
|
4759
|
-
*/
|
4760
|
-
/**
|
4761
|
-
* @public
|
4762
|
-
*/
|
4763
|
-
export declare interface PBGltfNode {
|
4764
|
-
/** the path of the target node in the Gltf. */
|
4765
|
-
path: string;
|
4766
|
-
}
|
4767
|
-
|
4768
|
-
/**
|
4769
|
-
* @public
|
4770
|
-
*/
|
4771
|
-
export declare namespace PBGltfNode {
|
4772
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4773
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4774
|
-
}
|
4775
|
-
|
4776
|
-
/**
|
4777
|
-
* The state of a linked gltf node.
|
4778
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4779
|
-
*/
|
4780
|
-
/**
|
4781
|
-
* @public
|
4782
|
-
*/
|
4783
|
-
export declare interface PBGltfNodeState {
|
4784
|
-
state: GltfNodeStateValue;
|
4785
|
-
error?: string | undefined;
|
4786
|
-
}
|
4787
|
-
|
4788
|
-
/**
|
4789
|
-
* @public
|
4790
|
-
*/
|
4791
|
-
export declare namespace PBGltfNodeState {
|
4792
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4793
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4794
|
-
}
|
4795
|
-
|
4796
4462
|
/**
|
4797
4463
|
* @public
|
4798
4464
|
*/
|
@@ -4832,62 +4498,6 @@ export declare namespace PBInputModifier_StandardInput {
|
|
4832
4498
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4833
4499
|
}
|
4834
4500
|
|
4835
|
-
/**
|
4836
|
-
* defines a light source.
|
4837
|
-
* the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
|
4838
|
-
* a PBGlobalLight component can also be added to the root to control the directional light direction.
|
4839
|
-
* point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
|
4840
|
-
*/
|
4841
|
-
/**
|
4842
|
-
* @public
|
4843
|
-
*/
|
4844
|
-
export declare interface PBLight {
|
4845
|
-
/**
|
4846
|
-
* whether the light is on
|
4847
|
-
* default true
|
4848
|
-
*/
|
4849
|
-
enabled?: boolean | undefined;
|
4850
|
-
/**
|
4851
|
-
* light brightness in lux (lumens/m^2).
|
4852
|
-
*
|
4853
|
-
* 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).
|
4854
|
-
* the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
|
4855
|
-
* for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
|
4856
|
-
*
|
4857
|
-
* for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
|
4858
|
-
* divide lumens by ~12 (4*pi).
|
4859
|
-
* e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
|
4860
|
-
* a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
|
4861
|
-
*
|
4862
|
-
* default
|
4863
|
-
* for point/spotlights: 10,000
|
4864
|
-
* for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
|
4865
|
-
*/
|
4866
|
-
illuminance?: number | undefined;
|
4867
|
-
/**
|
4868
|
-
* whether the light should cast shadows.
|
4869
|
-
* note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
|
4870
|
-
* of lights depending on the implementation, platform, and user settings.
|
4871
|
-
* default
|
4872
|
-
* for point/spotlights: false / off
|
4873
|
-
* for global directional light: true / on
|
4874
|
-
*/
|
4875
|
-
shadows?: boolean | undefined;
|
4876
|
-
/**
|
4877
|
-
* light color
|
4878
|
-
* default White
|
4879
|
-
*/
|
4880
|
-
color?: PBColor3 | undefined;
|
4881
|
-
}
|
4882
|
-
|
4883
|
-
/**
|
4884
|
-
* @public
|
4885
|
-
*/
|
4886
|
-
export declare namespace PBLight {
|
4887
|
-
export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
|
4888
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
|
4889
|
-
}
|
4890
|
-
|
4891
4501
|
/**
|
4892
4502
|
* PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
|
4893
4503
|
* This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
|
@@ -4919,14 +4529,6 @@ export declare interface PBMaterial {
|
|
4919
4529
|
$case: "pbr";
|
4920
4530
|
pbr: PBMaterial_PbrMaterial;
|
4921
4531
|
} | undefined;
|
4922
|
-
/**
|
4923
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
4924
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
4925
|
-
* supported by the PbMaterial.
|
4926
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
4927
|
-
* field with data that reflects the gltf material once it is loaded.
|
4928
|
-
*/
|
4929
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
4930
4532
|
}
|
4931
4533
|
|
4932
4534
|
/**
|
@@ -4937,22 +4539,6 @@ export declare namespace PBMaterial {
|
|
4937
4539
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4938
4540
|
}
|
4939
4541
|
|
4940
|
-
/**
|
4941
|
-
* @public
|
4942
|
-
*/
|
4943
|
-
export declare interface PBMaterial_GltfMaterial {
|
4944
|
-
gltfSrc: string;
|
4945
|
-
name: string;
|
4946
|
-
}
|
4947
|
-
|
4948
|
-
/**
|
4949
|
-
* @public
|
4950
|
-
*/
|
4951
|
-
export declare namespace PBMaterial_GltfMaterial {
|
4952
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
4953
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
4954
|
-
}
|
4955
|
-
|
4956
4542
|
/**
|
4957
4543
|
* @public
|
4958
4544
|
*/
|
@@ -5049,9 +4635,6 @@ export declare interface PBMeshCollider {
|
|
5049
4635
|
} | {
|
5050
4636
|
$case: "plane";
|
5051
4637
|
plane: PBMeshCollider_PlaneMesh;
|
5052
|
-
} | {
|
5053
|
-
$case: "gltf";
|
5054
|
-
gltf: PBMeshCollider_GltfMesh;
|
5055
4638
|
} | undefined;
|
5056
4639
|
}
|
5057
4640
|
|
@@ -5097,25 +4680,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
5097
4680
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
5098
4681
|
}
|
5099
4682
|
|
5100
|
-
/** A collider constructed from a Gltf Mesh. */
|
5101
|
-
/**
|
5102
|
-
* @public
|
5103
|
-
*/
|
5104
|
-
export declare interface PBMeshCollider_GltfMesh {
|
5105
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5106
|
-
gltfSrc: string;
|
5107
|
-
/** the name of the mesh asset */
|
5108
|
-
name: string;
|
5109
|
-
}
|
5110
|
-
|
5111
|
-
/**
|
5112
|
-
* @public
|
5113
|
-
*/
|
5114
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
5115
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5116
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5117
|
-
}
|
5118
|
-
|
5119
4683
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
5120
4684
|
/**
|
5121
4685
|
* @public
|
@@ -5148,11 +4712,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
5148
4712
|
|
5149
4713
|
/**
|
5150
4714
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
5151
|
-
* plane, a sphere
|
4715
|
+
* plane, a sphere or a cylinder.
|
5152
4716
|
*
|
5153
4717
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
5154
4718
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
5155
4719
|
* `float` coordinates, one for each corner of each side of each face.
|
4720
|
+
*
|
4721
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
5156
4722
|
*/
|
5157
4723
|
/**
|
5158
4724
|
* @public
|
@@ -5170,9 +4736,6 @@ export declare interface PBMeshRenderer {
|
|
5170
4736
|
} | {
|
5171
4737
|
$case: "plane";
|
5172
4738
|
plane: PBMeshRenderer_PlaneMesh;
|
5173
|
-
} | {
|
5174
|
-
$case: "gltf";
|
5175
|
-
gltf: PBMeshRenderer_GltfMesh;
|
5176
4739
|
} | undefined;
|
5177
4740
|
}
|
5178
4741
|
|
@@ -5220,25 +4783,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
5220
4783
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
5221
4784
|
}
|
5222
4785
|
|
5223
|
-
/** A mesh from a Gltf. */
|
5224
|
-
/**
|
5225
|
-
* @public
|
5226
|
-
*/
|
5227
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
5228
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5229
|
-
gltfSrc: string;
|
5230
|
-
/** the name of the mesh asset */
|
5231
|
-
name: string;
|
5232
|
-
}
|
5233
|
-
|
5234
|
-
/**
|
5235
|
-
* @public
|
5236
|
-
*/
|
5237
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
5238
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5239
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5240
|
-
}
|
5241
|
-
|
5242
4786
|
/** PlaneMesh renders a 2D rectangular shape. */
|
5243
4787
|
/**
|
5244
4788
|
* @public
|
@@ -5457,30 +5001,6 @@ export declare namespace PBPosition {
|
|
5457
5001
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
|
5458
5002
|
}
|
5459
5003
|
|
5460
|
-
/**
|
5461
|
-
* @public
|
5462
|
-
*/
|
5463
|
-
export declare interface PBPrimaryPointerInfo {
|
5464
|
-
pointerType?: PointerType | undefined;
|
5465
|
-
/** in pixels */
|
5466
|
-
screenCoordinates?: PBVector2 | undefined;
|
5467
|
-
/** in pixels */
|
5468
|
-
screenDelta?: PBVector2 | undefined;
|
5469
|
-
/**
|
5470
|
-
* ray direction that can be used with the primary camera origin for
|
5471
|
-
* raycasting from the cursor into the world
|
5472
|
-
*/
|
5473
|
-
worldRayDirection?: PBVector3 | undefined;
|
5474
|
-
}
|
5475
|
-
|
5476
|
-
/**
|
5477
|
-
* @public
|
5478
|
-
*/
|
5479
|
-
export declare namespace PBPrimaryPointerInfo {
|
5480
|
-
export function encode(message: PBPrimaryPointerInfo, writer?: _m0.Writer): _m0.Writer;
|
5481
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPrimaryPointerInfo;
|
5482
|
-
}
|
5483
|
-
|
5484
5004
|
/**
|
5485
5005
|
* @public
|
5486
5006
|
*/
|
@@ -5602,39 +5122,6 @@ export declare namespace PBRealmInfo {
|
|
5602
5122
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5603
5123
|
}
|
5604
5124
|
|
5605
|
-
/**
|
5606
|
-
* defines a spotlight.
|
5607
|
-
* spotlights are point lights that emit light only in a cone around the transform's forward direction.
|
5608
|
-
* add this component together with the PBLight component to transform a point light into a spotlight.
|
5609
|
-
* note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
|
5610
|
-
* so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
|
5611
|
-
* a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
|
5612
|
-
* and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
|
5613
|
-
*/
|
5614
|
-
/**
|
5615
|
-
* @public
|
5616
|
-
*/
|
5617
|
-
export declare interface PBSpotlight {
|
5618
|
-
/**
|
5619
|
-
* the cone radius in radians. distance away from forward in which the light is visible.
|
5620
|
-
* for a torch a value around 0.15 is appropriate.
|
5621
|
-
*/
|
5622
|
-
angle: number;
|
5623
|
-
/**
|
5624
|
-
* optional angle at which the light is brightest. should be <= outer angle.
|
5625
|
-
* if specified, the light will fall off smoothly between `inner_angle` and `angle`.
|
5626
|
-
*/
|
5627
|
-
innerAngle?: number | undefined;
|
5628
|
-
}
|
5629
|
-
|
5630
|
-
/**
|
5631
|
-
* @public
|
5632
|
-
*/
|
5633
|
-
export declare namespace PBSpotlight {
|
5634
|
-
export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
|
5635
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
|
5636
|
-
}
|
5637
|
-
|
5638
5125
|
/**
|
5639
5126
|
* The TextShape component renders customizable floating text.
|
5640
5127
|
*
|
@@ -5699,40 +5186,6 @@ export declare namespace PBTextShape {
|
|
5699
5186
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5700
5187
|
}
|
5701
5188
|
|
5702
|
-
/**
|
5703
|
-
* @public
|
5704
|
-
*/
|
5705
|
-
export declare interface PBTextureCamera {
|
5706
|
-
/** rendered texture width */
|
5707
|
-
width?: number | undefined;
|
5708
|
-
/** rendered texture height */
|
5709
|
-
height?: number | undefined;
|
5710
|
-
/**
|
5711
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5712
|
-
* defaults to 0
|
5713
|
-
*/
|
5714
|
-
layer?: number | undefined;
|
5715
|
-
/** default black */
|
5716
|
-
clearColor?: PBColor4 | undefined;
|
5717
|
-
/** default infinity */
|
5718
|
-
farPlane?: number | undefined;
|
5719
|
-
mode?: {
|
5720
|
-
$case: "perspective";
|
5721
|
-
perspective: Perspective;
|
5722
|
-
} | {
|
5723
|
-
$case: "orthographic";
|
5724
|
-
orthographic: Orthographic;
|
5725
|
-
} | undefined;
|
5726
|
-
}
|
5727
|
-
|
5728
|
-
/**
|
5729
|
-
* @public
|
5730
|
-
*/
|
5731
|
-
export declare namespace PBTextureCamera {
|
5732
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5733
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5734
|
-
}
|
5735
|
-
|
5736
5189
|
/**
|
5737
5190
|
* @public
|
5738
5191
|
*/
|
@@ -5822,25 +5275,6 @@ export declare namespace PBUiBackground {
|
|
5822
5275
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5823
5276
|
}
|
5824
5277
|
|
5825
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5826
|
-
/**
|
5827
|
-
* @public
|
5828
|
-
*/
|
5829
|
-
export declare interface PBUiCanvas {
|
5830
|
-
width: number;
|
5831
|
-
height: number;
|
5832
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5833
|
-
color?: PBColor4 | undefined;
|
5834
|
-
}
|
5835
|
-
|
5836
|
-
/**
|
5837
|
-
* @public
|
5838
|
-
*/
|
5839
|
-
export declare namespace PBUiCanvas {
|
5840
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5841
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5842
|
-
}
|
5843
|
-
|
5844
5278
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5845
5279
|
/**
|
5846
5280
|
* @public
|
@@ -5957,21 +5391,6 @@ export declare namespace PBUiInputResult {
|
|
5957
5391
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5958
5392
|
}
|
5959
5393
|
|
5960
|
-
/**
|
5961
|
-
* @public
|
5962
|
-
*/
|
5963
|
-
export declare interface PBUiScrollResult {
|
5964
|
-
value: PBVector2 | undefined;
|
5965
|
-
}
|
5966
|
-
|
5967
|
-
/**
|
5968
|
-
* @public
|
5969
|
-
*/
|
5970
|
-
export declare namespace PBUiScrollResult {
|
5971
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
5972
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
5973
|
-
}
|
5974
|
-
|
5975
5394
|
/**
|
5976
5395
|
* @public
|
5977
5396
|
*/
|
@@ -5988,10 +5407,6 @@ export declare interface PBUiText {
|
|
5988
5407
|
fontSize?: number | undefined;
|
5989
5408
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
5990
5409
|
textWrap?: TextWrap | undefined;
|
5991
|
-
/** width of the outline (default: 0) */
|
5992
|
-
outlineWidth?: number | undefined;
|
5993
|
-
/** RGBA color of the outline (default: opaque black) */
|
5994
|
-
outlineColor?: PBColor4 | undefined;
|
5995
5410
|
}
|
5996
5411
|
|
5997
5412
|
/**
|
@@ -6088,16 +5503,6 @@ export declare interface PBUiTransform {
|
|
6088
5503
|
paddingBottom: number;
|
6089
5504
|
/** default: PointerFilterMode.PFM_NONE */
|
6090
5505
|
pointerFilter?: PointerFilterMode | undefined;
|
6091
|
-
/** default: 1 */
|
6092
|
-
opacity?: number | undefined;
|
6093
|
-
/** default empty */
|
6094
|
-
elementId?: string | undefined;
|
6095
|
-
/** default position=(0,0) */
|
6096
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
6097
|
-
/** default ShowScrollBar.SSB_BOTH */
|
6098
|
-
scrollVisible?: ShowScrollBar | undefined;
|
6099
|
-
/** default 0 */
|
6100
|
-
zIndex?: number | undefined;
|
6101
5506
|
}
|
6102
5507
|
|
6103
5508
|
/**
|
@@ -6227,25 +5632,6 @@ export declare namespace PBVisibilityComponent {
|
|
6227
5632
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
6228
5633
|
}
|
6229
5634
|
|
6230
|
-
/**
|
6231
|
-
* @public
|
6232
|
-
*/
|
6233
|
-
export declare interface Perspective {
|
6234
|
-
/**
|
6235
|
-
* vertical field of view in radians
|
6236
|
-
* defaults to pi/4 = 45 degrees
|
6237
|
-
*/
|
6238
|
-
fieldOfView?: number | undefined;
|
6239
|
-
}
|
6240
|
-
|
6241
|
-
/**
|
6242
|
-
* @public
|
6243
|
-
*/
|
6244
|
-
export declare namespace Perspective {
|
6245
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6246
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6247
|
-
}
|
6248
|
-
|
6249
5635
|
/**
|
6250
5636
|
* Represens a plane by the equation ax + by + cz + d = 0
|
6251
5637
|
* @public
|
@@ -6401,24 +5787,6 @@ export declare interface PointerEventsSystem {
|
|
6401
5787
|
* @param entity - Entity where the callback was attached
|
6402
5788
|
*/
|
6403
5789
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6404
|
-
/**
|
6405
|
-
* @public
|
6406
|
-
* Remove the callback for onPointerDrag event
|
6407
|
-
* @param entity - Entity where the callback was attached
|
6408
|
-
*/
|
6409
|
-
removeOnPointerDrag(entity: Entity): void;
|
6410
|
-
/**
|
6411
|
-
* @public
|
6412
|
-
* Remove the callback for onPointerDragLocked event
|
6413
|
-
* @param entity - Entity where the callback was attached
|
6414
|
-
*/
|
6415
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
6416
|
-
/**
|
6417
|
-
* @public
|
6418
|
-
* Remove the callback for onPointerDragEnd event
|
6419
|
-
* @param entity - Entity where the callback was attached
|
6420
|
-
*/
|
6421
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
6422
5790
|
/**
|
6423
5791
|
* @public
|
6424
5792
|
* Execute callback when the user press the InputButton pointing at the entity
|
@@ -6473,37 +5841,6 @@ export declare interface PointerEventsSystem {
|
|
6473
5841
|
entity: Entity;
|
6474
5842
|
opts?: Partial<EventSystemOptions>;
|
6475
5843
|
}, cb: EventSystemCallback): void;
|
6476
|
-
/**
|
6477
|
-
* @public
|
6478
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6479
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6480
|
-
* @param cb - Function to execute when click fires
|
6481
|
-
*/
|
6482
|
-
onPointerDrag(pointerData: {
|
6483
|
-
entity: Entity;
|
6484
|
-
opts?: Partial<EventSystemOptions>;
|
6485
|
-
}, cb: EventSystemCallback): void;
|
6486
|
-
/**
|
6487
|
-
* @public
|
6488
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6489
|
-
* locking the cursor in place
|
6490
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6491
|
-
* @param cb - Function to execute when click fires
|
6492
|
-
*/
|
6493
|
-
onPointerDragLocked(pointerData: {
|
6494
|
-
entity: Entity;
|
6495
|
-
opts?: Partial<EventSystemOptions>;
|
6496
|
-
}, cb: EventSystemCallback): void;
|
6497
|
-
/**
|
6498
|
-
* @public
|
6499
|
-
* Execute callback when the user releases the button after a drag
|
6500
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6501
|
-
* @param cb - Function to execute when click fires
|
6502
|
-
*/
|
6503
|
-
onPointerDragEnd(pointerData: {
|
6504
|
-
entity: Entity;
|
6505
|
-
opts?: Partial<EventSystemOptions>;
|
6506
|
-
}, cb: EventSystemCallback): void;
|
6507
5844
|
}
|
6508
5845
|
|
6509
5846
|
/**
|
@@ -6520,10 +5857,7 @@ export declare const enum PointerEventType {
|
|
6520
5857
|
PET_UP = 0,
|
6521
5858
|
PET_DOWN = 1,
|
6522
5859
|
PET_HOVER_ENTER = 2,
|
6523
|
-
PET_HOVER_LEAVE = 3
|
6524
|
-
PET_DRAG_LOCKED = 4,
|
6525
|
-
PET_DRAG = 5,
|
6526
|
-
PET_DRAG_END = 6
|
5860
|
+
PET_HOVER_LEAVE = 3
|
6527
5861
|
}
|
6528
5862
|
|
6529
5863
|
/**
|
@@ -6543,17 +5877,6 @@ export declare type PointerFilterType = 'none' | 'block';
|
|
6543
5877
|
/** @public */
|
6544
5878
|
export declare const PointerLock: LastWriteWinElementSetComponentDefinition<PBPointerLock>;
|
6545
5879
|
|
6546
|
-
/**
|
6547
|
-
* @public
|
6548
|
-
*/
|
6549
|
-
export declare const enum PointerType {
|
6550
|
-
POT_NONE = 0,
|
6551
|
-
POT_MOUSE = 1,
|
6552
|
-
POT_PAD = 2,
|
6553
|
-
POT_TOUCH = 3,
|
6554
|
-
POT_WAND = 4
|
6555
|
-
}
|
6556
|
-
|
6557
5880
|
/**
|
6558
5881
|
* Type used for defining the position of the element. i.e. margin, padding
|
6559
5882
|
* @public
|
@@ -6591,9 +5914,6 @@ export declare type PositionType = 'absolute' | 'relative';
|
|
6591
5914
|
*/
|
6592
5915
|
export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
|
6593
5916
|
|
6594
|
-
/** @public */
|
6595
|
-
export declare const PrimaryPointerInfo: LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>;
|
6596
|
-
|
6597
5917
|
export declare enum ProcessMessageResultType {
|
6598
5918
|
/**
|
6599
5919
|
* Typical message and new state set.
|
@@ -7148,7 +6468,6 @@ export declare type RaycastSystemOptions = {
|
|
7148
6468
|
export declare interface ReactBasedUiSystem {
|
7149
6469
|
destroy(): void;
|
7150
6470
|
setUiRenderer(ui: UiComponent): void;
|
7151
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
7152
6471
|
}
|
7153
6472
|
|
7154
6473
|
/**
|
@@ -7602,43 +6921,6 @@ export declare namespace Schemas {
|
|
7602
6921
|
}) => void;
|
7603
6922
|
}
|
7604
6923
|
|
7605
|
-
/**
|
7606
|
-
* @public
|
7607
|
-
*/
|
7608
|
-
export declare interface ScrollPositionValue {
|
7609
|
-
value?: {
|
7610
|
-
$case: "position";
|
7611
|
-
position: PBVector2;
|
7612
|
-
} | {
|
7613
|
-
$case: "reference";
|
7614
|
-
reference: string;
|
7615
|
-
} | undefined;
|
7616
|
-
}
|
7617
|
-
|
7618
|
-
/**
|
7619
|
-
* @public
|
7620
|
-
*/
|
7621
|
-
export declare namespace ScrollPositionValue {
|
7622
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7623
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7624
|
-
}
|
7625
|
-
|
7626
|
-
/**
|
7627
|
-
* @public
|
7628
|
-
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7629
|
-
*/
|
7630
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7631
|
-
|
7632
|
-
/**
|
7633
|
-
* @public
|
7634
|
-
*/
|
7635
|
-
export declare const enum ShowScrollBar {
|
7636
|
-
SSB_BOTH = 0,
|
7637
|
-
SSB_ONLY_VERTICAL = 1,
|
7638
|
-
SSB_ONLY_HORIZONTAL = 2,
|
7639
|
-
SSB_HIDDEN = 3
|
7640
|
-
}
|
7641
|
-
|
7642
6924
|
/**
|
7643
6925
|
* @public
|
7644
6926
|
*/
|
@@ -7646,9 +6928,6 @@ export declare interface Spec {
|
|
7646
6928
|
[key: string]: ISchema;
|
7647
6929
|
}
|
7648
6930
|
|
7649
|
-
/** @public */
|
7650
|
-
export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
|
7651
|
-
|
7652
6931
|
/* Excluded from this release type: SyncComponents */
|
7653
6932
|
|
7654
6933
|
/**
|
@@ -7718,9 +6997,6 @@ export declare namespace Texture {
|
|
7718
6997
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7719
6998
|
}
|
7720
6999
|
|
7721
|
-
/** @public */
|
7722
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7723
|
-
|
7724
7000
|
/**
|
7725
7001
|
* @public
|
7726
7002
|
*/
|
@@ -7813,9 +7089,6 @@ export declare interface TextureUnion {
|
|
7813
7089
|
} | {
|
7814
7090
|
$case: "videoTexture";
|
7815
7091
|
videoTexture: VideoTexture;
|
7816
|
-
} | {
|
7817
|
-
$case: "uiTexture";
|
7818
|
-
uiTexture: UiCanvasTexture;
|
7819
7092
|
} | undefined;
|
7820
7093
|
}
|
7821
7094
|
|
@@ -8023,8 +7296,6 @@ export declare interface UiBackgroundProps {
|
|
8023
7296
|
uvs?: number[];
|
8024
7297
|
/** AvatarTexture for the background */
|
8025
7298
|
avatarTexture?: UiAvatarTexture;
|
8026
|
-
/** VideoTexture for the background */
|
8027
|
-
videoTexture?: UiVideoTexture;
|
8028
7299
|
/** Texture for the background */
|
8029
7300
|
texture?: UiTexture;
|
8030
7301
|
}
|
@@ -8044,31 +7315,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
8044
7315
|
disabled?: boolean;
|
8045
7316
|
}
|
8046
7317
|
|
8047
|
-
/** @public */
|
8048
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8049
|
-
|
8050
7318
|
/** @public */
|
8051
7319
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
8052
7320
|
|
8053
|
-
/**
|
8054
|
-
* @public
|
8055
|
-
*/
|
8056
|
-
export declare interface UiCanvasTexture {
|
8057
|
-
uiCanvasEntity: number;
|
8058
|
-
/** default = TextureWrapMode.Clamp */
|
8059
|
-
wrapMode?: TextureWrapMode | undefined;
|
8060
|
-
/** default = FilterMode.Bilinear */
|
8061
|
-
filterMode?: TextureFilterMode | undefined;
|
8062
|
-
}
|
8063
|
-
|
8064
|
-
/**
|
8065
|
-
* @public
|
8066
|
-
*/
|
8067
|
-
export declare namespace UiCanvasTexture {
|
8068
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8069
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8070
|
-
}
|
8071
|
-
|
8072
7321
|
/**
|
8073
7322
|
* @public
|
8074
7323
|
*/
|
@@ -8138,10 +7387,6 @@ export declare interface UiLabelProps {
|
|
8138
7387
|
textAlign?: TextAlignType | undefined;
|
8139
7388
|
/** Label font type. @defaultValue 'sans-serif' */
|
8140
7389
|
font?: UiFontType | undefined;
|
8141
|
-
/** Outline width of the text. @defaultValue 0 */
|
8142
|
-
outlineWidth?: number | undefined;
|
8143
|
-
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8144
|
-
outlineColor?: PBColor4 | undefined;
|
8145
7390
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
8146
7391
|
textWrap?: UiTextWrapType | undefined;
|
8147
7392
|
}
|
@@ -8151,9 +7396,6 @@ export declare interface UiLabelProps {
|
|
8151
7396
|
*/
|
8152
7397
|
export declare type uint32 = number;
|
8153
7398
|
|
8154
|
-
/** @public */
|
8155
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8156
|
-
|
8157
7399
|
/** @public */
|
8158
7400
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
8159
7401
|
|
@@ -8226,26 +7468,6 @@ export declare interface UiTransformProps {
|
|
8226
7468
|
overflow?: OverflowType;
|
8227
7469
|
/** 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) **/
|
8228
7470
|
pointerFilter?: PointerFilterType;
|
8229
|
-
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
8230
|
-
opacity?: number;
|
8231
|
-
/** A reference value to identify the element, default empty */
|
8232
|
-
elementId?: string;
|
8233
|
-
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8234
|
-
scrollPosition?: PBVector2 | string;
|
8235
|
-
/** default ShowScrollBar.SSB_BOTH */
|
8236
|
-
scrollVisible?: ScrollVisibleType;
|
8237
|
-
/** default 0 */
|
8238
|
-
zIndex?: number;
|
8239
|
-
}
|
8240
|
-
|
8241
|
-
/**
|
8242
|
-
* Texture
|
8243
|
-
* @public
|
8244
|
-
*/
|
8245
|
-
export declare interface UiVideoTexture {
|
8246
|
-
videoPlayerEntity: Entity;
|
8247
|
-
wrapMode?: TextureWrapType;
|
8248
|
-
filterMode?: TextureFilterType;
|
8249
7471
|
}
|
8250
7472
|
|
8251
7473
|
/**
|