FOnline
Классы
Стандартные классы и функции

Список стандартных классов и функций. Подробнее...

Классы

class   dictionary
  Класс, представляющий собой ассоциативный контейнер, отображающий множество строковых ключей в множество значений любого типа. Подробнее...
 
class   file
  Класс, предназначенный для чтения и записи текстовых файлов. Подробнее...
 
class   string
  Класс для работы со строками. Подробнее...
 

Игровые функции

void  AllowSlot (uint8 index, string &iniOption)
  Разрешает использование дополнительного слота с указанным номером. Подробнее...
 
void  SetRegistrationParameter (uint index, bool enabled)
  Позволяет определить параметры, которые отсылаются серверу при регистрации. Подробнее...
 

Математические функции

float  cos (float x)
  Возвращает косинус указанного угла. Подробнее...
 
float  sin (float x)
  Возвращает синус указанного угла. Подробнее...
 
float  tan (float x)
  Возвращает тангенс указанного угла. Подробнее...
 
float  acos (float x)
  Возвращает угол, косинус которого равен указанному числу. Подробнее...
 
float  asin (float x)
  Возвращает угол, синус которого равен указанному числу. Подробнее...
 
float  atan (float x)
  Возвращает угол, тангенс которого равен указанному числу. Подробнее...
 
float  atan2 (float y, float x)
  Возвращает угол, тангенс которого равен отношению двух указанных чисел. Подробнее...
 
float  cosh (float x)
  Возвращает гиперболический косинус указанного угла. Подробнее...
 
float  sinh (float x)
  Возвращает гиперболический синус указанного угла. Подробнее...
 
float  tanh (float x)
  Возвращает гиперболический тангенс указанного угла. Подробнее...
 
float  log (float x)
  Возвращает натуральный логарифм указанного числа. Подробнее...
 
float  log10 (float x)
  Возвращает десятичный логарифм указанного числа. Подробнее...
 
float  pow (float base, float exponent)
  Возвращает указанное число, возведенное в указанную степень. Подробнее...
 
float  sqrt (float x)
  Возвращает квадратный корень из указанного числа. Подробнее...
 
float  ceil (float x)
  Возвращает наименьшее целое число, которое больше или равно заданному числу. Подробнее...
 
float  abs (float x)
  Возвращает абсолютное значение указанного числа. Подробнее...
 
float  floor (float x)
  Возвращает наибольшее целое число, которое меньше или равно указанному числу. Подробнее...
 
float  fraction (float x)
  Возвращает дробную часть указанного числа. Подробнее...
 

Функции для работы со строками

string  substring (const string &in str, int start, int length)
  Возвращает подстроку указанной строки. Подробнее...
 
int  findFirst (const string &in str, const string &in sub)
  Возвращает индекс первого вхождения указанной подстроки в указанной входной строке. Подробнее...
 
int  findFirst (const string &in str, const string &in sub, int startAt)
  Возвращает индекс первого вхождения указанной подстроки в указанной входной строке. Подробнее...
 
int  findLast (const string &in str, const string &in sub)
  Возвращает индекс последнего вхождения указанной подстроки в указанной входной строке. Подробнее...
 
int  findLast (const string &in str, const string &in sub, int startAt)
  Возвращает индекс последнего вхождения указанной подстроки в указанной входной строке. Подробнее...
 
int  findFirstOf (const string &in str, const string &in set)
  Возвращает индекс первого встретившегося символа во входной строке, принадлежащего указанному множеству символов. Подробнее...
 
int  findFirstOf (const string &in str, const string &in set, int startAt)
  Возвращает индекс первого встретившегося символа во входной строке, принадлежащего указанному множеству символов. Подробнее...
 
int  findFirstNotOf (const string &in str, const string &in set)
  Возвращает индекс первого встретившегося символа во входной строке, не принадлежащего указанному множеству символов. Подробнее...
 
int  findFirstNotOf (const string &in str, const string &in set, int startAt)
  Возвращает индекс первого встретившегося символа во входной строке, не принадлежащего указанному множеству символов. Подробнее...
 
int  findLastOf (const string &in str, const string &in set)
  Возвращает индекс последнего встретившегося символа во входной строке, принадлежащего указанному множеству символов. Подробнее...
 
int  findLastOf (const string &in str, const string &in set, int startAt)
  Возвращает индекс последнего встретившегося символа во входной строке, принадлежащего указанному множеству символов. Подробнее...
 
int  findLastNotOf (const string &in str, const string &in set)
  Возвращает индекс последнего встретившегося символа во входной строке, не принадлежащего указанному множеству символов. Подробнее...
 
int  findLastNotOf (const string &in str, const string &in set, int startAt)
  Возвращает индекс последнего встретившегося символа во входной строке, не принадлежащего указанному множеству символов. Подробнее...
 
string[]  split (const string &in str, const string &in delimiter)
  Разбивает указанную строку на подстроки, используя указанный разделитель. Подробнее...
 
string[]  splitEx (const string &in str, const string &in delimiter)
  Разбивает указанную строку на подстроки, используя указанный разделитель. Подробнее...
 
string  join (const string @[]&in str, const string &in delimiter)
  Объединяет строки из заданного массива в одну строку, разделяя их при этом указанной строкой. Подробнее...
 
string  strlwr (const string &in str)
  Переводит строку в нижний регистр. Подробнее...
 
string  strupr (const string &in str)
  Переводит строку в верхний регистр. Подробнее...
 
uint  GetStrHash (string @str)
  Высчитывает хэш строки. Подробнее...
 

Прочее

int  GetCritterAnimType (uint crType)
  Возвращает вид криттера (Fallout, Tactics, Arcanum, etc) по номеру CritterType. Подробнее...
 
uint  GetCritterAlias (uint crType) string @GetCritterTypeName(uint crType) string @GetCritterSoundName(uint crType) bool IsCritterCanArmor(uint crType)
  возвращает значение Alias из CritterTypes.fos. Подробнее...
 
bool  IsCritterCanWalk (uint crType)
  возвращает возможность перемещения для заданного типа криттера. Подробнее...
 
bool  IsCritterCanRun (uint crType)
  возвращает возможность перемещения бегом для заданного типа криттера. Подробнее...
 
bool  IsCritterCanRotate (uint crType)
  возвращает возможность изменения направления для заданного типа криттера. Подробнее...
 
bool  IsCritterCanAim (uint crType)
  возвращает возможность прицельной атаки для заданного типа криттера. Подробнее...
 
bool  IsCritterAnim1 (uint crType, uint anim1)
  возвращает возможность анимации(?) для заданного типа криттера. Подробнее...
 

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

Список стандартных классов и функций.

Представленные здесь классы и функции доступны при скриптинге как клиентской, так и серверной части FOnline.

Функции

void AllowSlot ( uint8  index,
string iniOption 
)

Разрешает использование дополнительного слота с указанным номером.

Аргументы
index Номер слота. Должен быть больше 3 (слоты с номерами 0-3 являются стандартными).
iniOption Обозначение региона слота в ini-файлах интерфейса.
См. также
Слоты
ProtoItem::Slot
void SetRegistrationParameter ( uint  index,
bool  enabled 
)

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

Прим.
Все остальные параметры будут равны нулю.
Работает по принципу функции Critter::SetSendParam.
float cos ( float  x )

Возвращает косинус указанного угла.

Аргументы
x Угол, измеряемый в радианах.
Возвращает
Косинус x.
float sin ( float  x )

Возвращает синус указанного угла.

Аргументы
x Угол, измеряемый в радианах.
Возвращает
Синус x.
float tan ( float  x )

Возвращает тангенс указанного угла.

Аргументы
x Угол, измеряемый в радианах.
Возвращает
Тангенс x.
float acos ( float  x )

Возвращает угол, косинус которого равен указанному числу.

Аргументы
x Число в интервале [-1,+1], представляющее косинус.
Возвращает
Угол, измеренный в радианах, в интервале [0,pi] радиан.
float asin ( float  x )

Возвращает угол, синус которого равен указанному числу.

Аргументы
x Число в интервале [-1,+1], представляющее синус.
Возвращает
Угол, измеренный в радианах, в интервале [-pi/2,+pi/2] радиан.
float atan ( float  x )

Возвращает угол, тангенс которого равен указанному числу.

Аргументы
x Число представляющее тангенс.
Возвращает
Угол, измеренный в радианах, в интервале [-pi/2,+pi/2] радиан.
float atan2 ( float  y,
float  x 
)

Возвращает угол, тангенс которого равен отношению двух указанных чисел.

Аргументы
y Координата y точки.
x Координата х точки.
Возвращает
Угол, измеренный в радианах, в интервале [-pi,+pi] радиан, и тангенс которого равен y/x, где (x, y) – это точка в декартовой системе координат.
float cosh ( float  x )

Возвращает гиперболический косинус указанного угла.

Аргументы
x Угол, измеряемый в радианах.
Возвращает
Гиперболический косинус x.
float sinh ( float  x )

Возвращает гиперболический синус указанного угла.

Аргументы
x Угол, измеряемый в радианах.
Возвращает
Гиперболический синус x.
float tanh ( float  x )

Возвращает гиперболический тангенс указанного угла.

Аргументы
x Угол, измеряемый в радианах.
Возвращает
Гиперболический тангенс x.
float log ( float  x )

Возвращает натуральный логарифм указанного числа.

Аргументы
x Число, логарифм которого должен быть найден.
Возвращает
Натуральный логарифм x.
float log10 ( float  x )

Возвращает десятичный логарифм указанного числа.

Аргументы
x Число, логарифм которого должен быть найден.
Возвращает
Десятичный логарифм x.
float pow ( float  base,
float  exponent 
)

Возвращает указанное число, возведенное в указанную степень.

Аргументы
base Число, возводимое в степень.
exponent Число, задающее степень.
Возвращает
Число base, возведенное в степень exponent.
float sqrt ( float  x )

Возвращает квадратный корень из указанного числа.

Аргументы
x Число (x>=0).
Возвращает
Квадратный корень из x.
float ceil ( float  x )

Возвращает наименьшее целое число, которое больше или равно заданному числу.

Аргументы
x Число.
Возвращает
Наименьшее целое число, большее или равное x.
float abs ( float  x )

Возвращает абсолютное значение указанного числа.

Аргументы
x Число.
Возвращает
Абсолютное значение x.
float floor ( float  x )

Возвращает наибольшее целое число, которое меньше или равно указанному числу.

Аргументы
x Число.
Возвращает
Наибольшее целое число, меньшее или равное x.
float fraction ( float  x )

Возвращает дробную часть указанного числа.

Аргументы
x Число.
Возвращает
Дробная часть числа x, с тем же знаком.
string substring ( const string &in  str,
int  start,
int  length 
)

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

Аргументы
str Входная строка.
start Позиция первого символа подстроки во входной строке (с нуля).
length Число символов в подстроке.
Возвращает
Подстрока указанной входной строки.
int findFirst ( const string &in  str,
const string &in  sub 
)

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

Аргументы
str Входная строка.
sub Подстрока, поиск которой осуществляется во входной строке.
Возвращает
Индекс, с которого начинается первое вхождение подстроки в исходной строке, если эта подстрока найдена, или значение -1, если она не найдена.
int findFirst ( const string &in  str,
const string &in  sub,
int  startAt 
)

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

Аргументы
str Входная строка.
sub Подстрока, поиск которой осуществляется во входной строке.
startAt Позиция во входной строке, с которой начинается поиск.
Возвращает
Индекс, с которого начинается первое вхождение подстроки в исходной строке, если эта подстрока найдена, или значение -1, если она не найдена.
int findLast ( const string &in  str,
const string &in  sub 
)

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

Аргументы
str Входная строка.
sub Подстрока, поиск которой осуществляется во входной строке.
Возвращает
Индекс, с которого начинается последнее вхождение подстроки в исходной строке, если эта подстрока найдена, или значение -1, если она не найдена.
int findLast ( const string &in  str,
const string &in  sub,
int  startAt 
)

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

Аргументы
str Входная строка.
sub Подстрока, поиск которой осуществляется во входной строке.
startAt Позиция во входной строке, с которой начинается поиск.
Возвращает
Индекс, с которого начинается последнее вхождение подстроки в исходной строке, если эта подстрока найдена, или значение -1, если она не найдена.
int findFirstOf ( const string &in  str,
const string &in  set 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
Возвращает
Индекс первого встретившегося символа во входной строке, содержащегося и в строке set. Если таких символов не встретилось, то возвращается -1.
int findFirstOf ( const string &in  str,
const string &in  set,
int  startAt 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
startAt Позиция во входной строке, с которой начинается поиск.
Возвращает
Индекс первого встретившегося символа во входной строке, содержащегося и в строке set. Если таких символов не встретилось, то возвращается -1.
int findFirstNotOf ( const string &in  str,
const string &in  set 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
Возвращает
Индекс первого встретившегося символа во входной строке, не содержащегося в строке set. Если таких символов не встретилось, то возвращается -1.
int findFirstNotOf ( const string &in  str,
const string &in  set,
int  startAt 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
startAt Позиция во входной строке, с которой начинается поиск.
Возвращает
Индекс первого встретившегося символа во входной строке, не содержащегося в строке set. Если таких символов не встретилось, то возвращается -1.
int findLastOf ( const string &in  str,
const string &in  set 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
Возвращает
Индекс последнего встретившегося символа во входной строке, содержащегося и в строке set. Если таких символов не встретилось, то возвращается -1.
int findLastOf ( const string &in  str,
const string &in  set,
int  startAt 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
startAt Позиция во входной строке, с которой начинается поиск.
Возвращает
Индекс последнего встретившегося символа во входной строке, содержащегося и в строке set. Если таких символов не встретилось, то возвращается -1.
int findLastNotOf ( const string &in  str,
const string &in  set 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
Возвращает
Индекс последнего встретившегося символа во входной строке, не содержащегося в строке set. Если таких символов не встретилось, то возвращается -1.
int findLastNotOf ( const string &in  str,
const string &in  set,
int  startAt 
)

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

Аргументы
str Входная строка.
set Строка, задающая множество символов.
startAt Позиция во входной строке, с которой начинается поиск.
Возвращает
Индекс последнего встретившегося символа во входной строке, не содержащегося в строке set. Если таких символов не встретилось, то возвращается -1.
string [] split ( const string &in  str,
const string &in  delimiter 
)

Разбивает указанную строку на подстроки, используя указанный разделитель.

Аргументы
str Разбиваемая строка.
delimiter Строка, которая используется в качестве разделителя.
Возвращает
Массив, элементы которого содержат подстроки данной строки, разделенные строкой delimiter.
string [] splitEx ( const string &in  str,
const string &in  delimiter 
)

Разбивает указанную строку на подстроки, используя указанный разделитель.

Аргументы
str Разбиваемая строка.
delimiter Строка, которая используется в качестве разделителя.
Возвращает
Массив, элементы которого содержат подстроки данной строки, разделенные строкой delimiter. В итоговый массив не включаются пустые элементы, а так же убираются пробелы/табы/перенос_строки из итоговых элементов.
string join ( const string @&[]in  str,
const string &in  delimiter 
)

Объединяет строки из заданного массива в одну строку, разделяя их при этом указанной строкой.

Аргументы
str Массив объединяемых строк.
delimiter Строка, которая вставляется между отдельными элементами массива при их объединении.
Возвращает
Строка, состоящая из элементов str, перемежаемых строками delimiter.
string strlwr ( const string &in  str )

Переводит строку в нижний регистр.

Аргументы
str Входная строка.
Возвращает
Строка str в нижнем регистре.
string strupr ( const string &in  str )

Переводит строку в верхний регистр.

Аргументы
str Входная строка.
Возвращает
Строка str в верхнем регистре.
uint GetStrHash ( string str )

Высчитывает хэш строки.

Основное назначение - высчитывать хэш пути к файлу изображения

Аргументы
str Cтрока от которой высчитывается хэш (символ "/" в исходной строке будет автоматически заменен на "\"). Регистр значения не имеет.
Возвращает
Хэш строки
См. также
Item::PicMap
ItemCl::PicMap
Item::PicInv
ItemCl::PicInv
int GetCritterAnimType ( uint  crType )

Возвращает вид криттера (Fallout, Tactics, Arcanum, etc) по номеру CritterType.

Аргументы
crType номер типа криттера.
Возвращает
вид криттера. Значения в Anim types _animation.fos.
uint GetCritterAlias ( uint  crType )

возвращает значение Alias из CritterTypes.fos.

возвращает значение TypeName из CritterTypes.fos возвращает значение SoundName из CritterTypes.fos возвращает возможность смены брони для заданного типа криттера.

Аргументы
crType - Тип криттера (см. CritterTypes.cfg).
Возвращает
true – в случае если тип криттера может носить броню; false – в противном случае.
bool IsCritterCanWalk ( uint  crType )

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

Аргументы
crType - Тип криттера (см. CritterTypes.cfg).
Возвращает
true – в случае если тип криттера может ходить; false – в противном случае.
bool IsCritterCanRun ( uint  crType )

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

Аргументы
crType - Тип криттера (см. CritterTypes.cfg).
Возвращает
true – в случае если тип криттера может бегать; false – в противном случае.
bool IsCritterCanRotate ( uint  crType )

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

Аргументы
crType - Тип криттера (см. CritterTypes.cfg).
Возвращает
true – в случае если тип криттера может поворачиваться; false – в противном случае.
bool IsCritterCanAim ( uint  crType )

возвращает возможность прицельной атаки для заданного типа криттера.

Аргументы
crType - Тип криттера (см. CritterTypes.cfg).
Возвращает
true – в случае если тип криттера может носить броню; false – в противном случае.
Прим.
аналогичная функция bool Critter::IsCanAim в добавок учитывает еще и трейт Fast Shot
См. также
Critter::IsCanAim
bool IsCritterAnim1 ( uint  crType,
uint  anim1 
)

возвращает возможность анимации(?) для заданного типа криттера.

Аргументы
crType - Тип криттера (см. CritterTypes.cfg).
anim1 - (?)
Возвращает
true – (?) false – в противном случае.
Converted from CHM to HTML with chm2web Pro 2.85 (unicode)