Редактирование: X-Ray extensions

<div style="padding: .5em 1em; float: right; background: #f2f2f2; border: 1px solid #aaaaaa;">
<big>'''X-Ray extensions'''</big>
----
{| style="border: none"
| '''Тип'''                     || Расширения движка
|-
| '''Авторы'''                  || malandrinus, kolmogor, K.D., RayTwitty (aka Shadows),
Real Wolf, kstn, _призрак_, SkyLoader
|-
| '''Оф. репозиторий''' || [https://github.com/KD87/xray-extensions GitHub]
|-
| '''Оф. тема'''        || [http://www.amk-team.ru/forum/topic/10538-x-ray-extensions AMK форум]
|}
</div>
Этот проект представляет собой набор добавлений, расширяющих возможности движка для скриптеров, а также, в ряде случаев, меняющих поведение игры. Изменения реализованы в виде бинарных патчей библиотек и исполняемых файлов.

Информация данной статьи актуальна для '''187''' ревизии [https://github.com/KD87/xray-extensions официального репозитория].
=ТЧ=
==Скриптовый API==
===Класс game_object===
====Основные методы====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">// CActor
set_actor_visual(string)
float get_sprint_factor()
set_sprint_factor(float)
float get_actor_take_dist()
set_actor_take_dist(float)
float get_actor_max_weight()
set_actor_max_weight(float)
float get_actor_max_walk_weight()
set_actor_max_walk_weight(float)
open_inventory_box(game_object*)
set_camera_direction(vector)
update_camera_direction(game_object*)
enable_car_panel(bool)
attach_vehicle(game_object*)
detach_vehicle(vector)
set_goodwill_ex(int, int, int)
change_goodwill_ex(int, int, int)
float get_camera_fov()
set_camera_fov(float)
restore_camera_fov()
float get_hud_fov()
set_hud_fov(float)
set_hud_animation_channel(int)
set_hud_animation_callback_param(int)
set_use_hud_animation_callback(bool)
clear_personal_record(int, int)
uint actor_body_state()
bool is_actor_normal()
bool is_actor_crouch()
bool is_actor_creep()
bool is_actor_climb()
bool is_actor_walking()
bool is_actor_running()
bool is_actor_sprinting()
bool is_actor_crouching()
bool is_actor_creeping()
bool is_actor_climbing()

// CCar
float get_fuel()
set_fuel(float)
float get_fuel_consumption()
set_fuel_consumption(float)
float get_fuel_tank()

// CEntityAlive
heal_wounds(float)
update_condition()

// CGameObject
string specific_character()
int get_bone_visible(string, int)
int set_bone_visible(string, int)
int get_bone_id(string, int)
string get_bone_name()
bool has_visual()
ini_file* get_visual_ini()
bool nonscript_usable()

// CHangingLamp
set_lsf_speed(float)
set_lsf_amount(float)
set_lsf_smap_jitter(float)
float get_lsf_speed()

// CHolderCustom
game_object* get_holder_owner()

// CHudItem
play_hud_animation(string, bool)
uint get_hud_animation_remaining_time()
int get_hud_animation_length(string, int)
bool is_cyclic_hud_animation()
bool has_hud_animation(string)
set_hud_animation_end_time(int)
stop_hud_sounds()
uint get_hud_item_state()
int get_hud_bone_id(string, int)
vector get_hud_bone_pos(string)
int get_hud_bone_visible(string, int)
int set_hud_bone_visible(string, int)

// CInventoryBox
game_object* object_from_inv_box(int)
uint inv_box_count()

// CInventoryItem
float get_weight()

// CInventoryOwner
bool is_on_belt(game_object*)
bool is_in_ruck(game_object*)
bool is_in_slot(game_object*)
bool move_to_ruck(game_object*)
bool move_to_belt(game_object*)
bool move_to_slot(game_object*)
bool move_to_slot_and_activate(game_object*)
game_object* item_on_belt(int)
game_object* item_in_ruck(int)
uint belt_count()
uint ruck_count()
uint slot_number()
float get_inventory_weight()
invalidate_inventory()

// CObject
float radius()
string get_visual_name()
set_visual_name(string)

// CProjector
projector_on()
projector_off()
bool projector_is_on()
switch_projector(bool)

// CSpaceRestrictor
float get_shape_radius()

// CTorch
switch_torch(bool)
bool is_torch_enabled()
set_torch_range(float)
set_torch_color(vector)
set_torch_omni_range(float)
set_torch_omni_color(vector)
set_torch_glow_radius(float)
set_torch_spot_angle(float)
set_torch_color_animator(string)
switch_night_vision(bool)

// CWeapon
int get_wpn_bone_visible(string, int)
int set_wpn_bone_visible(string, int)</syntaxhighlight>
=====CActor=====
<code>set_actor_visual(string<path>)</code> - устанавливает путь до визуала.<br/>
<code>float<speed> get_sprint_factor()</code> - возвращает скорость бега.<br/>
<code>set_sprint_factor(float<speed>)</code> - устанавливает скорость бега.<br/>
<code>float<dist> get_actor_take_dist()</code> - возвращает дистанцию поднятия предметов.<br/>
<code>set_actor_take_dist(float<dist>)</code> - устанавливает дистанцию поднятия предметов.<br/>
<code>float<max_weight> get_actor_max_weight()</code> - возвращает максимальный вес рюкзака.<br/>
<code>set_actor_max_weight(float<max_weight>)</code> - устанавливает максимальный вес рюкзака.<br/>
<code>float<max_walk_weight> get_actor_max_walk_weight()</code> - возвращает максимально-переносимый вес рюкзака.<br/>
<code>set_actor_max_walk_weight(float<max_walk_weight>)</code> - устанавливает максимально-переносимый вес рюкзака.<br/>
<code>open_inventory_box(game_object*<box_obj>)</code> - открывает окно обыска инвентарного ящика.<br/>
<code>set_camera_direction(vector<yaw, pitch, roll>)</code> - устанавливает повороты камеры.<br/>
<code>update_camera_direction(game_object*<target_obj>)</code> - направляет камеру в позицию объекта.<br/>
<code>enable_car_panel(bool<is_visible>)</code> - устанавливает видимость панели машины (прогресс-бар состояния).<br/>
<code>attach_vehicle(game_object*<holder_obj>)</code> - садит ГГ в машину или станковое оружие.<br/>
<code>detach_vehicle(vector<exit_pos>)</code> - высаживает ГГ из машины в заданную позицию на уровне.<br/>
<code>set_goodwill_ex(int<who_id>, int<to_whom_id>, int<goodwill>)</code> - устанавливает отношения между персонажами.<br/>
<code>change_goodwill_ex(int<who_id>, int<to_whom_id>, int<goodwill_change>)</code> - изменяет отношения между персонажами на заданное значение.<br/>
<code>float<fov> get_camera_fov()</code> - возвращает текущий fov камеры.<br/>
<code>set_camera_fov(float<fov>)</code> - устанавливает fov камеры.<br/>
<code>restore_camera_fov()</code> - восстанавливает предыдущий fov камеры (заданный методом <code>set_camera_fov</code>).<br/>
<code>float<dist> get_hud_fov()</code> - возвращает расстояние от камеры до худа оружия.<br/>
<code>set_hud_fov(float<dist>)</code> - устанавливает расстояние от камеры до худа оружия.<br/>
<code>set_hud_animation_channel(int<blend_channel>)</code> - устанавливает номер канала блендинга анимации, который будет передан в колбек на завершение анимации (только при проигрывании анимации через метод <code>play_hud_animation</code>).<br/>
<code>set_hud_animation_callback_param(int<param>)</code> - устанавливает произвольный параметр, который будет передан в колбек на завершение анимации (только при проигрывании анимации через метод <code>play_hud_animation</code>).<br/>
<code>set_use_hud_animation_callback(bool<use_callback>)</code> - включает использование колбека на завершение анимации (только при проигрывании анимации через метод <code>play_hud_animation</code>).<br/>
<code>clear_personal_record(int<id_from>, int<id_to>)</code> - очищает отношения между двумя мобами по их id.<br/>
<code>uint<state> actor_body_state()</code> - возвращает номер текущего стейта.<br/>
<code>bool is_actor_normal()</code> - возвратит true, если ГГ просто стоит.<br/>
<code>bool is_actor_crouch()</code> - возвратит true, если ГГ присел.<br/>
<code>bool is_actor_creep()</code> - возвратит true, если ГГ глубоко присел.<br/>
<code>bool is_actor_climb()</code> - возвратит true, если ГГ находится на лестнице.<br/>
<code>bool is_actor_walking()</code> - возвратит true, если ГГ идет медленным шагом.<br/>
<code>bool is_actor_running()</code> - возвратит true, если ГГ идет быстрым шагом.<br/>
<code>bool is_actor_sprinting()</code> - возвратит true, если ГГ бежит.<br/>
<code>bool is_actor_crouching()</code> - возвратит true, если ГГ двигается в присяде.<br/>
<code>bool is_actor_creeping()</code> - возвратит true, если ГГ двигается в глубоком присяде.<br/>
<code>bool is_actor_climbing()</code> - возвратит true, если ГГ двигается на лестнице.<br/>
=====CCar=====
<code>float<fuel> get_fuel()</code> - возвращает текущее количество топлива.<br/>
<code>set_fuel(float<fuel>)</code> - устанавливает текущее количество топлива.<br/>
<code>float<consumption> get_fuel_consumption()</code> - возвращает расход топлива.<br/>
<code>set_fuel_consumption(float<consumption>)</code> - устанавливает расход топлива.<br/>
<code>float<tank_size> get_fuel_tank()</code> - возвращает размер топливного бака.<br/>
=====CEntityAlive=====
<code>heal_wounds(float<factor>)</code> - уменьшает силу кровотечения.<br/>
<code>update_condition()</code> - принудительно обновляет внутренние параметры состояния персонажа (жизнь, выносливость, кровотечение и т.д.).<br/>
=====CGameObject=====
<code>string<profile_name> specific_character()</code> - возвращает название профиля персонажа.<br/>
<code>int<is_visible>[0 or 1] get_bone_visible(string<bone_name>)</code> - возвращает видимость кости по имени.<br/>
<code>set_bone_visible(string<bone_name>, int<visible>[0 or 1])</code> - устанавливает видимость кости по имени.<br/>
<code>int<bone_id> get_bone_id(string<bone_name>)</code> - возвращает id кости по имени.<br/>
<code>string<bone_name> get_bone_name()</code> - возвращает имя кости по id (для установки id кости, необходимо использовать глобальную функцию <code>set_int_arg0(int<bone_id>)</code>).<br/>
<code>bool<visual> has_visual()</code> - возвратит true, если объект имеет визуал.<br/>
<code>ini_file* get_visual_ini()</code> - возвращает ссылку на внутренний конфиг модели.<br/>
<code>bool<is_usable> nonscript_usable()</code> - возвратит true, если над объектом разрешены нескриптовые действия.<br/>
=====CHangingLamp=====
<code>set_lsf_speed(float<speed>)</code> - устанавливает скорость затухания тени (чем больше - тем быстрее).<br/>
<code>set_lsf_amount(float<amount>)</code> - устанавливает максимальное ослабление тени (1.0 - пропадает до нуля, 0.0 - не ослабляется вовсе).<br/>
<code>set_lsf_smap_jitter(float<jitter>)</code> - устанавливает коэффициент размытия теней (чем больше число, тем больше размытие с отдалением от источника).<br/>
<code>float<speed> get_lsf_speed()</code> - возвращает скорость затухания тени.<br/>
Для работы данных методов необходимы дополнительные правки движка и шейдеров. Этот функционал широко используются в моде OGSE/OGSR.<br/>

=====CHolderCustom=====
<code>game_object*<owner_obj> get_holder_owner()</code> - возвращает владельца машины или станкового оружия.<br/>
=====CHudItem=====
<code>play_hud_animation(string<anim_name>, bool<mix_in>)</code> - проигрывает анимацию с заданным именем.<br/>
<code>uint<remaining_time> get_hud_animation_remaining_time()</code> - возвращает время, оставшееся до окончания текущей анимации.<br/>
<code>int<length> get_hud_animation_length(string<anim_name>)</code> - возвращает длительность анимации по её имени.<br/>
<code>bool<is_cyclic> is_cyclic_hud_animation()</code> - возвратит true, если текущая анимация зациклена.<br/>
<code>bool<has_anim> has_hud_animation(string<anim_name>)</code> - возвратит true, если анимация есть в модели.<br/>
<code>set_hud_animation_end_time(int<end_time>)</code> - устанавливает время конца текущей анимации.<br/>
<code>stop_hud_sounds()</code> - останавливает все звуки худа.<br/>
<code>uint<state> get_hud_item_state()</code> - возвращает номер текущего стейта.<br/>
<code>int<bone_id> get_hud_bone_id(string<bone_name>)</code> - возвращает id кости по имени.<br/>
<code>vector<pos> get_hud_bone_pos(string<bone_name>)</code> - возвращает позицию кости по имени.<br/>
<code>int<is_visible>[0 or 1] get_hud_bone_visible(string<bone_name>)</code> - возвращает видимость кости по имени.<br/>
<code>set_hud_bone_visible(string<bone_name>, int<visible>[0 or 1])</code> - устанавливает видимость кости по имени.<br/>
=====CInventoryBox=====
<code>game_object*<item_obj> object_from_inv_box(int<object_number>)</code> - возвращает предмет в ящике по номеру.<br/>
<code>uint<items_count> inv_box_count()</code> - возвращает количество предметов в ящике.<br/>
=====CInventoryItem=====
<code>float<weight> get_weight()</code> - возвращает вес предмета.<br/>
=====CInventoryOwner=====
<code>bool<is_on_belt> is_on_belt(game_object*<item_obj>)</code> - возвратит true, если предмет на поясе.<br/>
<code>bool<is_in_ruck> is_in_ruck(game_object*<item_obj>)</code> - возвратит true, если предмет в рюкзаке.<br/>
<code>bool<is_in_slot> is_in_slot(game_object*<item_obj>)</code> - возвратит true, если предмет в слоте.<br/>
<code>move_to_ruck(game_object*<item_obj>)</code> - перемещает предмет в рюкзак.<br/>
<code>move_to_belt(game_object*<item_obj>)</code> - перемещает предмет на пояс.<br/>
<code>move_to_slot(game_object*<item_obj>)</code> - перемещает предмет в слот.<br/>
<code>move_to_slot_and_activate(game_object*<item_obj>)</code> - перемещает предмет в слот и активирует его.<br/>
<code>game_object*<item_obj> item_on_belt(int<object_number>)</code> - возвращает предмет на поясе по номеру.<br/>
<code>game_object*<item_obj> item_in_ruck(int<object_number>)</code> - возвращает предмет в рюкзаке по номеру.<br/>
<code>uint<count> belt_count()</code> - возвращает количество предметов на поясе.<br/>
<code>uint<count> ruck_count()</code> - возвращает количество предметов в рюкзаке.<br/>
<code>uint<number> slot_number()</code> - возвращает количество слотов.<br/>
<code>float<total_weight> get_inventory_weight()</code> - возвращает суммарный вес инвентаря.<br/>
<code>invalidate_inventory()</code> - принудительно обновляет все данные в инвентаре.<br/>
=====CObject=====
<code>float<radius> radius()</code> - возвращает виртуальный радиус объекта.<br/>
<code>string<path> get_visual_name()</code> - возвращает путь до визуала объекта.<br/>
<code>set_visual_name(string<path>)</code> - устанавливает путь до визуала объекта.<br/>
=====CProjector=====
<code>projector_on()</code> - включает прожектор.<br/>
<code>projector_off()</code> - выключает прожектор.<br/>
<code>bool<is_on> projector_is_on()</code> - возвратит true, если прожектор включён.<br/>
<code>switch_projector(bool<switch_on>)</code> - переключает прожектор.<br/>
=====CSpaceRestrictor=====
<code>float<radius> get_shape_radius()</code> - возвращает радиус рестриктора.<br/>
=====CTorch=====
<code>switch_torch(bool<switch_on>)</code> - переключает фонарь.<br/>
<code>bool<is_on> is_torch_enabled()</code> - возвратит true, если фонарь включён.<br/>
<code>set_torch_range(float<range>)</code> - устанавливает дальность основного света фонаря.<br/>
<code>set_torch_color(vector<R, G, B>)</code> - устанавливает цвет основного света от фонаря.<br/>
<code>set_torch_omni_range(float<range>)</code> - устанавливает дальность амбиент-света фонаря.<br/>
<code>set_torch_omni_color(vector<R, G, B>)</code> - устанавливает цвет амбиент-света от фонаря.<br/>
<code>set_torch_glow_radius(float<radius>)</code> - устанавливает радиус глоу-эффекта от фонарика.<br/>
<code>set_torch_spot_angle(float<angle>)</code> - устанавливает радиус светового пятна от фонарика.<br/>
<code>set_torch_color_animator(string<path>)</code> - устанавливает путь до аниматора цвета.<br/>
<code>switch_night_vision(bool<switch_on>)</code> - переключает состояние ПНВ.<br/>
=====CWeapon=====
<code>int<is_visible>[0 or 1] get_wpn_bone_visible(string<bone_name>)</code> - возвращает видимость кости оружия по имени.<br/>
<code>set_wpn_bone_visible(string<bone_name>, int<visible>[0 or 1])</code> - устанавливает видимость кости оружия по имени.<br/>
====Хак для изменения значений в памяти объектов====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">// CActor
float get_actor_float(int)
set_actor_float(vector, float, int)
int get_actor_int(string, int)
set_actor_int(int, int)
int get_actor_int16(string, int)
string get_actor_shared_str()
int set_actor_shared_str(string, int)
float get_actor_condition_float(int)
set_actor_condition_float(vector, float, int)
int get_actor_condition_int(string, int)

// CCar
float get_car_float(int)
set_car_float(vector, float, int)
int get_car_int(string, int)
set_car_int(int, int)
int get_car_int16(string, int)
set_car_int16(int, int)

// CCustomMonster
float get_custom_monster_float(int)
int get_custom_monster_int(string, int)

// CGameObject
float get_go_float(int)
set_go_float(vector, float, int)
int get_go_int(string, int)
set_go_int(int, int)
int get_go_int16(string, int)
set_go_int16(int, int)
string get_go_shared_str()
int set_go_shared_str(string, int)

// CHolderCustom
int get_holder_int(string, int)

// CHudItem
float get_hud_float(int)
set_hud_float(vector, float, int)
string get_hud_shared_str()
int set_hud_shared_str(string, int)
int save_hud_bone_float(string, int)

// CInventoryItem
float get_inventory_item_float(int)
set_inventory_item_float(vector, float, int)
int get_inventory_item_int(string, int)
set_inventory_item_int(int, int)
int get_inventory_item_int8(string, int)
set_inventory_item_int8(int, int)
int get_inventory_item_int16(string, int)
set_inventory_item_int16(int, int)
string get_inventory_item_shared_str()
int set_inventory_item_shared_str(string, int)

// CWeapon
float get_wpn_float(int)
set_wpn_float(vector, float, int)
int get_wpn_int(string, int)
set_wpn_int(int, int)
int get_wpn_int8(string, int)
set_wpn_int8(int, int)
int get_wpn_int16(string, int)
set_wpn_int16(int, int)
string get_wpn_shared_str()
int set_wpn_shared_str(string, int)

// CWeaponMagazinedWGrenade
int get_wpn_gl_int(string, int)

// Memory access functions
float get_memory_float(int)
set_memory_float(vector, float, int)
int get_memory_int(string, int)
set_memory_int(int, int)
int get_memory_int8(string, int)
set_memory_int8(int, int)
int get_memory_int16(string, int)
set_memory_int16(int, int)</syntaxhighlight>
Методы предназначены для изменения тех значений в памяти игровых объектов, которые недоступны через стандартные средства.<br/>
Применение всех функций практически одинаково, поэтому далее будет рассматриваться только пример на классе ''CGameObject''.<br/>

''Смещение'' - это позиция нужной переменной в памяти относительно начала класса. Узнать смещение можно несколькими способами:<br/>
# посмотреть в папке [https://github.com/KD87/xray-extensions/tree/master/help help] официального репозитория;<br/>
# при помощи движка с отладочной информацией через дизассемблер (например, в ''IDA Pro'' выбрав нужную структуру во вкладке ''Local Types'');<br/>
# сканируя все смещения и выводя их значения в лог (однако, чтобы выяснить какое значение соответствует какому свойству класса, необходимо проводить дополнительные проверки).

'''Функция для сканирования значений класса CActor'''<br/>
''mode'' - режим поиска (<code>"int"</code> - целочисленный тип, <code>"float"</code> - число с плавающей запятой)<br/>
''range'' - диапазон сканирования (например, 2000)<br/>
<syntaxhighlight lang="lua">function scan_actor_values(mode, range)
	get_console():execute("clear_log")
	log1("~ scan "..mode.." values")
	for i = 1, range do
		if mode == "int" then
			log1(i.." = "..db.actor:get_actor_int(nil, i))
		elseif mode == "float" then
			log1(i.." = "..db.actor:get_actor_float(i))
		end
	end
	flush_log()
end</syntaxhighlight>
Результат работы функции записывается в лог игры.

<code>float<value> get_go_float(int<offset>)</code> - возвращает значение с плавающей точкой по заданному смещению.<br/>
<code>set_go_float(nil, float<value>, int<offset>)</code> - устанавливает значение с плавающей точкой по заданному смещению (первый аргумент - заглушка).<br/>
<code>int<value> get_go_int(nil, int<offset>)</code> - возвращает целочисленное значение по заданному смещению (первый аргумент - заглушка).<br/>
<code>set_go_int(int<offset>, int<value>)</code> - устанавливает целочисленное значение по заданному смещению.<br/>
<code>string<value> get_go_shared_str()</code> - возвращает строковое значение по заданному смещению (смещение задается через глобальную функцию <code>set_int_arg0(int<offset>)</code>).<br/>
<code>set_go_shared_str(string<value>, int<offset>)</code> - устанавливает строковое значение по заданному смещению.<br/>

{| style="background-color: #fffdee;" width="100%"
|<span style="color:#172172;">'''Важно!'''</span>
----
При поиске значений для ГГ необходимо учитывать тот факт, что часть из них находится в отдельном классе - ''CActorCondition''. Сила прыжка, сытость, алкоголизм и другие свойства расположены именно тут.
|}

====Методы для получения адреса базового объекта====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">uint cast_car()
uint cast_game_object()
uint cast_hud_item()
uint cast_inventory_box()
uint cast_inventory_item()
uint cast_weapon()</syntaxhighlight>
Методы позволяют получить адрес в памяти, откуда начинается базовый объект (адрес в большинстве случаев не совпадает с началом объекта в целом). Результат можно использовать в разных хаках, когда известно смещение относительно конкретного класса.
====Методы для проверки типа объекта====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">bool is_actor()
bool is_ammo()
bool is_anomaly()
bool is_antirad()
bool is_artefact()
bool is_binoculars()
bool is_bottle_item()
bool is_car()
bool is_custom_monster()
bool is_eatable_item()
bool is_entity_alive()
bool is_explosive()
bool is_food_item()
bool is_game_object()
bool is_grenade()
bool is_grenade_launcher()
bool is_hanging_lamp()
bool is_helicopter()
bool is_holder()
bool is_hud_item()
bool is_inventory_box()
bool is_inventory_item()
bool is_inventory_owner()
bool is_knife()
bool is_medkit()
bool is_missile()
bool is_monster()
bool is_outfit()
bool is_physics_shell_holder()
bool is_projector()
bool is_scope()
bool is_script_zone()
bool is_silencer()
bool is_space_restrictor()
bool is_stalker()
bool is_torch()
bool is_trader()
bool is_weapon()
bool is_weapon_gl()
bool is_weapon_magazined()
bool is_weapon_pistol()
bool is_weapon_shotgun()</syntaxhighlight>
Методы предназначены для проверки типа объекта (к какому классу принадлежит). Применение достаточно простое:
<syntaxhighlight lang="lua">if obj:is_<class_name>() then
...
end</syntaxhighlight>
====Методы не имеющие привязки к определенному объекту====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">game_object* get_object_arg_1(int)
set_object_arg_1(game_object*)
set_calibrating_vector(vector)
set_vector_global_arg_1(vector)
set_vector_global_arg_2(vector)
set_vector_global_arg_3(vector)
set_vector_global_arg_4(vector)</syntaxhighlight>
Эти методы предназначены для передачи или получения значений в(из) другие(их) методы(ов), в которых, по причине отсутствия необходимого прототипа, штатно это сделать нельзя.
Могут вызываться для любого типа объекта в игре.
===Класс matrix===
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">mul_43(matrix, matrix)
transform_tiny(vector, vector, vector, vector)
transform_tiny1(vector, vector, vector, vector)
transpose(float)</syntaxhighlight>
<code>mul_43(matrix<m1>, matrix<m2>)</code> - умножает две матрицы без последнего столбца и записывает результат в матрицу для которой вызывался метод.<br/>
<code>transform_tiny(vector<res>, vector<v>)</code> - умножает матрицу на вектор (перевод из одной системы координат в другую), с записыванием результата в вектор res.<br/>
<code>transform_tiny1(vector<v>)</code> - умножает матрицу на вектор (перевод из одной системы координат в другую), с записыванием результата в сам вектор.<br/>
<code>transpose()</code> - транспонирует матрицу (зеркалирование относительно главной диагонали).<br/>
===Класс CTime===
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">set_value(int, int, int)
int, int, int, int, int, int, int get_value()</syntaxhighlight>
<code>set_value(int<lv>, int<gv>)</code> - устанавливает значение объекта из компонент.<br/>
<code>int<lv>, int<gv> get_value()</code> - возвращает младшую и старшую часть счетчика.<br/>
===Класс CALifeSimulator===
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">CSE_Abstract* teleport_object(string, vector, uint, uint, uint)
CSE_Abstract* assign_story_id(string, vector, uint, uint, uint)</syntaxhighlight>
<code>teleport_object(nil, vector<position>, uint<level_vertex_id>, uint<game_vertex_id>, uint<id>)</code> - телепортирует объект по его id в заданную позицию на уровне.<br/>
<code>assign_story_id(nil, nil, uint<id>, uint<story_id>)</code> - устанавливает story_id объекту по его id.<br/>
===Класс CSE_Abstract===
'''Свойства'''<br/>
<code>angle<vector></code> - задает направление поворота объекта.
===Класс CSE_ALifeObject===
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">use_ai_locations(bool)</syntaxhighlight>
<code>use_ai_locations(bool<use>)</code> - задает использование AI-локаций (сетки) для объекта.
===Пространство имен level===
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">game_object* get_target_obj(int)
float get_target_dist()
int get_target_element(int)

int has_cam_effector(int)
int has_pp_effector(int)
bool has_indicators()

int advance_game_time(int)
game_object* get_second_talker(int)
int vertex_id(int)

float get_memory_float(string, int, bool, string)
int get_memory_int(int)

bool perform_ray_pick_query()
float get_ray_pick_dist()
game_object* get_ray_pick_obj(int)
int get_ray_pick_element(int)

CUIDialogWnd* get_inventory_wnd()
CUIDialogWnd* get_pda_wnd()
CUIDialogWnd* get_talk_wnd()
CUIDialogWnd* get_car_body_wnd()
CUIDialogWnd* get_trade_wnd()

int send_event_mouse_wheel(int)
int send_event_key_hold(int)
int send_event_key_release(int)
int send_event_key_press(int)

set_ce_time(float)
set_ce_amplitude(float)
set_ce_period_number(float)
set_ce_power(float)
bool add_ce()

vector get_tri_vertex1(int)
vector get_tri_vertex2(int)
vector get_tri_vertex3(int)

float get_tri_shootfactor(string, int, bool, string)
int get_tri_flags(int)</syntaxhighlight>
<code>game_object*<obj> get_target_obj()</code> - возвращает игровой объект (если он имеет шейпы), на который в данный момент направлена камера.<br/>
<code>float<dist> get_target_dist()</code> - возвращает дистанцию до точки, на которую в данный момент направлена камера.<br/>
<code>int<element> get_target_element()</code> - если камера направлена на игровой объект (который имеет шейпы), то возвращает номер кости, иначе возвращает номер полигона статической геометрии.<br/>

<code>int<is_cam_eff>[0 or +] has_cam_effector(int<effect_id>)</code> - вернет true, если заданный эффектор камеры в данный момент активен (0 - эффектор не активен, иначе - активен).<br/>
<code>int<is_pp_eff>[0 or +] has_pp_effector(int<effect_id>)</code> - вернет true, если заданный эффектор постпроцесса в данный момент активен (0 - эффектор не активен, иначе - активен).<br/>
<code>bool has_indicators()</code> - вернет true, если интерфейс худа сейчас показан.<br/>

<code>advance_game_time(int<time_ms>)</code> - прокручивает игровое время вперед на заданное количество миллисекунд.<br/>
<code>game_object*<obj> get_second_talker()</code> - возвращает игровой объект, с которым в данный момент открыто окно разговора.<br/>
<code>int<lvid> vertex_id()</code> - возвращает level_vertex_id по позиции на уровне (для установки позиции, необходимо использовать функцию игрового объекта <code>obj:set_vector_global_arg_1(vector<pos>)</code>).<br/>

<code>float<value> get_memory_float(nil, int<addr>)</code> - возвращает число с плавающей точкой по абсолютному адресу.<br/>
<code>int<value> get_memory_int(int<addr>)</code> - возвращает целое число по абсолютному адресу.<br/>

<code>bool<check> perform_ray_pick_query()</code> - выполнит запрос на трассировку и вернет true, если она была успешна.<br/>
<code>float<dist> get_ray_pick_dist()</code> - если трассировка была успешна, вернет дистанцию до точки, иначе вернет ранее заданный диапазон трассировки.<br/>
<code>game_object*<obj> get_ray_pick_obj()</code> - если трассировка была успешна, вернет игровой объект.<br/>
<code>int<element> get_ray_pick_element()</code> - если луч пересек игровой объект, то вернет номер кости, иначе вернет номер полигона статической геометрии (при неудачной трассировке вернет -1).<br/>

<code>CUIDialogWnd*<inv_wnd> get_inventory_wnd()</code> - возвращает объект окна инвентаря.<br/>
<code>CUIDialogWnd*<pda_wnd> get_pda_wnd()</code> - возвращает объект окна КПК.<br/>
<code>CUIDialogWnd*<talk_wnd> get_talk_wnd()</code> - возвращает объект окна разговора.<br/>
<code>CUIDialogWnd*<carbody_wnd> get_car_body_wnd()</code> - возвращает объект окна обыска.<br/>
<code>CUIDialogWnd*<trade_wnd> get_trade_wnd()</code> - возвращает объект окна торговли.<br/>

<code>send_event_mouse_wheel(int<vol>)</code> - имитация события вращения колеса мыши.<br/>
<code>send_event_key_hold(int<DIK_keys>)</code> - имитация события удержания кнопки.<br/>
<code>send_event_key_release(int<DIK_keys>)</code> - имитация события отпускания кнопки.<br/>
<code>send_event_key_press(int<DIK_keys>)</code> - имитация события нажатия кнопки.<br/>

<code>set_ce_time(float<total_time>)</code> - устанавливает продолжительность эффектора шатания камеры.<br/>
<code>set_ce_amplitude(float<amp>)</code> - устанавливает максимальную амплитуду эффектора шатания камеры.<br/>
<code>set_ce_period_number(float<periods>)</code> - устанавливает количество циклов эффектора шатания камеры.<br/>
<code>set_ce_power(float<power>)</code> - устанавливает интенсивность эффектора шатания камеры.<br/>
<code>add_ce()</code> - запускает эффектор шатания камеры с ранее установленными параметрами.<br/>

<code>vector<pos> get_tri_vertex1(int<element>)</code> - возвращает первую вершину статического треугольника.<br/>
<code>vector<pos> get_tri_vertex2(int<element>)</code> - возвращает вторую вершину статического треугольника.<br/>
<code>vector<pos> get_tri_vertex3(int<element>)</code> - возвращает третью вершину статического треугольника.<br/>

<code>float<factor> get_tri_shootfactor(nil, int<element>)</code> - возвращает фактор пробиваемости материала геометрии (0.0 - непробиваемый, 1.0 - полностью пробиваемый).<br/>
<code>int<flags> get_tri_flags(int<element>)</code> - возвращает флаги материала геометрии ([[#mtlFlags]]).<br/>

===Глобальное пространство имен===
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">log1(string)
fail(string)
int flush_log(int, int)
int bind_to_dik(int, int)

int get_extensions_flags(int, int)
int set_extensions_flags(int, int)
int get_actor_flags(int, int)
int set_actor_flags(int, int)
int get_input_language(int, int)
int set_input_language(int, int)

int set_trade_filtration_on(int, int)
int set_trade_filtration_off(int, int)
int set_manual_grouping_on(int, int)
int set_manual_grouping_off(int, int)
int set_manual_highlight_on(int, int)
int set_manual_highlight_off(int, int)
int get_manual_highlight(int, int)
int set_highlight_color(int, int)

int sum_args(int, int)
int sub_args(int, int)

int GetGoodwill(int, int)
int update_inventory_window(int, int)
init_external_libs(string)

set_game_time(float, float)
int print_level_time(int, int)
int print_alife_time(int, int)
int set_ignore_game_state_update(int, int)

screenshot0(string)
screenshot1(string)
screenshot2(string)
screenshot3(string)

set_hud_inertia(float, float)
set_hud_inertia_param2(float, float)

float get_static_rescale_factor()
set_static_rescale_factor(float, float)

int set_int_arg0(int, int)
int set_int_arg1(int, int)
int set_int_arg2(int, int)
int set_int_arg3(int, int)
int set_int_arg4(int, int)
int set_int_arg5(int, int)
int set_int_arg6(int, int)
set_float_args_12(float, float)
set_float_args_34(float, float)</syntaxhighlight>
<code>log1(string<message>)</code> - выводит строку-сообщение в лог.<br/>
<code>fail(string<message>)</code> - принудительно останавливает игру и выводит сообщение в лог.<br/>
<code>flush_log()</code> - записывает содержимое лога в лог-файл (аналогично вызову консольной команды flush).<br/>
<code>int<DIK_keys> bind_to_dik(int<key_bindings>)</code> - переводит код команды-экшена в код клавиши, забинденной на этот экшен.<br/>

<code>int<ex_flags> get_extensions_flags()</code> - возвращает состояние флагов работы колбеков (1 - key_press, 2 - key_release, 4 - key_hold, 8 - mouse_wheel, 16 - mouse_move).<br/>
<code>set_extensions_flags(int<ex_flags>)</code> - устанавливает состояние флагов работы колбеков (1 - key_press, 2 - key_release, 4 - key_hold, 8 - mouse_wheel, 16 - mouse_move).<br/>
<code>int<flags> get_actor_flags()</code> - возвращает состояние флагов из перечисления psActorFlags.<br/>
<code>set_actor_flags(int<flags>)</code> - устанавливает состояние флагов из перечисления psActorFlags.<br/>
<code>int<lang>[0 or 1] get_input_language()</code> - возвращает номер языка для ввода в полях редактирования (0 - eng, 1 - rus).<br/>
<code>set_input_language(int<lang>[0 or 1])</code> - устанавливает номер языка для ввода в полях редактирования (0 - eng, 1 - rus).<br/>

<code>set_trade_filtration_on()</code> - включает режим скриптовой фильтрации предметов в окне торговли.<br/>
<code>set_trade_filtration_off()</code> - выключает режим скриптовой фильтрации предметов в окне торговли.<br/>
<code>set_manual_grouping_on()</code> - включает режим скриптовой группировки предметов в окне торговли и обыска.<br/>
<code>set_manual_grouping_off()</code> - выключает режим скриптовой группировки предметов в окне торговли и обыска.<br/>
<code>set_manual_highlight_on()</code> - включает режим скриптовой подсветки предметов в окне торговли и обыска.<br/>
<code>set_manual_highlight_off()</code> - выключает режим скриптовой подсветки предметов в окне торговли и обыска.<br/>
<code>int<is_highlight>[0 or 1] get_manual_highlight()</code> - возвращает включенность режима скриптовой подсветки предметов.<br/>
<code>set_highlight_color(int<color_id>, int<GetARGB(A, R, G, B)>)</code> - устанавливает соответствие между индексом цвета и кодом цвета.<br/>

<code>int<result> sum_args(int<val1>, int<val2>)</code> - производит сложение двух чисел и возвращает целочисленный результат (при ариф. операциях, Lua возвращает число с плавающей точкой).<br/>
<code>int<result> sub_args(int<val1>, int<val2>)</code> - производит вычитание двух чисел и возвращает целочисленный результат (при ариф. операциях, Lua возвращает число с плавающей точкой).<br/>

<code>int<goodwill> GetGoodwill(int<who_id>, int<to_whom_id>)</code> - возвращает текущее отношение между персонажами.<br/>
<code>update_inventory_window()</code> - обновляет все графические элементы окна инвентаря.<br/>
<code>init_external_libs()</code> - вызывает подключение дополнительных библиотек, прописанных в движке, внутри этой функции (используется в моде OGSE/OGSR).<br/>

<code>print_level_time()</code> - выводит отладочную информацию в лог о времени уровня.<br/>
<code>print_alife_time()</code> - выводит отладочную информацию в лог о времени алайфа.<br/>
<code>set_ignore_game_state_update()</code> - устанавливает запрет на выполнение одного цикла обновления внутренних параметров времени (используется в моде OGSE/OGSR).<br/>

<code>screenshot0(string<path>)</code> - создает скриншот в обычном режиме и сохраняет файл по указанному пути.<br/>
<code>screenshot1(string<path>)</code> - создает скриншот в режиме cubemap и сохраняет файл по указанному пути.<br/>
<code>screenshot2(string<path>)</code> - создает скриншот в режиме save и сохраняет файл по указанному пути.<br/>
<code>screenshot3(string<path>)</code> - создает скриншот в режиме levelmap и сохраняет файл по указанному пути.<br/>

<code>set_hud_inertia(float<speed>)</code> - устанавливает скорость инерции худа.<br/>
<code>set_hud_inertia_param2(float<shift>)</code> - устанавливает силу инерции худа.<br/>

<code>float<rescale> get_static_rescale_factor()</code> - возвращает коэффициент сжатия элементов окна на выбранном разрешении.<br/>
<code>set_static_rescale_factor(float<rescale>)</code> - устанавливает коэффициент сжатия элементов окна на выбранном разрешении.<br/>

Остальные методы предназначены для передачи или получения значений в(из) другие(их) методы(ов), в которых, по причине отсутствия необходимого прототипа, штатно это сделать нельзя.
===Оконные классы===
====Класс CUIWindow====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">DetachFromParent()
BringToTop()
Update()
float GetVPos()
float GetHPos()
float GetCursorX()
float GetCursorY()
float GetAbsolutePosX()
float GetAbsolutePosY()</syntaxhighlight>
<code>DetachFromParent()</code> - отсоединяет окно от родительского с последующем удалением.<br/>
<code>BringToTop()</code> - перемещает окно на вершину в иерархии дочерних окон.<br/>
<code>Update()</code> - дополнительно вызывает виртуальный метод обновления окна.<br/>
<code>float<x> GetVPos()</code> - возвращает положение окна по оси X.<br/>
<code>float<y> GetHPos()</code> - возвращает положение окна по оси Y.<br/>
<code>float<x> GetCursorX()</code> - возвращает положение мыши в окне по оси X.<br/>
<code>float<y> GetCursorY()</code> - возвращает положение мыши в окне по оси Y.<br/>
<code>float<x> GetAbsolutePosX()</code> - возвращает абсолютное положение окна по оси X.<br/>
<code>float<y> GetAbsolutePosY()</code> - возвращает абсолютное положение окна по оси Y.<br/>
====Класс CUIStatic====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">SetTextComplexMode(bool)
AdjustWidthToText()
AdjustHeightToText()
SetVTextAlign(uint)
SetTextPos(float, float)
CanRotate(bool)</syntaxhighlight>
<code>SetTextComplexMode(bool<mode>)</code> - включает режим комплексной работы с текстом.<br/>
<code>AdjustWidthToText()</code> - растягивает ширину окна под размер текста.<br/>
<code>AdjustHeightToText()</code> - растягивает высоту окна под размер текста.<br/>
<code>SetVTextAlign(uint<align>)</code> - задает выравнивание текста по вертикали ([[#EVTextAlignment]]).<br/>
<code>SetTextPos(float<x>, float<y>)</code> - задает положение текста внутри окна.<br/>
<code>CanRotate(bool)</code> - устанавливает возможность вращения текстуры окна.<br/>
====Класс CUIListWnd====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">SetSelectedItem(int)</syntaxhighlight>
<code>SetSelectedItem(int<idx>)</code> - устанавливает выбранный элемент списка по его индексу.
====Класс CUIComboBox====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">AddItem(string)
string GetText()</syntaxhighlight>
<code>AddItem(string<text>)</code> - добавляет новый элемент с заданным текстом.<br/>
<code>string<text> GetText()</code> - возвращает текущую надпись в окне выпадающего списка.<br/>
====Класс CUITrackBar====
'''Регистрация функций в движке'''
<syntaxhighlight lang="lua">float GetFValue()
bool IsChanged()</syntaxhighlight>
<code>float<value> GetFValue()</code> - возвращает текущее значение ползунка.<br/>
<code>bool<changed> IsChanged()</code> - возвратит true, если значение было изменено с момента последнего сохранения окна опций.<br/>
===Скриптовые колбеки===
Рекомендуется использовать таблицу с идентификаторами колбеков [[#callback]], чтобы не запутаться в их номерах.
{| class="wikitable"
|-
! Название !! Номер !! Вызывается для !! Аргументы !! Описание
|-
| on_key_press || 123 || CActor || int<dik>[DIK_keys] || нажатие клавиши ([[#Активация колбеков ввода]])
|-
| on_key_release || 124 || CActor || int<dik>[DIK_keys] || отпускание клавиши ([[#Активация колбеков ввода]])
|-
| on_key_hold || 125 || CActor || int<dik>[DIK_keys] || удерживание клавиши ([[#Активация колбеков ввода]])
|-
| on_mouse_wheel || 126 || CActor || int<vol> || движение мыши ([[#Активация колбеков ввода]])
|-
| on_mouse_move || 127 || CActor || int<x>, int<y> || вращение колеса мыши ([[#Активация колбеков ввода]])
|-
| anomaly_hit || 128 || CCustomZone || game_object*<obj> || хит объекта аномалией
|-
| drop_item_from_inventory || 129 || CActor || game_object*<obj> || выкидывание предмета через интерфейс инвентаря (контекстное меню и клавиша G)
|-
| on_item_belt || 130 || CActor || game_object*<obj> || перемещение предмета на пояс
|-
| on_item_ruck || 131 || CActor || game_object*<obj> || перемещение предмета в рюкзак
|-
| on_item_slot || 132 || CActor || game_object*<obj> || перемещение предмета в слот
|-
| select_inventory_item || 133 || CActor || game_object*<obj> || выделение предмета в инвентаре
|-
| switch_torch || 134 || CTorch || int<light_on>[0 or 1] || переключение активности фонарика
|-
| set_dest_lvid || 135 || CAI_Stalker || int<level_vertex_id> || вызов после вызова метода <code>set_dest_level_vertex_id</code>
|-
| create_cell_item || 136 || CActor || game_object*<obj> || создание объекта ''CUICellItem'' в инвентаре (получить статик в этот момент можно при помощи вызова <code>CUIFrameWindow():GetTitleStatic()</code>)
|-
| attach_vehicle || 137 || CActor || game_object*<car> || посадка в машину
|-
| use_vehicle || 138 || CActor || game_object*<car> || использование машины (проверку на дистанцию необходимо организовать вручную)
|-
| detach_vehicle || 139 || CActor || game_object*<car> || выход из машины
|-
| after_save || 140 || CActor |||| вызов после сохранения игры
|-
| cell_item_focus_start || 141 || CActor || game_object*<obj> || получение фокуса объектом ''CUICellItem'' в инвентаре (получить статик в этот момент можно при помощи вызова <code>CUIFrameWindow():GetTitleStatic()</code>)
|-
| cell_item_focus_end || 142 || CActor || game_object*<obj> || потеря фокуса объектом ''CUICellItem'' в инвентаре (получить статик в этот момент можно при помощи вызова <code>CUIFrameWindow():GetTitleStatic()</code>)
|-
| group_cell_item || 143 || CActor || game_object*<obj1> || сравнение объектов для группировки в инвентаре (получить второй объект можно при помощи вызова <code>db.actor:get_object_arg_1()</code>, запретить группировку для текущего сравнения при помощи вызова <code>db.actor:set_object_arg_1(nil)</code>)
|-
| hit_effector || 144 || CActor || int<mob_type>[0 or 1], int<side> || появление хит-эффектора на экране (mob_type: 0 - stalker, 1 - monster)
|-
| set_goodwill || 145 || CActor || int<id_from>, int<id_to> || изменение отношений
|-
| before_update || 150 || CActor |||| вызов перед первым апдейтом
|-
| drop_item_in_box || 151 || CInventoryBox || game_object*<obj> || перемещение предмета в инвентарный ящик
|-
| before_hit || 152 || CEntityAlive || int<hit_data>, int<ignore_flags> || вызов перед получением хита (позволяет модифицировать параметры хита перед тем, как он произошел, однако требует дополнительных функций для работы с памятью)
|-
| npc_hit || 153 || CEntityAlive || game_object*<who> || вызов перед получением хита (позволяет установить игнорирование хита при помощи вызова <code>set_int_arg0(1)</code>, по смыслу частично повторяет функционал колбека ''before_hit'', однако не требует дополнительных функций)
|-
| update_addons_visibility || 154 || CWeapon |||| обновление видимости костей аддонов оружия (для активации колбека необходимо использовать скриптовую обвязку <code>activate_visibility_updates</code> [[#Функции]])
|-
| update_hud_addons_visibility || 155 || CWeapon |||| обновление видимости костей аддонов худа оружия (для активации колбека необходимо использовать скриптовую обвязку <code>activate_visibility_updates</code> [[#Функции]])
|-
| before_use_item || 156 || CActor || game_object*<obj> || вызов перед использованием предмета
|-
| hud_animation_end || 157 || CActor || int<param>, int<blend_channel> || завершение проигрывания анимации худа через метод <code>play_hud_animation</code> (для активации колбека, а также для передачи параметров используются методы <code>set_use_hud_animation_callback</code>, <code>set_hud_animation_callback_param</code>, <code>set_hud_animation_channel</code>)
|-
| init_addons || 158 || CWeapon || int<wpn_type>[1 or 2] || смена аддонов оружия (1 - CWeaponMagazined, 2 - CWeaponMagazinedWGrenade)
|-
| select_pda_contact || 180 || CActor || int<id> || выбор контакта во вкладке КПК "Контакты"
|}
====Активация колбеков ввода====
Для активации колбеков клавиатуры и мыши необходимо вызвать глобальную функцию <code>set_extensions_flags</code> и передать в нее флаги колбеков (1 - key_press, 2 - key_release, 4 - key_hold, 8 - mouse_wheel, 16 - mouse_move). Это нужно сделать на событии '''net_spawn''', а в '''net_destroy''' обнулить ранее установленные флаги.
<syntaxhighlight lang="lua">function actor_binder:net_spawn(data)
	...
	set_extensions_flags(31) -- активирует все пять колбеков
	return true
end

function actor_binder:net_destroy()
	...
	set_extensions_flags(0)
	object_binder.net_destroy(self)
end</syntaxhighlight>
===Дополнительная информация===
====Подсветка текста в консоли====
В связи с добавлением функции вывода произвольного текста в лог, стала доступна возможность выделять этот текст различными цветами.
{| class="wikitable"
|-
! Цвет !! Спец-символ цвета !! Код цвета в формате RGBA
|-
| Зеленый || "-" || (0, 255, 0, 255)
|-
| Красный || "!" || (255, 0, 0, 255)
|-
| Желтый || "~" || (255, 255, 0, 255)
|-
| Серый || "*" || (128, 128, 128, 255)
|-
| Бирюзовый || "#" || (0, 222, 205, 145)
|}
'''Пример использования'''
<syntaxhighlight lang="lua">log1("# Hello world!") -- текст будет отображаться бирюзовым цветом</syntaxhighlight>
После спец-символа цвета обязательно должен быть хотя бы один пробел, иначе строка будет выведена обрезанной.
====Общие рекомендации====
При использовании правок движка из этого проекта, рекомендуется расширить некоторые таблицы новыми значениями, например таблицы с идентификаторами колбеков, идентификаторами клавиш и т.п. Кроме того, ниже приведены некоторые функции, которые представляют из себя скриптовую обвязку для разрозненных движковых методов.<br/>
Код следует поместить в главный модуль '''_g.script'''.
=====Перечисления=====
{{Якорь|callback}} '''callback'''
<syntaxhighlight lang="lua">callback["on_key_press"] = 123
callback["on_key_release"] = 124
callback["on_key_hold"] = 125
callback["on_mouse_wheel"] = 126
callback["on_mouse_move"] = 127
callback["anomaly_hit"] = 128
callback["drop_item_from_inventory"] = 129
callback["on_item_belt"] = 130
callback["on_item_ruck"] = 131
callback["on_item_slot"] = 132
callback["select_inventory_item"] = 133
callback["switch_torch"] = 134
callback["set_dest_lvid"] = 135
callback["create_cell_item"] = 136
callback["attach_vehicle"] = 137
callback["use_vehicle"] = 138
callback["detach_vehicle"] = 139
callback["after_save"] = 140
callback["cell_item_focus_start"] = 141
callback["cell_item_focus_end"] = 142
callback["group_cell_item"] = 143
callback["hit_effector"] = 144
callback["set_goodwill"] = 145
callback["before_update"] = 150
callback["drop_item_in_box"] = 151
callback["before_hit"] = 152
callback["npc_hit"] = 153
callback["update_addons_visibility"] = 154
callback["update_hud_addons_visibility"] = 155
callback["before_use_item"] = 156
callback["hud_animation_end"] = 157
callback["init_addons"] = 158
callback["select_pda_contact"] = 180</syntaxhighlight>
'''DIK_keys'''
<syntaxhighlight lang="lua">DIK_keys["MOUSE_4"] = 340
DIK_keys["MOUSE_5"] = 341
DIK_keys["MOUSE_6"] = 342
DIK_keys["MOUSE_7"] = 343
DIK_keys["MOUSE_8"] = 344</syntaxhighlight>
'''key_bindings'''
<syntaxhighlight lang="lua">key_bindings["kSPRINT_TOGGLE"] = 8
key_bindings["kENGINE"] = 15
key_bindings["kARTEFACT"] = 30
key_bindings["kWPN_FIREMODE_PREV"] = 38
key_bindings["kWPN_FIREMODE_NEXT"] = 39
key_bindings["kPAUSE"] = 40
key_bindings["kCHAT_TEAM"] = 45
key_bindings["kACTIVE_JOBS"] = 53
key_bindings["kMAP"] = 54
key_bindings["kCONTACTS"] = 55
key_bindings["kVOTE_BEGIN"] = 57
key_bindings["kVOTE"] = 58
key_bindings["kVOTEYES"] = 59
key_bindings["kVOTENO"] = 60
key_bindings["kSPEECH_MENU_0"] = 63
key_bindings["kSPEECH_MENU_1"] = 64
key_bindings["kUSE_BANDAGE"] = 73
key_bindings["kUSE_MEDKIT"] = 74
key_bindings["kQUICK_SAVE"] = 75
key_bindings["kQUICK_LOAD"] = 76</syntaxhighlight>
{{Якорь|EVTextAlignment}} '''EVTextAlignment'''
<syntaxhighlight lang="lua">-- вертикальное центрирование текста
EVTextAlignment = {
	valTop			= 0,
	valCenter		= 1,
	valBottom		= 2
}</syntaxhighlight>
{{Якорь|mtlFlags}} '''mtlFlags'''
<syntaxhighlight lang="lua">-- флаги материала геометрии
mtlFlags = {
	flBreakable				= 1,			-- 0    разрушаемый
	flBounceable			= 4,			-- 2    возможность рикошета (0 - есть, 1 - нет)
	flSkidmark				= 8,			-- 3    оставляет тормозной след
	flBloodmark				= 16,			-- 4    оставляет кровь
	flClimable				= 32,			-- 5    невидимая лестница
	flPassable				= 128,			-- 7    проходимый для физических объектов
	flDynamic				= 256,			-- 8    динамический объект
	flLiquid				= 512,			-- 9    жидкость (вода)
	flSuppressShadows		= 1024,			-- 10   заглушает тени
	flSuppressWallmarks		= 2048,			-- 11   заглушает отметины от пуль
	flActorObstacle			= 4096,			-- 12   препятствие (силовое поле) для ГГ
	flInjurious				= 268435456,	-- 28   отбирает здоровье
	flShootable				= 536870912,	-- 29   непростреливаемый
	flTransparent			= 1073741824,	-- 30   непрозрачный
	flSlowDown				= 2147483648	-- 31   замедляет движение
}</syntaxhighlight>
{{Якорь|rq_target}} '''rq_target'''
<syntaxhighlight lang="lua">-- флаги трассировки
rq_target = {
	rqtNone,
	rqtObject		= 1,
	rqtStatic		= 2,
	rqtShape		= 4,
	rqtObstacle		= 8,
	rqtBoth			= 3, -- rqtObject + rqtStatic
	rqtDyn			= 13, -- rqtObject + rqtShape + rqtObstacle
}</syntaxhighlight>
=====Функции=====
'''Глобальное пространство имен'''
<syntaxhighlight lang="lua">-- возвращает имя кости по ее индексу
function _G.get_bone_name_by_id(obj, bone_id)
	set_int_arg0(bone_id)
	return obj:get_bone_name()
end</syntaxhighlight>
'''level'''
<syntaxhighlight lang="lua">-- прокручивает игровое время вперед на заданное количество минут, часов и дней
function level.change_game_time(m, h, d)
	level.advance_game_time((m or 0) * 60000 + (h or 0) * 3600000 + (d or 0) * 86400000)
	set_ignore_game_state_update()
end

-- возвращает level_vertex_id по позиции на уровне
function level.vertex_id_by_pos(position)
	db.actor:set_vector_global_arg_1(position)
	return level.vertex_id()
end

-- запускает эффектор шатания камеры с заданными параметрами
function level.add_cam_effector3(total_time, amplitude, period_number, power)
	level.set_ce_time(total_time)
	level.set_ce_amplitude(amplitude)
	level.set_ce_period_number(period_number)
	level.set_ce_power(power)
	level.add_ce()
end</syntaxhighlight>
'''relation_registry'''
<syntaxhighlight lang="lua">function relation_registry.get_goodwill(who_id, to_whom_id)
	return GetGoodwill(who_id, to_whom_id)
end

function relation_registry.set_goodwill(who_id, to_whom_id, goodwill)
	return db.actor:set_goodwill_ex(who_id, to_whom_id, goodwill)
end

function relation_registry.change_goodwill(who_id, to_whom_id, goodwill_change)
	return db.actor:change_goodwill_ex(who_id, to_whom_id, goodwill_change)
end</syntaxhighlight>
'''ray_pick'''<br/>
Флаги трассировки [[#rq_target]]
<syntaxhighlight lang="lua">-- устанавливает базовые параметры трассировки
function ray_pick.init(pos, dir, range, flags, obj)
	ray_pick.set_position(pos)
	ray_pick.set_direction(dir)
	ray_pick.set_range(range)
	ray_pick.set_flags(flags)
	ray_pick.set_ignore_object(obj)
end

-- устанавливает стартовую точку трассировки
function ray_pick.set_position(pos)
	db.actor:set_vector_global_arg_2(pos)
end

-- устанавливает направление трассировки
function ray_pick.set_direction(dir)
	db.actor:set_vector_global_arg_1(dir)
end

-- устанавливает диапазон трассировки
function ray_pick.set_range(range)
	set_float_args_12(range, 0)
end

-- устанавливает флаги трассировки (rq_target)
function ray_pick.set_flags(flags)
	set_int_arg1(flags)
end

-- устанавливает игнорируемый игровой объект для трассировки
function ray_pick.set_ignore_object(obj)
	db.actor:set_object_arg_1(obj)
end

-- выполняет запрос на трассировку и возвращает true, если она была успешна
function ray_pick.check()
	return level.perform_ray_pick_query()
end

-- если трассировка была успешна, возвращает дистанцию до точки, иначе возвращает ранее заданный диапазон трассировки
function ray_pick.get_distance()
	return level.get_ray_pick_dist()	
end

-- если трассировка была успешна, возвращает игровой объект
function ray_pick.get_object()
	return level.get_ray_pick_obj()
end

-- если луч пересек игровой объект, то возвращает номер кости, иначе возвращает номер полигона статической геометрии (при неудачной трассировке возвращает -1)
function ray_pick.get_element()
	return level.get_ray_pick_element()
end</syntaxhighlight>
----
Автор: '''RayTwitty (aka Shadows)'''

[[Категория:Движок]]