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

Game_object - класс для доступа к онлайновым (клиентским) объектам. Причём один класс является интерфейсом для совершенно разных объектов. Разработчики не придумали ничего лучше, как взять и объединить в одном классе все интерфейсы всех клиентских объектов: актора, сталкеров, монстров, физических объектов, автомобилей и лампочек, вообще всех. Более странного и вообще говоря уродливого объектно-ориентированного дизайна я ещё не видел. Во-первых, класс вышел совершенно необозримым - три сотни методов! Во-вторых, вызов не подходящего метода для произвольно взятого объекта приводит к совершенно непредсказуемым результатам. В лучшем случае не будет ничего, а чаще всего - будет вылет, причём обычно без лога. Наконец, описание этого класса в lua_help совершенно невнятное (как впрочем и всех остальных классов): типы возвращаемых значений опущены, типы входных аргументов указаны не всегда, а о назначении большинства методов можно только гадать. Предлагаю несколько более внятное описание. Методы рассортированы по клиентским классам, к объектам которых можно применить метод. Также напоминаю, что классы при наследовании также наследуют и все методы родительского класса.

Навигация
Описание класса game object. Часть I. Описание класса game object. Часть II. Описание класса game object. Часть III. Описание класса game object. Часть IV. Описание класса game object. Часть V.

ANY CLASS

Эти методы подходят к объектам любого класса

function direction() const

vector direction() const

возвращает направление взгляда (объект класса vector). Аргументов не принимает.

function position() const

vector position() const

возвращает координаты объекта (объект класса vector). Аргументов не принимает.

function center() const

vector center()

возвращает координаты центра баунд сферы объекта (физической оболочки, грубо говоря). Практически то же самое, что и position. Обычно используется для проверки вхождения актора в сферу. Возвращает объект класса vector. Аргументов не принимает.

function game_vertex_id() const

int game_vertex_id() const

возвращает game_vertex_id объекта. Аргументов не принимает.

function level_vertex_id() const

int level_vertex_id() const

возвращает level_vertex_id объекта. Аргументов не принимает.

function level_vertex_light() const

float level_vertex_light(const int level_vertex_id) const

Только ТЧ. всегда возвращает 0. Что-то связанное с аи-сеткой, но, видимо, нынче бесполезное.

function id() const

int id() const

возвращает id объекта. Аргументов не принимает.

function name() const

string name() const

возвращает системное имя объекта (обычно выглядит как комбинация имени секции и id). Аргументов не принимает.

function section() const

string section() const

возвращает имя секции объекта. Аргументов не принимает.

function spawn_ini() const

ini_file* spawn_ini() const

возвращает дескриптор ltx файла (объект класса ini_file), из которого вычитывались настройки спавна объекта.

function story_id() const

int story_id() const

возвращает story_id (уникальный идентификатор) объекта. Аргументов не принимает. Если у объекта нет story_id, возвращает -1.

function clsid() const

int clsid() const

возвращает clsid объекта, представляющий собой идентификатор класса. Возвращаемое значение является числовым эквивалентом строкового идентификатора, заданного в конфиге объекта параметром class. Аргументов не принимает.

function bone_position(string) const

vector bone_position(string bone_name) const

возвращает координаты кости. Принимает один аргумент - имя кости. Может быть применен к любому объекту, но модель объекта при этом должна иметь тип MT_SKELETON_ANIM или MT_SKELETON_RIGID, короче, иметь эти самые кости

function binded_object()

object_binder* binded_object()

возвращает объект lua-класса object_binder, привязанный к биндеру функцией bind_object(). Аргументов не принимает.

function bind_object(object_binder*)

void bind_object(object_binder* game_object)

привязывает объект к биндеру. Аргументов не принимает.

function hit(hit*)

void hit(hit* tpLuaHit)

наносит хит объекту. В качестве аргумента передается объект класса hit. У этого объекта обязательно должны быть выставлены свойства draftsman, power, direction, type, impulse

function play_cycle(string, boolean)

void play_cycle(string anim, bool mix_in)

проигрывает анимацию для объекта. Аргументы:

• anim - имя анимации
• mix_in - как я понял, устанавливает наложение анимации на текущую.

Сам объект может быть любым, но модель объекта должна иметь тип MT_SKELETON_ANIM (то есть поддерживать анимации).

function play_cycle(string)

void play_cycle(string anim)

аналогично предыдущей, mix_in по умолчанию берется true.

CObject

Поскольку все игровые объекты наследуют от класса CObject, следующие методы можно применять к любым объектам.

function parent() const

game_object* parent() const

возвращает parent объекта. Для предмета в ящике вернет объект ящика. Для инвентарных предметов вернет объект владельца инвентаря - актора, сталкера или монстра. Во всех остальных случаях возвратится 0. К полученному объекту можно применять все методы game_object, подходящие к классу объекта. Аргументов не принимает.

Добавлено в ЗП:

function get_visual_name() const

string get_visual_name() const

возвращает визуал объекта в виде имени модели. Аргументов не принимает.

function set_visual_name(string)

void set_visual_name(string visual_name)

устанавливает визуал объекта. В качестве аргумента необходимо задавать полный путь до модели от папки meshes.

CUsableScriptObject

Поскольку все игровые объекты наследуют от класса CUsableScriptObject, следующие методы можно применять к любым объектам.

function set_tip_text(string)

void set_tip_text(string tip_text)

устанавливает для объекта текст всплывающей подсказки, передаваемый аргументом tip_text.

function set_tip_text_default()

void set_tip_text_default()

устанавливает для объекта дефолтный текст всплывающей подсказки, установленный при спавне. Аргументов не принимает.

function set_nonscript_usable(boolean)

void set_nonscript_usable(bool nonscript_usable)

устанавливает для объекта возможность взаимодействия с актором.

CPhysicsShellHolder

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

function get_physics_shell() const

physics_shell* get_physics_shell() const

возвращает физическую оболочку объекта - объект класса physics_shell. Аргументов не принимает.

function set_const_force(const vector&, number, number)

void set_const_force(const vector& dir, float value, int time_interval)

применяет к физической оболочке объекта силу на некоторое время. Аргументы:

• dir - направление (объект класса vector)
• value - значение силы (float)
• time_interval - продолжительность действия силы (int).
  
  

function mass() const

float mass() const

возвращает массу объекта. При применении к неподходящему объекту возвращает -1. Масса, возвращаемая этим методом - не инвентарная, а, видимо, масса для обсчета коллизий. Для патронов, оружия возвращается 0. Аргументов не принимает.

CEntity

Эти методы можно применять для всех живых объектов (сталкеры, монстры, актор), вертолетов и машин.

function alive() const

bool alive() const

возвращает, жив ли объект (проверка на health > 0.0). Для неживых объектов возвращает false. Внимание! health обновляется с некоторым периодом, поэтому при вызове alive() сразу после kill() выдается true. Аргументов не принимает.

function death_time() const

int death_time() const

в ЗП нет. Возвращает время смерти объекта в мсек с начала игры. Если объект жив или в принципе неживой, возвратит 0. Аргументов не принимает.

function group() const

int group() const

возвращает группу, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.

function kill(game_object*)

void kill(game_object* who)

убить объект. Аргумент - клиентский объект-убийца. Если не указать, движок считает, что объект самоубился.

function max_health() const

float max_health() const

возвращает максимальный уровень здоровья объекта. Для неживых объектов возвращает -1. Аргументов не принимает.

function squad() const

int squad() const

возвращает отряд, к которому принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.

function team() const

int team() const

возвращает команду, к которой принадлежит объект. Для неживых объектов возвращает -1. Аргументов не принимает.

CEntityAlive

Эти методы можно применять только для живых объектов - сталкеры, монстры (кроме ворон), актор. Свойства объектов класса:

float satiety;    // сытость  -- есть, но почему-то не прописан в lua_help
float bleeding;   // кровотечение. только ЗП
float health;     // здоровье 0..1 
float morale;     // мораль 
float power;      // сила 
float psy_health; // пси-здоровье
float radiation;  // радиация 

все свойства на запись работают не так, как на чтение. При записи значение имеет смысл изменения соответствующего свойства. Т.е. если записать 0.1 в health, то это увеличит его на 0.1.

function get_bleeding() const

float get_bleeding() const

В ЗП нет. Возвращает текущй размер кровотечения. Чем больше у объекта ранений - тем больше кровотечение. Если объект неживой, возвращает -1. Аргументов не принимает.

function relation(game_object*)

ALife::ERelationType relation(game_object* who)

возвращает тип отношения обрабатываемого объекта к объекту, передаваемому аргументом who. Объект who также должен наследовать от CEntityAlive. Для трупов или неживых объектов возвращает -1. Возвращаемое значение - член перечисления ALife::ERelationType. В Lua оно экспортировано в виде констант класса game_object.

const friend = 0
const neutral = 1
const enemy = 2
const dummy = -1

Есть еще две неэкспортированных константы:

eRelationTypeWorstEnemy = 0x3
eRelationTypeLast = 0x4

function who_hit_name()

string who_hit_name()

возвращает имя объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.

function who_hit_section_name()

string who_hit_section_name()

возвращает имя секции объекта, последнего нанесшего хит обрабатываемому объекту. Аргументов не принимает.

function fov() const

float fov() const

возвращает угол зрения. Аргументов не принимает.

function range() const

float range() const

возвращает максимальную ширину видимой области. Аргументов не принимает.

---

Написано K.D. 15:52, 18 декабря 2011 (UTC) по материалам malandrinus, материалам форума АМК и собственным изысканиям.