@dcl/playground-assets 7.7.9-13728708694.commit-5b19f0f → 7.7.10-13856045106.commit-7f23e37
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 +787 -5
- package/dist/beta.d.ts +787 -5
- package/dist/index.bundled.d.ts +787 -5
- 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 +787 -5
- package/dist/tsdoc-metadata.json +1 -1
- package/etc/playground-assets.api.json +9029 -1093
- package/etc/playground-assets.api.md +504 -0
- package/package.json +4 -4
package/dist/alpha.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>>;
|
@@ -1890,6 +1983,9 @@ export declare type EntityComponents = {
|
|
1890
1983
|
onMouseUp: Callback;
|
1891
1984
|
onMouseEnter: Callback;
|
1892
1985
|
onMouseLeave: Callback;
|
1986
|
+
onMouseDrag: Callback;
|
1987
|
+
onMouseDragLocked: Callback;
|
1988
|
+
onMouseDragEnd: Callback;
|
1893
1989
|
};
|
1894
1990
|
|
1895
1991
|
/** @public */
|
@@ -2041,6 +2137,9 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
2041
2137
|
direction?: PBVector3;
|
2042
2138
|
};
|
2043
2139
|
|
2140
|
+
/** @public */
|
2141
|
+
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
2142
|
+
|
2044
2143
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
2045
2144
|
|
2046
2145
|
export declare type GlobalTargetRaycastSystemOptions = {
|
@@ -2053,6 +2152,21 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
2053
2152
|
/** @public */
|
2054
2153
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
2055
2154
|
|
2155
|
+
/** @public */
|
2156
|
+
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
2157
|
+
|
2158
|
+
/** @public */
|
2159
|
+
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
2160
|
+
|
2161
|
+
/**
|
2162
|
+
* @public
|
2163
|
+
*/
|
2164
|
+
export declare const enum GltfNodeStateValue {
|
2165
|
+
GNSV_PENDING = 0,
|
2166
|
+
GNSV_FAILED = 1,
|
2167
|
+
GNSV_READY = 2
|
2168
|
+
}
|
2169
|
+
|
2056
2170
|
/**
|
2057
2171
|
* @public
|
2058
2172
|
*/
|
@@ -2656,6 +2770,9 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
2656
2770
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
2657
2771
|
}
|
2658
2772
|
|
2773
|
+
/** @public */
|
2774
|
+
export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
|
2775
|
+
|
2659
2776
|
/**
|
2660
2777
|
* User key event Listeners
|
2661
2778
|
* @public
|
@@ -2669,6 +2786,12 @@ export declare type Listeners = {
|
|
2669
2786
|
onMouseEnter?: Callback;
|
2670
2787
|
/** triggered on mouse leave event */
|
2671
2788
|
onMouseLeave?: Callback;
|
2789
|
+
/** triggered on mouse drag event */
|
2790
|
+
onMouseDrag?: Callback;
|
2791
|
+
/** triggered on mouse drag event */
|
2792
|
+
onMouseDragLocked?: Callback;
|
2793
|
+
/** triggered on mouse drag event */
|
2794
|
+
onMouseDragEnd?: Callback;
|
2672
2795
|
};
|
2673
2796
|
|
2674
2797
|
/**
|
@@ -3537,6 +3660,14 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3537
3660
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3538
3661
|
*/
|
3539
3662
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3663
|
+
/**
|
3664
|
+
* @public
|
3665
|
+
* Set a gltf internal mesh in the MeshCollider component
|
3666
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
3667
|
+
* @param source - the path to the gltf
|
3668
|
+
* @param meshName - the name of the mesh in the gltf
|
3669
|
+
*/
|
3670
|
+
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3540
3671
|
}
|
3541
3672
|
|
3542
3673
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3573,6 +3704,14 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3573
3704
|
* @param entity - entity to create or replace the MeshRenderer component
|
3574
3705
|
*/
|
3575
3706
|
setSphere(entity: Entity): void;
|
3707
|
+
/**
|
3708
|
+
* @public
|
3709
|
+
* Set a gltf internal mesh in the MeshRenderer component
|
3710
|
+
* @param entity - entity to create or replace the MeshRenderer component
|
3711
|
+
* @param source - the path to the gltf
|
3712
|
+
* @param meshName - the name of the mesh in the gltf
|
3713
|
+
*/
|
3714
|
+
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3576
3715
|
}
|
3577
3716
|
|
3578
3717
|
/**
|
@@ -3985,6 +4124,25 @@ export declare const onVideoEvent: Observable<{
|
|
3985
4124
|
totalVideoLength: number;
|
3986
4125
|
}>;
|
3987
4126
|
|
4127
|
+
/**
|
4128
|
+
* @public
|
4129
|
+
*/
|
4130
|
+
export declare interface Orthographic {
|
4131
|
+
/**
|
4132
|
+
* vertical extent of the visible range in meters
|
4133
|
+
* defaults to 4m
|
4134
|
+
*/
|
4135
|
+
verticalRange?: number | undefined;
|
4136
|
+
}
|
4137
|
+
|
4138
|
+
/**
|
4139
|
+
* @public
|
4140
|
+
*/
|
4141
|
+
export declare namespace Orthographic {
|
4142
|
+
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4143
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4144
|
+
}
|
4145
|
+
|
3988
4146
|
/**
|
3989
4147
|
* @public
|
3990
4148
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4211,6 +4369,8 @@ export declare namespace PBAvatarEmoteCommand {
|
|
4211
4369
|
export declare interface PBAvatarEquippedData {
|
4212
4370
|
wearableUrns: string[];
|
4213
4371
|
emoteUrns: string[];
|
4372
|
+
/** slots that will render even if hidden */
|
4373
|
+
forceRender: string[];
|
4214
4374
|
}
|
4215
4375
|
|
4216
4376
|
/**
|
@@ -4245,6 +4405,9 @@ export declare interface PBAvatarModifierArea {
|
|
4245
4405
|
excludeIds: string[];
|
4246
4406
|
/** list of modifiers to apply */
|
4247
4407
|
modifiers: AvatarModifierType[];
|
4408
|
+
movementSettings?: AvatarMovementSettings | undefined;
|
4409
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4410
|
+
useColliderRange?: boolean | undefined;
|
4248
4411
|
}
|
4249
4412
|
|
4250
4413
|
/**
|
@@ -4301,6 +4464,8 @@ export declare interface PBAvatarShape {
|
|
4301
4464
|
wearables: string[];
|
4302
4465
|
/** available emotes (default empty) */
|
4303
4466
|
emotes: string[];
|
4467
|
+
/** slots that will render even if hidden */
|
4468
|
+
forceRender: string[];
|
4304
4469
|
}
|
4305
4470
|
|
4306
4471
|
/**
|
@@ -4335,6 +4500,51 @@ export declare namespace PBBillboard {
|
|
4335
4500
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4336
4501
|
}
|
4337
4502
|
|
4503
|
+
/**
|
4504
|
+
* @public
|
4505
|
+
*/
|
4506
|
+
export declare interface PBCameraLayer {
|
4507
|
+
/**
|
4508
|
+
* layer to which these settings apply. must be > 0
|
4509
|
+
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4510
|
+
*/
|
4511
|
+
layer: number;
|
4512
|
+
/** should the sun light affect this layer? default false */
|
4513
|
+
directionalLight?: boolean | undefined;
|
4514
|
+
/** should this layer show player avatars? default false */
|
4515
|
+
showAvatars?: boolean | undefined;
|
4516
|
+
/** should this layer show the sky? default false */
|
4517
|
+
showSkybox?: boolean | undefined;
|
4518
|
+
/** should this layer show distance fog? default false */
|
4519
|
+
showFog?: boolean | undefined;
|
4520
|
+
/** ambient light overrides for this layer. default -> use same as main camera */
|
4521
|
+
ambientColorOverride?: PBColor3 | undefined;
|
4522
|
+
ambientBrightnessOverride?: number | undefined;
|
4523
|
+
}
|
4524
|
+
|
4525
|
+
/**
|
4526
|
+
* @public
|
4527
|
+
*/
|
4528
|
+
export declare namespace PBCameraLayer {
|
4529
|
+
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4530
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4531
|
+
}
|
4532
|
+
|
4533
|
+
/**
|
4534
|
+
* @public
|
4535
|
+
*/
|
4536
|
+
export declare interface PBCameraLayers {
|
4537
|
+
layers: number[];
|
4538
|
+
}
|
4539
|
+
|
4540
|
+
/**
|
4541
|
+
* @public
|
4542
|
+
*/
|
4543
|
+
export declare namespace PBCameraLayers {
|
4544
|
+
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4545
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4546
|
+
}
|
4547
|
+
|
4338
4548
|
/**
|
4339
4549
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4340
4550
|
* third-person view.
|
@@ -4357,7 +4567,7 @@ export declare namespace PBCameraMode {
|
|
4357
4567
|
|
4358
4568
|
/**
|
4359
4569
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4360
|
-
* the player's camera mode (1st-person
|
4570
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
4361
4571
|
*
|
4362
4572
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4363
4573
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4367,6 +4577,8 @@ export declare namespace PBCameraMode {
|
|
4367
4577
|
*
|
4368
4578
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4369
4579
|
* is actually a 3D volume.
|
4580
|
+
*
|
4581
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4370
4582
|
*/
|
4371
4583
|
/**
|
4372
4584
|
* @public
|
@@ -4376,6 +4588,9 @@ export declare interface PBCameraModeArea {
|
|
4376
4588
|
area: PBVector3 | undefined;
|
4377
4589
|
/** the camera mode to enforce */
|
4378
4590
|
mode: CameraType;
|
4591
|
+
cinematicSettings?: CinematicSettings | undefined;
|
4592
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4593
|
+
useColliderRange?: boolean | undefined;
|
4379
4594
|
}
|
4380
4595
|
|
4381
4596
|
/**
|
@@ -4447,6 +4662,39 @@ export declare namespace PBEngineInfo {
|
|
4447
4662
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4448
4663
|
}
|
4449
4664
|
|
4665
|
+
/**
|
4666
|
+
* defines the global scene light settings. must be added to the scene root.
|
4667
|
+
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4668
|
+
*/
|
4669
|
+
/**
|
4670
|
+
* @public
|
4671
|
+
*/
|
4672
|
+
export declare interface PBGlobalLight {
|
4673
|
+
/**
|
4674
|
+
* the direction the directional light shines in.
|
4675
|
+
* default depends on time of day and explorer implementation
|
4676
|
+
*/
|
4677
|
+
direction?: PBVector3 | undefined;
|
4678
|
+
/**
|
4679
|
+
* ambient light color
|
4680
|
+
* default: White
|
4681
|
+
*/
|
4682
|
+
ambientColor?: PBColor3 | undefined;
|
4683
|
+
/**
|
4684
|
+
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4685
|
+
* default 1
|
4686
|
+
*/
|
4687
|
+
ambientBrightness?: number | undefined;
|
4688
|
+
}
|
4689
|
+
|
4690
|
+
/**
|
4691
|
+
* @public
|
4692
|
+
*/
|
4693
|
+
export declare namespace PBGlobalLight {
|
4694
|
+
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4695
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4696
|
+
}
|
4697
|
+
|
4450
4698
|
/**
|
4451
4699
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4452
4700
|
*
|
@@ -4482,6 +4730,25 @@ export declare namespace PBGltfContainer {
|
|
4482
4730
|
*/
|
4483
4731
|
export declare interface PBGltfContainerLoadingState {
|
4484
4732
|
currentState: LoadingState;
|
4733
|
+
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4734
|
+
nodePaths: string[];
|
4735
|
+
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4736
|
+
meshNames: string[];
|
4737
|
+
/**
|
4738
|
+
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4739
|
+
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4740
|
+
*/
|
4741
|
+
materialNames: string[];
|
4742
|
+
/**
|
4743
|
+
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4744
|
+
* sure all your materials are explicitly named.
|
4745
|
+
*/
|
4746
|
+
skinNames: string[];
|
4747
|
+
/**
|
4748
|
+
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4749
|
+
* your skins are explicitly named.
|
4750
|
+
*/
|
4751
|
+
animationNames: string[];
|
4485
4752
|
}
|
4486
4753
|
|
4487
4754
|
/**
|
@@ -4492,6 +4759,77 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4492
4759
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4493
4760
|
}
|
4494
4761
|
|
4762
|
+
/**
|
4763
|
+
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4764
|
+
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4765
|
+
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4766
|
+
* in the parent.
|
4767
|
+
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4768
|
+
*
|
4769
|
+
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4770
|
+
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4771
|
+
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4772
|
+
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4773
|
+
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4774
|
+
*
|
4775
|
+
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4776
|
+
*
|
4777
|
+
* From the scene, you can modify various components to alter the gltf node:
|
4778
|
+
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4779
|
+
* regardless of any intermediate gltf node hierarchy.
|
4780
|
+
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4781
|
+
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4782
|
+
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4783
|
+
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4784
|
+
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4785
|
+
* 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
|
4786
|
+
* PBMaterial will be maintained.
|
4787
|
+
*
|
4788
|
+
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4789
|
+
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4790
|
+
* change the state to `GNS_FAILED`.
|
4791
|
+
* - deleting the scene entity will not delete the gltf node.
|
4792
|
+
*
|
4793
|
+
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4794
|
+
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4795
|
+
* the gltf node will also be displayed.
|
4796
|
+
*/
|
4797
|
+
/**
|
4798
|
+
* @public
|
4799
|
+
*/
|
4800
|
+
export declare interface PBGltfNode {
|
4801
|
+
/** the path of the target node in the Gltf. */
|
4802
|
+
path: string;
|
4803
|
+
}
|
4804
|
+
|
4805
|
+
/**
|
4806
|
+
* @public
|
4807
|
+
*/
|
4808
|
+
export declare namespace PBGltfNode {
|
4809
|
+
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4810
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4811
|
+
}
|
4812
|
+
|
4813
|
+
/**
|
4814
|
+
* The state of a linked gltf node.
|
4815
|
+
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4816
|
+
*/
|
4817
|
+
/**
|
4818
|
+
* @public
|
4819
|
+
*/
|
4820
|
+
export declare interface PBGltfNodeState {
|
4821
|
+
state: GltfNodeStateValue;
|
4822
|
+
error?: string | undefined;
|
4823
|
+
}
|
4824
|
+
|
4825
|
+
/**
|
4826
|
+
* @public
|
4827
|
+
*/
|
4828
|
+
export declare namespace PBGltfNodeState {
|
4829
|
+
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4830
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4831
|
+
}
|
4832
|
+
|
4495
4833
|
/**
|
4496
4834
|
* @public
|
4497
4835
|
*/
|
@@ -4531,6 +4869,62 @@ export declare namespace PBInputModifier_StandardInput {
|
|
4531
4869
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4532
4870
|
}
|
4533
4871
|
|
4872
|
+
/**
|
4873
|
+
* defines a light source.
|
4874
|
+
* the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
|
4875
|
+
* a PBGlobalLight component can also be added to the root to control the directional light direction.
|
4876
|
+
* point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
|
4877
|
+
*/
|
4878
|
+
/**
|
4879
|
+
* @public
|
4880
|
+
*/
|
4881
|
+
export declare interface PBLight {
|
4882
|
+
/**
|
4883
|
+
* whether the light is on
|
4884
|
+
* default true
|
4885
|
+
*/
|
4886
|
+
enabled?: boolean | undefined;
|
4887
|
+
/**
|
4888
|
+
* light brightness in lux (lumens/m^2).
|
4889
|
+
*
|
4890
|
+
* 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).
|
4891
|
+
* the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
|
4892
|
+
* for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
|
4893
|
+
*
|
4894
|
+
* for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
|
4895
|
+
* divide lumens by ~12 (4*pi).
|
4896
|
+
* e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
|
4897
|
+
* a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
|
4898
|
+
*
|
4899
|
+
* default
|
4900
|
+
* for point/spotlights: 10,000
|
4901
|
+
* for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
|
4902
|
+
*/
|
4903
|
+
illuminance?: number | undefined;
|
4904
|
+
/**
|
4905
|
+
* whether the light should cast shadows.
|
4906
|
+
* note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
|
4907
|
+
* of lights depending on the implementation, platform, and user settings.
|
4908
|
+
* default
|
4909
|
+
* for point/spotlights: false / off
|
4910
|
+
* for global directional light: true / on
|
4911
|
+
*/
|
4912
|
+
shadows?: boolean | undefined;
|
4913
|
+
/**
|
4914
|
+
* light color
|
4915
|
+
* default White
|
4916
|
+
*/
|
4917
|
+
color?: PBColor3 | undefined;
|
4918
|
+
}
|
4919
|
+
|
4920
|
+
/**
|
4921
|
+
* @public
|
4922
|
+
*/
|
4923
|
+
export declare namespace PBLight {
|
4924
|
+
export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
|
4925
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
|
4926
|
+
}
|
4927
|
+
|
4534
4928
|
/**
|
4535
4929
|
* PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
|
4536
4930
|
* This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
|
@@ -4562,6 +4956,14 @@ export declare interface PBMaterial {
|
|
4562
4956
|
$case: "pbr";
|
4563
4957
|
pbr: PBMaterial_PbrMaterial;
|
4564
4958
|
} | undefined;
|
4959
|
+
/**
|
4960
|
+
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
4961
|
+
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
4962
|
+
* supported by the PbMaterial.
|
4963
|
+
* If this is provided and the `material` field is not provided, the renderer will update the material
|
4964
|
+
* field with data that reflects the gltf material once it is loaded.
|
4965
|
+
*/
|
4966
|
+
gltf?: PBMaterial_GltfMaterial | undefined;
|
4565
4967
|
}
|
4566
4968
|
|
4567
4969
|
/**
|
@@ -4572,6 +4974,22 @@ export declare namespace PBMaterial {
|
|
4572
4974
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4573
4975
|
}
|
4574
4976
|
|
4977
|
+
/**
|
4978
|
+
* @public
|
4979
|
+
*/
|
4980
|
+
export declare interface PBMaterial_GltfMaterial {
|
4981
|
+
gltfSrc: string;
|
4982
|
+
name: string;
|
4983
|
+
}
|
4984
|
+
|
4985
|
+
/**
|
4986
|
+
* @public
|
4987
|
+
*/
|
4988
|
+
export declare namespace PBMaterial_GltfMaterial {
|
4989
|
+
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
4990
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
4991
|
+
}
|
4992
|
+
|
4575
4993
|
/**
|
4576
4994
|
* @public
|
4577
4995
|
*/
|
@@ -4668,6 +5086,9 @@ export declare interface PBMeshCollider {
|
|
4668
5086
|
} | {
|
4669
5087
|
$case: "plane";
|
4670
5088
|
plane: PBMeshCollider_PlaneMesh;
|
5089
|
+
} | {
|
5090
|
+
$case: "gltf";
|
5091
|
+
gltf: PBMeshCollider_GltfMesh;
|
4671
5092
|
} | undefined;
|
4672
5093
|
}
|
4673
5094
|
|
@@ -4713,6 +5134,25 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
4713
5134
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
4714
5135
|
}
|
4715
5136
|
|
5137
|
+
/** A collider constructed from a Gltf Mesh. */
|
5138
|
+
/**
|
5139
|
+
* @public
|
5140
|
+
*/
|
5141
|
+
export declare interface PBMeshCollider_GltfMesh {
|
5142
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
5143
|
+
gltfSrc: string;
|
5144
|
+
/** the name of the mesh asset */
|
5145
|
+
name: string;
|
5146
|
+
}
|
5147
|
+
|
5148
|
+
/**
|
5149
|
+
* @public
|
5150
|
+
*/
|
5151
|
+
export declare namespace PBMeshCollider_GltfMesh {
|
5152
|
+
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5153
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5154
|
+
}
|
5155
|
+
|
4716
5156
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
4717
5157
|
/**
|
4718
5158
|
* @public
|
@@ -4745,13 +5185,11 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
4745
5185
|
|
4746
5186
|
/**
|
4747
5187
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
4748
|
-
* plane, a sphere or a
|
5188
|
+
* plane, a sphere, a cylinder, or a Gltf mesh.
|
4749
5189
|
*
|
4750
5190
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
4751
5191
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
4752
5192
|
* `float` coordinates, one for each corner of each side of each face.
|
4753
|
-
*
|
4754
|
-
* More complex shapes require the use of a `GltfContainer` component.
|
4755
5193
|
*/
|
4756
5194
|
/**
|
4757
5195
|
* @public
|
@@ -4769,6 +5207,9 @@ export declare interface PBMeshRenderer {
|
|
4769
5207
|
} | {
|
4770
5208
|
$case: "plane";
|
4771
5209
|
plane: PBMeshRenderer_PlaneMesh;
|
5210
|
+
} | {
|
5211
|
+
$case: "gltf";
|
5212
|
+
gltf: PBMeshRenderer_GltfMesh;
|
4772
5213
|
} | undefined;
|
4773
5214
|
}
|
4774
5215
|
|
@@ -4816,6 +5257,25 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
4816
5257
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
4817
5258
|
}
|
4818
5259
|
|
5260
|
+
/** A mesh from a Gltf. */
|
5261
|
+
/**
|
5262
|
+
* @public
|
5263
|
+
*/
|
5264
|
+
export declare interface PBMeshRenderer_GltfMesh {
|
5265
|
+
/** the GLTF file path as listed in the scene's manifest. */
|
5266
|
+
gltfSrc: string;
|
5267
|
+
/** the name of the mesh asset */
|
5268
|
+
name: string;
|
5269
|
+
}
|
5270
|
+
|
5271
|
+
/**
|
5272
|
+
* @public
|
5273
|
+
*/
|
5274
|
+
export declare namespace PBMeshRenderer_GltfMesh {
|
5275
|
+
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5276
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5277
|
+
}
|
5278
|
+
|
4819
5279
|
/** PlaneMesh renders a 2D rectangular shape. */
|
4820
5280
|
/**
|
4821
5281
|
* @public
|
@@ -5034,6 +5494,30 @@ export declare namespace PBPosition {
|
|
5034
5494
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
|
5035
5495
|
}
|
5036
5496
|
|
5497
|
+
/**
|
5498
|
+
* @public
|
5499
|
+
*/
|
5500
|
+
export declare interface PBPrimaryPointerInfo {
|
5501
|
+
pointerType?: PointerType | undefined;
|
5502
|
+
/** in pixels */
|
5503
|
+
screenCoordinates?: PBVector2 | undefined;
|
5504
|
+
/** in pixels */
|
5505
|
+
screenDelta?: PBVector2 | undefined;
|
5506
|
+
/**
|
5507
|
+
* ray direction that can be used with the primary camera origin for
|
5508
|
+
* raycasting from the cursor into the world
|
5509
|
+
*/
|
5510
|
+
worldRayDirection?: PBVector3 | undefined;
|
5511
|
+
}
|
5512
|
+
|
5513
|
+
/**
|
5514
|
+
* @public
|
5515
|
+
*/
|
5516
|
+
export declare namespace PBPrimaryPointerInfo {
|
5517
|
+
export function encode(message: PBPrimaryPointerInfo, writer?: _m0.Writer): _m0.Writer;
|
5518
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPrimaryPointerInfo;
|
5519
|
+
}
|
5520
|
+
|
5037
5521
|
/**
|
5038
5522
|
* @public
|
5039
5523
|
*/
|
@@ -5155,6 +5639,39 @@ export declare namespace PBRealmInfo {
|
|
5155
5639
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5156
5640
|
}
|
5157
5641
|
|
5642
|
+
/**
|
5643
|
+
* defines a spotlight.
|
5644
|
+
* spotlights are point lights that emit light only in a cone around the transform's forward direction.
|
5645
|
+
* add this component together with the PBLight component to transform a point light into a spotlight.
|
5646
|
+
* note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
|
5647
|
+
* so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
|
5648
|
+
* a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
|
5649
|
+
* and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
|
5650
|
+
*/
|
5651
|
+
/**
|
5652
|
+
* @public
|
5653
|
+
*/
|
5654
|
+
export declare interface PBSpotlight {
|
5655
|
+
/**
|
5656
|
+
* the cone radius in radians. distance away from forward in which the light is visible.
|
5657
|
+
* for a torch a value around 0.15 is appropriate.
|
5658
|
+
*/
|
5659
|
+
angle: number;
|
5660
|
+
/**
|
5661
|
+
* optional angle at which the light is brightest. should be <= outer angle.
|
5662
|
+
* if specified, the light will fall off smoothly between `inner_angle` and `angle`.
|
5663
|
+
*/
|
5664
|
+
innerAngle?: number | undefined;
|
5665
|
+
}
|
5666
|
+
|
5667
|
+
/**
|
5668
|
+
* @public
|
5669
|
+
*/
|
5670
|
+
export declare namespace PBSpotlight {
|
5671
|
+
export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
|
5672
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
|
5673
|
+
}
|
5674
|
+
|
5158
5675
|
/**
|
5159
5676
|
* The TextShape component renders customizable floating text.
|
5160
5677
|
*
|
@@ -5219,6 +5736,40 @@ export declare namespace PBTextShape {
|
|
5219
5736
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5220
5737
|
}
|
5221
5738
|
|
5739
|
+
/**
|
5740
|
+
* @public
|
5741
|
+
*/
|
5742
|
+
export declare interface PBTextureCamera {
|
5743
|
+
/** rendered texture width */
|
5744
|
+
width?: number | undefined;
|
5745
|
+
/** rendered texture height */
|
5746
|
+
height?: number | undefined;
|
5747
|
+
/**
|
5748
|
+
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5749
|
+
* defaults to 0
|
5750
|
+
*/
|
5751
|
+
layer?: number | undefined;
|
5752
|
+
/** default black */
|
5753
|
+
clearColor?: PBColor4 | undefined;
|
5754
|
+
/** default infinity */
|
5755
|
+
farPlane?: number | undefined;
|
5756
|
+
mode?: {
|
5757
|
+
$case: "perspective";
|
5758
|
+
perspective: Perspective;
|
5759
|
+
} | {
|
5760
|
+
$case: "orthographic";
|
5761
|
+
orthographic: Orthographic;
|
5762
|
+
} | undefined;
|
5763
|
+
}
|
5764
|
+
|
5765
|
+
/**
|
5766
|
+
* @public
|
5767
|
+
*/
|
5768
|
+
export declare namespace PBTextureCamera {
|
5769
|
+
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5770
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5771
|
+
}
|
5772
|
+
|
5222
5773
|
/**
|
5223
5774
|
* @public
|
5224
5775
|
*/
|
@@ -5308,6 +5859,25 @@ export declare namespace PBUiBackground {
|
|
5308
5859
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5309
5860
|
}
|
5310
5861
|
|
5862
|
+
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5863
|
+
/**
|
5864
|
+
* @public
|
5865
|
+
*/
|
5866
|
+
export declare interface PBUiCanvas {
|
5867
|
+
width: number;
|
5868
|
+
height: number;
|
5869
|
+
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5870
|
+
color?: PBColor4 | undefined;
|
5871
|
+
}
|
5872
|
+
|
5873
|
+
/**
|
5874
|
+
* @public
|
5875
|
+
*/
|
5876
|
+
export declare namespace PBUiCanvas {
|
5877
|
+
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5878
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5879
|
+
}
|
5880
|
+
|
5311
5881
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5312
5882
|
/**
|
5313
5883
|
* @public
|
@@ -5424,6 +5994,21 @@ export declare namespace PBUiInputResult {
|
|
5424
5994
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5425
5995
|
}
|
5426
5996
|
|
5997
|
+
/**
|
5998
|
+
* @public
|
5999
|
+
*/
|
6000
|
+
export declare interface PBUiScrollResult {
|
6001
|
+
value: PBVector2 | undefined;
|
6002
|
+
}
|
6003
|
+
|
6004
|
+
/**
|
6005
|
+
* @public
|
6006
|
+
*/
|
6007
|
+
export declare namespace PBUiScrollResult {
|
6008
|
+
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
6009
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
6010
|
+
}
|
6011
|
+
|
5427
6012
|
/**
|
5428
6013
|
* @public
|
5429
6014
|
*/
|
@@ -5440,6 +6025,10 @@ export declare interface PBUiText {
|
|
5440
6025
|
fontSize?: number | undefined;
|
5441
6026
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
5442
6027
|
textWrap?: TextWrap | undefined;
|
6028
|
+
/** width of the outline (default: 0) */
|
6029
|
+
outlineWidth?: number | undefined;
|
6030
|
+
/** RGBA color of the outline (default: opaque black) */
|
6031
|
+
outlineColor?: PBColor4 | undefined;
|
5443
6032
|
}
|
5444
6033
|
|
5445
6034
|
/**
|
@@ -5536,6 +6125,16 @@ export declare interface PBUiTransform {
|
|
5536
6125
|
paddingBottom: number;
|
5537
6126
|
/** default: PointerFilterMode.PFM_NONE */
|
5538
6127
|
pointerFilter?: PointerFilterMode | undefined;
|
6128
|
+
/** default: 1 */
|
6129
|
+
opacity?: number | undefined;
|
6130
|
+
/** default empty */
|
6131
|
+
elementId?: string | undefined;
|
6132
|
+
/** default position=(0,0) */
|
6133
|
+
scrollPosition?: ScrollPositionValue | undefined;
|
6134
|
+
/** default ShowScrollBar.SSB_BOTH */
|
6135
|
+
scrollVisible?: ShowScrollBar | undefined;
|
6136
|
+
/** default 0 */
|
6137
|
+
zIndex?: number | undefined;
|
5539
6138
|
}
|
5540
6139
|
|
5541
6140
|
/**
|
@@ -5665,6 +6264,25 @@ export declare namespace PBVisibilityComponent {
|
|
5665
6264
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
5666
6265
|
}
|
5667
6266
|
|
6267
|
+
/**
|
6268
|
+
* @public
|
6269
|
+
*/
|
6270
|
+
export declare interface Perspective {
|
6271
|
+
/**
|
6272
|
+
* vertical field of view in radians
|
6273
|
+
* defaults to pi/4 = 45 degrees
|
6274
|
+
*/
|
6275
|
+
fieldOfView?: number | undefined;
|
6276
|
+
}
|
6277
|
+
|
6278
|
+
/**
|
6279
|
+
* @public
|
6280
|
+
*/
|
6281
|
+
export declare namespace Perspective {
|
6282
|
+
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6283
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6284
|
+
}
|
6285
|
+
|
5668
6286
|
/**
|
5669
6287
|
* Represens a plane by the equation ax + by + cz + d = 0
|
5670
6288
|
* @public
|
@@ -5820,6 +6438,24 @@ export declare interface PointerEventsSystem {
|
|
5820
6438
|
* @param entity - Entity where the callback was attached
|
5821
6439
|
*/
|
5822
6440
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6441
|
+
/**
|
6442
|
+
* @public
|
6443
|
+
* Remove the callback for onPointerDrag event
|
6444
|
+
* @param entity - Entity where the callback was attached
|
6445
|
+
*/
|
6446
|
+
removeOnPointerDrag(entity: Entity): void;
|
6447
|
+
/**
|
6448
|
+
* @public
|
6449
|
+
* Remove the callback for onPointerDragLocked event
|
6450
|
+
* @param entity - Entity where the callback was attached
|
6451
|
+
*/
|
6452
|
+
removeOnPointerDragLocked(entity: Entity): void;
|
6453
|
+
/**
|
6454
|
+
* @public
|
6455
|
+
* Remove the callback for onPointerDragEnd event
|
6456
|
+
* @param entity - Entity where the callback was attached
|
6457
|
+
*/
|
6458
|
+
removeOnPointerDragEnd(entity: Entity): void;
|
5823
6459
|
/**
|
5824
6460
|
* @public
|
5825
6461
|
* Execute callback when the user press the InputButton pointing at the entity
|
@@ -5874,6 +6510,37 @@ export declare interface PointerEventsSystem {
|
|
5874
6510
|
entity: Entity;
|
5875
6511
|
opts?: Partial<EventSystemOptions>;
|
5876
6512
|
}, cb: EventSystemCallback): void;
|
6513
|
+
/**
|
6514
|
+
* @public
|
6515
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6516
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6517
|
+
* @param cb - Function to execute when click fires
|
6518
|
+
*/
|
6519
|
+
onPointerDrag(pointerData: {
|
6520
|
+
entity: Entity;
|
6521
|
+
opts?: Partial<EventSystemOptions>;
|
6522
|
+
}, cb: EventSystemCallback): void;
|
6523
|
+
/**
|
6524
|
+
* @public
|
6525
|
+
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6526
|
+
* locking the cursor in place
|
6527
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6528
|
+
* @param cb - Function to execute when click fires
|
6529
|
+
*/
|
6530
|
+
onPointerDragLocked(pointerData: {
|
6531
|
+
entity: Entity;
|
6532
|
+
opts?: Partial<EventSystemOptions>;
|
6533
|
+
}, cb: EventSystemCallback): void;
|
6534
|
+
/**
|
6535
|
+
* @public
|
6536
|
+
* Execute callback when the user releases the button after a drag
|
6537
|
+
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6538
|
+
* @param cb - Function to execute when click fires
|
6539
|
+
*/
|
6540
|
+
onPointerDragEnd(pointerData: {
|
6541
|
+
entity: Entity;
|
6542
|
+
opts?: Partial<EventSystemOptions>;
|
6543
|
+
}, cb: EventSystemCallback): void;
|
5877
6544
|
}
|
5878
6545
|
|
5879
6546
|
/**
|
@@ -5890,7 +6557,10 @@ export declare const enum PointerEventType {
|
|
5890
6557
|
PET_UP = 0,
|
5891
6558
|
PET_DOWN = 1,
|
5892
6559
|
PET_HOVER_ENTER = 2,
|
5893
|
-
PET_HOVER_LEAVE = 3
|
6560
|
+
PET_HOVER_LEAVE = 3,
|
6561
|
+
PET_DRAG_LOCKED = 4,
|
6562
|
+
PET_DRAG = 5,
|
6563
|
+
PET_DRAG_END = 6
|
5894
6564
|
}
|
5895
6565
|
|
5896
6566
|
/**
|
@@ -5910,6 +6580,17 @@ export declare type PointerFilterType = 'none' | 'block';
|
|
5910
6580
|
/** @public */
|
5911
6581
|
export declare const PointerLock: LastWriteWinElementSetComponentDefinition<PBPointerLock>;
|
5912
6582
|
|
6583
|
+
/**
|
6584
|
+
* @public
|
6585
|
+
*/
|
6586
|
+
export declare const enum PointerType {
|
6587
|
+
POT_NONE = 0,
|
6588
|
+
POT_MOUSE = 1,
|
6589
|
+
POT_PAD = 2,
|
6590
|
+
POT_TOUCH = 3,
|
6591
|
+
POT_WAND = 4
|
6592
|
+
}
|
6593
|
+
|
5913
6594
|
/**
|
5914
6595
|
* Type used for defining the position of the element. i.e. margin, padding
|
5915
6596
|
* @public
|
@@ -5947,6 +6628,9 @@ export declare type PositionType = 'absolute' | 'relative';
|
|
5947
6628
|
*/
|
5948
6629
|
export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
|
5949
6630
|
|
6631
|
+
/** @public */
|
6632
|
+
export declare const PrimaryPointerInfo: LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>;
|
6633
|
+
|
5950
6634
|
export declare enum ProcessMessageResultType {
|
5951
6635
|
/**
|
5952
6636
|
* Typical message and new state set.
|
@@ -6501,6 +7185,7 @@ export declare type RaycastSystemOptions = {
|
|
6501
7185
|
export declare interface ReactBasedUiSystem {
|
6502
7186
|
destroy(): void;
|
6503
7187
|
setUiRenderer(ui: UiComponent): void;
|
7188
|
+
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
6504
7189
|
}
|
6505
7190
|
|
6506
7191
|
/**
|
@@ -6954,6 +7639,43 @@ export declare namespace Schemas {
|
|
6954
7639
|
}) => void;
|
6955
7640
|
}
|
6956
7641
|
|
7642
|
+
/**
|
7643
|
+
* @public
|
7644
|
+
*/
|
7645
|
+
export declare interface ScrollPositionValue {
|
7646
|
+
value?: {
|
7647
|
+
$case: "position";
|
7648
|
+
position: PBVector2;
|
7649
|
+
} | {
|
7650
|
+
$case: "reference";
|
7651
|
+
reference: string;
|
7652
|
+
} | undefined;
|
7653
|
+
}
|
7654
|
+
|
7655
|
+
/**
|
7656
|
+
* @public
|
7657
|
+
*/
|
7658
|
+
export declare namespace ScrollPositionValue {
|
7659
|
+
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7660
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7661
|
+
}
|
7662
|
+
|
7663
|
+
/**
|
7664
|
+
* @public
|
7665
|
+
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7666
|
+
*/
|
7667
|
+
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7668
|
+
|
7669
|
+
/**
|
7670
|
+
* @public
|
7671
|
+
*/
|
7672
|
+
export declare const enum ShowScrollBar {
|
7673
|
+
SSB_BOTH = 0,
|
7674
|
+
SSB_ONLY_VERTICAL = 1,
|
7675
|
+
SSB_ONLY_HORIZONTAL = 2,
|
7676
|
+
SSB_HIDDEN = 3
|
7677
|
+
}
|
7678
|
+
|
6957
7679
|
/**
|
6958
7680
|
* @public
|
6959
7681
|
*/
|
@@ -6961,6 +7683,9 @@ export declare interface Spec {
|
|
6961
7683
|
[key: string]: ISchema;
|
6962
7684
|
}
|
6963
7685
|
|
7686
|
+
/** @public */
|
7687
|
+
export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
|
7688
|
+
|
6964
7689
|
/**
|
6965
7690
|
* @alpha
|
6966
7691
|
* This is going to be used for sync components through a server.
|
@@ -7035,6 +7760,9 @@ export declare namespace Texture {
|
|
7035
7760
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7036
7761
|
}
|
7037
7762
|
|
7763
|
+
/** @public */
|
7764
|
+
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7765
|
+
|
7038
7766
|
/**
|
7039
7767
|
* @public
|
7040
7768
|
*/
|
@@ -7127,6 +7855,9 @@ export declare interface TextureUnion {
|
|
7127
7855
|
} | {
|
7128
7856
|
$case: "videoTexture";
|
7129
7857
|
videoTexture: VideoTexture;
|
7858
|
+
} | {
|
7859
|
+
$case: "uiTexture";
|
7860
|
+
uiTexture: UiCanvasTexture;
|
7130
7861
|
} | undefined;
|
7131
7862
|
}
|
7132
7863
|
|
@@ -7334,6 +8065,8 @@ export declare interface UiBackgroundProps {
|
|
7334
8065
|
uvs?: number[];
|
7335
8066
|
/** AvatarTexture for the background */
|
7336
8067
|
avatarTexture?: UiAvatarTexture;
|
8068
|
+
/** VideoTexture for the background */
|
8069
|
+
videoTexture?: UiVideoTexture;
|
7337
8070
|
/** Texture for the background */
|
7338
8071
|
texture?: UiTexture;
|
7339
8072
|
}
|
@@ -7353,9 +8086,31 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
7353
8086
|
disabled?: boolean;
|
7354
8087
|
}
|
7355
8088
|
|
8089
|
+
/** @public */
|
8090
|
+
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8091
|
+
|
7356
8092
|
/** @public */
|
7357
8093
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
7358
8094
|
|
8095
|
+
/**
|
8096
|
+
* @public
|
8097
|
+
*/
|
8098
|
+
export declare interface UiCanvasTexture {
|
8099
|
+
uiCanvasEntity: number;
|
8100
|
+
/** default = TextureWrapMode.Clamp */
|
8101
|
+
wrapMode?: TextureWrapMode | undefined;
|
8102
|
+
/** default = FilterMode.Bilinear */
|
8103
|
+
filterMode?: TextureFilterMode | undefined;
|
8104
|
+
}
|
8105
|
+
|
8106
|
+
/**
|
8107
|
+
* @public
|
8108
|
+
*/
|
8109
|
+
export declare namespace UiCanvasTexture {
|
8110
|
+
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8111
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8112
|
+
}
|
8113
|
+
|
7359
8114
|
/**
|
7360
8115
|
* @public
|
7361
8116
|
*/
|
@@ -7425,6 +8180,10 @@ export declare interface UiLabelProps {
|
|
7425
8180
|
textAlign?: TextAlignType | undefined;
|
7426
8181
|
/** Label font type. @defaultValue 'sans-serif' */
|
7427
8182
|
font?: UiFontType | undefined;
|
8183
|
+
/** Outline width of the text. @defaultValue 0 */
|
8184
|
+
outlineWidth?: number | undefined;
|
8185
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8186
|
+
outlineColor?: PBColor4 | undefined;
|
7428
8187
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
7429
8188
|
textWrap?: UiTextWrapType | undefined;
|
7430
8189
|
}
|
@@ -7434,6 +8193,9 @@ export declare interface UiLabelProps {
|
|
7434
8193
|
*/
|
7435
8194
|
export declare type uint32 = number;
|
7436
8195
|
|
8196
|
+
/** @public */
|
8197
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8198
|
+
|
7437
8199
|
/** @public */
|
7438
8200
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
7439
8201
|
|
@@ -7506,6 +8268,26 @@ export declare interface UiTransformProps {
|
|
7506
8268
|
overflow?: OverflowType;
|
7507
8269
|
/** 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) **/
|
7508
8270
|
pointerFilter?: PointerFilterType;
|
8271
|
+
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
8272
|
+
opacity?: number;
|
8273
|
+
/** A reference value to identify the element, default empty */
|
8274
|
+
elementId?: string;
|
8275
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8276
|
+
scrollPosition?: PBVector2 | string;
|
8277
|
+
/** default ShowScrollBar.SSB_BOTH */
|
8278
|
+
scrollVisible?: ScrollVisibleType;
|
8279
|
+
/** default 0 */
|
8280
|
+
zIndex?: number;
|
8281
|
+
}
|
8282
|
+
|
8283
|
+
/**
|
8284
|
+
* Texture
|
8285
|
+
* @public
|
8286
|
+
*/
|
8287
|
+
export declare interface UiVideoTexture {
|
8288
|
+
videoPlayerEntity: Entity;
|
8289
|
+
wrapMode?: TextureWrapType;
|
8290
|
+
filterMode?: TextureFilterType;
|
7509
8291
|
}
|
7510
8292
|
|
7511
8293
|
/**
|