@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/beta.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
|
*/
|
@@ -2779,9 +2647,6 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
2779
2647
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
2780
2648
|
}
|
2781
2649
|
|
2782
|
-
/** @public */
|
2783
|
-
export declare const Light: LastWriteWinElementSetComponentDefinition<PBLight>;
|
2784
|
-
|
2785
2650
|
/**
|
2786
2651
|
* User key event Listeners
|
2787
2652
|
* @public
|
@@ -2795,12 +2660,6 @@ export declare type Listeners = {
|
|
2795
2660
|
onMouseEnter?: Callback;
|
2796
2661
|
/** triggered on mouse leave event */
|
2797
2662
|
onMouseLeave?: Callback;
|
2798
|
-
/** triggered on mouse drag event */
|
2799
|
-
onMouseDrag?: Callback;
|
2800
|
-
/** triggered on mouse drag event */
|
2801
|
-
onMouseDragLocked?: Callback;
|
2802
|
-
/** triggered on mouse drag event */
|
2803
|
-
onMouseDragEnd?: Callback;
|
2804
2663
|
};
|
2805
2664
|
|
2806
2665
|
/**
|
@@ -3669,14 +3528,6 @@ export declare interface MeshColliderComponentDefinitionExtended extends LastWri
|
|
3669
3528
|
* @param colliderMask - the set of layer where the collider reacts, default: Physics and Pointer
|
3670
3529
|
*/
|
3671
3530
|
setSphere(entity: Entity, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3672
|
-
/**
|
3673
|
-
* @public
|
3674
|
-
* Set a gltf internal mesh in the MeshCollider component
|
3675
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3676
|
-
* @param source - the path to the gltf
|
3677
|
-
* @param meshName - the name of the mesh in the gltf
|
3678
|
-
*/
|
3679
|
-
setGltfMesh(entity: Entity, source: string, meshName: string, colliderLayers?: ColliderLayer | ColliderLayer[]): void;
|
3680
3531
|
}
|
3681
3532
|
|
3682
3533
|
export declare const MeshRenderer: MeshRendererComponentDefinitionExtended;
|
@@ -3713,14 +3564,6 @@ export declare interface MeshRendererComponentDefinitionExtended extends LastWri
|
|
3713
3564
|
* @param entity - entity to create or replace the MeshRenderer component
|
3714
3565
|
*/
|
3715
3566
|
setSphere(entity: Entity): void;
|
3716
|
-
/**
|
3717
|
-
* @public
|
3718
|
-
* Set a gltf internal mesh in the MeshRenderer component
|
3719
|
-
* @param entity - entity to create or replace the MeshRenderer component
|
3720
|
-
* @param source - the path to the gltf
|
3721
|
-
* @param meshName - the name of the mesh in the gltf
|
3722
|
-
*/
|
3723
|
-
setGltfMesh(entity: Entity, source: string, meshName: string): void;
|
3724
3567
|
}
|
3725
3568
|
|
3726
3569
|
/* Excluded from this release type: MessageBus */
|
@@ -4114,25 +3957,6 @@ export declare const onVideoEvent: Observable<{
|
|
4114
3957
|
totalVideoLength: number;
|
4115
3958
|
}>;
|
4116
3959
|
|
4117
|
-
/**
|
4118
|
-
* @public
|
4119
|
-
*/
|
4120
|
-
export declare interface Orthographic {
|
4121
|
-
/**
|
4122
|
-
* vertical extent of the visible range in meters
|
4123
|
-
* defaults to 4m
|
4124
|
-
*/
|
4125
|
-
verticalRange?: number | undefined;
|
4126
|
-
}
|
4127
|
-
|
4128
|
-
/**
|
4129
|
-
* @public
|
4130
|
-
*/
|
4131
|
-
export declare namespace Orthographic {
|
4132
|
-
export function encode(message: Orthographic, writer?: _m0.Writer): _m0.Writer;
|
4133
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Orthographic;
|
4134
|
-
}
|
4135
|
-
|
4136
3960
|
/**
|
4137
3961
|
* @public
|
4138
3962
|
* The overflow property controls what happens to content that is too big to fit into an area
|
@@ -4359,8 +4183,6 @@ export declare namespace PBAvatarEmoteCommand {
|
|
4359
4183
|
export declare interface PBAvatarEquippedData {
|
4360
4184
|
wearableUrns: string[];
|
4361
4185
|
emoteUrns: string[];
|
4362
|
-
/** slots that will render even if hidden */
|
4363
|
-
forceRender: string[];
|
4364
4186
|
}
|
4365
4187
|
|
4366
4188
|
/**
|
@@ -4395,9 +4217,6 @@ export declare interface PBAvatarModifierArea {
|
|
4395
4217
|
excludeIds: string[];
|
4396
4218
|
/** list of modifiers to apply */
|
4397
4219
|
modifiers: AvatarModifierType[];
|
4398
|
-
movementSettings?: AvatarMovementSettings | undefined;
|
4399
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4400
|
-
useColliderRange?: boolean | undefined;
|
4401
4220
|
}
|
4402
4221
|
|
4403
4222
|
/**
|
@@ -4454,8 +4273,6 @@ export declare interface PBAvatarShape {
|
|
4454
4273
|
wearables: string[];
|
4455
4274
|
/** available emotes (default empty) */
|
4456
4275
|
emotes: string[];
|
4457
|
-
/** slots that will render even if hidden */
|
4458
|
-
forceRender: string[];
|
4459
4276
|
}
|
4460
4277
|
|
4461
4278
|
/**
|
@@ -4490,51 +4307,6 @@ export declare namespace PBBillboard {
|
|
4490
4307
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBBillboard;
|
4491
4308
|
}
|
4492
4309
|
|
4493
|
-
/**
|
4494
|
-
* @public
|
4495
|
-
*/
|
4496
|
-
export declare interface PBCameraLayer {
|
4497
|
-
/**
|
4498
|
-
* layer to which these settings apply. must be > 0
|
4499
|
-
* Layer 0 is the default "real world" layer viewed by the player and cannot be modified.
|
4500
|
-
*/
|
4501
|
-
layer: number;
|
4502
|
-
/** should the sun light affect this layer? default false */
|
4503
|
-
directionalLight?: boolean | undefined;
|
4504
|
-
/** should this layer show player avatars? default false */
|
4505
|
-
showAvatars?: boolean | undefined;
|
4506
|
-
/** should this layer show the sky? default false */
|
4507
|
-
showSkybox?: boolean | undefined;
|
4508
|
-
/** should this layer show distance fog? default false */
|
4509
|
-
showFog?: boolean | undefined;
|
4510
|
-
/** ambient light overrides for this layer. default -> use same as main camera */
|
4511
|
-
ambientColorOverride?: PBColor3 | undefined;
|
4512
|
-
ambientBrightnessOverride?: number | undefined;
|
4513
|
-
}
|
4514
|
-
|
4515
|
-
/**
|
4516
|
-
* @public
|
4517
|
-
*/
|
4518
|
-
export declare namespace PBCameraLayer {
|
4519
|
-
export function encode(message: PBCameraLayer, writer?: _m0.Writer): _m0.Writer;
|
4520
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayer;
|
4521
|
-
}
|
4522
|
-
|
4523
|
-
/**
|
4524
|
-
* @public
|
4525
|
-
*/
|
4526
|
-
export declare interface PBCameraLayers {
|
4527
|
-
layers: number[];
|
4528
|
-
}
|
4529
|
-
|
4530
|
-
/**
|
4531
|
-
* @public
|
4532
|
-
*/
|
4533
|
-
export declare namespace PBCameraLayers {
|
4534
|
-
export function encode(message: PBCameraLayers, writer?: _m0.Writer): _m0.Writer;
|
4535
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBCameraLayers;
|
4536
|
-
}
|
4537
|
-
|
4538
4310
|
/**
|
4539
4311
|
* The CameraMode component can be used to determine whether the player is using a first-person o
|
4540
4312
|
* third-person view.
|
@@ -4557,7 +4329,7 @@ export declare namespace PBCameraMode {
|
|
4557
4329
|
|
4558
4330
|
/**
|
4559
4331
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4560
|
-
* the player's camera mode (1st-person
|
4332
|
+
* the player's camera mode (1st-person or 3rd-person) is overridden.
|
4561
4333
|
*
|
4562
4334
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4563
4335
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4567,8 +4339,6 @@ export declare namespace PBCameraMode {
|
|
4567
4339
|
*
|
4568
4340
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4569
4341
|
* is actually a 3D volume.
|
4570
|
-
*
|
4571
|
-
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4572
4342
|
*/
|
4573
4343
|
/**
|
4574
4344
|
* @public
|
@@ -4578,9 +4348,6 @@ export declare interface PBCameraModeArea {
|
|
4578
4348
|
area: PBVector3 | undefined;
|
4579
4349
|
/** the camera mode to enforce */
|
4580
4350
|
mode: CameraType;
|
4581
|
-
cinematicSettings?: CinematicSettings | undefined;
|
4582
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4583
|
-
useColliderRange?: boolean | undefined;
|
4584
4351
|
}
|
4585
4352
|
|
4586
4353
|
/**
|
@@ -4652,39 +4419,6 @@ export declare namespace PBEngineInfo {
|
|
4652
4419
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBEngineInfo;
|
4653
4420
|
}
|
4654
4421
|
|
4655
|
-
/**
|
4656
|
-
* defines the global scene light settings. must be added to the scene root.
|
4657
|
-
* to control sunlight color, intensity, shadows etc, you can also add a PBLight to the scene root.
|
4658
|
-
*/
|
4659
|
-
/**
|
4660
|
-
* @public
|
4661
|
-
*/
|
4662
|
-
export declare interface PBGlobalLight {
|
4663
|
-
/**
|
4664
|
-
* the direction the directional light shines in.
|
4665
|
-
* default depends on time of day and explorer implementation
|
4666
|
-
*/
|
4667
|
-
direction?: PBVector3 | undefined;
|
4668
|
-
/**
|
4669
|
-
* ambient light color
|
4670
|
-
* default: White
|
4671
|
-
*/
|
4672
|
-
ambientColor?: PBColor3 | undefined;
|
4673
|
-
/**
|
4674
|
-
* ambient light intensity. the explorer default ambient brightness is multiplied by this non-physical quantity.
|
4675
|
-
* default 1
|
4676
|
-
*/
|
4677
|
-
ambientBrightness?: number | undefined;
|
4678
|
-
}
|
4679
|
-
|
4680
|
-
/**
|
4681
|
-
* @public
|
4682
|
-
*/
|
4683
|
-
export declare namespace PBGlobalLight {
|
4684
|
-
export function encode(message: PBGlobalLight, writer?: _m0.Writer): _m0.Writer;
|
4685
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGlobalLight;
|
4686
|
-
}
|
4687
|
-
|
4688
4422
|
/**
|
4689
4423
|
* GltfContainer loads a GLTF file (and any additional files packaged inside) attached to an Entity.
|
4690
4424
|
*
|
@@ -4720,25 +4454,6 @@ export declare namespace PBGltfContainer {
|
|
4720
4454
|
*/
|
4721
4455
|
export declare interface PBGltfContainerLoadingState {
|
4722
4456
|
currentState: LoadingState;
|
4723
|
-
/** all node paths in the gltf, which can be used with a GltfNode to inspect and modify the gltf contents */
|
4724
|
-
nodePaths: string[];
|
4725
|
-
/** all meshes in the gltf. unnamed meshes will be auto-assigned a name of the form `MeshX` or `MeshX/PrimitiveY` */
|
4726
|
-
meshNames: string[];
|
4727
|
-
/**
|
4728
|
-
* where X is the mesh index and Y is the primitive index (and there is more than 1 primitive). note this may
|
4729
|
-
* conflict with manually named meshes - to avoid any issues make sure all your meshes are explicitly named.
|
4730
|
-
*/
|
4731
|
-
materialNames: string[];
|
4732
|
-
/**
|
4733
|
-
* X is the material index. note this may conflict with manually named materials - to avoid any issues make
|
4734
|
-
* sure all your materials are explicitly named.
|
4735
|
-
*/
|
4736
|
-
skinNames: string[];
|
4737
|
-
/**
|
4738
|
-
* X is the skin index. note this may conflict with manually named skins - to avoid any issues make sure all
|
4739
|
-
* your skins are explicitly named.
|
4740
|
-
*/
|
4741
|
-
animationNames: string[];
|
4742
4457
|
}
|
4743
4458
|
|
4744
4459
|
/**
|
@@ -4749,77 +4464,6 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4749
4464
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4750
4465
|
}
|
4751
4466
|
|
4752
|
-
/**
|
4753
|
-
* a GltfNode links a scene entity with a node from within a gltf, allowing the scene to inspect it or modify it.
|
4754
|
-
* This component must be added to a direct child of an entity with a PBGltfContainer component, or
|
4755
|
-
* to a direct child of another entity with a GltfNode component, and the referenced gltf node must be a descendent of the gltf node
|
4756
|
-
* in the parent.
|
4757
|
-
* The name must match the path of one of the nodes within the Gltf. These are available on the GltfContainerLoadingState component.
|
4758
|
-
*
|
4759
|
-
* The renderer will attach a PBGltfNodeState to the entity describing the state. Once the state is `GNS_READY`,
|
4760
|
-
* - the `Transform` will be updated to match the position of the node within the gltf (relative to the gltf root, or the parent node),
|
4761
|
-
* - a `MeshRenderer` with a GltfMesh mesh type will be added (if the gltf node has a mesh).
|
4762
|
-
* - a `MeshCollider` with a GltfMesh mesh type will be added (if the gltf node has a collider).
|
4763
|
-
* - a `Material` component including a GltfMaterial reference will be added (if the gltf node has a material).
|
4764
|
-
*
|
4765
|
-
* After creation, if an animation moves the node, the `Transform` will be updated.
|
4766
|
-
*
|
4767
|
-
* From the scene, you can modify various components to alter the gltf node:
|
4768
|
-
* - modifying the `Transform` position/rotation/scale will move the node. The position is interpreted relative to the gltf root (or parent node),
|
4769
|
-
* regardless of any intermediate gltf node hierarchy.
|
4770
|
-
* If an animation is playing, the animation takes priority and the scene entity's position will be updated to match the animation.
|
4771
|
-
* - `Visibility` can be added to hide or show the node and it's children in the gltf hierarchy.
|
4772
|
-
* - `MeshRenderer` can be added/modified/removed to create/modify/remove a mesh on the node.
|
4773
|
-
* - `MeshCollider` can be added/modified/removed to create/modify/remove a collider on the node.
|
4774
|
-
* - `Material` can be added or modified to change the material properties. If the gltf node has a material, the original material will be
|
4775
|
-
* 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
|
4776
|
-
* PBMaterial will be maintained.
|
4777
|
-
*
|
4778
|
-
* The scene can add additional entities as children to the gltf node, but structural modifications of the gltf are not possible:
|
4779
|
-
* - changing the scene hierarchy will not change the gltf node hierarchy. Moving the entity out of the gltf will sever the link and
|
4780
|
-
* change the state to `GNS_FAILED`.
|
4781
|
-
* - deleting the scene entity will not delete the gltf node.
|
4782
|
-
*
|
4783
|
-
* Removing the GltfNode will revert any changes to the original gltf. If the GltfNode component is removed and the mesh/collider/material
|
4784
|
-
* are not removed, this will result in a duplication of these components as the previously-linked entity will retain it's components and
|
4785
|
-
* the gltf node will also be displayed.
|
4786
|
-
*/
|
4787
|
-
/**
|
4788
|
-
* @public
|
4789
|
-
*/
|
4790
|
-
export declare interface PBGltfNode {
|
4791
|
-
/** the path of the target node in the Gltf. */
|
4792
|
-
path: string;
|
4793
|
-
}
|
4794
|
-
|
4795
|
-
/**
|
4796
|
-
* @public
|
4797
|
-
*/
|
4798
|
-
export declare namespace PBGltfNode {
|
4799
|
-
export function encode(message: PBGltfNode, writer?: _m0.Writer): _m0.Writer;
|
4800
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNode;
|
4801
|
-
}
|
4802
|
-
|
4803
|
-
/**
|
4804
|
-
* The state of a linked gltf node.
|
4805
|
-
* If the state is GNSV_FAILED, the renderer may describe the failure in the error string.
|
4806
|
-
*/
|
4807
|
-
/**
|
4808
|
-
* @public
|
4809
|
-
*/
|
4810
|
-
export declare interface PBGltfNodeState {
|
4811
|
-
state: GltfNodeStateValue;
|
4812
|
-
error?: string | undefined;
|
4813
|
-
}
|
4814
|
-
|
4815
|
-
/**
|
4816
|
-
* @public
|
4817
|
-
*/
|
4818
|
-
export declare namespace PBGltfNodeState {
|
4819
|
-
export function encode(message: PBGltfNodeState, writer?: _m0.Writer): _m0.Writer;
|
4820
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfNodeState;
|
4821
|
-
}
|
4822
|
-
|
4823
4467
|
/**
|
4824
4468
|
* @public
|
4825
4469
|
*/
|
@@ -4859,62 +4503,6 @@ export declare namespace PBInputModifier_StandardInput {
|
|
4859
4503
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4860
4504
|
}
|
4861
4505
|
|
4862
|
-
/**
|
4863
|
-
* defines a light source.
|
4864
|
-
* the world has a default directional light (like sunlight) which can be overridden by adding the light component to the scene root.
|
4865
|
-
* a PBGlobalLight component can also be added to the root to control the directional light direction.
|
4866
|
-
* point lights (lightbulbs) or spotlights can be created by attaching the light component to non-root entities.
|
4867
|
-
*/
|
4868
|
-
/**
|
4869
|
-
* @public
|
4870
|
-
*/
|
4871
|
-
export declare interface PBLight {
|
4872
|
-
/**
|
4873
|
-
* whether the light is on
|
4874
|
-
* default true
|
4875
|
-
*/
|
4876
|
-
enabled?: boolean | undefined;
|
4877
|
-
/**
|
4878
|
-
* light brightness in lux (lumens/m^2).
|
4879
|
-
*
|
4880
|
-
* 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).
|
4881
|
-
* the default global light illuminance varies from 400 (sunrise/sunset) to 10,000 (midday).
|
4882
|
-
* for typical values, see https://en.wikipedia.org/wiki/Lux#Illuminance
|
4883
|
-
*
|
4884
|
-
* for point and spot lights, this is the lumens/m^2 at 1m distance from the light. to transform from raw lumens,
|
4885
|
-
* divide lumens by ~12 (4*pi).
|
4886
|
-
* e.g. a 100w household bulb with 1200 lumens would have an illuminance of ~100.
|
4887
|
-
* a lighthouse bulb with 200,000 lumens would have an illuminance of ~15,000 (ignoring beam reflections)
|
4888
|
-
*
|
4889
|
-
* default
|
4890
|
-
* for point/spotlights: 10,000
|
4891
|
-
* for global directional light: depends on explorer implementation. may vary on light direction, time of day, etc
|
4892
|
-
*/
|
4893
|
-
illuminance?: number | undefined;
|
4894
|
-
/**
|
4895
|
-
* whether the light should cast shadows.
|
4896
|
-
* note: even when set to true the engine may not display shadows, or may only show shadows for a limited number
|
4897
|
-
* of lights depending on the implementation, platform, and user settings.
|
4898
|
-
* default
|
4899
|
-
* for point/spotlights: false / off
|
4900
|
-
* for global directional light: true / on
|
4901
|
-
*/
|
4902
|
-
shadows?: boolean | undefined;
|
4903
|
-
/**
|
4904
|
-
* light color
|
4905
|
-
* default White
|
4906
|
-
*/
|
4907
|
-
color?: PBColor3 | undefined;
|
4908
|
-
}
|
4909
|
-
|
4910
|
-
/**
|
4911
|
-
* @public
|
4912
|
-
*/
|
4913
|
-
export declare namespace PBLight {
|
4914
|
-
export function encode(message: PBLight, writer?: _m0.Writer): _m0.Writer;
|
4915
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBLight;
|
4916
|
-
}
|
4917
|
-
|
4918
4506
|
/**
|
4919
4507
|
* PBMainCamera.virtualCameraEntity defines which VirtualCamera entity is active at the moment.
|
4920
4508
|
* This component may hold 'repeated common.CameraTransition' transitionOverrides in the future
|
@@ -4946,14 +4534,6 @@ export declare interface PBMaterial {
|
|
4946
4534
|
$case: "pbr";
|
4947
4535
|
pbr: PBMaterial_PbrMaterial;
|
4948
4536
|
} | undefined;
|
4949
|
-
/**
|
4950
|
-
* A gltf material that may provide additional features not supported by the PbMaterial fields.
|
4951
|
-
* If both gltf and material fields are provided, the gltf will be used only for extended features not
|
4952
|
-
* supported by the PbMaterial.
|
4953
|
-
* If this is provided and the `material` field is not provided, the renderer will update the material
|
4954
|
-
* field with data that reflects the gltf material once it is loaded.
|
4955
|
-
*/
|
4956
|
-
gltf?: PBMaterial_GltfMaterial | undefined;
|
4957
4537
|
}
|
4958
4538
|
|
4959
4539
|
/**
|
@@ -4964,22 +4544,6 @@ export declare namespace PBMaterial {
|
|
4964
4544
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial;
|
4965
4545
|
}
|
4966
4546
|
|
4967
|
-
/**
|
4968
|
-
* @public
|
4969
|
-
*/
|
4970
|
-
export declare interface PBMaterial_GltfMaterial {
|
4971
|
-
gltfSrc: string;
|
4972
|
-
name: string;
|
4973
|
-
}
|
4974
|
-
|
4975
|
-
/**
|
4976
|
-
* @public
|
4977
|
-
*/
|
4978
|
-
export declare namespace PBMaterial_GltfMaterial {
|
4979
|
-
export function encode(message: PBMaterial_GltfMaterial, writer?: _m0.Writer): _m0.Writer;
|
4980
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMaterial_GltfMaterial;
|
4981
|
-
}
|
4982
|
-
|
4983
4547
|
/**
|
4984
4548
|
* @public
|
4985
4549
|
*/
|
@@ -5076,9 +4640,6 @@ export declare interface PBMeshCollider {
|
|
5076
4640
|
} | {
|
5077
4641
|
$case: "plane";
|
5078
4642
|
plane: PBMeshCollider_PlaneMesh;
|
5079
|
-
} | {
|
5080
|
-
$case: "gltf";
|
5081
|
-
gltf: PBMeshCollider_GltfMesh;
|
5082
4643
|
} | undefined;
|
5083
4644
|
}
|
5084
4645
|
|
@@ -5124,25 +4685,6 @@ export declare namespace PBMeshCollider_CylinderMesh {
|
|
5124
4685
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_CylinderMesh;
|
5125
4686
|
}
|
5126
4687
|
|
5127
|
-
/** A collider constructed from a Gltf Mesh. */
|
5128
|
-
/**
|
5129
|
-
* @public
|
5130
|
-
*/
|
5131
|
-
export declare interface PBMeshCollider_GltfMesh {
|
5132
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5133
|
-
gltfSrc: string;
|
5134
|
-
/** the name of the mesh asset */
|
5135
|
-
name: string;
|
5136
|
-
}
|
5137
|
-
|
5138
|
-
/**
|
5139
|
-
* @public
|
5140
|
-
*/
|
5141
|
-
export declare namespace PBMeshCollider_GltfMesh {
|
5142
|
-
export function encode(message: PBMeshCollider_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5143
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshCollider_GltfMesh;
|
5144
|
-
}
|
5145
|
-
|
5146
4688
|
/** PlaneMesh is a 2D rectangle described by the Entity's Transform. */
|
5147
4689
|
/**
|
5148
4690
|
* @public
|
@@ -5175,11 +4717,13 @@ export declare namespace PBMeshCollider_SphereMesh {
|
|
5175
4717
|
|
5176
4718
|
/**
|
5177
4719
|
* The MeshRenderer component renders a basic geometric shape for an Entity. It can be a cube, a
|
5178
|
-
* plane, a sphere
|
4720
|
+
* plane, a sphere or a cylinder.
|
5179
4721
|
*
|
5180
4722
|
* The cube and plane variants can include a UV texture mapping, so specific areas of a material
|
5181
4723
|
* texture are rendered on different faces of the shape. They are serialized as a sequence of 2D
|
5182
4724
|
* `float` coordinates, one for each corner of each side of each face.
|
4725
|
+
*
|
4726
|
+
* More complex shapes require the use of a `GltfContainer` component.
|
5183
4727
|
*/
|
5184
4728
|
/**
|
5185
4729
|
* @public
|
@@ -5197,9 +4741,6 @@ export declare interface PBMeshRenderer {
|
|
5197
4741
|
} | {
|
5198
4742
|
$case: "plane";
|
5199
4743
|
plane: PBMeshRenderer_PlaneMesh;
|
5200
|
-
} | {
|
5201
|
-
$case: "gltf";
|
5202
|
-
gltf: PBMeshRenderer_GltfMesh;
|
5203
4744
|
} | undefined;
|
5204
4745
|
}
|
5205
4746
|
|
@@ -5247,25 +4788,6 @@ export declare namespace PBMeshRenderer_CylinderMesh {
|
|
5247
4788
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_CylinderMesh;
|
5248
4789
|
}
|
5249
4790
|
|
5250
|
-
/** A mesh from a Gltf. */
|
5251
|
-
/**
|
5252
|
-
* @public
|
5253
|
-
*/
|
5254
|
-
export declare interface PBMeshRenderer_GltfMesh {
|
5255
|
-
/** the GLTF file path as listed in the scene's manifest. */
|
5256
|
-
gltfSrc: string;
|
5257
|
-
/** the name of the mesh asset */
|
5258
|
-
name: string;
|
5259
|
-
}
|
5260
|
-
|
5261
|
-
/**
|
5262
|
-
* @public
|
5263
|
-
*/
|
5264
|
-
export declare namespace PBMeshRenderer_GltfMesh {
|
5265
|
-
export function encode(message: PBMeshRenderer_GltfMesh, writer?: _m0.Writer): _m0.Writer;
|
5266
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBMeshRenderer_GltfMesh;
|
5267
|
-
}
|
5268
|
-
|
5269
4791
|
/** PlaneMesh renders a 2D rectangular shape. */
|
5270
4792
|
/**
|
5271
4793
|
* @public
|
@@ -5484,30 +5006,6 @@ export declare namespace PBPosition {
|
|
5484
5006
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPosition;
|
5485
5007
|
}
|
5486
5008
|
|
5487
|
-
/**
|
5488
|
-
* @public
|
5489
|
-
*/
|
5490
|
-
export declare interface PBPrimaryPointerInfo {
|
5491
|
-
pointerType?: PointerType | undefined;
|
5492
|
-
/** in pixels */
|
5493
|
-
screenCoordinates?: PBVector2 | undefined;
|
5494
|
-
/** in pixels */
|
5495
|
-
screenDelta?: PBVector2 | undefined;
|
5496
|
-
/**
|
5497
|
-
* ray direction that can be used with the primary camera origin for
|
5498
|
-
* raycasting from the cursor into the world
|
5499
|
-
*/
|
5500
|
-
worldRayDirection?: PBVector3 | undefined;
|
5501
|
-
}
|
5502
|
-
|
5503
|
-
/**
|
5504
|
-
* @public
|
5505
|
-
*/
|
5506
|
-
export declare namespace PBPrimaryPointerInfo {
|
5507
|
-
export function encode(message: PBPrimaryPointerInfo, writer?: _m0.Writer): _m0.Writer;
|
5508
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBPrimaryPointerInfo;
|
5509
|
-
}
|
5510
|
-
|
5511
5009
|
/**
|
5512
5010
|
* @public
|
5513
5011
|
*/
|
@@ -5629,39 +5127,6 @@ export declare namespace PBRealmInfo {
|
|
5629
5127
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBRealmInfo;
|
5630
5128
|
}
|
5631
5129
|
|
5632
|
-
/**
|
5633
|
-
* defines a spotlight.
|
5634
|
-
* spotlights are point lights that emit light only in a cone around the transform's forward direction.
|
5635
|
-
* add this component together with the PBLight component to transform a point light into a spotlight.
|
5636
|
-
* note that spotlights do not model any internal reflections / focus, they only restrict the area of effect.
|
5637
|
-
* so for e.g. a torch beam, the bulb illuminance should be multiplied by the solid angle.
|
5638
|
-
* a typical torch with a beam width of 15 degrees would use outer angle of 0.15 (7.5 degrees in radians),
|
5639
|
-
* and an illuminance approximately equal to the bulb's lumens, e.g. 1200.
|
5640
|
-
*/
|
5641
|
-
/**
|
5642
|
-
* @public
|
5643
|
-
*/
|
5644
|
-
export declare interface PBSpotlight {
|
5645
|
-
/**
|
5646
|
-
* the cone radius in radians. distance away from forward in which the light is visible.
|
5647
|
-
* for a torch a value around 0.15 is appropriate.
|
5648
|
-
*/
|
5649
|
-
angle: number;
|
5650
|
-
/**
|
5651
|
-
* optional angle at which the light is brightest. should be <= outer angle.
|
5652
|
-
* if specified, the light will fall off smoothly between `inner_angle` and `angle`.
|
5653
|
-
*/
|
5654
|
-
innerAngle?: number | undefined;
|
5655
|
-
}
|
5656
|
-
|
5657
|
-
/**
|
5658
|
-
* @public
|
5659
|
-
*/
|
5660
|
-
export declare namespace PBSpotlight {
|
5661
|
-
export function encode(message: PBSpotlight, writer?: _m0.Writer): _m0.Writer;
|
5662
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBSpotlight;
|
5663
|
-
}
|
5664
|
-
|
5665
5130
|
/**
|
5666
5131
|
* The TextShape component renders customizable floating text.
|
5667
5132
|
*
|
@@ -5726,40 +5191,6 @@ export declare namespace PBTextShape {
|
|
5726
5191
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextShape;
|
5727
5192
|
}
|
5728
5193
|
|
5729
|
-
/**
|
5730
|
-
* @public
|
5731
|
-
*/
|
5732
|
-
export declare interface PBTextureCamera {
|
5733
|
-
/** rendered texture width */
|
5734
|
-
width?: number | undefined;
|
5735
|
-
/** rendered texture height */
|
5736
|
-
height?: number | undefined;
|
5737
|
-
/**
|
5738
|
-
* which layer of entities to render. entity layers can be specified by adding PBCameraLayers to target entities.
|
5739
|
-
* defaults to 0
|
5740
|
-
*/
|
5741
|
-
layer?: number | undefined;
|
5742
|
-
/** default black */
|
5743
|
-
clearColor?: PBColor4 | undefined;
|
5744
|
-
/** default infinity */
|
5745
|
-
farPlane?: number | undefined;
|
5746
|
-
mode?: {
|
5747
|
-
$case: "perspective";
|
5748
|
-
perspective: Perspective;
|
5749
|
-
} | {
|
5750
|
-
$case: "orthographic";
|
5751
|
-
orthographic: Orthographic;
|
5752
|
-
} | undefined;
|
5753
|
-
}
|
5754
|
-
|
5755
|
-
/**
|
5756
|
-
* @public
|
5757
|
-
*/
|
5758
|
-
export declare namespace PBTextureCamera {
|
5759
|
-
export function encode(message: PBTextureCamera, writer?: _m0.Writer): _m0.Writer;
|
5760
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBTextureCamera;
|
5761
|
-
}
|
5762
|
-
|
5763
5194
|
/**
|
5764
5195
|
* @public
|
5765
5196
|
*/
|
@@ -5849,25 +5280,6 @@ export declare namespace PBUiBackground {
|
|
5849
5280
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiBackground;
|
5850
5281
|
}
|
5851
5282
|
|
5852
|
-
/** The UiCanvas component can be attached to a ui root entity to specify properties of the ui texture. */
|
5853
|
-
/**
|
5854
|
-
* @public
|
5855
|
-
*/
|
5856
|
-
export declare interface PBUiCanvas {
|
5857
|
-
width: number;
|
5858
|
-
height: number;
|
5859
|
-
/** default = (0.0, 0.0, 0.0, 0.0) / transparent */
|
5860
|
-
color?: PBColor4 | undefined;
|
5861
|
-
}
|
5862
|
-
|
5863
|
-
/**
|
5864
|
-
* @public
|
5865
|
-
*/
|
5866
|
-
export declare namespace PBUiCanvas {
|
5867
|
-
export function encode(message: PBUiCanvas, writer?: _m0.Writer): _m0.Writer;
|
5868
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiCanvas;
|
5869
|
-
}
|
5870
|
-
|
5871
5283
|
/** This component is created by the renderer and used by the scenes to know the resolution of the UI canvas */
|
5872
5284
|
/**
|
5873
5285
|
* @public
|
@@ -5984,21 +5396,6 @@ export declare namespace PBUiInputResult {
|
|
5984
5396
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5985
5397
|
}
|
5986
5398
|
|
5987
|
-
/**
|
5988
|
-
* @public
|
5989
|
-
*/
|
5990
|
-
export declare interface PBUiScrollResult {
|
5991
|
-
value: PBVector2 | undefined;
|
5992
|
-
}
|
5993
|
-
|
5994
|
-
/**
|
5995
|
-
* @public
|
5996
|
-
*/
|
5997
|
-
export declare namespace PBUiScrollResult {
|
5998
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
5999
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
6000
|
-
}
|
6001
|
-
|
6002
5399
|
/**
|
6003
5400
|
* @public
|
6004
5401
|
*/
|
@@ -6015,10 +5412,6 @@ export declare interface PBUiText {
|
|
6015
5412
|
fontSize?: number | undefined;
|
6016
5413
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
6017
5414
|
textWrap?: TextWrap | undefined;
|
6018
|
-
/** width of the outline (default: 0) */
|
6019
|
-
outlineWidth?: number | undefined;
|
6020
|
-
/** RGBA color of the outline (default: opaque black) */
|
6021
|
-
outlineColor?: PBColor4 | undefined;
|
6022
5415
|
}
|
6023
5416
|
|
6024
5417
|
/**
|
@@ -6115,16 +5508,6 @@ export declare interface PBUiTransform {
|
|
6115
5508
|
paddingBottom: number;
|
6116
5509
|
/** default: PointerFilterMode.PFM_NONE */
|
6117
5510
|
pointerFilter?: PointerFilterMode | undefined;
|
6118
|
-
/** default: 1 */
|
6119
|
-
opacity?: number | undefined;
|
6120
|
-
/** default empty */
|
6121
|
-
elementId?: string | undefined;
|
6122
|
-
/** default position=(0,0) */
|
6123
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
6124
|
-
/** default ShowScrollBar.SSB_BOTH */
|
6125
|
-
scrollVisible?: ShowScrollBar | undefined;
|
6126
|
-
/** default 0 */
|
6127
|
-
zIndex?: number | undefined;
|
6128
5511
|
}
|
6129
5512
|
|
6130
5513
|
/**
|
@@ -6254,25 +5637,6 @@ export declare namespace PBVisibilityComponent {
|
|
6254
5637
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBVisibilityComponent;
|
6255
5638
|
}
|
6256
5639
|
|
6257
|
-
/**
|
6258
|
-
* @public
|
6259
|
-
*/
|
6260
|
-
export declare interface Perspective {
|
6261
|
-
/**
|
6262
|
-
* vertical field of view in radians
|
6263
|
-
* defaults to pi/4 = 45 degrees
|
6264
|
-
*/
|
6265
|
-
fieldOfView?: number | undefined;
|
6266
|
-
}
|
6267
|
-
|
6268
|
-
/**
|
6269
|
-
* @public
|
6270
|
-
*/
|
6271
|
-
export declare namespace Perspective {
|
6272
|
-
export function encode(message: Perspective, writer?: _m0.Writer): _m0.Writer;
|
6273
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): Perspective;
|
6274
|
-
}
|
6275
|
-
|
6276
5640
|
/**
|
6277
5641
|
* Represens a plane by the equation ax + by + cz + d = 0
|
6278
5642
|
* @public
|
@@ -6428,24 +5792,6 @@ export declare interface PointerEventsSystem {
|
|
6428
5792
|
* @param entity - Entity where the callback was attached
|
6429
5793
|
*/
|
6430
5794
|
removeOnPointerHoverLeave(entity: Entity): void;
|
6431
|
-
/**
|
6432
|
-
* @public
|
6433
|
-
* Remove the callback for onPointerDrag event
|
6434
|
-
* @param entity - Entity where the callback was attached
|
6435
|
-
*/
|
6436
|
-
removeOnPointerDrag(entity: Entity): void;
|
6437
|
-
/**
|
6438
|
-
* @public
|
6439
|
-
* Remove the callback for onPointerDragLocked event
|
6440
|
-
* @param entity - Entity where the callback was attached
|
6441
|
-
*/
|
6442
|
-
removeOnPointerDragLocked(entity: Entity): void;
|
6443
|
-
/**
|
6444
|
-
* @public
|
6445
|
-
* Remove the callback for onPointerDragEnd event
|
6446
|
-
* @param entity - Entity where the callback was attached
|
6447
|
-
*/
|
6448
|
-
removeOnPointerDragEnd(entity: Entity): void;
|
6449
5795
|
/**
|
6450
5796
|
* @public
|
6451
5797
|
* Execute callback when the user press the InputButton pointing at the entity
|
@@ -6500,37 +5846,6 @@ export declare interface PointerEventsSystem {
|
|
6500
5846
|
entity: Entity;
|
6501
5847
|
opts?: Partial<EventSystemOptions>;
|
6502
5848
|
}, cb: EventSystemCallback): void;
|
6503
|
-
/**
|
6504
|
-
* @public
|
6505
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity
|
6506
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6507
|
-
* @param cb - Function to execute when click fires
|
6508
|
-
*/
|
6509
|
-
onPointerDrag(pointerData: {
|
6510
|
-
entity: Entity;
|
6511
|
-
opts?: Partial<EventSystemOptions>;
|
6512
|
-
}, cb: EventSystemCallback): void;
|
6513
|
-
/**
|
6514
|
-
* @public
|
6515
|
-
* Execute callback when the user clicks and drags the pointer from inside the entity,
|
6516
|
-
* locking the cursor in place
|
6517
|
-
* @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
|
6518
|
-
* @param cb - Function to execute when click fires
|
6519
|
-
*/
|
6520
|
-
onPointerDragLocked(pointerData: {
|
6521
|
-
entity: Entity;
|
6522
|
-
opts?: Partial<EventSystemOptions>;
|
6523
|
-
}, cb: EventSystemCallback): void;
|
6524
|
-
/**
|
6525
|
-
* @public
|
6526
|
-
* Execute callback when the user releases the button after a drag
|
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
|
-
onPointerDragEnd(pointerData: {
|
6531
|
-
entity: Entity;
|
6532
|
-
opts?: Partial<EventSystemOptions>;
|
6533
|
-
}, cb: EventSystemCallback): void;
|
6534
5849
|
}
|
6535
5850
|
|
6536
5851
|
/**
|
@@ -6547,10 +5862,7 @@ export declare const enum PointerEventType {
|
|
6547
5862
|
PET_UP = 0,
|
6548
5863
|
PET_DOWN = 1,
|
6549
5864
|
PET_HOVER_ENTER = 2,
|
6550
|
-
PET_HOVER_LEAVE = 3
|
6551
|
-
PET_DRAG_LOCKED = 4,
|
6552
|
-
PET_DRAG = 5,
|
6553
|
-
PET_DRAG_END = 6
|
5865
|
+
PET_HOVER_LEAVE = 3
|
6554
5866
|
}
|
6555
5867
|
|
6556
5868
|
/**
|
@@ -6570,17 +5882,6 @@ export declare type PointerFilterType = 'none' | 'block';
|
|
6570
5882
|
/** @public */
|
6571
5883
|
export declare const PointerLock: LastWriteWinElementSetComponentDefinition<PBPointerLock>;
|
6572
5884
|
|
6573
|
-
/**
|
6574
|
-
* @public
|
6575
|
-
*/
|
6576
|
-
export declare const enum PointerType {
|
6577
|
-
POT_NONE = 0,
|
6578
|
-
POT_MOUSE = 1,
|
6579
|
-
POT_PAD = 2,
|
6580
|
-
POT_TOUCH = 3,
|
6581
|
-
POT_WAND = 4
|
6582
|
-
}
|
6583
|
-
|
6584
5885
|
/**
|
6585
5886
|
* Type used for defining the position of the element. i.e. margin, padding
|
6586
5887
|
* @public
|
@@ -6618,9 +5919,6 @@ export declare type PositionType = 'absolute' | 'relative';
|
|
6618
5919
|
*/
|
6619
5920
|
export declare type PositionUnit = `${number}px` | `${number}%` | number | `${number}` | ScaleUnit;
|
6620
5921
|
|
6621
|
-
/** @public */
|
6622
|
-
export declare const PrimaryPointerInfo: LastWriteWinElementSetComponentDefinition<PBPrimaryPointerInfo>;
|
6623
|
-
|
6624
5922
|
export declare enum ProcessMessageResultType {
|
6625
5923
|
/**
|
6626
5924
|
* Typical message and new state set.
|
@@ -7175,7 +6473,6 @@ export declare type RaycastSystemOptions = {
|
|
7175
6473
|
export declare interface ReactBasedUiSystem {
|
7176
6474
|
destroy(): void;
|
7177
6475
|
setUiRenderer(ui: UiComponent): void;
|
7178
|
-
setTextureRenderer(entity: Entity, ui: UiComponent): void;
|
7179
6476
|
}
|
7180
6477
|
|
7181
6478
|
/**
|
@@ -7629,43 +6926,6 @@ export declare namespace Schemas {
|
|
7629
6926
|
}) => void;
|
7630
6927
|
}
|
7631
6928
|
|
7632
|
-
/**
|
7633
|
-
* @public
|
7634
|
-
*/
|
7635
|
-
export declare interface ScrollPositionValue {
|
7636
|
-
value?: {
|
7637
|
-
$case: "position";
|
7638
|
-
position: PBVector2;
|
7639
|
-
} | {
|
7640
|
-
$case: "reference";
|
7641
|
-
reference: string;
|
7642
|
-
} | undefined;
|
7643
|
-
}
|
7644
|
-
|
7645
|
-
/**
|
7646
|
-
* @public
|
7647
|
-
*/
|
7648
|
-
export declare namespace ScrollPositionValue {
|
7649
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
7650
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
7651
|
-
}
|
7652
|
-
|
7653
|
-
/**
|
7654
|
-
* @public
|
7655
|
-
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
7656
|
-
*/
|
7657
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
7658
|
-
|
7659
|
-
/**
|
7660
|
-
* @public
|
7661
|
-
*/
|
7662
|
-
export declare const enum ShowScrollBar {
|
7663
|
-
SSB_BOTH = 0,
|
7664
|
-
SSB_ONLY_VERTICAL = 1,
|
7665
|
-
SSB_ONLY_HORIZONTAL = 2,
|
7666
|
-
SSB_HIDDEN = 3
|
7667
|
-
}
|
7668
|
-
|
7669
6929
|
/**
|
7670
6930
|
* @public
|
7671
6931
|
*/
|
@@ -7673,9 +6933,6 @@ export declare interface Spec {
|
|
7673
6933
|
[key: string]: ISchema;
|
7674
6934
|
}
|
7675
6935
|
|
7676
|
-
/** @public */
|
7677
|
-
export declare const Spotlight: LastWriteWinElementSetComponentDefinition<PBSpotlight>;
|
7678
|
-
|
7679
6936
|
/* Excluded from this release type: SyncComponents */
|
7680
6937
|
|
7681
6938
|
/**
|
@@ -7745,9 +7002,6 @@ export declare namespace Texture {
|
|
7745
7002
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): Texture;
|
7746
7003
|
}
|
7747
7004
|
|
7748
|
-
/** @public */
|
7749
|
-
export declare const TextureCamera: LastWriteWinElementSetComponentDefinition<PBTextureCamera>;
|
7750
|
-
|
7751
7005
|
/**
|
7752
7006
|
* @public
|
7753
7007
|
*/
|
@@ -7840,9 +7094,6 @@ export declare interface TextureUnion {
|
|
7840
7094
|
} | {
|
7841
7095
|
$case: "videoTexture";
|
7842
7096
|
videoTexture: VideoTexture;
|
7843
|
-
} | {
|
7844
|
-
$case: "uiTexture";
|
7845
|
-
uiTexture: UiCanvasTexture;
|
7846
7097
|
} | undefined;
|
7847
7098
|
}
|
7848
7099
|
|
@@ -8050,8 +7301,6 @@ export declare interface UiBackgroundProps {
|
|
8050
7301
|
uvs?: number[];
|
8051
7302
|
/** AvatarTexture for the background */
|
8052
7303
|
avatarTexture?: UiAvatarTexture;
|
8053
|
-
/** VideoTexture for the background */
|
8054
|
-
videoTexture?: UiVideoTexture;
|
8055
7304
|
/** Texture for the background */
|
8056
7305
|
texture?: UiTexture;
|
8057
7306
|
}
|
@@ -8071,31 +7320,9 @@ export declare interface UiButtonProps extends UiLabelProps, EntityPropTypes {
|
|
8071
7320
|
disabled?: boolean;
|
8072
7321
|
}
|
8073
7322
|
|
8074
|
-
/** @public */
|
8075
|
-
export declare const UiCanvas: LastWriteWinElementSetComponentDefinition<PBUiCanvas>;
|
8076
|
-
|
8077
7323
|
/** @public */
|
8078
7324
|
export declare const UiCanvasInformation: LastWriteWinElementSetComponentDefinition<PBUiCanvasInformation>;
|
8079
7325
|
|
8080
|
-
/**
|
8081
|
-
* @public
|
8082
|
-
*/
|
8083
|
-
export declare interface UiCanvasTexture {
|
8084
|
-
uiCanvasEntity: number;
|
8085
|
-
/** default = TextureWrapMode.Clamp */
|
8086
|
-
wrapMode?: TextureWrapMode | undefined;
|
8087
|
-
/** default = FilterMode.Bilinear */
|
8088
|
-
filterMode?: TextureFilterMode | undefined;
|
8089
|
-
}
|
8090
|
-
|
8091
|
-
/**
|
8092
|
-
* @public
|
8093
|
-
*/
|
8094
|
-
export declare namespace UiCanvasTexture {
|
8095
|
-
export function encode(message: UiCanvasTexture, writer?: _m0.Writer): _m0.Writer;
|
8096
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): UiCanvasTexture;
|
8097
|
-
}
|
8098
|
-
|
8099
7326
|
/**
|
8100
7327
|
* @public
|
8101
7328
|
*/
|
@@ -8165,10 +7392,6 @@ export declare interface UiLabelProps {
|
|
8165
7392
|
textAlign?: TextAlignType | undefined;
|
8166
7393
|
/** Label font type. @defaultValue 'sans-serif' */
|
8167
7394
|
font?: UiFontType | undefined;
|
8168
|
-
/** Outline width of the text. @defaultValue 0 */
|
8169
|
-
outlineWidth?: number | undefined;
|
8170
|
-
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
8171
|
-
outlineColor?: PBColor4 | undefined;
|
8172
7395
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
8173
7396
|
textWrap?: UiTextWrapType | undefined;
|
8174
7397
|
}
|
@@ -8178,9 +7401,6 @@ export declare interface UiLabelProps {
|
|
8178
7401
|
*/
|
8179
7402
|
export declare type uint32 = number;
|
8180
7403
|
|
8181
|
-
/** @public */
|
8182
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
8183
|
-
|
8184
7404
|
/** @public */
|
8185
7405
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
8186
7406
|
|
@@ -8253,26 +7473,6 @@ export declare interface UiTransformProps {
|
|
8253
7473
|
overflow?: OverflowType;
|
8254
7474
|
/** 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) **/
|
8255
7475
|
pointerFilter?: PointerFilterType;
|
8256
|
-
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
8257
|
-
opacity?: number;
|
8258
|
-
/** A reference value to identify the element, default empty */
|
8259
|
-
elementId?: string;
|
8260
|
-
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
8261
|
-
scrollPosition?: PBVector2 | string;
|
8262
|
-
/** default ShowScrollBar.SSB_BOTH */
|
8263
|
-
scrollVisible?: ScrollVisibleType;
|
8264
|
-
/** default 0 */
|
8265
|
-
zIndex?: number;
|
8266
|
-
}
|
8267
|
-
|
8268
|
-
/**
|
8269
|
-
* Texture
|
8270
|
-
* @public
|
8271
|
-
*/
|
8272
|
-
export declare interface UiVideoTexture {
|
8273
|
-
videoPlayerEntity: Entity;
|
8274
|
-
wrapMode?: TextureWrapType;
|
8275
|
-
filterMode?: TextureFilterType;
|
8276
7476
|
}
|
8277
7477
|
|
8278
7478
|
/**
|