Основы языка

Для целей этой документации мы используем CSL и среду выполнения/платформу вокруг него как взаимозаменяемые понятия

Эта страница — «сторона моделирования данных» CSL: примитивы, структуры/классы и шаблоны, которые вы будете использовать для аккуратного представления состояния игры.

Если вы совсем новичок, начните с Начало работы с CSL. На этой странице предполагается, что вы уже знаете, как объявлять переменные и писать proc/method.

Примитивные типы

Числа и булевы значения

• Знаковые целые числа: s8, s16, s32, s64 (псевдоним: int == s64)

• Беззнаковые целые числа: u8, u16, u32, u64 (псевдоним: uint == u64)

• Числа с плавающей точкой: f32 (псевдоним: float), f64

• Булевы значения: b8 (псевдоним: bool), b16, b32, b64

health: int = 100;
speed: float = 6.5;
is_dead: bool = false;

Строки

string постоянно используется для ID, имён и форматирования.

item_id := "sword";
log_info("подобран %", {item_id});

Векторы

v2, v3, v4 — это встроенные математические/данные типы:

pos: v2 = {10, 20};
color: v4 = {1, 0, 0, 1};

Перечисления

Перечисления отлично подходят для читаемых полей «режим/состояние»:

Game_Phase :: enum {
    LOBBY;
    RUNNING;
    POST_GAME;
}

phase := Game_Phase.LOBBY;

if phase == .RUNNING {
    // ...
}

Значения перечисления обычно обращаются через сокращённую форму .VALUE когда компилятор может вывести тип перечисления.

Структуры (тип-значение)

Используйте структуры для «простых данных», которые вы хотите дешёво копировать (конфиги, небольшие блоки состояния, дескрипторы).

Damage_Desc :: struct {
    amount: int;
    knockback: v2;
}

hit := Damage_Desc{amount=10, knockback={2, 1}};

Когда использовать структуру

• Объект-дескриптор/конфиг (*_Desc)

• Небольшое, самодостаточное состояние, которое вы хотите копировать по значению

• Данные, которые вы хотите вложить внутрь другого типа

Когда не стоит использовать структуру

• Большое изменяемое состояние, разделяемое между несколькими системами (используйте класс)

• Объекты «с идентичностью» (игроки, предметы, долго живущие объекты) (используйте класс)

Классы (ссылочные типы)

Классы — это ссылочные типы. Создавайте экземпляры с помощью new(...).

Enemy :: class {
    health: int;
    target: v2;
}

e := new(Enemy);
e.health = 50;
e.target = {0, 0};

Наследование

Вы можете наследовать от других структур/классов:

Weapon_Definition :: class {
    id: string;
    name: string;
}

Gun_Definition :: class : Weapon_Definition {
    fire_rate: float;
}

Используйте наследование, когда есть реальная связь «является». Для большинства игровых данных композиция (поля) проще и её легче поддерживать.

Массивы, срезы и динамические массивы

Вы увидите три распространённые формы:

• Фиксированные массивы: [N]T (размер на этапе компиляции)

• Срезы / управляемые массивы: []T (представление массива)

• Динамические массивы: [..]T (изменяемый по размеру список)

Пример:

spawn_points: [4]v2 = {{0,0}, {5,0}, {0,5}, {5,5}};

alive_enemy_ids: [..]int;
alive_enemy_ids->append(123);
alive_enemy_ids->append(456);

Полное руководство см. в Массивы и коллекции.

Передача по ссылке (ref)

Если процедуре нужно изменить значение, используйте ref:

apply_damage :: proc(health: ref int, amount: int) {
    health -= amount;
}

hp := 100;
apply_damage(ref hp, 10);

Это особенно полезно для API в стиле «разметки», которые постепенно обрезают/уменьшают прямоугольник:

draw_panel :: proc(rect: ref Rect) {
    header := rect->cut_top(50);
    draw_header(header);
    // rect теперь — оставшаяся область для содержимого
}

Приведение типов

Используйте expr.(T):

f := 12.7;
i := f.(int);    // 12
f2 := i.(float); // 12.0

Типовой полиморфизм (процедуры в стиле обобщений)

CSL поддерживает полиморфные процедуры с использованием $ чтобы определить типы в месте вызова:

min :: proc(a: $T, b: T) -> T {
    if a < b return a;
    return b;
}

a := min(10, 20);       // T == int
b := min(1.25, 3.5);    // T == float

Типы как значения (typeid)

typeid — это значение, которое представляет тип во время выполнения и/или для полиморфных вызовов:

default_of :: proc($T: typeid) -> T {
    t: T;
    return t;
}

zero := default_of(int);
empty := default_of(string);

Практические рекомендации по моделированию

• Состояние, специфичное для игрока, хранится в Player. Если оно должно различаться между игроками, оно не должно быть глобальным.

• Для дескрипторов предпочитайте небольшие структуры а состояние времени выполнения храните в классах/компонентах.

• Сохраняйте данные, авторитетные для сервера, авторитетными. Если это влияет на геймплей, не вычисляйте это только на клиенте.

Для шаблонов, специфичных для игрока, см. Добавление логики игрока. Для стороны ECS в мире см. Сущности и компоненты.