IMapConverter that provides functionality for identifying and saving maps from files. More...

Inheritance diagram for fCraft.MapConversion.IMapImporter:

[legend]

Collaboration diagram for fCraft.MapConversion.IMapImporter:

Public Member Functions
bool	ClaimsName ([NotNull] string path)
	Returns true if the file name (or directory name) matches this format's expectations.

bool	Claims ([NotNull] string path)
	Allows validating the map format while using minimal resources.

Map	LoadHeader ([NotNull] string path)
	Attempts to load map dimensions from specified location. Throws MapFormatException on failure.

Map	Load ([NotNull] string path)
	Fully loads map from specified location. Throws MapFormatException on failure.

Additional Inherited Members
Properties inherited from fCraft.MapConversion.IMapConverter
string	ServerName `[get]`
	Returns name(s) of the server(s) that uses this format.

bool	SupportsImport `[get]`
	Whether this converter supports importing/loading from the format.

bool	SupportsExport `[get]`
	Whether this converter supports exporting/saving to the format.

string	FileExtension `[get]`
	File extension assiciated with this file. Throws NotSupportedException if this is a directory-based format.

MapStorageType	StorageType `[get]`
	Returns the map storage type (file-based or directory-based).

MapFormat	Format `[get]`
	Returns the format name.

Detailed Description

IMapConverter that provides functionality for identifying and saving maps from files.

Member Function Documentation

bool fCraft.MapConversion.IMapImporter.Claims ( [NotNull] string path )

Allows validating the map format while using minimal resources.

bool fCraft.MapConversion.IMapImporter.ClaimsName ( [NotNull] string path )

Returns true if the file name (or directory name) matches this format's expectations.

Map fCraft.MapConversion.IMapImporter.Load ( [NotNull] string path )

Fully loads map from specified location. Throws MapFormatException on failure.

Map fCraft.MapConversion.IMapImporter.LoadHeader ( [NotNull] string path )

Attempts to load map dimensions from specified location. Throws MapFormatException on failure.

The documentation for this interface was generated from the following file: