Объяснение формата
В начале (страницы с описанием) я буду записывать функцию и аргументы следующим образом:
[no fix] Code "string", arg_enum, var_float, [optional] (returns short)
[no fix] Указывает, что эта функция никогда не используется со стрелкой, то есть не может быть вызвана определенным объектом.
Функции без этого префикса могут быть вызваны актером, объектом или теми, и другими.
Code: Имя функции
Аргументы функции: “string” указывает на строку, например ID объекта.
arg_enum указывает на явное значение (не переменную).
var_float указывает на переменную определенного типа (например, float).
Скобки [...] указывают на необязательные параметры.
(returns short) или (returns float) указывают, что функция возвращает значение и обозначает его тип.
Я буду использовать (returns Boolean/short), чтобы указать, что функция возвращает 1 или 0, так как в игре они имеют тип short.
Пример использования приводится (жирным шрифтом) и с отступом:
Code "ID", var_enum, var_float
Примеры скриптов заключены в рамку *это в оригинале, у нас скрипты синим шрифтом и отступом идут.
Begin script
[функции скрипта]
End script
С 8-ой редакции функции из Трибунала и Бладмуна находятся в соответствующих разделах руководства.
Они обозначены:
для функций Трибунала
для функций Бладмуна.
Чтобы использовать эти функции нужно установить соответствующее дополнение (но не обязательно его активировать)
*т.е. все зависит от версии МВ.ехе, а не активации мастер файлов в лаунчере.
Explanation of the format
First I will list the function and the arguments it takes:
[no fix] Code "string", arg_enum, arg_float, [optional] (returns short)
[no fix] Indicates this function can never be used with a "fix" meaning it can not be called by a specified actor. Functions without this tag can be called by an actor, an object, or both.
Code: Name of the function
Arguments of the function: "string" indicates a literal string, such as an object ID. arg_enum indicates a literal value (no variables taken) var_float indicates a variable of the specified type (in this case float). Brackets [] indicate optional parameters. (returns short) or (returns float) indicate that the function returns a value and of what type the value is. I will use the designation (returns Boolean/short) to indicate a function that returns either 1 or 0 (a Boolean variable although the game strictly speaking still uses a float)
Examples of usage follow in italics and are indented:
Code "ID", var_enum, var_float
Example scripts are set in frames:
Begin script
[Script functions]
End script
From the 8th edition onward the functions added with Tribunal and Bloodmoon have been moved into the suitable sections of the reference section. They are now marked with:
for Tribunal functions and
for Bloodmoon functions.
To use these functions the respective expansion must be installed (but not necessarily active). Bloodmoon (and GOTY edition) incorporates all functions from Tribunal as well.
