iqbalrifai
/
Aegisub
mirror of https://github.com/odrling/Aegisub
1
0
Fork 0
Code Issues Releases Wiki Activity

minor clarifications in perl-api.txt 

Originally committed to SVN as r1764.
This commit is contained in:
Karl Blomster 2008-01-18 06:01:27 +00:00
parent 6a27b9a075
commit f4f619d22b
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
automation/v4-docs/perl-api.txt
View File

@ -68,9 +68,9 @@ register_macro NAME, DESC, PROC_SUB, VAL_SUB
NAME The name of the macro. NAME The name of the macro.
DESC A dascription for the macro. DESC A dascription for the macro.
PROC_SUB A ref to a subroutine to be used as the macro processing function PROC_SUB A ref to a subroutine to be used as the macro processing function
(see the next section). (see the callbacks section).
VAL_SUB A ref to a subrotine to be used as the macro validation function VAL_SUB A ref to a subrotine to be used as the macro validation function
(see next)(optional, if not defined will be considered as always true). (see callbacks)(optional, if not defined will be considered as always true).
set_info NAME, DESC, AUTHOR, VERSION set_info NAME, DESC, AUTHOR, VERSION
You can set all of the script's info values with a call to this function You can set all of the script's info values with a call to this function
@ -123,7 +123,12 @@ macro_processing_function LINES, SELECTED, ACTIVE
The first two arguments can be modified, and the modification will be The first two arguments can be modified, and the modification will be
reflected in the subtitles file reflected in the subtitles file
Arguments: Arguments:
LINES A ref the the list containing the subtitle file lines LINES A reference to the list containing the subtitle file lines.
Each element of the list is actually a hash with the name of the fields
as keys. See the Lua documentation; this is basically the same structure.
EXAMPLE:
my $l = $lines->[$linenumber]; # an entire line
my $text = $lines->[$linenumber]->{"text"} # the text field of a dialogue line
SELECTED A ref to an array of ints, showing the currently selected lines in SELECTED A ref to an array of ints, showing the currently selected lines in
the file the file
ACTIVE Index of the currently active line in the subtitle file (sic) ACTIVE Index of the currently active line in the subtitle file (sic)