@dcl/playground-assets 7.5.6-9766786409.commit-5232ccb → 7.5.7-9891810625.commit-d9f5cf2
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 +165 -1
- package/dist/beta.d.ts +165 -1
- package/dist/index.bundled.d.ts +165 -1
- package/dist/index.js +6 -6
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +2 -2
- package/dist/playground-assets.d.ts +165 -1
- package/etc/playground-assets.api.json +2474 -554
- package/etc/playground-assets.api.md +123 -0
- package/package.json +4 -4
@@ -1,7 +1,7 @@
|
|
1
1
|
{
|
2
2
|
"name": "@dcl/sdk",
|
3
3
|
"description": "",
|
4
|
-
"version": "7.5.
|
4
|
+
"version": "7.5.7-9891810625.commit-d9f5cf2",
|
5
5
|
"author": "Decentraland",
|
6
6
|
"dependencies": {
|
7
7
|
"@dcl/ecs": "file:../ecs",
|
@@ -35,5 +35,5 @@
|
|
35
35
|
},
|
36
36
|
"types": "./index.d.ts",
|
37
37
|
"typings": "./index.d.ts",
|
38
|
-
"commit": "
|
38
|
+
"commit": "d9f5cf295888b87c72efd42fa6874b8754f97eb7"
|
39
39
|
}
|
@@ -177,6 +177,18 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
|
|
177
177
|
/** @public */
|
178
178
|
export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
|
179
179
|
|
180
|
+
/**
|
181
|
+
* @public
|
182
|
+
*/
|
183
|
+
export declare const enum AvatarControlType {
|
184
|
+
/** CCT_NONE - avatar cannot move */
|
185
|
+
CCT_NONE = 0,
|
186
|
+
/** CCT_RELATIVE - avatar moves relative to the camera origin */
|
187
|
+
CCT_RELATIVE = 1,
|
188
|
+
/** CCT_TANK - avatar moves like a tank: left/right rotate the player, forward/backward advance/retreat the player */
|
189
|
+
CCT_TANK = 2
|
190
|
+
}
|
191
|
+
|
180
192
|
/** @public */
|
181
193
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
182
194
|
|
@@ -197,6 +209,37 @@ export declare const enum AvatarModifierType {
|
|
197
209
|
AMT_DISABLE_PASSPORTS = 1
|
198
210
|
}
|
199
211
|
|
212
|
+
/**
|
213
|
+
* @public
|
214
|
+
*/
|
215
|
+
export declare interface AvatarMovementSettings {
|
216
|
+
controlMode?: AvatarControlType | undefined;
|
217
|
+
/** if not explicitly set, the following properties default to user's preference settings */
|
218
|
+
runSpeed?: number | undefined;
|
219
|
+
/** how fast the player gets up to speed or comes to rest. higher = more responsive */
|
220
|
+
friction?: number | undefined;
|
221
|
+
/** how fast the player accelerates vertically when not on a solid surface, in m/s. should normally be negative */
|
222
|
+
gravity?: number | undefined;
|
223
|
+
/** how high the player can jump, in meters. should normally be positive. gravity must have the same sign for jumping to be possible */
|
224
|
+
jumpHeight?: number | undefined;
|
225
|
+
/** max fall speed in m/s. should normally be negative */
|
226
|
+
maxFallSpeed?: number | undefined;
|
227
|
+
/** speed the player turns in tank mode, in radians/s */
|
228
|
+
turnSpeed?: number | undefined;
|
229
|
+
/** speed the player walks at, in m/s */
|
230
|
+
walkSpeed?: number | undefined;
|
231
|
+
/** 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 */
|
232
|
+
allowWeightedMovement?: boolean | undefined;
|
233
|
+
}
|
234
|
+
|
235
|
+
/**
|
236
|
+
* @public
|
237
|
+
*/
|
238
|
+
export declare namespace AvatarMovementSettings {
|
239
|
+
export function encode(message: AvatarMovementSettings, writer?: _m0.Writer): _m0.Writer;
|
240
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
241
|
+
}
|
242
|
+
|
200
243
|
/** @public */
|
201
244
|
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
202
245
|
|
@@ -479,6 +522,39 @@ export declare const enum CameraType {
|
|
479
522
|
|
480
523
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
481
524
|
|
525
|
+
/**
|
526
|
+
* @public
|
527
|
+
*/
|
528
|
+
export declare interface CinematicSettings {
|
529
|
+
/** Entity that defines the cinematic camera transform. */
|
530
|
+
cameraEntity: number;
|
531
|
+
/**
|
532
|
+
* Position -> camera's position
|
533
|
+
* Rotation -> camera's direction
|
534
|
+
* scale.z -> zoom level
|
535
|
+
* scale.x and scale.y -> unused
|
536
|
+
*/
|
537
|
+
allowManualRotation?: boolean | undefined;
|
538
|
+
/** how far the camera can rotate around the y-axis / look left/right, in radians. default unrestricted */
|
539
|
+
yawRange?: number | undefined;
|
540
|
+
/** how far the camera can rotate around the x-axis / look up-down, in radians. default unrestricted */
|
541
|
+
pitchRange?: number | undefined;
|
542
|
+
/** note: cameras can never look up/down further than Vec3::Y */
|
543
|
+
rollRange?: number | undefined;
|
544
|
+
/** minimum zoom level. must be greater than 0. defaults to the input zoom level */
|
545
|
+
zoomMin?: number | undefined;
|
546
|
+
/** maximum zoom level. must be greater than 0. defaults to the input zoom level */
|
547
|
+
zoomMax?: number | undefined;
|
548
|
+
}
|
549
|
+
|
550
|
+
/**
|
551
|
+
* @public
|
552
|
+
*/
|
553
|
+
export declare namespace CinematicSettings {
|
554
|
+
export function encode(message: CinematicSettings, writer?: _m0.Writer): _m0.Writer;
|
555
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): CinematicSettings;
|
556
|
+
}
|
557
|
+
|
482
558
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
483
559
|
/**
|
484
560
|
* @public
|
@@ -1278,6 +1354,7 @@ export declare const componentDefinitionByName: {
|
|
1278
1354
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
1279
1355
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
1280
1356
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
1357
|
+
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
1281
1358
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
1282
1359
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
1283
1360
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
@@ -4163,6 +4240,9 @@ export declare interface PBAvatarModifierArea {
|
|
4163
4240
|
excludeIds: string[];
|
4164
4241
|
/** list of modifiers to apply */
|
4165
4242
|
modifiers: AvatarModifierType[];
|
4243
|
+
movementSettings?: AvatarMovementSettings | undefined;
|
4244
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4245
|
+
useColliderRange?: boolean | undefined;
|
4166
4246
|
}
|
4167
4247
|
|
4168
4248
|
/**
|
@@ -4275,7 +4355,7 @@ export declare namespace PBCameraMode {
|
|
4275
4355
|
|
4276
4356
|
/**
|
4277
4357
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4278
|
-
* the player's camera mode (1st-person
|
4358
|
+
* the player's camera mode (1st-person, 3rd-person or cinematic) is overridden.
|
4279
4359
|
*
|
4280
4360
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4281
4361
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4285,6 +4365,8 @@ export declare namespace PBCameraMode {
|
|
4285
4365
|
*
|
4286
4366
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4287
4367
|
* is actually a 3D volume.
|
4368
|
+
*
|
4369
|
+
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4288
4370
|
*/
|
4289
4371
|
/**
|
4290
4372
|
* @public
|
@@ -4294,6 +4376,9 @@ export declare interface PBCameraModeArea {
|
|
4294
4376
|
area: PBVector3 | undefined;
|
4295
4377
|
/** the camera mode to enforce */
|
4296
4378
|
mode: CameraType;
|
4379
|
+
cinematicSettings?: CinematicSettings | undefined;
|
4380
|
+
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4381
|
+
useColliderRange?: boolean | undefined;
|
4297
4382
|
}
|
4298
4383
|
|
4299
4384
|
/**
|
@@ -5275,6 +5360,21 @@ export declare namespace PBUiInputResult {
|
|
5275
5360
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5276
5361
|
}
|
5277
5362
|
|
5363
|
+
/**
|
5364
|
+
* @public
|
5365
|
+
*/
|
5366
|
+
export declare interface PBUiScrollResult {
|
5367
|
+
value: PBVector2 | undefined;
|
5368
|
+
}
|
5369
|
+
|
5370
|
+
/**
|
5371
|
+
* @public
|
5372
|
+
*/
|
5373
|
+
export declare namespace PBUiScrollResult {
|
5374
|
+
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
5375
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
5376
|
+
}
|
5377
|
+
|
5278
5378
|
/**
|
5279
5379
|
* @public
|
5280
5380
|
*/
|
@@ -5291,6 +5391,10 @@ export declare interface PBUiText {
|
|
5291
5391
|
fontSize?: number | undefined;
|
5292
5392
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
5293
5393
|
textWrap?: TextWrap | undefined;
|
5394
|
+
/** width of the outline (default: 0) */
|
5395
|
+
outlineWidth?: number | undefined;
|
5396
|
+
/** RGBA color of the outline (default: opaque black) */
|
5397
|
+
outlineColor?: PBColor4 | undefined;
|
5294
5398
|
}
|
5295
5399
|
|
5296
5400
|
/**
|
@@ -5387,6 +5491,14 @@ export declare interface PBUiTransform {
|
|
5387
5491
|
paddingBottom: number;
|
5388
5492
|
/** default: PointerFilterMode.PFM_NONE */
|
5389
5493
|
pointerFilter?: PointerFilterMode | undefined;
|
5494
|
+
/** default: 1 */
|
5495
|
+
opacity?: number | undefined;
|
5496
|
+
/** default empty */
|
5497
|
+
elementId?: string | undefined;
|
5498
|
+
/** default position=(0,0) */
|
5499
|
+
scrollPosition?: ScrollPositionValue | undefined;
|
5500
|
+
/** default ShowScrollBar.SSB_BOTH */
|
5501
|
+
scrollVisible?: ShowScrollBar | undefined;
|
5390
5502
|
}
|
5391
5503
|
|
5392
5504
|
/**
|
@@ -6750,6 +6862,43 @@ export declare namespace Schemas {
|
|
6750
6862
|
}) => void;
|
6751
6863
|
}
|
6752
6864
|
|
6865
|
+
/**
|
6866
|
+
* @public
|
6867
|
+
*/
|
6868
|
+
export declare interface ScrollPositionValue {
|
6869
|
+
value?: {
|
6870
|
+
$case: "position";
|
6871
|
+
position: PBVector2;
|
6872
|
+
} | {
|
6873
|
+
$case: "reference";
|
6874
|
+
reference: string;
|
6875
|
+
} | undefined;
|
6876
|
+
}
|
6877
|
+
|
6878
|
+
/**
|
6879
|
+
* @public
|
6880
|
+
*/
|
6881
|
+
export declare namespace ScrollPositionValue {
|
6882
|
+
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
6883
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
6884
|
+
}
|
6885
|
+
|
6886
|
+
/**
|
6887
|
+
* @public
|
6888
|
+
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
6889
|
+
*/
|
6890
|
+
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
6891
|
+
|
6892
|
+
/**
|
6893
|
+
* @public
|
6894
|
+
*/
|
6895
|
+
export declare const enum ShowScrollBar {
|
6896
|
+
SSB_BOTH = 0,
|
6897
|
+
SSB_ONLY_VERTICAL = 1,
|
6898
|
+
SSB_ONLY_HORIZONTAL = 2,
|
6899
|
+
SSB_HIDDEN = 3
|
6900
|
+
}
|
6901
|
+
|
6753
6902
|
/**
|
6754
6903
|
* @public
|
6755
6904
|
*/
|
@@ -7178,6 +7327,10 @@ export declare interface UiLabelProps {
|
|
7178
7327
|
textAlign?: TextAlignType | undefined;
|
7179
7328
|
/** Label font type. @defaultValue 'sans-serif' */
|
7180
7329
|
font?: UiFontType | undefined;
|
7330
|
+
/** Outline width of the text. @defaultValue 0 */
|
7331
|
+
outlineWidth?: number | undefined;
|
7332
|
+
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
7333
|
+
outlineColor?: PBColor4 | undefined;
|
7181
7334
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
7182
7335
|
textWrap?: UiTextWrapType | undefined;
|
7183
7336
|
}
|
@@ -7187,6 +7340,9 @@ export declare interface UiLabelProps {
|
|
7187
7340
|
*/
|
7188
7341
|
export declare type uint32 = number;
|
7189
7342
|
|
7343
|
+
/** @public */
|
7344
|
+
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
7345
|
+
|
7190
7346
|
/** @public */
|
7191
7347
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
7192
7348
|
|
@@ -7259,6 +7415,14 @@ export declare interface UiTransformProps {
|
|
7259
7415
|
overflow?: OverflowType;
|
7260
7416
|
/** 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) **/
|
7261
7417
|
pointerFilter?: PointerFilterType;
|
7418
|
+
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
7419
|
+
opacity?: number;
|
7420
|
+
/** A reference value to identify the element, default empty */
|
7421
|
+
elementId?: string;
|
7422
|
+
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
7423
|
+
scrollPosition?: PBVector2 | string;
|
7424
|
+
/** default ShowScrollBar.SSB_BOTH */
|
7425
|
+
scrollVisible?: ScrollVisibleType;
|
7262
7426
|
}
|
7263
7427
|
|
7264
7428
|
/**
|