Skip to content

Commit 172a6bf

Browse files
Update documentation sources
1 parent b9c1bd4 commit 172a6bf

2 files changed

Lines changed: 13562 additions & 13570 deletions

File tree

src/assets/syntaxes/addons/skript-worldguard.json

Lines changed: 81 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@
88
"version": "1.0.1"
99
},
1010
"expressions": {
11-
"ExprRegion": {
11+
"ExprMoveType": {
1212
"origin": {
1313
"name": "skript-worldguard",
14-
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegion"
14+
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprMoveType"
1515
},
16-
"id": "ExprRegion",
17-
"name": "Region",
18-
"description": "The region in any region related event.",
16+
"id": "ExprMoveType",
17+
"name": "WorldGuard Move Type",
18+
"description": "The movement type in a 'region enter/leave' event. This represents how the player ended up in/out of a region.",
1919
"examples": [
20-
"on region enter:\n\tsend \"You have entered %region%\""
20+
"on region enter:\n\tif the movement type is swimming:\n\t\tmessage \"You have swum into %region%!\""
2121
],
2222
"since": [
2323
"1.0"
@@ -32,23 +32,23 @@
3232
}
3333
],
3434
"patterns": [
35-
"[the] [worldguard] region"
35+
"[the] [worldguard] move[ment][ ]type"
3636
],
3737
"returnType": {
38-
"id": "TypeRegion",
39-
"name": "Region"
38+
"id": "TypeWorldguardMoveType",
39+
"name": "WorldGuard Move Type"
4040
}
4141
},
42-
"ExprMoveType": {
42+
"ExprRegion": {
4343
"origin": {
4444
"name": "skript-worldguard",
45-
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprMoveType"
45+
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegion"
4646
},
47-
"id": "ExprMoveType",
48-
"name": "WorldGuard Move Type",
49-
"description": "The movement type in a 'region enter/leave' event. This represents how the player ended up in/out of a region.",
47+
"id": "ExprRegion",
48+
"name": "Region",
49+
"description": "The region in any region related event.",
5050
"examples": [
51-
"on region enter:\n\tif the movement type is swimming:\n\t\tmessage \"You have swum into %region%!\""
51+
"on region enter:\n\tsend \"You have entered %region%\""
5252
],
5353
"since": [
5454
"1.0"
@@ -63,11 +63,11 @@
6363
}
6464
],
6565
"patterns": [
66-
"[the] [worldguard] move[ment][ ]type"
66+
"[the] [worldguard] region"
6767
],
6868
"returnType": {
69-
"id": "TypeWorldguardMoveType",
70-
"name": "WorldGuard Move Type"
69+
"id": "TypeRegion",
70+
"name": "Region"
7171
}
7272
},
7373
"ExprRegions": {
@@ -124,16 +124,16 @@
124124
"name": "Number"
125125
}
126126
},
127-
"ExprRegionPoints": {
127+
"ExprBlocksInRegion": {
128128
"origin": {
129129
"name": "skript-worldguard",
130-
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegionPoints"
130+
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprBlocksInRegion"
131131
},
132-
"id": "ExprRegionPoints",
133-
"name": "Region Points",
134-
"description": "An expression to obtain the points of a region.\nNote that when obtaining the points of a region, the region itself is projected onto an X-Z plane. Thus, the points do not have a y-component. However, for simplicity, the y-component of the minimum point is used.",
132+
"id": "ExprBlocksInRegion",
133+
"name": "Blocks of Region",
134+
"description": "An expression that returns all of the blocks in the given regions.",
135135
"examples": [
136-
"command /highlight-points <text>:\n\ttrigger:\n\t\tset the blocks at the points of the region text-argument to red wool"
136+
"command /fillregion <text> <material>:\n\ttrigger:\n\t\tset {_region} to the region text-argument in the player's world\n\t\tset the blocks of {_region} to material-argument"
137137
],
138138
"since": [
139139
"1.0"
@@ -142,27 +142,24 @@
142142
"keywords": [],
143143
"deprecated": false,
144144
"patterns": [
145-
"[the] (min|max)[imum] point[s] of %worldguardregions%",
146-
"%worldguardregions%'[s] (min|max)[imum] point[s]",
147-
"[the] points of %worldguardregions%",
148-
"%worldguardregions%'[s] points"
145+
"[the] blocks of %worldguardregions%",
146+
"%worldguardregions%'[s] blocks"
149147
],
150148
"returnType": {
151-
"id": "TypeLocation",
152-
"name": "Location"
149+
"id": "TypeBlock",
150+
"name": "Block"
153151
}
154152
},
155-
"ExprRegionParent": {
153+
"ExprRegionPoints": {
156154
"origin": {
157155
"name": "skript-worldguard",
158-
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegionParent"
156+
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegionPoints"
159157
},
160-
"id": "ExprRegionParent",
161-
"name": "Region Parent",
162-
"description": "An expression to obtain and change the direct parent of a region.\nIt is also possible to obtain all parents of a region (e.g., including a parent region's parent region).\nWhen a region has a parent, it inherits the parents members, owners, and flags (that aren't defined on the child).",
158+
"id": "ExprRegionPoints",
159+
"name": "Region Points",
160+
"description": "An expression to obtain the points of a region.\nNote that when obtaining the points of a region, the region itself is projected onto an X-Z plane. Thus, the points do not have a y-component. However, for simplicity, the y-component of the minimum point is used.",
163161
"examples": [
164-
"command /setparent <text> <text>:\n\ttrigger:\n\t\tset the parent of the region text-argument-1 to the region text-argument-2",
165-
"if any of all of the parent regions of {_region} are global"
162+
"command /highlight-points <text>:\n\ttrigger:\n\t\tset the blocks at the points of the region text-argument to red wool"
166163
],
167164
"since": [
168165
"1.0"
@@ -171,25 +168,27 @@
171168
"keywords": [],
172169
"deprecated": false,
173170
"patterns": [
174-
"[the] parent region[s] of %worldguardregions%",
175-
"%worldguardregions%'[s] parent region[s]",
176-
"all [[of] the] parent regions of %worldguardregions%"
171+
"[the] (min|max)[imum] point[s] of %worldguardregions%",
172+
"%worldguardregions%'[s] (min|max)[imum] point[s]",
173+
"[the] points of %worldguardregions%",
174+
"%worldguardregions%'[s] points"
177175
],
178176
"returnType": {
179-
"id": "TypeRegion",
180-
"name": "Region"
177+
"id": "TypeLocation",
178+
"name": "Location"
181179
}
182180
},
183-
"ExprBlocksInRegion": {
181+
"ExprRegionMembersOwners": {
184182
"origin": {
185183
"name": "skript-worldguard",
186-
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprBlocksInRegion"
184+
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegionMembersOwners"
187185
},
188-
"id": "ExprBlocksInRegion",
189-
"name": "Blocks of Region",
190-
"description": "An expression that returns all of the blocks in the given regions.",
186+
"id": "ExprRegionMembersOwners",
187+
"name": "Region Members/Owners",
188+
"description": "An expression to obtain the members/owners of the given regions.\nThe members/owners of a region are made up of players and groups (strings).\nBy default, this expression returns both. However, keyword specifiers for each type (player/group) are available.",
191189
"examples": [
192-
"command /fillregion <text> <material>:\n\ttrigger:\n\t\tset {_region} to the region text-argument in the player's world\n\t\tset the blocks of {_region} to material-argument"
190+
"on region enter:\n\tmessage \"You have entered %region%. It is owned by %owners of region%.\"",
191+
"command /promote <text> <player>:\n\ttrigger:\n\t\tset {_region} to the region text-argument in the player's world\n\t\tif player-argument is an owner of {_region}:\n\t\t\tmessage \"<red>%player-argument% is already an owner of %{_region}%\"\n\t\telse if player-argument is a member of {_region}:\n\t\t\tadd player to the owners of {_region}\n\t\t\tmessage \"<green>%player-argument% has been promoted to an owner of %{_region}%\"\n\t\telse:\n\t\t\tadd player to the members of {_region}\n\t\t\tmessage \"<green>%player-argument% has been promoted to a member of %{_region}%\""
193192
],
194193
"since": [
195194
"1.0"
@@ -198,25 +197,27 @@
198197
"keywords": [],
199198
"deprecated": false,
200199
"patterns": [
201-
"[the] blocks of %worldguardregions%",
202-
"%worldguardregions%'[s] blocks"
200+
"[the] [player|group] (members|owners) of %worldguardregions%",
201+
"%worldguardregions%'[s] [player|group] (members|owners)",
202+
"[the] (member|owner) (players|groups) of %worldguardregions%",
203+
"%worldguardregions%'[s] (member|owner) (players|groups)"
203204
],
204205
"returnType": {
205-
"id": "TypeBlock",
206-
"name": "Block"
206+
"id": "TypeObject",
207+
"name": "Object"
207208
}
208209
},
209-
"ExprRegionMembersOwners": {
210+
"ExprRegionParent": {
210211
"origin": {
211212
"name": "skript-worldguard",
212-
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegionMembersOwners"
213+
"class": "org.skriptlang.skriptworldguard.elements.expressions.ExprRegionParent"
213214
},
214-
"id": "ExprRegionMembersOwners",
215-
"name": "Region Members/Owners",
216-
"description": "An expression to obtain the members/owners of the given regions.\nThe members/owners of a region are made up of players and groups (strings).\nBy default, this expression returns both. However, keyword specifiers for each type (player/group) are available.",
215+
"id": "ExprRegionParent",
216+
"name": "Region Parent",
217+
"description": "An expression to obtain and change the direct parent of a region.\nIt is also possible to obtain all parents of a region (e.g., including a parent region's parent region).\nWhen a region has a parent, it inherits the parents members, owners, and flags (that aren't defined on the child).",
217218
"examples": [
218-
"on region enter:\n\tmessage \"You have entered %region%. It is owned by %owners of region%.\"",
219-
"command /promote <text> <player>:\n\ttrigger:\n\t\tset {_region} to the region text-argument in the player's world\n\t\tif player-argument is an owner of {_region}:\n\t\t\tmessage \"<red>%player-argument% is already an owner of %{_region}%\"\n\t\telse if player-argument is a member of {_region}:\n\t\t\tadd player to the owners of {_region}\n\t\t\tmessage \"<green>%player-argument% has been promoted to an owner of %{_region}%\"\n\t\telse:\n\t\t\tadd player to the members of {_region}\n\t\t\tmessage \"<green>%player-argument% has been promoted to a member of %{_region}%\""
219+
"command /setparent <text> <text>:\n\ttrigger:\n\t\tset the parent of the region text-argument-1 to the region text-argument-2",
220+
"if any of all of the parent regions of {_region} are global"
220221
],
221222
"since": [
222223
"1.0"
@@ -225,14 +226,13 @@
225226
"keywords": [],
226227
"deprecated": false,
227228
"patterns": [
228-
"[the] [player|group] (members|owners) of %worldguardregions%",
229-
"%worldguardregions%'[s] [player|group] (members|owners)",
230-
"[the] (member|owner) (players|groups) of %worldguardregions%",
231-
"%worldguardregions%'[s] (member|owner) (players|groups)"
229+
"[the] parent region[s] of %worldguardregions%",
230+
"%worldguardregions%'[s] parent region[s]",
231+
"all [[of] the] parent regions of %worldguardregions%"
232232
],
233233
"returnType": {
234-
"id": "TypeObject",
235-
"name": "Object"
234+
"id": "TypeRegion",
235+
"name": "Region"
236236
}
237237
},
238238
"ExprRegionFlag": {
@@ -397,16 +397,16 @@
397397
"%offlineplayers/strings% (isn't|is not|aren't|are not) ([a] member|[the|an] owner) of %worldguardregions%"
398398
]
399399
},
400-
"CondIsValidRegionId": {
400+
"CondIsRegionTemporary": {
401401
"origin": {
402402
"name": "skript-worldguard",
403-
"class": "org.skriptlang.skriptworldguard.elements.conditions.CondIsValidRegionId"
403+
"class": "org.skriptlang.skriptworldguard.elements.conditions.CondIsRegionTemporary"
404404
},
405-
"id": "CondIsValidRegionId",
406-
"name": "Is Valid Region ID",
407-
"description": "A condition to test whether a string is a valid region ID.\nValid region IDs only contain letters, numbers, underscores, commas, single quotation marks, dashes, pluses, or forward slashes.",
405+
"id": "CondIsRegionTemporary",
406+
"name": "Is Region Temporary",
407+
"description": "A condition to test whether a region is temporary.\nTemporary regions are those that are removed when the server restarts.",
408408
"examples": [
409-
"command /createregion <text>:\n\tif the text-argument is not a valid region id:\n\t\tmessage \"<red>'%text-argument%' is not a valid region ID\")\n\t# here is where the rest of the command would go :)"
409+
"on region enter:\n\tif the region is temporary:\n\t\tmessage \"Be ready! This protected region will expire when the server restarts.\""
410410
],
411411
"since": [
412412
"1.0"
@@ -415,20 +415,20 @@
415415
"keywords": [],
416416
"deprecated": false,
417417
"patterns": [
418-
"%strings% (is|are) [a] valid [worldguard] region id",
419-
"%strings% (isn't|is not|aren't|are not) [a] valid [worldguard] region id"
418+
"%worldguardregions% (is|are) (temporary|transient)",
419+
"%worldguardregions% (isn't|is not|aren't|are not) (temporary|transient)"
420420
]
421421
},
422-
"CondIsRegionTemporary": {
422+
"CondIsValidRegionId": {
423423
"origin": {
424424
"name": "skript-worldguard",
425-
"class": "org.skriptlang.skriptworldguard.elements.conditions.CondIsRegionTemporary"
425+
"class": "org.skriptlang.skriptworldguard.elements.conditions.CondIsValidRegionId"
426426
},
427-
"id": "CondIsRegionTemporary",
428-
"name": "Is Region Temporary",
429-
"description": "A condition to test whether a region is temporary.\nTemporary regions are those that are removed when the server restarts.",
427+
"id": "CondIsValidRegionId",
428+
"name": "Is Valid Region ID",
429+
"description": "A condition to test whether a string is a valid region ID.\nValid region IDs only contain letters, numbers, underscores, commas, single quotation marks, dashes, pluses, or forward slashes.",
430430
"examples": [
431-
"on region enter:\n\tif the region is temporary:\n\t\tmessage \"Be ready! This protected region will expire when the server restarts.\""
431+
"command /createregion <text>:\n\tif the text-argument is not a valid region id:\n\t\tmessage \"<red>'%text-argument%' is not a valid region ID\")\n\t# here is where the rest of the command would go :)"
432432
],
433433
"since": [
434434
"1.0"
@@ -437,8 +437,8 @@
437437
"keywords": [],
438438
"deprecated": false,
439439
"patterns": [
440-
"%worldguardregions% (is|are) (temporary|transient)",
441-
"%worldguardregions% (isn't|is not|aren't|are not) (temporary|transient)"
440+
"%strings% (is|are) [a] valid [worldguard] region id",
441+
"%strings% (isn't|is not|aren't|are not) [a] valid [worldguard] region id"
442442
]
443443
},
444444
"CondIsRegionType": {

0 commit comments

Comments
 (0)