Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update what-is-extra.md #10

Merged
merged 1 commit into from
Aug 8, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,9 +1,100 @@
# Что такое экстра

## Для чего нужна

## Внесение и получение данных

## Куда передавать
# Что такое экстра?
Как мы знаем, в игре существует множество предметов. И каждый из них может иметь свои данные. Такими предметами являются предметы, которые имеют один и тот же идентификатор, но при этом не могут быть сложены в один стак и чем-то отличаются. Одним из таких предметов является зачарованная книга.
## Для чего нужна?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Желательно с конкретикой описать отличия, либо в целом не писать о них; например сделать подводку к экстре, ведь именно за счет нее предметы и не стакаются. Про зачарованную книгу требуется пояснение, поскольку непонятно к чему она приведена.

Представим такую ситуацию. У вас есть магический кристалл, на котором вычерчены древние руны. Поскольку руны хранят информацию, нам нужно, чтобы разные кристаллы хранили в себе разные руны. Чтобы это реализовать, нам и понадобятся данные предметов.
## Внесение данных
Давайте попробуем создать механику присвоения случайных рун нашему магическому кристаллу. Но что нам для этого нужно? Нам нужно хранилище, куда будут помещены наши данные.
### Класс ItemExtraData
ItemExtraData это то, в чём мы и будем хранить наши данные для последующей передачи в поле экстры.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Документация обычно не разделяется на конкретные классы, тем более что вся статья описывает изменение ItemExtraData.

Создадим функцию, добавляющую в список текста наших рун, и список:
```js
const runeList = [];
function addRune(text) {
runeList.push(text);
};
```
Отлично, теперь мы имеем хранилище. Давайте зарегистрируем для нашего примера несколько текстов
```js
addRune("magic");
addRune("twilight");
addRune("fire");
```
Сделаем функцию, которая будет возвращать экземпляр класса ItemExtraData, содержащий случайную руну из списка;
Comment on lines +9 to +21
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Важно, чтобы вводные данные были максимально компактны, если прочего не требует код. Это поможет сразу понять с чем мы имеем дело, быстро входя в возможности рассматриваемого класса/функции и прочего.

Suggested change
Создадим функцию, добавляющую в список текста наших рун, и список:
```js
const runeList = [];
function addRune(text) {
runeList.push(text);
};
```
Отлично, теперь мы имеем хранилище. Давайте зарегистрируем для нашего примера несколько текстов
```js
addRune("magic");
addRune("twilight");
addRune("fire");
```
Для начала, создадим список рун, который будет использоваться нашей экстрой для определения типа руны:
```js
const RUNES = [
"magic",
"twilight",
"fire"
];

```js
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
Сделаем функцию, которая будет возвращать экземпляр класса ItemExtraData, содержащий случайную руну из списка;
Сделаем функцию, которая будет возвращать экземпляр класса ItemExtraData, содержащий случайную руну из списка:

function giveRandomRune() {
const index = Math.floor(Math.random() * runeList.length);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Функции объявляются константами на протяжении документации, также желательно чтобы функция в названии описывала то, что она должна возвращать. Например, getRandomRuneExtra().

const extraData = new ItemExtraData();
extraData.putString("rune", runeList(index));
return extraData;
}
```
Стоит заметить, что ItemExtraData принимает в себя параметр, в который можно передать предыдущие или любые другие данные экстры, чтобы создать экземпляр содержащий эти данные. Однако свои так же можно будет передать, это лишь способ дополнения.
```js
const extraDataOld = new ItemExtraData();
extraDataOld.putString("old_rune", "castle");

const extraDataNew = new ItemExtraData(extraDataOld);
extraDataNew.putString("new_rune", "cave");
```
Что такое putString? Дело в том, что ItemExtraData реализует способ передачи и получения данных класса CompoundTag.
Он позволяет разделять данные на типы, и получать их в зависимости от переданного типа.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

putString был использован в прошлой функции, но описывается здесь, важно включать пояснение к новым вызовам сразу.

Первым аргументом идёт название ключа, вторым значение.
Рассмотрим некоторые способы передачи и получения данных, которые в нём есть:
```js
const extraData = new ItemExtraData();
extraData.putInt("int_key", 10) //мы передаём число
extraData.putString("string_key", "random_rune"); //мы передаём строку
extraData.putFloat("float_key", 1.1) //мы передаём число с десятичной частью
extraData.putBoolean("boolean_key", true); //мы передаём булевое значение
extraData.putObject("object_key", {fruit: "apple"}); //мы передаём объект с данными
extraData.putLong("long_key", 10000) //сюда мы передаём число от -2^63 до 2^63-1
```
## Куда передавать?
Ранее мы создали список, где хранятся наши руны, и функцию для получения случайной из списка. Но одного хранилища экстры недостаточно, нам нужно их куда-то передать, чтобы они приобрели вес. Так вот.
Как мы знаем, предметы хранят в себе объект типа ItemInstance:
```ts
interface ItemInstance {
id: int,
count: int,
data: int,
extra?: ItemExtraData
}
```
Как мы видим, этот тип хранит в себе идентификатор предмета, его количество, прочность, и данные предмета, если они есть.
Тоесть это описание того, какие данные хранят в себе предметы.
Comment on lines +54 to +63
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Нежелательно включать декларации напрямую, предметы уже были рассмотрены ранее, можно подвести к использованию экстры в методах, но не их прямой типизации. Это сложно для понимания.

А поскольку мы можем манипулировать этими данными, мы можем использовать любой метод для выдачи предмета, в который можно будет как раз таки передать наши данные.
Давайте реализуем присвоение случайной руны нашему кристаллу после клика им о камень:
```js
Item.registerUseFunctionForID(ItemID["magic_crystal"], function (coords, item, block, player) {
if(block.id === VanillaBlockID.stone && !item.extra || (item.extra && item.extra.getString("rune") === null)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ItemID.magic_crystal

Entity.setCarriedItem(item.id, item.count, item.data, giveRandomRune());
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Типизированное сравнивание (===) не требуется и используется только если это оправданно.

}
})
```
Теперь, при клике кристаллом по камню, кристаллу присвоится случайная руна, если руна не была присвоена ранее.
## Получение
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Мы до функции указали что собираемся сделать, лучше внести ясность что конкретно происходит в "адском" условии, например:

Suggested change
Теперь, при клике кристаллом по камню, кристаллу присвоится случайная руна, если руна не была присвоена ранее.
При клике по камню если экстры еще нет, либо информации о руне в ней не существует, будет присвоена руна случайная из нашего списка в начале статьи.

Мы присвоили кристаллу руну, но что, если нам понадобится получить содержимое этой руны?
В таком случае, в классе предусмотрены методы по получению данных в зависимости от типа:
```js
const extraData = new ItemExtraData();
extraData.getInt("int_key", 10) //мы получаем число, и если его нет, то получим 10
extraData.getString("string_key", "random_rune"); //мы получаем строку, если её нет, то получим "random_rune"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
extraData.getInt("int_key", 10) //мы получаем число, и если его нет, то получим 10
extraData.getInt("int_key", 10); // мы получаем число, и если его нет, то получим 10

extraData.getFloat("float_key", 1.1) //мы получаем число с десятичной частью, если его нет, то получим 1.1
extraData.getBoolean("boolean_key", true); //мы получаем булевое значение, если его нет, то получим true
extraData.getObject("object_key", {fruit: "apple"}); //мы получаем объект с данными, если его нет, то получим {fruit: "apple"}
extraData.getLong("long_key", 10000) //мы получаем число вида long, если его нет, то получим 10000
```
Важно заметить, что второй аргумент необязателен, и если его не будет и значения ключа тоже, то вернётся null.
Comment on lines +78 to +86
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Стандартизируем, например:

Suggested change
```js
const extraData = new ItemExtraData();
extraData.getInt("int_key", 10) //мы получаем число, и если его нет, то получим 10
extraData.getString("string_key", "random_rune"); //мы получаем строку, если её нет, то получим "random_rune"
extraData.getFloat("float_key", 1.1) //мы получаем число с десятичной частью, если его нет, то получим 1.1
extraData.getBoolean("boolean_key", true); //мы получаем булевое значение, если его нет, то получим true
extraData.getObject("object_key", {fruit: "apple"}); //мы получаем объект с данными, если его нет, то получим {fruit: "apple"}
extraData.getLong("long_key", 10000) //мы получаем число вида long, если его нет, то получим 10000
```
```js
const extraData = new ItemExtraData();
extraData.getInt("int_key", 10); // вернется целочисленное число по ключу "int_key", либо же 10 если его нет
extraData.getString("string_key", "random_rune"); // вернется строка по ключу "string_key", либо же "random_rune" если ее нет
extraData.getFloat("float_key", 1.1) // вернется число с дробью по ключу "float_key", либо же 1.1 если его нет
extraData.getBoolean("boolean_key", true); // вернется буль по ключу "boolean_key", либо же true если его нет
extraData.getObject("object_key", { fruit: "apple" }); // вернется объект по ключу "object_key", либо же приведенный объект если его нет
extraData.getLong("long_key", 2147483648); // вернется большое число по ключу "long_key", либо же 2147483648 если его нет

> Давайте улучшим нашу функцию, и если экстра уже будет присутствовать, то мы будем выводить значение в чат.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

null вернется лишь в случае объекта или строки, иначе вернется 0, 0.0, false и 0 соответственно.

> ```js
Item.registerUseFunctionForID(ItemID["magic_crystal"], function (coords, item, block, player) {
if(block.id === VanillaBlockID.stone) {
if(!item.extra || (item.extra && item.extra.getString("rune") === null)) {
Entity.setCarriedItem(item.id, item.count, item.data, giveRandomRune());
} else {
Game.message("Rune name: " + item.extra && item.extra.getString("rune"));
}
}
})
```
## Использование тегов
Comment on lines +88 to +99
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Сноски не рекомендуются, специально для этого созданы Admoniconы:

Suggested change
> Давайте улучшим нашу функцию, и если экстра уже будет присутствовать, то мы будем выводить значение в чат.
> ```js
Item.registerUseFunctionForID(ItemID["magic_crystal"], function (coords, item, block, player) {
if(block.id === VanillaBlockID.stone) {
if(!item.extra || (item.extra && item.extra.getString("rune") === null)) {
Entity.setCarriedItem(item.id, item.count, item.data, giveRandomRune());
} else {
Game.message("Rune name: " + item.extra && item.extra.getString("rune"));
}
}
})
```
:::tip Давайте улучшим!
Например, если экстра уже присутствует, выведем значение в чат:
```js
Item.registerUseFunctionForID(ItemID.magic_crystal, function (coords, item, block, player) {
if (block.id == VanillaBlockID.stone) {
if (!item.extra || (item.extra && item.extra.getString("rune") == null)) {
Entity.setCarriedItem(item.id, item.count, item.data, giveRandomRune());
} else {
Game.message("Rune name: " + item.extra.getString("rune"));
}
}
});

:::

Loading