Skip to content

Commit c8ceb99

Browse files
committed
update the example in the "customize value provider" page
1 parent a168139 commit c8ceb99

File tree

1 file changed

+60
-40
lines changed

1 file changed

+60
-40
lines changed

src/topper/extra/provider/index.md

Lines changed: 60 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,9 @@ can be useful if the provider is slow or if it performs a lot of calculations.
1515
```yaml
1616
holders:
1717
jump:
18-
<your other settings>
19-
async: true
18+
type: statistic
19+
statistic: jump
20+
async: true # [!code focus]
2021
```
2122
2223
== FabricMC
@@ -25,8 +26,9 @@ holders:
2526
{
2627
"holders": {
2728
"jump": {
28-
"<your other settings>": "you other settings",
29-
"async": true
29+
"type": "statistic",
30+
"statistic": "minecraft:jump",
31+
"async": true // [!code focus]
3032
}
3133
}
3234
}
@@ -45,8 +47,9 @@ settings.
4547
```yaml
4648
holders:
4749
jump:
48-
<your other settings>
49-
default-value: null # The default value of an entry. This will be used when a player joins the server the first time
50+
type: statistic
51+
statistic: jump
52+
default-value: null # [!code focus:5] # The default value of an entry. This will be used when a player joins the server the first time
5053
null-name: "---" # Default value for the name
5154
null-uuid: "---" # Default value for the uuid
5255
null-value: "---" # Default value for the value
@@ -59,8 +62,9 @@ holders:
5962
{
6063
"holders": {
6164
"jump": {
62-
"<your other settings>": "you other settings",
63-
"default-value": null,
65+
"type": "statistic",
66+
"statistic": "minecraft:jump",
67+
"default-value": null, // [!code focus:5]
6468
"null-name": "---",
6569
"null-uuid": "---",
6670
"null-value": "---",
@@ -83,8 +87,9 @@ show the player with the least value first), you can set `reverse` to `true`.
8387
```yaml
8488
holders:
8589
jump:
86-
<your other settings>
87-
reverse: true
90+
type: statistic
91+
statistic: jump
92+
reverse: true # [!code focus]
8893
```
8994
9095
== FabricMC
@@ -93,8 +98,9 @@ holders:
9398
{
9499
"holders": {
95100
"jump": {
96-
"<your other settings>": "you other settings",
97-
"reverse": true
101+
"type": "statistic",
102+
"statistic": "minecraft:jump",
103+
"reverse": true // [!code focus]
98104
}
99105
}
100106
}
@@ -114,8 +120,9 @@ separator, you can enable the `formatted` option in your Holder Setting.
114120
```yml
115121
holders:
116122
example-formatted-value-provider:
117-
<your other settings>
118-
formatted: true
123+
type: statistic
124+
statistic: jump
125+
formatted: true # [!code focus:3]
119126
formatted-settings: # Optional settings for the formatted value
120127
decimal-separator: "." # Change this to the decimal separator of the formatted value
121128
```
@@ -126,8 +133,9 @@ holders:
126133
{
127134
"holders": {
128135
"example-formatted-value-provider": {
129-
"<your other settings>": "you other settings",
130-
"formatted": true,
136+
"type": "statistic",
137+
"statistic": "minecraft:jump",
138+
"formatted": true, // [!code focus:5]
131139
"formatted-settings": {
132140
// Optional settings for the formatted value
133141
"decimal-separator": "."
@@ -151,12 +159,14 @@ the permissions.
151159
```yml
152160
holders:
153161
jump:
154-
<your other settings>
155-
ignore-permission: exclude.permission
162+
type: statistic
163+
statistic: jump
164+
ignore-permission: exclude.permission # [!code focus:1]
156165

157166
jump-multiple:
158-
<your other settings>
159-
ignore-permission:
167+
type: statistic
168+
statistic: jump
169+
ignore-permission: # [!code focus:3]
160170
- exclude.permission1
161171
- exclude.permission2
162172
```
@@ -167,12 +177,14 @@ holders:
167177
{
168178
"holders": {
169179
"jump": {
170-
"<your other settings>": "you other settings",
171-
"ignore-permission": "exclude.permission"
180+
"type": "statistic",
181+
"statistic": "minecraft:jump",
182+
"ignore-permission": "exclude.permission" // [!code focus:1]
172183
},
173184
"jump-multiple": {
174-
"<your other settings>": "you other settings",
175-
"ignore-permission": [
185+
"type": "statistic",
186+
"statistic": "minecraft:jump",
187+
"ignore-permission": [ // [!code focus:3]
176188
"exclude.permission1",
177189
"exclude.permission2"
178190
]
@@ -192,12 +204,14 @@ permissions.
192204
```yml
193205
holders:
194206
jump:
195-
<your other settings>
196-
reset-permission: reset.permission
207+
type: statistic
208+
statistic: jump
209+
reset-permission: reset.permission # [!code focus:1]
197210

198211
jump-multiple:
199-
<your other settings>
200-
reset-permission:
212+
type: statistic
213+
statistic: jump
214+
reset-permission: # [!code focus:3]
201215
- reset.permission1
202216
- reset.permission2
203217
```
@@ -208,12 +222,14 @@ holders:
208222
{
209223
"holders": {
210224
"jump": {
211-
"<your other settings>": "you other settings",
212-
"reset-permission": "reset.permission"
225+
"type": "statistic",
226+
"statistic": "minecraft:jump",
227+
"reset-permission": "reset.permission" // [!code focus:1]
213228
},
214229
"jump-multiple": {
215-
"<your other settings>": "you other settings",
216-
"reset-permission": [
230+
"type": "statistic",
231+
"statistic": "minecraft:jump",
232+
"reset-permission": [ // [!code focus:3]
217233
"reset.permission1",
218234
"reset.permission2"
219235
]
@@ -235,8 +251,9 @@ instead, you can set `show-errors` to `true`.
235251
```yaml
236252
holders:
237253
jump:
238-
<your other settings>
239-
show-errors: true
254+
type: statistic
255+
statistic: jump
256+
show-errors: true # [!code focus]
240257
```
241258
242259
== FabricMC
@@ -245,8 +262,9 @@ holders:
245262
{
246263
"holders": {
247264
"jump": {
248-
"<your other settings>": "you other settings",
249-
"show-errors": true
265+
"type": "statistic",
266+
"statistic": "minecraft:jump",
267+
"show-errors": true // [!code focus]
250268
}
251269
}
252270
}
@@ -262,8 +280,9 @@ You can also reset the value of the player if there is an error when updating th
262280
```yaml
263281
holders:
264282
jump:
265-
<your other settings>
266-
reset-on-error: true
283+
type: statistic
284+
statistic: jump
285+
reset-on-error: true # [!code focus]
267286
```
268287
269288
== FabricMC
@@ -272,8 +291,9 @@ holders:
272291
{
273292
"holders": {
274293
"jump": {
275-
"<your other settings>": "you other settings",
276-
"reset-on-error": true
294+
"type": "statistic",
295+
"statistic": "minecraft:jump",
296+
"reset-on-error": true // [!code focus]
277297
}
278298
}
279299
}

0 commit comments

Comments
 (0)