Version: Phaser v4.0.0-rc.6

TilemapCSVFile

A single Tilemap CSV File suitable for loading by the Loader.

These are created when you use the Phaser.Loader.LoaderPlugin#tilemapCSV method and are not typically created directly.

For documentation about what all the arguments and configuration options mean please see Phaser.Loader.LoaderPlugin#tilemapCSV.

Constructor

new TilemapCSVFile(loader, key, [url], [xhrSettings])

Parameters

name	type	optional	description
loader	Phaser.Loader.LoaderPlugin	No	A reference to the Loader that is responsible for this file.
key	string \| Phaser.Types.Loader.FileTypes.TilemapCSVFileConfig	No	The key to use for this file, or a file configuration object.
url	string	Yes	The absolute or relative URL to load this file from. If undefined or `null` it will be set to `<key>.csv`, i.e. if `key` was "alien" then the URL will be "alien.csv".
xhrSettings	Phaser.Types.Loader.XHRSettingsObject	Yes	Extra XHR Settings specifically for this file.

Scope: static

Extends

Phaser.Loader.File

Source: src/loader/filetypes/TilemapCSVFile.js#L15
Since: 3.0.0

Inherited Methods

Description:

Adds this file to its target cache upon successful loading and processing.

Overrides: Phaser.Loader.File#addToCache

Source: src/loader/filetypes/TilemapCSVFile.js#L85
Since: 3.7.0

Description:

Called automatically by Loader.nextFile.

This method controls what extra work this File does with its loaded data.

Overrides: Phaser.Loader.File#onProcess

Source: src/loader/filetypes/TilemapCSVFile.js#L69
Since: 3.7.0