@dcl/playground-assets 7.7.10-13859848918.commit-407cb6b → 7.7.10-13947412611.commit-a58a334
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 +9 -809
- package/dist/beta.d.ts +9 -809
- package/dist/index.bundled.d.ts +9 -809
- 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 +9 -809
- package/etc/playground-assets.api.json +2038 -10116
- package/etc/playground-assets.api.md +2 -532
- package/package.json +4 -4
package/dist/alpha.d.ts
CHANGED
@@ -178,32 +178,11 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
|
|
178
178
|
/** @public */
|
179
179
|
export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
|
180
180
|
|
181
|
-
/**
|
182
|
-
* @public
|
183
|
-
*/
|
184
|
-
export declare const enum AvatarControlType {
|
185
|
-
/** CCT_NONE - avatar cannot move */
|
186
|
-
CCT_NONE = 0,
|
187
|
-
/** CCT_RELATIVE - avatar moves relative to the camera origin */
|
188
|
-
CCT_RELATIVE = 1,
|
189
|
-
/** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
|
190
|
-
CCT_TANK = 2
|
191
|
-
}
|
192
|
-
|
193
181
|
/** @public */
|
194
182
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
195
183
|
|
196
|
-
|
197
|
-
|
198
|
-
/**
|
199
|
-
* @public
|
200
|
-
*/
|
201
|
-
export declare interface AvatarEquippedDataComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<AvatarEquippedDataType> {
|
202
|
-
}
|
203
|
-
|
204
|
-
export declare type AvatarEquippedDataType = Omit<PBAvatarEquippedData, 'forceRender'> & {
|
205
|
-
forceRender?: string[] | undefined;
|
206
|
-
};
|
184
|
+
/** @public */
|
185
|
+
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
207
186
|
|
208
187
|
/** @public */
|
209
188
|
export declare const AvatarModifierArea: LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>;
|
@@ -219,48 +198,8 @@ export declare const enum AvatarModifierType {
|
|
219
198
|
AMT_DISABLE_PASSPORTS = 1
|
220
199
|
}
|
221
200
|
|
222
|
-
/**
|
223
|
-
|
224
|
-
*/
|
225
|
-
export declare interface AvatarMovementSettings {
|
226
|
-
controlMode?: AvatarControlType | undefined;
|
227
|
-
/** if not explicitly set, the following properties default to user's preference settings */
|
228
|
-
runSpeed?: number | undefined;
|
229
|
-
/** how fast the player gets up to speed or comes to rest. higher = more responsive */
|
230
|
-
friction?: number | undefined;
|
231
|
-
/** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
|
232
|
-
gravity?: number | undefined;
|
233
|
-
/** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
|
234
|
-
jumpHeight?: number | undefined;
|
235
|
-
/** max fall speed in m/s. should normally be negative */
|
236
|
-
maxFallSpeed?: number | undefined;
|
237
|
-
/** speed the player turns in tank mode, in radians/s */
|
238
|
-
turnSpeed?: number | undefined;
|
239
|
-
/** speed the player walks at, in m/s */
|
240
|
-
walkSpeed?: number | undefined;
|
241
|
-
/** 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 */
|
242
|
-
allowWeightedMovement?: boolean | undefined;
|
243
|
-
}
|
244
|
-
|
245
|
-
/**
|
246
|
-
* @public
|
247
|
-
*/
|
248
|
-
export declare namespace AvatarMovementSettings {
|
249
|
-
export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
|
250
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
251
|
-
}
|
252
|
-
|
253
|
-
export declare const AvatarShape: AvatarShapeComponentDefinitionExtended;
|
254
|
-
|
255
|
-
/**
|
256
|
-
* @public
|
257
|
-
*/
|
258
|
-
export declare interface AvatarShapeComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<AvatarShapeType> {
|
259
|
-
}
|
260
|
-
|
261
|
-
export declare type AvatarShapeType = Omit<PBAvatarShape, 'forceRender'> & {
|
262
|
-
forceRender?: string[] | undefined;
|
263
|
-
};
|
201
|
+
/** @public */
|
202
|
+
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
264
203
|
|
265
204
|
/**
|
266
205
|
* @public
|
@@ -523,12 +462,6 @@ export declare interface ByteBuffer {
|
|
523
462
|
*/
|
524
463
|
export declare type Callback = () => void;
|
525
464
|
|
526
|
-
/** @public */
|
527
|
-
export declare const CameraLayer: LastWriteWinElementSetComponentDefinition<PBCameraLayer>;
|
528
|
-
|
529
|
-
/** @public */
|
530
|
-
export declare const CameraLayers: LastWriteWinElementSetComponentDefinition<PBCameraLayers>;
|
531
|
-
|
532
465
|
/** @public */
|
533
466
|
export declare const CameraMode: LastWriteWinElementSetComponentDefinition<PBCameraMode>;
|
534
467
|
|
@@ -586,39 +519,6 @@ export declare const enum CameraType {
|
|
586
519
|
|
587
520
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
588
521
|
|
589
|
-
/**
|
590
|
-
* @public
|
591
|
-
*/
|
592
|
-
export declare interface CinematicSettings {
|
593
|
-
/** Entity that defines the cinematic camera transform. */
|
594
|
-
cameraEntity: number;
|
595
|
-
/**
|
596
|
-
* Position -> camera's position
|
597
|
-
* Rotation -> camera's direction
|
598
|
-
* scale.z -> zoom level
|
599
|
-
* scale.x and scale.y -> unused
|
600
|
-
*/
|
601
|
-
allowManualRotation?: boolean | undefined;
|
602
|
-
/** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
|
603
|
-
yawRange?: number | undefined;
|
604
|
-
/** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
|
605
|
-
pitchRange?: number | undefined;
|
606
|
-
/** note: cameras can never look up/down further than Vec3::Y */
|
607
|
-
rollRange?: number | undefined;
|
608
|
-
/** minimum zoom level. must be greater than 0. defaults to the input zoom level */
|
609
|
-
zoomMin?: number | undefined;
|
610
|
-
/** maximum zoom level. must be greater than 0. defaults to the input zoom level */
|
611
|
-
zoomMax?: number | undefined;
|
612
|
-
}
|
613
|
-
|
614
|
-
/**
|
615
|
-
* @public
|
616
|
-
*/
|
617
|
-
export declare namespace CinematicSettings {
|
618
|
-
export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
|
619
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
|
620
|
-
}
|
621
|
-
|
622
522
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
623
523
|
/**
|
624
524
|
* @public
|
@@ -1392,18 +1292,12 @@ export declare const componentDefinitionByName: {
|
|
1392
1292
|
"core::AvatarModifierArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarModifierArea>>;
|
1393
1293
|
"core::AvatarShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBAvatarShape>>;
|
1394
1294
|
"core::Billboard": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBBillboard>>;
|
1395
|
-
"core::CameraLayer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayer>>;
|
1396
|
-
"core::CameraLayers": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraLayers>>;
|
1397
1295
|
"core::CameraMode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraMode>>;
|
1398
1296
|
"core::CameraModeArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBCameraModeArea>>;
|
1399
1297
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
1400
|
-
"core::GlobalLight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGlobalLight>>;
|
1401
1298
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
1402
1299
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
1403
|
-
"core::GltfNode": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNode>>;
|
1404
|
-
"core::GltfNodeState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfNodeState>>;
|
1405
1300
|
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
1406
|
-
"core::Light": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBLight>>;
|
1407
1301
|
"core::MainCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMainCamera>>;
|
1408
1302
|
"core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
|
1409
1303
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
@@ -1413,24 +1307,19 @@ export declare const componentDefinitionByName: {
|
|
1413
1307
|
"core::PointerEvents": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerEvents>>;
|
1414
1308
|
"core::PointerEventsResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBPointerEventsResult>>;
|
1415
1309
|
"core::PointerLock": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPointerLock>>;
|
1416
|
-
"core::PrimaryPointerInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>>;
|
1417
1310
|
"core::Raycast": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycast>>;
|
1418
1311
|
"core::RaycastResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRaycastResult>>;
|
1419
1312
|
"core::RealmInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBRealmInfo>>;
|
1420
|
-
"core::Spotlight": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBSpotlight>>;
|
1421
1313
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
1422
|
-
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
1423
1314
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
1424
1315
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
1425
1316
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
1426
1317
|
"core::UiBackground": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiBackground>>;
|
1427
|
-
"core::UiCanvas": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvas>>;
|
1428
1318
|
"core::UiCanvasInformation": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>>;
|
1429
1319
|
"core::UiDropdown": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdown>>;
|
1430
1320
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
1431
1321
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
1432
1322
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
1433
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
1434
1323
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
1435
1324
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
1436
1325
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
@@ -2001,9 +1890,6 @@ export declare type EntityComponents = {
|
|
2001
1890
|
onMouseUp: Callback;
|
2002
1891
|
onMouseEnter: Callback;
|
2003
1892
|
onMouseLeave: Callback;
|
2004
|
-
onMouseDrag: Callback;
|
2005
|
-
onMouseDragLocked: Callback;
|
2006
|
-
onMouseDragEnd: Callback;
|
2007
1893
|
};
|
2008
1894
|
|
2009
1895
|
/** @public */
|
@@ -2155,9 +2041,6 @@ export declare type GlobalDirectionRaycastSystemOptions = {
|
|
2155
2041
|
direction?: PBVector3;
|
2156
2042
|
};
|
2157
2043
|
|
2158
|
-
/** @public */
|
2159
|
-
export declare const GlobalLight: LastWriteWinElementSetComponentDefinition<PBGlobalLight>;
|
2160
|
-
|
2161
2044
|
export declare type GlobalTargetRaycastOptions = RaycastSystemOptions & GlobalTargetRaycastSystemOptions;
|
2162
2045
|
|
2163
2046
|
export declare type GlobalTargetRaycastSystemOptions = {
|
@@ -2170,21 +2053,6 @@ export declare const GltfContainer: LastWriteWinElementSetComponentDefinition<PB
|
|
2170
2053
|
/** @public */
|
2171
2054
|
export declare const GltfContainerLoadingState: LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>;
|
2172
2055
|
|
2173
|
-
/** @public */
|
2174
|
-
export declare const GltfNode: LastWriteWinElementSetComponentDefinition<PBGltfNode>;
|
2175
|
-
|
2176
|
-
/** @public */
|
2177
|
-
export declare const GltfNodeState: LastWriteWinElementSetComponentDefinition<PBGltfNodeState>;
|
2178
|
-
|
2179
|
-
/**
|
2180
|
-
* @public
|
2181
|
-
*/
|
2182
|
-
export declare const enum GltfNodeStateValue {
|
2183
|
-
GNSV_PENDING = 0,
|
2184
|
-
GNSV_FAILED = 1,
|
2185
|
-
GNSV_READY = 2
|
2186
|
-
}
|
2187
|
-
|
2188
2056
|
/**
|
2189
2057
|
* @public
|
2190
2058
|
*/
|
@@ -2788,9 +2656,6 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
2788
2656
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
2789
2657
|
}
|
2790
2658
|
|
2791
|
-
/** @public */
|
2792
|
-
export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
|
2793
|
-
|
2794
2659
|
/**
|
2795
2660
|
* User key event Listeners
|
2796
2661
|
* @public
|
@@ -2804,12 +2669,6 @@ export declare type Listeners = {
|
|
2804
2669
|
onMouseEnter?: Callback;
|
2805
2670
|
/** triggered on mouse leave event */
|
2806
2671
|
onMouseLeave?: Callback;
|
2807
|
-
/** triggered on mouse drag event */
|
2808
|
-
onMouseDrag?: Callback;
|
2809
|
-
/** triggered on mouse drag event */
|
2810
|
-
onMouseDragLocked?: Callback;
|
2811
|
-
/** triggered on mouse drag event */
|
2812
|
-
onMouseDragEnd?: Callback;
|
2813
2672
|
};
|
2814
2673
|
|
2815
2674
|
/**
|
@@ -3678,14 +3537,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3678
3537
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3679
3538
|
*/
|
3680
3539
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3681
|
-
/**
|
3682
|
-
* @public
|
3683
|
-
* Set a gltf internal mesh in the MeshCollider component
|
3684
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3685
|
-
* @param source - the path to the gltf
|
3686
|
-
* @param meshName - the name of the mesh in the gltf
|
3687
|
-
*/
|
3688
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3689
3540
|
}
|
3690
3541
|
|
3691
3542
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3722,14 +3573,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3722
3573
|
* @param entity - entity to create or replace the MeshRenderer component
|
3723
3574
|
*/
|
3724
3575
|
setSphere(entity: Entity): void;
|
3725
|
-
/**
|
3726
|
-
* @public
|
3727
|
-
* Set a gltf internal mesh in the MeshRenderer component
|
3728
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3729
|
-
* @param source - the path to the gltf
|
3730
|
-
* @param meshName - the name of the mesh in the gltf
|
3731
|
-
*/
|
3732
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3733
3576
|
}
|
3734
3577
|
|
3735
3578
|
/**
|
@@ -4142,25 +3985,6 @@ export declare const onVideoEvent: Observable<{
|
|
4142
3985
|
totalVideoLength: number;
|
4143
3986
|
}>;
|
4144
3987
|
|
4145
|
-
/**
|
4146
|
-
* @public
|
4147
|
-
*/
|
4148
|
-
export declare interface Orthographic {
|
4149
|
-
/**
|
4150
|
-
* vertical extent of the visible range in meters
|
4151
|
-
* defaults to 4m
|
4152
|
-
*/
|
4153
|
-
verticalRange?: number | undefined;
|
4154
|
-
}
|
4155
|
-
|
4156
|
-
/**
|
4157
|
-
* @public
|
4158
|
-
*/
|
4159
|
-
export declare namespace Orthographic {
|
4160
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4161
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4162
|
-
}
|
4163
|
-
|
4164
3988
|
/**
|
4165
3989
|
* @public
|
4166
3990
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4387,8 +4211,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
4387
4211
|
export declare interface PBAvatarEquippedData {
|
4388
4212
|
wearableUrns: string[];
|
4389
4213
|
emoteUrns: string[];
|
4390
|
-
/** slots that will render even if hidden */
|
4391
|
-
forceRender: string[];
|
4392
4214
|
}
|
4393
4215
|
|
4394
4216
|
/**
|
@@ -4423,9 +4245,6 @@ export declare interface PBAvatarModifierArea {
|
|
4423
4245
|
excludeIds: string[];
|
4424
4246
|
/** list of modifiers to apply */
|
4425
4247
|
modifiers: AvatarModifierType[];
|
4426
|
-
movementSettings?: AvatarMovementSettings | undefined;
|
4427
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4428
|
-
useColliderRange?: boolean | undefined;
|
4429
4248
|
}
|
4430
4249
|
|
4431
4250
|
/**
|
@@ -4482,8 +4301,6 @@ export declare interface PBAvatarShape {
|
|
4482
4301
|
wearables: string[];
|
4483
4302
|
/** available emotes (default empty) */
|
4484
4303
|
emotes: string[];
|
4485
|
-
/** slots that will render even if hidden */
|
4486
|
-
forceRender: string[];
|
4487
4304
|
}
|
4488
4305
|
|
4489
4306
|
/**
|
@@ -4518,51 +4335,6 @@ export declare namespace PBBillboard {
|
|
4518
4335
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4519
4336
|
}
|
4520
4337
|
|
4521
|
-
/**
|
4522
|
-
* @public
|
4523
|
-
*/
|
4524
|
-
export declare interface PBCameraLayer {
|
4525
|
-
/**
|
4526
|
-
* layer to which these settings apply. must be > 0
|
4527
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4528
|
-
*/
|
4529
|
-
layer: number;
|
4530
|
-
/** should the sun light affect this layer? default false */
|
4531
|
-
directionalLight?: boolean | undefined;
|
4532
|
-
/** should this layer show player avatars? default false */
|
4533
|
-
showAvatars?: boolean | undefined;
|
4534
|
-
/** should this layer show the sky? default false */
|
4535
|
-
showSkybox?: boolean | undefined;
|
4536
|
-
/** should this layer show distance fog? default false */
|
4537
|
-
showFog?: boolean | undefined;
|
4538
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
4539
|
-
ambientColorOverride?: PBColor3 | undefined;
|
4540
|
-
ambientBrightnessOverride?: number | undefined;
|
4541
|
-
}
|
4542
|
-
|
4543
|
-
/**
|
4544
|
-
* @public
|
4545
|
-
*/
|
4546
|
-
export declare namespace PBCameraLayer {
|
4547
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4548
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4549
|
-
}
|
4550
|
-
|
4551
|
-
/**
|
4552
|
-
* @public
|
4553
|
-
*/
|
4554
|
-
export declare interface PBCameraLayers {
|
4555
|
-
layers: number[];
|
4556
|
-
}
|
4557
|
-
|
4558
|
-
/**
|
4559
|
-
* @public
|
4560
|
-
*/
|
4561
|
-
export declare namespace PBCameraLayers {
|
4562
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4563
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4564
|
-
}
|
4565
|
-
|
4566
4338
|
/**
|
4567
4339
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4568
4340
|
* third-person view.
|
@@ -4585,7 +4357,7 @@ export declare namespace PBCameraMode {
|
|
4585
4357
|
|
4586
4358
|
/**
|
4587
4359
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4588
|
-
* the player's camera mode (1st-person
|
4360
|
+
* the player's camera mode (1st-person or 3rd-person) is overridden.
|
4589
4361
|
*
|
4590
4362
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4591
4363
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4595,8 +4367,6 @@ export declare namespace PBCameraMode {
|
|
4595
4367
|
*
|
4596
4368
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4597
4369
|
* is actually a 3D volume.
|
4598
|
-
*
|
4599
|
-
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4600
4370
|
*/
|
4601
4371
|
/**
|
4602
4372
|
* @public
|
@@ -4606,9 +4376,6 @@ export declare interface PBCameraModeArea {
|
|
4606
4376
|
area: PBVector3 | undefined;
|
4607
4377
|
/** the camera mode to enforce */
|
4608
4378
|
mode: CameraType;
|
4609
|
-
cinematicSettings?: CinematicSettings | undefined;
|
4610
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4611
|
-
useColliderRange?: boolean | undefined;
|
4612
4379
|
}
|
4613
4380
|
|
4614
4381
|
/**
|
@@ -4680,39 +4447,6 @@ export declare namespace PBEngineInfo {
|
|
4680
4447
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4681
4448
|
}
|
4682
4449
|
|
4683
|
-
/**
|
4684
|
-
* defines the global scene light settings. must be added to the scene root.
|
4685
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4686
|
-
*/
|
4687
|
-
/**
|
4688
|
-
* @public
|
4689
|
-
*/
|
4690
|
-
export declare interface PBGlobalLight {
|
4691
|
-
/**
|
4692
|
-
* the direction the directional light shines in.
|
4693
|
-
* default depends on time of day and explorer implementation
|
4694
|
-
*/
|
4695
|
-
direction?: PBVector3 | undefined;
|
4696
|
-
/**
|
4697
|
-
* ambient light color
|
4698
|
-
* default: White
|
4699
|
-
*/
|
4700
|
-
ambientColor?: PBColor3 | undefined;
|
4701
|
-
/**
|
4702
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4703
|
-
* default 1
|
4704
|
-
*/
|
4705
|
-
ambientBrightness?: number | undefined;
|
4706
|
-
}
|
4707
|
-
|
4708
|
-
/**
|
4709
|
-
* @public
|
4710
|
-
*/
|
4711
|
-
export declare namespace PBGlobalLight {
|
4712
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4713
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4714
|
-
}
|
4715
|
-
|
4716
4450
|
/**
|
4717
4451
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4718
4452
|
*
|
@@ -4748,25 +4482,6 @@ export declare namespace PBGltfContainer {
|
|
4748
4482
|
*/
|
4749
4483
|
export declare interface PBGltfContainerLoadingState {
|
4750
4484
|
currentState: LoadingState;
|
4751
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4752
|
-
nodePaths: string[];
|
4753
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4754
|
-
meshNames: string[];
|
4755
|
-
/**
|
4756
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4757
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4758
|
-
*/
|
4759
|
-
materialNames: string[];
|
4760
|
-
/**
|
4761
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4762
|
-
* sure all your materials are explicitly named.
|
4763
|
-
*/
|
4764
|
-
skinNames: string[];
|
4765
|
-
/**
|
4766
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4767
|
-
* your skins are explicitly named.
|
4768
|
-
*/
|
4769
|
-
animationNames: string[];
|
4770
4485
|
}
|
4771
4486
|
|
4772
4487
|
/**
|
@@ -4777,77 +4492,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4777
4492
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4778
4493
|
}
|
4779
4494
|
|
4780
|
-
/**
|
4781
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4782
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4783
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4784
|
-
* in the parent.
|
4785
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4786
|
-
*
|
4787
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4788
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4789
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4790
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4791
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4792
|
-
*
|
4793
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4794
|
-
*
|
4795
|
-
* From the scene, you can modify various components to alter the gltf node:
|
4796
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4797
|
-
* regardless of any intermediate gltf node hierarchy.
|
4798
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4799
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4800
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4801
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4802
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4803
|
-
* 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
|
4804
|
-
* PBMaterial will be maintained.
|
4805
|
-
*
|
4806
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4807
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4808
|
-
* change the state to `GNS_FAILED`.
|
4809
|
-
* - deleting the scene entity will not delete the gltf node.
|
4810
|
-
*
|
4811
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4812
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4813
|
-
* the gltf node will also be displayed.
|
4814
|
-
*/
|
4815
|
-
/**
|
4816
|
-
* @public
|
4817
|
-
*/
|
4818
|
-
export declare interface PBGltfNode {
|
4819
|
-
/** the path of the target node in the Gltf. */
|
4820
|
-
path: string;
|
4821
|
-
}
|
4822
|
-
|
4823
|
-
/**
|
4824
|
-
* @public
|
4825
|
-
*/
|
4826
|
-
export declare namespace PBGltfNode {
|
4827
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4828
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4829
|
-
}
|
4830
|
-
|
4831
|
-
/**
|
4832
|
-
* The state of a linked gltf node.
|
4833
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4834
|
-
*/
|
4835
|
-
/**
|
4836
|
-
* @public
|
4837
|
-
*/
|
4838
|
-
export declare interface PBGltfNodeState {
|
4839
|
-
state: GltfNodeStateValue;
|
4840
|
-
error?: string | undefined;
|
4841
|
-
}
|
4842
|
-
|
4843
|
-
/**
|
4844
|
-
* @public
|
4845
|
-
*/
|
4846
|
-
export declare namespace PBGltfNodeState {
|
4847
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4848
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4849
|
-
}
|
4850
|
-
|
4851
4495
|
/**
|
4852
4496
|
* @public
|
4853
4497
|
*/
|
@@ -4887,62 +4531,6 @@ export declare namespace PBInputModifier_StandardInput {
|
|
4887
4531
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4888
4532
|
}
|
4889
4533
|
|
4890
|
-
/**
|
4891
|
-
* defines a light source.
|
4892
|
-
* the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
|
4893
|
-
* a PBGlobalLight component can also be added to the root to control the directional light direction.
|
4894
|
-
* point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
|
4895
|
-
*/
|
4896
|
-
/**
|
4897
|
-
* @public
|
4898
|
-
*/
|
4899
|
-
export declare interface PBLight {
|
4900
|
-
/**
|
4901
|
-
* whether the light is on
|
4902
|
-
* default true
|
4903
|
-
*/
|
4904
|
-
enabled?: boolean | undefined;
|
4905
|
-
/**
|
4906
|
-
* light brightness in lux (lumens/m^2).
|
4907
|
-
*
|
4908
|
-
* 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).
|
4909
|
-
* the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
|
4910
|
-
* for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
|
4911
|
-
*
|
4912
|
-
* for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
|
4913
|
-
* divide lumens by ~12 (4*pi).
|
4914
|
-
* e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
|
4915
|
-
* a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
|
4916
|
-
*
|
4917
|
-
* default
|
4918
|
-
* for point/spotlights: 10,000
|
4919
|
-
* for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
|
4920
|
-
*/
|
4921
|
-
illuminance?: number | undefined;
|
4922
|
-
/**
|
4923
|
-
* whether the light should cast shadows.
|
4924
|
-
* note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
|
4925
|
-
* of lights depending on the implementation, platform, and user settings.
|
4926
|
-
* default
|
4927
|
-
* for point/spotlights: false / off
|
4928
|
-
* for global directional light: true / on
|
4929
|
-
*/
|
4930
|
-
shadows?: boolean | undefined;
|
4931
|
-
/**
|
4932
|
-
* light color
|
4933
|
-
* default White
|
4934
|
-
*/
|
4935
|
-
color?: PBColor3 | undefined;
|
4936
|
-
}
|
4937
|
-
|
4938
|
-
/**
|
4939
|
-
* @public
|
4940
|
-
*/
|
4941
|
-
export declare namespace PBLight {
|
4942
|
-
export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
|
4943
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
|
4944
|
-
}
|
4945
|
-
|
4946
4534
|
/**
|
4947
4535
|
* PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
|
4948
4536
|
* This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
|
@@ -4974,14 +4562,6 @@ export declare interface PBMaterial {
|
|
4974
4562
|
$case: "pbr";
|
4975
4563
|
pbr: PBMaterial_PbrMaterial;
|
4976
4564
|
} | undefined;
|
4977
|
-
/**
|
4978
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
4979
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
4980
|
-
* supported by the PbMaterial.
|
4981
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
4982
|
-
* field with data that reflects the gltf material once it is loaded.
|
4983
|
-
*/
|
4984
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
4985
4565
|
}
|
4986
4566
|
|
4987
4567
|
/**
|
@@ -4992,22 +4572,6 @@ export declare namespace PBMaterial {
|
|
4992
4572
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4993
4573
|
}
|
4994
4574
|
|
4995
|
-
/**
|
4996
|
-
* @public
|
4997
|
-
*/
|
4998
|
-
export declare interface PBMaterial_GltfMaterial {
|
4999
|
-
gltfSrc: string;
|
5000
|
-
name: string;
|
5001
|
-
}
|
5002
|
-
|
5003
|
-
/**
|
5004
|
-
* @public
|
5005
|
-
*/
|
5006
|
-
export declare namespace PBMaterial_GltfMaterial {
|
5007
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
5008
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
5009
|
-
}
|
5010
|
-
|
5011
4575
|
/**
|
5012
4576
|
* @public
|
5013
4577
|
*/
|
@@ -5104,9 +4668,6 @@ export declare interface PBMeshCollider {
|
|
5104
4668
|
} | {
|
5105
4669
|
$case: "plane";
|
5106
4670
|
plane: PBMeshCollider_PlaneMesh;
|
5107
|
-
} | {
|
5108
|
-
$case: "gltf";
|
5109
|
-
gltf: PBMeshCollider_GltfMesh;
|
5110
4671
|
} | undefined;
|
5111
4672
|
}
|
5112
4673
|
|
@@ -5152,25 +4713,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
5152
4713
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
5153
4714
|
}
|
5154
4715
|
|
5155
|
-
/** A collider constructed from a Gltf Mesh. */
|
5156
|
-
/**
|
5157
|
-
* @public
|
5158
|
-
*/
|
5159
|
-
export declare interface PBMeshCollider_GltfMesh {
|
5160
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5161
|
-
gltfSrc: string;
|
5162
|
-
/** the name of the mesh asset */
|
5163
|
-
name: string;
|
5164
|
-
}
|
5165
|
-
|
5166
|
-
/**
|
5167
|
-
* @public
|
5168
|
-
*/
|
5169
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
5170
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5171
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5172
|
-
}
|
5173
|
-
|
5174
4716
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
5175
4717
|
/**
|
5176
4718
|
* @public
|
@@ -5203,11 +4745,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
5203
4745
|
|
5204
4746
|
/**
|
5205
4747
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
5206
|
-
* plane, a sphere
|
4748
|
+
* plane, a sphere or a cylinder.
|
5207
4749
|
*
|
5208
4750
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
5209
4751
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
5210
4752
|
* `float` coordinates, one for each corner of each side of each face.
|
4753
|
+
*
|
4754
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
5211
4755
|
*/
|
5212
4756
|
/**
|
5213
4757
|
* @public
|
@@ -5225,9 +4769,6 @@ export declare interface PBMeshRenderer {
|
|
5225
4769
|
} | {
|
5226
4770
|
$case: "plane";
|
5227
4771
|
plane: PBMeshRenderer_PlaneMesh;
|
5228
|
-
} | {
|
5229
|
-
$case: "gltf";
|
5230
|
-
gltf: PBMeshRenderer_GltfMesh;
|
5231
4772
|
} | undefined;
|
5232
4773
|
}
|
5233
4774
|
|
@@ -5275,25 +4816,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
5275
4816
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
5276
4817
|
}
|
5277
4818
|
|
5278
|
-
/** A mesh from a Gltf. */
|
5279
|
-
/**
|
5280
|
-
* @public
|
5281
|
-
*/
|
5282
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
5283
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5284
|
-
gltfSrc: string;
|
5285
|
-
/** the name of the mesh asset */
|
5286
|
-
name: string;
|
5287
|
-
}
|
5288
|
-
|
5289
|
-
/**
|
5290
|
-
* @public
|
5291
|
-
*/
|
5292
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
5293
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5294
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5295
|
-
}
|
5296
|
-
|
5297
4819
|
/** PlaneMesh renders a 2D rectangular shape. */
|
5298
4820
|
/**
|
5299
4821
|
* @public
|
@@ -5512,30 +5034,6 @@ export declare namespace PBPosition {
|
|
5512
5034
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
|
5513
5035
|
}
|
5514
5036
|
|
5515
|
-
/**
|
5516
|
-
* @public
|
5517
|
-
*/
|
5518
|
-
export declare interface PBPrimaryPointerInfo {
|
5519
|
-
pointerType?: PointerType | undefined;
|
5520
|
-
/** in pixels */
|
5521
|
-
screenCoordinates?: PBVector2 | undefined;
|
5522
|
-
/** in pixels */
|
5523
|
-
screenDelta?: PBVector2 | undefined;
|
5524
|
-
/**
|
5525
|
-
* ray direction that can be used with the primary camera origin for
|
5526
|
-
* raycasting from the cursor into the world
|
5527
|
-
*/
|
5528
|
-
worldRayDirection?: PBVector3 | undefined;
|
5529
|
-
}
|
5530
|
-
|
5531
|
-
/**
|
5532
|
-
* @public
|
5533
|
-
*/
|
5534
|
-
export declare namespace PBPrimaryPointerInfo {
|
5535
|
-
export function encode(message: PBPrimaryPointerInfo, writer?: _m0.Writer): _m0.Writer;
|
5536
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPrimaryPointerInfo;
|
5537
|
-
}
|
5538
|
-
|
5539
5037
|
/**
|
5540
5038
|
* @public
|
5541
5039
|
*/
|
@@ -5657,39 +5155,6 @@ export declare namespace PBRealmInfo {
|
|
5657
5155
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5658
5156
|
}
|
5659
5157
|
|
5660
|
-
/**
|
5661
|
-
* defines a spotlight.
|
5662
|
-
* spotlights are point lights that emit light only in a cone around the transform's forward direction.
|
5663
|
-
* add this component together with the PBLight component to transform a point light into a spotlight.
|
5664
|
-
* note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
|
5665
|
-
* so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
|
5666
|
-
* a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
|
5667
|
-
* and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
|
5668
|
-
*/
|
5669
|
-
/**
|
5670
|
-
* @public
|
5671
|
-
*/
|
5672
|
-
export declare interface PBSpotlight {
|
5673
|
-
/**
|
5674
|
-
* the cone radius in radians. distance away from forward in which the light is visible.
|
5675
|
-
* for a torch a value around 0.15 is appropriate.
|
5676
|
-
*/
|
5677
|
-
angle: number;
|
5678
|
-
/**
|
5679
|
-
* optional angle at which the light is brightest. should be <= outer angle.
|
5680
|
-
* if specified, the light will fall off smoothly between `inner_angle` and `angle`.
|
5681
|
-
*/
|
5682
|
-
innerAngle?: number | undefined;
|
5683
|
-
}
|
5684
|
-
|
5685
|
-
/**
|
5686
|
-
* @public
|
5687
|
-
*/
|
5688
|
-
export declare namespace PBSpotlight {
|
5689
|
-
export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
|
5690
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
|
5691
|
-
}
|
5692
|
-
|
5693
5158
|
/**
|
5694
5159
|
* The TextShape component renders customizable floating text.
|
5695
5160
|
*
|
@@ -5754,40 +5219,6 @@ export declare namespace PBTextShape {
|
|
5754
5219
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5755
5220
|
}
|
5756
5221
|
|
5757
|
-
/**
|
5758
|
-
* @public
|
5759
|
-
*/
|
5760
|
-
export declare interface PBTextureCamera {
|
5761
|
-
/** rendered texture width */
|
5762
|
-
width?: number | undefined;
|
5763
|
-
/** rendered texture height */
|
5764
|
-
height?: number | undefined;
|
5765
|
-
/**
|
5766
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5767
|
-
* defaults to 0
|
5768
|
-
*/
|
5769
|
-
layer?: number | undefined;
|
5770
|
-
/** default black */
|
5771
|
-
clearColor?: PBColor4 | undefined;
|
5772
|
-
/** default infinity */
|
5773
|
-
farPlane?: number | undefined;
|
5774
|
-
mode?: {
|
5775
|
-
$case: "perspective";
|
5776
|
-
perspective: Perspective;
|
5777
|
-
} | {
|
5778
|
-
$case: "orthographic";
|
5779
|
-
orthographic: Orthographic;
|
5780
|
-
} | undefined;
|
5781
|
-
}
|
5782
|
-
|
5783
|
-
/**
|
5784
|
-
* @public
|
5785
|
-
*/
|
5786
|
-
export declare namespace PBTextureCamera {
|
5787
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5788
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5789
|
-
}
|
5790
|
-
|
5791
5222
|
/**
|
5792
5223
|
* @public
|
5793
5224
|
*/
|
@@ -5877,25 +5308,6 @@ export declare namespace PBUiBackground {
|
|
5877
5308
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5878
5309
|
}
|
5879
5310
|
|
5880
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5881
|
-
/**
|
5882
|
-
* @public
|
5883
|
-
*/
|
5884
|
-
export declare interface PBUiCanvas {
|
5885
|
-
width: number;
|
5886
|
-
height: number;
|
5887
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5888
|
-
color?: PBColor4 | undefined;
|
5889
|
-
}
|
5890
|
-
|
5891
|
-
/**
|
5892
|
-
* @public
|
5893
|
-
*/
|
5894
|
-
export declare namespace PBUiCanvas {
|
5895
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5896
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5897
|
-
}
|
5898
|
-
|
5899
5311
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5900
5312
|
/**
|
5901
5313
|
* @public
|
@@ -6012,21 +5424,6 @@ export declare namespace PBUiInputResult {
|
|
6012
5424
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
6013
5425
|
}
|
6014
5426
|
|
6015
|
-
/**
|
6016
|
-
* @public
|
6017
|
-
*/
|
6018
|
-
export declare interface PBUiScrollResult {
|
6019
|
-
value: PBVector2 | undefined;
|
6020
|
-
}
|
6021
|
-
|
6022
|
-
/**
|
6023
|
-
* @public
|
6024
|
-
*/
|
6025
|
-
export declare namespace PBUiScrollResult {
|
6026
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
6027
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
6028
|
-
}
|
6029
|
-
|
6030
5427
|
/**
|
6031
5428
|
* @public
|
6032
5429
|
*/
|
@@ -6043,10 +5440,6 @@ export declare interface PBUiText {
|
|
6043
5440
|
fontSize?: number | undefined;
|
6044
5441
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
6045
5442
|
textWrap?: TextWrap | undefined;
|
6046
|
-
/** width of the outline (default: 0) */
|
6047
|
-
outlineWidth?: number | undefined;
|
6048
|
-
/** RGBA color of the outline (default: opaque black) */
|
6049
|
-
outlineColor?: PBColor4 | undefined;
|
6050
5443
|
}
|
6051
5444
|
|
6052
5445
|
/**
|
@@ -6143,16 +5536,6 @@ export declare interface PBUiTransform {
|
|
6143
5536
|
paddingBottom: number;
|
6144
5537
|
/** default: PointerFilterMode.PFM_NONE */
|
6145
5538
|
pointerFilter?: PointerFilterMode | undefined;
|
6146
|
-
/** default: 1 */
|
6147
|
-
opacity?: number | undefined;
|
6148
|
-
/** default empty */
|
6149
|
-
elementId?: string | undefined;
|
6150
|
-
/** default position=(0,0) */
|
6151
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
6152
|
-
/** default ShowScrollBar.SSB_BOTH */
|
6153
|
-
scrollVisible?: ShowScrollBar | undefined;
|
6154
|
-
/** default 0 */
|
6155
|
-
zIndex?: number | undefined;
|
6156
5539
|
}
|
6157
5540
|
|
6158
5541
|
/**
|
@@ -6282,25 +5665,6 @@ export declare namespace PBVisibilityComponent {
|
|
6282
5665
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
6283
5666
|
}
|
6284
5667
|
|
6285
|
-
/**
|
6286
|
-
* @public
|
6287
|
-
*/
|
6288
|
-
export declare interface Perspective {
|
6289
|
-
/**
|
6290
|
-
* vertical field of view in radians
|
6291
|
-
* defaults to pi/4 = 45 degrees
|
6292
|
-
*/
|
6293
|
-
fieldOfView?: number | undefined;
|
6294
|
-
}
|
6295
|
-
|
6296
|
-
/**
|
6297
|
-
* @public
|
6298
|
-
*/
|
6299
|
-
export declare namespace Perspective {
|
6300
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6301
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6302
|
-
}
|
6303
|
-
|
6304
5668
|
/**
|
6305
5669
|
* Represens a plane by the equation ax + by + cz + d = 0
|
6306
5670
|
* @public
|
@@ -6456,24 +5820,6 @@ export declare interface PointerEventsSystem {
|
|
6456
5820
|
* @param entity - Entity where the callback was attached
|
6457
5821
|
*/
|
6458
5822
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6459
|
-
/**
|
6460
|
-
* @public
|
6461
|
-
* Remove the callback for onPointerDrag event
|
6462
|
-
* @param entity - Entity where the callback was attached
|
6463
|
-
*/
|
6464
|
-
removeOnPointerDrag(entity: Entity): void;
|
6465
|
-
/**
|
6466
|
-
* @public
|
6467
|
-
* Remove the callback for onPointerDragLocked event
|
6468
|
-
* @param entity - Entity where the callback was attached
|
6469
|
-
*/
|
6470
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
6471
|
-
/**
|
6472
|
-
* @public
|
6473
|
-
* Remove the callback for onPointerDragEnd event
|
6474
|
-
* @param entity - Entity where the callback was attached
|
6475
|
-
*/
|
6476
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
6477
5823
|
/**
|
6478
5824
|
* @public
|
6479
5825
|
* Execute callback when the user press the InputButton pointing at the entity
|
@@ -6528,37 +5874,6 @@ export declare interface PointerEventsSystem {
|
|
6528
5874
|
entity: Entity;
|
6529
5875
|
opts?: Partial<EventSystemOptions>;
|
6530
5876
|
}, cb: EventSystemCallback): void;
|
6531
|
-
/**
|
6532
|
-
* @public
|
6533
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6534
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6535
|
-
* @param cb - Function to execute when click fires
|
6536
|
-
*/
|
6537
|
-
onPointerDrag(pointerData: {
|
6538
|
-
entity: Entity;
|
6539
|
-
opts?: Partial<EventSystemOptions>;
|
6540
|
-
}, cb: EventSystemCallback): void;
|
6541
|
-
/**
|
6542
|
-
* @public
|
6543
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6544
|
-
* locking the cursor in place
|
6545
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6546
|
-
* @param cb - Function to execute when click fires
|
6547
|
-
*/
|
6548
|
-
onPointerDragLocked(pointerData: {
|
6549
|
-
entity: Entity;
|
6550
|
-
opts?: Partial<EventSystemOptions>;
|
6551
|
-
}, cb: EventSystemCallback): void;
|
6552
|
-
/**
|
6553
|
-
* @public
|
6554
|
-
* Execute callback when the user releases the button after a drag
|
6555
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6556
|
-
* @param cb - Function to execute when click fires
|
6557
|
-
*/
|
6558
|
-
onPointerDragEnd(pointerData: {
|
6559
|
-
entity: Entity;
|
6560
|
-
opts?: Partial<EventSystemOptions>;
|
6561
|
-
}, cb: EventSystemCallback): void;
|
6562
5877
|
}
|
6563
5878
|
|
6564
5879
|
/**
|
@@ -6575,10 +5890,7 @@ export declare const enum PointerEventType {
|
|
6575
5890
|
PET_UP = 0,
|
6576
5891
|
PET_DOWN = 1,
|
6577
5892
|
PET_HOVER_ENTER = 2,
|
6578
|
-
PET_HOVER_LEAVE = 3
|
6579
|
-
PET_DRAG_LOCKED = 4,
|
6580
|
-
PET_DRAG = 5,
|
6581
|
-
PET_DRAG_END = 6
|
5893
|
+
PET_HOVER_LEAVE = 3
|
6582
5894
|
}
|
6583
5895
|
|
6584
5896
|
/**
|
@@ -6598,17 +5910,6 @@ export declare type PointerFilterType = 'none' | 'block';
|
|
6598
5910
|
/** @public */
|
6599
5911
|
export declare const PointerLock: LastWriteWinElementSetComponentDefinition<PBPointerLock>;
|
6600
5912
|
|
6601
|
-
/**
|
6602
|
-
* @public
|
6603
|
-
*/
|
6604
|
-
export declare const enum PointerType {
|
6605
|
-
POT_NONE = 0,
|
6606
|
-
POT_MOUSE = 1,
|
6607
|
-
POT_PAD = 2,
|
6608
|
-
POT_TOUCH = 3,
|
6609
|
-
POT_WAND = 4
|
6610
|
-
}
|
6611
|
-
|
6612
5913
|
/**
|
6613
5914
|
* Type used for defining the position of the element. i.e. margin, padding
|
6614
5915
|
* @public
|
@@ -6646,9 +5947,6 @@ export declare type PositionType = 'absolute' | 'relative';
|
|
6646
5947
|
*/
|
6647
5948
|
export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
|
6648
5949
|
|
6649
|
-
/** @public */
|
6650
|
-
export declare const PrimaryPointerInfo: LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>;
|
6651
|
-
|
6652
5950
|
export declare enum ProcessMessageResultType {
|
6653
5951
|
/**
|
6654
5952
|
* Typical message and new state set.
|
@@ -7203,7 +6501,6 @@ export declare type RaycastSystemOptions = {
|
|
7203
6501
|
export declare interface ReactBasedUiSystem {
|
7204
6502
|
destroy(): void;
|
7205
6503
|
setUiRenderer(ui: UiComponent): void;
|
7206
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
7207
6504
|
}
|
7208
6505
|
|
7209
6506
|
/**
|
@@ -7657,43 +6954,6 @@ export declare namespace Schemas {
|
|
7657
6954
|
}) => void;
|
7658
6955
|
}
|
7659
6956
|
|
7660
|
-
/**
|
7661
|
-
* @public
|
7662
|
-
*/
|
7663
|
-
export declare interface ScrollPositionValue {
|
7664
|
-
value?: {
|
7665
|
-
$case: "position";
|
7666
|
-
position: PBVector2;
|
7667
|
-
} | {
|
7668
|
-
$case: "reference";
|
7669
|
-
reference: string;
|
7670
|
-
} | undefined;
|
7671
|
-
}
|
7672
|
-
|
7673
|
-
/**
|
7674
|
-
* @public
|
7675
|
-
*/
|
7676
|
-
export declare namespace ScrollPositionValue {
|
7677
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7678
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7679
|
-
}
|
7680
|
-
|
7681
|
-
/**
|
7682
|
-
* @public
|
7683
|
-
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7684
|
-
*/
|
7685
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7686
|
-
|
7687
|
-
/**
|
7688
|
-
* @public
|
7689
|
-
*/
|
7690
|
-
export declare const enum ShowScrollBar {
|
7691
|
-
SSB_BOTH = 0,
|
7692
|
-
SSB_ONLY_VERTICAL = 1,
|
7693
|
-
SSB_ONLY_HORIZONTAL = 2,
|
7694
|
-
SSB_HIDDEN = 3
|
7695
|
-
}
|
7696
|
-
|
7697
6957
|
/**
|
7698
6958
|
* @public
|
7699
6959
|
*/
|
@@ -7701,9 +6961,6 @@ export declare interface Spec {
|
|
7701
6961
|
[key: string]: ISchema;
|
7702
6962
|
}
|
7703
6963
|
|
7704
|
-
/** @public */
|
7705
|
-
export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
|
7706
|
-
|
7707
6964
|
/**
|
7708
6965
|
* @alpha
|
7709
6966
|
* This is going to be used for sync components through a server.
|
@@ -7778,9 +7035,6 @@ export declare namespace Texture {
|
|
7778
7035
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7779
7036
|
}
|
7780
7037
|
|
7781
|
-
/** @public */
|
7782
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7783
|
-
|
7784
7038
|
/**
|
7785
7039
|
* @public
|
7786
7040
|
*/
|
@@ -7873,9 +7127,6 @@ export declare interface TextureUnion {
|
|
7873
7127
|
} | {
|
7874
7128
|
$case: "videoTexture";
|
7875
7129
|
videoTexture: VideoTexture;
|
7876
|
-
} | {
|
7877
|
-
$case: "uiTexture";
|
7878
|
-
uiTexture: UiCanvasTexture;
|
7879
7130
|
} | undefined;
|
7880
7131
|
}
|
7881
7132
|
|
@@ -8083,8 +7334,6 @@ export declare interface UiBackgroundProps {
|
|
8083
7334
|
uvs?: number[];
|
8084
7335
|
/** AvatarTexture for the background */
|
8085
7336
|
avatarTexture?: UiAvatarTexture;
|
8086
|
-
/** VideoTexture for the background */
|
8087
|
-
videoTexture?: UiVideoTexture;
|
8088
7337
|
/** Texture for the background */
|
8089
7338
|
texture?: UiTexture;
|
8090
7339
|
}
|
@@ -8104,31 +7353,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
8104
7353
|
disabled?: boolean;
|
8105
7354
|
}
|
8106
7355
|
|
8107
|
-
/** @public */
|
8108
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8109
|
-
|
8110
7356
|
/** @public */
|
8111
7357
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
8112
7358
|
|
8113
|
-
/**
|
8114
|
-
* @public
|
8115
|
-
*/
|
8116
|
-
export declare interface UiCanvasTexture {
|
8117
|
-
uiCanvasEntity: number;
|
8118
|
-
/** default = TextureWrapMode.Clamp */
|
8119
|
-
wrapMode?: TextureWrapMode | undefined;
|
8120
|
-
/** default = FilterMode.Bilinear */
|
8121
|
-
filterMode?: TextureFilterMode | undefined;
|
8122
|
-
}
|
8123
|
-
|
8124
|
-
/**
|
8125
|
-
* @public
|
8126
|
-
*/
|
8127
|
-
export declare namespace UiCanvasTexture {
|
8128
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8129
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8130
|
-
}
|
8131
|
-
|
8132
7359
|
/**
|
8133
7360
|
* @public
|
8134
7361
|
*/
|
@@ -8198,10 +7425,6 @@ export declare interface UiLabelProps {
|
|
8198
7425
|
textAlign?: TextAlignType | undefined;
|
8199
7426
|
/** Label font type. @defaultValue 'sans-serif' */
|
8200
7427
|
font?: UiFontType | undefined;
|
8201
|
-
/** Outline width of the text. @defaultValue 0 */
|
8202
|
-
outlineWidth?: number | undefined;
|
8203
|
-
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8204
|
-
outlineColor?: PBColor4 | undefined;
|
8205
7428
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
8206
7429
|
textWrap?: UiTextWrapType | undefined;
|
8207
7430
|
}
|
@@ -8211,9 +7434,6 @@ export declare interface UiLabelProps {
|
|
8211
7434
|
*/
|
8212
7435
|
export declare type uint32 = number;
|
8213
7436
|
|
8214
|
-
/** @public */
|
8215
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8216
|
-
|
8217
7437
|
/** @public */
|
8218
7438
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
8219
7439
|
|
@@ -8286,26 +7506,6 @@ export declare interface UiTransformProps {
|
|
8286
7506
|
overflow?: OverflowType;
|
8287
7507
|
/** 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) **/
|
8288
7508
|
pointerFilter?: PointerFilterType;
|
8289
|
-
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
8290
|
-
opacity?: number;
|
8291
|
-
/** A reference value to identify the element, default empty */
|
8292
|
-
elementId?: string;
|
8293
|
-
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8294
|
-
scrollPosition?: PBVector2 | string;
|
8295
|
-
/** default ShowScrollBar.SSB_BOTH */
|
8296
|
-
scrollVisible?: ScrollVisibleType;
|
8297
|
-
/** default 0 */
|
8298
|
-
zIndex?: number;
|
8299
|
-
}
|
8300
|
-
|
8301
|
-
/**
|
8302
|
-
* Texture
|
8303
|
-
* @public
|
8304
|
-
*/
|
8305
|
-
export declare interface UiVideoTexture {
|
8306
|
-
videoPlayerEntity: Entity;
|
8307
|
-
wrapMode?: TextureWrapType;
|
8308
|
-
filterMode?: TextureFilterType;
|
8309
7509
|
}
|
8310
7510
|
|
8311
7511
|
/**
|