@dcl/playground-assets 7.10.2 → 7.10.3-17918694201.commit-b983b3b

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.
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@dcl/sdk",
3
3
  "description": "",
4
- "version": "7.10.2",
4
+ "version": "7.10.3-17918694201.commit-b983b3b",
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": "931de89979b7eca676af3d4e3ccbaa5dcf8ef300"
38
+ "commit": "b983b3b74a44f323355ad4aed6a0e25504d20eb1"
39
39
  }
@@ -2250,6 +2250,13 @@ export declare interface IEngine {
2250
2250
  * @typeParam T - The type of the entity name value
2251
2251
  */
2252
2252
  getEntityByName<T = never, K = T>(value: K & (T extends never ? never : string)): Entity;
2253
+ /**
2254
+ * @public
2255
+ * Get all entities that have a specific tag in their Tag component
2256
+ * @param tag - Tag to search
2257
+ * @returns Iterator of entities that have the given tag
2258
+ */
2259
+ getEntitiesByTag(tagName: string): Iterable<Entity>;
2253
2260
  /**
2254
2261
  * @public
2255
2262
  * @param deltaTime - deltaTime in seconds
@@ -7277,6 +7284,33 @@ export declare type SystemItem = {
7277
7284
 
7278
7285
  export declare const SYSTEMS_REGULAR_PRIORITY = 100000;
7279
7286
 
7287
+ export declare const Tags: TagsComponentDefinitionExtended;
7288
+
7289
+ export declare interface TagsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<TagsType> {
7290
+ /**
7291
+ * @public
7292
+ *
7293
+ * Add a tag to the entity's Tags component or create the component if it doesn't exist and add the tag
7294
+ * @param entity - entity to add the tag to
7295
+ * @param tagName - the tag name to add
7296
+ * @returns true
7297
+ */
7298
+ add(entity: Entity, tagName: string): boolean;
7299
+ /**
7300
+ * @public
7301
+ *
7302
+ * Remove a tag from the entity's Tags component
7303
+ * @param entity - entity to remove the tag from
7304
+ * @param tagName - the tag name to remove
7305
+ * @returns true if successful, false if the entity doesn't have a Tags component or the tag doesn't exist
7306
+ */
7307
+ remove(entity: Entity, tagName: string): boolean;
7308
+ }
7309
+
7310
+ export declare interface TagsType {
7311
+ tags: string[];
7312
+ }
7313
+
7280
7314
  export declare type TargetEntityRaycastOptions = RaycastSystemOptions & TargetEntityRaycastSystemOptions;
7281
7315
 
7282
7316
  export declare type TargetEntityRaycastSystemOptions = {
@@ -5,7 +5,7 @@
5
5
  "toolPackages": [
6
6
  {
7
7
  "packageName": "@microsoft/api-extractor",
8
- "packageVersion": "7.52.11"
8
+ "packageVersion": "7.52.13"
9
9
  }
10
10
  ]
11
11
  }
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "metadata": {
3
3
  "toolPackage": "@microsoft/api-extractor",
4
- "toolVersion": "7.52.11",
4
+ "toolVersion": "7.52.13",
5
5
  "schemaVersion": 1011,
6
6
  "oldestForwardsCompatibleVersion": 1001,
7
7
  "tsdocConfig": {
@@ -21018,6 +21018,65 @@
21018
21018
  ],
21019
21019
  "name": "getComponentOrNull"
21020
21020
  },
21021
+ {
21022
+ "kind": "MethodSignature",
21023
+ "canonicalReference": "@dcl/playground-assets!IEngine#getEntitiesByTag:member(1)",
21024
+ "docComment": "/**\n * Get all entities that have a specific tag in their Tag component\n *\n * @param tag - Tag to search\n *\n * @returns Iterator of entities that have the given tag\n *\n * @public\n */\n",
21025
+ "excerptTokens": [
21026
+ {
21027
+ "kind": "Content",
21028
+ "text": "getEntitiesByTag(tagName: "
21029
+ },
21030
+ {
21031
+ "kind": "Content",
21032
+ "text": "string"
21033
+ },
21034
+ {
21035
+ "kind": "Content",
21036
+ "text": "): "
21037
+ },
21038
+ {
21039
+ "kind": "Reference",
21040
+ "text": "Iterable",
21041
+ "canonicalReference": "!Iterable:interface"
21042
+ },
21043
+ {
21044
+ "kind": "Content",
21045
+ "text": "<"
21046
+ },
21047
+ {
21048
+ "kind": "Reference",
21049
+ "text": "Entity",
21050
+ "canonicalReference": "@dcl/playground-assets!Entity:type"
21051
+ },
21052
+ {
21053
+ "kind": "Content",
21054
+ "text": ">"
21055
+ },
21056
+ {
21057
+ "kind": "Content",
21058
+ "text": ";"
21059
+ }
21060
+ ],
21061
+ "isOptional": false,
21062
+ "returnTypeTokenRange": {
21063
+ "startIndex": 3,
21064
+ "endIndex": 7
21065
+ },
21066
+ "releaseTag": "Public",
21067
+ "overloadIndex": 1,
21068
+ "parameters": [
21069
+ {
21070
+ "parameterName": "tagName",
21071
+ "parameterTypeTokenRange": {
21072
+ "startIndex": 1,
21073
+ "endIndex": 2
21074
+ },
21075
+ "isOptional": false
21076
+ }
21077
+ ],
21078
+ "name": "getEntitiesByTag"
21079
+ },
21021
21080
  {
21022
21081
  "kind": "MethodSignature",
21023
21082
  "canonicalReference": "@dcl/playground-assets!IEngine#getEntitiesWith:member(1)",
@@ -70095,6 +70154,244 @@
70095
70154
  "endIndex": 0
70096
70155
  }
70097
70156
  },
70157
+ {
70158
+ "kind": "Variable",
70159
+ "canonicalReference": "@dcl/playground-assets!Tags:var",
70160
+ "docComment": "",
70161
+ "excerptTokens": [
70162
+ {
70163
+ "kind": "Content",
70164
+ "text": "Tags: "
70165
+ },
70166
+ {
70167
+ "kind": "Reference",
70168
+ "text": "TagsComponentDefinitionExtended",
70169
+ "canonicalReference": "@dcl/playground-assets!TagsComponentDefinitionExtended:interface"
70170
+ }
70171
+ ],
70172
+ "fileUrlPath": "../ecs/dist/index.d.ts",
70173
+ "isReadonly": true,
70174
+ "releaseTag": "Public",
70175
+ "name": "Tags",
70176
+ "variableTypeTokenRange": {
70177
+ "startIndex": 1,
70178
+ "endIndex": 2
70179
+ }
70180
+ },
70181
+ {
70182
+ "kind": "Interface",
70183
+ "canonicalReference": "@dcl/playground-assets!TagsComponentDefinitionExtended:interface",
70184
+ "docComment": "",
70185
+ "excerptTokens": [
70186
+ {
70187
+ "kind": "Content",
70188
+ "text": "export interface TagsComponentDefinitionExtended extends "
70189
+ },
70190
+ {
70191
+ "kind": "Reference",
70192
+ "text": "LastWriteWinElementSetComponentDefinition",
70193
+ "canonicalReference": "@dcl/playground-assets!LastWriteWinElementSetComponentDefinition:interface"
70194
+ },
70195
+ {
70196
+ "kind": "Content",
70197
+ "text": "<"
70198
+ },
70199
+ {
70200
+ "kind": "Reference",
70201
+ "text": "TagsType",
70202
+ "canonicalReference": "@dcl/playground-assets!TagsType:interface"
70203
+ },
70204
+ {
70205
+ "kind": "Content",
70206
+ "text": ">"
70207
+ },
70208
+ {
70209
+ "kind": "Content",
70210
+ "text": " "
70211
+ }
70212
+ ],
70213
+ "fileUrlPath": "../ecs/dist/components/manual/Tags.d.ts",
70214
+ "releaseTag": "Public",
70215
+ "name": "TagsComponentDefinitionExtended",
70216
+ "preserveMemberOrder": false,
70217
+ "members": [
70218
+ {
70219
+ "kind": "MethodSignature",
70220
+ "canonicalReference": "@dcl/playground-assets!TagsComponentDefinitionExtended#add:member(1)",
70221
+ "docComment": "/**\n * Add a tag to the entity's Tags component or create the component if it doesn't exist and add the tag\n *\n * @param entity - entity to add the tag to\n *\n * @param tagName - the tag name to add\n *\n * @returns true\n *\n * @public\n */\n",
70222
+ "excerptTokens": [
70223
+ {
70224
+ "kind": "Content",
70225
+ "text": "add(entity: "
70226
+ },
70227
+ {
70228
+ "kind": "Reference",
70229
+ "text": "Entity",
70230
+ "canonicalReference": "@dcl/playground-assets!Entity:type"
70231
+ },
70232
+ {
70233
+ "kind": "Content",
70234
+ "text": ", tagName: "
70235
+ },
70236
+ {
70237
+ "kind": "Content",
70238
+ "text": "string"
70239
+ },
70240
+ {
70241
+ "kind": "Content",
70242
+ "text": "): "
70243
+ },
70244
+ {
70245
+ "kind": "Content",
70246
+ "text": "boolean"
70247
+ },
70248
+ {
70249
+ "kind": "Content",
70250
+ "text": ";"
70251
+ }
70252
+ ],
70253
+ "isOptional": false,
70254
+ "returnTypeTokenRange": {
70255
+ "startIndex": 5,
70256
+ "endIndex": 6
70257
+ },
70258
+ "releaseTag": "Public",
70259
+ "overloadIndex": 1,
70260
+ "parameters": [
70261
+ {
70262
+ "parameterName": "entity",
70263
+ "parameterTypeTokenRange": {
70264
+ "startIndex": 1,
70265
+ "endIndex": 2
70266
+ },
70267
+ "isOptional": false
70268
+ },
70269
+ {
70270
+ "parameterName": "tagName",
70271
+ "parameterTypeTokenRange": {
70272
+ "startIndex": 3,
70273
+ "endIndex": 4
70274
+ },
70275
+ "isOptional": false
70276
+ }
70277
+ ],
70278
+ "name": "add"
70279
+ },
70280
+ {
70281
+ "kind": "MethodSignature",
70282
+ "canonicalReference": "@dcl/playground-assets!TagsComponentDefinitionExtended#remove:member(1)",
70283
+ "docComment": "/**\n * Remove a tag from the entity's Tags component\n *\n * @param entity - entity to remove the tag from\n *\n * @param tagName - the tag name to remove\n *\n * @returns true if successful, false if the entity doesn't have a Tags component or the tag doesn't exist\n *\n * @public\n */\n",
70284
+ "excerptTokens": [
70285
+ {
70286
+ "kind": "Content",
70287
+ "text": "remove(entity: "
70288
+ },
70289
+ {
70290
+ "kind": "Reference",
70291
+ "text": "Entity",
70292
+ "canonicalReference": "@dcl/playground-assets!Entity:type"
70293
+ },
70294
+ {
70295
+ "kind": "Content",
70296
+ "text": ", tagName: "
70297
+ },
70298
+ {
70299
+ "kind": "Content",
70300
+ "text": "string"
70301
+ },
70302
+ {
70303
+ "kind": "Content",
70304
+ "text": "): "
70305
+ },
70306
+ {
70307
+ "kind": "Content",
70308
+ "text": "boolean"
70309
+ },
70310
+ {
70311
+ "kind": "Content",
70312
+ "text": ";"
70313
+ }
70314
+ ],
70315
+ "isOptional": false,
70316
+ "returnTypeTokenRange": {
70317
+ "startIndex": 5,
70318
+ "endIndex": 6
70319
+ },
70320
+ "releaseTag": "Public",
70321
+ "overloadIndex": 1,
70322
+ "parameters": [
70323
+ {
70324
+ "parameterName": "entity",
70325
+ "parameterTypeTokenRange": {
70326
+ "startIndex": 1,
70327
+ "endIndex": 2
70328
+ },
70329
+ "isOptional": false
70330
+ },
70331
+ {
70332
+ "parameterName": "tagName",
70333
+ "parameterTypeTokenRange": {
70334
+ "startIndex": 3,
70335
+ "endIndex": 4
70336
+ },
70337
+ "isOptional": false
70338
+ }
70339
+ ],
70340
+ "name": "remove"
70341
+ }
70342
+ ],
70343
+ "extendsTokenRanges": [
70344
+ {
70345
+ "startIndex": 1,
70346
+ "endIndex": 5
70347
+ }
70348
+ ]
70349
+ },
70350
+ {
70351
+ "kind": "Interface",
70352
+ "canonicalReference": "@dcl/playground-assets!TagsType:interface",
70353
+ "docComment": "",
70354
+ "excerptTokens": [
70355
+ {
70356
+ "kind": "Content",
70357
+ "text": "export interface TagsType "
70358
+ }
70359
+ ],
70360
+ "fileUrlPath": "../ecs/dist/components/manual/Tags.d.ts",
70361
+ "releaseTag": "Public",
70362
+ "name": "TagsType",
70363
+ "preserveMemberOrder": false,
70364
+ "members": [
70365
+ {
70366
+ "kind": "PropertySignature",
70367
+ "canonicalReference": "@dcl/playground-assets!TagsType#tags:member",
70368
+ "docComment": "",
70369
+ "excerptTokens": [
70370
+ {
70371
+ "kind": "Content",
70372
+ "text": "tags: "
70373
+ },
70374
+ {
70375
+ "kind": "Content",
70376
+ "text": "string[]"
70377
+ },
70378
+ {
70379
+ "kind": "Content",
70380
+ "text": ";"
70381
+ }
70382
+ ],
70383
+ "isReadonly": false,
70384
+ "isOptional": false,
70385
+ "releaseTag": "Public",
70386
+ "name": "tags",
70387
+ "propertyTypeTokenRange": {
70388
+ "startIndex": 1,
70389
+ "endIndex": 2
70390
+ }
70391
+ }
70392
+ ],
70393
+ "extendsTokenRanges": []
70394
+ },
70098
70395
  {
70099
70396
  "kind": "TypeAlias",
70100
70397
  "canonicalReference": "@dcl/playground-assets!TargetEntityRaycastOptions:type",
@@ -1253,6 +1253,7 @@ export interface IEngine {
1253
1253
  defineValueSetComponentFromSchema<T>(componentName: string, spec: ISchema<T>, options: ValueSetOptions<T>): GrowOnlyValueSetComponentDefinition<T>;
1254
1254
  getComponent<T>(componentId: number | string): ComponentDefinition<T>;
1255
1255
  getComponentOrNull<T>(componentId: number | string): ComponentDefinition<T> | null;
1256
+ getEntitiesByTag(tagName: string): Iterable<Entity>;
1256
1257
  getEntitiesWith<T extends [ComponentDefinition<any>, ...ComponentDefinition<any>[]]>(...components: T): Iterable<[Entity, ...ReadonlyComponentSchema<T>]>;
1257
1258
  getEntityByName<T = never, K = T>(value: K & (T extends never ? never : string)): Entity;
1258
1259
  // @alpha
@@ -4081,6 +4082,27 @@ export type SystemItem = {
4081
4082
  // @public (undocumented)
4082
4083
  export const SYSTEMS_REGULAR_PRIORITY = 100000;
4083
4084
 
4085
+ // Warning: (ae-missing-release-tag) "Tags" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
4086
+ //
4087
+ // @public (undocumented)
4088
+ export const Tags: TagsComponentDefinitionExtended;
4089
+
4090
+ // Warning: (ae-missing-release-tag) "TagsComponentDefinitionExtended" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
4091
+ //
4092
+ // @public (undocumented)
4093
+ export interface TagsComponentDefinitionExtended extends LastWriteWinElementSetComponentDefinition<TagsType> {
4094
+ add(entity: Entity, tagName: string): boolean;
4095
+ remove(entity: Entity, tagName: string): boolean;
4096
+ }
4097
+
4098
+ // Warning: (ae-missing-release-tag) "TagsType" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
4099
+ //
4100
+ // @public (undocumented)
4101
+ export interface TagsType {
4102
+ // (undocumented)
4103
+ tags: string[];
4104
+ }
4105
+
4084
4106
  // Warning: (ae-missing-release-tag) "TargetEntityRaycastOptions" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal)
4085
4107
  //
4086
4108
  // @public (undocumented)
package/package.json CHANGED
@@ -1,11 +1,11 @@
1
1
  {
2
2
  "name": "@dcl/playground-assets",
3
3
  "description": "",
4
- "version": "7.10.2",
4
+ "version": "7.10.3-17918694201.commit-b983b3b",
5
5
  "author": "Decentraland",
6
6
  "dependencies": {
7
- "@dcl/js-runtime": "7.10.2",
8
- "@dcl/sdk": "7.10.2"
7
+ "@dcl/js-runtime": "7.10.3-17918694201.commit-b983b3b",
8
+ "@dcl/sdk": "7.10.3-17918694201.commit-b983b3b"
9
9
  },
10
10
  "devDependencies": {
11
11
  "@microsoft/api-extractor": "^7.33.8"
@@ -32,5 +32,5 @@
32
32
  },
33
33
  "types": "./dist/index.d.ts",
34
34
  "typings": "./dist/index.d.ts",
35
- "commit": "931de89979b7eca676af3d4e3ccbaa5dcf8ef300"
35
+ "commit": "b983b3b74a44f323355ad4aed6a0e25504d20eb1"
36
36
  }