@dcl/playground-assets 7.33.0 → 7.33.1-44149226847.commit-7d1c56d

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.
@@ -245,6 +245,42 @@ export declare interface AudioStreamComponentDefinitionExtended extends LastWrit
245
245
  getAudioState(entity: Entity): PBAudioEvent | undefined;
246
246
  }
247
247
 
248
+ /**
249
+ * @public
250
+ */
251
+ export declare type AuthoritativePutComponentMessage = CrdtMessageHeader & AuthoritativePutComponentMessageBody;
252
+
253
+ /**
254
+ * Server authoritative message - identical to PutComponentMessageBody but with forced processing
255
+ * Min. length = header (8 bytes) + 16 bytes = 24 bytes
256
+ *
257
+ * @param entity - Uint32 number of the entity
258
+ * @param componentId - Uint32 number of id
259
+ * @param timestamp - Uint32 Lamport timestamp (server's authoritative timestamp)
260
+ * @param data - Uint8[] data of component => length(4 bytes) + block of bytes[0..length-1]
261
+ * @public
262
+ */
263
+ export declare type AuthoritativePutComponentMessageBody = {
264
+ type: CrdtMessageType.AUTHORITATIVE_PUT_COMPONENT;
265
+ entityId: Entity;
266
+ componentId: number;
267
+ timestamp: number;
268
+ data: Uint8Array;
269
+ };
270
+
271
+ /**
272
+ * @public
273
+ */
274
+ export declare namespace AuthoritativePutComponentOperation {
275
+ const MESSAGE_HEADER_LENGTH = 16;
276
+ /**
277
+ * Call this function for an optimal writing data passing the ByteBuffer
278
+ * already allocated
279
+ */
280
+ export function write(entity: Entity, timestamp: number, componentId: number, data: Uint8Array, buf: ByteBuffer): void;
281
+ export function read(buf: ByteBuffer): AuthoritativePutComponentMessage | null;
282
+ }
283
+
248
284
  /** AvatarAnchorPointType determines the part of the avatar's body that anchors the Entity. */
249
285
  /**
250
286
  * @public
@@ -420,6 +456,22 @@ export declare interface BaseComponent<T> {
420
456
  * If the value is undefined, the component was deleted.
421
457
  */
422
458
  onChange(entity: Entity, cb: (value: T | undefined) => void): void;
459
+ /**
460
+ * @public
461
+ *
462
+ */
463
+ validateBeforeChange(entity: Entity, cb: ValidateCallback<T>): void;
464
+ validateBeforeChange(cb: ValidateCallback<T>): void;
465
+ /**
466
+ * Get the CRDT state for an entity (serialized data and timestamp)
467
+ * @param entity - Entity to get the CRDT state for
468
+ * @returns Object with serialized data and timestamp, or null if entity doesn't have the component
469
+ * @public
470
+ */
471
+ getCrdtState(entity: Entity): {
472
+ data: Uint8Array;
473
+ timestamp: number;
474
+ } | null;
423
475
  }
424
476
 
425
477
  /** @public */
@@ -1704,12 +1756,12 @@ export declare const CRDT_MESSAGE_HEADER_LENGTH = 8;
1704
1756
  /**
1705
1757
  * @public
1706
1758
  */
1707
- export declare type CrdtMessage = PutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
1759
+ export declare type CrdtMessage = PutComponentMessage | AuthoritativePutComponentMessage | DeleteComponentMessage | AppendValueMessage | DeleteEntityMessage | PutNetworkComponentMessage | DeleteComponentNetworkMessage | DeleteEntityNetworkMessage;
1708
1760
 
1709
1761
  /**
1710
1762
  * @public
1711
1763
  */
1712
- export declare type CrdtMessageBody = PutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
1764
+ export declare type CrdtMessageBody = PutComponentMessageBody | AuthoritativePutComponentMessageBody | DeleteComponentMessageBody | DeleteEntityMessageBody | AppendValueMessageBody | CrdtNetworkMessageBody;
1713
1765
 
1714
1766
  /**
1715
1767
  * Min length = 8 bytes
@@ -1764,7 +1816,8 @@ export declare enum CrdtMessageType {
1764
1816
  PUT_COMPONENT_NETWORK = 5,
1765
1817
  DELETE_COMPONENT_NETWORK = 6,
1766
1818
  DELETE_ENTITY_NETWORK = 7,
1767
- MAX_MESSAGE_TYPE = 8
1819
+ AUTHORITATIVE_PUT_COMPONENT = 8,
1820
+ MAX_MESSAGE_TYPE = 9
1768
1821
  }
1769
1822
 
1770
1823
  /**
@@ -1772,6 +1825,8 @@ export declare enum CrdtMessageType {
1772
1825
  */
1773
1826
  export declare type CrdtNetworkMessageBody = PutNetworkComponentMessageBody | DeleteComponentNetworkMessageBody | DeleteEntityNetworkMessageBody;
1774
1827
 
1828
+ export declare const CreatedBy: ICreatedBy;
1829
+
1775
1830
  /**
1776
1831
  * @public
1777
1832
  */
@@ -2551,6 +2606,12 @@ export declare interface GrowOnlyValueSetComponentDefinition<T> extends BaseComp
2551
2606
 
2552
2607
  export declare type GSetComponentGetter<T extends GrowOnlyValueSetComponentDefinition<any>> = (engine: Pick<IEngine, 'defineValueSetComponentFromSchema'>) => T;
2553
2608
 
2609
+ export declare type ICreatedBy = LastWriteWinElementSetComponentDefinition<ICreatedByType>;
2610
+
2611
+ export declare interface ICreatedByType {
2612
+ address: string;
2613
+ }
2614
+
2554
2615
  /**
2555
2616
  * @public
2556
2617
  */
@@ -3028,6 +3089,35 @@ export declare const enum InteractionType {
3028
3089
  PROXIMITY = 1
3029
3090
  }
3030
3091
 
3092
+ /**
3093
+ * Internal component interface that exposes all internal methods for SDK use
3094
+ * This is not exposed to users, only for internal SDK operations
3095
+ */
3096
+ export declare interface InternalBaseComponent<T> extends BaseComponent<T> {
3097
+ /**
3098
+ * @public
3099
+ * Dry run update to check if a CRDT message would be accepted without actually applying it
3100
+ */
3101
+ __dry_run_updateFromCrdt(body: CrdtMessageBody): ProcessMessageResultType;
3102
+ /**
3103
+ * @public
3104
+ * Get the iterator to every entity has the component
3105
+ */
3106
+ iterator(): Iterable<[Entity, any]>;
3107
+ /**
3108
+ * @public
3109
+ */
3110
+ dirtyIterator(): Iterable<Entity>;
3111
+ /**
3112
+ * @public
3113
+ */
3114
+ __onChangeCallbacks(entity: Entity, value: T): void;
3115
+ /**
3116
+ * @public
3117
+ */
3118
+ __run_validateBeforeChange(entity: Entity, newValue: T | undefined, senderAddress: string, createdBy: string): boolean;
3119
+ }
3120
+
3031
3121
  /**
3032
3122
  * @public
3033
3123
  */
@@ -4964,7 +5054,7 @@ export declare namespace PBAvatarEmoteCommand {
4964
5054
  /**
4965
5055
  * AvatarEquipData is used to read the information about the avatar's owneables.
4966
5056
  * this component is written by the engine using the communications transports'
4967
- * data.
5057
+ * data. It describes the outfit in the player's profile.
4968
5058
  */
4969
5059
  /**
4970
5060
  * @public
@@ -4972,6 +5062,8 @@ export declare namespace PBAvatarEmoteCommand {
4972
5062
  export declare interface PBAvatarEquippedData {
4973
5063
  wearableUrns: string[];
4974
5064
  emoteUrns: string[];
5065
+ /** one per item of wearable_urns, in the same order */
5066
+ wearables: PBAvatarEquippedData_EquippedWearable[];
4975
5067
  }
4976
5068
 
4977
5069
  /**
@@ -4982,6 +5074,27 @@ export declare namespace PBAvatarEquippedData {
4982
5074
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
4983
5075
  }
4984
5076
 
5077
+ /**
5078
+ * @public
5079
+ */
5080
+ export declare interface PBAvatarEquippedData_EquippedWearable {
5081
+ urn: string;
5082
+ /**
5083
+ * true if the wearable is visible in the profile outfit, after hides, replaces and force render apply.
5084
+ * Of two wearables with the same category, the later one is used: the earlier one is false and hides nothing.
5085
+ * Unset until all the wearables of the outfit have loaded or failed. A wearable that failed to load is false.
5086
+ */
5087
+ visible?: boolean | undefined;
5088
+ }
5089
+
5090
+ /**
5091
+ * @public
5092
+ */
5093
+ export declare namespace PBAvatarEquippedData_EquippedWearable {
5094
+ export function encode(message: PBAvatarEquippedData_EquippedWearable, writer?: _m0.Writer): _m0.Writer;
5095
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData_EquippedWearable;
5096
+ }
5097
+
4985
5098
  /**
4986
5099
  * The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
4987
5100
  * as the avatar movement speed, jump height etc.
@@ -5098,19 +5211,29 @@ export declare namespace PBAvatarNametag {
5098
5211
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
5099
5212
  * a simplified GLTF container for this specific case.
5100
5213
  *
5101
- * All fields (except ID) are optional have reasonable default values. In the case of `wearables`,
5214
+ * All fields (except ID) are optional and have reasonable default values. In the case of `wearables`,
5102
5215
  * each slot on the Avatar's body that is not explicitly included in the list has its own default.
5103
5216
  *
5104
- * Note that, while AvatarShape can be attached to any Entity, it's only actually used in the global
5105
- * Avatar Scene. Other requirements are usually better served by GLTFs.
5217
+ * On most entities, AvatarShape draws an avatar, for example an NPC. Other requirements are usually
5218
+ * better served by GLTFs.
5219
+ *
5220
+ * On a player entity (`engine.PlayerEntity` or the entity of another player), AvatarShape changes the
5221
+ * look of that player's avatar:
5222
+ * - An unset field keeps the value from the player's profile. The defaults below apply only to other entities.
5223
+ * - A non-empty `wearables` replaces all the wearables. A body slot that it does not fill stays empty.
5224
+ * An empty `wearables` is the same as unset.
5225
+ * - Fields marked "ignored on player entities" have no effect.
5226
+ * - The change is local to this client. It is not broadcast.
5227
+ * - The change applies only while the scene that wrote it is the current scene.
5228
+ * - AvatarBase and AvatarEquippedData keep the values from the profile.
5106
5229
  */
5107
5230
  /**
5108
5231
  * @public
5109
5232
  */
5110
5233
  export declare interface PBAvatarShape {
5111
- /** the user ID */
5234
+ /** the user ID; ignored on player entities */
5112
5235
  id: string;
5113
- /** visible name (default: "NPC") */
5236
+ /** visible name (default: "NPC"); ignored on player entities */
5114
5237
  name?: string | undefined;
5115
5238
  /** shape URN (default "urn:decentraland:off-chain:base-avatars:BaseFemale") */
5116
5239
  bodyShape?: string | undefined;
@@ -5120,25 +5243,30 @@ export declare interface PBAvatarShape {
5120
5243
  hairColor?: PBColor3 | undefined;
5121
5244
  /** RGB (default [0.6, 0.462, 0.356]) */
5122
5245
  eyeColor?: PBColor3 | undefined;
5123
- /** current emote animations */
5246
+ /** current emote animations; ignored on player entities */
5124
5247
  expressionTriggerId?: string | undefined;
5125
- /** start of emote animations (in the same order) */
5248
+ /** start of emote animations (in the same order); ignored on player entities */
5126
5249
  expressionTriggerTimestamp?: number | undefined;
5127
- /** whether to display the floating voice chat icon */
5250
+ /** whether to display the floating voice chat icon; ignored on player entities */
5128
5251
  talking?: boolean | undefined;
5129
5252
  /**
5130
- * Wearable URNs, one for each body slot.
5253
+ * Wearables, one per body slot. Each item is one of:
5254
+ * - a wearable URN
5255
+ * - the path of a GLB file in the scene content, named `<name>_<category>.glb`, for example `cap_hat.glb`
5256
+ * If two items have the same category, the later item is used.
5257
+ * A scene GLB is always visible and hides nothing. Exception: a `skin` GLB hides the body that it replaces.
5258
+ * If an item is not a URN or a `.glb` path, or if it cannot be loaded, the item is skipped.
5131
5259
  * Default values for each unspecified slot:
5132
5260
  * Eyes : "urn:decentraland:off-chain:base-avatars:f_eyes_00",
5133
5261
  * Eyebrows: "urn:decentraland:off-chain:base-avatars:f_eyebrows_00",
5134
- * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00"
5262
+ * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00",
5135
5263
  * Hair : "urn:decentraland:off-chain:base-avatars:standard_hair",
5136
5264
  * Shirt : "urn:decentraland:off-chain:base-avatars:f_simple_yellow_tshirt",
5137
5265
  * Trousers: "urn:decentraland:off-chain:base-avatars:f_brown_trousers",
5138
- * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"]
5266
+ * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"
5139
5267
  */
5140
5268
  wearables: string[];
5141
- /** available emotes (default empty) */
5269
+ /** available emotes (default empty); ignored on player entities */
5142
5270
  emotes: string[];
5143
5271
  /** hides the skin + hair + facial features (default: false) */
5144
5272
  showOnlyWearables?: boolean | undefined;
@@ -9729,6 +9857,16 @@ export declare type Transport = {
9729
9857
  onmessage?(message: Uint8Array): void;
9730
9858
  filter(message: Omit<TransportMessage, 'messageBuffer'>): boolean;
9731
9859
  type?: string;
9860
+ /**
9861
+ * Whether this transport is allowed to mutate reserved-range entities
9862
+ * (root/player/camera + avatars, entity number below `RESERVED_STATIC_ENTITIES`).
9863
+ * Only the trusted host/renderer transport sets this. An inbound DELETE_ENTITY
9864
+ * or component operation (PUT_COMPONENT, DELETE_COMPONENT, APPEND_VALUE,
9865
+ * AUTHORITATIVE_PUT_COMPONENT) on a reserved entity from a transport without
9866
+ * this flag (a comms peer, or any scene-added transport) is rejected — see
9867
+ * `receiveMessages`.
9868
+ */
9869
+ allowReservedEntities?: boolean;
9732
9870
  };
9733
9871
 
9734
9872
  /**
@@ -10310,6 +10448,14 @@ export declare interface UiTransformProps {
10310
10448
  */
10311
10449
  export declare type Unpacked<T> = T extends (infer U)[] ? U : T;
10312
10450
 
10451
+ export declare type ValidateCallback<T> = (value: {
10452
+ entity: Entity;
10453
+ currentValue: T | undefined;
10454
+ newValue: T | undefined;
10455
+ senderAddress: string;
10456
+ createdBy: string;
10457
+ }) => boolean;
10458
+
10313
10459
  /**
10314
10460
  * @public
10315
10461
  */