Сущности и компоненты

Все игры Out построены вокруг сущностей (объектов в мире) и компонентов (поведение/данные, привязанные к сущностям).

Если вы раньше использовали Unity: думайте “GameObject + Components”. Если вы раньше использовали Roblox: думайте “Instance + Scripts/Components”. Основная идея та же: вы собираете геймплей, добавляя компоненты к сущностям.

Сущности

Сущности существуют двумя распространёнными способами:

• Размещённые в редакторе: они уже находятся в сцене при запуске.

• Созданные во время выполнения: вы создаёте их из скрипта.

Создание и уничтожение сущностей

entity := Scene.create_entity();
entity->set_local_position({10, 20});
entity->set_local_scale({2.5, 2.5});
entity->set_local_rotation(0);

// Когда закончите:
entity->destroy();

Уничтожение сущности уничтожает и её компоненты. Не храните ссылки на компоненты после уничтожения их сущности.

Итерация по сущностям

foreach e: entity_iterator() {
    // ...
}

Компоненты

Компоненты — это единицы поведения. Компонент «живёт» на сущности и может читать/изменять эту сущность.

Получение и добавление компонентов

sprite := entity->get_component(Sprite_Renderer);

player := entity->get_component(Player);

my_comp := entity->add_component(My_Component);

Итерация по компонентам

foreach enemy: component_iterator(Enemy) {
    enemy->tick_ai();
}

Встроенные компоненты, которые вы будете часто использовать

Sprite_Renderer

texture := get_asset(Texture_Asset, "ui/button.png");

sprite := entity->get_component(Sprite_Renderer);
sprite->set_texture(texture);
sprite.color = {1, 1, 1, 1}; // RGBA
sprite.depth_offset = 0.5;
sprite.layer = 10;

Префабы (Prefab_Asset)

Префабы нужно создавать в редакторе. В скриптах вы их инстанцируете.

prefab := get_asset(Prefab_Asset, "MyPrefab.prefab");
spawned := instantiate(prefab);
spawned->set_local_position({1, 3});

Spine (Spine_Animator)

Если вы используете 2D-анимированных персонажей, вы часто будете работать с Spine_Animator. См. Spine.

Написание собственного компонента

Создавайте новые компоненты в отдельных файлах (например, orbiter.csl) и прикрепляйте их к сущностям либо:

• Вручную в редакторе, или

• Во время выполнения с помощью entity->add_component(...)

Компоненты могут реализовывать колбэки жизненного цикла:

• ao_start()

• ao_update(dt)

• ao_late_update(dt) (после всех обновлений)

• ao_end() (при уничтожении)

Пример:

Orbiter :: class : Component {
    center: v2;
    radius: float;
    speed: float;
    angle: float;

    ao_start :: method() {
        center = entity.local_position;
        radius = 2;
        speed = 1;
        angle = 0;
    }

    ao_update :: method(dt: float) {
        angle += speed * dt;

        offset_x := cos(angle) * radius;
        offset_y := sin(angle) * radius;

        entity->set_local_position({center.x + offset_x, center.y + offset_y});
    }
}

Методы жизненного цикла для глобальных скриптов (ao_start, ao_update, ...) рассматриваются в Жизненный цикл игры/кадра.

Сериализуемые поля (@ao_serialize)

Используйте @ao_serialize чтобы отобразить поле в редакторе (и часто включить сохранение/персистентность, где это применимо).

Chest :: class : Component {
    capacity: int @ao_serialize;
}

Поиск ближайших компонентов (запросы по близости)

В CSL нет колбэков столкновений. Распространённый шаблон — «запросить ближайшие компоненты и проверить расстояние».

Полезные вспомогательные функции:

Scene.get_all_components_in_range     :: proc(position: v2, range: float, results: ref [..]$T)
Scene.get_closest_component_in_range  :: proc(position: v2, range: float, $T: typeid) -> T, bool

Пример:

nearby: [..]Enemy;
Scene.get_all_components_in_range(player.entity.world_position, 5.0, ref nearby);

for e: nearby {
    // ...
}

closest_pickup, found := Scene.get_closest_component_in_range(player.entity.world_position, 2.0, Pickup);
if found {
    // ...
}

Лучшие практики

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

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

• Локализуйте косметические эффекты. UI/частицы обычно должны выполняться за is_local() проверок.