@dcl/playground-assets 7.5.7-9891810625.commit-d9f5cf2 → 7.5.7
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 +45 -165
- package/dist/beta.d.ts +45 -165
- package/dist/index.bundled.d.ts +45 -165
- package/dist/index.js +6 -6
- package/dist/index.js.map +4 -4
- package/dist/playground/sdk/dcl-sdk.package.json +3 -3
- package/dist/playground-assets.d.ts +45 -165
- package/dist/tsdoc-metadata.json +1 -1
- package/etc/playground-assets.api.json +1223 -2543
- package/etc/playground-assets.api.md +46 -124
- package/package.json +4 -4
package/dist/index.bundled.d.ts
CHANGED
@@ -143,6 +143,7 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
|
|
143
143
|
* @public
|
144
144
|
*/
|
145
145
|
export declare const enum AvatarAnchorPointType {
|
146
|
+
/** AAPT_POSITION - @deprecated consider parenting to `engine.PlayerEntity`, this will attach to player position with an arbitrary offset */
|
146
147
|
AAPT_POSITION = 0,
|
147
148
|
AAPT_NAME_TAG = 1,
|
148
149
|
AAPT_HEAD = 4,
|
@@ -177,18 +178,6 @@ export declare const AvatarAttach: LastWriteWinElementSetComponentDefinition<PBA
|
|
177
178
|
/** @public */
|
178
179
|
export declare const AvatarBase: LastWriteWinElementSetComponentDefinition<PBAvatarBase>;
|
179
180
|
|
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
|
-
|
192
181
|
/** @public */
|
193
182
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
194
183
|
|
@@ -209,37 +198,6 @@ export declare const enum AvatarModifierType {
|
|
209
198
|
AMT_DISABLE_PASSPORTS = 1
|
210
199
|
}
|
211
200
|
|
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
|
-
|
243
201
|
/** @public */
|
244
202
|
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
245
203
|
|
@@ -522,39 +480,6 @@ export declare const enum CameraType {
|
|
522
480
|
|
523
481
|
export declare type Children = ReactEcs.JSX.ReactNode;
|
524
482
|
|
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
|
-
|
558
483
|
/** ColliderLayer determines the kind of collision to detect, in OR-able bit flag form. */
|
559
484
|
/**
|
560
485
|
* @public
|
@@ -1333,6 +1258,7 @@ export declare const componentDefinitionByName: {
|
|
1333
1258
|
"core::EngineInfo": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBEngineInfo>>;
|
1334
1259
|
"core::GltfContainer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainer>>;
|
1335
1260
|
"core::GltfContainerLoadingState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBGltfContainerLoadingState>>;
|
1261
|
+
"core::InputModifier": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBInputModifier>>;
|
1336
1262
|
"core::Material": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMaterial>>;
|
1337
1263
|
"core::MeshCollider": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshCollider>>;
|
1338
1264
|
"core::MeshRenderer": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBMeshRenderer>>;
|
@@ -1354,7 +1280,6 @@ export declare const componentDefinitionByName: {
|
|
1354
1280
|
"core::UiDropdownResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiDropdownResult>>;
|
1355
1281
|
"core::UiInput": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInput>>;
|
1356
1282
|
"core::UiInputResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiInputResult>>;
|
1357
|
-
"core::UiScrollResult": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiScrollResult>>;
|
1358
1283
|
"core::UiText": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiText>>;
|
1359
1284
|
"core::UiTransform": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBUiTransform>>;
|
1360
1285
|
"core::VideoEvent": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBVideoEvent>>;
|
@@ -2475,6 +2400,9 @@ export declare const enum InputAction {
|
|
2475
2400
|
IA_ACTION_6 = 13
|
2476
2401
|
}
|
2477
2402
|
|
2403
|
+
/** @public */
|
2404
|
+
export declare const InputModifier: LastWriteWinElementSetComponentDefinition<PBInputModifier>;
|
2405
|
+
|
2478
2406
|
/**
|
2479
2407
|
* @public
|
2480
2408
|
* Input system manager. Check for button events
|
@@ -4212,9 +4140,6 @@ export declare interface PBAvatarModifierArea {
|
|
4212
4140
|
excludeIds: string[];
|
4213
4141
|
/** list of modifiers to apply */
|
4214
4142
|
modifiers: AvatarModifierType[];
|
4215
|
-
movementSettings?: AvatarMovementSettings | undefined;
|
4216
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4217
|
-
useColliderRange?: boolean | undefined;
|
4218
4143
|
}
|
4219
4144
|
|
4220
4145
|
/**
|
@@ -4327,7 +4252,7 @@ export declare namespace PBCameraMode {
|
|
4327
4252
|
|
4328
4253
|
/**
|
4329
4254
|
* The CameraModeArea component can be attached to an Entity to define a region of space where
|
4330
|
-
* the player's camera mode (1st-person
|
4255
|
+
* the player's camera mode (1st-person or 3rd-person) is overridden.
|
4331
4256
|
*
|
4332
4257
|
* The Entity's Transform position determines the center-point of the region, while its size is
|
4333
4258
|
* given as a vector in the `area` property below. The Transform rotation is applied, but the scale
|
@@ -4337,8 +4262,6 @@ export declare namespace PBCameraMode {
|
|
4337
4262
|
*
|
4338
4263
|
* Note that, while commonly used to delineate a 2D area in a scene (hence the name), the region
|
4339
4264
|
* is actually a 3D volume.
|
4340
|
-
*
|
4341
|
-
* When mode is set to CtCinematic, the cinematic_settings field must also be provided.
|
4342
4265
|
*/
|
4343
4266
|
/**
|
4344
4267
|
* @public
|
@@ -4348,9 +4271,6 @@ export declare interface PBCameraModeArea {
|
|
4348
4271
|
area: PBVector3 | undefined;
|
4349
4272
|
/** the camera mode to enforce */
|
4350
4273
|
mode: CameraType;
|
4351
|
-
cinematicSettings?: CinematicSettings | undefined;
|
4352
|
-
/** if true, the player will be considered inside the area when they are within 0.3m of the area. default true */
|
4353
|
-
useColliderRange?: boolean | undefined;
|
4354
4274
|
}
|
4355
4275
|
|
4356
4276
|
/**
|
@@ -4467,6 +4387,45 @@ export declare namespace PBGltfContainerLoadingState {
|
|
4467
4387
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBGltfContainerLoadingState;
|
4468
4388
|
}
|
4469
4389
|
|
4390
|
+
/**
|
4391
|
+
* @public
|
4392
|
+
*/
|
4393
|
+
export declare interface PBInputModifier {
|
4394
|
+
mode?: {
|
4395
|
+
$case: "standard";
|
4396
|
+
standard: PBInputModifier_StandardInput;
|
4397
|
+
} | undefined;
|
4398
|
+
}
|
4399
|
+
|
4400
|
+
/**
|
4401
|
+
* @public
|
4402
|
+
*/
|
4403
|
+
export declare namespace PBInputModifier {
|
4404
|
+
export function encode(message: PBInputModifier, writer?: _m0.Writer): _m0.Writer;
|
4405
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier;
|
4406
|
+
}
|
4407
|
+
|
4408
|
+
/** when a boolean = false (default) the message is ignored and doesn't consume bandwidth */
|
4409
|
+
/**
|
4410
|
+
* @public
|
4411
|
+
*/
|
4412
|
+
export declare interface PBInputModifier_StandardInput {
|
4413
|
+
disableAll?: boolean | undefined;
|
4414
|
+
disableWalk?: boolean | undefined;
|
4415
|
+
disableJog?: boolean | undefined;
|
4416
|
+
disableRun?: boolean | undefined;
|
4417
|
+
disableJump?: boolean | undefined;
|
4418
|
+
disableEmote?: boolean | undefined;
|
4419
|
+
}
|
4420
|
+
|
4421
|
+
/**
|
4422
|
+
* @public
|
4423
|
+
*/
|
4424
|
+
export declare namespace PBInputModifier_StandardInput {
|
4425
|
+
export function encode(message: PBInputModifier_StandardInput, writer?: _m0.Writer): _m0.Writer;
|
4426
|
+
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBInputModifier_StandardInput;
|
4427
|
+
}
|
4428
|
+
|
4470
4429
|
/**
|
4471
4430
|
* @public
|
4472
4431
|
*/
|
@@ -5332,21 +5291,6 @@ export declare namespace PBUiInputResult {
|
|
5332
5291
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiInputResult;
|
5333
5292
|
}
|
5334
5293
|
|
5335
|
-
/**
|
5336
|
-
* @public
|
5337
|
-
*/
|
5338
|
-
export declare interface PBUiScrollResult {
|
5339
|
-
value: PBVector2 | undefined;
|
5340
|
-
}
|
5341
|
-
|
5342
|
-
/**
|
5343
|
-
* @public
|
5344
|
-
*/
|
5345
|
-
export declare namespace PBUiScrollResult {
|
5346
|
-
export function encode(message: PBUiScrollResult, writer?: _m0.Writer): _m0.Writer;
|
5347
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): PBUiScrollResult;
|
5348
|
-
}
|
5349
|
-
|
5350
5294
|
/**
|
5351
5295
|
* @public
|
5352
5296
|
*/
|
@@ -5363,10 +5307,6 @@ export declare interface PBUiText {
|
|
5363
5307
|
fontSize?: number | undefined;
|
5364
5308
|
/** wrap text when the border is reached (default: TW_WRAP) */
|
5365
5309
|
textWrap?: TextWrap | undefined;
|
5366
|
-
/** width of the outline (default: 0) */
|
5367
|
-
outlineWidth?: number | undefined;
|
5368
|
-
/** RGBA color of the outline (default: opaque black) */
|
5369
|
-
outlineColor?: PBColor4 | undefined;
|
5370
5310
|
}
|
5371
5311
|
|
5372
5312
|
/**
|
@@ -5463,14 +5403,6 @@ export declare interface PBUiTransform {
|
|
5463
5403
|
paddingBottom: number;
|
5464
5404
|
/** default: PointerFilterMode.PFM_NONE */
|
5465
5405
|
pointerFilter?: PointerFilterMode | undefined;
|
5466
|
-
/** default: 1 */
|
5467
|
-
opacity?: number | undefined;
|
5468
|
-
/** default empty */
|
5469
|
-
elementId?: string | undefined;
|
5470
|
-
/** default position=(0,0) */
|
5471
|
-
scrollPosition?: ScrollPositionValue | undefined;
|
5472
|
-
/** default ShowScrollBar.SSB_BOTH */
|
5473
|
-
scrollVisible?: ShowScrollBar | undefined;
|
5474
5406
|
}
|
5475
5407
|
|
5476
5408
|
/**
|
@@ -6834,43 +6766,6 @@ export declare namespace Schemas {
|
|
6834
6766
|
}) => void;
|
6835
6767
|
}
|
6836
6768
|
|
6837
|
-
/**
|
6838
|
-
* @public
|
6839
|
-
*/
|
6840
|
-
export declare interface ScrollPositionValue {
|
6841
|
-
value?: {
|
6842
|
-
$case: "position";
|
6843
|
-
position: PBVector2;
|
6844
|
-
} | {
|
6845
|
-
$case: "reference";
|
6846
|
-
reference: string;
|
6847
|
-
} | undefined;
|
6848
|
-
}
|
6849
|
-
|
6850
|
-
/**
|
6851
|
-
* @public
|
6852
|
-
*/
|
6853
|
-
export declare namespace ScrollPositionValue {
|
6854
|
-
export function encode(message: ScrollPositionValue, writer?: _m0.Writer): _m0.Writer;
|
6855
|
-
export function decode(input: _m0.Reader | Uint8Array, length?: number): ScrollPositionValue;
|
6856
|
-
}
|
6857
|
-
|
6858
|
-
/**
|
6859
|
-
* @public
|
6860
|
-
* The scroll-visible determines if the scrollbars are shown when the scroll overflow is enabled
|
6861
|
-
*/
|
6862
|
-
export declare type ScrollVisibleType = 'horizontal' | 'vertical' | 'both' | 'hidden';
|
6863
|
-
|
6864
|
-
/**
|
6865
|
-
* @public
|
6866
|
-
*/
|
6867
|
-
export declare const enum ShowScrollBar {
|
6868
|
-
SSB_BOTH = 0,
|
6869
|
-
SSB_ONLY_VERTICAL = 1,
|
6870
|
-
SSB_ONLY_HORIZONTAL = 2,
|
6871
|
-
SSB_HIDDEN = 3
|
6872
|
-
}
|
6873
|
-
|
6874
6769
|
/**
|
6875
6770
|
* @public
|
6876
6771
|
*/
|
@@ -7294,10 +7189,6 @@ export declare interface UiLabelProps {
|
|
7294
7189
|
textAlign?: TextAlignType | undefined;
|
7295
7190
|
/** Label font type. @defaultValue 'sans-serif' */
|
7296
7191
|
font?: UiFontType | undefined;
|
7297
|
-
/** Outline width of the text. @defaultValue 0 */
|
7298
|
-
outlineWidth?: number | undefined;
|
7299
|
-
/** Outline color of the text. @defaultValue `{ r: 0, g: 0, b: 0, a: 1 }` */
|
7300
|
-
outlineColor?: PBColor4 | undefined;
|
7301
7192
|
/** Behaviour when text reached. @defaultValue 'wrap' */
|
7302
7193
|
textWrap?: UiTextWrapType | undefined;
|
7303
7194
|
}
|
@@ -7307,9 +7198,6 @@ export declare interface UiLabelProps {
|
|
7307
7198
|
*/
|
7308
7199
|
export declare type uint32 = number;
|
7309
7200
|
|
7310
|
-
/** @public */
|
7311
|
-
export declare const UiScrollResult: LastWriteWinElementSetComponentDefinition<PBUiScrollResult>;
|
7312
|
-
|
7313
7201
|
/** @public */
|
7314
7202
|
export declare const UiText: LastWriteWinElementSetComponentDefinition<PBUiText>;
|
7315
7203
|
|
@@ -7382,14 +7270,6 @@ export declare interface UiTransformProps {
|
|
7382
7270
|
overflow?: OverflowType;
|
7383
7271
|
/** 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) **/
|
7384
7272
|
pointerFilter?: PointerFilterType;
|
7385
|
-
/** The opacity property sets the opacity level for an element, it's accumulated across children @defaultValue 1 */
|
7386
|
-
opacity?: number;
|
7387
|
-
/** A reference value to identify the element, default empty */
|
7388
|
-
elementId?: string;
|
7389
|
-
/** default position=(0,0) if it aplies, a vector or a reference-id */
|
7390
|
-
scrollPosition?: PBVector2 | string;
|
7391
|
-
/** default ShowScrollBar.SSB_BOTH */
|
7392
|
-
scrollVisible?: ScrollVisibleType;
|
7393
7273
|
}
|
7394
7274
|
|
7395
7275
|
/**
|