@dcl/playground-assets 7.33.0 → 7.33.1-44118805139.commit-b0b508d

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 CHANGED
@@ -4992,7 +4992,7 @@ export declare namespace PBAvatarEmoteCommand {
4992
4992
  /**
4993
4993
  * AvatarEquipData is used to read the information about the avatar's owneables.
4994
4994
  * this component is written by the engine using the communications transports'
4995
- * data.
4995
+ * data. It describes the outfit in the player's profile.
4996
4996
  */
4997
4997
  /**
4998
4998
  * @public
@@ -5000,6 +5000,8 @@ export declare namespace PBAvatarEmoteCommand {
5000
5000
  export declare interface PBAvatarEquippedData {
5001
5001
  wearableUrns: string[];
5002
5002
  emoteUrns: string[];
5003
+ /** one per item of wearable_urns, in the same order */
5004
+ wearables: PBAvatarEquippedData_EquippedWearable[];
5003
5005
  }
5004
5006
 
5005
5007
  /**
@@ -5010,6 +5012,27 @@ export declare namespace PBAvatarEquippedData {
5010
5012
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
5011
5013
  }
5012
5014
 
5015
+ /**
5016
+ * @public
5017
+ */
5018
+ export declare interface PBAvatarEquippedData_EquippedWearable {
5019
+ urn: string;
5020
+ /**
5021
+ * true if the wearable is visible in the profile outfit, after hides, replaces and force render apply.
5022
+ * Of two wearables with the same category, the later one is used: the earlier one is false and hides nothing.
5023
+ * Unset until all the wearables of the outfit have loaded or failed. A wearable that failed to load is false.
5024
+ */
5025
+ visible?: boolean | undefined;
5026
+ }
5027
+
5028
+ /**
5029
+ * @public
5030
+ */
5031
+ export declare namespace PBAvatarEquippedData_EquippedWearable {
5032
+ export function encode(message: PBAvatarEquippedData_EquippedWearable, writer?: _m0.Writer): _m0.Writer;
5033
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData_EquippedWearable;
5034
+ }
5035
+
5013
5036
  /**
5014
5037
  * The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
5015
5038
  * as the avatar movement speed, jump height etc.
@@ -5126,19 +5149,29 @@ export declare namespace PBAvatarNametag {
5126
5149
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
5127
5150
  * a simplified GLTF container for this specific case.
5128
5151
  *
5129
- * All fields (except ID) are optional have reasonable default values. In the case of `wearables`,
5152
+ * All fields (except ID) are optional and have reasonable default values. In the case of `wearables`,
5130
5153
  * each slot on the Avatar's body that is not explicitly included in the list has its own default.
5131
5154
  *
5132
- * Note that, while AvatarShape can be attached to any Entity, it's only actually used in the global
5133
- * Avatar Scene. Other requirements are usually better served by GLTFs.
5155
+ * On most entities, AvatarShape draws an avatar, for example an NPC. Other requirements are usually
5156
+ * better served by GLTFs.
5157
+ *
5158
+ * On a player entity (`engine.PlayerEntity` or the entity of another player), AvatarShape changes the
5159
+ * look of that player's avatar:
5160
+ * - An unset field keeps the value from the player's profile. The defaults below apply only to other entities.
5161
+ * - A non-empty `wearables` replaces all the wearables. A body slot that it does not fill stays empty.
5162
+ * An empty `wearables` is the same as unset.
5163
+ * - Fields marked "ignored on player entities" have no effect.
5164
+ * - The change is local to this client. It is not broadcast.
5165
+ * - The change applies only while the scene that wrote it is the current scene.
5166
+ * - AvatarBase and AvatarEquippedData keep the values from the profile.
5134
5167
  */
5135
5168
  /**
5136
5169
  * @public
5137
5170
  */
5138
5171
  export declare interface PBAvatarShape {
5139
- /** the user ID */
5172
+ /** the user ID; ignored on player entities */
5140
5173
  id: string;
5141
- /** visible name (default: "NPC") */
5174
+ /** visible name (default: "NPC"); ignored on player entities */
5142
5175
  name?: string | undefined;
5143
5176
  /** shape URN (default "urn:decentraland:off-chain:base-avatars:BaseFemale") */
5144
5177
  bodyShape?: string | undefined;
@@ -5148,25 +5181,30 @@ export declare interface PBAvatarShape {
5148
5181
  hairColor?: PBColor3 | undefined;
5149
5182
  /** RGB (default [0.6, 0.462, 0.356]) */
5150
5183
  eyeColor?: PBColor3 | undefined;
5151
- /** current emote animations */
5184
+ /** current emote animations; ignored on player entities */
5152
5185
  expressionTriggerId?: string | undefined;
5153
- /** start of emote animations (in the same order) */
5186
+ /** start of emote animations (in the same order); ignored on player entities */
5154
5187
  expressionTriggerTimestamp?: number | undefined;
5155
- /** whether to display the floating voice chat icon */
5188
+ /** whether to display the floating voice chat icon; ignored on player entities */
5156
5189
  talking?: boolean | undefined;
5157
5190
  /**
5158
- * Wearable URNs, one for each body slot.
5191
+ * Wearables, one per body slot. Each item is one of:
5192
+ * - a wearable URN
5193
+ * - the path of a GLB file in the scene content, named `<name>_<category>.glb`, for example `cap_hat.glb`
5194
+ * If two items have the same category, the later item is used.
5195
+ * A scene GLB is always visible and hides nothing. Exception: a `skin` GLB hides the body that it replaces.
5196
+ * If an item is not a URN or a `.glb` path, or if it cannot be loaded, the item is skipped.
5159
5197
  * Default values for each unspecified slot:
5160
5198
  * Eyes : "urn:decentraland:off-chain:base-avatars:f_eyes_00",
5161
5199
  * Eyebrows: "urn:decentraland:off-chain:base-avatars:f_eyebrows_00",
5162
- * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00"
5200
+ * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00",
5163
5201
  * Hair : "urn:decentraland:off-chain:base-avatars:standard_hair",
5164
5202
  * Shirt : "urn:decentraland:off-chain:base-avatars:f_simple_yellow_tshirt",
5165
5203
  * Trousers: "urn:decentraland:off-chain:base-avatars:f_brown_trousers",
5166
- * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"]
5204
+ * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"
5167
5205
  */
5168
5206
  wearables: string[];
5169
- /** available emotes (default empty) */
5207
+ /** available emotes (default empty); ignored on player entities */
5170
5208
  emotes: string[];
5171
5209
  /** hides the skin + hair + facial features (default: false) */
5172
5210
  showOnlyWearables?: boolean | undefined;
package/dist/beta.d.ts CHANGED
@@ -4964,7 +4964,7 @@ export declare namespace PBAvatarEmoteCommand {
4964
4964
  /**
4965
4965
  * AvatarEquipData is used to read the information about the avatar's owneables.
4966
4966
  * this component is written by the engine using the communications transports'
4967
- * data.
4967
+ * data. It describes the outfit in the player's profile.
4968
4968
  */
4969
4969
  /**
4970
4970
  * @public
@@ -4972,6 +4972,8 @@ export declare namespace PBAvatarEmoteCommand {
4972
4972
  export declare interface PBAvatarEquippedData {
4973
4973
  wearableUrns: string[];
4974
4974
  emoteUrns: string[];
4975
+ /** one per item of wearable_urns, in the same order */
4976
+ wearables: PBAvatarEquippedData_EquippedWearable[];
4975
4977
  }
4976
4978
 
4977
4979
  /**
@@ -4982,6 +4984,27 @@ export declare namespace PBAvatarEquippedData {
4982
4984
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
4983
4985
  }
4984
4986
 
4987
+ /**
4988
+ * @public
4989
+ */
4990
+ export declare interface PBAvatarEquippedData_EquippedWearable {
4991
+ urn: string;
4992
+ /**
4993
+ * true if the wearable is visible in the profile outfit, after hides, replaces and force render apply.
4994
+ * Of two wearables with the same category, the later one is used: the earlier one is false and hides nothing.
4995
+ * Unset until all the wearables of the outfit have loaded or failed. A wearable that failed to load is false.
4996
+ */
4997
+ visible?: boolean | undefined;
4998
+ }
4999
+
5000
+ /**
5001
+ * @public
5002
+ */
5003
+ export declare namespace PBAvatarEquippedData_EquippedWearable {
5004
+ export function encode(message: PBAvatarEquippedData_EquippedWearable, writer?: _m0.Writer): _m0.Writer;
5005
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData_EquippedWearable;
5006
+ }
5007
+
4985
5008
  /**
4986
5009
  * The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
4987
5010
  * as the avatar movement speed, jump height etc.
@@ -5098,19 +5121,29 @@ export declare namespace PBAvatarNametag {
5098
5121
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
5099
5122
  * a simplified GLTF container for this specific case.
5100
5123
  *
5101
- * All fields (except ID) are optional have reasonable default values. In the case of `wearables`,
5124
+ * All fields (except ID) are optional and have reasonable default values. In the case of `wearables`,
5102
5125
  * each slot on the Avatar's body that is not explicitly included in the list has its own default.
5103
5126
  *
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.
5127
+ * On most entities, AvatarShape draws an avatar, for example an NPC. Other requirements are usually
5128
+ * better served by GLTFs.
5129
+ *
5130
+ * On a player entity (`engine.PlayerEntity` or the entity of another player), AvatarShape changes the
5131
+ * look of that player's avatar:
5132
+ * - An unset field keeps the value from the player's profile. The defaults below apply only to other entities.
5133
+ * - A non-empty `wearables` replaces all the wearables. A body slot that it does not fill stays empty.
5134
+ * An empty `wearables` is the same as unset.
5135
+ * - Fields marked "ignored on player entities" have no effect.
5136
+ * - The change is local to this client. It is not broadcast.
5137
+ * - The change applies only while the scene that wrote it is the current scene.
5138
+ * - AvatarBase and AvatarEquippedData keep the values from the profile.
5106
5139
  */
5107
5140
  /**
5108
5141
  * @public
5109
5142
  */
5110
5143
  export declare interface PBAvatarShape {
5111
- /** the user ID */
5144
+ /** the user ID; ignored on player entities */
5112
5145
  id: string;
5113
- /** visible name (default: "NPC") */
5146
+ /** visible name (default: "NPC"); ignored on player entities */
5114
5147
  name?: string | undefined;
5115
5148
  /** shape URN (default "urn:decentraland:off-chain:base-avatars:BaseFemale") */
5116
5149
  bodyShape?: string | undefined;
@@ -5120,25 +5153,30 @@ export declare interface PBAvatarShape {
5120
5153
  hairColor?: PBColor3 | undefined;
5121
5154
  /** RGB (default [0.6, 0.462, 0.356]) */
5122
5155
  eyeColor?: PBColor3 | undefined;
5123
- /** current emote animations */
5156
+ /** current emote animations; ignored on player entities */
5124
5157
  expressionTriggerId?: string | undefined;
5125
- /** start of emote animations (in the same order) */
5158
+ /** start of emote animations (in the same order); ignored on player entities */
5126
5159
  expressionTriggerTimestamp?: number | undefined;
5127
- /** whether to display the floating voice chat icon */
5160
+ /** whether to display the floating voice chat icon; ignored on player entities */
5128
5161
  talking?: boolean | undefined;
5129
5162
  /**
5130
- * Wearable URNs, one for each body slot.
5163
+ * Wearables, one per body slot. Each item is one of:
5164
+ * - a wearable URN
5165
+ * - the path of a GLB file in the scene content, named `<name>_<category>.glb`, for example `cap_hat.glb`
5166
+ * If two items have the same category, the later item is used.
5167
+ * A scene GLB is always visible and hides nothing. Exception: a `skin` GLB hides the body that it replaces.
5168
+ * If an item is not a URN or a `.glb` path, or if it cannot be loaded, the item is skipped.
5131
5169
  * Default values for each unspecified slot:
5132
5170
  * Eyes : "urn:decentraland:off-chain:base-avatars:f_eyes_00",
5133
5171
  * Eyebrows: "urn:decentraland:off-chain:base-avatars:f_eyebrows_00",
5134
- * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00"
5172
+ * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00",
5135
5173
  * Hair : "urn:decentraland:off-chain:base-avatars:standard_hair",
5136
5174
  * Shirt : "urn:decentraland:off-chain:base-avatars:f_simple_yellow_tshirt",
5137
5175
  * Trousers: "urn:decentraland:off-chain:base-avatars:f_brown_trousers",
5138
- * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"]
5176
+ * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"
5139
5177
  */
5140
5178
  wearables: string[];
5141
- /** available emotes (default empty) */
5179
+ /** available emotes (default empty); ignored on player entities */
5142
5180
  emotes: string[];
5143
5181
  /** hides the skin + hair + facial features (default: false) */
5144
5182
  showOnlyWearables?: boolean | undefined;
@@ -4964,7 +4964,7 @@ export declare namespace PBAvatarEmoteCommand {
4964
4964
  /**
4965
4965
  * AvatarEquipData is used to read the information about the avatar's owneables.
4966
4966
  * this component is written by the engine using the communications transports'
4967
- * data.
4967
+ * data. It describes the outfit in the player's profile.
4968
4968
  */
4969
4969
  /**
4970
4970
  * @public
@@ -4972,6 +4972,8 @@ export declare namespace PBAvatarEmoteCommand {
4972
4972
  export declare interface PBAvatarEquippedData {
4973
4973
  wearableUrns: string[];
4974
4974
  emoteUrns: string[];
4975
+ /** one per item of wearable_urns, in the same order */
4976
+ wearables: PBAvatarEquippedData_EquippedWearable[];
4975
4977
  }
4976
4978
 
4977
4979
  /**
@@ -4982,6 +4984,27 @@ export declare namespace PBAvatarEquippedData {
4982
4984
  export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData;
4983
4985
  }
4984
4986
 
4987
+ /**
4988
+ * @public
4989
+ */
4990
+ export declare interface PBAvatarEquippedData_EquippedWearable {
4991
+ urn: string;
4992
+ /**
4993
+ * true if the wearable is visible in the profile outfit, after hides, replaces and force render apply.
4994
+ * Of two wearables with the same category, the later one is used: the earlier one is false and hides nothing.
4995
+ * Unset until all the wearables of the outfit have loaded or failed. A wearable that failed to load is false.
4996
+ */
4997
+ visible?: boolean | undefined;
4998
+ }
4999
+
5000
+ /**
5001
+ * @public
5002
+ */
5003
+ export declare namespace PBAvatarEquippedData_EquippedWearable {
5004
+ export function encode(message: PBAvatarEquippedData_EquippedWearable, writer?: _m0.Writer): _m0.Writer;
5005
+ export function decode(input: _m0.Reader | Uint8Array, length?: number): PBAvatarEquippedData_EquippedWearable;
5006
+ }
5007
+
4985
5008
  /**
4986
5009
  * The PBAvatarLocomotionSettings component allows scenes to modify locomotion settings defining things such
4987
5010
  * as the avatar movement speed, jump height etc.
@@ -5098,19 +5121,29 @@ export declare namespace PBAvatarNametag {
5098
5121
  * The AvatarShape component contains the information required to draw and animate avatar, acting as
5099
5122
  * a simplified GLTF container for this specific case.
5100
5123
  *
5101
- * All fields (except ID) are optional have reasonable default values. In the case of `wearables`,
5124
+ * All fields (except ID) are optional and have reasonable default values. In the case of `wearables`,
5102
5125
  * each slot on the Avatar's body that is not explicitly included in the list has its own default.
5103
5126
  *
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.
5127
+ * On most entities, AvatarShape draws an avatar, for example an NPC. Other requirements are usually
5128
+ * better served by GLTFs.
5129
+ *
5130
+ * On a player entity (`engine.PlayerEntity` or the entity of another player), AvatarShape changes the
5131
+ * look of that player's avatar:
5132
+ * - An unset field keeps the value from the player's profile. The defaults below apply only to other entities.
5133
+ * - A non-empty `wearables` replaces all the wearables. A body slot that it does not fill stays empty.
5134
+ * An empty `wearables` is the same as unset.
5135
+ * - Fields marked "ignored on player entities" have no effect.
5136
+ * - The change is local to this client. It is not broadcast.
5137
+ * - The change applies only while the scene that wrote it is the current scene.
5138
+ * - AvatarBase and AvatarEquippedData keep the values from the profile.
5106
5139
  */
5107
5140
  /**
5108
5141
  * @public
5109
5142
  */
5110
5143
  export declare interface PBAvatarShape {
5111
- /** the user ID */
5144
+ /** the user ID; ignored on player entities */
5112
5145
  id: string;
5113
- /** visible name (default: "NPC") */
5146
+ /** visible name (default: "NPC"); ignored on player entities */
5114
5147
  name?: string | undefined;
5115
5148
  /** shape URN (default "urn:decentraland:off-chain:base-avatars:BaseFemale") */
5116
5149
  bodyShape?: string | undefined;
@@ -5120,25 +5153,30 @@ export declare interface PBAvatarShape {
5120
5153
  hairColor?: PBColor3 | undefined;
5121
5154
  /** RGB (default [0.6, 0.462, 0.356]) */
5122
5155
  eyeColor?: PBColor3 | undefined;
5123
- /** current emote animations */
5156
+ /** current emote animations; ignored on player entities */
5124
5157
  expressionTriggerId?: string | undefined;
5125
- /** start of emote animations (in the same order) */
5158
+ /** start of emote animations (in the same order); ignored on player entities */
5126
5159
  expressionTriggerTimestamp?: number | undefined;
5127
- /** whether to display the floating voice chat icon */
5160
+ /** whether to display the floating voice chat icon; ignored on player entities */
5128
5161
  talking?: boolean | undefined;
5129
5162
  /**
5130
- * Wearable URNs, one for each body slot.
5163
+ * Wearables, one per body slot. Each item is one of:
5164
+ * - a wearable URN
5165
+ * - the path of a GLB file in the scene content, named `<name>_<category>.glb`, for example `cap_hat.glb`
5166
+ * If two items have the same category, the later item is used.
5167
+ * A scene GLB is always visible and hides nothing. Exception: a `skin` GLB hides the body that it replaces.
5168
+ * If an item is not a URN or a `.glb` path, or if it cannot be loaded, the item is skipped.
5131
5169
  * Default values for each unspecified slot:
5132
5170
  * Eyes : "urn:decentraland:off-chain:base-avatars:f_eyes_00",
5133
5171
  * Eyebrows: "urn:decentraland:off-chain:base-avatars:f_eyebrows_00",
5134
- * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00"
5172
+ * Mouth : "urn:decentraland:off-chain:base-avatars:f_mouth_00",
5135
5173
  * Hair : "urn:decentraland:off-chain:base-avatars:standard_hair",
5136
5174
  * Shirt : "urn:decentraland:off-chain:base-avatars:f_simple_yellow_tshirt",
5137
5175
  * Trousers: "urn:decentraland:off-chain:base-avatars:f_brown_trousers",
5138
- * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"]
5176
+ * Shoes : "urn:decentraland:off-chain:base-avatars:bun_shoes"
5139
5177
  */
5140
5178
  wearables: string[];
5141
- /** available emotes (default empty) */
5179
+ /** available emotes (default empty); ignored on player entities */
5142
5180
  emotes: string[];
5143
5181
  /** hides the skin + hair + facial features (default: false) */
5144
5182
  showOnlyWearables?: boolean | undefined;