FOnline
Открытые члены | Открытые атрибуты | Полный список членов класса
Класс CritterCl

Функционально ограниченный эквивалент класса Critter, доступный при скриптинге клиента. Подробнее...

Открытые члены

bool  IsChosen ()
  Позволяет проверить, является ли криттер тем игроком, для которого запущен клиент. Подробнее...
 
bool  IsPlayer ()
  Позволяет проверить, является ли криттер игроком. Подробнее...
 
bool  IsNpc ()
  Позволяет проверить, является ли криттер NPC. Подробнее...
 
bool  IsLife ()
  Проверяет, жив ли криттер. Подробнее...
 
bool  IsKnockout ()
  Проверяет, находится ли криттер в нокдауне. Подробнее...
 
bool  IsDead ()
  Проверяет, мёртв ли криттер. Подробнее...
 
bool  IsFree ()
  Проверяет, свободен ли криттер или нет. Подробнее...
 
bool  IsBusy ()
  Проверяет, занят ли криттер или нет. Подробнее...
 
bool  IsTurnBasedTurn ()
  Проверяет, ход криттера ли в данный момент в пошаговом бою. Подробнее...
 
uint  GetTurnBasedTime ()
  Возвращает время до окончания хода. Подробнее...
 
uint  ItemsCount ()
  Возвращает количество всех предметов, находящихся в инвентаре криттера. Подробнее...
 
uint  ItemsWeight ()
  Возвращает общий вес всех предметов, находящихся в инвентаре криттера. Подробнее...
 
uint  ItemsVolume ()
  Возвращает общий объем всех предметов, находящихся в инвентаре криттера. Подробнее...
 
uint  CountItem (uint16 protoId)
  Возвращает количество указанных предметов, находящихся в инвентаре криттера. Подробнее...
 
ItemCl  GetItem (uint16 protoId, int slot)
  Возвращает указатель на объект предмета, который находится в инвентаре криттера. Подробнее...
 
uint  GetItems (int slot, ItemCl @[]@+items)
  Находит все предметы, которые находятся в инвентаре. Подробнее...
 
uint  GetItemsByType (int type, Item @[]@+items)
  Позволяет получить все предметы указанного типа, находящиеся в инвентаре криттера. Подробнее...
 
ProtoItem  GetSlotProto (int slot, uint8 &mode)
  Позволяет получить прототип предмета, который находится в указанном слоте. Подробнее...
 
bool  CheckKey (uint doorId)
  Проверяет, есть ли у криттера ключ от указанного замка. Подробнее...
 
void  SetVisible (bool visible)
  Позволяет включить/отключить видимость криттера в клиенте в совокупности с его освещением и яйцом прозрачности. Подробнее...
 
bool  GetVisible ()
  Позволяет проверить видим ли криттер в клиенте. Подробнее...
 
ProtoItem  GetSlotProto (int slot)
  Возвращает прототип предмета, находящегося в указанном слоте криттера. Подробнее...
 
uint  GetMultihex ()
  Возвращает значение мултигексовости для персонажа Подробнее...
 
Анимация
bool  IsAnimAviable (uint anim1, uint anim2)
  Позволяет проверить, существует ли указанная анимация для криттера. Подробнее...
 
bool  IsAnimPlaying ()
  Позволяет проверить, проигрывается ли в данный момент какая-либо анимация. Подробнее...
 
uint  GetAnim1 ()
  Возвращает индекс текущей анимации Anim1. Подробнее...
 
void  Animate (uint anim1, uint anim2)
  Ставит указанную анимацию в очередь проигрываемых анимаций криттера. Подробнее...
 
void  Animate (uint anim1, uint anim2, ItemCl @+item)
  Ставит указанную анимацию в очередь проигрываемых анимаций криттера. Подробнее...
 
void  ClearAnim ()
  Очищает очередь анимаций и прекращает проигрывание текущей. Подробнее...
 

Открытые атрибуты

const uint  Id
  Уникальный идентификатор криттера. Подробнее...
 
const uint16  Pid
  Номер прототипа криттера. Подробнее...
 
const uint8  CrType
  Базовый тип анимации криттера. Подробнее...
 
const uint8  CrTypeAlias
  Дополнительный базовый тип. Подробнее...
 
const uint16  HexX
  Координата, по оси X, расположения криттера на карте. Подробнее...
 
const uint16  HexY
  Координата, по оси Y, расположения криттера на карте. Подробнее...
 
const uint8  Dir
  Направление, в которое повернут криттер. Подробнее...
 
const uint16  FlagsExt
  Флаги криттера, предназначенные только для чтения. Подробнее...
 
DataVal  Param
  Массив значений параметров криттера. Подробнее...
 
string  NameOnHead
  Если данная строка не пустая, то выводится над головой криттера, в противном случае выводится имя криттера. Подробнее...
 
uint  NameColor
  Цвет имени над головой криттера Подробнее...
 
uint  ContourColor
  Цвет обводки криттера Подробнее...
 
int[]  Anim3dLayer
  Значения слоев 3D-модели криттера. Подробнее...
 
const uint  Life
  Уточняет состояние криттера. Подробнее...
 
const uint  Knockout
  Уточняет состояние криттера. Подробнее...
 
const uint  Dead
  Уточняет состояние криттера. Подробнее...
 

Подробное описание

Функционально ограниченный эквивалент класса Critter, доступный при скриптинге клиента.

Обладает меньшим функционалом по сравнению с серверным: почти все статы, навыки, перки и т.п. можно просмотреть только у самого игрока, про что не следует забывать.

Методы

bool IsChosen ( )

Позволяет проверить, является ли криттер тем игроком, для которого запущен клиент.

bool IsPlayer ( )

Позволяет проверить, является ли криттер игроком.

Возвращает
true – если криттер является игроком; false – в противном случае.
bool IsNpc ( )

Позволяет проверить, является ли криттер NPC.

Возвращает
true – если криттер является NPC; false – в противном случае.
bool IsLife ( )

Проверяет, жив ли криттер.

Возвращает
true – если криттер жив; false – в противном случае.
См. также
IsDead
IsKnockout
bool IsKnockout ( )

Проверяет, находится ли криттер в нокдауне.

Возвращает
true – если криттер в нокдауне; false – в противном случае.
См. также
IsDead
IsLife
bool IsDead ( )

Проверяет, мёртв ли криттер.

Возвращает
true – если криттер мёртв; false – в противном случае.
См. также
IsKnockout
IsLife
bool IsFree ( )

Проверяет, свободен ли криттер или нет.

Возвращает
true – если криттер свободен; false – в противном случае.
См. также
IsBusy
bool IsBusy ( )

Проверяет, занят ли криттер или нет.

Возвращает
true – если криттер занят; false – в противном случае.
См. также
IsFree
bool IsTurnBasedTurn ( )

Проверяет, ход криттера ли в данный момент в пошаговом бою.

Возвращает
true – если ход данного криттера; false – в противном случае.
uint GetTurnBasedTime ( )

Возвращает время до окончания хода.

Возвращает
время в миллисекундах.
uint ItemsCount ( )

Возвращает количество всех предметов, находящихся в инвентаре криттера.

Возвращает
Количество всех предметов.
uint ItemsWeight ( )

Возвращает общий вес всех предметов, находящихся в инвентаре криттера.

Возвращает
Общий вес предметов в инвентаре.
uint ItemsVolume ( )

Возвращает общий объем всех предметов, находящихся в инвентаре криттера.

Возвращает
Общий объем предметов в инвентаре.
uint CountItem ( uint16  protoId )

Возвращает количество указанных предметов, находящихся в инвентаре криттера.

Аргументы
protoId ID прототипа предмета (см. файл ITEMPID.H).
Возвращает
Количество предметов с указанным прототипом, находящихся в инвентаре.
ItemCl GetItem ( uint16  protoId,
int  slot 
)

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

Аргументы
protoId ID прототипа предмета (см. файл ITEMPID.H).
slot Слот, в котором находится предмет (см. Slots). Если установлено значение: -1, то слот учитываться не будет.
Возвращает
Указатель на экземпляр класса ItemCl. В случае провала – null.
uint GetItems ( int  slot,
ItemCl @@+[]  items 
)

Находит все предметы, которые находятся в инвентаре.

Аргументы
items Массив указателей на предметы, которые находятся в инвентаре. Массив не очищается, а дописывается с конца нужными предметами.
slot Слот, в котором находятся предметы (см. Slots). Если установлено значение: -1, то слот учитываться не будет.
Возвращает
Количество найденных предметов.
uint GetItemsByType ( int  type,
Item @@+[]  items 
)

Позволяет получить все предметы указанного типа, находящиеся в инвентаре криттера.

Аргументы
type Тип предмета (см. Items types).
items Массив, в конец которого будут записаны найденные предметы.
Возвращает
Количество предметов указанного типа.
ProtoItem GetSlotProto ( int  slot,
uint8 &  mode 
)

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

Аргументы
slot Слот (см. Slots).
mode В аргументе возвращается текущий режим атаки, если объект в слоте является оружием старшие четыре бита - прицел (см. Hit Locations), младшие четыре бита - тип использования (0 – primary, 1 – secondary, 2 – third).
Возвращает
Указатель на экземпляр класса ProtoItem. Если слот пуст, то возвращается null.
bool CheckKey ( uint  doorId )

Проверяет, есть ли у криттера ключ от указанного замка.

Аргументы
doorId Уникальный номер замка. Так же учитывается сетчатка криттера и отпечатки пальцев. Эти номера уникальны для каждого криттера.
Возвращает
true – если у криттера есть такой ключ; false – если такого ключа нет.
void SetVisible ( bool  visible )

Позволяет включить/отключить видимость криттера в клиенте в совокупности с его освещением и яйцом прозрачности.

Аргументы
visible Устанавливаемое значение.
См. также
GetVisible
bool GetVisible ( )

Позволяет проверить видим ли криттер в клиенте.

Возвращает
true – если криттер виден; false – в противном случае.
См. также
SetVisible
ProtoItem GetSlotProto ( int  slot )

Возвращает прототип предмета, находящегося в указанном слоте криттера.

Аргументы
slot См. Slots.
Возвращает
Указатель на экземпляр класса ProtoItem. Если в слоте ничего нет – null.
uint GetMultihex ( )

Возвращает значение мултигексовости для персонажа

bool IsAnimAviable ( uint  anim1,
uint  anim2 
)

Позволяет проверить, существует ли указанная анимация для криттера.

Аргументы
anim1 Первый индекс анимации (см. ANIM1_* в _animation.fos).
anim2 Второй индекс анимации (см. ANIM2_* в _animation.fos).
Возвращает
true, если существует; false – в противном случае.
bool IsAnimPlaying ( )

Позволяет проверить, проигрывается ли в данный момент какая-либо анимация.

uint GetAnim1 ( )

Возвращает индекс текущей анимации Anim1.

Возвращает
Cм. ANIM1_* в _animation.fos.
void Animate ( uint  anim1,
uint  anim2 
)

Ставит указанную анимацию в очередь проигрываемых анимаций криттера.

Аргументы
anim1 Первый индекс анимации (см. ANIM1_* в _animation.fos).
anim2 Второй индекс анимации (см. ANIM2_* в _animation.fos).
См. также
animation2d_process
animation3d_process
void Animate ( uint  anim1,
uint  anim2,
ItemCl @+  item 
)

Ставит указанную анимацию в очередь проигрываемых анимаций криттера.

Аргументы
anim1 Первый индекс анимации (см. ANIM1_* в _animation.fos).
anim2 Второй индекс анимации (см. ANIM2_* в _animation.fos).
item Указатель на предмет, используемый в анимации.
См. также
animation2d_process
animation3d_process
void ClearAnim ( )

Очищает очередь анимаций и прекращает проигрывание текущей.

Данные класса

const uint Id

Уникальный идентификатор криттера.

const uint16 Pid

Номер прототипа криттера.

const uint8 CrType

Базовый тип анимации криттера.

const uint8 CrTypeAlias

Дополнительный базовый тип.

const uint16 HexX

Координата, по оси X, расположения криттера на карте.

const uint16 HexY

Координата, по оси Y, расположения криттера на карте.

const uint8 Dir

Направление, в которое повернут криттер.

const uint16 FlagsExt

Флаги криттера, предназначенные только для чтения.

См. Critter extra flags.

DataVal Param

Массив значений параметров криттера.

string NameOnHead

Если данная строка не пустая, то выводится над головой криттера, в противном случае выводится имя криттера.

См __ShowNpcNames.

uint NameColor

Цвет имени над головой криттера

uint ContourColor

Цвет обводки криттера

int [] Anim3dLayer

Значения слоев 3D-модели криттера.

Значения смотрите в _animations.fos, 3d models layers.

const uint Life

Уточняет состояние криттера.

Используется для анимаций.

const uint Knockout

Уточняет состояние криттера.

Используется для анимаций.

const uint Dead

Уточняет состояние криттера.

Используется для анимаций.

Converted from CHM to HTML with chm2web Pro 2.85 (unicode)