Skip to content

Commit 0bcc98b

Browse files
Documentation improvements
1 parent 8eb95f1 commit 0bcc98b

File tree

5 files changed

+14
-8
lines changed

5 files changed

+14
-8
lines changed

src/main/java/org/skriptlang/skriptworldguard/elements/conditions/CondIsRegionTemporary.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@
1010

1111
@Name("Is Region Temporary")
1212
@Description({
13-
"A condition to test whether a region is temporary.",
14-
"Temporary regions are those that are removed when the server restarts."
13+
"A condition to test whether a region is temporary.",
14+
"Temporary regions are those that are removed when the server restarts."
1515
})
1616
@Example("""
1717
on region enter:

src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprBlocksInRegion.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,12 @@
2222

2323
@Name("Blocks of Region")
2424
@Description("An expression that returns all of the blocks in the given regions.")
25-
@Example("set the blocks of {arena} to air")
25+
@Example("""
26+
command /fillregion <text> <material>:
27+
trigger:
28+
set {_region} to the region text-argument in the player's world
29+
set the blocks of {_region} to material-argument
30+
""")
2631
@Since("1.0")
2732
public class ExprBlocksInRegion extends PropertyExpression<WorldGuardRegion, Block> {
2833

src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegionFlag.java

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,8 +38,10 @@
3838

3939
@Name("Region Flag")
4040
@Description({
41-
"An expression for working with the flag of a region.",
42-
"NOTE: Skript may not support all flags, specifically those representing values Skript cannot understand."
41+
"An expression for working with the flag of a region.",
42+
"The region group flag of a flag supports controlling which groups of a region" +
43+
" (i.e., members, owners, etc.) a flag applies to.",
44+
"NOTE: Skript may not support all flags, specifically those representing values Skript cannot understand."
4345
})
4446
@Example("message flag \"greeting\" of player's region")
4547
@Since("1.0")

src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegionParent.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@
1515

1616
@Name("Region Parent")
1717
@Description({
18-
"An expression to obtain and change the parent of a region.",
19-
"When a region has a parent, it inherits the parents members, owners, and flags (that aren't defined on the child)."
18+
"An expression to obtain and change the parent of a region.",
19+
"When a region has a parent, it inherits the parents members, owners, and flags (that aren't defined on the child)."
2020
})
2121
@Example("""
2222
command /setparent <text>:

src/main/java/org/skriptlang/skriptworldguard/elements/expressions/ExprRegions.java

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,6 @@
99
import ch.njol.skript.lang.SyntaxStringBuilder;
1010
import ch.njol.skript.lang.util.SimpleExpression;
1111
import ch.njol.util.Kleenean;
12-
import org.bukkit.Bukkit;
1312
import org.jetbrains.annotations.Nullable;
1413
import org.skriptlang.skript.registration.SyntaxInfo;
1514
import org.skriptlang.skript.registration.SyntaxRegistry;

0 commit comments

Comments
 (0)