core/com.lehaine.littlekt.file.vfs/VfsFile

VfsFile

data class VfsFile(val vfs: Vfs, val path: String) : VfsNamed

A virtual file or directory on a file system.

Author

Colton Daily

Constructors

fun VfsFile(vfs: Vfs, path: String)

Functions

decodeFromString

inline suspend fun <T> decodeFromString(): T

operator fun get(path: String): VfsFile

fun isHttpUrl(): Boolean

suspend fun read(): ByteBuffer

suspend fun readBytes(): ByteArray

fun readKeystore(): String?

readKeystoreBytes

fun readKeystoreBytes(): ByteBuffer?

suspend fun readLines(): List<String>

suspend fun readStream(): ByteSequenceStream

suspend fun readString(): String

fun relativePathTo(relative: VfsFile): String?

fun writeKeystore(data: ByteArray): Boolean

fun writeKeystore(data: String): Boolean

Properties

val absolutePath: String

absolutePathInfo

val absolutePathInfo: PathInfo

val parent: VfsFile

val path: String

open override val pathInfo: PathInfo

val root: VfsFile

val vfs: Vfs

Extensions

val Path.baseName: String

baseNameWithCompoundExtension

fun Path.baseNameWithCompoundExtension(ext: String): String

baseNameWithExtension

fun Path.baseNameWithExtension(ext: String): String

baseNameWithoutCompoundExtension

val Path.baseNameWithoutCompoundExtension: String

baseNameWithoutExtension

val Path.baseNameWithoutExtension: String

compoundExtension

val Path.compoundExtension: String

compoundExtensionLC

val Path.compoundExtensionLC: String

val Path.extension: String

val Path.extensionLC: String

val Path.folder: String

folderWithSlash

val Path.folderWithSlash: String

val Path.fullName: String

fullNameWithoutCompoundExtension

val Path.fullNameWithoutCompoundExtension: String

fullNameWithoutExtension

val Path.fullNameWithoutExtension: String

fullPathNormalized

val Path.fullPathNormalized: String

fullPathWithExtension

fun Path.fullPathWithExtension(ext: String): String

fullPathWithoutExtension

val Path.fullPathWithoutExtension: String

getPathComponents

fun Path.getPathComponents(): List<String>

getPathFullComponents

fun Path.getPathFullComponents(): List<String>

mimeTypeByExtension

val Path.mimeTypeByExtension: MimeType

suspend fun VfsFile.readAtlas(): TextureAtlas

Loads a TextureAtlas from the given path. Currently, supports only JSON atlas files.

actual suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

expect suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

actual suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

actual suspend fun VfsFile.readAudioClip(): AudioClip

Loads audio from the path as an AudioClip.

readAudioStream

actual suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

expect suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

actual suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

actual suspend fun VfsFile.readAudioStream(): AudioStream

Streams audio from the path as an AudioStream.

suspend fun VfsFile.readBitmapFont(filter: TexMagFilter = TexMagFilter.NEAREST, mipmaps: Boolean = true, preloadedTextures: List<TextureSlice> = listOf()): BitmapFont

Reads a bitmap font.

suspend fun VfsFile.readGltfModel(loadTexturesAsynchronously: Boolean = false): Model

Loads a glTF / glb model from the path and converts it to a Model.

readLDtkMapLoader

suspend fun VfsFile.readLDtkMapLoader(atlas: TextureAtlas? = null, tilesetBorder: Int = 2): LDtkMapLoader

Reads the VfsFile as a LDtkMapLoader. This will read the LDtk file and create a loader to allow flexible loading of LDtkWorld or LDtkLevel. This loader should be cached and reused when loading separate levels.

actual suspend fun VfsFile.readPixmap(): Pixmap

expect suspend fun VfsFile.readPixmap(): Pixmap

Loads an image from the path as a Pixmap.

actual suspend fun VfsFile.readPixmap(): Pixmap

Loads an image from the path as a Pixmap.

actual suspend fun VfsFile.readPixmap(): Pixmap

actual suspend fun VfsFile.readTexture(minFilter: TexMinFilter, magFilter: TexMagFilter, mipmaps: Boolean): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

expect suspend fun VfsFile.readTexture(minFilter: TexMinFilter = TexMinFilter.NEAREST, magFilter: TexMagFilter = TexMagFilter.NEAREST, mipmaps: Boolean = true): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

actual suspend fun VfsFile.readTexture(minFilter: TexMinFilter, magFilter: TexMagFilter, mipmaps: Boolean): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

actual suspend fun VfsFile.readTexture(minFilter: TexMinFilter, magFilter: TexMagFilter, mipmaps: Boolean): Texture

Loads an image from the path as a Texture. This will call Texture.prepare before returning!

suspend fun VfsFile.readTiledMap(atlas: TextureAtlas? = null, tilesetBorder: Int = 2, mipmaps: Boolean = true): TiledMap

Reads the VfsFile as a TiledMap. Any loaders and assets will be cached for reuse/reloading.

suspend fun VfsFile.readTtfFont(chars: String = CharacterSets.LATIN_ALL): TtfFont

actual suspend fun VfsFile.writePixmap(pixmap: Pixmap)

expect suspend fun VfsFile.writePixmap(pixmap: Pixmap)

Write pixmap to disk.

actual suspend fun VfsFile.writePixmap(pixmap: Pixmap)

actual suspend fun VfsFile.writePixmap(pixmap: Pixmap)