Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

PackedColorArray

Пакетний масив Colors.

Опис

Масив, спеціально призначений для зберігання елементів типу Color. Дані в ньому упаковуються щільно, що дозволяє економити пам'ять при роботі з великими масивами.

Відмінності між упакованими масивами, типізованими масивами та нетипізованими масивами: Ітерація та модифікація упакованих масивів, як правило, відбувається швидше, ніж у типізованих масивів того ж типу (наприклад, PackedColorArray проти Array[Color]). Крім того, упаковані масиви споживають менше пам'яті. Недоліком є те, що упаковані масиви менш гнучкі, оскільки не пропонують стільки зручних методів, як, наприклад, Array.map(). Типізовані масиви, у свою чергу, швидше обробляються та модифікуються, ніж нетипізовані масиви.

Примітка: Упаковані масиви завжди передаються за посиланням. Щоб отримати копію масиву, яку можна змінювати незалежно від оригінального масиву, використовуйте метод duplicate. Це не стосується вбудованих властивостей та методів. У цих випадках повернений упакований масив є копією, і його зміна не вплине на оригінальне значення. Щоб оновити вбудовану властивість цього типу, змініть повернутий масив, а потім знову присвойте його властивості.

Примітка: У логічному контексті упакований масив обчислюється як false, якщо він порожній. В іншому випадку упакований масив завжди обчислюється як true.

Примітка

Існують значні відмінності при використанні цього API із С#. Більше інформації: ref:doc_c_sharp_differences.

Конструктори

PackedColorArray

PackedColorArray()

PackedColorArray

PackedColorArray(from: PackedColorArray)

PackedColorArray

PackedColorArray(from: Array)

Методи

bool

append(value: Color)

void

append_array(array: PackedColorArray)

int

bsearch(value: Color, before: bool = true) const

void

clear()

int

count(value: Color) const

PackedColorArray

duplicate() const

bool

erase(value: Color)

void

fill(value: Color)

int

find(value: Color, from: int = 0) const

Color

get(index: int) const

bool

has(value: Color) const

int

insert(at_index: int, value: Color)

bool

is_empty() const

bool

push_back(value: Color)

void

remove_at(index: int)

int

resize(new_size: int)

void

reverse()

int

rfind(value: Color, from: int = -1) const

void

set(index: int, value: Color)

int

size() const

PackedColorArray

slice(begin: int, end: int = 2147483647) const

void

sort()

PackedByteArray

to_byte_array() const

Оператори

bool

operator !=(right: PackedColorArray)

PackedColorArray

operator +(right: PackedColorArray)

bool

operator ==(right: PackedColorArray)

Color

operator [](index: int)

Описи конструкторів

PackedColorArray PackedColorArray() 🔗

Будуємо порожній PackedColorArray.

PackedColorArray PackedColorArray(from: PackedColorArray)

Constructs a PackedColorArray як копія даної PackedColorArray.

PackedColorArray PackedColorArray(from: Array)

Створює новий PackedColorArray. За бажанням ви можете передати загальний Array, який буде перетворено.

Примітка. Під час ініціалізації PackedColorArray з елементами, він повинен бути ініціалізований Array значень Color:

var array = PackedColorArray([Color(0,1, 0,2, 0,3), Color(0,4, 0,5, 0,6)])

Описи методів

bool append(value: Color) 🔗

Додає елемент у кінець масиву (псевдонім push_back()).

void append_array(array: PackedColorArray) 🔗

Додаток PackedColorArray в кінці цього масиву.

int bsearch(value: Color, before: bool = true) const 🔗

Знаходить індекс існуючого значення (або індекс вставки, який підтримує порядок сортування, якщо значення ще не присутнє в масиві) за допомогою бінарного пошуку. За бажанням можна передати специфікатор before. Якщо false, індекс, що повертається, йде після всіх існуючих записів значення в масиві.

Примітка: Виклик bsearch() на невідсортованому масиві призводить до неочікуваної поведінки.

void clear() 🔗

Очищає масив. Еквівалентно використанню resize() з розміром 0.

int count(value: Color) const 🔗

Повертає кількість повторень елемента в масиві.

PackedColorArray duplicate() const 🔗

Створює копію масиву і повертає його.

bool erase(value: Color) 🔗

Видаляє перше входження значення з масиву та повертає true. Якщо значення не існує в масиві, нічого не відбувається, і повертається false. Щоб видалити елемент за індексом, використовуйте метод remove_at().

void fill(value: Color) 🔗

Присвоює задане значення всім елементам масиву. Зазвичай це можна використовувати разом з resize() для створення масиву заданого розміру та ініціалізованих елементів.

int find(value: Color, from: int = 0) const 🔗

Шукає в масиві значення і повертає його індекс або -1, якщо таке не знайдено. За бажанням можна передати початковий індекс пошуку.

Color get(index: int) const 🔗

Повертає Color за заданим index у масиві. Якщо index виходить за межі або є від'ємним, цей метод завершується невдачею та повертає Color(0, 0, 0, 1).

Цей метод схожий (але не ідентичний) на оператор []. Найголовніше, що коли цей метод завершується невдачею, він не призупиняє виконання проекту, якщо його запускати з редактора.

bool has(value: Color) const 🔗

Повертає true, якщо масив містить value.

int insert(at_index: int, value: Color) 🔗

Вставте новий елемент на даній позиції в масиві. Посада повинна бути дійсна, або в кінці масиву (idx == розмір()).

bool is_empty() const 🔗

Повертає true, якщо масив порожній.

bool push_back(value: Color) 🔗

Додає значення до масиву.

void remove_at(index: int) 🔗

Видаляє елемент з масиву за індексом.

int resize(new_size: int) 🔗

Встановлює розмір масиву. Якщо масив збільшується, резервує елементи в кінці масиву. Якщо масив скорочується, обрізає масив до нового розміру. Виклик методу resize() один раз і призначення нових значень відбувається швидше, ніж додавання нових елементів по одному.

Повертає @GlobalScope.OK у разі успіху або одну з наступних констант Error, якщо цей метод не працює: @GlobalScope.ERR_INVALID_PARAMETER, якщо розмір від'ємний, або @GlobalScope.ERR_OUT_OF_MEMORY, якщо розподіл пам'яті не вдається. Використовуйте метод size(), щоб знайти фактичний розмір масиву після зміни розміру.

void reverse() 🔗

Змінює порядок елементів у масиві на протилежний.

int rfind(value: Color, from: int = -1) const 🔗

Здійснює пошук у масиві у зворотному порядку. За бажанням можна передати початковий індекс пошуку. Якщо він від'ємний, то початковий індекс береться відносно кінця масиву.

void set(index: int, value: Color) 🔗

Змінює Color в даній позиції.

int size() const 🔗

Повертає кількість елементів у масиві.

PackedColorArray slice(begin: int, end: int = 2147483647) const 🔗

Повертає розріз PackedColorArray, з start (включно) до end (виключно), як новий PackedColorArray.

Абсолютне значення start і end буде зафіксовано до розміру масиву, тому значення за замовчуванням для end робить кінець розрізу кінцем масиву за замовчуванням (тобто arr.slice(1) є скороченим записом для arr.slice(1, arr.size())).

Якщо ж start або end є негативними, вони будуть відносно кінця масиву (тобто arr.slice(0, -2) є скороченим записом для arr.slice(0, arr.size() - 2)).

void sort() 🔗

Сорти елементів масиву в порядку закріплення.

PackedByteArray to_byte_array() const 🔗

Повернення PackedByteArray з кожним кольором закодовано як байти.

Описи операторів

bool operator !=(right: PackedColorArray) 🔗

Повертає true, якщо вміст масивів відрізняється.

PackedColorArray operator +(right: PackedColorArray) 🔗

Повертає новий PackedColorArray з вмістом right додано в кінці цього масиву. Для кращої роботи розглянемо використання append_array() замість.

bool operator ==(right: PackedColorArray) 🔗

Повертає true, якщо вміст обох масивів однаково, тобто вони мають всі рівні Color у відповідних індексах.

Color operator [](index: int) 🔗

Повертає Color за індексом index. Від'ємні індекси можна використовувати для доступу до елементів, починаючи з кінця. Використання індексу поза межами масиву призведе до помилки.