Инвентарь

Обзор

All Out предоставляет API инвентаря игрока, которое позволяет создавать предметы, выдавать их игрокам, а также позволяет игрокам сортировать, использовать и выбрасывать предметы в вашей игре.

Есть три основных понятия:

• Определения предметов (Item_Definition): что представляет собой предмет является (название/иконка/стекование + ваши собственные поля)
• Экземпляры предметов (Item_Instance): реальный стек в мире/в инвентаре
• Инвентари (Inventory): контейнер слотов, который хранит экземпляры предметов

У каждого игрока есть встроенный инвентарь в player.default_inventory.

Сохранение

Если вы хотите, чтобы инвентари игроков автоматически сохранялись между игровыми сессиями, включите Auto Save Player Inventory флажок в Edit → Game Config разделе редактора.

Вы также можете настроить эти параметры программно в CSL. Вызовите Scene.set_auto_save_player_inventory(true) и Scene.set_player_inventory_capacity(32) во время инициализации сцены (например, в ao_before_scene_load) до того, как к игре присоединятся какие-либо игроки.

Справочник API инвентаря

Item_Definition_Desc :: struct {
    id:         string;
    name:       string;
    icon:       Texture_Asset;
    stack_size: s64;    // 1 = не стакается, -1 = бесконечно
    tier:       Item_Tier;
}

Items :: struct {
    // Инвентари
    create_inventory  :: proc(unique_id: string, capacity: s64) -> Inventory;
    destroy_inventory :: proc(inventory: Inventory) -> bool;
    set_capacity      :: proc(inventory: Inventory, capacity: s64);

    // Определения предметов + экземпляры
    register_item_definition :: proc(desc: Item_Definition_Desc, $Definition_Type: typeid = Item_Definition, instance_type: typeid = Item_Instance) -> Definition_Type;
    create_item_instance     :: proc(definition: Item_Definition, count: s64 = 1) -> Item_Instance;
    create_item_instance     :: proc(definition: Item_Definition, $T: typeid, count: s64 = 1) -> T;
    destroy_item_instance    :: proc(instance: Item_Instance, count: s64 = -1);

    // Перемещение предметов
    can_move_item_to_inventory                  :: proc(instance: Item_Instance, inventory: Inventory, will_destroy_item: ref bool) -> bool;
    move_item_to_inventory                      :: proc(instance: Item_Instance, inventory: Inventory);
    move_as_many_items_as_possible_to_inventory :: proc(instance: Item_Instance, inventory: Inventory, destroyed_item: ref bool) -> s64;
    remove_item_from_inventory                  :: proc(instance: Item_Instance, inventory: Inventory);
    can_move_all_items                          :: proc(entries: []Item_Transaction_Entry) -> bool;
    move_all_items                              :: proc(entries: []Item_Transaction_Entry);
    can_swap_items                              :: proc(inventory_a: Inventory, inventory_b: Inventory, slot_a: s64, slot_b: s64) -> bool;
    swap_items                                  :: proc(inventory_a: Inventory, inventory_b: Inventory, slot_a: s64, slot_b: s64);

    // Запросы
    calculate_room_in_inventory_for_item :: proc(definition: Item_Definition, inventory: Inventory) -> s64;
    destroy_all_items :: proc(inventory: Inventory);

    // UI (необязательно)
    draw_inventory :: proc(rect: Rect, inventory: Inventory, options: Inventory_Draw_Options) -> bool;
    draw_hotbar    :: proc(player: Player, inventory: Inventory, options: Inventory_Draw_Options) -> Draw_Hotbar_Result;
}

Inventory :: class {
    get_item :: proc(inventory: Inventory, index: s64) -> Item_Instance;
    has_item_id :: proc(inventory: Inventory, item_id: string) -> bool;
    capacity: s64 #read_only;
}

Item_Definition :: class {
    get_icon :: method() -> Texture_Asset;
    id: string #read_only;
    name: string #read_only;
    type: typeid #read_only;
    instance_type: typeid #read_only;
    tier: Item_Tier #read_only;
}

Item_Instance :: class {
    quantity:   s64       #read_only;  // количество в стеке
    slot_index: s64       #read_only;  // слот в родительском инвентаре
    inventory:  Inventory #read_only;  // родительский инвентарь (null, если его нет)
    get_definition :: method() -> Item_Definition;
}

Item_Transaction_Entry :: struct {
    instance: Item_Instance;
    inventory: Inventory;
}

Inventory_Draw_Options :: struct {
    title: string;
    show_exit_button: bool;
    show_scroll_bar: bool;
    show_background: bool;
    allow_drag_drop: bool;
    drag_drop_color_multiplier: v4;
    hotbar_item_count: s32;
    columns: s32;
    rows: s32;
    force_select_hotbar_index: s32;
    hide_bag_button: bool;
    enable_selection: bool;
    scroll_item_selection: bool;
    keyboard_item_selection: bool;
    enable_use_from_hotbar: bool;
    on_before_draw: (proc(item: Item_Instance, rect: Rect));
    on_after_draw: (proc(item: Item_Instance, rect: Rect));

    default :: proc() -> Inventory_Draw_Options;
}

Draw_Hotbar_Result :: struct {
    selected_item: Item_Instance;
    selected_item_index: s64;
    dropped_item: Item_Instance;
    entire_rect: Rect;
    inventory_open: bool;
    inventory_open_t: float;
}

Быстрый старт (регистрация + выдача предмета)

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

// Необязательно: пользовательские типы предметов
Weapon_Definition :: class : Item_Definition {
    damage: s64;
}

Weapon_Item :: class : Item_Instance {
    durability: s64 @ao_serialize; // @ao_serialize автоматически сохраняет это поле между сессиями
}

sword_defn: Weapon_Definition;

ao_before_scene_load :: proc() {
    sword_defn = Items.register_item_definition(
        {id="sword", name="Iron Sword", icon=get_asset(Texture_Asset, "icons/sword.png"), stack_size=1, tier=.COMMON},
        Weapon_Definition,
        Weapon_Item
    );
    sword_defn.damage = 10;
}

give_sword :: proc(player: Player) {
    item := Items.create_item_instance(sword_defn, Weapon_Item);

    will_destroy: bool;
    if Items.can_move_item_to_inventory(item, player.default_inventory, ref will_destroy) {
        item.durability = 100;
        Items.move_item_to_inventory(item, player.default_inventory);
        // Если will_destroy равно true, предмет был поглощён существующим стеком
        // и на эту ссылку на предмет не следует полагаться после перемещения.
    }
    else {
        // Инвентарь полон → уничтожаем созданный экземпляр
        Items.destroy_item_instance(item);
    }
}

Отображение хотбара

Чтобы показать стандартный UI хотбара инвентаря на экране, вызовите Items.draw_hotbar внутри метода ao_late_update вашего Player. Без этого система инвентаря будет работать за кулисами, но игрок её не увидит!

Player :: class : Player_Base {
    ao_late_update :: method(dt: float) {
        if this.is_local_or_server() {
            draw_player_hotbar(this);
        }
    }
}

draw_player_hotbar :: proc(player: Player) {
    options := Inventory_Draw_Options.default();
    options.hide_bag_button = false;

    result := Items.draw_hotbar(player, player.default_inventory, options);

    // result.selected_item — это текущий выделенный предмет (или null)
    // result.inventory_open показывает, отображается ли полный UI рюкзака
}

Items.draw_hotbar полностью обрабатывает для вас весь UI хотбара + переключение рюкзака. Оно возвращает Draw_Hotbar_Result с selected_item, selected_item_index, inventory_open, а dropped_item полями.

hide_bag_button = true запрещает игроку открывать рюкзак. Если рюкзак уже открыт, он закроется, поэтому используйте это только тогда, когда у игроков есть другой способ получить доступ к важным предметам.

Проверка, есть ли у игрока уже предмет

Обычный шаблон — выдавать предмет только если у игрока его ещё нет:

Используйте зарегистрированный ID определения:

give_sword_if_needed :: proc(player: Player) {
    if player.default_inventory.has_item_id("sword") return;
    give_sword(player);
}

Вы также можете проверить, сколько места осталось для конкретного типа предмета, прежде чем создавать его:

room := Items.calculate_room_in_inventory_for_item(sword_defn, player.default_inventory);
if room > 0 {
    give_sword(player);
}

Пользовательские инвентари

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

• Сундуки / контейнеры для хранения
• Команды рыб/мобов

chest_inventory := Items.create_inventory("chest_01", 12);

Чтобы получить доступ к предметам:

for i: 0..<chest_inventory.capacity {
    item := chest_inventory.get_item(i);
    if item == null continue;
    defn := item.get_definition();
    log_info("Слот %: %", {i, defn.name});
}

Атомарное перемещение предметов

Используйте транзакцию, когда несколько перемещений предметов должны либо все выполниться, либо все провалиться:

moves: [..]Item_Transaction_Entry;
moves.append({instance = sword, inventory = player.default_inventory});
moves.append({instance = shield, inventory = player.default_inventory});

if Items.can_move_all_items(moves) {
    Items.move_all_items(moves);
}

Каждый экземпляр предмета может появляться в транзакции только один раз. Всегда сначала вызывайте can_move_all_items ; move_all_items вызывает assert, если вся транзакция больше не помещается. Перемещение может объединить стек и уничтожить перемещаемый экземпляр, поэтому не продолжайте использовать ссылки на предмет после транзакции.

Выброшенные предметы

Если вы хотите, чтобы игроки выбрасывали предметы в мир (и чтобы другие игроки могли подбирать их), используйте систему выброшенных предметов:

import "core:dropped_items"

Создание выброшенного предмета

item := Items.create_item_instance(sword_defn, Weapon_Item);
dropped := Dropped_Item.spawn(player.entity.world_position, item);

Анимация выброса + привязка к navmesh

gameplay_rng: u64;

dropped.do_spawn_animation(ref gameplay_rng, navmesh); // navmesh необязателен

Обработка drag-and-drop из UI хотбара

Если вы используете Items.draw_hotbar, игроки могут перетаскивать предмет из UI, чтобы выбросить его. Dropped_Item.handle_dropped_item удаляет его из инвентаря и создаёт сущность выброшенного предмета.

result := Items.draw_hotbar(player, player.default_inventory, Inventory_Draw_Options.default());

dropped: Dropped_Item;
if Dropped_Item.handle_dropped_item(result, player.entity.world_position, ref dropped) {
    dropped.do_spawn_animation(ref gameplay_rng, navmesh);
}

Выброшенные предметы автоматически исчезают со временем (с предупреждающей полосой). Удержание кнопки взаимодействия на предмете сбрасывает таймер его исчезновения.

Вы можете сделать выброшенный предмет эксклюзивным (видимым/подбираемым только одним игроком), используя dropped.set_exclusive(player).