HomeWikiSourceDownloadsDiscord

Kristal Wiki

Getting Started

These pages get you ready to use the engine.


General Mod Creation

These pages teach you about mod development.


The Overworld

Everything to do with the overworld.


Battles

Everything related to creating battles.


API Reference

An auto-generated API reference for Kristal.

⮬Back to Top⮭

Methods


Assets.getBubbleData(path: string)

Arguments:

path: string

Returns:

1: table

Assets.getFont(path: string, size: number?)

Arguments:

path: string
size: number?

Returns:

1: love.Font

Assets.getFontData(path: string)

Arguments:

path: string

Returns:

1: table

Assets.getFontScale(path: string, size: number?)

Arguments:

path: string
size: number?

Returns:

1: number

Assets.getFrameIds(path: string)

Arguments:

path: string

Returns:

1: string[]

Assets.getFrames(path: string)

Arguments:

path: string

Returns:

1: love.Image[]

Assets.getFramesFor(texture: string)

Arguments:

texture: string

Returns:

texture: string
frame: number

Assets.getFramesOrTexture(path: string)

Arguments:

path: string

Returns:

1: love.Image[]

Assets.getMusicPath(music: string)

Arguments:

music: string

Returns:

1: string

Assets.getQuad(x: number, y: number, w: number, h: number, sw: number, sh: number)

Arguments:

x: number
y: number
w: number
h: number
sw: number
sh: number

Returns:

1: love.Quad

Assets.getSound(sound: string)

Arguments:

sound: string

Returns:

1: love.Source

Assets.getTexture(path: string)

Arguments:

path: string

Returns:

1: love.Image

Assets.getTextureData(path: string)

Arguments:

path: string

Returns:

1: love.ImageData

Assets.getTextureID(texture: string|love.Image)

Arguments:

texture: string|love.Image

Drawable image type.

Open in Browser

Returns:

1: string

Assets.getVideoPath(video: string)

Arguments:

video: string

Returns:

1: string


Assets.newSound(sound: string)

Arguments:

sound: string

Returns:

1: love.Source

Assets.newVideo(video: string, load_audio: boolean?)

Arguments:

video: string
load_audio: boolean?

Returns:

1: love.Video


Assets.playSound(sound: string, volume: number?, pitch: number?)

Arguments:

sound: string
volume: number?
pitch: number?

Returns:

1: love.Source



Assets.startSound(sound: string)

Arguments:

sound: string

Returns:

1: love.Source

Assets.stopAndPlaySound(sound: string, volume: number?, pitch: number?, actually_stop: boolean?)

Arguments:

sound: string
volume: number?
pitch: number?
actually_stop: boolean?

Returns:

1: love.Source

Assets.stopSound(sound: string, actually_stop: boolean?)

Arguments:

sound: string
actually_stop: boolean?



Fields


Undocumented