Описание класса game object. Часть I. - История изменений

K.D.: /* CObject */

2011-12-19T17:01:01Z

‎CObject

109.127.186.34: /* CEntityAlive */

2011-12-19T15:01:44Z

‎CEntityAlive

K.D. в 15:55, 18 декабря 2011

2011-12-18T15:55:48Z

K.D. в 15:53, 18 декабря 2011

2011-12-18T15:53:28Z

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

2011-12-18T15:52:50Z

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

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

2011-12-18T15:52:02Z

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

Новая страница

'''Просьба переименовать статью так: Описание класса 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 форума АМК] и собственным изысканиям.

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

@@ Строка 98: / Строка 98: @@
 <div class="NavContent"><cpp>game_object* parent() const</cpp>
 возвращает parent объекта. Для предмета в ящике вернет объект ящика. Для инвентарных предметов вернет объект владельца инвентаря - актора, сталкера или монстра. Во всех остальных случаях возвратится 0. К полученному объекту можно применять все методы game_object, подходящие к классу объекта. Аргументов не принимает.<br /><br /></div></div>
 ='''CUsableScriptObject'''=
 Поскольку все игровые объекты наследуют от класса '''''CUsableScriptObject''''', следующие методы можно применять к любым объектам.

@@ Строка 175: / Строка 175: @@
 float morale;     // мораль
 float power;      // сила
-float psy_health;
+float psy_health; // пси-здоровье
 float radiation;  // радиация </cpp>
 все свойства на запись работают не так, как на чтение. При записи значение имеет смысл изменения соответствующего свойства. Т.е. если записать 0.1 в health, то это увеличит его на 0.1.

@@ Строка 1: / Строка 1: @@
 '''Game_object''' - класс для доступа к онлайновым (клиентским) объектам. Причём один класс является интерфейсом для совершенно разных объектов. Разработчики не придумали ничего лучше, как взять и объединить в одном классе все интерфейсы всех клиентских объектов: актора, сталкеров, монстров, физических объектов, автомобилей и лампочек, вообще всех. Более странного и вообще говоря уродливого объектно-ориентированного дизайна я ещё не видел. Во-первых, класс вышел совершенно необозримым - три сотни методов! Во-вторых, вызов не подходящего метода для произвольно взятого объекта приводит к совершенно непредсказуемым результатам. В лучшем случае не будет ничего, а чаще всего - будет вылет, причём обычно без лога. Наконец, описание этого класса в lua_help совершенно невнятное (как впрочем и всех остальных классов): типы возвращаемых значений опущены, типы входных аргументов указаны не всегда, а о назначении большинства методов можно только гадать. Предлагаю несколько более внятное описание. Методы рассортированы по клиентским классам, к объектам которых можно применить метод. Также напоминаю, что классы при наследовании также наследуют и все методы родительского класса.
 {| border="0" cellpadding="3" align="right" width="250" cellspacing="1" style="background:#ccc;"
@@ Строка 14: / Строка 13: @@
   |}
 __TOC__
 = '''ANY CLASS'''	 =
 Эти методы подходят к объектам любого класса<br /><br />

← Предыдущая	Версия 15:52, 18 декабря 2011
(нет различий)