@dcl/playground-assets 7.7.3-13057502418.commit-f85e704 → 7.7.3-13089595989.commit-0b20ca2
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 +784 -10
- package/dist/beta.d.ts +784 -10
- package/dist/index.bundled.d.ts +784 -10
- package/dist/index.js +7 -7
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/apis.d.ts +0 -8
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +784 -10
- package/etc/playground-assets.api.json +9000 -1127
- package/etc/playground-assets.api.md +503 -1
- package/package.json +4 -4
- package/README.md +0 -27
package/dist/beta.d.ts
CHANGED
@@ -178,6 +178,18 @@ 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
|
+
|
181
193
|
/** @public */
|
182
194
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
183
195
|
|
@@ -198,6 +210,37 @@ export declare const enum AvatarModifierType {
|
|
198
210
|
AMT_DISABLE_PASSPORTS = 1
|
199
211
|
}
|
200
212
|
|
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
|
+
|
201
244
|
/** @public */
|
202
245
|
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
203
246
|
|
@@ -462,6 +505,12 @@ export declare interface ByteBuffer {
|
|
462
505
|
*/
|
463
506
|
export declare type Callback = () => void;
|
464
507
|
|
508
|
+
/** @public */
|
509
|
+
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
510
|
+
|
511
|
+
/** @public */
|
512
|
+
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
513
|
+
|
465
514
|
/** @public */
|
466
515
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
467
516
|
|
@@ -519,6 +568,39 @@ export declare const enum CameraType {
|
|
519
568
|
|
520
569
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
521
570
|
|
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
|
+
|
522
604
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
523
605
|
/**
|
524
606
|
* @public
|
@@ -1292,12 +1374,18 @@ export declare const componentDefinitionByName: {
|
|
1292
1374
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
1293
1375
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
1294
1376
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
1377
|
+
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
1378
|
+
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
1295
1379
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
1296
1380
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
1297
1381
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
1382
|
+
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
1298
1383
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
1299
1384
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
1385
|
+
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
1386
|
+
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
1300
1387
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
1388
|
+
"core::Light": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLight>>;
|
1301
1389
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
1302
1390
|
"core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
|
1303
1391
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
@@ -1307,19 +1395,24 @@ export declare const componentDefinitionByName: {
|
|
1307
1395
|
"core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
|
1308
1396
|
"core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
|
1309
1397
|
"core::PointerLock": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerLock>>;
|
1398
|
+
"core::PrimaryPointerInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>>;
|
1310
1399
|
"core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
|
1311
1400
|
"core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
|
1312
1401
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
1402
|
+
"core::Spotlight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSpotlight>>;
|
1313
1403
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
1404
|
+
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
1314
1405
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
1315
1406
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
1316
1407
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
1317
1408
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
1409
|
+
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
1318
1410
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
1319
1411
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
1320
1412
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
1321
1413
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
1322
1414
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
1415
|
+
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
1323
1416
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
1324
1417
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
1325
1418
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
@@ -1885,6 +1978,9 @@ export declare type EntityComponents = {
|
|
1885
1978
|
onMouseUp: Callback;
|
1886
1979
|
onMouseEnter: Callback;
|
1887
1980
|
onMouseLeave: Callback;
|
1981
|
+
onMouseDrag: Callback;
|
1982
|
+
onMouseDragLocked: Callback;
|
1983
|
+
onMouseDragEnd: Callback;
|
1888
1984
|
};
|
1889
1985
|
|
1890
1986
|
/** @public */
|
@@ -2036,6 +2132,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
2036
2132
|
direction?: PBVector3;
|
2037
2133
|
};
|
2038
2134
|
|
2135
|
+
/** @public */
|
2136
|
+
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
2137
|
+
|
2039
2138
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
2040
2139
|
|
2041
2140
|
export declare type GlobalTargetRaycastSystemOptions = {
|
@@ -2048,6 +2147,21 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
2048
2147
|
/** @public */
|
2049
2148
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
2050
2149
|
|
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
|
+
|
2051
2165
|
/**
|
2052
2166
|
* @public
|
2053
2167
|
*/
|
@@ -2642,6 +2756,9 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
2642
2756
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
2643
2757
|
}
|
2644
2758
|
|
2759
|
+
/** @public */
|
2760
|
+
export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
|
2761
|
+
|
2645
2762
|
/**
|
2646
2763
|
* User key event Listeners
|
2647
2764
|
* @public
|
@@ -2655,6 +2772,12 @@ export declare type Listeners = {
|
|
2655
2772
|
onMouseEnter?: Callback;
|
2656
2773
|
/** triggered on mouse leave event */
|
2657
2774
|
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;
|
2658
2781
|
};
|
2659
2782
|
|
2660
2783
|
/**
|
@@ -3523,6 +3646,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3523
3646
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3524
3647
|
*/
|
3525
3648
|
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;
|
3526
3657
|
}
|
3527
3658
|
|
3528
3659
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3559,6 +3690,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3559
3690
|
* @param entity - entity to create or replace the MeshRenderer component
|
3560
3691
|
*/
|
3561
3692
|
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;
|
3562
3701
|
}
|
3563
3702
|
|
3564
3703
|
/* Excluded from this release type: MessageBus */
|
@@ -3952,6 +4091,25 @@ export declare const onVideoEvent: Observable<{
|
|
3952
4091
|
totalVideoLength: number;
|
3953
4092
|
}>;
|
3954
4093
|
|
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
|
+
|
3955
4113
|
/**
|
3956
4114
|
* @public
|
3957
4115
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4212,6 +4370,9 @@ export declare interface PBAvatarModifierArea {
|
|
4212
4370
|
excludeIds: string[];
|
4213
4371
|
/** list of modifiers to apply */
|
4214
4372
|
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;
|
4215
4376
|
}
|
4216
4377
|
|
4217
4378
|
/**
|
@@ -4302,6 +4463,51 @@ export declare namespace PBBillboard {
|
|
4302
4463
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4303
4464
|
}
|
4304
4465
|
|
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
|
+
|
4305
4511
|
/**
|
4306
4512
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4307
4513
|
* third-person view.
|
@@ -4324,7 +4530,7 @@ export declare namespace PBCameraMode {
|
|
4324
4530
|
|
4325
4531
|
/**
|
4326
4532
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4327
|
-
* the player's camera mode (1st-person
|
4533
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
4328
4534
|
*
|
4329
4535
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4330
4536
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4334,6 +4540,8 @@ export declare namespace PBCameraMode {
|
|
4334
4540
|
*
|
4335
4541
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4336
4542
|
* is actually a 3D volume.
|
4543
|
+
*
|
4544
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4337
4545
|
*/
|
4338
4546
|
/**
|
4339
4547
|
* @public
|
@@ -4343,6 +4551,9 @@ export declare interface PBCameraModeArea {
|
|
4343
4551
|
area: PBVector3 | undefined;
|
4344
4552
|
/** the camera mode to enforce */
|
4345
4553
|
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;
|
4346
4557
|
}
|
4347
4558
|
|
4348
4559
|
/**
|
@@ -4414,6 +4625,39 @@ export declare namespace PBEngineInfo {
|
|
4414
4625
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4415
4626
|
}
|
4416
4627
|
|
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
|
+
|
4417
4661
|
/**
|
4418
4662
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4419
4663
|
*
|
@@ -4449,6 +4693,25 @@ export declare namespace PBGltfContainer {
|
|
4449
4693
|
*/
|
4450
4694
|
export declare interface PBGltfContainerLoadingState {
|
4451
4695
|
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[];
|
4452
4715
|
}
|
4453
4716
|
|
4454
4717
|
/**
|
@@ -4459,6 +4722,77 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4459
4722
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4460
4723
|
}
|
4461
4724
|
|
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
|
+
|
4462
4796
|
/**
|
4463
4797
|
* @public
|
4464
4798
|
*/
|
@@ -4498,6 +4832,62 @@ export declare namespace PBInputModifier_StandardInput {
|
|
4498
4832
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4499
4833
|
}
|
4500
4834
|
|
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
|
+
|
4501
4891
|
/**
|
4502
4892
|
* PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
|
4503
4893
|
* This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
|
@@ -4529,6 +4919,14 @@ export declare interface PBMaterial {
|
|
4529
4919
|
$case: "pbr";
|
4530
4920
|
pbr: PBMaterial_PbrMaterial;
|
4531
4921
|
} | 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;
|
4532
4930
|
}
|
4533
4931
|
|
4534
4932
|
/**
|
@@ -4539,6 +4937,22 @@ export declare namespace PBMaterial {
|
|
4539
4937
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4540
4938
|
}
|
4541
4939
|
|
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
|
+
|
4542
4956
|
/**
|
4543
4957
|
* @public
|
4544
4958
|
*/
|
@@ -4635,6 +5049,9 @@ export declare interface PBMeshCollider {
|
|
4635
5049
|
} | {
|
4636
5050
|
$case: "plane";
|
4637
5051
|
plane: PBMeshCollider_PlaneMesh;
|
5052
|
+
} | {
|
5053
|
+
$case: "gltf";
|
5054
|
+
gltf: PBMeshCollider_GltfMesh;
|
4638
5055
|
} | undefined;
|
4639
5056
|
}
|
4640
5057
|
|
@@ -4680,6 +5097,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
4680
5097
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
4681
5098
|
}
|
4682
5099
|
|
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
|
+
|
4683
5119
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
4684
5120
|
/**
|
4685
5121
|
* @public
|
@@ -4712,13 +5148,11 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
4712
5148
|
|
4713
5149
|
/**
|
4714
5150
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
4715
|
-
* plane, a sphere or a
|
5151
|
+
* plane, a sphere, a cylinder, or a Gltf mesh.
|
4716
5152
|
*
|
4717
5153
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
4718
5154
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
4719
5155
|
* `float` coordinates, one for each corner of each side of each face.
|
4720
|
-
*
|
4721
|
-
* More complex shapes require the use of a `GltfContainer` component.
|
4722
5156
|
*/
|
4723
5157
|
/**
|
4724
5158
|
* @public
|
@@ -4736,6 +5170,9 @@ export declare interface PBMeshRenderer {
|
|
4736
5170
|
} | {
|
4737
5171
|
$case: "plane";
|
4738
5172
|
plane: PBMeshRenderer_PlaneMesh;
|
5173
|
+
} | {
|
5174
|
+
$case: "gltf";
|
5175
|
+
gltf: PBMeshRenderer_GltfMesh;
|
4739
5176
|
} | undefined;
|
4740
5177
|
}
|
4741
5178
|
|
@@ -4783,6 +5220,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
4783
5220
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
4784
5221
|
}
|
4785
5222
|
|
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
|
+
|
4786
5242
|
/** PlaneMesh renders a 2D rectangular shape. */
|
4787
5243
|
/**
|
4788
5244
|
* @public
|
@@ -5001,6 +5457,30 @@ export declare namespace PBPosition {
|
|
5001
5457
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
|
5002
5458
|
}
|
5003
5459
|
|
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
|
+
|
5004
5484
|
/**
|
5005
5485
|
* @public
|
5006
5486
|
*/
|
@@ -5122,6 +5602,39 @@ export declare namespace PBRealmInfo {
|
|
5122
5602
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5123
5603
|
}
|
5124
5604
|
|
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
|
+
|
5125
5638
|
/**
|
5126
5639
|
* The TextShape component renders customizable floating text.
|
5127
5640
|
*
|
@@ -5186,6 +5699,40 @@ export declare namespace PBTextShape {
|
|
5186
5699
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5187
5700
|
}
|
5188
5701
|
|
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
|
+
|
5189
5736
|
/**
|
5190
5737
|
* @public
|
5191
5738
|
*/
|
@@ -5275,6 +5822,25 @@ export declare namespace PBUiBackground {
|
|
5275
5822
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5276
5823
|
}
|
5277
5824
|
|
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
|
+
|
5278
5844
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5279
5845
|
/**
|
5280
5846
|
* @public
|
@@ -5391,6 +5957,21 @@ export declare namespace PBUiInputResult {
|
|
5391
5957
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5392
5958
|
}
|
5393
5959
|
|
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
|
+
|
5394
5975
|
/**
|
5395
5976
|
* @public
|
5396
5977
|
*/
|
@@ -5407,6 +5988,10 @@ export declare interface PBUiText {
|
|
5407
5988
|
fontSize?: number | undefined;
|
5408
5989
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
5409
5990
|
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;
|
5410
5995
|
}
|
5411
5996
|
|
5412
5997
|
/**
|
@@ -5503,6 +6088,16 @@ export declare interface PBUiTransform {
|
|
5503
6088
|
paddingBottom: number;
|
5504
6089
|
/** default: PointerFilterMode.PFM_NONE */
|
5505
6090
|
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;
|
5506
6101
|
}
|
5507
6102
|
|
5508
6103
|
/**
|
@@ -5632,6 +6227,25 @@ export declare namespace PBVisibilityComponent {
|
|
5632
6227
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
5633
6228
|
}
|
5634
6229
|
|
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
|
+
|
5635
6249
|
/**
|
5636
6250
|
* Represens a plane by the equation ax + by + cz + d = 0
|
5637
6251
|
* @public
|
@@ -5787,6 +6401,24 @@ export declare interface PointerEventsSystem {
|
|
5787
6401
|
* @param entity - Entity where the callback was attached
|
5788
6402
|
*/
|
5789
6403
|
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;
|
5790
6422
|
/**
|
5791
6423
|
* @public
|
5792
6424
|
* Execute callback when the user press the InputButton pointing at the entity
|
@@ -5841,6 +6473,37 @@ export declare interface PointerEventsSystem {
|
|
5841
6473
|
entity: Entity;
|
5842
6474
|
opts?: Partial<EventSystemOptions>;
|
5843
6475
|
}, 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;
|
5844
6507
|
}
|
5845
6508
|
|
5846
6509
|
/**
|
@@ -5857,7 +6520,10 @@ export declare const enum PointerEventType {
|
|
5857
6520
|
PET_UP = 0,
|
5858
6521
|
PET_DOWN = 1,
|
5859
6522
|
PET_HOVER_ENTER = 2,
|
5860
|
-
PET_HOVER_LEAVE = 3
|
6523
|
+
PET_HOVER_LEAVE = 3,
|
6524
|
+
PET_DRAG_LOCKED = 4,
|
6525
|
+
PET_DRAG = 5,
|
6526
|
+
PET_DRAG_END = 6
|
5861
6527
|
}
|
5862
6528
|
|
5863
6529
|
/**
|
@@ -5877,6 +6543,17 @@ export declare type PointerFilterType = 'none' | 'block';
|
|
5877
6543
|
/** @public */
|
5878
6544
|
export declare const PointerLock: LastWriteWinElementSetComponentDefinition<PBPointerLock>;
|
5879
6545
|
|
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
|
+
|
5880
6557
|
/**
|
5881
6558
|
* Type used for defining the position of the element. i.e. margin, padding
|
5882
6559
|
* @public
|
@@ -5914,6 +6591,9 @@ export declare type PositionType = 'absolute' | 'relative';
|
|
5914
6591
|
*/
|
5915
6592
|
export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
|
5916
6593
|
|
6594
|
+
/** @public */
|
6595
|
+
export declare const PrimaryPointerInfo: LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>;
|
6596
|
+
|
5917
6597
|
export declare enum ProcessMessageResultType {
|
5918
6598
|
/**
|
5919
6599
|
* Typical message and new state set.
|
@@ -6468,6 +7148,7 @@ export declare type RaycastSystemOptions = {
|
|
6468
7148
|
export declare interface ReactBasedUiSystem {
|
6469
7149
|
destroy(): void;
|
6470
7150
|
setUiRenderer(ui: UiComponent): void;
|
7151
|
+
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
6471
7152
|
}
|
6472
7153
|
|
6473
7154
|
/**
|
@@ -6921,6 +7602,43 @@ export declare namespace Schemas {
|
|
6921
7602
|
}) => void;
|
6922
7603
|
}
|
6923
7604
|
|
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
|
+
|
6924
7642
|
/**
|
6925
7643
|
* @public
|
6926
7644
|
*/
|
@@ -6928,6 +7646,9 @@ export declare interface Spec {
|
|
6928
7646
|
[key: string]: ISchema;
|
6929
7647
|
}
|
6930
7648
|
|
7649
|
+
/** @public */
|
7650
|
+
export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
|
7651
|
+
|
6931
7652
|
/* Excluded from this release type: SyncComponents */
|
6932
7653
|
|
6933
7654
|
/**
|
@@ -6997,6 +7718,9 @@ export declare namespace Texture {
|
|
6997
7718
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
6998
7719
|
}
|
6999
7720
|
|
7721
|
+
/** @public */
|
7722
|
+
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7723
|
+
|
7000
7724
|
/**
|
7001
7725
|
* @public
|
7002
7726
|
*/
|
@@ -7089,6 +7813,9 @@ export declare interface TextureUnion {
|
|
7089
7813
|
} | {
|
7090
7814
|
$case: "videoTexture";
|
7091
7815
|
videoTexture: VideoTexture;
|
7816
|
+
} | {
|
7817
|
+
$case: "uiTexture";
|
7818
|
+
uiTexture: UiCanvasTexture;
|
7092
7819
|
} | undefined;
|
7093
7820
|
}
|
7094
7821
|
|
@@ -7186,11 +7913,7 @@ export declare type TransformTypeWithOptionals = Partial<TransformType>;
|
|
7186
7913
|
* @public
|
7187
7914
|
*/
|
7188
7915
|
export declare type Transport = {
|
7189
|
-
|
7190
|
-
* For Network messages its an Uint8Array[]. Due too the LiveKit MAX_SIZE = 13kb
|
7191
|
-
* For Renderer & Other transports we send a single Uint8Array
|
7192
|
-
*/
|
7193
|
-
send(message: Uint8Array | Uint8Array[]): Promise<void>;
|
7916
|
+
send(message: Uint8Array): Promise<void>;
|
7194
7917
|
onmessage?(message: Uint8Array): void;
|
7195
7918
|
filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
|
7196
7919
|
type?: string;
|
@@ -7296,6 +8019,8 @@ export declare interface UiBackgroundProps {
|
|
7296
8019
|
uvs?: number[];
|
7297
8020
|
/** AvatarTexture for the background */
|
7298
8021
|
avatarTexture?: UiAvatarTexture;
|
8022
|
+
/** VideoTexture for the background */
|
8023
|
+
videoTexture?: UiVideoTexture;
|
7299
8024
|
/** Texture for the background */
|
7300
8025
|
texture?: UiTexture;
|
7301
8026
|
}
|
@@ -7315,9 +8040,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
7315
8040
|
disabled?: boolean;
|
7316
8041
|
}
|
7317
8042
|
|
8043
|
+
/** @public */
|
8044
|
+
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8045
|
+
|
7318
8046
|
/** @public */
|
7319
8047
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
7320
8048
|
|
8049
|
+
/**
|
8050
|
+
* @public
|
8051
|
+
*/
|
8052
|
+
export declare interface UiCanvasTexture {
|
8053
|
+
uiCanvasEntity: number;
|
8054
|
+
/** default = TextureWrapMode.Clamp */
|
8055
|
+
wrapMode?: TextureWrapMode | undefined;
|
8056
|
+
/** default = FilterMode.Bilinear */
|
8057
|
+
filterMode?: TextureFilterMode | undefined;
|
8058
|
+
}
|
8059
|
+
|
8060
|
+
/**
|
8061
|
+
* @public
|
8062
|
+
*/
|
8063
|
+
export declare namespace UiCanvasTexture {
|
8064
|
+
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8065
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8066
|
+
}
|
8067
|
+
|
7321
8068
|
/**
|
7322
8069
|
* @public
|
7323
8070
|
*/
|
@@ -7387,6 +8134,10 @@ export declare interface UiLabelProps {
|
|
7387
8134
|
textAlign?: TextAlignType | undefined;
|
7388
8135
|
/** Label font type. @defaultValue 'sans-serif' */
|
7389
8136
|
font?: UiFontType | undefined;
|
8137
|
+
/** Outline width of the text. @defaultValue 0 */
|
8138
|
+
outlineWidth?: number | undefined;
|
8139
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8140
|
+
outlineColor?: PBColor4 | undefined;
|
7390
8141
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
7391
8142
|
textWrap?: UiTextWrapType | undefined;
|
7392
8143
|
}
|
@@ -7396,6 +8147,9 @@ export declare interface UiLabelProps {
|
|
7396
8147
|
*/
|
7397
8148
|
export declare type uint32 = number;
|
7398
8149
|
|
8150
|
+
/** @public */
|
8151
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8152
|
+
|
7399
8153
|
/** @public */
|
7400
8154
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
7401
8155
|
|
@@ -7468,6 +8222,26 @@ export declare interface UiTransformProps {
|
|
7468
8222
|
overflow?: OverflowType;
|
7469
8223
|
/** 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) **/
|
7470
8224
|
pointerFilter?: PointerFilterType;
|
8225
|
+
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
8226
|
+
opacity?: number;
|
8227
|
+
/** A reference value to identify the element, default empty */
|
8228
|
+
elementId?: string;
|
8229
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8230
|
+
scrollPosition?: PBVector2 | string;
|
8231
|
+
/** default ShowScrollBar.SSB_BOTH */
|
8232
|
+
scrollVisible?: ScrollVisibleType;
|
8233
|
+
/** default 0 */
|
8234
|
+
zIndex?: number;
|
8235
|
+
}
|
8236
|
+
|
8237
|
+
/**
|
8238
|
+
* Texture
|
8239
|
+
* @public
|
8240
|
+
*/
|
8241
|
+
export declare interface UiVideoTexture {
|
8242
|
+
videoPlayerEntity: Entity;
|
8243
|
+
wrapMode?: TextureWrapType;
|
8244
|
+
filterMode?: TextureFilterType;
|
7471
8245
|
}
|
7472
8246
|
|
7473
8247
|
/**
|