love-typescript-definitions
Version:
Write LÖVE 2D projects with TypeScript
58 lines (52 loc) • 2.06 kB
TypeScript
/**
* Allows you to work with threads.
*
* @noResolution
* @noSelf
* @link [love.thread](https://love2d.org/wiki/love.thread)
*/
declare module "love.thread" {
import { FileData } from "love.filesystem";
/**
* Creates or retrieves a named thread channel.
*
* @param name The name of the channel you want to create or retrieve.
* @return channel, A named channel object which can be further manipulated.
* @link [love.thread.getChannel](https://love2d.org/wiki/love.thread.getChannel)
*/
function getChannel(name: string): Channel;
/**
* Create a new unnamed thread channel.
*
* One use for them is to pass new unnamed channels to other threads via
* Channel:push
*
* @return channel, A unnamed channel object which can be further manipulated.
* @link [love.thread.newChannel](https://love2d.org/wiki/love.thread.newChannel)
*/
function newChannel(): Channel;
/**
* Creates a new Thread from a filename, string or FileData object containing Lua code.
*
* @param filename The name of the Lua File to use as source.
* @return thread, A new Thread that has yet to be started.
* @link [love.thread.newThread](https://love2d.org/wiki/love.thread.newThread)
*/
function newThread(filename: string): Thread;
/**
* Creates a new Thread from a File or Data object.
*
* @param fileData The FileData containing the Lua code to use as the source.
* @return thread, A new Thread that has yet to be started.
* @link [love.thread.newThread](https://love2d.org/wiki/love.thread.newThread)
*/
function newThread(fileData: FileData): Thread;
/**
* Creates a new Thread from a File or Data object.
*
* @param codestring A string containing the Lua code to use as the source. It needs to either be at least 1024 characters long, or contain at least one newline.
* @return thread, A new Thread that has yet to be started.
* @link [love.thread.newThread](https://love2d.org/wiki/love.thread.newThread)
*/
function newThread(codestring: string): Thread;
}