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...

PackedStringArray

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

Опис

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

Якщо вам потрібно об'єднати рядки в масиві, скористайтеся методом String.join.

var string_array = PackedStringArray(["hello", "world"])
var string = " ".join(string_array)
print(string) # "hello world"

Відмінності між упакованими масивами, типізованими масивами та нетипізованими масивами: Упаковані масиви, як правило, швидше обробляються та модифікуються порівняно з типізованим масивом того ж типу (наприклад, PackedStringArray проти Array[String]). Крім того, упаковані масиви споживають менше пам'яті. З іншого боку, упаковані масиви менш гнучкі, оскільки не пропонують стільки зручних методів, як, наприклад, Array.map(). Типізовані масиви, у свою чергу, швидше обробляються та модифікуються, ніж нетипізовані масиви.

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

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

Примітка

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

Посібники

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

PackedStringArray

PackedStringArray()

PackedStringArray

PackedStringArray(from: PackedStringArray)

PackedStringArray

PackedStringArray(from: Array)

Методи

bool

append(value: String)

void

append_array(array: PackedStringArray)

int

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

void

clear()

int

count(value: String) const

PackedStringArray

duplicate() const

bool

erase(value: String)

void

fill(value: String)

int

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

String

get(index: int) const

bool

has(value: String) const

int

insert(at_index: int, value: String)

bool

is_empty() const

bool

push_back(value: String)

void

remove_at(index: int)

int

resize(new_size: int)

void

reverse()

int

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

void

set(index: int, value: String)

int

size() const

PackedStringArray

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

void

sort()

PackedByteArray

to_byte_array() const

Оператори

bool

operator !=(right: PackedStringArray)

PackedStringArray

operator +(right: PackedStringArray)

bool

operator ==(right: PackedStringArray)

String

operator [](index: int)

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

PackedStringArray PackedStringArray() 🔗

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

PackedStringArray PackedStringArray(from: PackedStringArray)

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

PackedStringArray PackedStringArray(from: Array)

Будуємо новий PackedStringArray. Додатково ви можете пройти в загальній Array, яка буде перетворена.

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

bool append(value: String) 🔗

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

void append_array(array: PackedStringArray) 🔗

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

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

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

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

void clear() 🔗

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

int count(value: String) const 🔗

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

PackedStringArray duplicate() const 🔗

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

bool erase(value: String) 🔗

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

void fill(value: String) 🔗

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

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

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

String get(index: int) const 🔗

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

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

bool has(value: String) const 🔗

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

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

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

bool is_empty() const 🔗

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

bool push_back(value: String) 🔗

Додаток елемента рядка в кінці масиву.

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: String, from: int = -1) const 🔗

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

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

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

int size() const 🔗

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

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

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

Абсолютне значення 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 з кожним рядком, закодованим як UTF-8. Рядки завершуються null.

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

bool operator !=(right: PackedStringArray) 🔗

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

PackedStringArray operator +(right: PackedStringArray) 🔗

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

bool operator ==(right: PackedStringArray) 🔗

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

String operator [](index: int) 🔗

Повертаємо String в індексі index. Негативні індекси можуть використовуватися для доступу до елементів з кінця. Використання індексу з меж масиву призведе до помилки.