Skip to content
This repository was archived by the owner on Feb 25, 2025. It is now read-only.

Commit 3896503

Browse files
committed
Added docs stuff.
1 parent e47aa9b commit 3896503

20 files changed

+125
-25
lines changed

src/main/java/me/asleepp/skript_itemsadder/elements/conditions/CondIsCustomBlock.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.conditions;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Condition;
58
import ch.njol.skript.lang.Expression;
69
import ch.njol.skript.lang.SkriptParser;
@@ -13,7 +16,9 @@
1316
import org.bukkit.inventory.ItemStack;
1417

1518
import javax.annotation.Nullable;
16-
19+
@Name("Is ItemsAdder Block")
20+
@Description({"Checks if the block is an ItemsAdder block."})
21+
@Examples({"if ruby_block is a custom block"})
1722
public class CondIsCustomBlock extends Condition {
1823
private Expression<Block> block;
1924

src/main/java/me/asleepp/skript_itemsadder/elements/conditions/CondIsCustomEntity.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.conditions;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Condition;
58
import ch.njol.skript.lang.Expression;
69
import ch.njol.skript.lang.SkriptParser;
@@ -10,7 +13,9 @@
1013
import org.bukkit.event.Event;
1114

1215
import javax.annotation.Nullable;
13-
16+
@Name("Is ItemsAdder Entity")
17+
@Description({"Checks if the entity is an ItemsAdder entity."})
18+
@Examples({"if jonesy is a custom entity"})
1419
public class CondIsCustomEntity extends Condition {
1520

1621
private Expression<Entity> entities;

src/main/java/me/asleepp/skript_itemsadder/elements/conditions/CondIsCustomItem.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
import ch.njol.skript.Skript;
44
import ch.njol.skript.aliases.ItemType;
5+
import ch.njol.skript.doc.Description;
6+
import ch.njol.skript.doc.Examples;
7+
import ch.njol.skript.doc.Name;
58
import ch.njol.skript.lang.Condition;
69
import ch.njol.skript.lang.Expression;
710
import ch.njol.skript.lang.SkriptParser;
@@ -12,7 +15,9 @@
1215

1316
import javax.annotation.Nullable;
1417

15-
18+
@Name("Is ItemsAdder Item")
19+
@Description({"Checks if the item is an ItemsAdder item."})
20+
@Examples({"if player's tool is a custom item"})
1621
public class CondIsCustomItem extends Condition {
1722

1823
private Expression<ItemType> item;

src/main/java/me/asleepp/skript_itemsadder/elements/effects/EffPlaceBlock.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.effects;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Effect;
58
import ch.njol.skript.lang.Expression;
69
import ch.njol.skript.lang.SkriptParser;
@@ -10,7 +13,9 @@
1013
import org.bukkit.event.Event;
1114

1215
import javax.annotation.Nullable;
13-
16+
@Name("PlaceCustomBlock")
17+
@Description({"Places a custom block."})
18+
@Examples({"set block at player's location to custom itemsadder block ruby_block"})
1419
public class EffPlaceBlock extends Effect {
1520
private Expression<Location> locationExpr;
1621
private Expression<String> customBlockIdExpr;

src/main/java/me/asleepp/skript_itemsadder/elements/effects/EffPlayIATotemAnimation.java

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.effects;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Effect;
58
import ch.njol.skript.lang.Expression;
69
import ch.njol.skript.lang.SkriptParser;
@@ -10,14 +13,16 @@
1013
import org.bukkit.event.Event;
1114

1215
import javax.annotation.Nullable;
13-
16+
@Name("Play ItemsAdder Totem Animation")
17+
@Description({"Play a custom Totem Animation to players."})
18+
@Examples({"play the custom totem animation you_win to player"})
1419
public class EffPlayIATotemAnimation extends Effect {
1520

1621
private Expression<Player> players;
1722
private Expression<String> totem;
1823

1924
static {
20-
Skript.registerEffect(EffSendIAResourcePack.class, "(play|make) (custom|ia|itemsadder) totem [(anim|animation)] %string% to %players%");
25+
Skript.registerEffect(EffSendIAResourcePack.class, "(play|make) [the] (custom|ia|itemsadder) totem [(anim|animation)] %string% to %players%");
2126
}
2227

2328
@Override

src/main/java/me/asleepp/skript_itemsadder/elements/effects/EffPlayerEmote.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.effects;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Effect;
58
import ch.njol.skript.lang.Expression;
69
import ch.njol.skript.lang.SkriptParser;
@@ -10,7 +13,9 @@
1013
import org.bukkit.event.Event;
1114

1215
import javax.annotation.Nullable;
13-
16+
@Name("Make Player Emote/Stop Emoting")
17+
@Description({"Force player to emote/stop emoting"})
18+
@Examples({"force all players to perform emote fortinayt"})
1419
public class EffPlayerEmote extends Effect {
1520
private Expression<Player> players;
1621
private Expression<String> emote;

src/main/java/me/asleepp/skript_itemsadder/elements/effects/EffSendIAResourcePack.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.effects;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Effect;
58
import ch.njol.skript.lang.Expression;
69
import ch.njol.skript.lang.SkriptParser;
@@ -10,7 +13,9 @@
1013
import org.bukkit.event.Event;
1114

1215
import javax.annotation.Nullable;
13-
16+
@Name("Send ItemsAdder Resource Pack")
17+
@Description({"Sends the most recently generated ItemsAdder resource pack to players."})
18+
@Examples({"send current itemsadder resource pack to all players"})
1419
public class EffSendIAResourcePack extends Effect {
1520

1621
private Expression<Player> players;

src/main/java/me/asleepp/skript_itemsadder/elements/effects/EffSetBlocksBetween.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.effects;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Effect;
58
import ch.njol.skript.lang.Expression;
69
import ch.njol.skript.lang.SkriptParser;
@@ -10,7 +13,9 @@
1013
import org.bukkit.event.Event;
1114

1215
import javax.annotation.Nullable;
13-
16+
@Name("Set Custom Blocks Within")
17+
@Description({"Sets the blocks within 2 locations to ItemsAdder custom blocks."})
18+
@Examples({"set all blocks within location(0, 100, 0) and player's location to custom block ruby_block"})
1419
public class EffSetBlocksBetween extends Effect {
1520
private Expression<Location> location1Expr;
1621
private Expression<Location> location2Expr;

src/main/java/me/asleepp/skript_itemsadder/elements/events/EvtCustomBlockBreak.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.events;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Literal;
58
import ch.njol.skript.lang.SkriptEvent;
69
import ch.njol.skript.lang.SkriptParser;
@@ -9,7 +12,9 @@
912
import org.bukkit.event.Event;
1013

1114
import javax.annotation.Nullable;
12-
15+
@Name("On Custom Block Break")
16+
@Description({"Fires when a ItemsAdder block gets broken."})
17+
@Examples({"on break of custom block:"})
1318
public class EvtCustomBlockBreak extends SkriptEvent {
1419

1520
private Literal<String> blockName;

src/main/java/me/asleepp/skript_itemsadder/elements/events/EvtCustomBlockInteract.java

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
package me.asleepp.skript_itemsadder.elements.events;
22

33
import ch.njol.skript.Skript;
4+
import ch.njol.skript.doc.Description;
5+
import ch.njol.skript.doc.Examples;
6+
import ch.njol.skript.doc.Name;
47
import ch.njol.skript.lang.Literal;
58
import ch.njol.skript.lang.SkriptEvent;
69
import ch.njol.skript.lang.SkriptParser;
@@ -9,7 +12,9 @@
912
import org.bukkit.event.Event;
1013

1114
import javax.annotation.Nullable;
12-
15+
@Name("On Custom Block Interact")
16+
@Description({"Fires when a ItemsAdder block gets interacted with."})
17+
@Examples({"on interact with custom block:"})
1318
public class EvtCustomBlockInteract extends SkriptEvent {
1419
private Literal<String> blockName;
1520

0 commit comments

Comments
 (0)