Data API

Data API terpadu bertujuan untuk menyediakan cara yang konsisten untuk mengakses data modifikasi data. 'Data', dalam konteks ini berarti setiap data yang disinkronisasi secara konsisten antara client danserver. hal ini dapat diubah sisi server dan kemudian perubahan tersebut akan disinkronkan ke klien yang terhubung. Ini termasuk, diantara banyak lainnya, teks pada sebuah tanda, penambilan kuda atau kesehatan dari setiap entitas yang hidup.

Where other approaches define the available data using interfaces and inheritance (like a LivingEntity interface providing getter and setter functions for current and maximum health), in Sponge every entity, block etc. is completely oblivious to what data it holds. While this may appear less straightforward than direct accessor methods, it is foremost far more extensible. And thanks to the addition of Keys, simply accessing specific values is no less straightforward.

Tip

If the data API behaves differently from what you expect (e.g. returns an empty Optional even if the data are supposed to be present), or there is a feature/value missing that you need, check the Implementation Tracker, ask in the #spongedev IRC channel or on the Forums.

Konsep

Pada sekilas dokumen API, API data mengancam untuk membanjiri Anda dengan banyak antarmuka dan paket. Tapi untuk hanya menggunakan data API, Anda tidak perlu berurusan dengan banyak dari mereka, karena kebanyakan antarmuka hanya menemukan manipulator data tertentu.

CatalogTypes

Catalog Types are groups of values that can be used in certain context. Famous examples of these types are BlockTypes, EntityTypes and ItemTypes.

DataHolder

Pemegang data hanya itu - sesuatu yang menyimpan data. Ini menyediakan metode untuk mengambil dan menawarkan kembali data. Antarmuka itu sendiri sama sekali tidak memperhatikan tipe data yang dimiliki. Karena hanya implementasinya yang memiliki pengetahuan ini, mungkin untuk bertanya kepada: javadoc: DataHolder untuk menyediakan data yang tidak memiliki atau menerima data yang tidak dapat digunakan. Dalam kasus tersebut, nilai pengembalian metode akan memberikan informasi bahwa data tidak tersedia (melalui `` Opsional.empty () ``) atau tidak diterima (melalui: doc: DataTransactionResult <transaction>).

Properti

A property too is data, but not synchronized between server and clients. Therefore, it can only be changed by modifications present on both client and server. Since Sponge is not intended to require a client-side counterpart, properties are not modifiable. Examples of properties are the harvesting abilities on tools (represented as HarvestingProperty or the damage absorption of an equipable armor item (represented as DamageAbsorptionProperty).

Datamanipulator

Manipulasi data mewakili titik data kohesif yang menggambarkan komponen tertentu dari dudukannya. Misalnya: javadoc: HealthData, yang berisi kesehatan terkini dan maksimal. Jika pemegang data memiliki `` HealthData``, kesehatannya dapat habis dan diisi ulang dan dapat mati jika kesehatan habis. Ini memungkinkan penggunaan kembali komponen semacam itu di atas API dan mencegah duplikasi metode accessor. Misalnya, domba, blok kaca patri dan pelindung kulit semua dapat berbagi: javadoc: DyeableData memegang warna yang diwarnai.

Kunci

A `` Key`` adalah pengenal unik untuk satu titik data dan dapat digunakan untuk langsung membaca atau menetapkan titik data tanpa khawatir tentang manipulator data. Ini dirancang untuk menyediakan cara mudah mengakses data yang mirip dengan metode pengambil / penyetel langsung. Semua kunci yang digunakan dalam Sponge terdaftar sebagai konstanta di: javadoc: Keys kelas utilitas.

Nilai

Dalam API Data, nilai yang disebut oleh Kunci dikodekan dalam objek kontainer. Untuk dokumentasi ini, disebut sebagai 'nilai kunci' untuk menghindari kebingungan dengan nilai sebenarnya. Nilai kunci mengenkapsulasi nilai data aktual (jika ada), nilai default (untuk digunakan jika tidak ada nilai langsung) dan Kunci dimana nilai diidentifikasi.