@dcl/playground-assets 7.1.18-5157707330.commit-091fce4 → 7.1.18-5158337338.commit-735bf67

Sign up to get free protection for your applications and to get access to all the features.
package/dist/alpha.d.ts CHANGED
@@ -4941,6 +4941,15 @@ export declare interface PointerEventsSystem {
4941
4941
  /**
4942
4942
  * @public
4943
4943
  * Execute callback when the user press the InputButton pointing at the entity
4944
+ * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
4945
+ * @param cb - Function to execute when click fires
4946
+ */
4947
+ onPointerDown(pointerData: {
4948
+ entity: Entity;
4949
+ opts?: Partial<EventSystemOptions>;
4950
+ }, cb: EventSystemCallback): void;
4951
+ /**
4952
+ * @deprecated Use onPointerDown with (pointerData, cb)
4944
4953
  * @param entity - Entity to attach the callback
4945
4954
  * @param cb - Function to execute when click fires
4946
4955
  * @param opts - Opts to trigger Feedback and Button
@@ -4949,6 +4958,15 @@ export declare interface PointerEventsSystem {
4949
4958
  /**
4950
4959
  * @public
4951
4960
  * Execute callback when the user releases the InputButton pointing at the entity
4961
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
4962
+ * @param cb - Function to execute when click fires
4963
+ */
4964
+ onPointerUp(pointerData: {
4965
+ entity: Entity;
4966
+ opts?: Partial<EventSystemOptions>;
4967
+ }, cb: EventSystemCallback): void;
4968
+ /**
4969
+ * @deprecated Use onPointerUp with (pointerData, cb)
4952
4970
  * @param entity - Entity to attach the callback
4953
4971
  * @param cb - Function to execute when click fires
4954
4972
  * @param opts - Opts to trigger Feedback and Button
@@ -5424,6 +5442,15 @@ export declare interface RaycastSystem {
5424
5442
  * @public
5425
5443
  * Execute callback when the entity receives a RaycastResult component update.
5426
5444
  * Uses a Vector3 entity-local direction value to calculate the ray direction
5445
+ * @param raycastData - Entity to attach the callback and Raycast configuration options
5446
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5447
+ */
5448
+ registerLocalDirectionRaycast(raycastData: {
5449
+ entity: Entity;
5450
+ opts?: Partial<LocalDirectionRaycastOptions>;
5451
+ }, callback: RaycastSystemCallback): void;
5452
+ /**
5453
+ * @deprecated use registerLocalDirectionRaycast(raycastData, cb) instead
5427
5454
  * @param entity - Entity to attach the callback
5428
5455
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5429
5456
  * @param options - Raycast configuration options
@@ -5433,6 +5460,15 @@ export declare interface RaycastSystem {
5433
5460
  * @public
5434
5461
  * Execute callback when the entity receives a RaycastResult component update.
5435
5462
  * Uses a Vector3 global direction value to calculate the ray direction
5463
+ * @param raycastData - Entity to attach the callback
5464
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5465
+ */
5466
+ registerGlobalDirectionRaycast(raycastData: {
5467
+ entity: Entity;
5468
+ opts?: Partial<GlobalDirectionRaycastOptions>;
5469
+ }, callback: RaycastSystemCallback): void;
5470
+ /**
5471
+ * @deprecated use registerGlobalDirectionRaycast(raycastData, cb) instead
5436
5472
  * @param entity - Entity to attach the callback
5437
5473
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5438
5474
  * @param options - Raycast configuration options
@@ -5442,6 +5478,15 @@ export declare interface RaycastSystem {
5442
5478
  * @public
5443
5479
  * Execute callback when the entity receives a RaycastResult component update.
5444
5480
  * Uses a Vector3 global target position to calculate the ray direction
5481
+ * @param raycastData - Entity to attach the callback and Raycast configuration options
5482
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5483
+ */
5484
+ registerGlobalTargetRaycast(raycastData: {
5485
+ entity: Entity;
5486
+ opts?: Partial<GlobalTargetRaycastOptions>;
5487
+ }, callback: RaycastSystemCallback): void;
5488
+ /**
5489
+ * @deprecated use registerGlobalTargetRaycast(raycastData, cb) instead
5445
5490
  * @param entity - Entity to attach the callback
5446
5491
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5447
5492
  * @param options - Raycast configuration options
@@ -5451,11 +5496,48 @@ export declare interface RaycastSystem {
5451
5496
  * @public
5452
5497
  * Execute callback when the entity receives a RaycastResult component update.
5453
5498
  * Uses an target Entity value to calculate the ray direction
5499
+ * @param raycastData - Entity to attach the callback
5500
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5501
+ * @param options - Raycast configuration options
5502
+ */
5503
+ registerTargetEntityRaycast(raycastData: {
5504
+ entity: Entity;
5505
+ opts?: Partial<TargetEntityRaycastOptions>;
5506
+ }, callback: RaycastSystemCallback): void;
5507
+ /**
5508
+ * @deprecated use registerTargetEntityRaycast(raycastData, cb) instead
5454
5509
  * @param entity - Entity to attach the callback
5455
5510
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5456
5511
  * @param options - Raycast configuration options
5457
5512
  */
5458
5513
  registerTargetEntityRaycast(entity: Entity, callback: RaycastSystemCallback, options?: Partial<TargetEntityRaycastOptions>): void;
5514
+ /**
5515
+ * @public
5516
+ * Creates Raycast local direction opts with defaults
5517
+ */
5518
+ localDirectionOptions(options?: Partial<LocalDirectionRaycastOptions>): RaycastSystemOptions;
5519
+ /**
5520
+ * @public
5521
+ * Creates Raycast global direction opts with defaults
5522
+ */
5523
+ globalDirectionOptions(options?: Partial<GlobalDirectionRaycastOptions>): RaycastSystemOptions;
5524
+ /**
5525
+ * @public
5526
+ * Creates Raycast global target direction opts with defaults
5527
+ */
5528
+ globalTargetOptions(options?: Partial<GlobalTargetRaycastOptions>): RaycastSystemOptions;
5529
+ /**
5530
+ * @public
5531
+ * Creates Raycast target entity opts with defaults
5532
+ */
5533
+ targetEntitytOptions(options?: Partial<TargetEntityRaycastOptions>): RaycastSystemOptions;
5534
+ /**
5535
+ * @public
5536
+ * Immediate mode Raycast to be used on a sytem rather than callbacks
5537
+ *
5538
+ * Use the options helper to create the specified raycast i.e. localDirectionOptions(opts)
5539
+ */
5540
+ registerRaycast(entity: Entity, options: RaycastSystemOptions): DeepReadonlyObject<PBRaycastResult> | null;
5459
5541
  }
5460
5542
 
5461
5543
  /**
@@ -6884,6 +6966,11 @@ export declare interface VideoEventsSystem {
6884
6966
  removeVideoEventsEntity(entity: Entity): void;
6885
6967
  registerVideoEventsEntity(entity: Entity, callback: VideoEventsSystemCallback): void;
6886
6968
  hasVideoEventsEntity(entity: Entity): boolean;
6969
+ /**
6970
+ * Returns the latest state of the VideoEvent
6971
+ * @param entity - Entity to retrieve the video status
6972
+ */
6973
+ getVideoState(entity: Entity): DeepReadonlyObject<PBVideoEvent> | undefined;
6887
6974
  }
6888
6975
 
6889
6976
  /**
package/dist/beta.d.ts CHANGED
@@ -4937,6 +4937,15 @@ export declare interface PointerEventsSystem {
4937
4937
  /**
4938
4938
  * @public
4939
4939
  * Execute callback when the user press the InputButton pointing at the entity
4940
+ * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
4941
+ * @param cb - Function to execute when click fires
4942
+ */
4943
+ onPointerDown(pointerData: {
4944
+ entity: Entity;
4945
+ opts?: Partial<EventSystemOptions>;
4946
+ }, cb: EventSystemCallback): void;
4947
+ /**
4948
+ * @deprecated Use onPointerDown with (pointerData, cb)
4940
4949
  * @param entity - Entity to attach the callback
4941
4950
  * @param cb - Function to execute when click fires
4942
4951
  * @param opts - Opts to trigger Feedback and Button
@@ -4945,6 +4954,15 @@ export declare interface PointerEventsSystem {
4945
4954
  /**
4946
4955
  * @public
4947
4956
  * Execute callback when the user releases the InputButton pointing at the entity
4957
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
4958
+ * @param cb - Function to execute when click fires
4959
+ */
4960
+ onPointerUp(pointerData: {
4961
+ entity: Entity;
4962
+ opts?: Partial<EventSystemOptions>;
4963
+ }, cb: EventSystemCallback): void;
4964
+ /**
4965
+ * @deprecated Use onPointerUp with (pointerData, cb)
4948
4966
  * @param entity - Entity to attach the callback
4949
4967
  * @param cb - Function to execute when click fires
4950
4968
  * @param opts - Opts to trigger Feedback and Button
@@ -5420,6 +5438,15 @@ export declare interface RaycastSystem {
5420
5438
  * @public
5421
5439
  * Execute callback when the entity receives a RaycastResult component update.
5422
5440
  * Uses a Vector3 entity-local direction value to calculate the ray direction
5441
+ * @param raycastData - Entity to attach the callback and Raycast configuration options
5442
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5443
+ */
5444
+ registerLocalDirectionRaycast(raycastData: {
5445
+ entity: Entity;
5446
+ opts?: Partial<LocalDirectionRaycastOptions>;
5447
+ }, callback: RaycastSystemCallback): void;
5448
+ /**
5449
+ * @deprecated use registerLocalDirectionRaycast(raycastData, cb) instead
5423
5450
  * @param entity - Entity to attach the callback
5424
5451
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5425
5452
  * @param options - Raycast configuration options
@@ -5429,6 +5456,15 @@ export declare interface RaycastSystem {
5429
5456
  * @public
5430
5457
  * Execute callback when the entity receives a RaycastResult component update.
5431
5458
  * Uses a Vector3 global direction value to calculate the ray direction
5459
+ * @param raycastData - Entity to attach the callback
5460
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5461
+ */
5462
+ registerGlobalDirectionRaycast(raycastData: {
5463
+ entity: Entity;
5464
+ opts?: Partial<GlobalDirectionRaycastOptions>;
5465
+ }, callback: RaycastSystemCallback): void;
5466
+ /**
5467
+ * @deprecated use registerGlobalDirectionRaycast(raycastData, cb) instead
5432
5468
  * @param entity - Entity to attach the callback
5433
5469
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5434
5470
  * @param options - Raycast configuration options
@@ -5438,6 +5474,15 @@ export declare interface RaycastSystem {
5438
5474
  * @public
5439
5475
  * Execute callback when the entity receives a RaycastResult component update.
5440
5476
  * Uses a Vector3 global target position to calculate the ray direction
5477
+ * @param raycastData - Entity to attach the callback and Raycast configuration options
5478
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5479
+ */
5480
+ registerGlobalTargetRaycast(raycastData: {
5481
+ entity: Entity;
5482
+ opts?: Partial<GlobalTargetRaycastOptions>;
5483
+ }, callback: RaycastSystemCallback): void;
5484
+ /**
5485
+ * @deprecated use registerGlobalTargetRaycast(raycastData, cb) instead
5441
5486
  * @param entity - Entity to attach the callback
5442
5487
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5443
5488
  * @param options - Raycast configuration options
@@ -5447,11 +5492,48 @@ export declare interface RaycastSystem {
5447
5492
  * @public
5448
5493
  * Execute callback when the entity receives a RaycastResult component update.
5449
5494
  * Uses an target Entity value to calculate the ray direction
5495
+ * @param raycastData - Entity to attach the callback
5496
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5497
+ * @param options - Raycast configuration options
5498
+ */
5499
+ registerTargetEntityRaycast(raycastData: {
5500
+ entity: Entity;
5501
+ opts?: Partial<TargetEntityRaycastOptions>;
5502
+ }, callback: RaycastSystemCallback): void;
5503
+ /**
5504
+ * @deprecated use registerTargetEntityRaycast(raycastData, cb) instead
5450
5505
  * @param entity - Entity to attach the callback
5451
5506
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5452
5507
  * @param options - Raycast configuration options
5453
5508
  */
5454
5509
  registerTargetEntityRaycast(entity: Entity, callback: RaycastSystemCallback, options?: Partial<TargetEntityRaycastOptions>): void;
5510
+ /**
5511
+ * @public
5512
+ * Creates Raycast local direction opts with defaults
5513
+ */
5514
+ localDirectionOptions(options?: Partial<LocalDirectionRaycastOptions>): RaycastSystemOptions;
5515
+ /**
5516
+ * @public
5517
+ * Creates Raycast global direction opts with defaults
5518
+ */
5519
+ globalDirectionOptions(options?: Partial<GlobalDirectionRaycastOptions>): RaycastSystemOptions;
5520
+ /**
5521
+ * @public
5522
+ * Creates Raycast global target direction opts with defaults
5523
+ */
5524
+ globalTargetOptions(options?: Partial<GlobalTargetRaycastOptions>): RaycastSystemOptions;
5525
+ /**
5526
+ * @public
5527
+ * Creates Raycast target entity opts with defaults
5528
+ */
5529
+ targetEntitytOptions(options?: Partial<TargetEntityRaycastOptions>): RaycastSystemOptions;
5530
+ /**
5531
+ * @public
5532
+ * Immediate mode Raycast to be used on a sytem rather than callbacks
5533
+ *
5534
+ * Use the options helper to create the specified raycast i.e. localDirectionOptions(opts)
5535
+ */
5536
+ registerRaycast(entity: Entity, options: RaycastSystemOptions): DeepReadonlyObject<PBRaycastResult> | null;
5455
5537
  }
5456
5538
 
5457
5539
  /**
@@ -6880,6 +6962,11 @@ export declare interface VideoEventsSystem {
6880
6962
  removeVideoEventsEntity(entity: Entity): void;
6881
6963
  registerVideoEventsEntity(entity: Entity, callback: VideoEventsSystemCallback): void;
6882
6964
  hasVideoEventsEntity(entity: Entity): boolean;
6965
+ /**
6966
+ * Returns the latest state of the VideoEvent
6967
+ * @param entity - Entity to retrieve the video status
6968
+ */
6969
+ getVideoState(entity: Entity): DeepReadonlyObject<PBVideoEvent> | undefined;
6883
6970
  }
6884
6971
 
6885
6972
  /**
@@ -4937,6 +4937,15 @@ export declare interface PointerEventsSystem {
4937
4937
  /**
4938
4938
  * @public
4939
4939
  * Execute callback when the user press the InputButton pointing at the entity
4940
+ * @param pointerData - Entity to attach the callback, Opts to trigger Feedback and Button
4941
+ * @param cb - Function to execute when click fires
4942
+ */
4943
+ onPointerDown(pointerData: {
4944
+ entity: Entity;
4945
+ opts?: Partial<EventSystemOptions>;
4946
+ }, cb: EventSystemCallback): void;
4947
+ /**
4948
+ * @deprecated Use onPointerDown with (pointerData, cb)
4940
4949
  * @param entity - Entity to attach the callback
4941
4950
  * @param cb - Function to execute when click fires
4942
4951
  * @param opts - Opts to trigger Feedback and Button
@@ -4945,6 +4954,15 @@ export declare interface PointerEventsSystem {
4945
4954
  /**
4946
4955
  * @public
4947
4956
  * Execute callback when the user releases the InputButton pointing at the entity
4957
+ * @param pointerData - Entity to attach the callback - Opts to trigger Feedback and Button
4958
+ * @param cb - Function to execute when click fires
4959
+ */
4960
+ onPointerUp(pointerData: {
4961
+ entity: Entity;
4962
+ opts?: Partial<EventSystemOptions>;
4963
+ }, cb: EventSystemCallback): void;
4964
+ /**
4965
+ * @deprecated Use onPointerUp with (pointerData, cb)
4948
4966
  * @param entity - Entity to attach the callback
4949
4967
  * @param cb - Function to execute when click fires
4950
4968
  * @param opts - Opts to trigger Feedback and Button
@@ -5420,6 +5438,15 @@ export declare interface RaycastSystem {
5420
5438
  * @public
5421
5439
  * Execute callback when the entity receives a RaycastResult component update.
5422
5440
  * Uses a Vector3 entity-local direction value to calculate the ray direction
5441
+ * @param raycastData - Entity to attach the callback and Raycast configuration options
5442
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5443
+ */
5444
+ registerLocalDirectionRaycast(raycastData: {
5445
+ entity: Entity;
5446
+ opts?: Partial<LocalDirectionRaycastOptions>;
5447
+ }, callback: RaycastSystemCallback): void;
5448
+ /**
5449
+ * @deprecated use registerLocalDirectionRaycast(raycastData, cb) instead
5423
5450
  * @param entity - Entity to attach the callback
5424
5451
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5425
5452
  * @param options - Raycast configuration options
@@ -5429,6 +5456,15 @@ export declare interface RaycastSystem {
5429
5456
  * @public
5430
5457
  * Execute callback when the entity receives a RaycastResult component update.
5431
5458
  * Uses a Vector3 global direction value to calculate the ray direction
5459
+ * @param raycastData - Entity to attach the callback
5460
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5461
+ */
5462
+ registerGlobalDirectionRaycast(raycastData: {
5463
+ entity: Entity;
5464
+ opts?: Partial<GlobalDirectionRaycastOptions>;
5465
+ }, callback: RaycastSystemCallback): void;
5466
+ /**
5467
+ * @deprecated use registerGlobalDirectionRaycast(raycastData, cb) instead
5432
5468
  * @param entity - Entity to attach the callback
5433
5469
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5434
5470
  * @param options - Raycast configuration options
@@ -5438,6 +5474,15 @@ export declare interface RaycastSystem {
5438
5474
  * @public
5439
5475
  * Execute callback when the entity receives a RaycastResult component update.
5440
5476
  * Uses a Vector3 global target position to calculate the ray direction
5477
+ * @param raycastData - Entity to attach the callback and Raycast configuration options
5478
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5479
+ */
5480
+ registerGlobalTargetRaycast(raycastData: {
5481
+ entity: Entity;
5482
+ opts?: Partial<GlobalTargetRaycastOptions>;
5483
+ }, callback: RaycastSystemCallback): void;
5484
+ /**
5485
+ * @deprecated use registerGlobalTargetRaycast(raycastData, cb) instead
5441
5486
  * @param entity - Entity to attach the callback
5442
5487
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5443
5488
  * @param options - Raycast configuration options
@@ -5447,11 +5492,48 @@ export declare interface RaycastSystem {
5447
5492
  * @public
5448
5493
  * Execute callback when the entity receives a RaycastResult component update.
5449
5494
  * Uses an target Entity value to calculate the ray direction
5495
+ * @param raycastData - Entity to attach the callback
5496
+ * @param callback - Function to execute when the entity's RaycastResult component is updated
5497
+ * @param options - Raycast configuration options
5498
+ */
5499
+ registerTargetEntityRaycast(raycastData: {
5500
+ entity: Entity;
5501
+ opts?: Partial<TargetEntityRaycastOptions>;
5502
+ }, callback: RaycastSystemCallback): void;
5503
+ /**
5504
+ * @deprecated use registerTargetEntityRaycast(raycastData, cb) instead
5450
5505
  * @param entity - Entity to attach the callback
5451
5506
  * @param callback - Function to execute when the entity's RaycastResult component is updated
5452
5507
  * @param options - Raycast configuration options
5453
5508
  */
5454
5509
  registerTargetEntityRaycast(entity: Entity, callback: RaycastSystemCallback, options?: Partial<TargetEntityRaycastOptions>): void;
5510
+ /**
5511
+ * @public
5512
+ * Creates Raycast local direction opts with defaults
5513
+ */
5514
+ localDirectionOptions(options?: Partial<LocalDirectionRaycastOptions>): RaycastSystemOptions;
5515
+ /**
5516
+ * @public
5517
+ * Creates Raycast global direction opts with defaults
5518
+ */
5519
+ globalDirectionOptions(options?: Partial<GlobalDirectionRaycastOptions>): RaycastSystemOptions;
5520
+ /**
5521
+ * @public
5522
+ * Creates Raycast global target direction opts with defaults
5523
+ */
5524
+ globalTargetOptions(options?: Partial<GlobalTargetRaycastOptions>): RaycastSystemOptions;
5525
+ /**
5526
+ * @public
5527
+ * Creates Raycast target entity opts with defaults
5528
+ */
5529
+ targetEntitytOptions(options?: Partial<TargetEntityRaycastOptions>): RaycastSystemOptions;
5530
+ /**
5531
+ * @public
5532
+ * Immediate mode Raycast to be used on a sytem rather than callbacks
5533
+ *
5534
+ * Use the options helper to create the specified raycast i.e. localDirectionOptions(opts)
5535
+ */
5536
+ registerRaycast(entity: Entity, options: RaycastSystemOptions): DeepReadonlyObject<PBRaycastResult> | null;
5455
5537
  }
5456
5538
 
5457
5539
  /**
@@ -6880,6 +6962,11 @@ export declare interface VideoEventsSystem {
6880
6962
  removeVideoEventsEntity(entity: Entity): void;
6881
6963
  registerVideoEventsEntity(entity: Entity, callback: VideoEventsSystemCallback): void;
6882
6964
  hasVideoEventsEntity(entity: Entity): boolean;
6965
+ /**
6966
+ * Returns the latest state of the VideoEvent
6967
+ * @param entity - Entity to retrieve the video status
6968
+ */
6969
+ getVideoState(entity: Entity): DeepReadonlyObject<PBVideoEvent> | undefined;
6883
6970
  }
6884
6971
 
6885
6972
  /**