Шпаргалка по Enforce Script

Главная | Шпаргалка

Краткий справочник по Enforce Script для DayZ на одной странице. Добавьте в закладки.

Типы

Тип	Описание	Значение по умолчанию	Пример
`int`	32-битное знаковое целое	`0`	`int x = 42;`
`float`	32-битное с плавающей точкой	`0.0`	`float f = 3.14;`
`bool`	Логический	`false`	`bool b = true;`
`string`	Неизменяемый тип-значение	`""`	`string s = "hello";`
`vector`	3-компонентный float (x,y,z)	`"0 0 0"`	`vector v = "1 2 3";`
`typename`	Ссылка на тип	`null`	`typename t = PlayerBase;`
`Class`	Корень всех ссылочных типов	`null`	---
`void`	Нет возвращаемого значения	---	---

Пределы: int.MAX = 2147483647, int.MIN = -2147483648, float.MAX, float.MIN

Методы Array (`array<T>`)

Метод	Возвращает	Примечания
`Insert(item)`	`int` (индекс)	Добавить в конец
`InsertAt(item, idx)`	`void`	Вставить на позицию
`Get(idx)` / `arr[idx]`	`T`	Доступ по индексу
`Set(idx, item)`	`void`	Заменить по индексу
`Find(item)`	`int`	Индекс или -1
`Count()`	`int`	Количество элементов
`IsValidIndex(idx)`	`bool`	Проверка границ
`Remove(idx)`	`void`	Неупорядоченное (меняет с последним!)
`RemoveOrdered(idx)`	`void`	Сохраняет порядок
`RemoveItem(item)`	`void`	Найти + удалить (упорядоченно)
`Clear()`	`void`	Удалить все
`Sort()` / `Sort(true)`	`void`	По возрастанию / по убыванию
`ShuffleArray()`	`void`	Перемешать
`Invert()`	`void`	Обратить порядок
`GetRandomElement()`	`T`	Случайный выбор
`InsertAll(other)`	`void`	Добавить все из другого
`Copy(other)`	`void`	Заменить копией
`Resize(n)`	`void`	Изменить размер (заполняет значениями по умолчанию)
`Reserve(n)`	`void`	Предвыделить ёмкость

Псевдонимы типов: TStringArray, TIntArray, TFloatArray, TBoolArray, TVectorArray

Методы Map (`map<K,V>`)

Метод	Возвращает	Примечания
`Insert(key, val)`	`bool`	Добавить новый
`Set(key, val)`	`void`	Вставить или обновить
`Get(key)`	`V`	Возвращает значение по умолчанию, если отсутствует
`Find(key, out val)`	`bool`	Безопасное получение
`Contains(key)`	`bool`	Проверка наличия
`Remove(key)`	`void`	Удалить по ключу
`Count()`	`int`	Количество записей
`GetKey(idx)`	`K`	Ключ по индексу (O(n))
`GetElement(idx)`	`V`	Значение по индексу (O(n))
`GetKeyArray()`	`array<K>`	Все ключи
`GetValueArray()`	`array<V>`	Все значения
`Clear()`	`void`	Удалить все

Методы Set (`set<T>`)

Метод	Возвращает
`Insert(item)`	`int` (индекс)
`Find(item)`	`int` (индекс или -1)
`Get(idx)`	`T`
`Remove(idx)`	`void`
`RemoveItem(item)`	`void`
`Count()`	`int`
`Clear()`	`void`

Синтаксис классов

class MyClass extends BaseClass
{
    protected int m_Value;                  // поле
    private ref array<string> m_List;       // владеющая ссылка

    void MyClass() { m_List = new array<string>; }  // конструктор
    void ~MyClass() { }                              // деструктор

    override void OnInit() { super.OnInit(); }       // переопределение
    static int GetCount() { return 0; }              // статический метод
};

Доступ: private | protected | (по умолчанию публичный) Модификаторы: static | override | ref | const | out | notnullМодификация: modded class MissionServer { override void OnInit() { super.OnInit(); } }

Управление потоком

// if / else if / else
if (a > 0) { } else if (a == 0) { } else { }

// for
for (int i = 0; i < count; i++) { }

// foreach (значение)
foreach (string item : myArray) { }

// foreach (индекс + значение)
foreach (int i, string item : myArray) { }

// foreach (map: ключ + значение)
foreach (string key, int val : myMap) { }

// while
while (condition) { }

// switch (НЕТ проваливания!)
switch (val) { case 0: Print("zero"); break; default: break; }

Методы строк

Метод	Возвращает	Пример
`s.Length()`	`int`	`"hello".Length()` = 5
`s.Substring(start, len)`	`string`	`"hello".Substring(1,3)` = `"ell"`
`s.IndexOf(sub)`	`int`	-1 если не найдено
`s.LastIndexOf(sub)`	`int`	Поиск с конца
`s.Contains(sub)`	`bool`
`s.Replace(old, new)`	`int`	Изменяет на месте, возвращает количество
`s.ToLower()`	`void`	На месте!
`s.ToUpper()`	`void`	На месте!
`s.TrimInPlace()`	`void`	На месте!
`s.Split(delim, out arr)`	`void`	Разделяет в TStringArray
`s.Get(idx)`	`string`	Один символ
`s.Set(idx, ch)`	`void`	Заменить символ
`s.ToInt()`	`int`	Парсинг целого
`s.ToFloat()`	`float`	Парсинг дробного
`s.ToVector()`	`vector`	Парсинг `"1 2 3"`
`string.Format(fmt, ...)`	`string`	Подстановки `%1`..`%9`
`string.Join(sep, arr)`	`string`	Объединение элементов массива

Математические методы

Метод	Описание
`Math.RandomInt(min, max)`	`[min, max)` исключая max
`Math.RandomIntInclusive(min, max)`	`[min, max]`
`Math.RandomFloat01()`	`[0, 1]`
`Math.RandomBool()`	Случайный true/false
`Math.Round(f)` / `Floor(f)` / `Ceil(f)`	Округление
`Math.AbsFloat(f)` / `AbsInt(i)`	Абсолютное значение
`Math.Clamp(val, min, max)`	Ограничение диапазоном
`Math.Min(a, b)` / `Max(a, b)`	Минимум/максимум
`Math.Lerp(a, b, t)`	Линейная интерполяция
`Math.InverseLerp(a, b, val)`	Обратная интерполяция
`Math.Pow(base, exp)` / `Sqrt(f)`	Степень/корень
`Math.Sin(r)` / `Cos(r)` / `Tan(r)`	Тригонометрия (радианы)
`Math.Atan2(y, x)`	Угол из компонентов
`Math.NormalizeAngle(deg)`	Приведение к 0-360
`Math.SqrFloat(f)` / `SqrInt(i)`	Квадрат

Константы: Math.PI, Math.PI2, Math.PI_HALF, Math.DEG2RAD, Math.RAD2DEG

Вектор: vector.Distance(a,b), vector.DistanceSq(a,b), vector.Direction(a,b), vector.Dot(a,b), vector.Lerp(a,b,t), v.Length(), v.Normalized()

Распространённые паттерны

Безопасное приведение типа

PlayerBase player;
if (Class.CastTo(player, obj))
{
    player.DoSomething();
}

Инлайн-приведение

PlayerBase player = PlayerBase.Cast(obj);
if (player) player.DoSomething();

Проверка на null

if (!player) return;
if (!player.GetIdentity()) return;
string name = player.GetIdentity().GetName();

Проверка IsAlive (требуется EntityAI)

EntityAI eai;
if (Class.CastTo(eai, obj) && eai.IsAlive()) { }

Итерация по Map через foreach

foreach (string key, int value : myMap)
{
    Print(key + " = " + value.ToString());
}

Преобразование перечислений

string name = typename.EnumToString(EDamageState, state);
int val; typename.StringToEnum(EDamageState, "RUINED", val);

Битовые флаги

int flags = FLAG_A | FLAG_B;       // объединить
if (flags & FLAG_A) { }           // проверить
flags = flags & ~FLAG_B;          // удалить

Чего НЕ существует

Отсутствующая возможность	Обходной путь
Тернарный `? :`	`if/else`
`do...while`	`while(true) { ... break; }`
`try/catch`	Защитные проверки + ранний return
Множественное наследование	Одиночное + композиция
Перегрузка операторов	Именованные методы (кроме `[]` через Get/Set)
Лямбды	Именованные методы
`nullptr`	`null` / `NULL`
`\\` / `\"` в строках	Избегать (CParser ломается)
`#include`	config.cpp `files[]`
Пространства имён	Префиксы имён (`MyMod_`, `VPP_`)
Интерфейсы / абстрактные	Пустые базовые методы
Проваливание в switch	Каждый case независим
`#define` со значениями	Используйте `const`
Выражения в параметрах по умолчанию	Только литералы/NULL
Вариадические параметры	`string.Format` или массивы
Переобъявление переменных в else-if	Уникальные имена в каждой ветке

Создание виджетов (программно)

// Получение рабочей области
WorkspaceWidget ws = GetGame().GetWorkspace();

// Создание из макета
Widget root = ws.CreateWidgets("MyMod/gui/layouts/MyPanel.layout");

// Поиск дочернего виджета
TextWidget title = TextWidget.Cast(root.FindAnyWidget("TitleText"));
if (title) title.SetText("Hello World");

// Показать/скрыть
root.Show(true);
root.Show(false);

Паттерн RPC

Регистрация (сервер):

// В инициализации 3_Game или 4_World:
GetGame().RPCSingleParam(null, MY_RPC_ID, null, true, identity);  // RPC движка

// Или через строковую маршрутизацию RPC (MyRPC / CF):
GetRPCManager().AddRPC("MyMod", "RPC_Handler", this, 2);  // CF
MyRPC.Register("MyMod", "MyRoute", this, MyRPCSide.SERVER);  // MyMod

Отправка (клиент серверу):

Param2<string, int> data = new Param2<string, int>("itemName", 5);
GetGame().RPCSingleParam(null, MY_RPC_ID, data, true);

Приём (обработчик на сервере):

void RPC_Handler(CallType type, ParamsReadContext ctx, PlayerIdentity sender, Object target)
{
    if (type != CallType.Server) return;
    if (!sender) return;

    Param2<string, int> data;
    if (!ctx.Read(data)) return;

    string itemName = data.param1;
    int quantity = data.param2;
    // Обработка...
}

Обработка ошибок

ErrorEx("message");                              // Серьёзность ERROR по умолчанию
ErrorEx("info", ErrorExSeverity.INFO);           // Информация
ErrorEx("warning", ErrorExSeverity.WARNING);     // Предупреждение
Print("debug output");                           // Лог скрипта
string stack = DumpStackString();                // Получить стек вызовов

Файловый ввод-вывод

// Пути: "$profile:", "$saves:", "$mission:", "$CurrentDir:"
bool exists = FileExist("$profile:MyMod/config.json");
MakeDirectory("$profile:MyMod");

// JSON
MyConfig cfg = new MyConfig();
JsonFileLoader<MyConfig>.JsonLoadFile(path, cfg);  // Возвращает VOID!
JsonFileLoader<MyConfig>.JsonSaveFile(path, cfg);

// Прямой файл
FileHandle fh = OpenFile(path, FileMode.WRITE);
if (fh != 0) { FPrintln(fh, "line"); CloseFile(fh); }

Создание объектов

// Базовое
Object obj = GetGame().CreateObject("AK101", pos, false, false, true);

// С флагами
Object obj = GetGame().CreateObjectEx("Barrel_Green", pos, ECE_PLACE_ON_SURFACE);

// В инвентаре игрока
player.GetInventory().CreateInInventory("BandageDressing");

// Как вложение
weapon.GetInventory().CreateAttachment("ACOGOptic");

// Удаление
GetGame().ObjectDelete(obj);

Ключевые глобальные функции

GetGame()                          // Экземпляр CGame
GetGame().GetPlayer()              // Локальный игрок (только КЛИЕНТ, null на сервере!)
GetGame().GetPlayers(out arr)      // Все игроки (сервер)
GetGame().GetWorld()               // Экземпляр мира
GetGame().GetTickTime()            // Серверное время (float)
GetGame().GetWorkspace()           // Рабочая область UI
GetGame().SurfaceY(x, z)          // Высота рельефа
GetGame().IsServer()               // true на сервере
GetGame().IsClient()               // true на клиенте
GetGame().IsMultiplayer()          // true в мультиплеере

Полная документация: Вики моддинга DayZ | Подводные камни | Обработка ошибок

Шпаргалка по Enforce Script ​

Типы ​

Методы Array (array<T>) ​

Методы Map (map<K,V>) ​

Методы Set (set<T>) ​

Синтаксис классов ​

Управление потоком ​

Методы строк ​

Математические методы ​

Распространённые паттерны ​

Безопасное приведение типа ​

Инлайн-приведение ​

Проверка на null ​

Проверка IsAlive (требуется EntityAI) ​

Итерация по Map через foreach ​

Преобразование перечислений ​

Битовые флаги ​

Чего НЕ существует ​

Создание виджетов (программно) ​

Паттерн RPC ​

Обработка ошибок ​

Файловый ввод-вывод ​

Создание объектов ​

Ключевые глобальные функции ​