Skip to content

Commit cdca5fa

Browse files
committed
sr: improve grammar for binding docs
1 parent ba76c80 commit cdca5fa

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

wikis/summoningrituals/docs/binding/entity.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Summoning Entity
22

3-
`SummoningEntity` is a utility binding that allows you to easily create complex instances of `EntityInput`s and `EntityOutput`s via the `EntityInputBuilder` and `EntityOutputBuilder`. The builders offer functionality to add tooltips, offset and spread values, as well as NBT to entities, which is otherwise not possible, if you only provide a simple [entity input](../recipe/inputs.md#entity-inputs) or [entity output](../recipe/outputs.md#entity-outputs) instance.
3+
`SummoningEntity` is a utility binding that allows you to easily create complex instances of `EntityInput`s and `EntityOutput`s via the `EntityInputBuilder` and `EntityOutputBuilder`. The builders offer functionality to add tooltips, offset and spread values, as well as NBT to entities, which is otherwise not possible if you only provide a simple [entity input](../recipe/inputs.md#entity-inputs) or [entity output](../recipe/outputs.md#entity-outputs) instance.
44

55
## Overview
66

@@ -27,7 +27,7 @@ SummoningEntity.output("iron_golem", 2)
2727

2828
## Entity Input Builder
2929

30-
After obtaining the `EntityInputBuilder` instance through the binding, you can chain more functions to it. It is not required to finish the builder because the `entityInputs` function accepts builder instances as well.
30+
After obtaining the `EntityInputBuilder` instance through the binding, you can chain additional functions to it. It is not required to finish the builder because the `entityInputs` function also accepts builder instances.
3131

3232
- properties:
3333
- `entity`
@@ -63,10 +63,10 @@ After obtaining the `EntityInputBuilder` instance through the binding, you can c
6363
- assigns the given validator to the `EntityInput`
6464

6565
> [!TIP] What is a validator?
66-
> You might ask why a custom `validator` is required if `data` is already provided. For inputs, the `data` property is only used for rendering purposes in recipe viewers. If you give an entity a sword via the `data` property, it will be displayed in the recipe viewer page, but it won't be checked if the entity actually has a sword when being sacrificed.
66+
> You might ask why a custom `validator` is required if `data` is already provided. For inputs, the `data` property is only used for rendering purposes in recipe viewers. If you give an entity a sword via the `data` property, it will be displayed on the recipe viewer page, but it won't check whether the entity actually has a sword when being sacrificed.
6767
>
6868
> **Why is that?<br>**
69-
> Because vanilla Minecraft only checks entity data (NBT) for exact matches, there is no way to always cover all desired functionality. If you want to ensure that an entity has at least 10 HP, this wouldn't be possible because Minecraft would check for the exact value only. That's why you have to use a custom validator with your own logic to check if the respective values are correct.
69+
> Because vanilla Minecraft only checks entity data (NBT) for exact matches, there is no way to always cover all desired functionality. If you want to ensure that an entity has at least 10 HP, this wouldn't be possible because Minecraft would check only for the exact value. That's why you have to use a custom validator with your own logic to check whether the respective values are correct.
7070
7171
```js
7272
.entityInputs([
@@ -88,7 +88,7 @@ After obtaining the `EntityInputBuilder` instance through the binding, you can c
8888

8989
## Entity Output Builder
9090

91-
After obtaining the `EntityOutputBuilder` instance through the binding, you can chain more functions to it. It is not required to finish the builder because the `entityOutputs` function accepts builder instances as well.
91+
After obtaining the `EntityOutputBuilder` instance through the binding, you can chain additional functions to it. It is not required to finish the builder because the `entityOutputs` function also accepts builder instances.
9292

9393
- properties:
9494
- `entity`
@@ -111,7 +111,7 @@ After obtaining the `EntityOutputBuilder` instance through the binding, you can
111111
- required: no
112112
- default: empty list
113113
- `offset`
114-
- description: specifies the offset to the altar block where to spawn the output entity at
114+
- description: specifies the offset from the altar block where the output entity is spawned
115115
- type: `BlockPos`
116116
- required: no
117117
- default: `[0, 2, 0]`

wikis/summoningrituals/docs/binding/item.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Summoning Item
22

3-
`SummoningItem` is a utility binding that allows you to easily create complex instances of `ItemOutput`s via the `ItemOutputBuilder`. The builder offers functionality to add offset and spread values to an item output, which is otherwise not possible, if you only provide a simple [item output](../recipe/outputs.md#item-outputs) instance.
3+
`SummoningItem` is a utility binding that allows you to easily create complex instances of `ItemOutput`s via the `ItemOutputBuilder`. The builder offers functionality to add offset and spread values to an item output, which is otherwise not possible if you only provide a simple [item output](../recipe/outputs.md#item-outputs) instance.
44

55
## Overview
66

@@ -20,15 +20,15 @@ SummoningItem.of("minecraft:carrot", 2)
2020

2121
## Item Output Builder
2222

23-
After obtaining the `ItemOutputBuilder` instance through the binding, you can chain more functions to it. It is not required to finish the builder because the `itemOutputs` function accepts builder instances as well.
23+
After obtaining the `ItemOutputBuilder` instance through the binding, you can chain additional functions to it. It is not required to finish the builder because the `itemOutputs` function also accepts builder instances.
2424

2525
- properties:
2626
- `item`
2727
- description: specifies the output item; defined via the binding function to obtain the builder
2828
- type: `ItemStack`
2929
- required: yes
3030
- `offset`
31-
- description: specifies the offset to the altar block where to spawn the output item at
31+
- description: specifies the offset from the altar block where the output item is spawned
3232
- type: `BlockPos`
3333
- required: no
3434
- default: `[0, 2, 0]`

0 commit comments

Comments
 (0)