S.T.A.L.K.E.R. Inside Wiki - Вклад участника [ru]

Скриптовые шейдеры

2012-12-21T07:07:26Z

K.D.:

Редактируя любую модель, многие в свойствах поверхностей замечали графу shader, в которой указывается нечто вроде models/model или подобные.
Как правило, эти шейдеры упакованы в shaders.xr и shaders_xrlc.xr, которые представляют собой своеобразную базу данных шейдеров, собранных по определенным шаблонам.

Но кроме этих баз данных есть еще и скриптовые шейдеры, которые имеют приоритет перед теми шейдерами, что упакованы в *.xr. Это файлы, имеющие расширение .s и лежащие в папках соответствующих рендеров. Вычислить правильное название шейдера в БД и шейдерного скрипта .s можно очень просто - для примера, если у нас в БД шейдер находится в model/selflight, то имя шейдера должно быть model_selflight.s, если details/blend, то скрипт шейдера будет, соответственно, details_blend.s . Не так уж сложно.

Вообще база данных с шейдерами была выдумана не потому что авторам сталкера очень нравилось плодить экземпляры труднораспарсиваемых форматов, а причина более банальна - чтобы увеличить скорость загрузки игры, сэкономив за счет активности жесткого диска при открытии файлов скриптовых шейдеров в папке соответствующего рендера. Плюс к тому в этом случае уменьшается количество шейдерных файлов, что как минимум вдвое уменьшает вероятность ошибки - при условии двух рендеров эта экономия получается за счет тех шейдеров, которые являются общими для обоих рендеров. Плюс к тому вероятность ошибки еще более уменьшается тем, что базы данных редактируются в сдк, а сдк эти базы данных представляет в виде всевозможных галочек и полей ввода, поэтому ошибка может быть только во вводимых данных, но не в скриптовом коде шейдеров, который, вероятнее всего, генерируется во время загрузки игры.

Скриптовые шейдеры используются же в основном только в тех случаях, когда их код отличается для разных рендеров.

По некоторым причинам я считаю что для модостроителей шейдерные скрипты являются более предпочтительными, чем распространение своих шейдерных модов в виде модифицированной .xr-БД. Причины в основном две: Во-первых скриптовые шейдеры предоставляют бОльшие возможности для полета фантазии, а во-вторых распространение шейдерных модов в виде скриптовых шейдеров все же делает меньше вероятность конфликта модов, так как разные шейдеры будут в разных файлах, а не все вместе в одном хитром и трудноредактируемом, и, что самое плохое, - труднообъединяемом файле. Поэтому далее мы рассмотрим скриптовые шейдеры.

Что собой представляют шейдерные скрипты? Это обычные скрипты на lua, которые являются своеобразным языком для того чтобы объяснить движку, какие загружать текстуры и какие подключать шейдеры из наличествующих .ps и .vs файлов.

: ''Для тех кто воспрял духом сразу скажу, что несмотря на то, что шейдерные скрипты написаны на языке, который используется в игровых скриптах, это все-таки не одно и то же. Во-первых шейдерные скрипты выполняются при загрузке уровня всего один раз (в фазу загрузки "загрузка шейдеров"), поэтому на отрисовку в реальном времени влиять неспособны, и кроме того, к игровым скриптам скриптовые шейдеры доступа не имеют.''

Вот, для примера, содержимое простейшего скриптового шейдера:

function normal( shader, t_base, t_second, t_detail )

shader:begin( "effects_gradient", "effects_gradient_p" )

end

Разберем его по косточкам:

* '''function normal''' - объявление стандартной функции шейдерного скрипта. В некоторых шейдерах есть еще функции '''l_spot''', '''l_point''', '''l_special''' и '''normal_hq''' аналогичного содержания, но явно просчитывающие поведение этого шейдера в условиях освещения

* '''shader''' - вероятнее всего идентификатор шейдера в игре, содержимое этой переменной обычно представляет собой текстовую строку вроде "models_selflight" или "models/selflight".
* '''t_base''' - путь к текстуре, которую следует выводить с помощью этого шейдера
* '''t_second''', '''t_detail''' - пути к другим текстурам, пока назначение их неизвестно.

* '''shader:begin( "effects_gradient", "effects_gradient_p" )''' - святая святых шейдера. Если точнее - создание объекта шейдера как такового.
:: '''effects_gradient''' - имя .vs файла используемого в этом шейдере
:: '''effects_gradient_p''' - имя .ps файла соответственно.

После этой строки могут быть такие строки (они необязательны)

* ''': blend ( true, blend.srcalpha, blend.one )''' - обработка текстур, например, полупрозрачные текстуры без применения этой строки будут выглядеть непрозрачными черными в прозрачных местах. Эти методы блендинга соответствуют переключателю в сдк, где варианты ALPHA-ADD, BLEND, SET и так далее. На примере выше блендинг соответствует положению ALPHA-ADD.

:: '''true''' - может быть '''false''' - включение обработки текстур, то есть true - обработка включена, false, соответственно, выключена.

:: '''blend.srcalpha''', '''blend.one''' - соответственно, методы блендинга, могут быть:

blend.one
blend.zero
null

Также вот таблица, по которой можно выбрать остальные параметры блендинга, выбирая в таблице по порядку слева направо:

<table style="border: 1px solid #666;" width="470px" height="60px">
<tr>
<td> </td>
<td bgcolor="#666" width="2px"></td>
<td>src</td>
<td bgcolor="#666" width="2px"></td>
<td>color</td>
</tr>
<tr>
<td height="2px" bgcolor="#666" colspan="5"></td>
</tr>
<tr>
<td>inv</td>
<td bgcolor="#666" width="2px"></td>
<td>dest</td>
<td bgcolor="#666" width="2px"></td>
<td>alpha</td>
</tr>
</table>

то есть:

blend.srccolor
blend.invsrccolor
blend.destcolor
blend.invdestcolor
blend.srcalpha
blend.invsrcalpha
blend.destalpha
blend.invdestalpha

: где '''inv''' - инверсия, '''color''' - цвет, '''alpha''' - альфа (коэффициент прозрачности), '''src''' - параметр берется до шейдера, '''dest''' - параметр берется после шейдера.

* ''': sorting ( 3, false )''' - порядок отрисовки поверхности по отношению к самому объекту, частью которого является поверхность.

:: '''3''' - цифра порядка отрисовки, где 1 - за объектом, 2 - на уровне с объектом, 3 - спереди объекта (ближе к актору). Как правило, при тройке шейдируемая поверхность будет отрисовываться поверх всего, в том числе и оружия.

:: '''false''' - соответствует галочке "srict sorting" в сдк. Пока назначение неизвестно.

* ''': aref ( false, 2 )''' - функция переключает режим тестирования пикселей по альфе. Первый аргумент - вкл/выкл, второй аргумент - значение альфы, используемое в сравнении альфы пикселей. Если пиксель проверку не прошел, он не будет отрисовываться. Как именно происходит проверка альфы, пока непонятно, функция проверки устанавливается где-то в движке.

* ''': zb ( false, false )''' - устанавливает функцию сравнения пикселей при z-тесте и включает режим записи в z-буфер для текстуры. Первый аргумент - функция сравнения (false - D3DCMP_LESSEQUAL - пиксель проходит тест только, если его z меньше или равно текущему пикселю, true - D3DCMP_ALWAYS - пиксель всегда проходит тест). Второй аргумент - включение записи в z-буфер, тут вкл/выкл.

* ''': fog ( false )''' - отключает освещение текстуры и включает для нее FOG DirectX.

* ''': emissive ( true )''' - применяется в источниках освещения.

* ''': distort ( true )''' - представляет из себя механизм искажений, аналогичный эффекту искажающегося воздуха в некоторых аномалиях, а также "линза" в главном меню над кнопками.

* ''': wmark (true)''' - используется в валлмарках

----

* '''shader : sampler( "s_base" )''' - создание буфера для помещения туда текстуры. Аргумент представляет собой идентификатор, получаемый ps и vs шейдерами, где будет фигурировать как predefined-переменная s_base.

''Перечисленные ниже параметры могут быть только ниже сэмплерной строки!''

* ''': texture ( t_base ) ''' - помещение в вышеобъявленный буфер текстуры. Аргумент этой ф-ции представляет собой путь к текстуре, так что вполне можно указать нечто вроде

: texture ( "fx\\fx_sun" )

чтобы в буфер воткнуть текстуру '''gamedata/textures/fx/fx_sun.dds'''

Следующие функции устанавливают один из режимов адресации текстуры. Режим адресации определяет способ обработки текстурных координат при выходе их за пределы диапазона [0.0,1.0]
* ''': clamp()''' - режим адресации D3DTADDRESS_CLAMP. Значения текстурных координат, выходящие за рамки [0.0,1.0] обрезаются до 0.0 и 1.0 соответственно. Соответствует галке Texture Clamp в сдк.

* ''': wrap ()''' - режим адресации D3DTADDRESS_WRAP. При выходе значений текстурных координат за пределы [0.0,1.0] от значений отнимается их целая часть. Другими словами, если у вас u,v получились [1.3, 2.5], в этом режиме семплирование текстуры будет происходит по координатам [0.3, 0.5].

* ''': mirror ()''' - режим адресации D3DTADDRESS_MIRROR. При выходе значений текстурных координат за пределы [0.0,1.0] от значений отнимается их целая часть и остаток вычитается из 1.0. Если u,v получились [1.3, 2.6], в этом режиме семплирование текстуры будет происходит по координатам [0.7, 0.4].

Функции установки фильтрации текстур:

* ''': f_none ()''' - точечная фильтрация (то есть по сути, нет фильтрации)

* ''': f_linear ()''' - линейная фильтрация

* ''': f_bilinear ()''' - билинейная фильтрация

* ''': f_trilinear ()''' - трилинейная фильтрация. На редкость бесполезная функция, потому что семплер по умолчанию создается с трилинейной фильтрацией

* ''': f_anisotropic ()''' - анизотропная фильтрация.

Помимо этих функций также присутствуют функции для "тонкой" настройки фильтрации:
Настройка magnification filter

* ''': fmag_none ()''' - без фильтрации

* ''': fmag_point ()''' - точечная фильтрация

* ''': fmag_linear ()''' - линейная фильтрация

Настройка minification filter

* ''': fmin_none ()''' - без фильтрации

* ''': fmin_point ()''' - точечная фильтрация

* ''': fmin_linear ()''' - линейная фильтрация

* ''': fmin_aniso ()''' - анизотропная фильтрация.

Настройка mip filter

* ''': fmip_none ()''' - без фильтрации

* ''': fmip_point ()''' - точечная фильтрация

* ''': fmip_linear ()''' - линейная фильтрация

Разные функции:

* ''': project()''' - функция выставляет флаг D3DTTFF_PROJECTED для преобразования текстурных координат перед растеризатором. При выставленном флаге все компоненты текстурных координат делятся на w-компоненту. Актуально только для ffp (R1, ps_1_x).

----

Также в папке с шейдерами лежат еще файлы .s (именно такого имени - точка и эс), которые являются для всех *.s-файлов своеобразными заголовочными файлами, функции из файла .s доступны из файлов *.s . На данный момент там имеются функции printf, и закомментированные во втором рендере ф-ции l_point и l_spot, которые отвечают за создание точечного и неточечного источников света соответственно.

'''Статья создана участником cjayho'''

[[Категория:Скрипты]]

Описание класса game object. Часть II.

2011-12-19T18:05:45Z

K.D.: /* CCustomMonster */

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CCustomMonster'''=
Эти методы можно применять только для сталкеров и монстров.
<div class="NavFrame collapsed">
<div class="NavHead">'''function best_danger()''' </div>
<div class="NavContent"><cpp>danger_object* best_danger()</cpp>
возвращает лучший дэнжер в виде объекта класса danger_object. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_enemy()''' </div>
<div class="NavContent"><cpp>game_object* best_enemy()</cpp>
возвращает объект врага. Работает для сталкеров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_item()''' </div>
<div class="NavContent"><cpp>game_object* best_item()</cpp>
вроде как возвращает объект тушки, которую можно пожевать. Точно неизвестно. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_enemy() const''' </div>
<div class="NavContent"><cpp>game_object* get_enemy() const</cpp>
возвращает объект текущего врага. Работает для монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_position(const game_object&)''' </div>
<div class="NavContent"><cpp>vector memory_position(const game_object& lua_game_object)</cpp>
возвращает позицию (в виде объекта класса vector), на которой последний раз был видим объект lua_game_object нашим объектом. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_time(const game_object&)''' </div>
<div class="NavContent"><cpp>int memory_time(const game_object& lua_game_object)</cpp>
возвращает время, когда последний раз был видим объект lua_game_object нашим объектом, в игровых мс. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_memory_object(game_object*, boolean)''' </div>
<div class="NavContent"><cpp>void enable_memory_object(game_object* lua_game_object, bool enable)</cpp>
включает/отключает объект в памяти монстра/сталкера. В игре используется для форсированного "забывания" врага при его долговременном отсутствии. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_hit_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_hit_objects() const</cpp>
возвращает итератор объектов, которые когда-либо наносили хит. Объекты имеют тип hit_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_hit_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_sound_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_sound_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были слышимы. Объекты имеют тип sound_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_sound_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_visible_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были видимы. Объекты имеют тип visible_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function not_yet_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator not_yet_visible_objects() const</cpp>
возвращает итератор объектов, которые видны или собираются быть видны. Объекты имеют тип not_yet_visible_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:not_yet_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function change_team(number, number, number)''' </div>
<div class="NavContent"><cpp>void change_team(int team, int squad, int group)</cpp>
меняет для объекта team, squad и group.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function see(string)''' </div>
<div class="NavContent"><cpp>bool see(string section_name)</cpp>
проверяет, есть ли среди массива видимых объектов объект с именем секции, равной section_name.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fov(number)''' </div>
<div class="NavContent"><cpp>void set_fov(float new_fov)</cpp>
устанавливает угол зрения, равный значению new_fov.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_range(number)''' </div>
<div class="NavContent"><cpp>void set_range(float new_range)</cpp>
устанавливает максимальную ширину видимой области, равный значению new_range.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vertex_in_direction(number, vector, number) const''' </div>
<div class="NavContent"><cpp>int vertex_in_direction(int level_vertex_id, vector direction, float max_distance) const</cpp>
возвращает lvid наиболее удаленной точки, доступной неписю в направлении direction. Аргументы:
*level_vertex_id - ближайший к объекту левел вертекс
*direction - направление, в котором надо получить точку
*max_distance - диаметр сферы с центром в level_vertex_id, в которой ищутся доступные вертексы.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible_nearest(const vector&, vector&)''' </div>
<div class="NavContent"><cpp>int accessible_nearest(const vector& position, vector& result)</cpp>
возвращает ближайший к точке position левел вертекс. В память по указателю result записываются координаты этого вертекса.<br />Пример использования:<lua>local pos = npc:position()
local res = vector():set(0,0,0)
local lvid = npc:accessible_nearest(pos, res)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(const vector&)''' </div>
<div class="NavContent"><cpp>bool accessible(const vector& position)</cpp>
возвращает true, если точка position находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(number)''' </div>
<div class="NavContent"><cpp>bool accessible(int level_vertex_id)</cpp>
возвращает true, если вертекс level_vertex_id находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void add_restrictions(string out, string in)</cpp>
добавляет объекту рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_in_restrictions()''' </div>
<div class="NavContent"><cpp>string base_in_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_out_restrictions()''' </div>
<div class="NavContent"><cpp>string base_out_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function in_restrictions()''' </div>
<div class="NavContent"><cpp>string in_restrictions()</cpp>
возвращает список рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function out_restrictions()''' </div>
<div class="NavContent"><cpp>string out_restrictions()</cpp>
возвращает список рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_all_restrictions()''' </div>
<div class="NavContent"><cpp>string remove_all_restrictions()</cpp>
удаляет все рестрикторы 4 и 5 типов. Устанавливает in_restrictions и out_restrictions пустыми.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void remove_restrictions(string out, string in);</cpp>
удаляет рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую. Есть особенность: обязательно должен быть задан аргумент out, иначе функция не будет работать (хотя и не вылетит)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function critically_wounded()''' </div>
<div class="NavContent"><cpp>bool critically_wounded()</cpp>
возвращает true, если объект критически ранен.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled(boolean)''' </div>
<div class="NavContent"><cpp>void movement_enabled(bool enable)</cpp>
разрешает/запрещает объекту движение.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled()''' </div>
<div class="NavContent"><cpp>bool movement_enabled()</cpp>
возвращает true, если объекту разрешено двигаться по пути.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_point_index()''' </div>
<div class="NavContent"><cpp>int get_current_point_index()</cpp>
возвращает номер текущей точки пути (lvid).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function is_body_turning()''' </div>
<div class="NavContent"><cpp>int is_body_turning()</cpp>
возвращает true, если объект поворачивается. Сравнивается текущее и целевое направление, разница между ними сравнивается с 0,00001 и если разница больше, то возвращается true. Для сталкеров возвращает true, даже если он просто вертит башкой.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function location_on_path(number, vector*)''' </div>
<div class="NavContent"><cpp>int location_on_path(float distance, vector* location)</cpp>
возвращает координаты точки пути объекта, которая отстоит от следующей точки пути более, чем на расстояние distance. Аргументы:
*distance - расстояние между точками (float)
*location - в этот вектор пишутся вычисленные кординаты.
Непосредственно функция возвращает level_vertex_id найденной точки. Также, если у непися нет активного пути или он стоит в последней точке пути, или между всеми точками пути расстояние меньше, чем distance, возвратятся его координаты и вертекс<br />Примеры использования:<lua>
local dist = 5
local location = vector():set(0,0,0)
local lvid = npc:location_on_path(dist, location)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function path_completed()''' </div>
<div class="NavContent"><cpp>bool path_completed()</cpp>
возвращает true, если путь завершен объектом. false если нет.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function patrol_path_make_inactual()''' </div>
<div class="NavContent"><cpp>void patrol_path_make_inactual()</cpp>
делает текущий путь завершенным.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_point(number)''' </div>
<div class="NavContent"><cpp>void set_start_point(int point_index)</cpp>
установить начальную точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_previous_point(number)''' </div>
<div class="NavContent"><cpp>void set_previous_point(int point_index)</cpp>
установить предыдущую точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count(boolean)''' </div>
<div class="NavContent"><cpp>int active_sound_count(bool only_playing)</cpp>
возвращает количество проигрываемых звуков. Если only_playing = false, то вернет еще и количество звуков в очереди.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count()''' </div>
<div class="NavContent"><cpp>int active_sound_count()</cpp>
см active_sound_count(boolean). Параметр only_playing по умолчанию false <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number, string)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type, string bone_name)</cpp>
инициализирует для объекта еще один звук. Аргументы:
*prefix - sound_prefix звука
*max_count - ???
*type - тип звука. Возможные значения см в классе-перечислении snd_type.
*priority - ???
*mask - ???
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*bone_name - кость, от которой будет играться звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type)</cpp>
см. add_sound(string, number, enum ESoundTypes, number, number, number, string). Аргумент bone_name по умолчанию bip01_head.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time, int id)</cpp>
проигрывает от объекта звук. Аргументы:
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*max_start_time, min_start_time - максимальное и минимальное время задержки запуска звука. Если грубо - между ними берется рандомное значение, к нему прибавляется текущее время и результат устанавливается началом запуска звука
*max_stop_time, min_stop_time - аналогично start_time. Время окончания устанавливается равным текущему времени + start_time + stop_time + длительность звука
*id - вроде как номер темы. Из этой темы движок выбирает рандомный звук. Если -1 - будет выбрана рандомная фраза, инициализированная для объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number, number). Аргумент id по умолчанию берется -1.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number). Аргумент min_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time)</cpp>
см.выше function play_sound(number, number, number, number). Аргумент max_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time)</cpp>
см.выше function play_sound(number, number, number). Аргумент min_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type)</cpp>
см.выше function play_sound(number, number). Аргумент max_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_sound_threshold()''' </div>
<div class="NavContent"><cpp>void restore_sound_threshold()</cpp>
восстанавливает дефолтный sound_threshold - порог громкости, при котором непись слышит звук. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_sound_threshold(float value)</cpp>
устанавливает sound_threshold - порог громкости, при котором непись слышит звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_sound(number)''' </div>
<div class="NavContent"><cpp>void remove_sound(int internal_type)</cpp>
стереть тему с индексом id из списка разрешенных для персонажа.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_mask(number)''' </div>
<div class="NavContent"><cpp>void set_sound_mask(int sound_mask)</cpp>
устанавливает sound_mask.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix(string)''' </div>
<div class="NavContent"><cpp>void sound_prefix(string sound_prefix)</cpp>
устанавливает sound_prefix объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_prefix() const</cpp>
возвращает sound_prefix объекта. sound_prefix - папка со звуками для данного объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_voice_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_voice_prefix() const</cpp>
возвращает sound_voice_prefix объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function visibility_threshold() const''' </div>
<div class="NavContent"><cpp>float visibility_threshold() const</cpp>
возвращает максимальное расстояние, на котором объект видит другие объекты. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vision_enabled() const''' </div>
<div class="NavContent"><cpp>bool vision_enabled() const</cpp>
проверяет, включено ли запоминание видимых объектов. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_vision(boolean)''' </div>
<div class="NavContent"><cpp>void enable_vision(bool value)</cpp>
включить/выключить запись видимых объектов в память.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length(number)''' </div>
<div class="NavContent"><cpp>void extrapolate_length(float extrapolate_length)</cpp>
устанавливает m_extrapolate_length равным extrapolate_length. Что это - непонятно, но имеет отношение к CDetailPathManager.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length()''' </div>
<div class="NavContent"><cpp>float extrapolate_length()</cpp>
возвращает m_extrapolate_length. Имеет отношение к CDetailPathManager.<br /><br /></div></div>
Добавлено в ЧН
<div class="NavFrame collapsed">
<div class="NavHead">'''function invulnerable() const''' </div>
<div class="NavContent"><cpp>bool invulnerable() const</cpp>
возвращает состояние режима неуязвимости.<br /><br /></div></div>
<div class="NavFrame collapsed">

<div class="NavHead">'''function invulnerable(boolean)''' </div>
<div class="NavContent"><cpp>void invulnerable(bool value)</cpp>
включить/отключить режим неуязвимости.<br /><br /></div></div>
Добавлено в ЗП
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_npc_position(vector)''' </div>
<div class="NavContent"><cpp>void set_npc_position(vector pos)</cpp>
телепортировать объект по координатам pos.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_visual_memory_enabled(boolean)''' </div>
<div class="NavContent"><cpp>void set_visual_memory_enabled(bool val)</cpp>
включение/отключение памяти непися/монстра. Используется для помещения непися или монстра в состояние игнора актора.<br /><br /></div></div>
function add_combat_sound(string, number, enum ESoundTypes, number, number, number, string);

='''CBaseMonster'''=
Эти методы можно применять только для монстров.

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_corpse()''' </div>
<div class="NavContent"><cpp>game_object* get_corpse()</cpp>
возвращает объект трупа в ближайшем радиусе вокруг монстра, причем класс объекта эквивалентен CEntity. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_monster_hit_info()''' </div>
<div class="NavContent"><cpp>MonsterHitInfo* get_monster_hit_info()</cpp>
возвращает объект класса MonsterHitInfo, содержащий информацию о последнем, кто бил по монстру. Аргументов не принимает.
<cpp>class MonsterHitInfo {
vector direction; //направление хита
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект нанесшего хит.
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_sound_info()''' </div>
<div class="NavContent"><cpp>SoundInfo* get_sound_info()</cpp>
возвращает объект SoundInfo, содержащий информацию о последнем услышанном звуке. Аргументов не принимает.
<cpp>class MonsterHitInfo {
bool danger; //опасен ли звук. У меня получалось true, если издающй звук объект еще и наносит хит. Если стрелять в воздух, монстр "не боится".
vector position; //координаты звука
float power; //сила звука
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект издавшего звука
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_home()''' </div>
<div class="NavContent"><cpp>void remove_home()</cpp>
удаление точки "выпаса" монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_custom_panic_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_custom_panic_threshold(float value)</cpp>
установить порог паники, равным value.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_default_panic_threshold()''' </div>
<div class="NavContent"><cpp>void set_default_panic_threshold()</cpp>
вернуть порог паники по умолчанию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_home(string, number, number, boolean)''' </div>
<div class="NavContent"><cpp>void set_home(string name, float r_min, float r_max, bool aggressive)</cpp>
установить точку "выпаса" монстров. Аргументы:
*name - имя пути
*r_min - минимальный радуис беготни вокруг точки
*r_max - максимальный радиус удаления от точки
*aggressive - аггресивность монстров.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function skip_transfer_enemy(boolean)''' </div>
<div class="NavContent"><cpp>void skip_transfer_enemy(bool val)</cpp>
управляет передачей врагов от друзей. Если установлено в true и видит дружественного монстра, то его враги также становятся врагами.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function character_rank()''' </div>
<div class="NavContent"><cpp>int character_rank()</cpp>
возвращает ранг объекта. Также работает и для объектов-наследников CInventoryOwner. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function jump(const vector&, number)''' </div>
<div class="NavContent"><cpp>void jump(const vector& position, float factor)</cpp>
заставляет объект прыгнуть. Работает только для снорков. Аргументы:
*position - конечные координаты прыжка.
*factor - точно трудно сказать, но похоже, что время прыжка.<br /><br /></div></div>
='''CAI_Bloodsucker'''=
Эти методы можно применять только для кровососа.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_alien_control(boolean)''' </div>
<div class="NavContent"><cpp>void set_alien_control(bool val)</cpp>
устанавливает камеру актера в положение "от глаз монстра" и обратно.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_invisible(boolean)''' </div>
<div class="NavContent"><cpp>void set_invisible(bool val)</cpp>
управляет невидимостью. true - установить, false - убрать.<br /><br /></div></div>
='''CAI_Zombie'''=
Эти методы можно применять только для зомби.
<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_fall_down()''' </div>
<div class="NavContent"><cpp>boolean fake_death_fall_down()</cpp>
проигрывает у зомби анимацию ложной смерти. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_stand_up()''' </div>
<div class="NavContent"><cpp>boolean fake_death_stand_up()</cpp>
проигрывает у зомби анимацию вставания. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 17:21, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть V.

2011-12-19T17:35:46Z

K.D.: /* CLevelChanger (ЧН и ЗП) */

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CAI_PhraseDialogManager'''=
Эти методы можно применять только для сталкеров и торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_default_start_dialog()''' </div>
<div class="NavContent"><cpp>void restore_default_start_dialog()</cpp>
устанавливает стартовый диалог неписю дефолтным. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog(string)''' </div>
<div class="NavContent"><cpp>void set_start_dialog(string dialog_id)</cpp>
устанавливает диалог dialog_id неписю в качестве стартового диалога.<br /><br /></div></div>

='''CAI_Trader'''=
Эти методы можно применять только для торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function external_sound_start(string)''' </div>
<div class="NavContent"><cpp>void external_sound_start(string sound)</cpp>
вроде как включает для торговца звук sound, но останавливает анимацию головы. Используется в начальном туторе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog()''' </div>
<div class="NavContent"><cpp>void external_sound_stop()</cpp>
станавливает звук торговца. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_global_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_global_anim(string anim)</cpp>
устанавливает анимацию anim для тела торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_head_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_head_anim(string anim)</cpp>
устанавливает анимацию anim для головы торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_sound(string, string)''' </div>
<div class="NavContent"><cpp>void set_trader_sound(string sound, string anim)</cpp>
устанавливает торговцу анимацию головы anim и включает в голове звук sound.<br /><br /></div></div>

='''CActor'''=
Эти методы можно работают для актора.<br />Следующие методы не проверяют свой неявный аргумент, так что их можно применять хоть к бочкам. Объект в них берется с помощью actor()
<div class="NavFrame collapsed">
<div class="NavHead">'''function give_task(CGameTask*, number, boolean)''' </div>
<div class="NavContent"><cpp>void give_task(CGameTask* t, int dt, bool bCheckExisting)</cpp>
выдает актору задание. Аргументы:
*t - задание в виде объекта CGameTask. Можно взять методом CGameTask() и загрузить в него данные методом load().
*dt - время на завершение
*bCheckExisting - проверять ли на наличие. Если bCheckExisting == true, то задание, при его присутствии у актора не выдается, в противном случае инициализируется заново.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_task_state(string, number)''' </div>
<div class="NavContent"><cpp>task get_task_state(string task_id, int objective_num)</cpp>
возвращает состояние задания (поле task_state) для задания task_id и подзадания objective_num. Возвращает константу из класса-перечисления task.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_task_state(enum ETaskState, string, number)''' </div>
<div class="NavContent"><cpp>void set_task_state(enum ETaskState state, string task_id, int objective_num)</cpp>
устанавливает у подзадания таска одно из выбранных состояний. Аргументы:
*state - состояние (константа из класса-перечисления task)
*task_id - таск
*objective_num - номер подзадания <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function hide_weapon()''' </div>
<div class="NavContent"><cpp>void hide_weapon()</cpp>
спрятать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_weapon()''' </div>
<div class="NavContent"><cpp>void restore_weapon()</cpp>
достать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function eat(game_object*)''' </div>
<div class="NavContent"><cpp>void eat(game_object* item)</cpp>
заставляет актора съесть предмет item. Предмет должен наследовать от класса CEatableItem.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_talk_message(string, string, Frect, string)''' </div>
<div class="NavContent"><cpp>void give_talk_message(string text, string texture_name, Frect tex_rect, string templ_name)</cpp>
выводит сообщение в диалоговое окно. Пример - вывод списка доступных повторяющихся квестов в диалоге с торговцем. Аргументы:
*text - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*templ_name - имя шаблона выводимой картинки. Регистрируется в talk.xml. Если не указано - движок считает, что это "iconed_answer_item"<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_game_news(string, string, Frect, number, number)''' </div>
<div class="NavContent"><cpp>bool give_game_news(string news, string texture_name, Frect tex_rect, int delay, int show_time)</cpp>
выводит сообщение в виде новости. Аргументы:
*news - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*delay - задержка выдачи новости
*show_time - время показа новости<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fastcall(const function<boolean>& , object)''' </div>
<div class="NavContent"><cpp>void set_fastcall(const function<boolean>& , object)</cpp>
установка быстрого обработчика.<br /><br /></div></div>
Следующие методы проверяют, к кому применются, вызывать их следует только для актора.

<div class="NavFrame collapsed">
<div class="NavHead">'''function run_talk_dialog(game_object*)''' </div>
<div class="NavContent"><cpp>void run_talk_dialog(game_object* pToWho)</cpp>
запускает диалог между актором и объектом pToWho. Тот объект должен наследовать от класса CInventoryOwner. Разговор можно начать только если собеседник находится на расстоянии не больше трёх метров от актора. Если точнее, то можно попытаться вызвать её и на больших расстояниях. Что-то при этом происходит: появляется мышь, отключается движение актора и он начинает смотреть на "собеседника" даже при том, что окна разговора нет. Такое ощущение, что просто безбожно глючит. Проверка допустимого расстояния перед началом остаётся таким образом на совести скриптёра. Расстояние в 3 метра никакими настройками не изменить, похоже вшито прямо в код движка. Другой момент. Данная функция только открывает диалог разговора. Если не делать ничего дополнительно, то непись "разговаривая" пойдёт себе дальше, и как только выйдет за три метра - разговор прервётся. В игре непись удерживается от убегания специальной скриптовой схемой, которая заставляет его стоять на месте, смотреть на актора, может ещё анимации проигрывать, точно не знаю. Параметр need_osoznanie_mode в секции персонажа позволяет избежать ограничения в 3 метра на возможность начать разговор. Однако при этом окно разговора показывается не полностью. Отсутствуют окна с иконками собеседников и окно чата. Есть только нижняя часть - окно выбора варианта ответа или диалога. Фактически, это превращает окно общения в своеобразное диалоговое окно для выбора одного из нескольких вариантов. Это используется в игре для предоставления Меченому выбора - присоединяться к О-Сознанию или нет. В принципе ничто не мешает использовать это как-то иначе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_direction(number)''' </div>
<div class="NavContent"><cpp>void set_actor_direction(float dir)</cpp>
устанавливает для актора направление взгляда, передаваемое углом вращения dir (в радианах).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_position(vector)''' </div>
<div class="NavContent"><cpp>void set_actor_position(vector pos)</cpp>
устанавливает для актора координаты, передаваемые вектором pos.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function switch_to_trade()''' </div>
<div class="NavContent"><cpp>void switch_to_trade()</cpp>
активировать окно торговли в диалоге. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_holder()''' </div>
<div class="NavContent"><cpp>holder* get_current_holder()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором. Аргументов не принимает.<br /><br /></div></div>
='''CInventoryBox'''=
Эти методы можно применять только для ящиков с инвентарем.
<div class="NavFrame collapsed">
<div class="NavHead">'''function is_inv_box_empty()''' </div>
<div class="NavContent"><cpp>bool is_inv_box_empty()</cpp>
проверяет, пустой ли ящик с инвентарем. Аргументов не принимает.<br /><br /></div></div>
Появилось в ЧН
<div class="NavFrame collapsed">
<div class="NavHead">'''function iterate_inventory_box(function<void>, object)''' </div>
<div class="NavContent"><cpp>void iterate_inventory_box(function<void>, object)</cpp>
перебор предметов в ящике. Работает аналогично перебору по инвентарю актора.<br /><br /></div></div>

='''CSpaceRestrictor'''=
Эти методы можно применять только для спейс рестрикторов и аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&, number)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position, float epsilon) const</cpp>
возвращает true, если сфера с центром в position и радиусом epsilon персекается со спейс рестриктором. Аргументы:
*position - центр сферы, для которой проверяется пересечение со спейс-рестриктором (объект класса vector)
*epsilon - радиус сферы (float)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position) const</cpp>
см. inside(const vector&, number), epsilon берется по умолчанию 0,001.<br /><br /></div></div>
='''CCustomZone'''=
Эти методы можно применять только для аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function disable_anomaly()''' </div>
<div class="NavContent"><cpp>void disable_anomaly()</cpp>
отключает аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_anomaly()''' </div>
<div class="NavContent"><cpp>void enable_anomaly()</cpp>
активирует аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_anomaly_power()''' </div>
<div class="NavContent"><cpp>float get_anomaly_power()</cpp>
возвращает max_power для объекта аномалиию. Максимальное значение вроде 1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_anomaly_power(number)''' </div>
<div class="NavContent"><cpp>void set_anomaly_power(float p)</cpp>
устанавливает max_power для объекта аномалии. Установить можно любое значение. Аргументов не принимает.<br /><br /></div></div>
='''CLevelChanger (ЧН и ЗП)'''=
Эти методы можно применять только для переходов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function is_level_changer_enabled()''' </div>
<div class="NavContent"><cpp>bool is_level_changer_enabled()</cpp>
возвращает состояние перехода (включен/выключен). Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_level_changer(boolean)''' </div>
<div class="NavContent"><cpp>void enable_level_changer(bool val)</cpp>
включить/выключить переход.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_level_changer_invitation(string )''' </div>
<div class="NavContent"><cpp>void set_level_changer_invitation(string invitation)</cpp>
установить текст в окне запроса при переходе. Для ЗП не актуально.<br /><br /></div></div>

='''CScriptZone'''=
Эти методы можно применять только для подходит только для скриптовых зон. Но в игре их вроде нет.
<div class="NavFrame collapsed">
<div class="NavHead">'''function active_zone_contact(number)''' </div>
<div class="NavContent"><cpp>void active_zone_contact(int id)</cpp>
возвращает true, если зона находится в контакте с объектом с индексом id.<br /><br /></div></div>
='''CProjector'''=
Эти методы можно применять только для прожекторов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_direction()''' </div>
<div class="NavContent"><cpp>vector get_current_direction()</cpp>
возвращает текущее направление проектора. Аргументов не принимает.<br /><br /></div></div>
='''CHudItem'''=
Эти методы можно применять только для артефактов, гранат и оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function animation_slot()''' </div>
<div class="NavContent"><cpp>int animation_slot() const</cpp>
возвращает номер слота анимации для данного объекта. Это не слот в инвентаре! Примеры:
*для пистолета - 1
*для автомата - 2
*для дробовика - 3
*для артефакта - 11
*для бинокля - 13.<br /><br /></div></div>
='''CExplosive'''=
Эти методы можно применять только для гранат и канистр.
<div class="NavFrame collapsed">
<div class="NavHead">'''function explode(number)''' </div>
<div class="NavContent"><cpp>void explode(int level_time)</cpp>
подрывает итем. Несмотря на наличие аргумента level_time, он вроде в функции не используется, так что управлять подрывом не выйдет.<br /><br /></div></div>
='''CAttachableItem'''=
Эти методы можно применять для всех инвентарных предметов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function attachable_item_enabled()''' </div>
<div class="NavContent"><cpp>bool attachable_item_enabled() const</cpp>
возвращает, активен ли итем. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_attachable_item(boolean)''' </div>
<div class="NavContent"><cpp>void enable_attachable_item(bool value)</cpp>
делает активным/неактивным итем. Parent итема должен наследовать от класса CAttachmentOwner. Всегда активны: аптечки, бинты, детекторы, патроны для активного оружия, активное оружие. Короче, все то, что в слотах или на горяих клавишах.<br /><br /></div></div>
='''CInventoryItem'''=
Эти методы можно применять для тех инвентарных предметов, у которых параметр class в конфиге не равен II_ATTCH.
<div class="NavFrame collapsed">
<div class="NavHead">'''function cost() const''' </div>
<div class="NavContent"><cpp>int cost() const</cpp>
возвращает стоимость вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function condition() const''' </div>
<div class="NavContent"><cpp>int condition() const</cpp>
возвращает состояние вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_condition(number)''' </div>
<div class="NavContent"><cpp>void set_condition(int val)</cpp>
устанавливает состояние вещи.<br /><br /></div></div>
='''CTorch (только ЗП)'''=
Эти методы можно применять только для фонаря.
<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_night_vision(boolean)''' </div>
<div class="NavContent"><cpp>void enable_night_vision(bool val)</cpp>
включить/отключить ночное видение.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function night_vision_enabled() const''' </div>
<div class="NavContent"><cpp>bool night_vision_enabled() const</cpp>
возвращает состояние ночного видения. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_torch(boolean)''' </div>
<div class="NavContent"><cpp>void enable_torch(bool val)</cpp>
включить/отключить фонарь.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function torch_enabled() const''' </div>
<div class="NavContent"><cpp>bool torch_enabled() const</cpp>
возвращает состояние фонаря (включен/отключен). Аргументов не принимает.<br /><br /></div></div>
='''CWeapon'''=
Эти методы можно применять только для оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_total() const''' </div>
<div class="NavContent"><cpp>int get_ammo_total() const</cpp>
возвращает общее количество патронов для данного оружия в стволе и инвентаре, если ствол в инвентаре. Если не в инвентаре - просто количество патронов в обойме. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_in_magazine() const''' </div>
<div class="NavContent"><cpp>int get_ammo_in_magazine() const</cpp>
возвращает количество патронов в стволе. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_ammo_elapsed(number)''' </div>
<div class="NavContent"><cpp>void set_ammo_elapsed(int ammo_elapsed)</cpp>
заряжает магазин количеством патронов, равным ammo_elapsed. Размер магазина игнорируется.<br /><br /></div></div>

='''CWeaponMagazined'''=
Эти методы можно применять только для оружия - кроме ножа и гранат.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_queue_size(number)''' </div>
<div class="NavContent"><cpp>void set_queue_size(int queue_size)</cpp>
устанавливает размер очереди из оружия.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function unload_magazine()''' </div>
<div class="NavContent"><cpp>void unload_magazine()</cpp>
разряжает магазин оружия. Оружие должно быть в инвентаре/руках объекта CAI_Stalker. Патроны из ствола пропадают. Аргументов не принимает.<br /><br /></div></div>

='''Методы получения объектов "чистых" клиентских движковых классов'''=
Эти методы позволяют получить объект чистого движкового класса из объекта класса-обертки CScriptGameObject.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_car()''' </div>
<div class="NavContent"><cpp>CCar* get_car()</cpp>
возвращает объект машины.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_holder_class()''' </div>
<div class="NavContent"><cpp>holder* get_holder_class()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_hanging_lamp()''' </div>
<div class="NavContent"><cpp>hanging_lamp* get_hanging_lamp()</cpp>
озвращает объект лампочки.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_helicopter()''' </div>
<div class="NavContent"><cpp>CHelicopter* get_helicopter()</cpp>
возвращает объект вертолета.<br /><br /></div></div>
Следующие методы присутствуют начиная с ЧН.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_campfire()''' </div>
<div class="NavContent"><cpp>CZoneCampfire* get_campfire()</cpp>
возвращает объект костра.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_artefact()''' </div>
<div class="NavContent"><cpp>CArtefact* get_artefact()</cpp>
возвращает объект артефакта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_object()''' </div>
<div class="NavContent"><cpp>CPhysicObject* get_physics_object()</cpp>
возвращает объект физических предметов (ящики, коробки).<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 17:35, 19 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть V.

2011-12-19T17:35:07Z

K.D.:

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CAI_PhraseDialogManager'''=
Эти методы можно применять только для сталкеров и торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_default_start_dialog()''' </div>
<div class="NavContent"><cpp>void restore_default_start_dialog()</cpp>
устанавливает стартовый диалог неписю дефолтным. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog(string)''' </div>
<div class="NavContent"><cpp>void set_start_dialog(string dialog_id)</cpp>
устанавливает диалог dialog_id неписю в качестве стартового диалога.<br /><br /></div></div>

='''CAI_Trader'''=
Эти методы можно применять только для торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function external_sound_start(string)''' </div>
<div class="NavContent"><cpp>void external_sound_start(string sound)</cpp>
вроде как включает для торговца звук sound, но останавливает анимацию головы. Используется в начальном туторе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog()''' </div>
<div class="NavContent"><cpp>void external_sound_stop()</cpp>
станавливает звук торговца. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_global_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_global_anim(string anim)</cpp>
устанавливает анимацию anim для тела торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_head_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_head_anim(string anim)</cpp>
устанавливает анимацию anim для головы торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_sound(string, string)''' </div>
<div class="NavContent"><cpp>void set_trader_sound(string sound, string anim)</cpp>
устанавливает торговцу анимацию головы anim и включает в голове звук sound.<br /><br /></div></div>

='''CActor'''=
Эти методы можно работают для актора.<br />Следующие методы не проверяют свой неявный аргумент, так что их можно применять хоть к бочкам. Объект в них берется с помощью actor()
<div class="NavFrame collapsed">
<div class="NavHead">'''function give_task(CGameTask*, number, boolean)''' </div>
<div class="NavContent"><cpp>void give_task(CGameTask* t, int dt, bool bCheckExisting)</cpp>
выдает актору задание. Аргументы:
*t - задание в виде объекта CGameTask. Можно взять методом CGameTask() и загрузить в него данные методом load().
*dt - время на завершение
*bCheckExisting - проверять ли на наличие. Если bCheckExisting == true, то задание, при его присутствии у актора не выдается, в противном случае инициализируется заново.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_task_state(string, number)''' </div>
<div class="NavContent"><cpp>task get_task_state(string task_id, int objective_num)</cpp>
возвращает состояние задания (поле task_state) для задания task_id и подзадания objective_num. Возвращает константу из класса-перечисления task.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_task_state(enum ETaskState, string, number)''' </div>
<div class="NavContent"><cpp>void set_task_state(enum ETaskState state, string task_id, int objective_num)</cpp>
устанавливает у подзадания таска одно из выбранных состояний. Аргументы:
*state - состояние (константа из класса-перечисления task)
*task_id - таск
*objective_num - номер подзадания <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function hide_weapon()''' </div>
<div class="NavContent"><cpp>void hide_weapon()</cpp>
спрятать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_weapon()''' </div>
<div class="NavContent"><cpp>void restore_weapon()</cpp>
достать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function eat(game_object*)''' </div>
<div class="NavContent"><cpp>void eat(game_object* item)</cpp>
заставляет актора съесть предмет item. Предмет должен наследовать от класса CEatableItem.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_talk_message(string, string, Frect, string)''' </div>
<div class="NavContent"><cpp>void give_talk_message(string text, string texture_name, Frect tex_rect, string templ_name)</cpp>
выводит сообщение в диалоговое окно. Пример - вывод списка доступных повторяющихся квестов в диалоге с торговцем. Аргументы:
*text - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*templ_name - имя шаблона выводимой картинки. Регистрируется в talk.xml. Если не указано - движок считает, что это "iconed_answer_item"<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_game_news(string, string, Frect, number, number)''' </div>
<div class="NavContent"><cpp>bool give_game_news(string news, string texture_name, Frect tex_rect, int delay, int show_time)</cpp>
выводит сообщение в виде новости. Аргументы:
*news - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*delay - задержка выдачи новости
*show_time - время показа новости<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fastcall(const function<boolean>& , object)''' </div>
<div class="NavContent"><cpp>void set_fastcall(const function<boolean>& , object)</cpp>
установка быстрого обработчика.<br /><br /></div></div>
Следующие методы проверяют, к кому применются, вызывать их следует только для актора.

<div class="NavFrame collapsed">
<div class="NavHead">'''function run_talk_dialog(game_object*)''' </div>
<div class="NavContent"><cpp>void run_talk_dialog(game_object* pToWho)</cpp>
запускает диалог между актором и объектом pToWho. Тот объект должен наследовать от класса CInventoryOwner. Разговор можно начать только если собеседник находится на расстоянии не больше трёх метров от актора. Если точнее, то можно попытаться вызвать её и на больших расстояниях. Что-то при этом происходит: появляется мышь, отключается движение актора и он начинает смотреть на "собеседника" даже при том, что окна разговора нет. Такое ощущение, что просто безбожно глючит. Проверка допустимого расстояния перед началом остаётся таким образом на совести скриптёра. Расстояние в 3 метра никакими настройками не изменить, похоже вшито прямо в код движка. Другой момент. Данная функция только открывает диалог разговора. Если не делать ничего дополнительно, то непись "разговаривая" пойдёт себе дальше, и как только выйдет за три метра - разговор прервётся. В игре непись удерживается от убегания специальной скриптовой схемой, которая заставляет его стоять на месте, смотреть на актора, может ещё анимации проигрывать, точно не знаю. Параметр need_osoznanie_mode в секции персонажа позволяет избежать ограничения в 3 метра на возможность начать разговор. Однако при этом окно разговора показывается не полностью. Отсутствуют окна с иконками собеседников и окно чата. Есть только нижняя часть - окно выбора варианта ответа или диалога. Фактически, это превращает окно общения в своеобразное диалоговое окно для выбора одного из нескольких вариантов. Это используется в игре для предоставления Меченому выбора - присоединяться к О-Сознанию или нет. В принципе ничто не мешает использовать это как-то иначе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_direction(number)''' </div>
<div class="NavContent"><cpp>void set_actor_direction(float dir)</cpp>
устанавливает для актора направление взгляда, передаваемое углом вращения dir (в радианах).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_position(vector)''' </div>
<div class="NavContent"><cpp>void set_actor_position(vector pos)</cpp>
устанавливает для актора координаты, передаваемые вектором pos.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function switch_to_trade()''' </div>
<div class="NavContent"><cpp>void switch_to_trade()</cpp>
активировать окно торговли в диалоге. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_holder()''' </div>
<div class="NavContent"><cpp>holder* get_current_holder()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором. Аргументов не принимает.<br /><br /></div></div>
='''CInventoryBox'''=
Эти методы можно применять только для ящиков с инвентарем.
<div class="NavFrame collapsed">
<div class="NavHead">'''function is_inv_box_empty()''' </div>
<div class="NavContent"><cpp>bool is_inv_box_empty()</cpp>
проверяет, пустой ли ящик с инвентарем. Аргументов не принимает.<br /><br /></div></div>
Появилось в ЧН
<div class="NavFrame collapsed">
<div class="NavHead">'''function iterate_inventory_box(function<void>, object)''' </div>
<div class="NavContent"><cpp>void iterate_inventory_box(function<void>, object)</cpp>
перебор предметов в ящике. Работает аналогично перебору по инвентарю актора.<br /><br /></div></div>

='''CSpaceRestrictor'''=
Эти методы можно применять только для спейс рестрикторов и аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&, number)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position, float epsilon) const</cpp>
возвращает true, если сфера с центром в position и радиусом epsilon персекается со спейс рестриктором. Аргументы:
*position - центр сферы, для которой проверяется пересечение со спейс-рестриктором (объект класса vector)
*epsilon - радиус сферы (float)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position) const</cpp>
см. inside(const vector&, number), epsilon берется по умолчанию 0,001.<br /><br /></div></div>
='''CCustomZone'''=
Эти методы можно применять только для аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function disable_anomaly()''' </div>
<div class="NavContent"><cpp>void disable_anomaly()</cpp>
отключает аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_anomaly()''' </div>
<div class="NavContent"><cpp>void enable_anomaly()</cpp>
активирует аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_anomaly_power()''' </div>
<div class="NavContent"><cpp>float get_anomaly_power()</cpp>
возвращает max_power для объекта аномалиию. Максимальное значение вроде 1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_anomaly_power(number)''' </div>
<div class="NavContent"><cpp>void set_anomaly_power(float p)</cpp>
устанавливает max_power для объекта аномалии. Установить можно любое значение. Аргументов не принимает.<br /><br /></div></div>
='''CLevelChanger (ЧН и ЗП)'''=
Эти методы можно применять только для аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function is_level_changer_enabled()''' </div>
<div class="NavContent"><cpp>bool is_level_changer_enabled()</cpp>
возвращает состояние перехода (включен/выключен). Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_level_changer(boolean)''' </div>
<div class="NavContent"><cpp>void enable_level_changer(bool val)</cpp>
включить/выключить переход.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_level_changer_invitation(string )''' </div>
<div class="NavContent"><cpp>void set_level_changer_invitation(string invitation)</cpp>
установить текст в окне запроса при переходе. Для ЗП не актуально.<br /><br /></div></div>
='''CScriptZone'''=
Эти методы можно применять только для подходит только для скриптовых зон. Но в игре их вроде нет.
<div class="NavFrame collapsed">
<div class="NavHead">'''function active_zone_contact(number)''' </div>
<div class="NavContent"><cpp>void active_zone_contact(int id)</cpp>
возвращает true, если зона находится в контакте с объектом с индексом id.<br /><br /></div></div>
='''CProjector'''=
Эти методы можно применять только для прожекторов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_direction()''' </div>
<div class="NavContent"><cpp>vector get_current_direction()</cpp>
возвращает текущее направление проектора. Аргументов не принимает.<br /><br /></div></div>
='''CHudItem'''=
Эти методы можно применять только для артефактов, гранат и оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function animation_slot()''' </div>
<div class="NavContent"><cpp>int animation_slot() const</cpp>
возвращает номер слота анимации для данного объекта. Это не слот в инвентаре! Примеры:
*для пистолета - 1
*для автомата - 2
*для дробовика - 3
*для артефакта - 11
*для бинокля - 13.<br /><br /></div></div>
='''CExplosive'''=
Эти методы можно применять только для гранат и канистр.
<div class="NavFrame collapsed">
<div class="NavHead">'''function explode(number)''' </div>
<div class="NavContent"><cpp>void explode(int level_time)</cpp>
подрывает итем. Несмотря на наличие аргумента level_time, он вроде в функции не используется, так что управлять подрывом не выйдет.<br /><br /></div></div>
='''CAttachableItem'''=
Эти методы можно применять для всех инвентарных предметов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function attachable_item_enabled()''' </div>
<div class="NavContent"><cpp>bool attachable_item_enabled() const</cpp>
возвращает, активен ли итем. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_attachable_item(boolean)''' </div>
<div class="NavContent"><cpp>void enable_attachable_item(bool value)</cpp>
делает активным/неактивным итем. Parent итема должен наследовать от класса CAttachmentOwner. Всегда активны: аптечки, бинты, детекторы, патроны для активного оружия, активное оружие. Короче, все то, что в слотах или на горяих клавишах.<br /><br /></div></div>
='''CInventoryItem'''=
Эти методы можно применять для тех инвентарных предметов, у которых параметр class в конфиге не равен II_ATTCH.
<div class="NavFrame collapsed">
<div class="NavHead">'''function cost() const''' </div>
<div class="NavContent"><cpp>int cost() const</cpp>
возвращает стоимость вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function condition() const''' </div>
<div class="NavContent"><cpp>int condition() const</cpp>
возвращает состояние вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_condition(number)''' </div>
<div class="NavContent"><cpp>void set_condition(int val)</cpp>
устанавливает состояние вещи.<br /><br /></div></div>
='''CTorch (только ЗП)'''=
Эти методы можно применять только для фонаря.
<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_night_vision(boolean)''' </div>
<div class="NavContent"><cpp>void enable_night_vision(bool val)</cpp>
включить/отключить ночное видение.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function night_vision_enabled() const''' </div>
<div class="NavContent"><cpp>bool night_vision_enabled() const</cpp>
возвращает состояние ночного видения. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_torch(boolean)''' </div>
<div class="NavContent"><cpp>void enable_torch(bool val)</cpp>
включить/отключить фонарь.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function torch_enabled() const''' </div>
<div class="NavContent"><cpp>bool torch_enabled() const</cpp>
возвращает состояние фонаря (включен/отключен). Аргументов не принимает.<br /><br /></div></div>
='''CWeapon'''=
Эти методы можно применять только для оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_total() const''' </div>
<div class="NavContent"><cpp>int get_ammo_total() const</cpp>
возвращает общее количество патронов для данного оружия в стволе и инвентаре, если ствол в инвентаре. Если не в инвентаре - просто количество патронов в обойме. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_in_magazine() const''' </div>
<div class="NavContent"><cpp>int get_ammo_in_magazine() const</cpp>
возвращает количество патронов в стволе. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_ammo_elapsed(number)''' </div>
<div class="NavContent"><cpp>void set_ammo_elapsed(int ammo_elapsed)</cpp>
заряжает магазин количеством патронов, равным ammo_elapsed. Размер магазина игнорируется.<br /><br /></div></div>

='''CWeaponMagazined'''=
Эти методы можно применять только для оружия - кроме ножа и гранат.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_queue_size(number)''' </div>
<div class="NavContent"><cpp>void set_queue_size(int queue_size)</cpp>
устанавливает размер очереди из оружия.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function unload_magazine()''' </div>
<div class="NavContent"><cpp>void unload_magazine()</cpp>
разряжает магазин оружия. Оружие должно быть в инвентаре/руках объекта CAI_Stalker. Патроны из ствола пропадают. Аргументов не принимает.<br /><br /></div></div>

='''Методы получения объектов "чистых" клиентских движковых классов'''=
Эти методы позволяют получить объект чистого движкового класса из объекта класса-обертки CScriptGameObject.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_car()''' </div>
<div class="NavContent"><cpp>CCar* get_car()</cpp>
возвращает объект машины.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_holder_class()''' </div>
<div class="NavContent"><cpp>holder* get_holder_class()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_hanging_lamp()''' </div>
<div class="NavContent"><cpp>hanging_lamp* get_hanging_lamp()</cpp>
озвращает объект лампочки.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_helicopter()''' </div>
<div class="NavContent"><cpp>CHelicopter* get_helicopter()</cpp>
возвращает объект вертолета.<br /><br /></div></div>
Следующие методы присутствуют начиная с ЧН.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_campfire()''' </div>
<div class="NavContent"><cpp>CZoneCampfire* get_campfire()</cpp>
возвращает объект костра.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_artefact()''' </div>
<div class="NavContent"><cpp>CArtefact* get_artefact()</cpp>
возвращает объект артефакта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_object()''' </div>
<div class="NavContent"><cpp>CPhysicObject* get_physics_object()</cpp>
возвращает объект физических предметов (ящики, коробки).<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 17:35, 19 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть V.

2011-12-19T17:29:03Z

K.D.: /* CInventoryBox */

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CAI_PhraseDialogManager'''=
Эти методы можно применять только для сталкеров и торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_default_start_dialog()''' </div>
<div class="NavContent"><cpp>void restore_default_start_dialog()</cpp>
устанавливает стартовый диалог неписю дефолтным. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog(string)''' </div>
<div class="NavContent"><cpp>void set_start_dialog(string dialog_id)</cpp>
устанавливает диалог dialog_id неписю в качестве стартового диалога.<br /><br /></div></div>

='''CAI_Trader'''=
Эти методы можно применять только для торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function external_sound_start(string)''' </div>
<div class="NavContent"><cpp>void external_sound_start(string sound)</cpp>
вроде как включает для торговца звук sound, но останавливает анимацию головы. Используется в начальном туторе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog()''' </div>
<div class="NavContent"><cpp>void external_sound_stop()</cpp>
станавливает звук торговца. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_global_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_global_anim(string anim)</cpp>
устанавливает анимацию anim для тела торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_head_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_head_anim(string anim)</cpp>
устанавливает анимацию anim для головы торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_sound(string, string)''' </div>
<div class="NavContent"><cpp>void set_trader_sound(string sound, string anim)</cpp>
устанавливает торговцу анимацию головы anim и включает в голове звук sound.<br /><br /></div></div>

='''CActor'''=
Эти методы можно работают для актора.<br />Следующие методы не проверяют свой неявный аргумент, так что их можно применять хоть к бочкам. Объект в них берется с помощью actor()
<div class="NavFrame collapsed">
<div class="NavHead">'''function give_task(CGameTask*, number, boolean)''' </div>
<div class="NavContent"><cpp>void give_task(CGameTask* t, int dt, bool bCheckExisting)</cpp>
выдает актору задание. Аргументы:
*t - задание в виде объекта CGameTask. Можно взять методом CGameTask() и загрузить в него данные методом load().
*dt - время на завершение
*bCheckExisting - проверять ли на наличие. Если bCheckExisting == true, то задание, при его присутствии у актора не выдается, в противном случае инициализируется заново.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_task_state(string, number)''' </div>
<div class="NavContent"><cpp>task get_task_state(string task_id, int objective_num)</cpp>
возвращает состояние задания (поле task_state) для задания task_id и подзадания objective_num. Возвращает константу из класса-перечисления task.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_task_state(enum ETaskState, string, number)''' </div>
<div class="NavContent"><cpp>void set_task_state(enum ETaskState state, string task_id, int objective_num)</cpp>
устанавливает у подзадания таска одно из выбранных состояний. Аргументы:
*state - состояние (константа из класса-перечисления task)
*task_id - таск
*objective_num - номер подзадания <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function hide_weapon()''' </div>
<div class="NavContent"><cpp>void hide_weapon()</cpp>
спрятать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_weapon()''' </div>
<div class="NavContent"><cpp>void restore_weapon()</cpp>
достать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function eat(game_object*)''' </div>
<div class="NavContent"><cpp>void eat(game_object* item)</cpp>
заставляет актора съесть предмет item. Предмет должен наследовать от класса CEatableItem.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_talk_message(string, string, Frect, string)''' </div>
<div class="NavContent"><cpp>void give_talk_message(string text, string texture_name, Frect tex_rect, string templ_name)</cpp>
выводит сообщение в диалоговое окно. Пример - вывод списка доступных повторяющихся квестов в диалоге с торговцем. Аргументы:
*text - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*templ_name - имя шаблона выводимой картинки. Регистрируется в talk.xml. Если не указано - движок считает, что это "iconed_answer_item"<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_game_news(string, string, Frect, number, number)''' </div>
<div class="NavContent"><cpp>bool give_game_news(string news, string texture_name, Frect tex_rect, int delay, int show_time)</cpp>
выводит сообщение в виде новости. Аргументы:
*news - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*delay - задержка выдачи новости
*show_time - время показа новости<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fastcall(const function<boolean>& , object)''' </div>
<div class="NavContent"><cpp>void set_fastcall(const function<boolean>& , object)</cpp>
установка быстрого обработчика.<br /><br /></div></div>
Следующие методы проверяют, к кому применются, вызывать их следует только для актора.

<div class="NavFrame collapsed">
<div class="NavHead">'''function run_talk_dialog(game_object*)''' </div>
<div class="NavContent"><cpp>void run_talk_dialog(game_object* pToWho)</cpp>
запускает диалог между актором и объектом pToWho. Тот объект должен наследовать от класса CInventoryOwner. Разговор можно начать только если собеседник находится на расстоянии не больше трёх метров от актора. Если точнее, то можно попытаться вызвать её и на больших расстояниях. Что-то при этом происходит: появляется мышь, отключается движение актора и он начинает смотреть на "собеседника" даже при том, что окна разговора нет. Такое ощущение, что просто безбожно глючит. Проверка допустимого расстояния перед началом остаётся таким образом на совести скриптёра. Расстояние в 3 метра никакими настройками не изменить, похоже вшито прямо в код движка. Другой момент. Данная функция только открывает диалог разговора. Если не делать ничего дополнительно, то непись "разговаривая" пойдёт себе дальше, и как только выйдет за три метра - разговор прервётся. В игре непись удерживается от убегания специальной скриптовой схемой, которая заставляет его стоять на месте, смотреть на актора, может ещё анимации проигрывать, точно не знаю. Параметр need_osoznanie_mode в секции персонажа позволяет избежать ограничения в 3 метра на возможность начать разговор. Однако при этом окно разговора показывается не полностью. Отсутствуют окна с иконками собеседников и окно чата. Есть только нижняя часть - окно выбора варианта ответа или диалога. Фактически, это превращает окно общения в своеобразное диалоговое окно для выбора одного из нескольких вариантов. Это используется в игре для предоставления Меченому выбора - присоединяться к О-Сознанию или нет. В принципе ничто не мешает использовать это как-то иначе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_direction(number)''' </div>
<div class="NavContent"><cpp>void set_actor_direction(float dir)</cpp>
устанавливает для актора направление взгляда, передаваемое углом вращения dir (в радианах).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_position(vector)''' </div>
<div class="NavContent"><cpp>void set_actor_position(vector pos)</cpp>
устанавливает для актора координаты, передаваемые вектором pos.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function switch_to_trade()''' </div>
<div class="NavContent"><cpp>void switch_to_trade()</cpp>
активировать окно торговли в диалоге. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_holder()''' </div>
<div class="NavContent"><cpp>holder* get_current_holder()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором. Аргументов не принимает.<br /><br /></div></div>
='''CInventoryBox'''=
Эти методы можно применять только для ящиков с инвентарем.
<div class="NavFrame collapsed">
<div class="NavHead">'''function is_inv_box_empty()''' </div>
<div class="NavContent"><cpp>bool is_inv_box_empty()</cpp>
проверяет, пустой ли ящик с инвентарем. Аргументов не принимает.<br /><br /></div></div>
Появилось в ЧН
<div class="NavFrame collapsed">
<div class="NavHead">'''function iterate_inventory_box(function<void>, object)''' </div>
<div class="NavContent"><cpp>void iterate_inventory_box(function<void>, object)</cpp>
перебор предметов в ящике. Работает аналогично перебору по инвентарю актора.<br /><br /></div></div>

='''CSpaceRestrictor'''=
Эти методы можно применять только для спейс рестрикторов и аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&, number)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position, float epsilon) const</cpp>
возвращает true, если сфера с центром в position и радиусом epsilon персекается со спейс рестриктором. Аргументы:
*position - центр сферы, для которой проверяется пересечение со спейс-рестриктором (объект класса vector)
*epsilon - радиус сферы (float)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position) const</cpp>
см. inside(const vector&, number), epsilon берется по умолчанию 0,001.<br /><br /></div></div>
='''CCustomZone'''=
Эти методы можно применять только для аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function disable_anomaly()''' </div>
<div class="NavContent"><cpp>void disable_anomaly()</cpp>
отключает аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_anomaly()''' </div>
<div class="NavContent"><cpp>void enable_anomaly()</cpp>
активирует аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_anomaly_power()''' </div>
<div class="NavContent"><cpp>float get_anomaly_power()</cpp>
возвращает max_power для объекта аномалиию. Максимальное значение вроде 1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_anomaly_power(number)''' </div>
<div class="NavContent"><cpp>void set_anomaly_power(float p)</cpp>
устанавливает max_power для объекта аномалии. Установить можно любое значение. Аргументов не принимает.<br /><br /></div></div>
='''CScriptZone'''=
Эти методы можно применять только для подходит только для скриптовых зон. Но в игре их вроде нет.
<div class="NavFrame collapsed">
<div class="NavHead">'''function active_zone_contact(number)''' </div>
<div class="NavContent"><cpp>void active_zone_contact(int id)</cpp>
возвращает true, если зона находится в контакте с объектом с индексом id.<br /><br /></div></div>
='''CProjector'''=
Эти методы можно применять только для прожекторов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_direction()''' </div>
<div class="NavContent"><cpp>vector get_current_direction()</cpp>
возвращает текущее направление проектора. Аргументов не принимает.<br /><br /></div></div>
='''CHudItem'''=
Эти методы можно применять только для артефактов, гранат и оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function animation_slot()''' </div>
<div class="NavContent"><cpp>int animation_slot() const</cpp>
возвращает номер слота анимации для данного объекта. Это не слот в инвентаре! Примеры:
*для пистолета - 1
*для автомата - 2
*для дробовика - 3
*для артефакта - 11
*для бинокля - 13.<br /><br /></div></div>
='''CExplosive'''=
Эти методы можно применять только для гранат и канистр.
<div class="NavFrame collapsed">
<div class="NavHead">'''function explode(number)''' </div>
<div class="NavContent"><cpp>void explode(int level_time)</cpp>
подрывает итем. Несмотря на наличие аргумента level_time, он вроде в функции не используется, так что управлять подрывом не выйдет.<br /><br /></div></div>
='''CAttachableItem'''=
Эти методы можно применять для всех инвентарных предметов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function attachable_item_enabled()''' </div>
<div class="NavContent"><cpp>bool attachable_item_enabled() const</cpp>
возвращает, активен ли итем. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_attachable_item(boolean)''' </div>
<div class="NavContent"><cpp>void enable_attachable_item(bool value)</cpp>
делает активным/неактивным итем. Parent итема должен наследовать от класса CAttachmentOwner. Всегда активны: аптечки, бинты, детекторы, патроны для активного оружия, активное оружие. Короче, все то, что в слотах или на горяих клавишах.<br /><br /></div></div>
='''CInventoryItem'''=
Эти методы можно применять для тех инвентарных предметов, у которых параметр class в конфиге не равен II_ATTCH.
<div class="NavFrame collapsed">
<div class="NavHead">'''function cost() const''' </div>
<div class="NavContent"><cpp>int cost() const</cpp>
возвращает стоимость вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function condition() const''' </div>
<div class="NavContent"><cpp>int condition() const</cpp>
возвращает состояние вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_condition(number)''' </div>
<div class="NavContent"><cpp>void set_condition(int val)</cpp>
устанавливает состояние вещи.<br /><br /></div></div>
='''CWeapon'''=
Эти методы можно применять только для оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_total() const''' </div>
<div class="NavContent"><cpp>int get_ammo_total() const</cpp>
возвращает общее количество патронов для данного оружия в стволе и инвентаре, если ствол в инвентаре. Если не в инвентаре - просто количество патронов в обойме. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_in_magazine() const''' </div>
<div class="NavContent"><cpp>int get_ammo_in_magazine() const</cpp>
возвращает количество патронов в стволе. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_ammo_elapsed(number)''' </div>
<div class="NavContent"><cpp>void set_ammo_elapsed(int ammo_elapsed)</cpp>
заряжает магазин количеством патронов, равным ammo_elapsed. Размер магазина игнорируется.<br /><br /></div></div>

='''CWeaponMagazined'''=
Эти методы можно применять только для оружия - кроме ножа и гранат.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_queue_size(number)''' </div>
<div class="NavContent"><cpp>void set_queue_size(int queue_size)</cpp>
устанавливает размер очереди из оружия.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function unload_magazine()''' </div>
<div class="NavContent"><cpp>void unload_magazine()</cpp>
разряжает магазин оружия. Оружие должно быть в инвентаре/руках объекта CAI_Stalker. Патроны из ствола пропадают. Аргументов не принимает.<br /><br /></div></div>

='''Методы получения объектов "чистых" клиентских движковых классов'''=
Эти методы позволяют получить объект чистого движкового класса из объекта класса-обертки CScriptGameObject.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_car()''' </div>
<div class="NavContent"><cpp>CCar* get_car()</cpp>
возвращает объект машины.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_holder_class()''' </div>
<div class="NavContent"><cpp>holder* get_holder_class()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_hanging_lamp()''' </div>
<div class="NavContent"><cpp>hanging_lamp* get_hanging_lamp()</cpp>
озвращает объект лампочки.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_helicopter()''' </div>
<div class="NavContent"><cpp>CHelicopter* get_helicopter()</cpp>
возвращает объект вертолета.<br /><br /></div></div>
Следующие методы присутствуют начиная с ЧН.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_campfire()''' </div>
<div class="NavContent"><cpp>CZoneCampfire* get_campfire()</cpp>
возвращает объект костра.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_artefact()''' </div>
<div class="NavContent"><cpp>CArtefact* get_artefact()</cpp>
возвращает объект артефакта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_object()''' </div>
<div class="NavContent"><cpp>CPhysicObject* get_physics_object()</cpp>
возвращает объект физических предметов (ящики, коробки).<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 18:04, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть II.

2011-12-19T17:09:39Z

K.D.: /* CCustomMonster */

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CCustomMonster'''=
Эти методы можно применять только для сталкеров и монстров.
<div class="NavFrame collapsed">
<div class="NavHead">'''function best_danger()''' </div>
<div class="NavContent"><cpp>danger_object* best_danger()</cpp>
возвращает лучший дэнжер в виде объекта класса danger_object. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_enemy()''' </div>
<div class="NavContent"><cpp>game_object* best_enemy()</cpp>
возвращает объект врага. Работает для сталкеров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_item()''' </div>
<div class="NavContent"><cpp>game_object* best_item()</cpp>
вроде как возвращает объект тушки, которую можно пожевать. Точно неизвестно. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_enemy() const''' </div>
<div class="NavContent"><cpp>game_object* get_enemy() const</cpp>
возвращает объект текущего врага. Работает для монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_position(const game_object&)''' </div>
<div class="NavContent"><cpp>vector memory_position(const game_object& lua_game_object)</cpp>
возвращает позицию (в виде объекта класса vector), на которой последний раз был видим объект lua_game_object нашим объектом. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_time(const game_object&)''' </div>
<div class="NavContent"><cpp>int memory_time(const game_object& lua_game_object)</cpp>
возвращает время, когда последний раз был видим объект lua_game_object нашим объектом, в игровых мс. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_memory_object(game_object*, boolean)''' </div>
<div class="NavContent"><cpp>void enable_memory_object(game_object* lua_game_object, bool enable)</cpp>
включает/отключает объект в памяти монстра/сталкера. В игре используется для форсированного "забывания" врага при его долговременном отсутствии. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_hit_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_hit_objects() const</cpp>
возвращает итератор объектов, которые когда-либо наносили хит. Объекты имеют тип hit_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_hit_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_sound_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_sound_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были слышимы. Объекты имеют тип sound_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_sound_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_visible_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были видимы. Объекты имеют тип visible_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function not_yet_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator not_yet_visible_objects() const</cpp>
возвращает итератор объектов, которые видны или собираются быть видны. Объекты имеют тип not_yet_visible_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:not_yet_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function change_team(number, number, number)''' </div>
<div class="NavContent"><cpp>void change_team(int team, int squad, int group)</cpp>
меняет для объекта team, squad и group.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function see(string)''' </div>
<div class="NavContent"><cpp>bool see(string section_name)</cpp>
проверяет, есть ли среди массива видимых объектов объект с именем секции, равной section_name.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fov(number)''' </div>
<div class="NavContent"><cpp>void set_fov(float new_fov)</cpp>
устанавливает угол зрения, равный значению new_fov.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_range(number)''' </div>
<div class="NavContent"><cpp>void set_range(float new_range)</cpp>
устанавливает максимальную ширину видимой области, равный значению new_range.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vertex_in_direction(number, vector, number) const''' </div>
<div class="NavContent"><cpp>int vertex_in_direction(int level_vertex_id, vector direction, float max_distance) const</cpp>
возвращает lvid наиболее удаленной точки, доступной неписю в направлении direction. Аргументы:
*level_vertex_id - ближайший к объекту левел вертекс
*direction - направление, в котором надо получить точку
*max_distance - диаметр сферы с центром в level_vertex_id, в которой ищутся доступные вертексы.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible_nearest(const vector&, vector&)''' </div>
<div class="NavContent"><cpp>int accessible_nearest(const vector& position, vector& result)</cpp>
возвращает ближайший к точке position левел вертекс. В память по указателю result записываются координаты этого вертекса.<br />Пример использования:<lua>local pos = npc:position()
local res = vector():set(0,0,0)
local lvid = npc:accessible_nearest(pos, res)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(const vector&)''' </div>
<div class="NavContent"><cpp>bool accessible(const vector& position)</cpp>
возвращает true, если точка position находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(number)''' </div>
<div class="NavContent"><cpp>bool accessible(int level_vertex_id)</cpp>
возвращает true, если вертекс level_vertex_id находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void add_restrictions(string out, string in)</cpp>
добавляет объекту рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_in_restrictions()''' </div>
<div class="NavContent"><cpp>string base_in_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_out_restrictions()''' </div>
<div class="NavContent"><cpp>string base_out_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function in_restrictions()''' </div>
<div class="NavContent"><cpp>string in_restrictions()</cpp>
возвращает список рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function out_restrictions()''' </div>
<div class="NavContent"><cpp>string out_restrictions()</cpp>
возвращает список рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_all_restrictions()''' </div>
<div class="NavContent"><cpp>string remove_all_restrictions()</cpp>
удаляет все рестрикторы 4 и 5 типов. Устанавливает in_restrictions и out_restrictions пустыми.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void remove_restrictions(string out, string in);</cpp>
удаляет рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую. Есть особенность: обязательно должен быть задан аргумент out, иначе функция не будет работать (хотя и не вылетит)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function critically_wounded()''' </div>
<div class="NavContent"><cpp>bool critically_wounded()</cpp>
возвращает true, если объект критически ранен.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled(boolean)''' </div>
<div class="NavContent"><cpp>void movement_enabled(bool enable)</cpp>
разрешает/запрещает объекту движение.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled()''' </div>
<div class="NavContent"><cpp>bool movement_enabled()</cpp>
возвращает true, если объекту разрешено двигаться по пути.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_point_index()''' </div>
<div class="NavContent"><cpp>int get_current_point_index()</cpp>
возвращает номер текущей точки пути (lvid).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function is_body_turning()''' </div>
<div class="NavContent"><cpp>int is_body_turning()</cpp>
возвращает true, если объект поворачивается. Сравнивается текущее и целевое направление, разница между ними сравнивается с 0,00001 и если разница больше, то возвращается true. Для сталкеров возвращает true, даже если он просто вертит башкой.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function location_on_path(number, vector*)''' </div>
<div class="NavContent"><cpp>int location_on_path(float distance, vector* location)</cpp>
возвращает координаты точки пути объекта, которая отстоит от следующей точки пути более, чем на расстояние distance. Аргументы:
*distance - расстояние между точками (float)
*location - в этот вектор пишутся вычисленные кординаты.
Непосредственно функция возвращает level_vertex_id найденной точки. Также, если у непися нет активного пути или он стоит в последней точке пути, или между всеми точками пути расстояние меньше, чем distance, возвратятся его координаты и вертекс<br />Примеры использования:<lua>
local dist = 5
local location = vector():set(0,0,0)
local lvid = npc:location_on_path(dist, location)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function path_completed()''' </div>
<div class="NavContent"><cpp>bool path_completed()</cpp>
возвращает true, если путь завершен объектом. false если нет.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function patrol_path_make_inactual()''' </div>
<div class="NavContent"><cpp>void patrol_path_make_inactual()</cpp>
делает текущий путь завершенным.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_point(number)''' </div>
<div class="NavContent"><cpp>void set_start_point(int point_index)</cpp>
установить начальную точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_previous_point(number)''' </div>
<div class="NavContent"><cpp>void set_previous_point(int point_index)</cpp>
установить предыдущую точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count(boolean)''' </div>
<div class="NavContent"><cpp>int active_sound_count(bool only_playing)</cpp>
возвращает количество проигрываемых звуков. Если only_playing = false, то вернет еще и количество звуков в очереди.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count()''' </div>
<div class="NavContent"><cpp>int active_sound_count()</cpp>
см active_sound_count(boolean). Параметр only_playing по умолчанию false <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number, string)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type, string bone_name)</cpp>
инициализирует для объекта еще один звук. Аргументы:
*prefix - sound_prefix звука
*max_count - ???
*type - тип звука. Возможные значения см в классе-перечислении snd_type.
*priority - ???
*mask - ???
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*bone_name - кость, от которой будет играться звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type)</cpp>
см. add_sound(string, number, enum ESoundTypes, number, number, number, string). Аргумент bone_name по умолчанию bip01_head.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time, int id)</cpp>
проигрывает от объекта звук. Аргументы:
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*max_start_time, min_start_time - максимальное и минимальное время задержки запуска звука. Если грубо - между ними берется рандомное значение, к нему прибавляется текущее время и результат устанавливается началом запуска звука
*max_stop_time, min_stop_time - аналогично start_time. Время окончания устанавливается равным текущему времени + start_time + stop_time + длительность звука
*id - вроде как номер темы. Из этой темы движок выбирает рандомный звук. Если -1 - будет выбрана рандомная фраза, инициализированная для объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number, number). Аргумент id по умолчанию берется -1.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number). Аргумент min_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time)</cpp>
см.выше function play_sound(number, number, number, number). Аргумент max_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time)</cpp>
см.выше function play_sound(number, number, number). Аргумент min_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type)</cpp>
см.выше function play_sound(number, number). Аргумент max_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_sound_threshold()''' </div>
<div class="NavContent"><cpp>void restore_sound_threshold()</cpp>
восстанавливает дефолтный sound_threshold - порог громкости, при котором непись слышит звук. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_sound_threshold(float value)</cpp>
устанавливает sound_threshold - порог громкости, при котором непись слышит звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_sound(number)''' </div>
<div class="NavContent"><cpp>void remove_sound(int internal_type)</cpp>
стереть тему с индексом id из списка разрешенных для персонажа.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_mask(number)''' </div>
<div class="NavContent"><cpp>void set_sound_mask(int sound_mask)</cpp>
устанавливает sound_mask.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix(string)''' </div>
<div class="NavContent"><cpp>void sound_prefix(string sound_prefix)</cpp>
устанавливает sound_prefix объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_prefix() const</cpp>
возвращает sound_prefix объекта. sound_prefix - папка со звуками для данного объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_voice_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_voice_prefix() const</cpp>
возвращает sound_voice_prefix объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function visibility_threshold() const''' </div>
<div class="NavContent"><cpp>float visibility_threshold() const</cpp>
возвращает максимальное расстояние, на котором объект видит другие объекты. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vision_enabled() const''' </div>
<div class="NavContent"><cpp>bool vision_enabled() const</cpp>
проверяет, включено ли запоминание видимых объектов. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_vision(boolean)''' </div>
<div class="NavContent"><cpp>void enable_vision(bool value)</cpp>
включить/выключить запись видимых объектов в память.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length(number)''' </div>
<div class="NavContent"><cpp>void extrapolate_length(float extrapolate_length)</cpp>
устанавливает m_extrapolate_length равным extrapolate_length. Что это - непонятно, но имеет отношение к CDetailPathManager.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length()''' </div>
<div class="NavContent"><cpp>float extrapolate_length()</cpp>
возвращает m_extrapolate_length. Имеет отношение к CDetailPathManager.<br /><br /></div></div>
Добавлено в ЧН
<div class="NavFrame collapsed">
<div class="NavHead">'''function invulnerable() const''' </div>
<div class="NavContent"><cpp>bool invulnerable() const</cpp>
возвращает состояние режима неуязвимости.<br /><br /></div></div>
<div class="NavFrame collapsed">

<div class="NavHead">'''function invulnerable(boolean)''' </div>
<div class="NavContent"><cpp>void invulnerable(bool value)</cpp>
включить/отключить режим неуязвимости.<br /><br /></div></div>

='''CBaseMonster'''=
Эти методы можно применять только для монстров.

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_corpse()''' </div>
<div class="NavContent"><cpp>game_object* get_corpse()</cpp>
возвращает объект трупа в ближайшем радиусе вокруг монстра, причем класс объекта эквивалентен CEntity. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_monster_hit_info()''' </div>
<div class="NavContent"><cpp>MonsterHitInfo* get_monster_hit_info()</cpp>
возвращает объект класса MonsterHitInfo, содержащий информацию о последнем, кто бил по монстру. Аргументов не принимает.
<cpp>class MonsterHitInfo {
vector direction; //направление хита
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект нанесшего хит.
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_sound_info()''' </div>
<div class="NavContent"><cpp>SoundInfo* get_sound_info()</cpp>
возвращает объект SoundInfo, содержащий информацию о последнем услышанном звуке. Аргументов не принимает.
<cpp>class MonsterHitInfo {
bool danger; //опасен ли звук. У меня получалось true, если издающй звук объект еще и наносит хит. Если стрелять в воздух, монстр "не боится".
vector position; //координаты звука
float power; //сила звука
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект издавшего звука
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_home()''' </div>
<div class="NavContent"><cpp>void remove_home()</cpp>
удаление точки "выпаса" монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_custom_panic_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_custom_panic_threshold(float value)</cpp>
установить порог паники, равным value.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_default_panic_threshold()''' </div>
<div class="NavContent"><cpp>void set_default_panic_threshold()</cpp>
вернуть порог паники по умолчанию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_home(string, number, number, boolean)''' </div>
<div class="NavContent"><cpp>void set_home(string name, float r_min, float r_max, bool aggressive)</cpp>
установить точку "выпаса" монстров. Аргументы:
*name - имя пути
*r_min - минимальный радуис беготни вокруг точки
*r_max - максимальный радиус удаления от точки
*aggressive - аггресивность монстров.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function skip_transfer_enemy(boolean)''' </div>
<div class="NavContent"><cpp>void skip_transfer_enemy(bool val)</cpp>
управляет передачей врагов от друзей. Если установлено в true и видит дружественного монстра, то его враги также становятся врагами.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function character_rank()''' </div>
<div class="NavContent"><cpp>int character_rank()</cpp>
возвращает ранг объекта. Также работает и для объектов-наследников CInventoryOwner. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function jump(const vector&, number)''' </div>
<div class="NavContent"><cpp>void jump(const vector& position, float factor)</cpp>
заставляет объект прыгнуть. Работает только для снорков. Аргументы:
*position - конечные координаты прыжка.
*factor - точно трудно сказать, но похоже, что время прыжка.<br /><br /></div></div>
='''CAI_Bloodsucker'''=
Эти методы можно применять только для кровососа.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_alien_control(boolean)''' </div>
<div class="NavContent"><cpp>void set_alien_control(bool val)</cpp>
устанавливает камеру актера в положение "от глаз монстра" и обратно.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_invisible(boolean)''' </div>
<div class="NavContent"><cpp>void set_invisible(bool val)</cpp>
управляет невидимостью. true - установить, false - убрать.<br /><br /></div></div>
='''CAI_Zombie'''=
Эти методы можно применять только для зомби.
<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_fall_down()''' </div>
<div class="NavContent"><cpp>boolean fake_death_fall_down()</cpp>
проигрывает у зомби анимацию ложной смерти. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_stand_up()''' </div>
<div class="NavContent"><cpp>boolean fake_death_stand_up()</cpp>
проигрывает у зомби анимацию вставания. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 17:21, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть I.

2011-12-19T17:01:01Z

K.D.: /* CObject */

'''Game_object''' - класс для доступа к онлайновым (клиентским) объектам. Причём один класс является интерфейсом для совершенно разных объектов. Разработчики не придумали ничего лучше, как взять и объединить в одном классе все интерфейсы всех клиентских объектов: актора, сталкеров, монстров, физических объектов, автомобилей и лампочек, вообще всех. Более странного и вообще говоря уродливого объектно-ориентированного дизайна я ещё не видел. Во-первых, класс вышел совершенно необозримым - три сотни методов! Во-вторых, вызов не подходящего метода для произвольно взятого объекта приводит к совершенно непредсказуемым результатам. В лучшем случае не будет ничего, а чаще всего - будет вылет, причём обычно без лога. Наконец, описание этого класса в lua_help совершенно невнятное (как впрочем и всех остальных классов): типы возвращаемых значений опущены, типы входных аргументов указаны не всегда, а о назначении большинства методов можно только гадать. Предлагаю несколько более внятное описание. Методы рассортированы по клиентским классам, к объектам которых можно применить метод. Также напоминаю, что классы при наследовании также наследуют и все методы родительского класса.
{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
= '''ANY CLASS''' =
Эти методы подходят к объектам любого класса<br /><br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function direction() const''' </div>
<div class="NavContent"><cpp>vector direction() const</cpp>
возвращает направление взгляда (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function position() const''' </div>
<div class="NavContent"><cpp>vector position() const</cpp>
возвращает координаты объекта (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function center() const''' </div>
<div class="NavContent"><cpp>vector center()</cpp>
возвращает координаты центра баунд сферы объекта (физической оболочки, грубо говоря). Практически то же самое, что и position. Обычно используется для проверки вхождения актора в сферу. Возвращает объект класса vector. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function game_vertex_id() const''' </div>
<div class="NavContent"><cpp>int game_vertex_id() const</cpp>
возвращает game_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_id() const''' </div>
<div class="NavContent"><cpp>int level_vertex_id() const</cpp>
возвращает level_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_light() const''' </div>
<div class="NavContent"><cpp>float level_vertex_light(const int level_vertex_id) const</cpp>
Только ТЧ. всегда возвращает 0. Что-то связанное с аи-сеткой, но, видимо, нынче бесполезное.<br /><br /></div></div>
<br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function id() const''' </div>
<div class="NavContent"><cpp>int id() const</cpp>
возвращает id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function name() const''' </div>
<div class="NavContent"><cpp>string name() const</cpp>
возвращает системное имя объекта (обычно выглядит как комбинация имени секции и id). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function section() const''' </div>
<div class="NavContent"><cpp>string section() const</cpp>
возвращает имя секции объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function spawn_ini() const''' </div>
<div class="NavContent"><cpp>ini_file* spawn_ini() const</cpp>
возвращает дескриптор ltx файла (объект класса ini_file), из которого вычитывались настройки спавна объекта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function story_id() const''' </div>
<div class="NavContent"><cpp>int story_id() const</cpp>
возвращает story_id (уникальный идентификатор) объекта. Аргументов не принимает. Если у объекта нет story_id, возвращает -1.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function clsid() const''' </div>
<div class="NavContent"><cpp>int clsid() const</cpp>
возвращает clsid объекта, представляющий собой идентификатор класса. Возвращаемое значение является числовым эквивалентом строкового идентификатора, заданного в конфиге объекта параметром class. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bone_position(string) const''' </div>
<div class="NavContent"><cpp>vector bone_position(string bone_name) const</cpp>
возвращает координаты кости. Принимает один аргумент - имя кости. Может быть применен к любому объекту, но модель объекта при этом должна иметь тип '''MT_SKELETON_ANIM''' или '''MT_SKELETON_RIGID''', короче, иметь эти самые кости<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function binded_object()''' </div>
<div class="NavContent"><cpp>object_binder* binded_object()</cpp>
возвращает объект lua-класса object_binder, привязанный к биндеру функцией bind_object(). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bind_object(object_binder*)''' </div>
<div class="NavContent"><cpp>void bind_object(object_binder* game_object)</cpp>
привязывает объект к биндеру. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<br />
<div class="NavHead">'''function hit(hit*)''' </div>
<div class="NavContent"><cpp>void hit(hit* tpLuaHit)</cpp>
наносит хит объекту. В качестве аргумента передается объект класса hit. У этого объекта обязательно должны быть выставлены свойства '''''draftsman''''', '''''power''''', '''''direction''''', '''''type''''', '''''impulse'''''<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string, boolean)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim, bool mix_in)</cpp>
проигрывает анимацию для объекта. Аргументы:
*anim - имя анимации
*mix_in - как я понял, устанавливает наложение анимации на текущую.
Сам объект может быть любым, но модель объекта должна иметь тип '''MT_SKELETON_ANIM''' (то есть поддерживать анимации).<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim)</cpp>
аналогично предыдущей, mix_in по умолчанию берется true.<br /><br /></div></div>
='''CObject'''=
Поскольку все игровые объекты наследуют от класса '''''CObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function parent() const''' </div>
<div class="NavContent"><cpp>game_object* parent() const</cpp>
возвращает parent объекта. Для предмета в ящике вернет объект ящика. Для инвентарных предметов вернет объект владельца инвентаря - актора, сталкера или монстра. Во всех остальных случаях возвратится 0. К полученному объекту можно применять все методы game_object, подходящие к классу объекта. Аргументов не принимает.<br /><br /></div></div>
Добавлено в ЗП:
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_visual_name() const''' </div>
<div class="NavContent"><cpp>string get_visual_name() const</cpp>
возвращает визуал объекта в виде имени модели. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_visual_name(string)''' </div>
<div class="NavContent"><cpp>void set_visual_name(string visual_name)</cpp>
устанавливает визуал объекта. В качестве аргумента необходимо задавать полный путь до модели от папки meshes.<br /><br /></div></div>

='''CUsableScriptObject'''=
Поскольку все игровые объекты наследуют от класса '''''CUsableScriptObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text(string)''' </div>
<div class="NavContent"><cpp>void set_tip_text(string tip_text)</cpp>
устанавливает для объекта текст всплывающей подсказки, передаваемый аргументом tip_text.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text_default()''' </div>
<div class="NavContent"><cpp>void set_tip_text_default()</cpp>
устанавливает для объекта дефолтный текст всплывающей подсказки, установленный при спавне. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_nonscript_usable(boolean)''' </div>
<div class="NavContent"><cpp>void set_nonscript_usable(bool nonscript_usable)</cpp>
устанавливает для объекта возможность взаимодействия с актором.<br /><br /></div></div>
='''CPhysicsShellHolder'''=
Эти методы можно применять для всех объектов, кроме аномалий, переходов, ящиков с инвентарем и прожекторов - всего того, у чего нет физической оболочки.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_shell() const''' </div>
<div class="NavContent"><cpp>physics_shell* get_physics_shell() const</cpp>
возвращает физическую оболочку объекта - объект класса physics_shell. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_const_force(const vector&, number, number)''' </div>
<div class="NavContent"><cpp>void set_const_force(const vector& dir, float value, int time_interval)</cpp>
применяет к физической оболочке объекта силу на некоторое время. Аргументы:
*dir - направление (объект класса vector)
*value - значение силы (float)
*time_interval - продолжительность действия силы (int).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function mass() const''' </div>
<div class="NavContent"><cpp>float mass() const</cpp>
возвращает массу объекта. При применении к неподходящему объекту возвращает -1. Масса, возвращаемая этим методом - не инвентарная, а, видимо, масса для обсчета коллизий. Для патронов, оружия возвращается 0. Аргументов не принимает.<br /><br /></div></div>
='''CEntity'''=
Эти методы можно применять для всех живых объектов (сталкеры, монстры, актор), вертолетов и машин.
<div class="NavFrame collapsed">
<div class="NavHead">'''function alive() const''' </div>
<div class="NavContent"><cpp>bool alive() const</cpp>
возвращает, жив ли объект (проверка на health > 0.0). Для неживых объектов возвращает false. Внимание! health обновляется с некоторым периодом, поэтому при вызове alive() сразу после kill() выдается true. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function death_time() const''' </div>
<div class="NavContent"><cpp>int death_time() const</cpp>
в ЗП нет. Возвращает время смерти объекта в мсек с начала игры. Если объект жив или в принципе неживой, возвратит 0. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function group() const''' </div>
<div class="NavContent"><cpp>int group() const</cpp>
возвращает группу, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function kill(game_object*)''' </div>
<div class="NavContent"><cpp>void kill(game_object* who)</cpp>
убить объект. Аргумент - клиентский объект-убийца. Если не указать, движок считает, что объект самоубился.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function max_health() const''' </div>
<div class="NavContent"><cpp>float max_health() const</cpp>
возвращает максимальный уровень здоровья объекта. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function squad() const''' </div>
<div class="NavContent"><cpp>int squad() const</cpp>
возвращает отряд, к которому принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function team() const''' </div>
<div class="NavContent"><cpp>int team() const</cpp>
возвращает команду, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>
='''CEntityAlive'''=
Эти методы можно применять только для живых объектов - сталкеры, монстры (кроме ворон), актор.
Свойства объектов класса:
<cpp>float satiety; // сытость -- есть, но почему-то не прописан в lua_help
float bleeding; // кровотечение. только ЗП
float health; // здоровье 0..1
float morale; // мораль
float power; // сила
float psy_health; // пси-здоровье
float radiation; // радиация </cpp>
все свойства на запись работают не так, как на чтение. При записи значение имеет смысл изменения соответствующего свойства. Т.е. если записать 0.1 в health, то это увеличит его на 0.1.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_bleeding() const''' </div>
<div class="NavContent"><cpp>float get_bleeding() const</cpp>
В ЗП нет. Возвращает текущй размер кровотечения. Чем больше у объекта ранений - тем больше кровотечение. Если объект неживой, возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function relation(game_object*)''' </div>
<div class="NavContent"><cpp>ALife::ERelationType relation(game_object* who)</cpp>
возвращает тип отношения обрабатываемого объекта к объекту, передаваемому аргументом who. Объект who также должен наследовать от CEntityAlive. Для трупов или неживых объектов возвращает -1. Возвращаемое значение - член перечисления ALife::ERelationType. В Lua оно экспортировано в виде констант класса game_object.
<cpp>const friend = 0
const neutral = 1
const enemy = 2
const dummy = -1</cpp>
Есть еще две неэкспортированных константы:
<cpp>eRelationTypeWorstEnemy = 0x3
eRelationTypeLast = 0x4</cpp><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_name()''' </div>
<div class="NavContent"><cpp>string who_hit_name()</cpp>
возвращает имя объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_section_name()''' </div>
<div class="NavContent"><cpp>string who_hit_section_name()</cpp>
возвращает имя секции объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fov() const''' </div>
<div class="NavContent"><cpp>float fov() const</cpp>
возвращает угол зрения. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function range() const''' </div>
<div class="NavContent"><cpp>float range() const</cpp>
возвращает максимальную ширину видимой области. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 15:52, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть IV.

2011-12-18T21:17:10Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T20:50:03Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T20:41:28Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T20:27:44Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T19:57:11Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T19:55:25Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T18:21:36Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T18:21:00Z

K.D.:

Описание класса game object. Часть IV.

2011-12-18T18:13:46Z

K.D.: Новая страница: «{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;" |- ! style="background:#eaf1dd;" align="left"|Навигация ...»

Описание класса game object. Часть III.

2011-12-18T18:11:05Z

K.D.:

Описание класса game object. Часть V.

2011-12-18T18:05:26Z

K.D.:

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CAI_PhraseDialogManager'''=
Эти методы можно применять только для сталкеров и торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_default_start_dialog()''' </div>
<div class="NavContent"><cpp>void restore_default_start_dialog()</cpp>
устанавливает стартовый диалог неписю дефолтным. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog(string)''' </div>
<div class="NavContent"><cpp>void set_start_dialog(string dialog_id)</cpp>
устанавливает диалог dialog_id неписю в качестве стартового диалога.<br /><br /></div></div>

='''CAI_Trader'''=
Эти методы можно применять только для торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function external_sound_start(string)''' </div>
<div class="NavContent"><cpp>void external_sound_start(string sound)</cpp>
вроде как включает для торговца звук sound, но останавливает анимацию головы. Используется в начальном туторе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog()''' </div>
<div class="NavContent"><cpp>void external_sound_stop()</cpp>
станавливает звук торговца. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_global_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_global_anim(string anim)</cpp>
устанавливает анимацию anim для тела торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_head_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_head_anim(string anim)</cpp>
устанавливает анимацию anim для головы торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_sound(string, string)''' </div>
<div class="NavContent"><cpp>void set_trader_sound(string sound, string anim)</cpp>
устанавливает торговцу анимацию головы anim и включает в голове звук sound.<br /><br /></div></div>

='''CActor'''=
Эти методы можно работают для актора.<br />Следующие методы не проверяют свой неявный аргумент, так что их можно применять хоть к бочкам. Объект в них берется с помощью actor()
<div class="NavFrame collapsed">
<div class="NavHead">'''function give_task(CGameTask*, number, boolean)''' </div>
<div class="NavContent"><cpp>void give_task(CGameTask* t, int dt, bool bCheckExisting)</cpp>
выдает актору задание. Аргументы:
*t - задание в виде объекта CGameTask. Можно взять методом CGameTask() и загрузить в него данные методом load().
*dt - время на завершение
*bCheckExisting - проверять ли на наличие. Если bCheckExisting == true, то задание, при его присутствии у актора не выдается, в противном случае инициализируется заново.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_task_state(string, number)''' </div>
<div class="NavContent"><cpp>task get_task_state(string task_id, int objective_num)</cpp>
возвращает состояние задания (поле task_state) для задания task_id и подзадания objective_num. Возвращает константу из класса-перечисления task.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_task_state(enum ETaskState, string, number)''' </div>
<div class="NavContent"><cpp>void set_task_state(enum ETaskState state, string task_id, int objective_num)</cpp>
устанавливает у подзадания таска одно из выбранных состояний. Аргументы:
*state - состояние (константа из класса-перечисления task)
*task_id - таск
*objective_num - номер подзадания <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function hide_weapon()''' </div>
<div class="NavContent"><cpp>void hide_weapon()</cpp>
спрятать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_weapon()''' </div>
<div class="NavContent"><cpp>void restore_weapon()</cpp>
достать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function eat(game_object*)''' </div>
<div class="NavContent"><cpp>void eat(game_object* item)</cpp>
заставляет актора съесть предмет item. Предмет должен наследовать от класса CEatableItem.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_talk_message(string, string, Frect, string)''' </div>
<div class="NavContent"><cpp>void give_talk_message(string text, string texture_name, Frect tex_rect, string templ_name)</cpp>
выводит сообщение в диалоговое окно. Пример - вывод списка доступных повторяющихся квестов в диалоге с торговцем. Аргументы:
*text - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*templ_name - имя шаблона выводимой картинки. Регистрируется в talk.xml. Если не указано - движок считает, что это "iconed_answer_item"<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_game_news(string, string, Frect, number, number)''' </div>
<div class="NavContent"><cpp>bool give_game_news(string news, string texture_name, Frect tex_rect, int delay, int show_time)</cpp>
выводит сообщение в виде новости. Аргументы:
*news - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*delay - задержка выдачи новости
*show_time - время показа новости<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fastcall(const function<boolean>& , object)''' </div>
<div class="NavContent"><cpp>void set_fastcall(const function<boolean>& , object)</cpp>
установка быстрого обработчика.<br /><br /></div></div>
Следующие методы проверяют, к кому применются, вызывать их следует только для актора.

<div class="NavFrame collapsed">
<div class="NavHead">'''function run_talk_dialog(game_object*)''' </div>
<div class="NavContent"><cpp>void run_talk_dialog(game_object* pToWho)</cpp>
запускает диалог между актором и объектом pToWho. Тот объект должен наследовать от класса CInventoryOwner. Разговор можно начать только если собеседник находится на расстоянии не больше трёх метров от актора. Если точнее, то можно попытаться вызвать её и на больших расстояниях. Что-то при этом происходит: появляется мышь, отключается движение актора и он начинает смотреть на "собеседника" даже при том, что окна разговора нет. Такое ощущение, что просто безбожно глючит. Проверка допустимого расстояния перед началом остаётся таким образом на совести скриптёра. Расстояние в 3 метра никакими настройками не изменить, похоже вшито прямо в код движка. Другой момент. Данная функция только открывает диалог разговора. Если не делать ничего дополнительно, то непись "разговаривая" пойдёт себе дальше, и как только выйдет за три метра - разговор прервётся. В игре непись удерживается от убегания специальной скриптовой схемой, которая заставляет его стоять на месте, смотреть на актора, может ещё анимации проигрывать, точно не знаю. Параметр need_osoznanie_mode в секции персонажа позволяет избежать ограничения в 3 метра на возможность начать разговор. Однако при этом окно разговора показывается не полностью. Отсутствуют окна с иконками собеседников и окно чата. Есть только нижняя часть - окно выбора варианта ответа или диалога. Фактически, это превращает окно общения в своеобразное диалоговое окно для выбора одного из нескольких вариантов. Это используется в игре для предоставления Меченому выбора - присоединяться к О-Сознанию или нет. В принципе ничто не мешает использовать это как-то иначе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_direction(number)''' </div>
<div class="NavContent"><cpp>void set_actor_direction(float dir)</cpp>
устанавливает для актора направление взгляда, передаваемое углом вращения dir (в радианах).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_position(vector)''' </div>
<div class="NavContent"><cpp>void set_actor_position(vector pos)</cpp>
устанавливает для актора координаты, передаваемые вектором pos.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function switch_to_trade()''' </div>
<div class="NavContent"><cpp>void switch_to_trade()</cpp>
активировать окно торговли в диалоге. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_holder()''' </div>
<div class="NavContent"><cpp>holder* get_current_holder()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором. Аргументов не принимает.<br /><br /></div></div>
='''CInventoryBox'''=
Эти методы можно применять только для ящиков с инвентарем.
<div class="NavFrame collapsed">
<div class="NavHead">'''function is_inv_box_empty()''' </div>
<div class="NavContent"><cpp>bool is_inv_box_empty()</cpp>
проверяет, пустой ли ящик с инвентарем. Аргументов не принимает.<br /><br /></div></div>
='''CSpaceRestrictor'''=
Эти методы можно применять только для спейс рестрикторов и аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&, number)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position, float epsilon) const</cpp>
возвращает true, если сфера с центром в position и радиусом epsilon персекается со спейс рестриктором. Аргументы:
*position - центр сферы, для которой проверяется пересечение со спейс-рестриктором (объект класса vector)
*epsilon - радиус сферы (float)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position) const</cpp>
см. inside(const vector&, number), epsilon берется по умолчанию 0,001.<br /><br /></div></div>
='''CCustomZone'''=
Эти методы можно применять только для аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function disable_anomaly()''' </div>
<div class="NavContent"><cpp>void disable_anomaly()</cpp>
отключает аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_anomaly()''' </div>
<div class="NavContent"><cpp>void enable_anomaly()</cpp>
активирует аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_anomaly_power()''' </div>
<div class="NavContent"><cpp>float get_anomaly_power()</cpp>
возвращает max_power для объекта аномалиию. Максимальное значение вроде 1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_anomaly_power(number)''' </div>
<div class="NavContent"><cpp>void set_anomaly_power(float p)</cpp>
устанавливает max_power для объекта аномалии. Установить можно любое значение. Аргументов не принимает.<br /><br /></div></div>
='''CScriptZone'''=
Эти методы можно применять только для подходит только для скриптовых зон. Но в игре их вроде нет.
<div class="NavFrame collapsed">
<div class="NavHead">'''function active_zone_contact(number)''' </div>
<div class="NavContent"><cpp>void active_zone_contact(int id)</cpp>
возвращает true, если зона находится в контакте с объектом с индексом id.<br /><br /></div></div>
='''CProjector'''=
Эти методы можно применять только для прожекторов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_direction()''' </div>
<div class="NavContent"><cpp>vector get_current_direction()</cpp>
возвращает текущее направление проектора. Аргументов не принимает.<br /><br /></div></div>
='''CHudItem'''=
Эти методы можно применять только для артефактов, гранат и оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function animation_slot()''' </div>
<div class="NavContent"><cpp>int animation_slot() const</cpp>
возвращает номер слота анимации для данного объекта. Это не слот в инвентаре! Примеры:
*для пистолета - 1
*для автомата - 2
*для дробовика - 3
*для артефакта - 11
*для бинокля - 13.<br /><br /></div></div>
='''CExplosive'''=
Эти методы можно применять только для гранат и канистр.
<div class="NavFrame collapsed">
<div class="NavHead">'''function explode(number)''' </div>
<div class="NavContent"><cpp>void explode(int level_time)</cpp>
подрывает итем. Несмотря на наличие аргумента level_time, он вроде в функции не используется, так что управлять подрывом не выйдет.<br /><br /></div></div>
='''CAttachableItem'''=
Эти методы можно применять для всех инвентарных предметов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function attachable_item_enabled()''' </div>
<div class="NavContent"><cpp>bool attachable_item_enabled() const</cpp>
возвращает, активен ли итем. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_attachable_item(boolean)''' </div>
<div class="NavContent"><cpp>void enable_attachable_item(bool value)</cpp>
делает активным/неактивным итем. Parent итема должен наследовать от класса CAttachmentOwner. Всегда активны: аптечки, бинты, детекторы, патроны для активного оружия, активное оружие. Короче, все то, что в слотах или на горяих клавишах.<br /><br /></div></div>
='''CInventoryItem'''=
Эти методы можно применять для тех инвентарных предметов, у которых параметр class в конфиге не равен II_ATTCH.
<div class="NavFrame collapsed">
<div class="NavHead">'''function cost() const''' </div>
<div class="NavContent"><cpp>int cost() const</cpp>
возвращает стоимость вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function condition() const''' </div>
<div class="NavContent"><cpp>int condition() const</cpp>
возвращает состояние вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_condition(number)''' </div>
<div class="NavContent"><cpp>void set_condition(int val)</cpp>
устанавливает состояние вещи.<br /><br /></div></div>
='''CWeapon'''=
Эти методы можно применять только для оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_total() const''' </div>
<div class="NavContent"><cpp>int get_ammo_total() const</cpp>
возвращает общее количество патронов для данного оружия в стволе и инвентаре, если ствол в инвентаре. Если не в инвентаре - просто количество патронов в обойме. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_in_magazine() const''' </div>
<div class="NavContent"><cpp>int get_ammo_in_magazine() const</cpp>
возвращает количество патронов в стволе. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_ammo_elapsed(number)''' </div>
<div class="NavContent"><cpp>void set_ammo_elapsed(int ammo_elapsed)</cpp>
заряжает магазин количеством патронов, равным ammo_elapsed. Размер магазина игнорируется.<br /><br /></div></div>

='''CWeaponMagazined'''=
Эти методы можно применять только для оружия - кроме ножа и гранат.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_queue_size(number)''' </div>
<div class="NavContent"><cpp>void set_queue_size(int queue_size)</cpp>
устанавливает размер очереди из оружия.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function unload_magazine()''' </div>
<div class="NavContent"><cpp>void unload_magazine()</cpp>
разряжает магазин оружия. Оружие должно быть в инвентаре/руках объекта CAI_Stalker. Патроны из ствола пропадают. Аргументов не принимает.<br /><br /></div></div>

='''Методы получения объектов "чистых" клиентских движковых классов'''=
Эти методы позволяют получить объект чистого движкового класса из объекта класса-обертки CScriptGameObject.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_car()''' </div>
<div class="NavContent"><cpp>CCar* get_car()</cpp>
возвращает объект машины.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_holder_class()''' </div>
<div class="NavContent"><cpp>holder* get_holder_class()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_hanging_lamp()''' </div>
<div class="NavContent"><cpp>hanging_lamp* get_hanging_lamp()</cpp>
озвращает объект лампочки.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_helicopter()''' </div>
<div class="NavContent"><cpp>CHelicopter* get_helicopter()</cpp>
возвращает объект вертолета.<br /><br /></div></div>
Следующие методы присутствуют начиная с ЧН.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_campfire()''' </div>
<div class="NavContent"><cpp>CZoneCampfire* get_campfire()</cpp>
возвращает объект костра.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_artefact()''' </div>
<div class="NavContent"><cpp>CArtefact* get_artefact()</cpp>
возвращает объект артефакта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_object()''' </div>
<div class="NavContent"><cpp>CPhysicObject* get_physics_object()</cpp>
возвращает объект физических предметов (ящики, коробки).<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 18:04, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть V.

2011-12-18T18:04:21Z

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CAI_PhraseDialogManager'''=
Эти методы можно применять только для сталкеров и торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_default_start_dialog()''' </div>
<div class="NavContent"><cpp>void restore_default_start_dialog()</cpp>
устанавливает стартовый диалог неписю дефолтным. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog(string)''' </div>
<div class="NavContent"><cpp>void set_start_dialog(string dialog_id)</cpp>
устанавливает диалог dialog_id неписю в качестве стартового диалога.<br /><br /></div></div>

='''CAI_Trader'''=
Эти методы можно применять только для торговцев.
<div class="NavFrame collapsed">
<div class="NavHead">'''function external_sound_start(string)''' </div>
<div class="NavContent"><cpp>void external_sound_start(string sound)</cpp>
вроде как включает для торговца звук sound, но останавливает анимацию головы. Используется в начальном туторе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_dialog()''' </div>
<div class="NavContent"><cpp>void external_sound_stop()</cpp>
станавливает звук торговца. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_global_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_global_anim(string anim)</cpp>
устанавливает анимацию anim для тела торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_head_anim(string)''' </div>
<div class="NavContent"><cpp>void set_trader_head_anim(string anim)</cpp>
устанавливает анимацию anim для головы торговца.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_trader_sound(string, string)''' </div>
<div class="NavContent"><cpp>void set_trader_sound(string sound, string anim)</cpp>
устанавливает торговцу анимацию головы anim и включает в голове звук sound.<br /><br /></div></div>

='''CActor'''=
Эти методы можно применять только для актора.<br />Следующие методы не проверяют свой неявный аргумент, так что их можно применять хоть к бочкам. Объект в них берется с помощью actor()
<div class="NavFrame collapsed">
<div class="NavHead">'''function give_task(CGameTask*, number, boolean)''' </div>
<div class="NavContent"><cpp>void give_task(CGameTask* t, int dt, bool bCheckExisting)</cpp>
выдает актору задание. Аргументы:
*t - задание в виде объекта CGameTask. Можно взять методом CGameTask() и загрузить в него данные методом load().
*dt - время на завершение
*bCheckExisting - проверять ли на наличие. Если bCheckExisting == true, то задание, при его присутствии у актора не выдается, в противном случае инициализируется заново.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_task_state(string, number)''' </div>
<div class="NavContent"><cpp>task get_task_state(string task_id, int objective_num)</cpp>
возвращает состояние задания (поле task_state) для задания task_id и подзадания objective_num. Возвращает константу из класса-перечисления task.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_task_state(enum ETaskState, string, number)''' </div>
<div class="NavContent"><cpp>void set_task_state(enum ETaskState state, string task_id, int objective_num)</cpp>
устанавливает у подзадания таска одно из выбранных состояний. Аргументы:
*state - состояние (константа из класса-перечисления task)
*task_id - таск
*objective_num - номер подзадания <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function hide_weapon()''' </div>
<div class="NavContent"><cpp>void hide_weapon()</cpp>
спрятать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_weapon()''' </div>
<div class="NavContent"><cpp>void restore_weapon()</cpp>
достать оружие актора. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function eat(game_object*)''' </div>
<div class="NavContent"><cpp>void eat(game_object* item)</cpp>
заставляет актора съесть предмет item. Предмет должен наследовать от класса CEatableItem.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_talk_message(string, string, Frect, string)''' </div>
<div class="NavContent"><cpp>void give_talk_message(string text, string texture_name, Frect tex_rect, string templ_name)</cpp>
выводит сообщение в диалоговое окно. Пример - вывод списка доступных повторяющихся квестов в диалоге с торговцем. Аргументы:
*text - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*templ_name - имя шаблона выводимой картинки. Регистрируется в talk.xml. Если не указано - движок считает, что это "iconed_answer_item"<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function give_game_news(string, string, Frect, number, number)''' </div>
<div class="NavContent"><cpp>bool give_game_news(string news, string texture_name, Frect tex_rect, int delay, int show_time)</cpp>
выводит сообщение в виде новости. Аргументы:
*news - выводимый текст
*texture_name, tex_rect - параметры текстуры, где содержится выводимая картинка, можно получить через get_texture_info()
*delay - задержка выдачи новости
*show_time - время показа новости<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fastcall(const function<boolean>& , object)''' </div>
<div class="NavContent"><cpp>void set_fastcall(const function<boolean>& , object)</cpp>
установка быстрого обработчика.<br /><br /></div></div>
Следующие методы проверяют, к кому применются, вызывать их следует только для актора.

<div class="NavFrame collapsed">
<div class="NavHead">'''function run_talk_dialog(game_object*)''' </div>
<div class="NavContent"><cpp>void run_talk_dialog(game_object* pToWho)</cpp>
запускает диалог между актором и объектом pToWho. Тот объект должен наследовать от класса CInventoryOwner. Разговор можно начать только если собеседник находится на расстоянии не больше трёх метров от актора. Если точнее, то можно попытаться вызвать её и на больших расстояниях. Что-то при этом происходит: появляется мышь, отключается движение актора и он начинает смотреть на "собеседника" даже при том, что окна разговора нет. Такое ощущение, что просто безбожно глючит. Проверка допустимого расстояния перед началом остаётся таким образом на совести скриптёра. Расстояние в 3 метра никакими настройками не изменить, похоже вшито прямо в код движка. Другой момент. Данная функция только открывает диалог разговора. Если не делать ничего дополнительно, то непись "разговаривая" пойдёт себе дальше, и как только выйдет за три метра - разговор прервётся. В игре непись удерживается от убегания специальной скриптовой схемой, которая заставляет его стоять на месте, смотреть на актора, может ещё анимации проигрывать, точно не знаю. Параметр need_osoznanie_mode в секции персонажа позволяет избежать ограничения в 3 метра на возможность начать разговор. Однако при этом окно разговора показывается не полностью. Отсутствуют окна с иконками собеседников и окно чата. Есть только нижняя часть - окно выбора варианта ответа или диалога. Фактически, это превращает окно общения в своеобразное диалоговое окно для выбора одного из нескольких вариантов. Это используется в игре для предоставления Меченому выбора - присоединяться к О-Сознанию или нет. В принципе ничто не мешает использовать это как-то иначе.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_direction(number)''' </div>
<div class="NavContent"><cpp>void set_actor_direction(float dir)</cpp>
устанавливает для актора направление взгляда, передаваемое углом вращения dir (в радианах).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_actor_position(vector)''' </div>
<div class="NavContent"><cpp>void set_actor_position(vector pos)</cpp>
устанавливает для актора координаты, передаваемые вектором pos.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function switch_to_trade()''' </div>
<div class="NavContent"><cpp>void switch_to_trade()</cpp>
активировать окно торговли в диалоге. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_holder()''' </div>
<div class="NavContent"><cpp>holder* get_current_holder()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором. Аргументов не принимает.<br /><br /></div></div>
='''CInventoryBox'''=
Эти методы можно применять только для ящиков с инвентарем.
<div class="NavFrame collapsed">
<div class="NavHead">'''function is_inv_box_empty()''' </div>
<div class="NavContent"><cpp>bool is_inv_box_empty()</cpp>
проверяет, пустой ли ящик с инвентарем. Аргументов не принимает.<br /><br /></div></div>
='''CSpaceRestrictor'''=
Эти методы можно применять только для спейс рестрикторов и аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&, number)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position, float epsilon) const</cpp>
возвращает true, если сфера с центром в position и радиусом epsilon персекается со спейс рестриктором. Аргументы:
*position - центр сферы, для которой проверяется пересечение со спейс-рестриктором (объект класса vector)
*epsilon - радиус сферы (float)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function inside(const vector&)''' </div>
<div class="NavContent"><cpp>bool inside(const vector& position) const</cpp>
см. inside(const vector&, number), epsilon берется по умолчанию 0,001.<br /><br /></div></div>
='''CCustomZone'''=
Эти методы можно применять только для аномалий.
<div class="NavFrame collapsed">
<div class="NavHead">'''function disable_anomaly()''' </div>
<div class="NavContent"><cpp>void disable_anomaly()</cpp>
отключает аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_anomaly()''' </div>
<div class="NavContent"><cpp>void enable_anomaly()</cpp>
активирует аномалию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_anomaly_power()''' </div>
<div class="NavContent"><cpp>float get_anomaly_power()</cpp>
возвращает max_power для объекта аномалиию. Максимальное значение вроде 1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_anomaly_power(number)''' </div>
<div class="NavContent"><cpp>void set_anomaly_power(float p)</cpp>
устанавливает max_power для объекта аномалии. Установить можно любое значение. Аргументов не принимает.<br /><br /></div></div>
='''CScriptZone'''=
Эти методы можно применять только для подходит только для скриптовых зон. Но в игре их вроде нет.
<div class="NavFrame collapsed">
<div class="NavHead">'''function active_zone_contact(number)''' </div>
<div class="NavContent"><cpp>void active_zone_contact(int id)</cpp>
возвращает true, если зона находится в контакте с объектом с индексом id.<br /><br /></div></div>
='''CProjector'''=
Эти методы можно применять только для прожекторов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_direction()''' </div>
<div class="NavContent"><cpp>vector get_current_direction()</cpp>
возвращает текущее направление проектора. Аргументов не принимает.<br /><br /></div></div>
='''CHudItem'''=
Эти методы можно применять только для артефактов, гранат и оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function animation_slot()''' </div>
<div class="NavContent"><cpp>int animation_slot() const</cpp>
возвращает номер слота анимации для данного объекта. Это не слот в инвентаре! Примеры:
*для пистолета - 1
*для автомата - 2
*для дробовика - 3
*для артефакта - 11
*для бинокля - 13.<br /><br /></div></div>
='''CExplosive'''=
Эти методы можно применять только для гранат и канистр.
<div class="NavFrame collapsed">
<div class="NavHead">'''function explode(number)''' </div>
<div class="NavContent"><cpp>void explode(int level_time)</cpp>
подрывает итем. Несмотря на наличие аргумента level_time, он вроде в функции не используется, так что управлять подрывом не выйдет.<br /><br /></div></div>
='''CAttachableItem'''=
Эти методы можно применять для всех инвентарных предметов.
<div class="NavFrame collapsed">
<div class="NavHead">'''function attachable_item_enabled()''' </div>
<div class="NavContent"><cpp>bool attachable_item_enabled() const</cpp>
возвращает, активен ли итем. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_attachable_item(boolean)''' </div>
<div class="NavContent"><cpp>void enable_attachable_item(bool value)</cpp>
делает активным/неактивным итем. Parent итема должен наследовать от класса CAttachmentOwner. Всегда активны: аптечки, бинты, детекторы, патроны для активного оружия, активное оружие. Короче, все то, что в слотах или на горяих клавишах.<br /><br /></div></div>
='''CInventoryItem'''=
Эти методы можно применять для тех инвентарных предметов, у которых параметр class в конфиге не равен II_ATTCH.
<div class="NavFrame collapsed">
<div class="NavHead">'''function cost() const''' </div>
<div class="NavContent"><cpp>int cost() const</cpp>
возвращает стоимость вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function condition() const''' </div>
<div class="NavContent"><cpp>int condition() const</cpp>
возвращает состояние вещи. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_condition(number)''' </div>
<div class="NavContent"><cpp>void set_condition(int val)</cpp>
устанавливает состояние вещи.<br /><br /></div></div>
='''CWeapon'''=
Эти методы можно применять только для оружия.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_total() const''' </div>
<div class="NavContent"><cpp>int get_ammo_total() const</cpp>
возвращает общее количество патронов для данного оружия в стволе и инвентаре, если ствол в инвентаре. Если не в инвентаре - просто количество патронов в обойме. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_ammo_in_magazine() const''' </div>
<div class="NavContent"><cpp>int get_ammo_in_magazine() const</cpp>
возвращает количество патронов в стволе. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_ammo_elapsed(number)''' </div>
<div class="NavContent"><cpp>void set_ammo_elapsed(int ammo_elapsed)</cpp>
заряжает магазин количеством патронов, равным ammo_elapsed. Размер магазина игнорируется.<br /><br /></div></div>

='''CWeaponMagazined'''=
Эти методы можно применять только для оружия - кроме ножа и гранат.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_queue_size(number)''' </div>
<div class="NavContent"><cpp>void set_queue_size(int queue_size)</cpp>
устанавливает размер очереди из оружия.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function unload_magazine()''' </div>
<div class="NavContent"><cpp>void unload_magazine()</cpp>
разряжает магазин оружия. Оружие должно быть в инвентаре/руках объекта CAI_Stalker. Патроны из ствола пропадают. Аргументов не принимает.<br /><br /></div></div>

='''Методы получения объектов "чистых" клиентских движковых классов'''=
Эти методы позволяют получить объект чистого движкового класса из объекта класса-обертки CScriptGameObject.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_car()''' </div>
<div class="NavContent"><cpp>CCar* get_car()</cpp>
возвращает объект машины.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_holder_class()''' </div>
<div class="NavContent"><cpp>holder* get_holder_class()</cpp>
возвращает машину или стационарное оружие, связанные в данный момент с актором.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_hanging_lamp()''' </div>
<div class="NavContent"><cpp>hanging_lamp* get_hanging_lamp()</cpp>
озвращает объект лампочки.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_helicopter()''' </div>
<div class="NavContent"><cpp>CHelicopter* get_helicopter()</cpp>
возвращает объект вертолета.<br /><br /></div></div>
Следующие методы присутствуют начиная с ЧН.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_campfire()''' </div>
<div class="NavContent"><cpp>CZoneCampfire* get_campfire()</cpp>
возвращает объект костра.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_artefact()''' </div>
<div class="NavContent"><cpp>CArtefact* get_artefact()</cpp>
возвращает объект артефакта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_object()''' </div>
<div class="NavContent"><cpp>CPhysicObject* get_physics_object()</cpp>
возвращает объект физических предметов (ящики, коробки).<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 18:04, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть II.

2011-12-18T17:21:23Z

K.D.:

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CCustomMonster'''=
Эти методы можно применять только для сталкеров и монстров.
<div class="NavFrame collapsed">
<div class="NavHead">'''function best_danger()''' </div>
<div class="NavContent"><cpp>danger_object* best_danger()</cpp>
возвращает лучший дэнжер в виде объекта класса danger_object. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_enemy()''' </div>
<div class="NavContent"><cpp>game_object* best_enemy()</cpp>
возвращает объект врага. Работает для сталкеров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_item()''' </div>
<div class="NavContent"><cpp>game_object* best_item()</cpp>
вроде как возвращает объект тушки, которую можно пожевать. Точно неизвестно. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_enemy() const''' </div>
<div class="NavContent"><cpp>game_object* get_enemy() const</cpp>
возвращает объект текущего врага. Работает для монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_position(const game_object&)''' </div>
<div class="NavContent"><cpp>vector memory_position(const game_object& lua_game_object)</cpp>
возвращает позицию (в виде объекта класса vector), на которой последний раз был видим объект lua_game_object нашим объектом. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_time(const game_object&)''' </div>
<div class="NavContent"><cpp>int memory_time(const game_object& lua_game_object)</cpp>
возвращает время, когда последний раз был видим объект lua_game_object нашим объектом, в игровых мс. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_memory_object(game_object*, boolean)''' </div>
<div class="NavContent"><cpp>void enable_memory_object(game_object* lua_game_object, bool enable)</cpp>
включает/отключает объект в памяти монстра/сталкера. В игре используется для форсированного "забывания" врага при его долговременном отсутствии. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_hit_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_hit_objects() const</cpp>
возвращает итератор объектов, которые когда-либо наносили хит. Объекты имеют тип hit_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_hit_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_sound_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_sound_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были слышимы. Объекты имеют тип sound_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_sound_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_visible_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были видимы. Объекты имеют тип visible_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function not_yet_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator not_yet_visible_objects() const</cpp>
возвращает итератор объектов, которые видны или собираются быть видны. Объекты имеют тип not_yet_visible_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:not_yet_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function change_team(number, number, number)''' </div>
<div class="NavContent"><cpp>void change_team(int team, int squad, int group)</cpp>
меняет для объекта team, squad и group.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function see(string)''' </div>
<div class="NavContent"><cpp>bool see(string section_name)</cpp>
проверяет, есть ли среди массива видимых объектов объект с именем секции, равной section_name.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fov(number)''' </div>
<div class="NavContent"><cpp>void set_fov(float new_fov)</cpp>
устанавливает угол зрения, равный значению new_fov.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_range(number)''' </div>
<div class="NavContent"><cpp>void set_range(float new_range)</cpp>
устанавливает максимальную ширину видимой области, равный значению new_range.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vertex_in_direction(number, vector, number) const''' </div>
<div class="NavContent"><cpp>int vertex_in_direction(int level_vertex_id, vector direction, float max_distance) const</cpp>
возвращает lvid наиболее удаленной точки, доступной неписю в направлении direction. Аргументы:
*level_vertex_id - ближайший к объекту левел вертекс
*direction - направление, в котором надо получить точку
*max_distance - диаметр сферы с центром в level_vertex_id, в которой ищутся доступные вертексы.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible_nearest(const vector&, vector&)''' </div>
<div class="NavContent"><cpp>int accessible_nearest(const vector& position, vector& result)</cpp>
возвращает ближайший к точке position левел вертекс. В память по указателю result записываются координаты этого вертекса.<br />Пример использования:<lua>local pos = npc:position()
local res = vector():set(0,0,0)
local lvid = npc:accessible_nearest(pos, res)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(const vector&)''' </div>
<div class="NavContent"><cpp>bool accessible(const vector& position)</cpp>
возвращает true, если точка position находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(number)''' </div>
<div class="NavContent"><cpp>bool accessible(int level_vertex_id)</cpp>
возвращает true, если вертекс level_vertex_id находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void add_restrictions(string out, string in)</cpp>
добавляет объекту рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_in_restrictions()''' </div>
<div class="NavContent"><cpp>string base_in_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_out_restrictions()''' </div>
<div class="NavContent"><cpp>string base_out_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function in_restrictions()''' </div>
<div class="NavContent"><cpp>string in_restrictions()</cpp>
возвращает список рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function out_restrictions()''' </div>
<div class="NavContent"><cpp>string out_restrictions()</cpp>
возвращает список рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_all_restrictions()''' </div>
<div class="NavContent"><cpp>string remove_all_restrictions()</cpp>
удаляет все рестрикторы 4 и 5 типов. Устанавливает in_restrictions и out_restrictions пустыми.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void remove_restrictions(string out, string in);</cpp>
удаляет рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую. Есть особенность: обязательно должен быть задан аргумент out, иначе функция не будет работать (хотя и не вылетит)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function critically_wounded()''' </div>
<div class="NavContent"><cpp>bool critically_wounded()</cpp>
возвращает true, если объект критически ранен.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled(boolean)''' </div>
<div class="NavContent"><cpp>void movement_enabled(bool enable)</cpp>
разрешает/запрещает объекту движение.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled()''' </div>
<div class="NavContent"><cpp>bool movement_enabled()</cpp>
возвращает true, если объекту разрешено двигаться по пути.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_point_index()''' </div>
<div class="NavContent"><cpp>int get_current_point_index()</cpp>
возвращает номер текущей точки пути (lvid).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function is_body_turning()''' </div>
<div class="NavContent"><cpp>int is_body_turning()</cpp>
возвращает true, если объект поворачивается. Сравнивается текущее и целевое направление, разница между ними сравнивается с 0,00001 и если разница больше, то возвращается true. Для сталкеров возвращает true, даже если он просто вертит башкой.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function location_on_path(number, vector*)''' </div>
<div class="NavContent"><cpp>int location_on_path(float distance, vector* location)</cpp>
возвращает координаты точки пути объекта, которая отстоит от следующей точки пути более, чем на расстояние distance. Аргументы:
*distance - расстояние между точками (float)
*location - в этот вектор пишутся вычисленные кординаты.
Непосредственно функция возвращает level_vertex_id найденной точки. Также, если у непися нет активного пути или он стоит в последней точке пути, или между всеми точками пути расстояние меньше, чем distance, возвратятся его координаты и вертекс<br />Примеры использования:<lua>
local dist = 5
local location = vector():set(0,0,0)
local lvid = npc:location_on_path(dist, location)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function path_completed()''' </div>
<div class="NavContent"><cpp>bool path_completed()</cpp>
возвращает true, если путь завершен объектом. false если нет.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function patrol_path_make_inactual()''' </div>
<div class="NavContent"><cpp>void patrol_path_make_inactual()</cpp>
делает текущий путь завершенным.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_point(number)''' </div>
<div class="NavContent"><cpp>void set_start_point(int point_index)</cpp>
установить начальную точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_previous_point(number)''' </div>
<div class="NavContent"><cpp>void set_previous_point(int point_index)</cpp>
установить предыдущую точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count(boolean)''' </div>
<div class="NavContent"><cpp>int active_sound_count(bool only_playing)</cpp>
возвращает количество проигрываемых звуков. Если only_playing = false, то вернет еще и количество звуков в очереди.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count()''' </div>
<div class="NavContent"><cpp>int active_sound_count()</cpp>
см active_sound_count(boolean). Параметр only_playing по умолчанию false <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number, string)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type, string bone_name)</cpp>
инициализирует для объекта еще один звук. Аргументы:
*prefix - sound_prefix звука
*max_count - ???
*type - тип звука. Возможные значения см в классе-перечислении snd_type.
*priority - ???
*mask - ???
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*bone_name - кость, от которой будет играться звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type)</cpp>
см. add_sound(string, number, enum ESoundTypes, number, number, number, string). Аргумент bone_name по умолчанию bip01_head.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time, int id)</cpp>
проигрывает от объекта звук. Аргументы:
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*max_start_time, min_start_time - максимальное и минимальное время задержки запуска звука. Если грубо - между ними берется рандомное значение, к нему прибавляется текущее время и результат устанавливается началом запуска звука
*max_stop_time, min_stop_time - аналогично start_time. Время окончания устанавливается равным текущему времени + start_time + stop_time + длительность звука
*id - вроде как номер темы. Из этой темы движок выбирает рандомный звук. Если -1 - будет выбрана рандомная фраза, инициализированная для объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number, number). Аргумент id по умолчанию берется -1.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number). Аргумент min_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time)</cpp>
см.выше function play_sound(number, number, number, number). Аргумент max_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time)</cpp>
см.выше function play_sound(number, number, number). Аргумент min_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type)</cpp>
см.выше function play_sound(number, number). Аргумент max_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_sound_threshold()''' </div>
<div class="NavContent"><cpp>void restore_sound_threshold()</cpp>
восстанавливает дефолтный sound_threshold - порог громкости, при котором непись слышит звук. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_sound_threshold(float value)</cpp>
устанавливает sound_threshold - порог громкости, при котором непись слышит звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_sound(number)''' </div>
<div class="NavContent"><cpp>void remove_sound(int internal_type)</cpp>
стереть тему с индексом id из списка разрешенных для персонажа.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_mask(number)''' </div>
<div class="NavContent"><cpp>void set_sound_mask(int sound_mask)</cpp>
устанавливает sound_mask.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix(string)''' </div>
<div class="NavContent"><cpp>void sound_prefix(string sound_prefix)</cpp>
устанавливает sound_prefix объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_prefix() const</cpp>
возвращает sound_prefix объекта. sound_prefix - папка со звуками для данного объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_voice_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_voice_prefix() const</cpp>
возвращает sound_voice_prefix объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function visibility_threshold() const''' </div>
<div class="NavContent"><cpp>float visibility_threshold() const</cpp>
возвращает максимальное расстояние, на котором объект видит другие объекты. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vision_enabled() const''' </div>
<div class="NavContent"><cpp>bool vision_enabled() const</cpp>
проверяет, включено ли запоминание видимых объектов. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_vision(boolean)''' </div>
<div class="NavContent"><cpp>void enable_vision(bool value)</cpp>
включить/выключить запись видимых объектов в память.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length(number)''' </div>
<div class="NavContent"><cpp>void extrapolate_length(float extrapolate_length)</cpp>
устанавливает m_extrapolate_length равным extrapolate_length. Что это - непонятно, но имеет отношение к CDetailPathManager.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length()''' </div>
<div class="NavContent"><cpp>float extrapolate_length()</cpp>
возвращает m_extrapolate_length. Имеет отношение к CDetailPathManager.<br /><br /></div></div>
='''CBaseMonster'''=
Эти методы можно применять только для монстров.

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_corpse()''' </div>
<div class="NavContent"><cpp>game_object* get_corpse()</cpp>
возвращает объект трупа в ближайшем радиусе вокруг монстра, причем класс объекта эквивалентен CEntity. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_monster_hit_info()''' </div>
<div class="NavContent"><cpp>MonsterHitInfo* get_monster_hit_info()</cpp>
возвращает объект класса MonsterHitInfo, содержащий информацию о последнем, кто бил по монстру. Аргументов не принимает.
<cpp>class MonsterHitInfo {
vector direction; //направление хита
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект нанесшего хит.
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_sound_info()''' </div>
<div class="NavContent"><cpp>SoundInfo* get_sound_info()</cpp>
возвращает объект SoundInfo, содержащий информацию о последнем услышанном звуке. Аргументов не принимает.
<cpp>class MonsterHitInfo {
bool danger; //опасен ли звук. У меня получалось true, если издающй звук объект еще и наносит хит. Если стрелять в воздух, монстр "не боится".
vector position; //координаты звука
float power; //сила звука
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект издавшего звука
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_home()''' </div>
<div class="NavContent"><cpp>void remove_home()</cpp>
удаление точки "выпаса" монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_custom_panic_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_custom_panic_threshold(float value)</cpp>
установить порог паники, равным value.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_default_panic_threshold()''' </div>
<div class="NavContent"><cpp>void set_default_panic_threshold()</cpp>
вернуть порог паники по умолчанию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_home(string, number, number, boolean)''' </div>
<div class="NavContent"><cpp>void set_home(string name, float r_min, float r_max, bool aggressive)</cpp>
установить точку "выпаса" монстров. Аргументы:
*name - имя пути
*r_min - минимальный радуис беготни вокруг точки
*r_max - максимальный радиус удаления от точки
*aggressive - аггресивность монстров.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function skip_transfer_enemy(boolean)''' </div>
<div class="NavContent"><cpp>void skip_transfer_enemy(bool val)</cpp>
управляет передачей врагов от друзей. Если установлено в true и видит дружественного монстра, то его враги также становятся врагами.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function character_rank()''' </div>
<div class="NavContent"><cpp>int character_rank()</cpp>
возвращает ранг объекта. Также работает и для объектов-наследников CInventoryOwner. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function jump(const vector&, number)''' </div>
<div class="NavContent"><cpp>void jump(const vector& position, float factor)</cpp>
заставляет объект прыгнуть. Работает только для снорков. Аргументы:
*position - конечные координаты прыжка.
*factor - точно трудно сказать, но похоже, что время прыжка.<br /><br /></div></div>
='''CAI_Bloodsucker'''=
Эти методы можно применять только для кровососа.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_alien_control(boolean)''' </div>
<div class="NavContent"><cpp>void set_alien_control(bool val)</cpp>
устанавливает камеру актера в положение "от глаз монстра" и обратно.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_invisible(boolean)''' </div>
<div class="NavContent"><cpp>void set_invisible(bool val)</cpp>
управляет невидимостью. true - установить, false - убрать.<br /><br /></div></div>
='''CAI_Zombie'''=
Эти методы можно применять только для зомби.
<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_fall_down()''' </div>
<div class="NavContent"><cpp>boolean fake_death_fall_down()</cpp>
проигрывает у зомби анимацию ложной смерти. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_stand_up()''' </div>
<div class="NavContent"><cpp>boolean fake_death_stand_up()</cpp>
проигрывает у зомби анимацию вставания. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 17:21, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть III.

2011-12-18T17:18:06Z

K.D.:

Описание класса game object. Часть III.

2011-12-18T17:01:36Z

Описание класса game object. Часть II.

2011-12-18T16:58:10Z

{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
='''CCustomMonster'''=
Эти методы можно применять только для сталкеров и монстров.
<div class="NavFrame collapsed">
<div class="NavHead">'''function best_danger()''' </div>
<div class="NavContent"><cpp>danger_object* best_danger()</cpp>
возвращает лучший дэнжер в виде объекта класса danger_object. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_enemy()''' </div>
<div class="NavContent"><cpp>game_object* best_enemy()</cpp>
возвращает объект врага. Работает для сталкеров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function best_item()''' </div>
<div class="NavContent"><cpp>game_object* best_item()</cpp>
вроде как возвращает объект тушки, которую можно пожевать. Точно неизвестно. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_enemy() const''' </div>
<div class="NavContent"><cpp>game_object* get_enemy() const</cpp>
возвращает объект текущего врага. Работает для монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_position(const game_object&)''' </div>
<div class="NavContent"><cpp>vector memory_position(const game_object& lua_game_object)</cpp>
возвращает позицию (в виде объекта класса vector), на которой последний раз был видим объект lua_game_object нашим объектом. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_time(const game_object&)''' </div>
<div class="NavContent"><cpp>int memory_time(const game_object& lua_game_object)</cpp>
возвращает время, когда последний раз был видим объект lua_game_object нашим объектом, в игровых мс. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_memory_object(game_object*, boolean)''' </div>
<div class="NavContent"><cpp>void enable_memory_object(game_object* lua_game_object, bool enable)</cpp>
включает/отключает объект в памяти монстра/сталкера. В игре используется для форсированного "забывания" врага при его долговременном отсутствии. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_hit_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_hit_objects() const</cpp>
возвращает итератор объектов, которые когда-либо наносили хит. Объекты имеют тип hit_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_hit_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_sound_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_sound_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были слышимы. Объекты имеют тип sound_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_sound_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function memory_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator memory_visible_objects() const</cpp>
возвращает итератор объектов, которые когда-либо были видимы. Объекты имеют тип visible_memory_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:memory_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function not_yet_visible_objects() const''' </div>
<div class="NavContent"><cpp>iterator not_yet_visible_objects() const</cpp>
возвращает итератор объектов, которые видны или собираются быть видны. Объекты имеют тип not_yet_visible_object. Аргументов не принимает.<br />
Пример использования:
<lua>local cObj = level.object_by_id(oID)
for obj in cObj:not_yet_visible_objects() do
--тут манипуляции с объектами
end</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function change_team(number, number, number)''' </div>
<div class="NavContent"><cpp>void change_team(int team, int squad, int group)</cpp>
меняет для объекта team, squad и group.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function see(string)''' </div>
<div class="NavContent"><cpp>bool see(string section_name)</cpp>
проверяет, есть ли среди массива видимых объектов объект с именем секции, равной section_name.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_fov(number)''' </div>
<div class="NavContent"><cpp>void set_fov(float new_fov)</cpp>
устанавливает угол зрения, равный значению new_fov.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_range(number)''' </div>
<div class="NavContent"><cpp>void set_range(float new_range)</cpp>
устанавливает максимальную ширину видимой области, равный значению new_range.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vertex_in_direction(number, vector, number) const''' </div>
<div class="NavContent"><cpp>int vertex_in_direction(int level_vertex_id, vector direction, float max_distance) const</cpp>
возвращает lvid наиболее удаленной точки, доступной неписю в направлении direction. Аргументы:
*level_vertex_id - ближайший к объекту левел вертекс
*direction - направление, в котором надо получить точку
*max_distance - диаметр сферы с центром в level_vertex_id, в которой ищутся доступные вертексы.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible_nearest(const vector&, vector&)''' </div>
<div class="NavContent"><cpp>int accessible_nearest(const vector& position, vector& result)</cpp>
возвращает ближайший к точке position левел вертекс. В память по указателю result записываются координаты этого вертекса.<br />Пример использования:<lua>local pos = npc:position()
local res = vector():set(0,0,0)
local lvid = npc:accessible_nearest(pos, res)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(const vector&)''' </div>
<div class="NavContent"><cpp>bool accessible(const vector& position)</cpp>
возвращает true, если точка position находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function accessible(number)''' </div>
<div class="NavContent"><cpp>bool accessible(int level_vertex_id)</cpp>
возвращает true, если вертекс level_vertex_id находится внутри out рестриктора или если у объекта вовсе нет out рестрикторов.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void add_restrictions(string out, string in)</cpp>
добавляет объекту рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_in_restrictions()''' </div>
<div class="NavContent"><cpp>string base_in_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function base_out_restrictions()''' </div>
<div class="NavContent"><cpp>string base_out_restrictions()</cpp>
возвращает список дефолтных рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function in_restrictions()''' </div>
<div class="NavContent"><cpp>string in_restrictions()</cpp>
возвращает список рестрикторов (через запятую), куда объекту ход заказан.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function out_restrictions()''' </div>
<div class="NavContent"><cpp>string out_restrictions()</cpp>
возвращает список рестрикторов (через запятую), где объекту нужно быть.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_all_restrictions()''' </div>
<div class="NavContent"><cpp>string remove_all_restrictions()</cpp>
удаляет все рестрикторы 4 и 5 типов. Устанавливает in_restrictions и out_restrictions пустыми.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_restrictions(string, string)''' </div>
<div class="NavContent"><cpp>void remove_restrictions(string out, string in);</cpp>
удаляет рестрикторы, заданные аргументами out (out рестрикторы) и in (in рестрикторы). Можно задавать списком, через запятую. Есть особенность: обязательно должен быть задан аргумент out, иначе функция не будет работать (хотя и не вылетит)<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function critically_wounded()''' </div>
<div class="NavContent"><cpp>bool critically_wounded()</cpp>
возвращает true, если объект критически ранен.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled(boolean)''' </div>
<div class="NavContent"><cpp>void movement_enabled(bool enable)</cpp>
разрешает/запрещает объекту движение.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function movement_enabled()''' </div>
<div class="NavContent"><cpp>bool movement_enabled()</cpp>
возвращает true, если объекту разрешено двигаться по пути.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_current_point_index()''' </div>
<div class="NavContent"><cpp>int get_current_point_index()</cpp>
возвращает номер текущей точки пути (lvid).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function is_body_turning()''' </div>
<div class="NavContent"><cpp>int is_body_turning()</cpp>
возвращает true, если объект поворачивается. Сравнивается текущее и целевое направление, разница между ними сравнивается с 0,00001 и если разница больше, то возвращается true. Для сталкеров возвращает true, даже если он просто вертит башкой.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function location_on_path(number, vector*)''' </div>
<div class="NavContent"><cpp>int location_on_path(float distance, vector* location)</cpp>
возвращает координаты точки пути объекта, которая отстоит от следующей точки пути более, чем на расстояние distance. Аргументы:
*distance - расстояние между точками (float)
*location - в этот вектор пишутся вычисленные кординаты.
Непосредственно функция возвращает level_vertex_id найденной точки. Также, если у непися нет активного пути или он стоит в последней точке пути, или между всеми точками пути расстояние меньше, чем distance, возвратятся его координаты и вертекс<br />Примеры использования:<lua>
local dist = 5
local location = vector():set(0,0,0)
local lvid = npc:location_on_path(dist, location)</lua><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function path_completed()''' </div>
<div class="NavContent"><cpp>bool path_completed()</cpp>
возвращает true, если путь завершен объектом. false если нет.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function patrol_path_make_inactual()''' </div>
<div class="NavContent"><cpp>void patrol_path_make_inactual()</cpp>
делает текущий путь завершенным.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_start_point(number)''' </div>
<div class="NavContent"><cpp>void set_start_point(int point_index)</cpp>
установить начальную точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_previous_point(number)''' </div>
<div class="NavContent"><cpp>void set_previous_point(int point_index)</cpp>
установить предыдущую точку пути как point_index.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count(boolean)''' </div>
<div class="NavContent"><cpp>int active_sound_count(bool only_playing)</cpp>
возвращает количество проигрываемых звуков. Если only_playing = false, то вернет еще и количество звуков в очереди.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function active_sound_count()''' </div>
<div class="NavContent"><cpp>int active_sound_count()</cpp>
см active_sound_count(boolean). Параметр only_playing по умолчанию false <br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number, string)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type, string bone_name)</cpp>
инициализирует для объекта еще один звук. Аргументы:
*prefix - sound_prefix звука
*max_count - ???
*type - тип звука. Возможные значения см в классе-перечислении snd_type.
*priority - ???
*mask - ???
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*bone_name - кость, от которой будет играться звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function add_sound(string, number, enum ESoundTypes, number, number, number)''' </div>
<div class="NavContent"><cpp>int add_sound(string prefix, int max_count, enum ESoundTypes type, int priority, int mask, int internal_type)</cpp>
см. add_sound(string, number, enum ESoundTypes, number, number, number, string). Аргумент bone_name по умолчанию bip01_head.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time, int id)</cpp>
проигрывает от объекта звук. Аргументы:
*internal_type - ключ в ассоциативном массиве звуков. При инициализации звуков для непися они записываются в ассоциативный массив, где ключами служат индексы, обозначающие группы звуков по смыслу. Такие группы являются константами экспортированного класса stalker_ids (те, что с индексом sound_).
*max_start_time, min_start_time - максимальное и минимальное время задержки запуска звука. Если грубо - между ними берется рандомное значение, к нему прибавляется текущее время и результат устанавливается началом запуска звука
*max_stop_time, min_stop_time - аналогично start_time. Время окончания устанавливается равным текущему времени + start_time + stop_time + длительность звука
*id - вроде как номер темы. Из этой темы движок выбирает рандомный звук. Если -1 - будет выбрана рандомная фраза, инициализированная для объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time, int min_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number, number). Аргумент id по умолчанию берется -1.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time, int max_stop_time)</cpp>
см.выше function play_sound(number, number, number, number, number). Аргумент min_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time, int min_start_time)</cpp>
см.выше function play_sound(number, number, number, number). Аргумент max_stop_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number, number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type, int max_start_time)</cpp>
см.выше function play_sound(number, number, number). Аргумент min_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function play_sound(number)''' </div>
<div class="NavContent"><cpp>void play_sound(int internal_type)</cpp>
см.выше function play_sound(number, number). Аргумент max_start_time по умолчанию берется 0.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function restore_sound_threshold()''' </div>
<div class="NavContent"><cpp>void restore_sound_threshold()</cpp>
восстанавливает дефолтный sound_threshold - порог громкости, при котором непись слышит звук. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_sound_threshold(float value)</cpp>
устанавливает sound_threshold - порог громкости, при котором непись слышит звук.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_sound(number)''' </div>
<div class="NavContent"><cpp>void remove_sound(int internal_type)</cpp>
стереть тему с индексом id из списка разрешенных для персонажа.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_sound_mask(number)''' </div>
<div class="NavContent"><cpp>void set_sound_mask(int sound_mask)</cpp>
устанавливает sound_mask.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix(string)''' </div>
<div class="NavContent"><cpp>void sound_prefix(string sound_prefix)</cpp>
устанавливает sound_prefix объекта.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_prefix() const</cpp>
возвращает sound_prefix объекта. sound_prefix - папка со звуками для данного объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function sound_voice_prefix() const''' </div>
<div class="NavContent"><cpp>string sound_voice_prefix() const</cpp>
возвращает sound_voice_prefix объекта. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function visibility_threshold() const''' </div>
<div class="NavContent"><cpp>float visibility_threshold() const</cpp>
возвращает максимальное расстояние, на котором объект видит другие объекты. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function vision_enabled() const''' </div>
<div class="NavContent"><cpp>bool vision_enabled() const</cpp>
проверяет, включено ли запоминание видимых объектов. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function enable_vision(boolean)''' </div>
<div class="NavContent"><cpp>void enable_vision(bool value)</cpp>
включить/выключить запись видимых объектов в память.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length(number)''' </div>
<div class="NavContent"><cpp>void extrapolate_length(float extrapolate_length)</cpp>
устанавливает m_extrapolate_length равным extrapolate_length. Что это - непонятно, но имеет отношение к CDetailPathManager.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function extrapolate_length()''' </div>
<div class="NavContent"><cpp>float extrapolate_length()</cpp>
возвращает m_extrapolate_length. Имеет отношение к CDetailPathManager.<br /><br /></div></div>
='''CBaseMonster'''=
Эти методы можно применять только для монстров.

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_corpse()''' </div>
<div class="NavContent"><cpp>game_object* get_corpse()</cpp>
возвращает объект трупа в ближайшем радиусе вокруг монстра, причем класс объекта эквивалентен CEntity. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_monster_hit_info()''' </div>
<div class="NavContent"><cpp>MonsterHitInfo* get_monster_hit_info()</cpp>
возвращает объект класса MonsterHitInfo, содержащий информацию о последнем, кто бил по монстру. Аргументов не принимает.
<cpp>class MonsterHitInfo {
vector direction; //направление хита
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект нанесшего хит.
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function get_sound_info()''' </div>
<div class="NavContent"><cpp>SoundInfo* get_sound_info()</cpp>
возвращает объект SoundInfo, содержащий информацию о последнем услышанном звуке. Аргументов не принимает.
<cpp>class MonsterHitInfo {
bool danger; //опасен ли звук. У меня получалось true, если издающй звук объект еще и наносит хит. Если стрелять в воздух, монстр "не боится".
vector position; //координаты звука
float power; //сила звука
int time; //игровое время, когда был нанесен хит
game_object* who; //клиентский объект издавшего звука
}</cpp><br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function remove_home()''' </div>
<div class="NavContent"><cpp>void remove_home()</cpp>
удаление точки "выпаса" монстров. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_custom_panic_threshold(number)''' </div>
<div class="NavContent"><cpp>void set_custom_panic_threshold(float value)</cpp>
установить порог паники, равным value.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_default_panic_threshold()''' </div>
<div class="NavContent"><cpp>void set_default_panic_threshold()</cpp>
вернуть порог паники по умолчанию. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_home(string, number, number, boolean)''' </div>
<div class="NavContent"><cpp>void set_home(string name, float r_min, float r_max, bool aggressive)</cpp>
установить точку "выпаса" монстров. Аргументы:
*name - имя пути
*r_min - минимальный радуис беготни вокруг точки
*r_max - максимальный радиус удаления от точки
*aggressive - аггресивность монстров.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function skip_transfer_enemy(boolean)''' </div>
<div class="NavContent"><cpp>void skip_transfer_enemy(bool val)</cpp>
управляет передачей врагов от друзей. Если установлено в true и видит дружественного монстра, то его враги также становятся врагами.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function character_rank()''' </div>
<div class="NavContent"><cpp>int character_rank()</cpp>
возвращает ранг объекта. Также работает и для объектов-наследников CInventoryOwner. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function jump(const vector&, number)''' </div>
<div class="NavContent"><cpp>void jump(const vector& position, float factor)</cpp>
заставляет объект прыгнуть. Работает только для снорков. Аргументы:
*position - конечные координаты прыжка.
*factor - точно трудно сказать, но похоже, что время прыжка.<br /><br /></div></div>
='''CAI_Bloodsucker'''=
Эти методы можно применять только для кровососа.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_alien_control(boolean)''' </div>
<div class="NavContent"><cpp>void set_alien_control(bool val)</cpp>
устанавливает камеру актера в положение "от глаз монстра" и обратно.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_invisible(boolean)''' </div>
<div class="NavContent"><cpp>void set_invisible(bool val)</cpp>
управляет невидимостью. true - установить, false - убрать.<br /><br /></div></div>
='''CAI_Zombie'''=
Эти методы можно применять только для зомби.
<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_fall_down()''' </div>
<div class="NavContent"><cpp>boolean fake_death_fall_down()</cpp>
проигрывает у зомби анимацию ложной смерти. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fake_death_stand_up()''' </div>
<div class="NavContent"><cpp>boolean fake_death_stand_up()</cpp>
проигрывает у зомби анимацию вставания. Возвращает результат операции. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 15:52, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть I.

2011-12-18T15:55:48Z

K.D.:

'''Game_object''' - класс для доступа к онлайновым (клиентским) объектам. Причём один класс является интерфейсом для совершенно разных объектов. Разработчики не придумали ничего лучше, как взять и объединить в одном классе все интерфейсы всех клиентских объектов: актора, сталкеров, монстров, физических объектов, автомобилей и лампочек, вообще всех. Более странного и вообще говоря уродливого объектно-ориентированного дизайна я ещё не видел. Во-первых, класс вышел совершенно необозримым - три сотни методов! Во-вторых, вызов не подходящего метода для произвольно взятого объекта приводит к совершенно непредсказуемым результатам. В лучшем случае не будет ничего, а чаще всего - будет вылет, причём обычно без лога. Наконец, описание этого класса в lua_help совершенно невнятное (как впрочем и всех остальных классов): типы возвращаемых значений опущены, типы входных аргументов указаны не всегда, а о назначении большинства методов можно только гадать. Предлагаю несколько более внятное описание. Методы рассортированы по клиентским классам, к объектам которых можно применить метод. Также напоминаю, что классы при наследовании также наследуют и все методы родительского класса.
{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
= '''ANY CLASS''' =
Эти методы подходят к объектам любого класса<br /><br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function direction() const''' </div>
<div class="NavContent"><cpp>vector direction() const</cpp>
возвращает направление взгляда (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function position() const''' </div>
<div class="NavContent"><cpp>vector position() const</cpp>
возвращает координаты объекта (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function center() const''' </div>
<div class="NavContent"><cpp>vector center()</cpp>
возвращает координаты центра баунд сферы объекта (физической оболочки, грубо говоря). Практически то же самое, что и position. Обычно используется для проверки вхождения актора в сферу. Возвращает объект класса vector. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function game_vertex_id() const''' </div>
<div class="NavContent"><cpp>int game_vertex_id() const</cpp>
возвращает game_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_id() const''' </div>
<div class="NavContent"><cpp>int level_vertex_id() const</cpp>
возвращает level_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_light() const''' </div>
<div class="NavContent"><cpp>float level_vertex_light(const int level_vertex_id) const</cpp>
Только ТЧ. всегда возвращает 0. Что-то связанное с аи-сеткой, но, видимо, нынче бесполезное.<br /><br /></div></div>
<br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function id() const''' </div>
<div class="NavContent"><cpp>int id() const</cpp>
возвращает id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function name() const''' </div>
<div class="NavContent"><cpp>string name() const</cpp>
возвращает системное имя объекта (обычно выглядит как комбинация имени секции и id). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function section() const''' </div>
<div class="NavContent"><cpp>string section() const</cpp>
возвращает имя секции объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function spawn_ini() const''' </div>
<div class="NavContent"><cpp>ini_file* spawn_ini() const</cpp>
возвращает дескриптор ltx файла (объект класса ini_file), из которого вычитывались настройки спавна объекта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function story_id() const''' </div>
<div class="NavContent"><cpp>int story_id() const</cpp>
возвращает story_id (уникальный идентификатор) объекта. Аргументов не принимает. Если у объекта нет story_id, возвращает -1.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function clsid() const''' </div>
<div class="NavContent"><cpp>int clsid() const</cpp>
возвращает clsid объекта, представляющий собой идентификатор класса. Возвращаемое значение является числовым эквивалентом строкового идентификатора, заданного в конфиге объекта параметром class. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bone_position(string) const''' </div>
<div class="NavContent"><cpp>vector bone_position(string bone_name) const</cpp>
возвращает координаты кости. Принимает один аргумент - имя кости. Может быть применен к любому объекту, но модель объекта при этом должна иметь тип '''MT_SKELETON_ANIM''' или '''MT_SKELETON_RIGID''', короче, иметь эти самые кости<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function binded_object()''' </div>
<div class="NavContent"><cpp>object_binder* binded_object()</cpp>
возвращает объект lua-класса object_binder, привязанный к биндеру функцией bind_object(). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bind_object(object_binder*)''' </div>
<div class="NavContent"><cpp>void bind_object(object_binder* game_object)</cpp>
привязывает объект к биндеру. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<br />
<div class="NavHead">'''function hit(hit*)''' </div>
<div class="NavContent"><cpp>void hit(hit* tpLuaHit)</cpp>
наносит хит объекту. В качестве аргумента передается объект класса hit. У этого объекта обязательно должны быть выставлены свойства '''''draftsman''''', '''''power''''', '''''direction''''', '''''type''''', '''''impulse'''''<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string, boolean)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim, bool mix_in)</cpp>
проигрывает анимацию для объекта. Аргументы:
*anim - имя анимации
*mix_in - как я понял, устанавливает наложение анимации на текущую.
Сам объект может быть любым, но модель объекта должна иметь тип '''MT_SKELETON_ANIM''' (то есть поддерживать анимации).<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim)</cpp>
аналогично предыдущей, mix_in по умолчанию берется true.<br /><br /></div></div>
='''CObject'''=
Поскольку все игровые объекты наследуют от класса '''''CObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function parent() const''' </div>
<div class="NavContent"><cpp>game_object* parent() const</cpp>
возвращает parent объекта. Для предмета в ящике вернет объект ящика. Для инвентарных предметов вернет объект владельца инвентаря - актора, сталкера или монстра. Во всех остальных случаях возвратится 0. К полученному объекту можно применять все методы game_object, подходящие к классу объекта. Аргументов не принимает.<br /><br /></div></div>
='''CUsableScriptObject'''=
Поскольку все игровые объекты наследуют от класса '''''CUsableScriptObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text(string)''' </div>
<div class="NavContent"><cpp>void set_tip_text(string tip_text)</cpp>
устанавливает для объекта текст всплывающей подсказки, передаваемый аргументом tip_text.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text_default()''' </div>
<div class="NavContent"><cpp>void set_tip_text_default()</cpp>
устанавливает для объекта дефолтный текст всплывающей подсказки, установленный при спавне. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_nonscript_usable(boolean)''' </div>
<div class="NavContent"><cpp>void set_nonscript_usable(bool nonscript_usable)</cpp>
устанавливает для объекта возможность взаимодействия с актором.<br /><br /></div></div>
='''CPhysicsShellHolder'''=
Эти методы можно применять для всех объектов, кроме аномалий, переходов, ящиков с инвентарем и прожекторов - всего того, у чего нет физической оболочки.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_shell() const''' </div>
<div class="NavContent"><cpp>physics_shell* get_physics_shell() const</cpp>
возвращает физическую оболочку объекта - объект класса physics_shell. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_const_force(const vector&, number, number)''' </div>
<div class="NavContent"><cpp>void set_const_force(const vector& dir, float value, int time_interval)</cpp>
применяет к физической оболочке объекта силу на некоторое время. Аргументы:
*dir - направление (объект класса vector)
*value - значение силы (float)
*time_interval - продолжительность действия силы (int).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function mass() const''' </div>
<div class="NavContent"><cpp>float mass() const</cpp>
возвращает массу объекта. При применении к неподходящему объекту возвращает -1. Масса, возвращаемая этим методом - не инвентарная, а, видимо, масса для обсчета коллизий. Для патронов, оружия возвращается 0. Аргументов не принимает.<br /><br /></div></div>
='''CEntity'''=
Эти методы можно применять для всех живых объектов (сталкеры, монстры, актор), вертолетов и машин.
<div class="NavFrame collapsed">
<div class="NavHead">'''function alive() const''' </div>
<div class="NavContent"><cpp>bool alive() const</cpp>
возвращает, жив ли объект (проверка на health > 0.0). Для неживых объектов возвращает false. Внимание! health обновляется с некоторым периодом, поэтому при вызове alive() сразу после kill() выдается true. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function death_time() const''' </div>
<div class="NavContent"><cpp>int death_time() const</cpp>
в ЗП нет. Возвращает время смерти объекта в мсек с начала игры. Если объект жив или в принципе неживой, возвратит 0. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function group() const''' </div>
<div class="NavContent"><cpp>int group() const</cpp>
возвращает группу, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function kill(game_object*)''' </div>
<div class="NavContent"><cpp>void kill(game_object* who)</cpp>
убить объект. Аргумент - клиентский объект-убийца. Если не указать, движок считает, что объект самоубился.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function max_health() const''' </div>
<div class="NavContent"><cpp>float max_health() const</cpp>
возвращает максимальный уровень здоровья объекта. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function squad() const''' </div>
<div class="NavContent"><cpp>int squad() const</cpp>
возвращает отряд, к которому принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function team() const''' </div>
<div class="NavContent"><cpp>int team() const</cpp>
возвращает команду, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>
='''CEntityAlive'''=
Эти методы можно применять только для живых объектов - сталкеры, монстры (кроме ворон), актор.
Свойства объектов класса:
<cpp>float satiety; // сытость -- есть, но почему-то не прописан в lua_help
float bleeding; // кровотечение. только ЗП
float health; // здоровье 0..1
float morale; // мораль
float power; // сила
float psy_health;
float radiation; // радиация </cpp>
все свойства на запись работают не так, как на чтение. При записи значение имеет смысл изменения соответствующего свойства. Т.е. если записать 0.1 в health, то это увеличит его на 0.1.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_bleeding() const''' </div>
<div class="NavContent"><cpp>float get_bleeding() const</cpp>
В ЗП нет. Возвращает текущй размер кровотечения. Чем больше у объекта ранений - тем больше кровотечение. Если объект неживой, возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function relation(game_object*)''' </div>
<div class="NavContent"><cpp>ALife::ERelationType relation(game_object* who)</cpp>
возвращает тип отношения обрабатываемого объекта к объекту, передаваемому аргументом who. Объект who также должен наследовать от CEntityAlive. Для трупов или неживых объектов возвращает -1. Возвращаемое значение - член перечисления ALife::ERelationType. В Lua оно экспортировано в виде констант класса game_object.
<cpp>const friend = 0
const neutral = 1
const enemy = 2
const dummy = -1</cpp>
Есть еще две неэкспортированных константы:
<cpp>eRelationTypeWorstEnemy = 0x3
eRelationTypeLast = 0x4</cpp><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_name()''' </div>
<div class="NavContent"><cpp>string who_hit_name()</cpp>
возвращает имя объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_section_name()''' </div>
<div class="NavContent"><cpp>string who_hit_section_name()</cpp>
возвращает имя секции объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fov() const''' </div>
<div class="NavContent"><cpp>float fov() const</cpp>
возвращает угол зрения. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function range() const''' </div>
<div class="NavContent"><cpp>float range() const</cpp>
возвращает максимальную ширину видимой области. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 15:52, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

[[Категория:Скрипты]]

Описание класса game object. Часть I.

2011-12-18T15:53:28Z

K.D.:

'''Game_object''' - класс для доступа к онлайновым (клиентским) объектам. Причём один класс является интерфейсом для совершенно разных объектов. Разработчики не придумали ничего лучше, как взять и объединить в одном классе все интерфейсы всех клиентских объектов: актора, сталкеров, монстров, физических объектов, автомобилей и лампочек, вообще всех. Более странного и вообще говоря уродливого объектно-ориентированного дизайна я ещё не видел. Во-первых, класс вышел совершенно необозримым - три сотни методов! Во-вторых, вызов не подходящего метода для произвольно взятого объекта приводит к совершенно непредсказуемым результатам. В лучшем случае не будет ничего, а чаще всего - будет вылет, причём обычно без лога. Наконец, описание этого класса в lua_help совершенно невнятное (как впрочем и всех остальных классов): типы возвращаемых значений опущены, типы входных аргументов указаны не всегда, а о назначении большинства методов можно только гадать. Предлагаю несколько более внятное описание. Методы рассортированы по клиентским классам, к объектам которых можно применить метод. Также напоминаю, что классы при наследовании также наследуют и все методы родительского класса.
{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
= '''ANY CLASS''' =
Эти методы подходят к объектам любого класса<br /><br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function direction() const''' </div>
<div class="NavContent"><cpp>vector direction() const</cpp>
возвращает направление взгляда (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function position() const''' </div>
<div class="NavContent"><cpp>vector position() const</cpp>
возвращает координаты объекта (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function center() const''' </div>
<div class="NavContent"><cpp>vector center()</cpp>
возвращает координаты центра баунд сферы объекта (физической оболочки, грубо говоря). Практически то же самое, что и position. Обычно используется для проверки вхождения актора в сферу. Возвращает объект класса vector. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function game_vertex_id() const''' </div>
<div class="NavContent"><cpp>int game_vertex_id() const</cpp>
возвращает game_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_id() const''' </div>
<div class="NavContent"><cpp>int level_vertex_id() const</cpp>
возвращает level_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_light() const''' </div>
<div class="NavContent"><cpp>float level_vertex_light(const int level_vertex_id) const</cpp>
Только ТЧ. всегда возвращает 0. Что-то связанное с аи-сеткой, но, видимо, нынче бесполезное.<br /><br /></div></div>
<br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function id() const''' </div>
<div class="NavContent"><cpp>int id() const</cpp>
возвращает id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function name() const''' </div>
<div class="NavContent"><cpp>string name() const</cpp>
возвращает системное имя объекта (обычно выглядит как комбинация имени секции и id). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function section() const''' </div>
<div class="NavContent"><cpp>string section() const</cpp>
возвращает имя секции объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function spawn_ini() const''' </div>
<div class="NavContent"><cpp>ini_file* spawn_ini() const</cpp>
возвращает дескриптор ltx файла (объект класса ini_file), из которого вычитывались настройки спавна объекта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function story_id() const''' </div>
<div class="NavContent"><cpp>int story_id() const</cpp>
возвращает story_id (уникальный идентификатор) объекта. Аргументов не принимает. Если у объекта нет story_id, возвращает -1.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function clsid() const''' </div>
<div class="NavContent"><cpp>int clsid() const</cpp>
возвращает clsid объекта, представляющий собой идентификатор класса. Возвращаемое значение является числовым эквивалентом строкового идентификатора, заданного в конфиге объекта параметром class. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bone_position(string) const''' </div>
<div class="NavContent"><cpp>vector bone_position(string bone_name) const</cpp>
возвращает координаты кости. Принимает один аргумент - имя кости. Может быть применен к любому объекту, но модель объекта при этом должна иметь тип '''MT_SKELETON_ANIM''' или '''MT_SKELETON_RIGID''', короче, иметь эти самые кости<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function binded_object()''' </div>
<div class="NavContent"><cpp>object_binder* binded_object()</cpp>
возвращает объект lua-класса object_binder, привязанный к биндеру функцией bind_object(). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bind_object(object_binder*)''' </div>
<div class="NavContent"><cpp>void bind_object(object_binder* game_object)</cpp>
привязывает объект к биндеру. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<br />
<div class="NavHead">'''function hit(hit*)''' </div>
<div class="NavContent"><cpp>void hit(hit* tpLuaHit)</cpp>
наносит хит объекту. В качестве аргумента передается объект класса hit. У этого объекта обязательно должны быть выставлены свойства '''''draftsman''''', '''''power''''', '''''direction''''', '''''type''''', '''''impulse'''''<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string, boolean)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim, bool mix_in)</cpp>
проигрывает анимацию для объекта. Аргументы:
*anim - имя анимации
*mix_in - как я понял, устанавливает наложение анимации на текущую.
Сам объект может быть любым, но модель объекта должна иметь тип '''MT_SKELETON_ANIM''' (то есть поддерживать анимации).<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim)</cpp>
аналогично предыдущей, mix_in по умолчанию берется true.<br /><br /></div></div>
='''CObject'''=
Поскольку все игровые объекты наследуют от класса '''''CObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function parent() const''' </div>
<div class="NavContent"><cpp>game_object* parent() const</cpp>
возвращает parent объекта. Для предмета в ящике вернет объект ящика. Для инвентарных предметов вернет объект владельца инвентаря - актора, сталкера или монстра. Во всех остальных случаях возвратится 0. К полученному объекту можно применять все методы game_object, подходящие к классу объекта. Аргументов не принимает.<br /><br /></div></div>
='''CUsableScriptObject'''=
Поскольку все игровые объекты наследуют от класса '''''CUsableScriptObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text(string)''' </div>
<div class="NavContent"><cpp>void set_tip_text(string tip_text)</cpp>
устанавливает для объекта текст всплывающей подсказки, передаваемый аргументом tip_text.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text_default()''' </div>
<div class="NavContent"><cpp>void set_tip_text_default()</cpp>
устанавливает для объекта дефолтный текст всплывающей подсказки, установленный при спавне. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_nonscript_usable(boolean)''' </div>
<div class="NavContent"><cpp>void set_nonscript_usable(bool nonscript_usable)</cpp>
устанавливает для объекта возможность взаимодействия с актором.<br /><br /></div></div>
='''CPhysicsShellHolder'''=
Эти методы можно применять для всех объектов, кроме аномалий, переходов, ящиков с инвентарем и прожекторов - всего того, у чего нет физической оболочки.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_shell() const''' </div>
<div class="NavContent"><cpp>physics_shell* get_physics_shell() const</cpp>
возвращает физическую оболочку объекта - объект класса physics_shell. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_const_force(const vector&, number, number)''' </div>
<div class="NavContent"><cpp>void set_const_force(const vector& dir, float value, int time_interval)</cpp>
применяет к физической оболочке объекта силу на некоторое время. Аргументы:
*dir - направление (объект класса vector)
*value - значение силы (float)
*time_interval - продолжительность действия силы (int).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function mass() const''' </div>
<div class="NavContent"><cpp>float mass() const</cpp>
возвращает массу объекта. При применении к неподходящему объекту возвращает -1. Масса, возвращаемая этим методом - не инвентарная, а, видимо, масса для обсчета коллизий. Для патронов, оружия возвращается 0. Аргументов не принимает.<br /><br /></div></div>
='''CEntity'''=
Эти методы можно применять для всех живых объектов (сталкеры, монстры, актор), вертолетов и машин.
<div class="NavFrame collapsed">
<div class="NavHead">'''function alive() const''' </div>
<div class="NavContent"><cpp>bool alive() const</cpp>
возвращает, жив ли объект (проверка на health > 0.0). Для неживых объектов возвращает false. Внимание! health обновляется с некоторым периодом, поэтому при вызове alive() сразу после kill() выдается true. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function death_time() const''' </div>
<div class="NavContent"><cpp>int death_time() const</cpp>
в ЗП нет. Возвращает время смерти объекта в мсек с начала игры. Если объект жив или в принципе неживой, возвратит 0. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function group() const''' </div>
<div class="NavContent"><cpp>int group() const</cpp>
возвращает группу, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function kill(game_object*)''' </div>
<div class="NavContent"><cpp>void kill(game_object* who)</cpp>
убить объект. Аргумент - клиентский объект-убийца. Если не указать, движок считает, что объект самоубился.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function max_health() const''' </div>
<div class="NavContent"><cpp>float max_health() const</cpp>
возвращает максимальный уровень здоровья объекта. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function squad() const''' </div>
<div class="NavContent"><cpp>int squad() const</cpp>
возвращает отряд, к которому принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function team() const''' </div>
<div class="NavContent"><cpp>int team() const</cpp>
возвращает команду, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>
='''CEntityAlive'''=
Эти методы можно применять только для живых объектов - сталкеры, монстры (кроме ворон), актор.
Свойства объектов класса:
<cpp>float satiety; // сытость -- есть, но почему-то не прописан в lua_help
float bleeding; // кровотечение. только ЗП
float health; // здоровье 0..1
float morale; // мораль
float power; // сила
float psy_health;
float radiation; // радиация </cpp>
все свойства на запись работают не так, как на чтение. При записи значение имеет смысл изменения соответствующего свойства. Т.е. если записать 0.1 в health, то это увеличит его на 0.1.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_bleeding() const''' </div>
<div class="NavContent"><cpp>float get_bleeding() const</cpp>
В ЗП нет. Возвращает текущй размер кровотечения. Чем больше у объекта ранений - тем больше кровотечение. Если объект неживой, возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function relation(game_object*)''' </div>
<div class="NavContent"><cpp>ALife::ERelationType relation(game_object* who)</cpp>
возвращает тип отношения обрабатываемого объекта к объекту, передаваемому аргументом who. Объект who также должен наследовать от CEntityAlive. Для трупов или неживых объектов возвращает -1. Возвращаемое значение - член перечисления ALife::ERelationType. В Lua оно экспортировано в виде констант класса game_object.
<cpp>const friend = 0
const neutral = 1
const enemy = 2
const dummy = -1</cpp>
Есть еще две неэкспортированных константы:
<cpp>eRelationTypeWorstEnemy = 0x3
eRelationTypeLast = 0x4</cpp><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_name()''' </div>
<div class="NavContent"><cpp>string who_hit_name()</cpp>
возвращает имя объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_section_name()''' </div>
<div class="NavContent"><cpp>string who_hit_section_name()</cpp>
возвращает имя секции объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fov() const''' </div>
<div class="NavContent"><cpp>float fov() const</cpp>
возвращает угол зрения. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function range() const''' </div>
<div class="NavContent"><cpp>float range() const</cpp>
возвращает максимальную ширину видимой области. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 15:52, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

Описание класса game object. Часть I.

2011-12-18T15:52:50Z

K.D.: переименовал «Описание класса game object» в «Описание класса game object. Часть I.»: Разбиение материала на несколько статей

'''Просьба переименовать статью так: Описание класса game object. Часть I.'''<br />
'''Game_object''' - класс для доступа к онлайновым (клиентским) объектам. Причём один класс является интерфейсом для совершенно разных объектов. Разработчики не придумали ничего лучше, как взять и объединить в одном классе все интерфейсы всех клиентских объектов: актора, сталкеров, монстров, физических объектов, автомобилей и лампочек, вообще всех. Более странного и вообще говоря уродливого объектно-ориентированного дизайна я ещё не видел. Во-первых, класс вышел совершенно необозримым - три сотни методов! Во-вторых, вызов не подходящего метода для произвольно взятого объекта приводит к совершенно непредсказуемым результатам. В лучшем случае не будет ничего, а чаще всего - будет вылет, причём обычно без лога. Наконец, описание этого класса в lua_help совершенно невнятное (как впрочем и всех остальных классов): типы возвращаемых значений опущены, типы входных аргументов указаны не всегда, а о назначении большинства методов можно только гадать. Предлагаю несколько более внятное описание. Методы рассортированы по клиентским классам, к объектам которых можно применить метод. Также напоминаю, что классы при наследовании также наследуют и все методы родительского класса.
{| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
|-
! style="background:#eaf1dd;" align="left"|Навигация
|-
| style="background:#f9f9f9;" align="left"|
[[Описание класса game object. Часть I.]]<br/>
[[Описание класса game object. Часть II.]]<br/>
[[Описание класса game object. Часть III.]]<br/>
[[Описание класса game object. Часть IV.]]<br/>
[[Описание класса game object. Часть V.]]
|-
|}
__TOC__
Клиентский объект можно получить разными способами. В примерах статьи клиентский объект cObj получен с помощью
<lua>local cObj = level.object_by_id(oID)</lua>
= '''ANY CLASS''' =
Эти методы подходят к объектам любого класса<br /><br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function direction() const''' </div>
<div class="NavContent"><cpp>vector direction() const</cpp>
возвращает направление взгляда (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function position() const''' </div>
<div class="NavContent"><cpp>vector position() const</cpp>
возвращает координаты объекта (объект класса vector). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function center() const''' </div>
<div class="NavContent"><cpp>vector center()</cpp>
возвращает координаты центра баунд сферы объекта (физической оболочки, грубо говоря). Практически то же самое, что и position. Обычно используется для проверки вхождения актора в сферу. Возвращает объект класса vector. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function game_vertex_id() const''' </div>
<div class="NavContent"><cpp>int game_vertex_id() const</cpp>
возвращает game_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_id() const''' </div>
<div class="NavContent"><cpp>int level_vertex_id() const</cpp>
возвращает level_vertex_id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function level_vertex_light() const''' </div>
<div class="NavContent"><cpp>float level_vertex_light(const int level_vertex_id) const</cpp>
Только ТЧ. всегда возвращает 0. Что-то связанное с аи-сеткой, но, видимо, нынче бесполезное.<br /><br /></div></div>
<br />
<div class="NavFrame collapsed">
<div class="NavHead">'''function id() const''' </div>
<div class="NavContent"><cpp>int id() const</cpp>
возвращает id объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function name() const''' </div>
<div class="NavContent"><cpp>string name() const</cpp>
возвращает системное имя объекта (обычно выглядит как комбинация имени секции и id). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function section() const''' </div>
<div class="NavContent"><cpp>string section() const</cpp>
возвращает имя секции объекта. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function spawn_ini() const''' </div>
<div class="NavContent"><cpp>ini_file* spawn_ini() const</cpp>
возвращает дескриптор ltx файла (объект класса ini_file), из которого вычитывались настройки спавна объекта.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function story_id() const''' </div>
<div class="NavContent"><cpp>int story_id() const</cpp>
возвращает story_id (уникальный идентификатор) объекта. Аргументов не принимает. Если у объекта нет story_id, возвращает -1.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function clsid() const''' </div>
<div class="NavContent"><cpp>int clsid() const</cpp>
возвращает clsid объекта, представляющий собой идентификатор класса. Возвращаемое значение является числовым эквивалентом строкового идентификатора, заданного в конфиге объекта параметром class. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bone_position(string) const''' </div>
<div class="NavContent"><cpp>vector bone_position(string bone_name) const</cpp>
возвращает координаты кости. Принимает один аргумент - имя кости. Может быть применен к любому объекту, но модель объекта при этом должна иметь тип '''MT_SKELETON_ANIM''' или '''MT_SKELETON_RIGID''', короче, иметь эти самые кости<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function binded_object()''' </div>
<div class="NavContent"><cpp>object_binder* binded_object()</cpp>
возвращает объект lua-класса object_binder, привязанный к биндеру функцией bind_object(). Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function bind_object(object_binder*)''' </div>
<div class="NavContent"><cpp>void bind_object(object_binder* game_object)</cpp>
привязывает объект к биндеру. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<br />
<div class="NavHead">'''function hit(hit*)''' </div>
<div class="NavContent"><cpp>void hit(hit* tpLuaHit)</cpp>
наносит хит объекту. В качестве аргумента передается объект класса hit. У этого объекта обязательно должны быть выставлены свойства '''''draftsman''''', '''''power''''', '''''direction''''', '''''type''''', '''''impulse'''''<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string, boolean)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim, bool mix_in)</cpp>
проигрывает анимацию для объекта. Аргументы:
*anim - имя анимации
*mix_in - как я понял, устанавливает наложение анимации на текущую.
Сам объект может быть любым, но модель объекта должна иметь тип '''MT_SKELETON_ANIM''' (то есть поддерживать анимации).<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function play_cycle(string)''' </div>
<div class="NavContent"><cpp>void play_cycle(string anim)</cpp>
аналогично предыдущей, mix_in по умолчанию берется true.<br /><br /></div></div>
='''CObject'''=
Поскольку все игровые объекты наследуют от класса '''''CObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function parent() const''' </div>
<div class="NavContent"><cpp>game_object* parent() const</cpp>
возвращает parent объекта. Для предмета в ящике вернет объект ящика. Для инвентарных предметов вернет объект владельца инвентаря - актора, сталкера или монстра. Во всех остальных случаях возвратится 0. К полученному объекту можно применять все методы game_object, подходящие к классу объекта. Аргументов не принимает.<br /><br /></div></div>
='''CUsableScriptObject'''=
Поскольку все игровые объекты наследуют от класса '''''CUsableScriptObject''''', следующие методы можно применять к любым объектам.
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text(string)''' </div>
<div class="NavContent"><cpp>void set_tip_text(string tip_text)</cpp>
устанавливает для объекта текст всплывающей подсказки, передаваемый аргументом tip_text.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_tip_text_default()''' </div>
<div class="NavContent"><cpp>void set_tip_text_default()</cpp>
устанавливает для объекта дефолтный текст всплывающей подсказки, установленный при спавне. Аргументов не принимает.<br /><br /></div></div>
<div class="NavFrame collapsed">
<div class="NavHead">'''function set_nonscript_usable(boolean)''' </div>
<div class="NavContent"><cpp>void set_nonscript_usable(bool nonscript_usable)</cpp>
устанавливает для объекта возможность взаимодействия с актором.<br /><br /></div></div>
='''CPhysicsShellHolder'''=
Эти методы можно применять для всех объектов, кроме аномалий, переходов, ящиков с инвентарем и прожекторов - всего того, у чего нет физической оболочки.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_physics_shell() const''' </div>
<div class="NavContent"><cpp>physics_shell* get_physics_shell() const</cpp>
возвращает физическую оболочку объекта - объект класса physics_shell. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function set_const_force(const vector&, number, number)''' </div>
<div class="NavContent"><cpp>void set_const_force(const vector& dir, float value, int time_interval)</cpp>
применяет к физической оболочке объекта силу на некоторое время. Аргументы:
*dir - направление (объект класса vector)
*value - значение силы (float)
*time_interval - продолжительность действия силы (int).<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function mass() const''' </div>
<div class="NavContent"><cpp>float mass() const</cpp>
возвращает массу объекта. При применении к неподходящему объекту возвращает -1. Масса, возвращаемая этим методом - не инвентарная, а, видимо, масса для обсчета коллизий. Для патронов, оружия возвращается 0. Аргументов не принимает.<br /><br /></div></div>
='''CEntity'''=
Эти методы можно применять для всех живых объектов (сталкеры, монстры, актор), вертолетов и машин.
<div class="NavFrame collapsed">
<div class="NavHead">'''function alive() const''' </div>
<div class="NavContent"><cpp>bool alive() const</cpp>
возвращает, жив ли объект (проверка на health > 0.0). Для неживых объектов возвращает false. Внимание! health обновляется с некоторым периодом, поэтому при вызове alive() сразу после kill() выдается true. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function death_time() const''' </div>
<div class="NavContent"><cpp>int death_time() const</cpp>
в ЗП нет. Возвращает время смерти объекта в мсек с начала игры. Если объект жив или в принципе неживой, возвратит 0. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function group() const''' </div>
<div class="NavContent"><cpp>int group() const</cpp>
возвращает группу, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function kill(game_object*)''' </div>
<div class="NavContent"><cpp>void kill(game_object* who)</cpp>
убить объект. Аргумент - клиентский объект-убийца. Если не указать, движок считает, что объект самоубился.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function max_health() const''' </div>
<div class="NavContent"><cpp>float max_health() const</cpp>
возвращает максимальный уровень здоровья объекта. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function squad() const''' </div>
<div class="NavContent"><cpp>int squad() const</cpp>
возвращает отряд, к которому принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function team() const''' </div>
<div class="NavContent"><cpp>int team() const</cpp>
возвращает команду, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.<br /><br /></div></div>
='''CEntityAlive'''=
Эти методы можно применять только для живых объектов - сталкеры, монстры (кроме ворон), актор.
Свойства объектов класса:
<cpp>float satiety; // сытость -- есть, но почему-то не прописан в lua_help
float bleeding; // кровотечение. только ЗП
float health; // здоровье 0..1
float morale; // мораль
float power; // сила
float psy_health;
float radiation; // радиация </cpp>
все свойства на запись работают не так, как на чтение. При записи значение имеет смысл изменения соответствующего свойства. Т.е. если записать 0.1 в health, то это увеличит его на 0.1.
<div class="NavFrame collapsed">
<div class="NavHead">'''function get_bleeding() const''' </div>
<div class="NavContent"><cpp>float get_bleeding() const</cpp>
В ЗП нет. Возвращает текущй размер кровотечения. Чем больше у объекта ранений - тем больше кровотечение. Если объект неживой, возвращает -1. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function relation(game_object*)''' </div>
<div class="NavContent"><cpp>ALife::ERelationType relation(game_object* who)</cpp>
возвращает тип отношения обрабатываемого объекта к объекту, передаваемому аргументом who. Объект who также должен наследовать от CEntityAlive. Для трупов или неживых объектов возвращает -1. Возвращаемое значение - член перечисления ALife::ERelationType. В Lua оно экспортировано в виде констант класса game_object.
<cpp>const friend = 0
const neutral = 1
const enemy = 2
const dummy = -1</cpp>
Есть еще две неэкспортированных константы:
<cpp>eRelationTypeWorstEnemy = 0x3
eRelationTypeLast = 0x4</cpp><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_name()''' </div>
<div class="NavContent"><cpp>string who_hit_name()</cpp>
возвращает имя объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function who_hit_section_name()''' </div>
<div class="NavContent"><cpp>string who_hit_section_name()</cpp>
возвращает имя секции объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function fov() const''' </div>
<div class="NavContent"><cpp>float fov() const</cpp>
возвращает угол зрения. Аргументов не принимает.<br /><br /></div></div>

<div class="NavFrame collapsed">
<div class="NavHead">'''function range() const''' </div>
<div class="NavContent"><cpp>float range() const</cpp>
возвращает максимальную ширину видимой области. Аргументов не принимает.<br /><br /></div></div>

----
Написано [[Участник:K.D.|K.D.]] 15:52, 18 декабря 2011 (UTC) по материалам malandrinus, материалам [http://www.amk-team.ru/forum/index.php?showtopic=7450 форума АМК] и собственным изысканиям.

Описание класса game object. Часть I.

2011-12-18T15:52:02Z

K.D.: Новая страница: «'''Просьба переименовать статью так: Описание класса game object. Часть I.'''<br /> '''Game_object''' - класс д...»