@dcl/playground-assets 7.12.3-19251638766.commit-26dce86 → 7.12.3-19269915433.commit-cbf59ef
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 +233 -11
- package/dist/beta.d.ts +233 -11
- package/dist/index.bundled.d.ts +233 -11
- 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 +233 -11
- package/etc/playground-assets.api.json +2608 -614
- package/etc/playground-assets.api.md +80 -10
- package/package.json +4 -4
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@dcl/sdk",
|
|
3
3
|
"description": "",
|
|
4
|
-
"version": "7.12.3-
|
|
4
|
+
"version": "7.12.3-19269915433.commit-cbf59ef",
|
|
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": "cbf59ef1058908f01a067d3044c09ffb804dd427"
|
|
39
39
|
}
|
|
@@ -193,7 +193,8 @@ export declare const enum AvatarControlType {
|
|
|
193
193
|
/** @public */
|
|
194
194
|
export declare const AvatarEmoteCommand: GrowOnlyValueSetComponentDefinition<PBAvatarEmoteCommand>;
|
|
195
195
|
|
|
196
|
-
|
|
196
|
+
/** @public */
|
|
197
|
+
export declare const AvatarEquippedData: LastWriteWinElementSetComponentDefinition<PBAvatarEquippedData>;
|
|
197
198
|
|
|
198
199
|
/**
|
|
199
200
|
* @public
|
|
@@ -249,7 +250,8 @@ export declare namespace AvatarMovementSettings {
|
|
|
249
250
|
export function decode(input: _m0.Reader | Uint8Array, length?: number): AvatarMovementSettings;
|
|
250
251
|
}
|
|
251
252
|
|
|
252
|
-
|
|
253
|
+
/** @public */
|
|
254
|
+
export declare const AvatarShape: LastWriteWinElementSetComponentDefinition<PBAvatarShape>;
|
|
253
255
|
|
|
254
256
|
/**
|
|
255
257
|
* @public
|
|
@@ -1434,7 +1436,7 @@ export declare const componentDefinitionByName: {
|
|
|
1434
1436
|
"core::TextShape": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextShape>>;
|
|
1435
1437
|
"core::TextureCamera": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTextureCamera>>;
|
|
1436
1438
|
"core::TriggerArea": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTriggerArea>>;
|
|
1437
|
-
"core::TriggerAreaResult":
|
|
1439
|
+
"core::TriggerAreaResult": GSetComponentGetter<GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>>;
|
|
1438
1440
|
"core::Tween": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTween>>;
|
|
1439
1441
|
"core::TweenSequence": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenSequence>>;
|
|
1440
1442
|
"core::TweenState": LwwComponentGetter<LastWriteWinElementSetComponentDefinition<PBTweenState>>;
|
|
@@ -2394,6 +2396,13 @@ export declare interface IEngine {
|
|
|
2394
2396
|
* @typeParam T - The type of the entity name value
|
|
2395
2397
|
*/
|
|
2396
2398
|
getEntityByName<T = never, K = T>(value: K & (T extends never ? never : string)): Entity;
|
|
2399
|
+
/**
|
|
2400
|
+
* @public
|
|
2401
|
+
* Get all entities that have a specific tag in their Tag component
|
|
2402
|
+
* @param tag - Tag to search
|
|
2403
|
+
* @returns Iterator of entities that have the given tag
|
|
2404
|
+
*/
|
|
2405
|
+
getEntitiesByTag(tagName: string): Iterable<Entity>;
|
|
2397
2406
|
/**
|
|
2398
2407
|
* @public
|
|
2399
2408
|
* @param deltaTime - deltaTime in seconds
|
|
@@ -2831,8 +2840,31 @@ export declare interface LastWriteWinElementSetComponentDefinition<T> extends Ba
|
|
|
2831
2840
|
getOrCreateMutable(entity: Entity, initialValue?: T): T;
|
|
2832
2841
|
}
|
|
2833
2842
|
|
|
2834
|
-
|
|
2835
|
-
|
|
2843
|
+
export declare const LightSource: LightSourceComponentDefinitionExtended;
|
|
2844
|
+
|
|
2845
|
+
/**
|
|
2846
|
+
* @public
|
|
2847
|
+
*/
|
|
2848
|
+
export declare interface LightSourceComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBLightSource> {
|
|
2849
|
+
/**
|
|
2850
|
+
* LightSource helper with constructor
|
|
2851
|
+
*/
|
|
2852
|
+
Type: LightSourceHelper;
|
|
2853
|
+
}
|
|
2854
|
+
|
|
2855
|
+
/**
|
|
2856
|
+
* @public
|
|
2857
|
+
*/
|
|
2858
|
+
export declare interface LightSourceHelper {
|
|
2859
|
+
/**
|
|
2860
|
+
* @returns a Light Source type
|
|
2861
|
+
*/
|
|
2862
|
+
Point: (point: PBLightSource_Point) => PBLightSource['type'];
|
|
2863
|
+
/**
|
|
2864
|
+
* @returns a Light Source type
|
|
2865
|
+
*/
|
|
2866
|
+
Spot: (spot: PBLightSource_Spot) => PBLightSource['type'];
|
|
2867
|
+
}
|
|
2836
2868
|
|
|
2837
2869
|
/**
|
|
2838
2870
|
* User key event Listeners
|
|
@@ -8078,6 +8110,33 @@ export declare type SystemItem = {
|
|
|
8078
8110
|
|
|
8079
8111
|
export declare const SYSTEMS_REGULAR_PRIORITY = 100000;
|
|
8080
8112
|
|
|
8113
|
+
export declare const Tags: TagsComponentDefinitionExtended;
|
|
8114
|
+
|
|
8115
|
+
export declare interface TagsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<TagsType> {
|
|
8116
|
+
/**
|
|
8117
|
+
* @public
|
|
8118
|
+
*
|
|
8119
|
+
* Add a tag to the entity's Tags component or create the component if it doesn't exist and add the tag
|
|
8120
|
+
* @param entity - entity to add the tag to
|
|
8121
|
+
* @param tagName - the tag name to add
|
|
8122
|
+
* @returns true
|
|
8123
|
+
*/
|
|
8124
|
+
add(entity: Entity, tagName: string): boolean;
|
|
8125
|
+
/**
|
|
8126
|
+
* @public
|
|
8127
|
+
*
|
|
8128
|
+
* Remove a tag from the entity's Tags component
|
|
8129
|
+
* @param entity - entity to remove the tag from
|
|
8130
|
+
* @param tagName - the tag name to remove
|
|
8131
|
+
* @returns true if successful, false if the entity doesn't have a Tags component or the tag doesn't exist
|
|
8132
|
+
*/
|
|
8133
|
+
remove(entity: Entity, tagName: string): boolean;
|
|
8134
|
+
}
|
|
8135
|
+
|
|
8136
|
+
export declare interface TagsType {
|
|
8137
|
+
tags: string[];
|
|
8138
|
+
}
|
|
8139
|
+
|
|
8081
8140
|
export declare type TargetEntityRaycastOptions = RaycastSystemOptions & TargetEntityRaycastSystemOptions;
|
|
8082
8141
|
|
|
8083
8142
|
export declare type TargetEntityRaycastSystemOptions = {
|
|
@@ -8371,8 +8430,83 @@ export declare type Transport = {
|
|
|
8371
8430
|
*/
|
|
8372
8431
|
export declare type TransportMessage = Omit<ReceiveMessage, 'data'>;
|
|
8373
8432
|
|
|
8374
|
-
|
|
8375
|
-
|
|
8433
|
+
export declare const TriggerArea: TriggerAreaComponentDefinitionExtended;
|
|
8434
|
+
|
|
8435
|
+
/**
|
|
8436
|
+
* @public
|
|
8437
|
+
*/
|
|
8438
|
+
export declare interface TriggerAreaComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<PBTriggerArea> {
|
|
8439
|
+
/**
|
|
8440
|
+
* @public
|
|
8441
|
+
* Set a box in the MeshCollider component
|
|
8442
|
+
* @param entity - entity to create or replace the TriggerArea component
|
|
8443
|
+
* @param collisionMask - the collision layers mask for the trigger to react, default: Player
|
|
8444
|
+
*/
|
|
8445
|
+
setBox(entity: Entity, collisionMask?: ColliderLayer | ColliderLayer[]): void;
|
|
8446
|
+
/**
|
|
8447
|
+
* @public
|
|
8448
|
+
* Set a sphere in the MeshCollider component
|
|
8449
|
+
* @param entity - entity to create or replace the TriggerArea component
|
|
8450
|
+
* @param collisionMask - the collision layers mask for the trigger to react, default: Player
|
|
8451
|
+
*/
|
|
8452
|
+
setSphere(entity: Entity, collisionMask?: ColliderLayer | ColliderLayer[]): void;
|
|
8453
|
+
}
|
|
8454
|
+
|
|
8455
|
+
/**
|
|
8456
|
+
* @public
|
|
8457
|
+
*/
|
|
8458
|
+
export declare interface TriggerAreaEventsSystem {
|
|
8459
|
+
/**
|
|
8460
|
+
* @public
|
|
8461
|
+
* Execute callback when an entity enters the Trigger Area
|
|
8462
|
+
* @param entity - The entity that already has the TriggerArea component
|
|
8463
|
+
* @param cb - Function to execute the 'Enter' type of result is detected
|
|
8464
|
+
*/
|
|
8465
|
+
onTriggerEnter(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
|
|
8466
|
+
/**
|
|
8467
|
+
* @public
|
|
8468
|
+
* Remove the callback for Trigger Area 'Enter' type of result
|
|
8469
|
+
* @param entity - Entity where the Trigger Area was attached
|
|
8470
|
+
*/
|
|
8471
|
+
removeOnTriggerEnter(entity: Entity): void;
|
|
8472
|
+
/**
|
|
8473
|
+
* @public
|
|
8474
|
+
* Execute callback when an entity stays in the Trigger Area
|
|
8475
|
+
* @param entity - The entity that already has the TriggerArea component
|
|
8476
|
+
* @param cb - Function to execute the 'Stay' type of result is detected
|
|
8477
|
+
*/
|
|
8478
|
+
onTriggerStay(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
|
|
8479
|
+
/**
|
|
8480
|
+
* @public
|
|
8481
|
+
* Remove the callback for Trigger Area 'Stay' type of result
|
|
8482
|
+
* @param entity - Entity where the Trigger Area was attached
|
|
8483
|
+
*/
|
|
8484
|
+
removeOnTriggerStay(entity: Entity): void;
|
|
8485
|
+
/**
|
|
8486
|
+
* @public
|
|
8487
|
+
* Execute callback when an entity exits the Trigger Area
|
|
8488
|
+
* @param entity - The entity that already has the TriggerArea component
|
|
8489
|
+
* @param cb - Function to execute the 'Exit' type of result is detected
|
|
8490
|
+
*/
|
|
8491
|
+
onTriggerExit(entity: Entity, cb: TriggerAreaEventSystemCallback): void;
|
|
8492
|
+
/**
|
|
8493
|
+
* @public
|
|
8494
|
+
* Remove the callback for Trigger Area 'Exit' type of result
|
|
8495
|
+
* @param entity - Entity where the Trigger Area was attached
|
|
8496
|
+
*/
|
|
8497
|
+
removeOnTriggerExit(entity: Entity): void;
|
|
8498
|
+
}
|
|
8499
|
+
|
|
8500
|
+
/**
|
|
8501
|
+
* @public
|
|
8502
|
+
* Register callback functions for trigger area results.
|
|
8503
|
+
*/
|
|
8504
|
+
export declare const triggerAreaEventsSystem: TriggerAreaEventsSystem;
|
|
8505
|
+
|
|
8506
|
+
/**
|
|
8507
|
+
* @public
|
|
8508
|
+
*/
|
|
8509
|
+
export declare type TriggerAreaEventSystemCallback = (result: DeepReadonlyObject<PBTriggerAreaResult>) => void;
|
|
8376
8510
|
|
|
8377
8511
|
/**
|
|
8378
8512
|
* @public
|
|
@@ -8392,7 +8526,7 @@ export declare const enum TriggerAreaMeshType {
|
|
|
8392
8526
|
}
|
|
8393
8527
|
|
|
8394
8528
|
/** @public */
|
|
8395
|
-
export declare const TriggerAreaResult:
|
|
8529
|
+
export declare const TriggerAreaResult: GrowOnlyValueSetComponentDefinition<PBTriggerAreaResult>;
|
|
8396
8530
|
|
|
8397
8531
|
export declare const Tween: TweenComponentDefinitionExtended;
|
|
8398
8532
|
|
|
@@ -8404,6 +8538,82 @@ export declare interface TweenComponentDefinitionExtended extends LastWriteWinEl
|
|
|
8404
8538
|
* Texture helpers with constructor
|
|
8405
8539
|
*/
|
|
8406
8540
|
Mode: TweenHelper;
|
|
8541
|
+
/**
|
|
8542
|
+
* @public
|
|
8543
|
+
*
|
|
8544
|
+
* Creates or replaces a move tween component that animates an entity's position from start to end
|
|
8545
|
+
* @param entity - entity to apply the tween to
|
|
8546
|
+
* @param start - starting position vector
|
|
8547
|
+
* @param end - ending position vector
|
|
8548
|
+
* @param duration - duration of the tween in milliseconds
|
|
8549
|
+
* @param easingFunction - easing function to use (defaults to EF_LINEAR)
|
|
8550
|
+
*/
|
|
8551
|
+
setMove(entity: Entity, start: PBVector3, end: PBVector3, duration: number, easingFunction?: EasingFunction): void;
|
|
8552
|
+
/**
|
|
8553
|
+
* @public
|
|
8554
|
+
*
|
|
8555
|
+
* Creates or replaces a scale tween component that animates an entity's scale from start to end
|
|
8556
|
+
* @param entity - entity to apply the tween to
|
|
8557
|
+
* @param start - starting scale vector
|
|
8558
|
+
* @param end - ending scale vector
|
|
8559
|
+
* @param duration - duration of the tween in milliseconds
|
|
8560
|
+
* @param easingFunction - easing function to use (defaults to EF_LINEAR)
|
|
8561
|
+
*/
|
|
8562
|
+
setScale(entity: Entity, start: PBVector3, end: PBVector3, duration: number, easingFunction?: EasingFunction): void;
|
|
8563
|
+
/**
|
|
8564
|
+
* @public
|
|
8565
|
+
*
|
|
8566
|
+
* Creates or replaces a rotation tween component that animates an entity's rotation from start to end
|
|
8567
|
+
* @param entity - entity to apply the tween to
|
|
8568
|
+
* @param start - starting rotation quaternion
|
|
8569
|
+
* @param end - ending rotation quaternion
|
|
8570
|
+
* @param duration - duration of the tween in milliseconds
|
|
8571
|
+
* @param easingFunction - easing function to use (defaults to EF_LINEAR)
|
|
8572
|
+
*/
|
|
8573
|
+
setRotate(entity: Entity, start: PBQuaternion, end: PBQuaternion, duration: number, easingFunction?: EasingFunction): void;
|
|
8574
|
+
/**
|
|
8575
|
+
* @public
|
|
8576
|
+
*
|
|
8577
|
+
* Creates or replaces a texture move tween component that animates texture UV coordinates from start to end
|
|
8578
|
+
* @param entity - entity to apply the tween to
|
|
8579
|
+
* @param start - starting UV coordinates
|
|
8580
|
+
* @param end - ending UV coordinates
|
|
8581
|
+
* @param duration - duration of the tween in milliseconds
|
|
8582
|
+
* @param movementType - type of texture movement (defaults to TMT_OFFSET)
|
|
8583
|
+
* @param easingFunction - easing function to use (defaults to EF_LINEAR)
|
|
8584
|
+
*/
|
|
8585
|
+
setTextureMove(entity: Entity, start: PBVector2, end: PBVector2, duration: number, movementType?: TextureMovementType, easingFunction?: EasingFunction): void;
|
|
8586
|
+
/**
|
|
8587
|
+
* @public
|
|
8588
|
+
*
|
|
8589
|
+
* Creates or replaces a continuous move tween component that moves an entity continuously in a direction
|
|
8590
|
+
* @param entity - entity to apply the tween to
|
|
8591
|
+
* @param direction - direction vector to move towards
|
|
8592
|
+
* @param speed - speed of movement per second
|
|
8593
|
+
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8594
|
+
*/
|
|
8595
|
+
setMoveContinuous(entity: Entity, direction: PBVector3, speed: number, duration?: number): void;
|
|
8596
|
+
/**
|
|
8597
|
+
* @public
|
|
8598
|
+
*
|
|
8599
|
+
* Creates or replaces a continuous rotation tween component that rotates an entity continuously
|
|
8600
|
+
* @param entity - entity to apply the tween to
|
|
8601
|
+
* @param direction - rotation direction quaternion
|
|
8602
|
+
* @param speed - speed of rotation per second
|
|
8603
|
+
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8604
|
+
*/
|
|
8605
|
+
setRotateContinuous(entity: Entity, direction: PBQuaternion, speed: number, duration?: number): void;
|
|
8606
|
+
/**
|
|
8607
|
+
* @public
|
|
8608
|
+
*
|
|
8609
|
+
* Creates or replaces a continuous texture move tween component that moves texture UV coordinates continuously
|
|
8610
|
+
* @param entity - entity to apply the tween to
|
|
8611
|
+
* @param direction - direction vector for UV movement
|
|
8612
|
+
* @param speed - speed of UV movement per second
|
|
8613
|
+
* @param movementType - type of texture movement (defaults to TMT_OFFSET)
|
|
8614
|
+
* @param duration - duration of the tween in milliseconds (defaults to 0 for infinite)
|
|
8615
|
+
*/
|
|
8616
|
+
setTextureMoveContinuous(entity: Entity, direction: PBVector2, speed: number, movementType?: TextureMovementType, duration?: number): void;
|
|
8407
8617
|
}
|
|
8408
8618
|
|
|
8409
8619
|
/**
|
|
@@ -8415,17 +8625,29 @@ export declare interface TweenHelper {
|
|
|
8415
8625
|
*/
|
|
8416
8626
|
Move: (move: Move) => PBTween['mode'];
|
|
8417
8627
|
/**
|
|
8418
|
-
* @returns a move mode tween
|
|
8628
|
+
* @returns a move-continuous mode tween
|
|
8629
|
+
*/
|
|
8630
|
+
MoveContinuous: (move: MoveContinuous) => PBTween['mode'];
|
|
8631
|
+
/**
|
|
8632
|
+
* @returns a rotate mode tween
|
|
8419
8633
|
*/
|
|
8420
8634
|
Rotate: (rotate: Rotate) => PBTween['mode'];
|
|
8421
8635
|
/**
|
|
8422
|
-
* @returns a
|
|
8636
|
+
* @returns a rotate-continuous mode tween
|
|
8637
|
+
*/
|
|
8638
|
+
RotateContinuous: (rotate: RotateContinuous) => PBTween['mode'];
|
|
8639
|
+
/**
|
|
8640
|
+
* @returns a scale mode tween
|
|
8423
8641
|
*/
|
|
8424
8642
|
Scale: (scale: Scale) => PBTween['mode'];
|
|
8425
8643
|
/**
|
|
8426
|
-
* @returns a texture
|
|
8644
|
+
* @returns a texture-move mode tween
|
|
8427
8645
|
*/
|
|
8428
8646
|
TextureMove: (textureMove: TextureMove) => PBTween['mode'];
|
|
8647
|
+
/**
|
|
8648
|
+
* @returns a texture-move-continuous mode tween
|
|
8649
|
+
*/
|
|
8650
|
+
TextureMoveContinuous: (textureMove: TextureMoveContinuous) => PBTween['mode'];
|
|
8429
8651
|
}
|
|
8430
8652
|
|
|
8431
8653
|
/**
|