pixi-tiledmap 2.0.0 → 2.1.0

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/index.d.ts DELETED
@@ -1,459 +0,0 @@
1
- import { Texture, Container, LoaderParser } from 'pixi.js';
2
-
3
- type TiledOrientation = 'orthogonal' | 'isometric' | 'staggered' | 'hexagonal';
4
- type TiledRenderOrder = 'right-down' | 'right-up' | 'left-down' | 'left-up';
5
- type TiledStaggerAxis = 'x' | 'y';
6
- type TiledStaggerIndex = 'odd' | 'even';
7
- type TiledLayerType = 'tilelayer' | 'objectgroup' | 'imagelayer' | 'group';
8
- type TiledDrawOrder = 'topdown' | 'index';
9
- type TiledEncoding = 'csv' | 'base64';
10
- type TiledCompression = 'zlib' | 'gzip' | 'zstd' | '';
11
- type TiledPropertyType = 'string' | 'int' | 'float' | 'bool' | 'color' | 'file' | 'object' | 'class';
12
- type TiledObjectAlignment = 'unspecified' | 'topleft' | 'top' | 'topright' | 'left' | 'center' | 'right' | 'bottomleft' | 'bottom' | 'bottomright';
13
- type TiledTileRenderSize = 'tile' | 'grid';
14
- type TiledFillMode = 'stretch' | 'preserve-aspect-fit';
15
- type TiledGridOrientation = 'orthogonal' | 'isometric';
16
- type TiledWangSetType = 'corner' | 'edge' | 'mixed';
17
- type TiledHAlign = 'center' | 'right' | 'justify' | 'left';
18
- type TiledVAlign = 'center' | 'bottom' | 'top';
19
- interface TiledProperty {
20
- name: string;
21
- type: TiledPropertyType;
22
- propertytype?: string;
23
- value: string | number | boolean;
24
- }
25
- interface TiledPoint {
26
- x: number;
27
- y: number;
28
- }
29
- interface TiledText {
30
- bold?: boolean;
31
- color?: string;
32
- fontfamily?: string;
33
- halign?: TiledHAlign;
34
- italic?: boolean;
35
- kerning?: boolean;
36
- pixelsize?: number;
37
- strikeout?: boolean;
38
- text: string;
39
- underline?: boolean;
40
- valign?: TiledVAlign;
41
- wrap?: boolean;
42
- }
43
- interface TiledObject {
44
- ellipse?: boolean;
45
- gid?: number;
46
- height: number;
47
- id: number;
48
- name: string;
49
- point?: boolean;
50
- polygon?: TiledPoint[];
51
- polyline?: TiledPoint[];
52
- properties?: TiledProperty[];
53
- rotation: number;
54
- template?: string;
55
- text?: TiledText;
56
- type: string;
57
- visible: boolean;
58
- width: number;
59
- x: number;
60
- y: number;
61
- }
62
- interface TiledChunk {
63
- data: number[] | string;
64
- height: number;
65
- width: number;
66
- x: number;
67
- y: number;
68
- }
69
- interface TiledLayer {
70
- chunks?: TiledChunk[];
71
- class?: string;
72
- compression?: TiledCompression;
73
- data?: number[] | string;
74
- draworder?: TiledDrawOrder;
75
- encoding?: TiledEncoding;
76
- height?: number;
77
- id: number;
78
- image?: string;
79
- imageheight?: number;
80
- imagewidth?: number;
81
- layers?: TiledLayer[];
82
- locked?: boolean;
83
- name: string;
84
- objects?: TiledObject[];
85
- offsetx?: number;
86
- offsety?: number;
87
- opacity: number;
88
- parallaxx?: number;
89
- parallaxy?: number;
90
- properties?: TiledProperty[];
91
- repeatx?: boolean;
92
- repeaty?: boolean;
93
- startx?: number;
94
- starty?: number;
95
- tintcolor?: string;
96
- transparentcolor?: string;
97
- type: TiledLayerType;
98
- visible: boolean;
99
- width?: number;
100
- x: number;
101
- y: number;
102
- }
103
- interface TiledFrame {
104
- duration: number;
105
- tileid: number;
106
- }
107
- interface TiledTileOffset {
108
- x: number;
109
- y: number;
110
- }
111
- interface TiledGrid {
112
- height: number;
113
- orientation: TiledGridOrientation;
114
- width: number;
115
- }
116
- interface TiledTransformations {
117
- hflip: boolean;
118
- vflip: boolean;
119
- rotate: boolean;
120
- preferuntransformed: boolean;
121
- }
122
- interface TiledTerrain {
123
- name: string;
124
- properties?: TiledProperty[];
125
- tile: number;
126
- }
127
- interface TiledWangColor {
128
- class?: string;
129
- color: string;
130
- name: string;
131
- probability: number;
132
- properties?: TiledProperty[];
133
- tile: number;
134
- }
135
- interface TiledWangTile {
136
- tileid: number;
137
- wangid: number[];
138
- }
139
- interface TiledWangSet {
140
- class?: string;
141
- colors: TiledWangColor[];
142
- name: string;
143
- properties?: TiledProperty[];
144
- tile: number;
145
- type: TiledWangSetType;
146
- wangtiles: TiledWangTile[];
147
- }
148
- interface TiledTileDefinition {
149
- animation?: TiledFrame[];
150
- id: number;
151
- image?: string;
152
- imageheight?: number;
153
- imagewidth?: number;
154
- x?: number;
155
- y?: number;
156
- width?: number;
157
- height?: number;
158
- objectgroup?: TiledLayer;
159
- probability?: number;
160
- properties?: TiledProperty[];
161
- terrain?: number[];
162
- type?: string;
163
- }
164
- interface TiledTileset {
165
- backgroundcolor?: string;
166
- class?: string;
167
- columns: number;
168
- fillmode?: TiledFillMode;
169
- firstgid: number;
170
- grid?: TiledGrid;
171
- image?: string;
172
- imageheight?: number;
173
- imagewidth?: number;
174
- margin: number;
175
- name: string;
176
- objectalignment?: TiledObjectAlignment;
177
- properties?: TiledProperty[];
178
- source?: string;
179
- spacing: number;
180
- terrains?: TiledTerrain[];
181
- tilecount: number;
182
- tiledversion?: string;
183
- tileheight: number;
184
- tileoffset?: TiledTileOffset;
185
- tilerendersize?: TiledTileRenderSize;
186
- tiles?: TiledTileDefinition[];
187
- tilewidth: number;
188
- transformations?: TiledTransformations;
189
- transparentcolor?: string;
190
- type?: string;
191
- version?: string;
192
- wangsets?: TiledWangSet[];
193
- }
194
- interface TiledTilesetRef {
195
- firstgid: number;
196
- source: string;
197
- }
198
- interface TiledMap$1 {
199
- backgroundcolor?: string;
200
- class?: string;
201
- compressionlevel?: number;
202
- height: number;
203
- hexsidelength?: number;
204
- infinite: boolean;
205
- layers: TiledLayer[];
206
- nextlayerid: number;
207
- nextobjectid: number;
208
- orientation: TiledOrientation;
209
- parallaxoriginx?: number;
210
- parallaxoriginy?: number;
211
- properties?: TiledProperty[];
212
- renderorder?: TiledRenderOrder;
213
- staggeraxis?: TiledStaggerAxis;
214
- staggerindex?: TiledStaggerIndex;
215
- tiledversion?: string;
216
- tileheight: number;
217
- tilesets: (TiledTileset | TiledTilesetRef)[];
218
- tilewidth: number;
219
- type: 'map';
220
- version: string;
221
- width: number;
222
- }
223
- interface TiledObjectTemplate {
224
- type: 'template';
225
- tileset?: TiledTileset;
226
- object: TiledObject;
227
- }
228
- declare const FLIPPED_HORIZONTALLY_FLAG = 2147483648;
229
- declare const FLIPPED_VERTICALLY_FLAG = 1073741824;
230
- declare const FLIPPED_DIAGONALLY_FLAG = 536870912;
231
- declare const ROTATED_HEXAGONAL_120_FLAG = 268435456;
232
- declare const GID_MASK = 268435455;
233
- interface ResolvedTile {
234
- gid: number;
235
- localId: number;
236
- tilesetIndex: number;
237
- horizontalFlip: boolean;
238
- verticalFlip: boolean;
239
- diagonalFlip: boolean;
240
- }
241
- interface ResolvedChunk {
242
- x: number;
243
- y: number;
244
- width: number;
245
- height: number;
246
- tiles: (ResolvedTile | null)[];
247
- }
248
- interface ResolvedTileLayer {
249
- type: 'tilelayer';
250
- id: number;
251
- name: string;
252
- opacity: number;
253
- visible: boolean;
254
- offsetx: number;
255
- offsety: number;
256
- parallaxx: number;
257
- parallaxy: number;
258
- tintcolor?: string;
259
- properties: TiledProperty[];
260
- width: number;
261
- height: number;
262
- infinite: boolean;
263
- tiles: (ResolvedTile | null)[];
264
- chunks?: ResolvedChunk[];
265
- }
266
- interface ResolvedImageLayer {
267
- type: 'imagelayer';
268
- id: number;
269
- name: string;
270
- opacity: number;
271
- visible: boolean;
272
- offsetx: number;
273
- offsety: number;
274
- parallaxx: number;
275
- parallaxy: number;
276
- tintcolor?: string;
277
- properties: TiledProperty[];
278
- image: string;
279
- imagewidth?: number;
280
- imageheight?: number;
281
- repeatx: boolean;
282
- repeaty: boolean;
283
- transparentcolor?: string;
284
- }
285
- interface ResolvedObjectLayer {
286
- type: 'objectgroup';
287
- id: number;
288
- name: string;
289
- opacity: number;
290
- visible: boolean;
291
- offsetx: number;
292
- offsety: number;
293
- parallaxx: number;
294
- parallaxy: number;
295
- tintcolor?: string;
296
- properties: TiledProperty[];
297
- draworder: TiledDrawOrder;
298
- objects: TiledObject[];
299
- }
300
- interface ResolvedGroupLayer {
301
- type: 'group';
302
- id: number;
303
- name: string;
304
- opacity: number;
305
- visible: boolean;
306
- offsetx: number;
307
- offsety: number;
308
- parallaxx: number;
309
- parallaxy: number;
310
- tintcolor?: string;
311
- properties: TiledProperty[];
312
- layers: ResolvedLayer[];
313
- }
314
- type ResolvedLayer = ResolvedTileLayer | ResolvedImageLayer | ResolvedObjectLayer | ResolvedGroupLayer;
315
- interface ResolvedTileset {
316
- firstgid: number;
317
- name: string;
318
- tilewidth: number;
319
- tileheight: number;
320
- columns: number;
321
- tilecount: number;
322
- margin: number;
323
- spacing: number;
324
- image?: string;
325
- imagewidth?: number;
326
- imageheight?: number;
327
- tileoffset: TiledTileOffset;
328
- objectalignment: TiledObjectAlignment;
329
- tilerendersize: TiledTileRenderSize;
330
- fillmode: TiledFillMode;
331
- tiles: Map<number, TiledTileDefinition>;
332
- properties: TiledProperty[];
333
- transformations?: TiledTransformations;
334
- grid?: TiledGrid;
335
- wangsets?: TiledWangSet[];
336
- terrains?: TiledTerrain[];
337
- }
338
- interface ResolvedMap {
339
- orientation: TiledOrientation;
340
- renderorder: TiledRenderOrder;
341
- width: number;
342
- height: number;
343
- tilewidth: number;
344
- tileheight: number;
345
- infinite: boolean;
346
- backgroundcolor?: string;
347
- hexsidelength?: number;
348
- staggeraxis?: TiledStaggerAxis;
349
- staggerindex?: TiledStaggerIndex;
350
- parallaxoriginx: number;
351
- parallaxoriginy: number;
352
- properties: TiledProperty[];
353
- tilesets: ResolvedTileset[];
354
- layers: ResolvedLayer[];
355
- version: string;
356
- tiledversion?: string;
357
- }
358
- interface ParseOptions {
359
- externalTilesets?: Map<string, TiledTileset>;
360
- }
361
- interface TiledMapOptions {
362
- tilesetTextures?: Map<string, Texture>;
363
- imageLayerTextures?: Map<string, Texture>;
364
- tileImageTextures?: Map<string, Texture>;
365
- }
366
- interface TiledMapAsset {
367
- mapData: ResolvedMap;
368
- container: Container;
369
- }
370
- interface MapContext {
371
- orientation: TiledOrientation;
372
- renderorder: TiledRenderOrder;
373
- tilewidth: number;
374
- tileheight: number;
375
- hexsidelength?: number;
376
- staggeraxis?: TiledStaggerAxis;
377
- staggerindex?: TiledStaggerIndex;
378
- }
379
- interface TilePosition {
380
- x: number;
381
- y: number;
382
- }
383
-
384
- declare function decodeGid(raw: number): ResolvedTile | null;
385
-
386
- declare function decodeLayerData(data: number[] | string, encoding?: TiledEncoding, compression?: TiledCompression): number[];
387
- declare function decodeLayerDataAsync(data: number[] | string, encoding?: TiledEncoding, compression?: TiledCompression): Promise<number[]>;
388
-
389
- declare function parseMap(data: TiledMap$1, options?: ParseOptions): ResolvedMap;
390
- declare function parseMapAsync(data: TiledMap$1, options?: ParseOptions): Promise<ResolvedMap>;
391
-
392
- declare function parseTmx(xml: string): TiledMap$1;
393
- declare function parseTsx(xml: string): TiledTileset;
394
-
395
- declare class TileSetRenderer {
396
- readonly tileset: ResolvedTileset;
397
- readonly baseTexture: Texture | null;
398
- private readonly _textureCache;
399
- constructor(tileset: ResolvedTileset, baseTexture: Texture | null);
400
- getTexture(localId: number): Texture | null;
401
- setTileTexture(localId: number, texture: Texture): void;
402
- getAnimationFrames(localId: number): TiledTileDefinition['animation'] | undefined;
403
- destroy(): void;
404
- }
405
-
406
- declare class TiledMap extends Container {
407
- readonly mapData: ResolvedMap;
408
- readonly tileSetRenderers: TileSetRenderer[];
409
- private _background;
410
- constructor(mapData: ResolvedMap, options?: TiledMapOptions);
411
- get orientation(): TiledOrientation;
412
- get mapWidth(): number;
413
- get mapHeight(): number;
414
- get tileWidth(): number;
415
- get tileHeight(): number;
416
- getLayer(name: string): Container | undefined;
417
- private _buildBackground;
418
- destroy(options?: Parameters<Container['destroy']>[0]): void;
419
- }
420
-
421
- declare function tileToPixel(col: number, row: number, ctx: MapContext): TilePosition;
422
-
423
- declare class TileLayerRenderer extends Container {
424
- readonly layerData: ResolvedTileLayer;
425
- constructor(layerData: ResolvedTileLayer, tilesets: TileSetRenderer[], ctx: MapContext);
426
- private _buildChunks;
427
- private _buildTiles;
428
- private _createAnimatedTile;
429
- }
430
-
431
- declare class ImageLayerRenderer extends Container {
432
- readonly layerData: ResolvedImageLayer;
433
- constructor(layerData: ResolvedImageLayer, texture: Texture | null);
434
- private _buildImage;
435
- }
436
-
437
- declare class ObjectLayerRenderer extends Container {
438
- readonly layerData: ResolvedObjectLayer;
439
- constructor(layerData: ResolvedObjectLayer, tilesets: TileSetRenderer[]);
440
- private _buildObjects;
441
- private _createObject;
442
- private _createTileObject;
443
- private _createTextObject;
444
- private _createRectangle;
445
- private _createEllipse;
446
- private _createPoint;
447
- private _createPolygon;
448
- }
449
-
450
- declare class GroupLayerRenderer extends Container {
451
- readonly layerData: ResolvedGroupLayer;
452
- constructor(layerData: ResolvedGroupLayer, tilesets: TileSetRenderer[], ctx: MapContext, imageTextures: Map<string, Texture>);
453
- }
454
-
455
- declare function createLayerRenderer(layer: ResolvedLayer, tilesets: TileSetRenderer[], ctx: MapContext, imageTextures: Map<string, Texture>): Container | null;
456
-
457
- declare const tiledMapLoader: LoaderParser<TiledMapAsset>;
458
-
459
- export { FLIPPED_DIAGONALLY_FLAG, FLIPPED_HORIZONTALLY_FLAG, FLIPPED_VERTICALLY_FLAG, GID_MASK, GroupLayerRenderer, ImageLayerRenderer, type MapContext, ObjectLayerRenderer, type ParseOptions, ROTATED_HEXAGONAL_120_FLAG, type ResolvedChunk, type ResolvedGroupLayer, type ResolvedImageLayer, type ResolvedLayer, type ResolvedMap, type ResolvedObjectLayer, type ResolvedTile, type ResolvedTileLayer, type ResolvedTileset, TileLayerRenderer, type TilePosition, TileSetRenderer, type TiledChunk, type TiledCompression, type TiledDrawOrder, type TiledEncoding, type TiledFillMode, type TiledFrame, type TiledGrid, type TiledGridOrientation, type TiledHAlign, type TiledLayer, type TiledLayerType, TiledMap, type TiledMapAsset, type TiledMap$1 as TiledMapData, type TiledMapOptions, type TiledObject, type TiledObjectAlignment, type TiledObjectTemplate, type TiledOrientation, type TiledPoint, type TiledProperty, type TiledPropertyType, type TiledRenderOrder, type TiledStaggerAxis, type TiledStaggerIndex, type TiledTerrain, type TiledText, type TiledTileDefinition, type TiledTileOffset, type TiledTileRenderSize, type TiledTileset, type TiledTilesetRef, type TiledTransformations, type TiledVAlign, type TiledWangColor, type TiledWangSet, type TiledWangSetType, type TiledWangTile, createLayerRenderer, decodeGid, decodeLayerData, decodeLayerDataAsync, parseMap, parseMapAsync, parseTmx, parseTsx, tileToPixel, tiledMapLoader };