![]() a The karaoke skeleton is a collection of functions mainly intended to do Modules reference # util An assorted collection of various utility functions which don’t fit into any coherent categories, especially for handling colours. Note that a, a and a do not have to be required in Karaoke Templater, as they are automatically imported. ![]() ![]() To use modules in Karaoke Templater, place the require statement in a code once line. These have been deprecated in favor of following the modern lua module style introduced with Lua 5.2. Note that if you look at older scripts you will probably see several other methods for including modules, such as include. Simply write modulename = require 'aegisub.modulename' at the top level of a script.įor example, to include the re modules, re = require 'aegisub.re'. Some of these, such as a implement subtitle-specific functionality, while others such as re fill holes in the Lua standard library. Miscellaneous APIs for e.g.A number of Lua modules are included with Aegisub. Providing a configuration interface for export filters. Displaying dialogue boxes and getting user input requesting user input during macro execution by dialogue boxes and ![]() Hints and warnings to the user and printing debug information. Progress reporting and debug output providing feedback to the user while a script is running, outputting Subtitle file interface Deals with use of the subtitles object, the principal way of accessingĪnd modifying the subtitle data. Script and feature registration Deals with advertising what features a script provides and a few other The Automation 4 Lua core APIĪutomation 4 Lua provides various APIs that can be grouped in these generalĬategories. Of the functions provided by the includes. You will find that for anything but the simplest scripts you will need some While it is possible to writeĪutomation 4 Lua scripts without using the provided standard include files that don'tĭepend directly on Aegisub internal data structures, have been implemented Most things that can be implemented in clean Lua code, i.e. Piece of text will be when rendered with a given style. the video frame timestamps and how large a This is described on the SubtitleĪutomation 4 Lua also provides a number of helper functions in the core APIįor getting information on e.g. The subtitles object allows you to accessĮvery line in the subtitle file, including headers, style definitions,ĭialogue lines and comment lines. Integer-indexed array, but it exposes some special interfaces to add, To some extent, the subtitles object works as an Object, the primary interface to the subtitle data the script will One of the parameters passed to the function is a subtitles Selecting a macro from the Automation menu) the registered script function When the user activates a feature from the Aegisub interface (such as by Then call the feature registration functions. Import some modules, write some functions that do the script's work and What you usually will do is define some of the script information globals, You can put variable initialisations and such at the top level, but When an Automation 4 Lua script is loaded, its top-level code is executed Templater script defines one macro and one export filter. Zero, one or many of each of those features. Manager window: script_name, script_description,Īutomation 4 Lua implements both of the currently defined "features" ofĪutomation 4: Macro and Export Filter. This information will be displayed in the There's a number of global variables a script can set to provide The smallest legal Automation 4 Lua script is an empty file, but that won't General overview of the organisation of Automation 4 Lua Language itself and its standard libraries. Structures provided by the Aegisub Automation 4 Lua interface. Libraries shipping with Lua, but only the additional functions and data This manual will not deal with the Lua language itself nor the standard The Automation 4 Lua scripting engine is based on the version 5.1 series of
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |