· 7 years ago · Sep 12, 2018, 08:58 AM
1Events:
2 At Time:
3 ID: at_time
4 Description:
5 An event that occurs at a given minecraft time in every world or only in specific worlds.
6 Examples:
7 at 18:00
8 at 7am in "world"
9 Since:
10 1.3.4
11 Patterns:
12 at %time% [in %worlds%]
13 Event values:
14 event-world
15 Cancellable: false
16 On Bed Enter:
17 ID: bed_enter
18 Description:
19 Called when a player starts sleeping.
20 Since:
21 1.0
22 Patterns:
23 [on] bed enter[ing]
24 [on] [player] enter[ing] [a] bed
25 Event values:
26 event-world
27 event-player
28 event-block
29 Cancellable: true
30 On Bed Leave:
31 ID: bed_leave
32 Description:
33 Called when a player leaves a bed.
34 Since:
35 1.0
36 Patterns:
37 [on] bed leav(e|ing)
38 [on] [player] leav(e|ing) [a] bed
39 Event values:
40 event-world
41 event-player
42 event-block
43 Cancellable: false
44 On Block Damage:
45 ID: block_damage
46 Description:
47 Called when a player starts to break a block. You can usually just use the leftclick event for this.
48 Since:
49 1.0
50 Patterns:
51 [on] block damag(ing|e)
52 Event values:
53 event-location
54 event-world
55 event-player
56 event-block
57 Cancellable: true
58 On Block Growth:
59 ID: block_growth
60 Description:
61 Called when a crop grows. Alternative to new form of generic grow event.
62 Examples:
63 on crop growth
64 Since:
65 2.2-Fixes-V10
66 Patterns:
67 [on] (plant|crop|block) grow[(th|ing)] [[of] %itemtypes%]
68 Event values:
69 past event-block
70 event-location
71 event-world
72 event-block
73 Cancellable: true
74 On Book Edit:
75 ID: book_edit
76 Description:
77 Called when a player edits a book
78 Since:
79 2.2-dev31
80 Patterns:
81 [on] book (edit|change|write)
82 Event values:
83 event-itemstack
84 event-world
85 event-player
86 Cancellable: true
87 On Book Sign:
88 ID: book_sign
89 Description:
90 Called when a player signs a book
91 Since:
92 2.2-dev31
93 Patterns:
94 [on] book sign[ing]
95 Event values:
96 event-itemstack
97 event-world
98 event-player
99 Cancellable: true
100 On Break / Mine:
101 ID: break_mine
102 Description:
103 Called when a block is broken by a player. If you use 'on mine', only events where the broken block dropped something will call the trigger.
104 Examples:
105 on mine
106 on break of stone
107 on mine of any ore
108 Since:
109 1.0 (break), <i>unknown</i> (mine)
110 Patterns:
111 [on] [block] (break[ing]|min(e|ing)) [[of] %itemtypes%]
112 Event values:
113 past event-block
114 event-entity
115 event-location
116 event-world
117 event-player
118 event-block
119 future event-block
120 Cancellable: true
121 On Bucket Empty:
122 ID: bucket_empty
123 Description:
124 Called when a player empties a bucket. You can also use the place event with a check for water or lava.
125 Since:
126 1.0
127 Patterns:
128 [on] bucket empty[ing]
129 [on] [player] empty[ing] [a] bucket
130 Event values:
131 past event-block
132 event-world
133 event-player
134 event-block
135 Cancellable: true
136 On Bucket fill:
137 ID: bucket_fill
138 Description:
139 Called when a player fills a bucket.
140 Since:
141 1.0
142 Patterns:
143 [on] bucket fill[ing]
144 [on] [player] fill[ing] [a] bucket
145 Event values:
146 event-world
147 event-player
148 event-block
149 future event-block
150 Cancellable: true
151 On Burn:
152 ID: burn
153 Description:
154 Called when a block is destroyed by fire.
155 Examples:
156 on burn
157 on burn of wood, fences, or chests
158 Since:
159 1.0
160 Patterns:
161 [on] [block] burn[ing] [[of] %itemtypes%]
162 Event values:
163 event-location
164 event-world
165 event-block
166 Cancellable: true
167 On Can Build Check:
168 ID: can_build_check
169 Description:
170 Called when a player rightclicks on a block while holding a block or a placeable item. You can either cancel the event to prevent the block from being built, or uncancel it to allow it.
171 Please note that the data value of the block to be placed is not available in this event, only its ID.
172 Since:
173 1.0 (basic), 2.0 ([un]cancellable)
174 Patterns:
175 [on] [block] can build check
176 Event values:
177 past event-block
178 event-location
179 event-world
180 event-block
181 Cancellable: false
182 On Chat:
183 ID: chat
184 Description:
185 Called whenever a player chats. Use chat format to change message format, use chat recipients to edit chat recipients.
186 Examples:
187 on chat:
188 if player has permission "owner":
189 set chat format to "<red>[player]<light gray>: <light red>[message]"
190 else if player has permission "admin":
191 set chat format to "<light red>[player]<light gray>: <orange>[message]"
192 else: #default message format
193 set chat format to "<orange>[player]<light gray>: <white>[message]"
194 Since:
195 1.4.1
196 Patterns:
197 [on] chat
198 Event values:
199 event-world
200 event-player
201 Cancellable: true
202 On Chunk Generate:
203 ID: chunk_generate
204 Description:
205 Called after a new chunk was generated.
206 Since:
207 1.0
208 Patterns:
209 [on] chunk (generat|populat)(e|ing)
210 Event values:
211 event-world
212 event-chunk
213 Cancellable: false
214 On Chunk Load:
215 ID: chunk_load
216 Description:
217 Called when a chunk loads. The chunk might or might not contain mobs when it's loaded.
218 Since:
219 1.0
220 Patterns:
221 [on] chunk load[ing]
222 Event values:
223 event-world
224 event-chunk
225 Cancellable: false
226 On Chunk Unload:
227 ID: chunk_unload
228 Description:
229 Called when a chunk is unloaded due to not being near any player. Cancel the event to force the server to keep the chunk loaded and thus keep simulating the chunk (e.g. physics, plant growth, minecarts, etc. will keep working and won't freeze).
230 Since:
231 1.0
232 Patterns:
233 [on] chunk unload[ing]
234 Event values:
235 event-world
236 event-chunk
237 Cancellable: true
238 On Click:
239 ID: click
240 Description:
241 Called when a user clicks on a block, an entity or air with or without an item in their hand.
242 Please note that rightclick events with an empty hand while not looking at a block are not sent to the server, so there's no way to detect them.
243 Examples:
244 on click
245 on rightclick holding a fishing rod
246 on leftclick on a stone or obsidian
247 on rightclick on a creeper
248 on click with a sword
249 Since:
250 1.0
251 Patterns:
252 [on] [(right|left)(| |-)][mouse(| |-)]click[ing] [on %-entitydata/itemtype%] [(with|using|holding) %itemtype%]
253 [on] [(right|left)(| |-)][mouse(| |-)]click[ing] (with|using|holding) %itemtype% on %entitydata/itemtype%
254 Event values:
255 event-direction
256 event-itemstack
257 event-entity
258 event-world
259 event-player
260 event-block
261 Cancellable: true
262 On Combust:
263 ID: combust
264 Description:
265 Called when an entity is set on fire, e.g. by fire or lava, a fireball, or by standing in direct sunlight (zombies, skeletons).
266 Since:
267 1.0
268 Patterns:
269 [on] combust[ing]
270 Event values:
271 event-entity
272 event-world
273 Cancellable: true
274 On Command:
275 ID: command
276 Description:
277 Called when a player enters a command (not neccessarily a Skript command).
278 Examples:
279 on command
280 on command "/stop"
281 on command "pm Njol "
282 Since:
283 2.0
284 Patterns:
285 [on] command [%-string%]
286 Event values:
287 event-world
288 event-commandsender
289 event-player
290 Cancellable: true
291 On Connect:
292 ID: connect
293 Description:
294 Called when the player connects to the server. This event is called before the player actually joins the server, so if you want to prevent players from joining you should prefer this event over on join.
295 Examples:
296 on connect:
297 player doesn't have permission "VIP"
298 number of players is larger than 20, kick the player due to "The last 5 slots are reserved for VIP players."
299 Since:
300 2.0
301 Patterns:
302 [on] [player] connect[ing]
303 Event values:
304 event-world
305 event-player
306 Cancellable: false
307 On Consume:
308 ID: consume
309 Description:
310 Called when a player is done eating/drinking something, e.g. an apple, bread, meat, milk or a potion.
311 Since:
312 2.0
313 Patterns:
314 [on] [player] ((eat|drink)[ing]|consum(e|ing)) [[of] %itemtypes%]
315 Event values:
316 event-itemstack
317 event-world
318 event-player
319 Cancellable: true
320 On Craft:
321 ID: craft
322 Description:
323 Called when a player crafts an item.
324 Since:
325 <i>unknown</i> (before 2.1)
326 Patterns:
327 [on] [player] craft[ing] [[of] %itemtypes%]
328 Event values:
329 event-itemstack
330 event-clicktype
331 event-world
332 event-inventory
333 event-recipe
334 event-player
335 event-slot
336 event-inventoryaction
337 Cancellable: true
338 On Creeper Power:
339 ID: creeper_power
340 Description:
341 Called when a creeper is struck by lighting and gets powered. Cancel the event to prevent the creeper from being powered.
342 Since:
343 1.0
344 Patterns:
345 [on] creeper power
346 Event values:
347 event-entity
348 event-world
349 Cancellable: true
350 On Damage:
351 ID: damage
352 Description:
353 Called when an entity receives damage, e.g. by an attack from another entity, lava, fire, drowning, fall, suffocation, etc.
354 Examples:
355 on damage
356 on damage of a player
357 Since:
358 1.0
359 Patterns:
360 [on] damag(e|ing) [of %entitydata%]
361 Event values:
362 event-projectile
363 event-damagecause
364 Cancellable: true
365 On Death:
366 ID: death
367 Description:
368 Called when a living entity (including players) dies.
369 Examples:
370 on death
371 on death of player
372 on death of a wither or ender dragon:
373 broadcast "A %entity% has been slain in %world%!"
374 Since:
375 1.0
376 Patterns:
377 [on] death [of %entitydatas%]
378 Event values:
379 event-entity
380 event-projectile
381 event-damagecause
382 event-world
383 Cancellable: false
384 On Dispense:
385 ID: dispense
386 Description:
387 Called when a dispenser dispenses an item.
388 Since:
389 <i>unknown</i> (before 2.1)
390 Patterns:
391 [on] dispens(e|ing) [[of] %itemtypes%]
392 Event values:
393 event-itemstack
394 event-location
395 event-world
396 event-block
397 Cancellable: true
398 On DownloadFile:
399 ID: downloadfile
400 Patterns:
401 [on] [skutil[ities] ]file download
402 Event values:
403 event-object
404 event-string
405 Cancellable: true
406 On Drop:
407 ID: drop
408 Description:
409 Called when a player drops an item from his inventory.
410 Since:
411 <i>unknown</i> (before 2.1)
412 Patterns:
413 [on] [player] drop[ing] [[of] %itemtypes%]
414 Event values:
415 event-itementity
416 event-itemstack
417 event-world
418 event-player
419 Cancellable: true
420 On Enderman/Sheep/Silverfish:
421 ID: endermansheepsilverfish
422 Description:
423 Called when an enderman places or picks up a block, a sheep eats grass or a silverfish boops into/out of a block respectively.
424 Patterns:
425 [on] enderman place
426 [on] enderman pickup
427 [on] sheep eat
428 [on] silverfish enter
429 [on] silverfish exit
430 Event values:
431 event-entity
432 event-world
433 event-block
434 Cancellable: true
435 On Entity Dismount:
436 ID: entity_dismount
437 Description:
438 Called when an entity dismounts.
439 Since:
440 2.2-dev13b
441 Patterns:
442 [on] dismount[ing]
443 Event values:
444 event-entity
445 event-world
446 Cancellable: false
447 On Entity Mount:
448 ID: entity_mount
449 Description:
450 Called when entity starts riding another.
451 Since:
452 2.2-dev13b
453 Patterns:
454 [on] mount[ing]
455 Event values:
456 event-entity
457 event-world
458 Cancellable: true
459 On Experience Spawn:
460 ID: experience_spawn
461 Description:
462 Called whenever experience is about to spawn. This is a helper event for easily being able to stop xp from spawning, as all you can currently do is cancel the event.
463 Please note that it's impossible to detect xp orbs spawned by plugins (including Skript) with Bukkit, thus make sure that you have no such plugins if you don't want any xp orbs to spawn. (Many plugins that only change the experience dropped by blocks or entities will be detected without problems though)
464 Examples:
465 on xp spawn:
466 world is "minigame_world"
467 cancel event
468 Since:
469 2.0
470 Patterns:
471 [on] [e]xp[erience] [orb] spawn
472 [on] spawn of [a[n]] [e]xp[erience] [orb]
473 Event values:
474 event-location
475 event-experience
476 Cancellable: true
477 On Explode:
478 ID: explode
479 Description:
480 Called when an entity (a primed TNT or a creeper) explodes.
481 Since:
482 1.0
483 Patterns:
484 [on] explo(d(e|ing)|sion)
485 Event values:
486 event-entity
487 event-world
488 Cancellable: true
489 On Explosion Prime:
490 ID: explosion_prime
491 Description:
492 Called when an explosive is primed, i.e. an entity will explode shortly. Creepers can abort the explosion if the player gets too far away, while TNT will explode for sure after a short time.
493 Since:
494 1.0
495 Patterns:
496 [on] explosion prime
497 Event values:
498 event-entity
499 event-world
500 Cancellable: true
501 On Fade:
502 ID: fade
503 Description:
504 Called when a block 'fades away', e.g. ice or snow melts.
505 Examples:
506 on fade of snow or ice
507 Since:
508 1.0
509 Patterns:
510 [on] [block] fad(e|ing) [[of] %itemtypes%]
511 Event values:
512 past event-block
513 event-location
514 event-world
515 event-block
516 future event-block
517 Cancellable: true
518 On FileCopy:
519 ID: filecopy
520 Patterns:
521 [on] [skutil[ities] ]file copy
522 Event values:
523 event-object
524 event-string
525 Cancellable: true
526 On FileCreation:
527 ID: filecreation
528 Patterns:
529 [on] [skutil[ities] ]file creat(ion|e)
530 Event values:
531 event-object
532 Cancellable: true
533 On FileDeletion:
534 ID: filedeletion
535 Patterns:
536 [on] [skutil[ities] ]file delet(ion|e)
537 Event values:
538 event-object
539 Cancellable: true
540 On FileMove:
541 ID: filemove
542 Patterns:
543 [on] [skutil[ities] ]file move
544 Event values:
545 event-object
546 event-string
547 Cancellable: true
548 On FileRename:
549 ID: filerename
550 Patterns:
551 [on] [skutil[ities] ]file rename
552 Event values:
553 event-object
554 event-string
555 Cancellable: true
556 On FileWipe:
557 ID: filewipe
558 Patterns:
559 [on] [skutil[ities] ]file (wipe|reset|clear)
560 Event values:
561 event-object
562 Cancellable: true
563 On FileWrite:
564 ID: filewrite
565 Patterns:
566 [on] [skutil[ities] ]file write
567 Event values:
568 event-number
569 event-object
570 event-string
571 Cancellable: true
572 On FileZip:
573 ID: filezip
574 Patterns:
575 [on] [skutil[ities] ]file zip
576 Event values:
577 event-object
578 event-string
579 Cancellable: true
580 On First Join:
581 ID: first_join
582 Description:
583 Called when a player joins the server for the first time.
584 Since:
585 1.3.7
586 Patterns:
587 [on] first (join|login)
588 Event values:
589 event-world
590 event-player
591 Cancellable: false
592 On Fishing:
593 ID: fishing
594 Description:
595 Called when a player fishes something. This is not of much use yet.
596 Since:
597 1.0
598 Patterns:
599 [on] [player] fish[ing]
600 Event values:
601 event-world
602 event-player
603 Cancellable: true
604 On Flight Toggle:
605 ID: flight_toggle
606 Description:
607 Called when a players stops/starts flying.
608 Examples:
609 on flight toggle:
610 if {game::%player%::playing} exists:
611 cancel event
612 Since:
613 2.2-dev36
614 Patterns:
615 [on] [player] flight togg(e|ing)
616 [on] [player] toggl(e|ing) flight
617 Event values:
618 event-world
619 event-player
620 Cancellable: true
621 On Flow:
622 ID: flow
623 Description:
624 Called when a blocks flows or teleports to another block. This not only applies to water and lava, but teleporting dragon eggs as well.
625 Since:
626 1.0
627 Patterns:
628 [on] [block] flow[ing]
629 [on] block mov(e|ing)
630 Event values:
631 event-location
632 event-world
633 event-block
634 future event-block
635 Cancellable: true
636 On Form:
637 ID: form
638 Description:
639 Called when a block is created, but not by a player, e.g. snow forms due to snowfall, water freezes in cold biomes. This isn't called when block spreads (mushroom growth, water physics etc.), as it has its own event (see spread event).
640 Examples:
641 on form of snow
642 on form of a mushroom
643 Since:
644 1.0
645 Patterns:
646 [on] [block] form[ing] [[of] %itemtypes%]
647 Event values:
648 past event-block
649 event-location
650 event-world
651 event-block
652 Cancellable: true
653 On Fuel Burn:
654 ID: fuel_burn
655 Description:
656 Called when a furnace burns an item from its fuel slot.
657 Since:
658 1.0
659 Patterns:
660 [on] fuel burn[ing]
661 Event values:
662 event-location
663 event-world
664 event-block
665 Cancellable: true
666 On Gamemode Change:
667 ID: gamemode_change
668 Description:
669 Called when a player's gamemode changes.
670 Examples:
671 on gamemode change
672 on gamemode change to adventure
673 Since:
674 1.0
675 Patterns:
676 [on] game[ ]mode change [to %gamemode%]
677 Event values:
678 event-world
679 event-player
680 Cancellable: true
681 On Grow:
682 ID: grow
683 Description:
684 Called when a tree, giant mushroom or plant grows to next stage.
685 Examples:
686 on grow
687 on grow of a tree
688 on grow of a huge jungle tree
689 Since:
690 1.0 (2.2-dev20 for plants)
691 Patterns:
692 [on] grow [of (%-structuretype%|%-itemtype%)]
693 Event values:
694 past event-block
695 event-location
696 event-world
697 event-block
698 future event-block
699 Cancellable: true
700 On Heal:
701 ID: heal
702 Description:
703 Called when an entity is healed, e.g. by eating (players), being fed (pets), or by the effect of a potion of healing (overworld mobs) or harm (nether mobs).
704 Since:
705 1.0
706 Patterns:
707 [on] heal[ing]
708 Event values:
709 event-entity
710 event-world
711 Cancellable: true
712 On Hunger Meter Change:
713 ID: hunger_meter_change
714 Description:
715 Called when the hunger bar of a player changes, i.e. either increases by eating or decreases over time.
716 Since:
717 1.4.4
718 Patterns:
719 [on] (food|hunger) (level|met(er|re)|bar) chang(e|ing)
720 Event values:
721 event-entity
722 event-world
723 Cancellable: true
724 On Ignition:
725 ID: ignition
726 Description:
727 Called when a block starts burning, i.e. a fire block is placed next to it and this block is flammable.
728 The burn event will be called when the block is about do be destroyed by the fire.
729 Since:
730 1.0
731 Patterns:
732 [on] [block] ignit(e|ion)
733 Event values:
734 event-location
735 event-world
736 event-player
737 event-block
738 Cancellable: true
739 On Inventory Click:
740 ID: inventory_click
741 Description:
742 Called when clicking on inventory slot.
743 Since:
744 2.2-Fixes-V10
745 Patterns:
746 [on] [player] inventory(-| )click[ing] [[at] %itemtypes%]
747 Event values:
748 event-itemstack
749 event-clicktype
750 event-world
751 event-inventory
752 event-recipe
753 event-player
754 event-slot
755 event-inventoryaction
756 Cancellable: true
757 On Inventory Close:
758 ID: inventory_close
759 Description:
760 Called when player's currently viewed inventory is closed.
761 Since:
762 2.2-dev21
763 Patterns:
764 [on] inventory clos(ing|e[d])
765 Event values:
766 event-inventory
767 event-player
768 Cancellable: false
769 On Inventory Open:
770 ID: inventory_open
771 Description:
772 Called when an inventory is opened for player.
773 Since:
774 2.2-dev21
775 Patterns:
776 [on] inventory open[ed]
777 Event values:
778 event-inventory
779 event-player
780 Cancellable: true
781 On Item Break:
782 ID: item_break
783 Description:
784 Called when a player breaks his tool because its damage reached the maximum value.
785 This event cannot be cancelled.
786 Since:
787 2.1.1
788 Patterns:
789 [on] [player] tool break[ing]
790 [on] [player] break[ing] (a|the|) tool
791 Event values:
792 event-itemstack
793 event-world
794 event-player
795 Cancellable: false
796 On Item Despawn:
797 ID: item_despawn
798 Description:
799 Called when an item is about to be despawned from the world, usually 5 minutes after it was dropped.
800 Examples:
801 on item despawn of diamond:
802 send "Not my precious!"
803 cancel event
804 Since:
805 2.2-dev35
806 Patterns:
807 [on] (item[ ][stack]|[item] %-itemtypes%) despawn[ing]
808 [on] [item[ ][stack]] despawn[ing] [[of] %-itemtypes%]
809 Event values:
810 event-itementity
811 event-itemstack
812 event-entity
813 event-world
814 Cancellable: true
815 On Item Merge:
816 ID: item_merge
817 Description:
818 Called when dropped items merge into a single stack.
819 Examples:
820 on item merge of gold blocks:
821 cancel event
822 Since:
823 2.2-dev35
824 Patterns:
825 [on] (item[ ][stack]|[item] %-itemtypes%) merg(e|ing)
826 [on] item[ ][stack] merg(e|ing) [[of] %-itemtypes%]
827 Event values:
828 event-itementity
829 event-itemstack
830 event-entity
831 event-world
832 Cancellable: true
833 On Item Spawn:
834 ID: item_spawn
835 Description:
836 Called whenever an item stack is spawned in a world, e.g. as drop of a block or mob, a player throwing items out of his inventory, or a dispenser dispensing an item (not shooting it).
837 Since:
838 <i>unknown</i> (before 2.1)
839 Patterns:
840 [on] item spawn[ing] [[of] %itemtypes%]
841 Event values:
842 event-itemstack
843 event-entity
844 event-world
845 Cancellable: true
846 On Join:
847 ID: join
848 Description:
849 Called when the player joins the server. The player is already in a world when this event is called, so if you want to prevent players from joining you should prefer on connect over this event.
850 Examples:
851 on join:
852 message "Welcome on our awesome server!"
853 broadcast "%player% just joined the server!"
854 Since:
855 1.0
856 Patterns:
857 [on] [player] (login|logging in|join[ing])
858 Event values:
859 event-world
860 event-player
861 Cancellable: false
862 On Kick:
863 ID: kick
864 Description:
865 Called when a player is kicked from the server. You can change the kick message or cancel the event entirely.
866 Since:
867 1.0
868 Patterns:
869 [on] [player] (kick|being kicked)
870 Event values:
871 event-world
872 event-player
873 Cancellable: true
874 On Leaves Decay:
875 ID: leaves_decay
876 Description:
877 Called when a leaf block decays due to not being connected to a tree.
878 Since:
879 1.0
880 Patterns:
881 [on] leaves decay[ing]
882 Event values:
883 event-location
884 event-world
885 event-block
886 Cancellable: true
887 On Level Change:
888 ID: level_change
889 Description:
890 Called when a player's level changes, e.g. by gathering experience or by enchanting something.
891 Since:
892 1.0
893 Patterns:
894 [on] [player] level [change]
895 Event values:
896 event-world
897 event-player
898 Cancellable: false
899 On Lightning Strike:
900 ID: lightning_strike
901 Description:
902 Called when lightning strikes.
903 Since:
904 1.0
905 Patterns:
906 [on] lightning [strike]
907 Event values:
908 event-world
909 Cancellable: true
910 On Move On:
911 ID: move_on
912 Description:
913 Called when a player moves onto a certain type of block. Please note that using this event can cause lag if there are many players online.
914 Examples:
915 on walking on dirt or grass
916 on stepping on stone
917 Since:
918 2.0
919 Patterns:
920 [on] (step|walk)[ing] (on|over) %*itemtypes%
921 Event values:
922 event-world
923 event-object
924 event-player
925 event-block
926 Cancellable: true
927 On On Any Move:
928 ID: on_any_move
929 Patterns:
930 [on] any[ ]move
931 Event values:
932 event-world
933 event-object
934 event-player
935 event-block
936 Cancellable: true
937 On On Download:
938 ID: on_download
939 Patterns:
940 [on] download
941 Event values:
942 none
943 Cancellable: true
944 On On Edit Book:
945 ID: on_edit_book
946 Patterns:
947 [on] [player] edit book
948 Event values:
949 event-itemstack
950 event-world
951 event-player
952 Cancellable: true
953 On On Enchant:
954 ID: on_enchant
955 Patterns:
956 [on] enchant [item]
957 Event values:
958 event-itemstack
959 event-player
960 Cancellable: true
961 On On Horse Jump:
962 ID: on_horse_jump
963 Patterns:
964 [on] horse jump
965 Event values:
966 event-entity
967 event-world
968 event-livingentity
969 Cancellable: true
970 On On Inventory Click:
971 ID: on_inventory_click
972 Patterns:
973 [on] inventory click
974 Event values:
975 event-itemstack
976 event-clicktype
977 event-world
978 event-inventory
979 event-recipe
980 event-player
981 event-slot
982 event-inventoryaction
983 Cancellable: true
984 On On Inventory Close:
985 ID: on_inventory_close
986 Patterns:
987 [on] inventory open
988 [on] close inventory
989 Event values:
990 event-inventory
991 event-player
992 Cancellable: false
993 On On Inventory Open:
994 ID: on_inventory_open
995 Patterns:
996 [on] inventory open
997 [on] open inventory
998 Event values:
999 event-inventory
1000 event-player
1001 Cancellable: true
1002 On On Jump:
1003 ID: on_jump
1004 Patterns:
1005 [on] jump[ing]
1006 Event values:
1007 event-player
1008 Cancellable: true
1009 On On Prepare Item Craft:
1010 ID: on_prepare_item_craft
1011 Patterns:
1012 [on] prepare item craft
1013 Event values:
1014 event-itemstack
1015 event-inventory
1016 event-recipe
1017 event-slot
1018 event-player
1019 Cancellable: false
1020 On On Server Ping:
1021 ID: on_server_ping
1022 Patterns:
1023 [on] [server] [list] ping
1024 Event values:
1025 event-string
1026 Cancellable: false
1027 On Physics:
1028 ID: physics
1029 Description:
1030 Called when a physics check is done on a block. By cancelling this event you can prevent some things from happening, e.g. sand falling, dirt turning into grass, torches dropping if their supporting block is destroyed, etc.Please note that using this event might cause quite some lag since it gets called extremely often.
1031 Examples:
1032 # prevents sand from falling
1033 on block physics:
1034 block is sand
1035 cancel event
1036 Since:
1037 1.4.6
1038 Patterns:
1039 [on] [block] physics
1040 Event values:
1041 event-location
1042 event-world
1043 event-block
1044 Cancellable: true
1045 On Pick Up:
1046 ID: pick_up
1047 Description:
1048 Called when a player picks up an item. Please note that the item is still on the ground when this event is called.
1049 Since:
1050 <i>unknown</i> (before 2.1)
1051 Patterns:
1052 [on] [player] (pick[ ]up|picking up) [[of] %itemtypes%]
1053 Event values:
1054 event-itementity
1055 event-itemstack
1056 event-world
1057 event-player
1058 Cancellable: true
1059 On Pig Zap:
1060 ID: pig_zap
1061 Description:
1062 Called when a pig is stroke by lightning and transformed into a zombie pigman. Cancel the event to prevent the transformation.
1063 Since:
1064 1.0
1065 Patterns:
1066 [on] pig[ ]zap
1067 Event values:
1068 event-entity
1069 event-world
1070 Cancellable: true
1071 On Piston Extend:
1072 ID: piston_extend
1073 Description:
1074 Called when a piston is about to extend.
1075 Since:
1076 1.0
1077 Patterns:
1078 [on] piston extend[ing]
1079 Event values:
1080 event-location
1081 event-world
1082 event-block
1083 Cancellable: true
1084 On Piston Retract:
1085 ID: piston_retract
1086 Description:
1087 Called when a piston is about to retract.
1088 Since:
1089 1.0
1090 Patterns:
1091 [on] piston retract[ing]
1092 Event values:
1093 event-location
1094 event-world
1095 event-block
1096 Cancellable: true
1097 On Place:
1098 ID: place
1099 Description:
1100 Called when a player places a block.
1101 Examples:
1102 on place
1103 on place of a furnace, workbench or chest
1104 Since:
1105 1.0
1106 Patterns:
1107 [on] [block] (plac(e|ing)|build[ing]) [[of] %itemtypes%]
1108 Event values:
1109 past event-block
1110 event-direction
1111 event-entity
1112 event-location
1113 event-world
1114 event-player
1115 event-block
1116 Cancellable: true
1117 On Player World Change:
1118 ID: player_world_change
1119 Description:
1120 Called when a player enters a world. Does not work with other entities!
1121 Examples:
1122 on player world change:
1123 world is "city"
1124 send "Welcome to the City!"
1125 Since:
1126 2.2-dev28
1127 Patterns:
1128 [on] [player] world chang(ing|e[d])
1129 Event values:
1130 event-world
1131 event-player
1132 Cancellable: false
1133 On Portal:
1134 ID: portal
1135 Description:
1136 Called when a player uses a nether or end portal. Cancel the event to prevent the player from teleporting.
1137 Since:
1138 1.0
1139 Patterns:
1140 [on] [player] portal
1141 Event values:
1142 event-world
1143 event-object
1144 event-player
1145 event-block
1146 Cancellable: true
1147 On Portal Create:
1148 ID: portal_create
1149 Description:
1150 Called when a portal is created, either by a player or mob lighting an obsidian frame on fire, or by a nether portal creating its teleportation target in the nether/overworld.
1151 Please note that it's not possible to use the player in this event.
1152 Since:
1153 1.0
1154 Patterns:
1155 [on] portal creat(e|ion)
1156 Event values:
1157 event-world
1158 Cancellable: true
1159 On Portal Enter:
1160 ID: portal_enter
1161 Description:
1162 Called when a player enters a nether portal and the swirly animation starts to play.
1163 Since:
1164 1.0
1165 Patterns:
1166 [on] portal enter[ing]
1167 [on] entering [a] portal
1168 Event values:
1169 event-entity
1170 event-world
1171 Cancellable: false
1172 On Prepare Craft:
1173 ID: prepare_craft
1174 Description:
1175 Called just before displaying crafting result to player. Note that setting the result item might or might not work due to Bukkit bugs.
1176 Since:
1177 2.2-Fixes-V10
1178 Patterns:
1179 [on] [player] (preparing|beginning) craft[ing] [[of] %itemtypes%]
1180 Event values:
1181 event-itemstack
1182 event-inventory
1183 event-recipe
1184 event-slot
1185 event-player
1186 Cancellable: false
1187 On Pressure Plate / Trip:
1188 ID: pressure_plate_trip
1189 Description:
1190 Called when a player steps on a pressure plate or tripwire respectively.
1191 Since:
1192 1.0 (pressure plate), 1.4.4 (tripwire)
1193 Patterns:
1194 [on] [step[ping] on] [a] [pressure] plate
1195 [on] (trip|[step[ping] on] [a] tripwire)
1196 Event values:
1197 event-direction
1198 event-itemstack
1199 event-world
1200 event-player
1201 event-block
1202 Cancellable: true
1203 On Projectile Hit:
1204 ID: projectile_hit
1205 Description:
1206 Called when a projectile hits an entity or a block.
1207 Use the damage event with a check for a projectile to be able to use the entity that got hit in the case when the projectile hit a living entity.
1208 A damage event will even be fired if the damage is 0, e.g. when throwing snowballs at non-nether mobs.
1209 Since:
1210 1.0
1211 Patterns:
1212 [on] projectile hit
1213 Event values:
1214 event-projectile
1215 Cancellable: false
1216 On Quit:
1217 ID: quit
1218 Description:
1219 Called when a player leaves the server. Starting with Skript 2.0 this also includes kicked players.
1220 Since:
1221 1.0
1222 Patterns:
1223 [on] (quit[ting]|disconnect[ing]|log[ ]out|logging out)
1224 Event values:
1225 event-world
1226 event-player
1227 Cancellable: false
1228 On Redstone:
1229 ID: redstone
1230 Description:
1231 Called when the redstone current of a block changes. This event is of not much use yet.
1232 Since:
1233 1.0
1234 Patterns:
1235 [on] redstone [current] [chang(e|ing)]
1236 Event values:
1237 event-location
1238 event-world
1239 event-block
1240 Cancellable: false
1241 On Respawn:
1242 ID: respawn
1243 Description:
1244 Called when a player respawns. You should prefer this event over the death event as the player is technically alive when this event is called.
1245 Since:
1246 1.0
1247 Patterns:
1248 [on] [player] respawn[ing]
1249 Event values:
1250 event-world
1251 event-player
1252 Cancellable: false
1253 On RunApp:
1254 ID: runapp
1255 Patterns:
1256 [on] [skutil[ities] ](file|app|script) (run|execute)
1257 Event values:
1258 event-object
1259 Cancellable: true
1260 On RunCode:
1261 ID: runcode
1262 Patterns:
1263 [on] [skutil[ities] ](bash|batch|sh) (command|cmd) (run|execute)
1264 Event values:
1265 event-string
1266 Cancellable: true
1267 On Script Load/Unload:
1268 ID: script_loadunload
1269 Description:
1270 Called directly after the trigger is loaded, or directly before the whole script is unloaded.
1271 Examples:
1272 on load:
1273 set {running.%script%} to true
1274 on unload:
1275 set {running.%script%} to false
1276 Since:
1277 2.0
1278 Patterns:
1279 [on] [script] (load|init|enable)
1280 [on] [script] (unload|stop|disable)
1281 Event values:
1282 none
1283 Cancellable: false
1284 On Server Start/Stop:
1285 ID: server_startstop
1286 Description:
1287 Called when the server starts or stops (actually, when Skript starts or stops, so a /reload will trigger these events as well).
1288 Examples:
1289 on Skript start
1290 on server stop
1291 Since:
1292 2.0
1293 Patterns:
1294 [on] (server|skript) (start|load|enable)
1295 [on] (server|skript) (stop|unload|disable)
1296 Event values:
1297 none
1298 Cancellable: false
1299 On Sheep Regrow Wool:
1300 ID: sheep_regrow_wool
1301 Description:
1302 Called when sheep regrows it's sheared wool back.
1303 Since:
1304 2.2-dev21
1305 Patterns:
1306 [on] sheep [re]grow[ing] wool
1307 Event values:
1308 event-entity
1309 event-world
1310 Cancellable: true
1311 On Shoot:
1312 ID: shoot
1313 Description:
1314 Called whenever a projectile is shot. Use the shooter expression to get who shot the projectile.
1315 Since:
1316 1.0
1317 Patterns:
1318 [on] [projectile] shoot
1319 Event values:
1320 event-projectile
1321 Cancellable: true
1322 On Sign Change:
1323 ID: sign_change
1324 Description:
1325 As signs are placed empty, this event is called when a player is done editing a sign.
1326 Examples:
1327 on sign change:
1328 line 2 is empty
1329 set line 1 to "<red>%line 1%"
1330 Since:
1331 1.0
1332 Patterns:
1333 [on] sign (chang[e]|edit)[ing]
1334 [on] [player] (chang[e]|edit)[ing] [a] sign
1335 Event values:
1336 event-location
1337 event-world
1338 event-player
1339 event-block
1340 Cancellable: true
1341 On Slime Split:
1342 ID: slime_split
1343 Description:
1344 Called when a slime splits. Usually this happens when a big slime dies.
1345 Since:
1346 2.2-dev26
1347 Patterns:
1348 [on] slime split[ting]
1349 Event values:
1350 event-entity
1351 event-world
1352 Cancellable: true
1353 On Smelt:
1354 ID: smelt
1355 Description:
1356 Called when a furnace smelts an item in its ore slot.
1357 Since:
1358 1.0
1359 Patterns:
1360 [on] [ore] smelt[ing]
1361 [on] smelt[ing] of ore
1362 Event values:
1363 event-location
1364 event-world
1365 event-block
1366 Cancellable: true
1367 On Sneak Toggle:
1368 ID: sneak_toggle
1369 Description:
1370 Called when a player starts or stops sneaking. Use is sneaking to get whether the player was sneaking before the event was called.
1371 Examples:
1372 # make players that stop sneaking jump
1373 on sneak toggle:
1374 player was sneaking
1375 push the player upwards at speed 0.5
1376 Since:
1377 1.0
1378 Patterns:
1379 [on] [player] toggl(e|ing) sneak
1380 [on] [player] sneak toggl(e|ing)
1381 Event values:
1382 event-world
1383 event-player
1384 Cancellable: true
1385 On Spawn:
1386 ID: spawn
1387 Description:
1388 Called when an creature spawns.
1389 Examples:
1390 on spawn of a zombie
1391 on spawn of an ender dragon:
1392 broadcast "A dragon has been sighted in %world%!"
1393 Since:
1394 1.0
1395 Patterns:
1396 [on] spawn[ing] [of %entitydatas%]
1397 Event values:
1398 event-entity
1399 event-world
1400 Cancellable: true
1401 On Spawn Change:
1402 ID: spawn_change
1403 Description:
1404 Called when the spawn point of a world changes.
1405 Since:
1406 1.0
1407 Patterns:
1408 [on] [world] spawn change
1409 Event values:
1410 event-world
1411 Cancellable: false
1412 On Spread:
1413 ID: spread
1414 Description:
1415 Called when a new block forms as a result of a block that can spread, e.g. water or mushrooms.
1416 Since:
1417 1.0
1418 Patterns:
1419 [on] spread[ing]
1420 Event values:
1421 past event-block
1422 event-location
1423 event-world
1424 event-block
1425 Cancellable: true
1426 On Sprint Toggle:
1427 ID: sprint_toggle
1428 Description:
1429 Called when a player starts or stops sprinting. Use is sprinting to get whether the player was sprinting before the event was called.
1430 Examples:
1431 on sprint toggle:
1432 player is not sprinting
1433 send "Run!"
1434 Since:
1435 1.0
1436 Patterns:
1437 [on] [player] toggl(e|ing) sprint
1438 [on] [player] sprint toggl(e|ing)
1439 Event values:
1440 event-world
1441 event-player
1442 Cancellable: true
1443 On Tame:
1444 ID: tame
1445 Description:
1446 Called when a player tames a wolf or ocelot. Can be cancelled to prevent the entity from being tamed.
1447 Since:
1448 1.0
1449 Patterns:
1450 [on] [entity] tam(e|ing)
1451 Event values:
1452 event-entity
1453 event-world
1454 Cancellable: true
1455 On Target:
1456 ID: target
1457 Description:
1458 Called when a mob starts/stops following/attacking another entity, usually a player.
1459 Since:
1460 1.0
1461 Patterns:
1462 [on] [entity] target
1463 [on] [entity] un[-]target
1464 Event values:
1465 event-entity
1466 event-world
1467 Cancellable: true
1468 On Teleport:
1469 ID: teleport
1470 Description:
1471 Called whenever a player is teleported, either by a nether/end portal or other means (e.g. by plugins).
1472 Since:
1473 1.0
1474 Patterns:
1475 [on] [player] teleport[ing]
1476 Event values:
1477 event-world
1478 event-object
1479 event-player
1480 event-block
1481 Cancellable: true
1482 On Throwing of an Egg:
1483 ID: throwing_of_an_egg
1484 Description:
1485 Called when a player throws an egg. You can just use the shoot event in most cases, as this event is intended to support changing the hatched mob and its chance to hatch, but Skript does not yet support that.
1486 Since:
1487 1.0
1488 Patterns:
1489 [on] throw[ing] [of] [an] egg
1490 [on] [player] egg throw
1491 Event values:
1492 event-world
1493 event-player
1494 Cancellable: false
1495 On Tool Change:
1496 ID: tool_change
1497 Description:
1498 Called whenever a player changes his held item by selecting a different slot (e.g. the keys 1-9 or the mouse wheel), not by dropping or replacing the item in the current slot.
1499 Since:
1500 1.0
1501 Patterns:
1502 [on] [player['s]] (tool|item held|held item) chang(e|ing)
1503 Event values:
1504 event-world
1505 event-player
1506 Cancellable: true
1507 On Unzip:
1508 ID: unzip
1509 Patterns:
1510 [on] [skutil[ities] ]unzip
1511 Event values:
1512 event-object
1513 event-string
1514 Cancellable: true
1515 On Vehicle Create:
1516 ID: vehicle_create
1517 Description:
1518 Called when a new vehicle is created, e.g. when a player places a boat or minecart.
1519 Since:
1520 1.0
1521 Patterns:
1522 [on] vehicle create
1523 [on] creat(e|ing|ion of) [a] vehicle
1524 Event values:
1525 event-entity
1526 event-entity
1527 event-world
1528 Cancellable: false
1529 On Vehicle Damage:
1530 ID: vehicle_damage
1531 Description:
1532 Called when a vehicle gets damage. Too much damage will destroy the vehicle.
1533 Since:
1534 1.0
1535 Patterns:
1536 [on] vehicle damage
1537 [on] damag(e|ing) [a] vehicle
1538 Event values:
1539 event-entity
1540 event-entity
1541 event-world
1542 Cancellable: true
1543 On Vehicle Destroy:
1544 ID: vehicle_destroy
1545 Description:
1546 Called when a vehicle is destroyed. Any passenger will be ejected and the vehicle might drop some item(s).
1547 Since:
1548 1.0
1549 Patterns:
1550 [on] vehicle destroy
1551 [on] destr(oy[ing]|uction of) [a] vehicle
1552 Event values:
1553 event-entity
1554 event-entity
1555 event-world
1556 Cancellable: true
1557 On Vehicle Enter:
1558 ID: vehicle_enter
1559 Description:
1560 Called when an entity enters a vehicle, either deliberately (players) or by falling into them (mobs).
1561 Since:
1562 1.0
1563 Patterns:
1564 [on] vehicle enter
1565 [on] enter[ing] [a] vehicle
1566 Event values:
1567 event-entity
1568 event-entity
1569 event-world
1570 Cancellable: true
1571 On Vehicle Exit:
1572 ID: vehicle_exit
1573 Description:
1574 Called when an entity exits a vehicle.
1575 Since:
1576 1.0
1577 Patterns:
1578 [on] vehicle exit
1579 [on] exit[ing] [a] vehicle
1580 Event values:
1581 event-entity
1582 event-livingentity
1583 event-entity
1584 event-world
1585 Cancellable: true
1586 On Weather Change:
1587 ID: weather_change
1588 Description:
1589 Called when a world's weather changes.
1590 Examples:
1591 on weather change
1592 on weather change to sunny
1593 Since:
1594 1.0
1595 Patterns:
1596 [on] weather change [to %weathertypes%]
1597 Event values:
1598 event-world
1599 Cancellable: true
1600 On World Init:
1601 ID: world_init
1602 Description:
1603 Called when a world is initialised. As all default worlds are initialised before any scripts are loaded, this event is only called for newly created worlds.
1604 World management plugins might change the behaviour of this event though.
1605 Since:
1606 1.0
1607 Patterns:
1608 [on] world init[zation)]
1609 Event values:
1610 event-world
1611 Cancellable: false
1612 On World Load:
1613 ID: world_load
1614 Description:
1615 Called when a world is loaded. As with the world init event, this event will not be called for the server's default world(s).
1616 Since:
1617 1.0
1618 Patterns:
1619 [on] world load[ing]
1620 Event values:
1621 event-world
1622 Cancellable: false
1623 On World Save:
1624 ID: world_save
1625 Description:
1626 Called when a world is saved to disk. Usually all worlds are saved simultaneously, but world management plugins could change this.
1627 Since:
1628 1.0
1629 Patterns:
1630 [on] world sav(e|ing)
1631 Event values:
1632 event-world
1633 Cancellable: false
1634 On World Unload:
1635 ID: world_unload
1636 Description:
1637 Called when a world is unloaded. This event might never be called if you don't have a world management plugin.
1638 Since:
1639 1.0
1640 Patterns:
1641 [on] world unload[ing]
1642 Event values:
1643 event-world
1644 Cancellable: true
1645 On Zombie Break Door:
1646 ID: zombie_break_door
1647 Description:
1648 Called when a zombie is done breaking a wooden door. Can be cancelled to prevent the zombie from breaking the door.
1649 Since:
1650 1.0
1651 Patterns:
1652 [on] zombie break[ing] [a] [wood[en]] door
1653 Event values:
1654 event-entity
1655 event-world
1656 event-block
1657 Cancellable: true
1658 Periodical:
1659 ID: periodical
1660 Description:
1661 An event that is called periodically.
1662 Examples:
1663 every 2 seconds
1664 every minecraft hour
1665 every ticks #can cause lag (depends on the code in this trigger)
1666 every minecraft days
1667 Since:
1668 1.0
1669 Patterns:
1670 every %timespan%
1671 Event values:
1672 none
1673 Cancellable: false
1674 Periodical:
1675 ID: periodical
1676 Description:
1677 An event that is called periodically.
1678 Examples:
1679 every 2 seconds in "world"
1680 every minecraft hour in "flatworld"
1681 every ticks in "world" #can cause lag (depends on the code in this trigger)
1682 every minecraft days in "plots"
1683 Since:
1684 1.0
1685 Patterns:
1686 every %timespan% in [world[s]] %worlds%
1687 Event values:
1688 event-world
1689 Cancellable: false
1690Conditions:
1691 Can Hold:
1692 ID: CondCanHold
1693 Description:
1694 Tests whether a player or a chest can hold the given item.
1695 Examples:
1696 block can hold 200 cobblestone
1697 player has enough space for 64 feathers
1698 Since:
1699 1.0
1700 Patterns:
1701 %inventories% (can hold|ha(s|ve) [enough] space (for|to hold)) %itemtypes%
1702 %inventories% (can(no|')t hold|(ha(s|ve) not|ha(s|ve)n't|do[es]n't have) [enough] space (for|to hold)) %itemtypes%
1703 Can See:
1704 ID: CondCanSee
1705 Description:
1706 Checks whether the given players can see another players.
1707 Examples:
1708 if the player can't see the player-argument:
1709 message "<light red>The player %player-argument% is not online!"
1710 Since:
1711 INSERT VERSION
1712 Patterns:
1713 %players% (is|are) [(in)]visible for %players%
1714 %players% can see %players%
1715 %players% (is|are)(n't| not) [(in)]visible for %players%
1716 %players% can('t| not) see %players%
1717 Chance:
1718 ID: CondChance
1719 Description:
1720 A condition that randomly succeeds or fails.
1721 Valid values are between 0% and 100%, or if the percent sign is omitted between 0 and 1.
1722 Examples:
1723 chance of 50%:
1724 drop a diamond
1725 chance of {var}% # {var} between 0 and 100
1726 chance of {var} # {var} between 0 and 1
1727 Since:
1728 1.0
1729 Patterns:
1730 chance of %number%(\%|)
1731 Comparison:
1732 ID: CondCompare
1733 Description:
1734 A very general condition, it simply compares two values. Usually you can only compare for equality (e.g. block is/isn't of <type>), but some values can also be compared using greater than/less than. In that case you can also test for whether an object is between two others.
1735 Note: This is the only element where not all patterns are shown. It has actually another two sets of similar patters, but with (was|were) or will be instead of (is|are) respectively, which check different time states of the first expression.
1736 Examples:
1737 the clicked block is a stone slab or a double stone slab
1738 time in the player's world is greater than 8:00
1739 the creature is not an enderman or an ender dragon
1740 Since:
1741 1.0
1742 Patterns:
1743 (neither|) %objects% ((is|are)(|(n't| not| neither)) ((greater|more|higher|bigger|larger) than|above)|\>) %objects%
1744 (neither|) %objects% ((is|are)(|(n't| not| neither)) (greater|more|higher|bigger|larger|above) [than] or (equal to|the same as)|\>=) %objects%
1745 (neither|) %objects% ((is|are)(|(n't| not| neither)) ((less|smaller) than|below)|\<) %objects%
1746 (neither|) %objects% ((is|are)(|(n't| not| neither)) (less|smaller|below) [than] or (equal to|the same as)|\<=) %objects%
1747 (neither|) %objects% ()((is|are) (not|neither)|isn't|aren't|!=) [equal to] %objects%
1748 (neither|) %objects% (is|are|=) [(equal to|the same as)] %objects%
1749 (neither|) %objects% (is|are) between %objects% and %objects%
1750 (neither|) %objects% ()(is not|are not|isn't|aren't) between %objects% and %objects%
1751 (neither|) %objects@-1% (was|were)(|(n't| not| neither)) ((greater|more|higher|bigger|larger) than|above) %objects%
1752 (neither|) %objects@-1% (was|were)(|(n't| not| neither)) (greater|more|higher|bigger|larger|above) [than] or (equal to|the same as) %objects%
1753 (neither|) %objects@-1% (was|were)(|(n't| not| neither)) ((less|smaller) than|below) %objects%
1754 (neither|) %objects@-1% (was|were)(|(n't| not| neither)) (less|smaller|below) [than] or (equal to|the same as) %objects%
1755 (neither|) %objects@-1% ()((was|were) (not|neither)|wasn't|weren't) [equal to] %objects%
1756 (neither|) %objects@-1% (was|were) [(equal to|the same as)] %objects%
1757 (neither|) %objects@-1% (was|were) between %objects% and %objects%
1758 (neither|) %objects@-1% ()(was not|were not|wasn't|weren't) between %objects% and %objects%
1759 (neither|) %objects@1% (will be|(will (not|neither) be|won't be)) ((greater|more|higher|bigger|larger) than|above) %objects%
1760 (neither|) %objects@1% (will be|(will (not|neither) be|won't be)) (greater|more|higher|bigger|larger|above) [than] or (equal to|the same as) %objects%
1761 (neither|) %objects@1% (will be|(will (not|neither) be|won't be)) ((less|smaller) than|below) %objects%
1762 (neither|) %objects@1% (will be|(will (not|neither) be|won't be)) (less|smaller|below) [than] or (equal to|the same as) %objects%
1763 (neither|) %objects@1% ()((will (not|neither) be|won't be)|(isn't|aren't|is not|are not) (turning|changing) [in]to) [equal to] %objects%
1764 (neither|) %objects@1% (will be [(equal to|the same as)]|(is|are) (turning|changing) [in]to) %objects%
1765 (neither|) %objects@1% will be between %objects% and %objects%
1766 (neither|) %objects@1% ()(will not be|won't be) between %objects% and %objects%
1767 Contains:
1768 ID: CondContains
1769 Description:
1770 Checks whether an inventory contains the given item, a text contains another piece of text, or a list of objects (e.g. a {list variable::*}) contains another object.
1771 Examples:
1772 block contains 20 cobblestone
1773 player has 4 flint and 2 iron ingots
1774 Since:
1775 1.0
1776 Patterns:
1777 %inventories% ha(s|ve) %itemtypes% [in [(the[ir]|his|her|its)] inventory]
1778 %inventories/strings/objects% contain[s] %itemtypes/strings/objects%
1779 %inventories% do[es](n't| not) have %itemtypes% [in [(the[ir]|his|her|its)] inventory]
1780 %inventories/strings/objects% do[es](n't| not) contain %itemtypes/strings/objects%
1781 Damage Cause:
1782 ID: CondDamageCause
1783 Description:
1784 Tests what kind of damage caused a damage event. Refer to the Damage Cause type for a list of all possible causes.
1785 Examples:
1786 # make players use their potions of fire resistance whenever they take any kind of fire damage
1787 on damage:
1788 damage was caused by lava, fire or burning
1789 victim is a player
1790 victim has a potion of fire resistance
1791 cancel event
1792 apply fire resistance to the victim for 30 seconds
1793 remove 1 potion of fire resistance from the victim
1794 # prevent mobs from dropping items under certain circumstances
1795 on death:
1796 entity is not a player
1797 damage wasn't caused by a block explosion, an attack, a projectile, a potion, fire, burning, thorns or poison
1798 clear drops
1799 Since:
1800 2.0
1801 Patterns:
1802 [the] damage (was|is|has)(|n('|o)t) [been] (caused|done|made) by %damagecause%
1803 Event Cancelled:
1804 ID: CondCancelled
1805 Description:
1806 Checks whether or not the event is cancelled
1807 Examples:
1808 on click:
1809 if event is cancelled:
1810 broadcast "no clicks allowed!"
1811 Since:
1812 2.2-dev36
1813 Patterns:
1814 [the] event is cancel[l]ed
1815 [the] event (is not|isn't) cancel[l]ed
1816 Exists/Is Set:
1817 ID: CondIsSet
1818 Description:
1819 Checks whether a given expression or variable is set.
1820 Examples:
1821 {teams::%player's uuid%::preferred-team} is not set
1822 on damage:
1823 projectile exists
1824 broadcast "%attacker% used a %projectile% to attack %victim%!"
1825 Since:
1826 1.2
1827 Patterns:
1828 %~objects% (exist[s]|(is|are) set)
1829 %~objects% (do[es](n't| not) exist|(is|are)(n't| not) set)
1830 Has Metadata:
1831 ID: CondHasMetadata
1832 Description:
1833 Checks whether a metadata holder has a metadata tag.
1834 Examples:
1835 if player has metadata value "healer":
1836 Since:
1837 2.2-dev36
1838 Patterns:
1839 %metadataholders% (has|have) metadata [(value|tag)[s]] %strings%
1840 %metadataholders% (doesn't|does not|do not|don't) have metadata [(value|tag)[s]] %strings%
1841 Has Permission:
1842 ID: CondPermission
1843 Description:
1844 Test whether a player has a certain permission.
1845 Examples:
1846 player has permission "skript.tree"
1847 victim has the permission "admin":
1848 send "You're attacking an admin!" to attacker
1849 Since:
1850 1.0
1851 Patterns:
1852 [%commandsenders%] (do[es]n't|don't|do[es] not) have [the] permission[s] %strings%
1853 [%commandsenders%] ha(s|ve) [the] permission[s] %strings%
1854 Has Played Before:
1855 ID: CondPlayedBefore
1856 Description:
1857 Checks whether a player has played on this server before. You can also use on first join if you want to make triggers for new players.
1858 Examples:
1859 player has played on this server before
1860 player hasn't played before
1861 Since:
1862 1.4
1863 Patterns:
1864 %offlineplayer% [(has|did)] [already] play[ed] [on (this|the) server] (before|already)
1865 %offlineplayer% (has not|hasn't|did not|didn't) [(already|yet)] play[ed] [on (this|the) server] (before|already|yet)
1866 Is Alive:
1867 ID: CondIsAlive
1868 Description:
1869 Checks whether an entity is alive. This is mostly useful to check whether an entity stored in a variable does still exist.
1870 Examples:
1871 {villager-buddy::%player's uuid%} is dead
1872 Since:
1873 2.0
1874 Patterns:
1875 %livingentities% (is|are) (alive|dead)
1876 %livingentities% (isn't|is not|aren't|are not) (alive|dead)
1877 Is Banned:
1878 ID: CondIsBanned
1879 Description:
1880 Checks whether a player or IP is banned.
1881 Examples:
1882 player is banned
1883 victim is not IP-banned
1884 "127.0.0.1" is banned
1885 Since:
1886 1.4
1887 Patterns:
1888 %offlineplayers/strings% (is|are) banned
1889 %players/strings% (is|are) IP(-| |)banned
1890 %offlineplayers/strings% (isn't|is not|aren't|are not) banned
1891 %players/strings% (isn't|is not|aren't|are not) IP(-| |)banned
1892 Is Blocking:
1893 ID: CondIsBlocking
1894 Description:
1895 Checks whether a player is blocking with his shield.
1896 Examples:
1897 on damage of player:
1898 victim is blocking
1899 damage attacker by 0.5 hearts
1900 Since:
1901 <i>unknown</i> (before 2.1)
1902 Patterns:
1903 %players% (is|are) (blocking|defending)
1904 %players% (isn't|is not|aren't|are not) (blocking|defending)
1905 Is Burning:
1906 ID: CondIsBurning
1907 Description:
1908 Checks whether an entity is on fire, e.g. a zombie due to being in sunlight, or any entity after falling into lava.
1909 Examples:
1910 # increased attack against burning targets
1911 victim is burning:
1912 increase damage by 2
1913 Since:
1914 1.4.4
1915 Patterns:
1916 %entities% (is|are) (burning|ignited|on fire)
1917 %entities% (isn't|is not|aren't|are not) (burning|ignited|on fire)
1918 Is Edible:
1919 ID: CondIsEdible
1920 Description:
1921 Checks whether an item is edible.
1922 Examples:
1923 steak is edible
1924 player's tool is edible
1925 Since:
1926 2.2-dev36
1927 Patterns:
1928 %itemstacks% (is|are) edible
1929 %itemstacks% (isn't|is not|aren't|are not) edible
1930 Is Empty:
1931 ID: CondIsEmpty
1932 Description:
1933 Checks whether an inventory, an inventory slot, or a text is empty.
1934 Examples:
1935 player's inventory is empty
1936 Since:
1937 <i>unknown</i> (before 2.1)
1938 Patterns:
1939 %inventories/slots/strings% (is|are) empty
1940 %inventories/slots/strings% (isn't|is not|aren't|are not) empty
1941 Is Enchanted:
1942 ID: CondIsEnchanted
1943 Description:
1944 Checks whether an item is enchanted.
1945 Examples:
1946 tool of the player is enchanted with efficiency 2
1947 helm, chestplate, leggings or boots are enchanted
1948 Since:
1949 1.4.6
1950 Patterns:
1951 %itemtypes% (is|are) enchanted [with %-enchantmenttype%]
1952 %itemtypes% (isn't|is not|aren't|are not) enchanted [with %-enchantmenttype%]
1953 Is Flammable:
1954 ID: CondIsFlammable
1955 Description:
1956 Checks whether an item is flammable.
1957 Examples:
1958 wood is flammable
1959 player's tool is flammable
1960 Since:
1961 2.2-dev36
1962 Patterns:
1963 %itemstacks% (is|are) flammable
1964 %itemstacks% (isn't|is not|aren't|are not) flammable
1965 Is Flying:
1966 ID: CondIsFlying
1967 Description:
1968 Checks whether a player is flying.
1969 Examples:
1970 player is not flying
1971 Since:
1972 1.4.4
1973 Patterns:
1974 %players% (is|are) flying
1975 %players% (isn't|is not|aren't|are not) flying
1976 Is Holding:
1977 ID: CondItemInHand
1978 Description:
1979 Checks whether a player is holding a specific item. Cannot be used with endermen, use 'entity is [not] an enderman holding <item type>' instead.
1980 Examples:
1981 player is holding a stick
1982 victim isn't holding a sword of sharpness
1983 Since:
1984 1.0
1985 Patterns:
1986 [%livingentities%] ha(s|ve) %itemtypes% in hand
1987 [%livingentities%] (is|are) holding %itemtypes% in hand
1988 [%livingentities%] (ha(s|ve) not|do[es]n't have) %itemtypes%
1989 [%livingentities%] (is not|isn't) holding %itemtypes%
1990 Is Loaded:
1991 ID: CondIsLoaded
1992 Description:
1993 Checks whether or not a chunk/world is loaded
1994 Examples:
1995 if chunk at {home::%player's uuid%} is loaded:
1996 Since:
1997 2.2-dev37
1998 Patterns:
1999 %worlds/chunks% (is|are) loaded
2000 %worlds/chunks% (isn't|is not|aren't|are not) loaded
2001 Is Online:
2002 ID: CondIsOnline
2003 Description:
2004 Checks whether a player is online.
2005 Examples:
2006 player is online
2007 player-argument is offline
2008 Since:
2009 1.4
2010 Patterns:
2011 %offlineplayers% ((is|are) online|(is not|isn't|are not|aren't) offline)
2012 %offlineplayers% ((is|are) offline|(is not|isn't|are not|aren't) online)
2013 Is Poisoned:
2014 ID: CondIsPoisoned
2015 Description:
2016 Checks whether an entity is poisoned.
2017 Examples:
2018 player is poisoned:
2019 cure the player from poison
2020 message "You have been cured!"
2021 Since:
2022 1.4.4
2023 Patterns:
2024 %livingentities% (is|are) poisoned
2025 %livingentities% (isn't|is not|aren't|are not) poisoned
2026 Is Riding:
2027 ID: CondIsRiding
2028 Description:
2029 Tests whether an entity is riding another or is in a vehicle.
2030 Examples:
2031 player is riding a saddled pig
2032 Since:
2033 2.0
2034 Patterns:
2035 %entities% (is|are) riding [%entitydatas%]
2036 %entities% (isn't|is not|aren't|are not) riding [%entitydatas%]
2037 Is Script Loaded:
2038 ID: CondScriptLoaded
2039 Description:
2040 Check if the current script or another script, is current loaded.
2041 Examples:
2042 script is loaded
2043 script "example.sk" is loaded
2044 Since:
2045 2.2-dev31
2046 Patterns:
2047 script[s] [%-strings%] (is|are) loaded
2048 script[s] [%-strings%] (isn't|is not|aren't|are not) loaded
2049 Is Sleeping:
2050 ID: CondIsSleeping
2051 Description:
2052 Checks whether a player is sleeping.
2053 Examples:
2054 # cut your enemies' throats in their sleep >=)
2055 on attack:
2056 attacker is holding a sword
2057 victim is sleeping
2058 increase the damage by 1000
2059 Since:
2060 1.4.4
2061 Patterns:
2062 %players% (is|are) sleeping
2063 %players% (isn't|is not|aren't|are not) sleeping
2064 Is Sneaking:
2065 ID: CondIsSneaking
2066 Description:
2067 Checks whether a player is sneaking.
2068 Examples:
2069 # prevent mobs from seeing sneaking players if they are at least 4 meters apart
2070 on target:
2071 target is sneaking
2072 distance of target and the entity is bigger than 4
2073 cancel the event
2074 Since:
2075 1.4.4
2076 Patterns:
2077 %players% (is|are) sneaking
2078 %players% (isn't|is not|aren't|are not) sneaking
2079 Is Solid:
2080 ID: CondIsSolid
2081 Description:
2082 Checks whether an item is solid.
2083 Examples:
2084 grass block is solid
2085 player's tool isn't solid
2086 Since:
2087 2.2-dev36
2088 Patterns:
2089 %itemstacks% (is|are) solid
2090 %itemstacks% (isn't|is not|aren't|are not) solid
2091 Is Sprinting:
2092 ID: CondIsSprinting
2093 Description:
2094 Checks whether a player is sprinting.
2095 Examples:
2096 player is not sprinting
2097 Since:
2098 1.4.4
2099 Patterns:
2100 %players% (is|are) sprinting
2101 %players% (isn't|is not|aren't|are not) sprinting
2102 Is Transparent:
2103 ID: CondIsTransparent
2104 Description:
2105 Checks whether an item is transparent.
2106 Examples:
2107 glass is transparent
2108 player's tool is transparent.
2109 Since:
2110 2.2-dev36
2111 Patterns:
2112 %itemstacks% (is|are) transparent
2113 %itemstacks% (isn't|is not|aren't|are not) transparent
2114 Is Wearing:
2115 ID: CondIsWearing
2116 Description:
2117 Checks whether a player is wearing some armour.
2118 Examples:
2119 player is wearing an iron chestplate and iron leggings
2120 player is wearing all diamond armour
2121 Since:
2122 1.0
2123 Patterns:
2124 %livingentities% (is|are) wearing %itemtypes%
2125 %livingentities% (isn't|is not|aren't|are not) wearing %itemtypes%
2126 Is in World:
2127 ID: CondIsInWorld
2128 Description:
2129 Checks whether an entity is in a specific world.
2130 Examples:
2131 player is in "world"
2132 argument isn't in world "world_nether"
2133 the player is in the world of the victim
2134 Since:
2135 1.4
2136 Patterns:
2137 %entities% (is|are) in [[the] world[s]] %worlds%
2138 %entities% (is not|isn't|are not|aren't) in [[the] world[s]] %worlds%
2139 Is of Type:
2140 ID: CondIsOfType
2141 Description:
2142 Checks whether an item of entity is of the given type. This is mostly useful for variables, as you can use the general 'is' condition otherwise (e.g. 'victim is a creeper').
2143 Examples:
2144 tool is of type {*selected type}
2145 victim is of type {villager type}
2146 Since:
2147 1.4
2148 Patterns:
2149 %itemstacks/entities% (is|are) of type[s] %itemtypes/entitydatas%
2150 %itemstacks/entities% (isn't|is not|aren't|are not) of type[s] %itemtypes/entitydatas%
2151 Is on Ground:
2152 ID: CondIsOnGround
2153 Description:
2154 Checks whether an entity is on ground.
2155 Examples:
2156 player is not on ground
2157 Since:
2158 2.2-dev26
2159 Patterns:
2160 %entities% (is|are) on ground
2161 %entities% (isn't|is not|aren't|are not) on ground
2162 PvP:
2163 ID: CondPvP
2164 Description:
2165 Checks the PvP state of a world.
2166 Examples:
2167 PvP is enabled
2168 PvP is disabled in "world"
2169 Since:
2170 1.3.4
2171 Patterns:
2172 (is PvP|PvP is) enabled [in %worlds%]
2173 (is PvP|PvP is) disabled [in %worlds%]
2174 Starts/Ends With:
2175 ID: CondStartsWith
2176 Description:
2177 Checks if a text starts or ends with another.
2178 Examples:
2179 if the argument starts with "test":
2180 send "Stop!"
2181 Since:
2182 2.2-dev36
2183 Patterns:
2184 %strings% (start|end)[s] with %string%
2185 %strings% do[es](n't| not) (start|end) with %string%
2186 Time:
2187 ID: CondDate
2188 Description:
2189 Tests whether a given real time was more or less than some time span ago.
2190 Examples:
2191 command /command-with-cooldown:
2192 trigger:
2193 {command::%player's uuid%::last-usage} was less than a minute ago:
2194 message "Please wait a minute between uses of this command."
2195 stop
2196 set {command::%player's uuid%::last-usage} to now
2197 # ... actual command trigger here ...
2198 Since:
2199 2.0
2200 Patterns:
2201 %date% (was|were)( more|(n't| not) less) than %timespan% [ago]
2202 %date% (was|were)((n't| not) more| less) than %timespan% [ago]
2203 Weather:
2204 ID: CondWeather
2205 Description:
2206 Checks whether the weather in a world is of a specific type.
2207 I welcome any ideas how to write this condition differently.
2208 Examples:
2209 is thundering
2210 is raining in "world" or "world2"
2211 Since:
2212 1.0
2213 Patterns:
2214 is %weathertypes% [in %worlds%]
2215Effects:
2216 Ban:
2217 ID: EffBan
2218 Description:
2219 Bans/unbans a player or IP.
2220 Starting with Skript 2.1.1 and Bukkit 1.7.2 R0.4, one can also ban players with a reason.
2221 Examples:
2222 unban player
2223 ban "127.0.0.1"
2224 IP-ban the player because "he is an idiot"
2225 Since:
2226 1.4, 2.1.1 (ban reason)
2227 Patterns:
2228 ban %strings/offlineplayers% [(by reason of|because [of]|on account of|due to) %-string%]
2229 unban %strings/offlineplayers%
2230 ban %players% by IP [(by reason of|because [of]|on account of|due to) %-string%]
2231 unban %players% by IP
2232 IP(-| )ban %players% [(by reason of|because [of]|on account of|due to) %-string%]
2233 (IP(-| )unban|un[-]IP[-]ban) %players%
2234 Broadcast:
2235 ID: EffBroadcast
2236 Description:
2237 Broadcasts a message to the server.
2238 Examples:
2239 broadcast "Welcome %player% to the server!"
2240 broadcast "Woah! It's a message!"
2241 Since:
2242 1.0
2243 Patterns:
2244 broadcast %strings% [(to|in) %-worlds%]
2245 Cancel Command Cooldown:
2246 ID: EffCancelCooldown
2247 Description:
2248 Only usable in command events. Makes it so the current command usage isn't counted towards the cooldown.
2249 Examples:
2250 command /nick <text>:
2251 executable by: players
2252 cooldown: 10 seconds
2253 trigger:
2254 if length of arg-1 is more than 16:
2255 # Makes it so that invalid arguments don't make you wait for the cooldown again
2256 cancel the cooldown
2257 send "Your nickname may be at most 16 characters."
2258 stop
2259 set the player's display name to arg-1
2260 Since:
2261 2.2-dev34
2262 Patterns:
2263 (cancel|ignore) [the] [current] [command] cooldown
2264 un(cancel|ignore) [the] [current] [command] cooldown
2265 Cancel Event:
2266 ID: EffCancelEvent
2267 Description:
2268 Cancels the event (e.g. prevent blocks from being placed, or damage being taken).
2269 Examples:
2270 on damage:
2271 victim is a player
2272 victim has the permission "skript.god"
2273 cancel the event
2274 Since:
2275 1.0
2276 Patterns:
2277 cancel [the] event
2278 uncancel [the] event
2279 Change: Set/Add/Remove/Delete/Reset:
2280 ID: EffChange
2281 Description:
2282 A very general effect that can change many expressions. Many expressions can only be set and/or deleted, while some can have things added to or removed from them.
2283 Examples:
2284 # set:
2285 Set the player's display name to "<red>%name of player%"
2286 set the block above the victim to lava
2287 # add:
2288 add 2 to the player's health # preferably use '<a href='#heal'>heal</a>' for this
2289 add argument to {blacklist::*}
2290 give a diamond pickaxe of efficiency 5 to the player
2291 increase the data value of the clicked block by 1
2292 # remove:
2293 remove 2 pickaxes from the victim
2294 subtract 2.5 from {points.%player%}
2295 # remove all:
2296 remove every iron tool from the player
2297 remove all minecarts from {entitylist::*}
2298 # delete:
2299 delete the block below the player
2300 clear drops
2301 delete {variable}
2302 # reset:
2303 reset walk speed of player
2304 reset chunk at the targeted block
2305 Since:
2306 1.0 (set, add, remove, delete), 2.0 (remove all)
2307 Patterns:
2308 (add|give) %objects% to %~objects%
2309 increase %~objects% by %objects%
2310 give %~objects% %objects%
2311 set %~objects% to %objects%
2312 remove (all|every) %objects% from %~objects%
2313 (remove|subtract) %objects% from %~objects%
2314 reduce %~objects% by %objects%
2315 (delete|clear) %~objects%
2316 reset %~objects%
2317 Colour Items:
2318 ID: EffColorArmor
2319 Description:
2320 Colours items in a given colour. You can also use RGB codes if you feel limited with the 16 default colours. RGB codes are three numbers from 0 to 255 in the order (red, green, blue), where (0,0,0) is black and (255,255,255) is white. Armor is colourable for all Minecraft versions. With Minecraft 1.11 or newer you can also colour potions and maps. Note that the colours might not look exactly how you'd expect.
2321 Examples:
2322 dye player's helmet blue
2323 colour the player's tool red
2324 Since:
2325 2.0, 2.2-dev26 (maps and potions)
2326 Patterns:
2327 (dye|colo[u]r|paint) %slots/itemstack% %color%
2328 (dye|colo[u]r|paint) %slots/itemstack% (%number%, %number%, %number%)
2329 Command:
2330 ID: EffCommand
2331 Description:
2332 Executes a command. This can be useful to use other plugins in triggers.
2333 Examples:
2334 make player execute command "/suicide"
2335 execute console command "/say Hello everyone!"
2336 Since:
2337 1.0
2338 Patterns:
2339 [execute] [the] command %strings% [by %-commandsenders%]
2340 [execute] [the] %commandsenders% command %strings%
2341 (let|make) %commandsenders% execute [[the] command] %strings%
2342 Continue:
2343 ID: EffContinue
2344 Description:
2345 Skips the value currently being looped, moving on to the next value if it exists.
2346 Examples:
2347 loop all players:
2348 if loop-value does not have permission "moderator":
2349 continue # filter out non moderators
2350 broadcast "%loop-player% is a moderator!" # only moderators get broadcast
2351 Since:
2352 2.2-dev37
2353 Patterns:
2354 continue [loop]
2355 Damage/Heal/Repair:
2356 ID: EffHealth
2357 Description:
2358 Damage/Heal/Repair an entity, or item stack.
2359 Examples:
2360 damage player by 5 hearts
2361 heal the player
2362 repair tool of player
2363 Since:
2364 1.0
2365 Patterns:
2366 damage %slots/livingentities/itemstack% by %number% [heart[s]][ with fake cause %-damagecause%]
2367 heal %livingentities% [by %-number% [heart[s]]]
2368 repair %slots/itemstack% [by %-number%]
2369 Delay:
2370 ID: Delay
2371 Description:
2372 Delays the script's execution by a given timespan. Please note that delays are not persistent, e.g. trying to create a tempban script with ban player → wait 7 days → unban player will not work if you restart your server anytime within these 7 days. You also have to be careful even when using small delays!
2373 Examples:
2374 wait 2 minutes
2375 halt for 5 minecraft hours
2376 wait a tick
2377 Since:
2378 1.4
2379 Patterns:
2380 (wait|halt) [for] %timespan%
2381 Drop:
2382 ID: EffDrop
2383 Description:
2384 Drops one or more items.
2385 Examples:
2386 on death of creeper:
2387 drop 1 TNT
2388 Since:
2389 1.0
2390 Patterns:
2391 drop %itemtypes/experience% [%directions% %locations%]
2392 drop %itemtypes/experience% [%directions% %locations%] without velocity
2393 Enchant/Disenchant:
2394 ID: EffEnchant
2395 Description:
2396 Enchant or disenchant an existing item
2397 Examples:
2398 enchant the player's tool with sharpness 5
2399 disenchant the player's tool
2400 Since:
2401 2.0
2402 Patterns:
2403 enchant %~itemstack% with %enchantmenttypes%
2404 disenchant %~itemstack%
2405 Equip:
2406 ID: EffEquip
2407 Description:
2408 Equips a player with some given armor. This will replace any armor that the player is wearing.
2409 Examples:
2410 equip player with diamond helmet
2411 equip player with all diamond armor
2412 Since:
2413 1.0
2414 Patterns:
2415 equip [%livingentity%] with %itemtypes%
2416 make %livingentity% wear %itemtypes%
2417 Exit:
2418 ID: EffExit
2419 Description:
2420 Exits a given amount of loops and conditionals, or the entire trigger.
2421 Examples:
2422 if player has any ore:
2423 stop
2424 message "%player% has no ores!"
2425 loop blocks above the player:
2426 loop-block is not air:
2427 exit 2 sections
2428 set loop-block to water
2429 Since:
2430 <i>unknown</i> (before 2.1)
2431 Patterns:
2432 (exit|stop) [trigger]
2433 (exit|stop) [(1|a|the|this)] (section|loop|conditional)
2434 (exit|stop) <\d+> (section|loop|conditional)s
2435 (exit|stop) all (section|loop|conditional)s
2436 Explosion:
2437 ID: EffExplosion
2438 Description:
2439 Creates an explosion of a given force. The Minecraft Wiki has an article on explosions which lists the explosion forces of TNT, creepers, etc.
2440 Hint: use a force of 0 to create a fake explosion that does no damage whatsoever, or use the explosion effect introduced in Skript 2.0.
2441 Starting with Bukkit 1.4.5 and Skript 2.0 you can use safe explosions which will damage entities but won't destroy any blocks.
2442 Examples:
2443 create an explosion of force 10 at the player
2444 create an explosion of force 0 at the victim
2445 Since:
2446 1.0
2447 Patterns:
2448 [(create|make)] [an] explosion (of|with) (force|strength|power) %number% [%directions% %locations%]
2449 [(create|make)] [a] safe explosion (of|with) (force|strength|power) %number% [%directions% %locations%]
2450 [(create|make)] [a] fake explosion [%directions% %locations%]
2451 [(create|make)] [an] explosion[ ]effect [%directions% %locations%]
2452 Feed:
2453 ID: EffFeed
2454 Description:
2455 Feeds the specified players.
2456 Examples:
2457 feed all players
2458 feed the player by 5 beefs
2459 Since:
2460 2.2-dev34
2461 Patterns:
2462 feed [the] %players% [by %-number% [beef[s]]]
2463 Force Respawn:
2464 ID: EffRespawn
2465 Description:
2466 Forces player(s) to respawn if they are dead. If this is called without delay from death event, one tick is waited before respawn attempt.
2467 Examples:
2468 on death of player:
2469 force event-player to respawn
2470 Since:
2471 2.2-dev21
2472 Patterns:
2473 force %players% to respawn
2474 Ignite/Extinguish:
2475 ID: EffIgnite
2476 Description:
2477 Lights entities on fire or extinguishes them.
2478 Examples:
2479 ignite the player
2480 extinguish the player
2481 Since:
2482 1.4
2483 Patterns:
2484 (ignite|set fire to) %entities% [for %-timespan%]
2485 (set|light) %entities% on fire [for %-timespan%]
2486 extinguish %entities%
2487 Kick:
2488 ID: EffKick
2489 Description:
2490 Kicks a player from the server.
2491 Examples:
2492 on place of TNT, lava, or obsidian:
2493 kick the player due to "You may not place %block%!"
2494 cancel the event
2495 Since:
2496 1.0
2497 Patterns:
2498 kick %players% [(by reason of|because [of]|on account of|due to) %-string%]
2499 Kill:
2500 ID: EffKill
2501 Description:
2502 Kills an entity.
2503 Note: This effect does not set the entitie's health to 0 (which causes issues), but damages the entity by 100 times its maximum health.
2504 Examples:
2505 kill the player
2506 kill all creepers in the player's world
2507 kill all endermen, witches and bats
2508 Since:
2509 1.0
2510 Patterns:
2511 kill %entities%
2512 Lightning:
2513 ID: EffLightning
2514 Description:
2515 Strike lightning at a given location. Can use 'ligning effect' to create a lightning that does not harm entities or start fires.
2516 Examples:
2517 strike lightning at the player
2518 strike lightning effect at the victim
2519 Since:
2520 1.4
2521 Patterns:
2522 (create|strike) lightning([ ]effect|) %directions% %locations%
2523 Log:
2524 ID: EffLog
2525 Description:
2526 Writes text into a .log file. Skript will write these files to /plugins/Skript/logs.
2527 NB: Using 'server.log' as the log file will write to the default server log. Omitting the log file altogether will log the message as '[Skript] [<script>.sk] <message>' in the server log.
2528 Examples:
2529 on place of TNT:
2530 log "%player% placed TNT in %world% at %location of block%" to "tnt/placement.log"
2531 Since:
2532 2.0
2533 Patterns:
2534 log %strings% [(to|in) [file[s]] %-strings%]
2535 Loop Version:
2536 ID: EffScriptOptionLoops
2537 Description:
2538 Changes loops to emulate given Skript version's behaviour.
2539 Examples:
2540 use old loops
2541 use new loops
2542 Since:
2543 <i>unknown</i> (2.2)
2544 Patterns:
2545 use[s] (old|new|2.1.2|2.2) loops
2546 Make Fly:
2547 ID: EffMakeFly
2548 Description:
2549 Forces a player to start/stop flying.
2550 Be aware that this also changes the flight mode of the player.
2551 Examples:
2552 make player fly
2553 force all players to stop flying
2554 Since:
2555 2.2-dev34
2556 Patterns:
2557 force %players% to [(start|stop)] fly[ing]
2558 make %players% (start|stop) flying
2559 make %players% fly
2560 Make Say:
2561 ID: EffMakeSay
2562 Description:
2563 Forces a player to send a message to the chat. If the message starts with a slash it will force the player to use command.
2564 Examples:
2565 make the player say "Hello."
2566 force all players to send the message "I love this server"
2567 Since:
2568 INSERT VERSION
2569 Patterns:
2570 make %players% (say|send [the] message[s]) %strings%
2571 force %players% to (say|send [the] message[s]) %strings%
2572 Message:
2573 ID: EffMessage
2574 Description:
2575 Sends a message to the given player.
2576 Examples:
2577 message "A wild %player% appeared!"
2578 message "This message is a distraction. Mwahaha!"
2579 send "Your kill streak is %{kill streak.%player%}%." to player
2580 if the targeted entity exists:
2581 message "You're currently looking at a %type of the targeted entity%!"
2582 Since:
2583 1.0, 2.2-dev26 (advanced features)
2584 Patterns:
2585 (message|send [message[s]]) %strings% [to %commandsenders%]
2586 Open/Close Inventory:
2587 ID: EffOpenInventory
2588 Description:
2589 Opens an inventory to a player. The player can then access and modify the inventory as if it was a chest that he just opened.
2590 Please note that currently 'show' and 'open' have the same effect, but 'show' will eventually show an unmodifiable view of the inventory in the future.
2591 Examples:
2592 show the victim's inventory to the player
2593 open the player's inventory for the player
2594 Since:
2595 2.0, 2.1.1 (closing), 2.2-Fixes-V10 (anvil)
2596 Patterns:
2597 (open|show) (((crafting [table]|workbench)|chest|anvil) (view|window|inventory|)|%-inventory%) (to|for) %players%
2598 close [the] inventory [view] (to|of|for) %players%
2599 close %players%'[s] inventory [view]
2600 Play Effect:
2601 ID: EffVisualEffect
2602 Description:
2603 Plays a visual effect at a given location or on a given entity.
2604 Please note that some effects can only be played on entities, e..g wolf hearts or the hurt effect, and that these are always visible to all players.
2605 Examples:
2606 play wolf hearts on the clicked wolf
2607 show mob spawner flames at the targeted block to the player
2608 Since:
2609 2.1
2610 Patterns:
2611 (play|show) %visualeffects% (on|%directions%) %entities/locations% [(to %-players%|in (radius|range) of %number%)]
2612 (play|show) %number% %visualeffects% (on|%directions%) %locations% [(to %-players%|in (radius|range) of %number%)]
2613 Play Sound:
2614 ID: EffPlaySound
2615 Description:
2616 Plays a sound at given location for everyone or just for given players. Playing sounds from resource packs is supported.
2617 Since:
2618 2.2-dev28
2619 Patterns:
2620 play sound %string% [with volume %number%] [(and|with) pitch %number%] at %location% [for %players%]
2621 Player Visibility:
2622 ID: EffPlayerVisibility
2623 Since:
2624 INSERT VERSION
2625 Patterns:
2626 hide %players% [(from|for) %-players%]
2627 reveal %players% [(to|for|from) %-players%]
2628 Poison/Cure:
2629 ID: EffPoison
2630 Description:
2631 Poison or cure a creature.
2632 Examples:
2633 poison the player
2634 poison the victim for 20 seconds
2635 cure the player from poison
2636 Since:
2637 1.3.2
2638 Patterns:
2639 poison %livingentities% [for %-timespan%]
2640 (cure|unpoison) %livingentities% [(from|of) poison]
2641 Potion Effects:
2642 ID: EffPotion
2643 Description:
2644 Apply or remove potion effects to/from entities.
2645 Examples:
2646 apply swiftness 2 to the player
2647 remove haste from the victim
2648 on join:
2649 apply potion of strength of tier {strength.%player%} to the player for 999 days
2650 Since:
2651 2.0, 2.2-dev27 (ambient and particle-less potion effects)
2652 Patterns:
2653 apply [potion of] %potioneffecttypes% [potion] [[[of] tier] %-number%] to %livingentities% [for %-timespan%]
2654 apply ambient [potion of] %potioneffecttypes% [potion] [[[of] tier] %-number%] to %livingentities% [for %-timespan%]
2655 apply [potion of] %potioneffecttypes% [potion] [[[of] tier] %-number%] without [any] particles to %livingentities% [for %-timespan%]
2656 Push:
2657 ID: EffPush
2658 Description:
2659 Push entities around.
2660 Examples:
2661 push the player upwards
2662 push the victim downwards at speed 0.5
2663 Since:
2664 1.4.6
2665 Patterns:
2666 (push|thrust) %entities% %direction% [(at|with) (speed|velocity|force) %-number%]
2667 PvP:
2668 ID: EffPvP
2669 Description:
2670 Set the PvP state for a given world.
2671 Examples:
2672 enable PvP #(current world only)
2673 disable PvP in all worlds
2674 Since:
2675 1.3.4
2676 Patterns:
2677 enable PvP [in %worlds%]
2678 disable PVP [in %worlds%]
2679 Replace:
2680 ID: EffReplace
2681 Description:
2682 Replaces all occurrences of a given text with another text. Please note that you can only change variables and a few expressions, e.g. a message or a line of a sign.
2683 Starting with 2.2-dev24, you can replace items in a inventory too.
2684 Examples:
2685 replace "<item>" in {textvar} with "%item%"
2686 replace every "&" with "§" in line 1
2687 # The following acts as a simple chat censor, but it will e.g. censor mass, hassle, assassin, etc. as well:
2688 on chat:
2689 replace all "fuck", "bitch" and "ass" with "****" in the message
2690
2691 replace all stone and dirt in player's inventory and player's top inventory with diamond
2692 Since:
2693 2.0, 2.2-dev24 (replace in muliple strings and replace items in inventory)
2694 Patterns:
2695 replace (all|every|) %strings% in %strings% with %string%
2696 replace (all|every|) %strings% with %string% in %strings%
2697 replace (all|every|) %itemstacks% in %inventories% with %itemstack%
2698 replace (all|every|) %itemstacks% with %itemstack% in %inventories%
2699 Return:
2700 ID: EffReturn
2701 Description:
2702 Makes a function return a value
2703 Examples:
2704 function double(i: number) :: number:
2705 return 2 * {_i}
2706 Since:
2707 2.2
2708 Patterns:
2709 return %objects%
2710 Send Block Change:
2711 ID: EffSendBlockChange
2712 Description:
2713 Makes a player see a block as something it really isn't
2714 Examples:
2715 make player see block at player as dirt
2716 Since:
2717 2.2-dev37
2718 Patterns:
2719 make %players% see %blocks% as %itemtype%
2720 Shear:
2721 ID: EffShear
2722 Description:
2723 Shears or 'un-shears' a sheep. Please note that no wool is dropped, this only sets the 'sheared' state of the sheep.
2724 Examples:
2725 on rightclick on a sheep holding a sword:
2726 shear the clicked sheep
2727 Since:
2728 2.0
2729 Patterns:
2730 shear %livingentities%
2731 un[-]shear %livingentities%
2732 Shoot:
2733 ID: EffShoot
2734 Description:
2735 Shoots a projectile (or any other entity) from a given entity.
2736 Examples:
2737 shoot an arrow
2738 make the player shoot a creeper at speed 10
2739 shoot a pig from the creeper
2740 Since:
2741 1.4
2742 Patterns:
2743 shoot %entitydatas% [from %livingentities/locations%] [(at|with) (speed|velocity) %-number%] [%-direction%]
2744 (make|let) %livingentities/locations% shoot %entitydatas% [(at|with) (speed|velocity) %-number%] [%-direction%]
2745 Spawn:
2746 ID: EffSpawn
2747 Description:
2748 Spawn a creature.
2749 Examples:
2750 spawn 3 creepers at the targeted block
2751 spawn a ghast 5 meters above the player
2752 Since:
2753 1.0
2754 Patterns:
2755 spawn %entitytypes% [%directions% %locations%]
2756 spawn %number% of %entitytypes% [%directions% %locations%]
2757 Teleport:
2758 ID: EffTeleport
2759 Description:
2760 Teleport an entity to a specific location.
2761 Examples:
2762 teleport the player to {homes.%player%}
2763 teleport the attacker to the victim
2764 Since:
2765 1.0
2766 Patterns:
2767 teleport %entities% (to|%direction%) %location%
2768 Toggle:
2769 ID: EffToggle
2770 Description:
2771 Toggle the state of a block.
2772 Examples:
2773 # use arrows to toggle switches, doors, etc.
2774 on projectile hit:
2775 projectile is arrow
2776 toggle the block at the arrow
2777 Since:
2778 1.4
2779 Patterns:
2780 (close|turn off|de[-]activate) %blocks%
2781 (toggle|switch) [[the] state of] %blocks%
2782 (open|turn on|activate) %blocks%
2783 Tree:
2784 ID: EffTree
2785 Description:
2786 Creates a tree.
2787 This may require that there is enough space above the given location and that the block below is dirt/grass, but it is possible that the tree will just grow anyways, possibly replacing every block in its path.
2788 Examples:
2789 grow a tall redwood tree above the clicked block
2790 Since:
2791 1.0
2792 Patterns:
2793 (grow|create|generate) tree [of type %structuretype%] %directions% %locations%
2794 (grow|create|generate) %structuretype% [tree] %directions% %locations%
2795 Vectors - Rotate around XYZ:
2796 ID: EffVectorRotateXYZ
2797 Description:
2798 Rotates a vector around x, y, or z axis by some degrees
2799 Examples:
2800 rotate {_v} around x-axis by 90
2801 rotate {_v} around y-axis by 90
2802 rotate {_v} around z-axis by 90
2803 Since:
2804 2.2-dev28
2805 Patterns:
2806 rotate %vectors% around (x|y|z)(-| )axis by %number% [degrees]
2807 Vectors - Rotate around vector:
2808 ID: EffVectorRotateAroundAnother
2809 Description:
2810 Rotates a vector around another vector
2811 Examples:
2812 rotate {_v} around vector 1, 0, 0 by 90
2813 Since:
2814 2.2-dev28
2815 Patterns:
2816 rotate %vectors% around %vector% by %number% [degrees]
2817 Vehicle:
2818 ID: EffVehicle
2819 Description:
2820 Makes an entity ride another entity, e.g. a minecart, a saddled pig, an arrow, etc.
2821 Examples:
2822 make the player ride a saddled pig
2823 make the attacker ride the victim
2824 Since:
2825 2.0
2826 Patterns:
2827 (make|let|force) %entities% [to] (ride|mount) [(in|on)] %entity/entitydatas%
2828 (make|let|force) %entities% [to] (dismount|(dismount|leave) (from|of|) (any|the[ir]|his|her|) vehicle[s])
2829 (eject|dismount) (any|the|) passenger[s] (of|from) %entities%
2830 op/deop:
2831 ID: EffOp
2832 Description:
2833 Grant/revoke a user operator state.
2834 Examples:
2835 op the player
2836 deop all players
2837 Since:
2838 1.0
2839 Patterns:
2840 [de[-]]op %offlineplayers%
2841Expressions:
2842 All Groups:
2843 ID: ExprAllGroups
2844 Description:
2845 All the groups a player can have. This expression requires Vault and a compatible permissions plugin to be installed.
2846 Examples:
2847 command /group <text>:
2848 trigger:
2849 if argument is "list":
2850 send "%all groups%"
2851 Since:
2852 2.2-dev35
2853 Return type: Text
2854 Changers:
2855 none
2856 Patterns:
2857 all groups
2858 All Permissions:
2859 ID: ExprPermissions
2860 Description:
2861 Returns all permissions of the defined player(s). Note that the modifications to resulting list do not actually change permissions.
2862 Examples:
2863 set {_permissions::*} to all permissions of the player
2864 Since:
2865 2.2-dev33
2866 Return type: Text
2867 Changers:
2868 none
2869 Patterns:
2870 [the] permissions of %players%
2871 %players%'[s] permissions
2872 Alphabetical Sort:
2873 ID: ExprAlphabetList
2874 Description:
2875 Sorts given strings in alphabetical order.
2876 Examples:
2877 set {_list::*} to alphabetically sorted {_list::*
2878 Since:
2879 2.2-dev18b
2880 Return type: Text
2881 Changers:
2882 none
2883 Patterns:
2884 alphabetically sorted %strings%
2885 Altitude:
2886 ID: ExprAltitude
2887 Description:
2888 Effectively an alias of 'y-coordinate of …', it represents the height of some object above bedrock.
2889 Examples:
2890 on damage:
2891 altitude of the attacker is higher that the altitude of the victim
2892 set damage to damage * 1.2
2893 Since:
2894 1.4.3
2895 Return type: double
2896 Changers:
2897 none
2898 Patterns:
2899 [the] altitude[s] of %locations%
2900 %locations%'[s] altitude[s]
2901 Amount:
2902 ID: ExprAmount
2903 Description:
2904 The amount of something.
2905 Please note that amount of <items> will not return the number of items, but the number of stacks, e.g. 1 for a stack of 64 torches.
2906 Examples:
2907 message "There are %number of all players% players online!"
2908 Since:
2909 1.0
2910 Return type: integer
2911 Changers:
2912 none
2913 Patterns:
2914 (amount|number|size) of %objects%
2915 Amount of Items:
2916 ID: ExprAmountOfItems
2917 Description:
2918 Counts how many of a particular item type are in a given inventory.
2919 Examples:
2920 message "You have %number of ores in the player's inventory% ores in your inventory."
2921 Since:
2922 2.0
2923 Return type: integer
2924 Changers:
2925 none
2926 Patterns:
2927 [the] (amount|number) of %itemtypes% (in|of) %inventories%
2928 Argument:
2929 ID: ExprArgument
2930 Description:
2931 Only usable in command events. Holds the value of the nth argument given to the command, e.g. if the command "/tell <player> <text>" is used like "/tell Njol Hello Njol!" argument 1 is the player named "Njol" and argument 2 is "Hello Njol!".
2932 One can also use the type of the argument instead of its index to address the argument, e.g. in the above example 'player-argument' is the same as 'argument 1'.
2933 Examples:
2934 give the item-argument to the player-argument
2935 damage the player-argument by the number-argument
2936 give a diamond pickaxe to the argument
2937 add argument 1 to argument 2
2938 heal the last argument
2939 Since:
2940 1.0
2941 Return type: Object
2942 Changers:
2943 unknown
2944 Patterns:
2945 [the] last arg[ument][s]
2946 [the] arg[ument][s](-| )<(\d+)>
2947 [the] <(\d*1)st|(\d*2)nd|(\d*3)rd|(\d*[4-90])th> arg[ument][s]
2948 [the] arg[ument][s]
2949 [the] %*classinfo%( |-)arg[ument][( |-)<\d+>]
2950 [the] arg[ument]( |-)%*classinfo%[( |-)<\d+>]
2951 Arithmetic:
2952 ID: ExprArithmetic
2953 Description:
2954 Arithmetic expressions, e.g. 1+2, (2 - health of player)/3, etc.
2955 Examples:
2956 set the player's health to 10 - the player's health
2957 loop (argument + 2)/5 times:
2958 message "Two useless numbers: %loop-num*2 - 5%, %2^loop-num - 1%"
2959 message "You have %health of player * 2% half hearts of HP!"
2960 Since:
2961 1.4.2
2962 Return type: Number
2963 Changers:
2964 unknown
2965 Patterns:
2966 %number%[ ]+[ ]%number%
2967 %number%[ ]-[ ]%number%
2968 %number%[ ]*[ ]%number%
2969 %number%[ ]/[ ]%number%
2970 %number%[ ]^[ ]%number%
2971 Armour Slot:
2972 ID: ExprArmorSlot
2973 Description:
2974 A part of a player's armour, i.e. the boots, leggings, chestplate or helmet.
2975 Examples:
2976 set chestplate of the player to a diamond chestplate
2977 helmet of player is neither a helmet nor air # player is wearing a block, e.g. from another plugin
2978 Since:
2979 1.0
2980 Return type: Inventory Slot
2981 Changers:
2982 add
2983 set
2984 remove
2985 remove all
2986 delete
2987 Patterns:
2988 [the] (boot[s]|shoe[s]|leg[ging][s]|chestplate[s]|helm[et][s]) [(item|slot)] of %livingentities%
2989 %livingentities%'[s] (boot[s]|shoe[s]|leg[ging][s]|chestplate[s]|helm[et][s]) [(item|slot)]
2990 Attacked:
2991 ID: ExprAttacked
2992 Description:
2993 The victim of a damage event, e.g. when a player attacks a zombie this expression represents the zombie.
2994 Examples:
2995 on damage:
2996 victim is a creeper
2997 damage the attacked by 1 heart
2998 Since:
2999 1.3
3000 Return type: Entity
3001 Changers:
3002 unknown
3003 Patterns:
3004 [the] (attacked|damaged|victim) [<(.+)>]
3005 Attacker:
3006 ID: ExprAttacker
3007 Description:
3008 The attacker of a damage event, e.g. when a player attacks a zombie this expression represents the player.
3009 Please note that the attacker can also be a block, e.g. a cactus or lava, but this expression will not be set in these cases.
3010 Examples:
3011 on damage:
3012 attacker is a player
3013 health of attacker is less than or equal to 2
3014 damage victim by 1 heart
3015 Since:
3016 1.3
3017 Return type: Entity
3018 Changers:
3019 add
3020 remove
3021 remove all
3022 Patterns:
3023 [the] (attacker|damager)
3024 Bed:
3025 ID: ExprBed
3026 Description:
3027 The bed location of a player, i.e. the spawn point of a player if he ever slept in a bed and the bed still exists and is unobstructed.
3028 Examples:
3029 bed of player exists:
3030 teleport player the the player's bed
3031 else:
3032 teleport the player to the world's spawn point
3033 Since:
3034 2.0
3035 Return type: Location
3036 Changers:
3037 set
3038 delete
3039 Patterns:
3040 [the] bed[s] [location[s]] of %players%
3041 %players%'[s] bed[s] [location[s]]
3042 Biome:
3043 ID: ExprBiome
3044 Description:
3045 The biome at a certain location. Please note that biomes are only defined for x/z-columns, i.e. the altitude (y-coordinate) doesn't matter.
3046 Examples:
3047 # damage player in deserts constantly
3048 every real minute:
3049 loop all players:
3050 biome at loop-player is desert
3051 damage the loop-player by 1
3052 Since:
3053 1.4.4
3054 Return type: Biome
3055 Changers:
3056 set
3057 Patterns:
3058 [the] biome (of|%direction%) %location%
3059 %location%'[s] biome
3060 Block:
3061 ID: ExprBlock
3062 Description:
3063 The block involved in the event, e.g. the clicked block or the placed block.
3064 Can optionally include a direction as well, e.g. 'block above' or 'block in front of the player'.
3065 Examples:
3066 block is ore
3067 set block below to air
3068 spawn a creeper above the block
3069 loop blocks in radius 4:
3070 loop-block is obsidian
3071 set loop-block to water
3072 block is a chest:
3073 clear the inventory of the block
3074 Since:
3075 1.0
3076 Return type: Block
3077 Changers:
3078 unknown
3079 Patterns:
3080 [the] [event-]block
3081 Block:
3082 ID: ExprBlock
3083 Description:
3084 The block involved in the event, e.g. the clicked block or the placed block.
3085 Can optionally include a direction as well, e.g. 'block above' or 'block in front of the player'.
3086 Examples:
3087 block is ore
3088 set block below to air
3089 spawn a creeper above the block
3090 loop blocks in radius 4:
3091 loop-block is obsidian
3092 set loop-block to water
3093 block is a chest:
3094 clear the inventory of the block
3095 Since:
3096 1.0
3097 Return type: Block
3098 Changers:
3099 unknown
3100 Patterns:
3101 [the] block %direction% [%location%]
3102 Block Sphere:
3103 ID: ExprBlockSphere
3104 Description:
3105 All blocks in a sphere around a center, mostly useful for looping.
3106 Examples:
3107 loop blocks in radius 5 around the player:
3108 Since:
3109 1.0
3110 Return type: Block
3111 Changers:
3112 add
3113 set
3114 remove
3115 remove all
3116 delete
3117 Patterns:
3118 [(all [[of] the]|the)] blocks in radius %number% [(of|around) %location%]
3119 [(all [[of] the]|the)] blocks around %location% in radius %number%
3120 Blocks:
3121 ID: ExprBlocks
3122 Description:
3123 Blocks relative to other blocks or between other blocks. Can be used to get blocks relative to other blocks or for looping.
3124 Examples:
3125 loop blocks above the player:
3126 loop blocks between the block below the player and the targeted block:
3127 set the blocks below the player, the victim and the targeted block to air
3128 Since:
3129 1.0
3130 Return type: Block
3131 Changers:
3132 add
3133 set
3134 remove
3135 remove all
3136 delete
3137 Patterns:
3138 [(all [[of] the]|the)] blocks %direction% [%locations%]
3139 [(all [[of] the]|the)] blocks from %location% [on] %direction%
3140 [(all [[of] the]|the)] blocks from %block% to %block%
3141 [(all [[of] the]|the)] blocks (within|between) %block% and %block%
3142 Book Author:
3143 ID: ExprBookAuthor
3144 Description:
3145 The author of a book
3146 Examples:
3147 on book sign:
3148 message "Book Title: %author of event-item%"
3149 Since:
3150 2.2-dev31
3151 Return type: Text
3152 Changers:
3153 set
3154 delete
3155 reset
3156 Patterns:
3157 [the] [book] (author|writer|publisher) of %itemstack%
3158 %itemstack%'[s] [book] (author|writer|publisher)
3159 Book Pages:
3160 ID: ExprBookPages
3161 Description:
3162 The pages of a book
3163 Examples:
3164 on book sign:
3165 message "Book Pages: %pages of event-item%"
3166 message "Book Page 1: %page 1 of event-item%"
3167 Since:
3168 2.2-dev31
3169 Return type: Text
3170 Changers:
3171 none
3172 Patterns:
3173 [all] [the] [book] (pages|content) of %itemstack%
3174 %itemstack%'s [book] (pages|content)
3175 [book] page %number% of %itemstack%
3176 %itemstack%'s [book] page %number%
3177 Book Title:
3178 ID: ExprBookTitle
3179 Description:
3180 The title of a book
3181 Examples:
3182 on book sign:
3183 message "Book Title: %title of event-item%"
3184 Since:
3185 2.2-dev31
3186 Return type: Text
3187 Changers:
3188 set
3189 delete
3190 reset
3191 Patterns:
3192 [the] (book name|title) of %itemstack%
3193 %itemstack%'[s] (book name|title)
3194 Burn/Cook Time:
3195 ID: ExprBurnCookTime
3196 Description:
3197 The time a furnace takes to burn an item in a fuel burn event.
3198 Can also be used to change the burn/cook time of a placed furnace.
3199 Examples:
3200 on fuel burn:
3201 if fuel slot is coal:
3202 set burning time to 1 tick
3203 Since:
3204 2.2-dev37
3205 Return type: Timespan
3206 Changers:
3207 add
3208 set
3209 remove
3210 Patterns:
3211 [the] burn[ing] time
3212 [the] (burn|cook)[ing] time of %blocks%
3213 %blocks%'[s] (burn|cook)[ing] time
3214 Chat Format:
3215 ID: ExprChatFormat
3216 Description:
3217 Can be used to get/retrieve the chat format. The sender of a message is represented by [player] or [sender], and the message by [message] or [msg].
3218 Examples:
3219 set the chat format to "<yellow>[player]<light gray>: <green>[message]"
3220 Since:
3221 2.2-dev31
3222 Return type: Text
3223 Changers:
3224 set
3225 reset
3226 Patterns:
3227 [the] (message|chat) format[ting]
3228 Chat Recipients:
3229 ID: ExprChatRecipients
3230 Description:
3231 Recipients of chat events where this is called.
3232 Examples:
3233 chat recipients
3234 Since:
3235 2.2-Fixes-v7, 2.2-dev35 (clearing recipients)
3236 Return type: Player
3237 Changers:
3238 add
3239 set
3240 remove
3241 remove all
3242 delete
3243 reset
3244 Patterns:
3245 [chat][( |-)]recipients
3246 Chunk:
3247 ID: ExprChunk
3248 Description:
3249 The chunk a block, location or entity is in
3250 Examples:
3251 add the chunk at the player to {protected chunks::*}
3252 Since:
3253 2.0
3254 Return type: Chunk
3255 Changers:
3256 none
3257 Patterns:
3258 [the] chunk[s] (of|%-directions%) %locations%
3259 %locations%'[s] chunk[s]
3260 Clicked Block/Entity/Inventory/Slot:
3261 ID: ExprClicked
3262 Description:
3263 The clicked block, entity, inventory slot, inventory, type or action.
3264 Examples:
3265 message "You clicked on a %type of clicked entity%!"
3266 clicked block is a chest:
3267 show the inventory of the clicked block to the player
3268 Since:
3269 1.0, 2.2-dev35 (more clickable things)
3270 Return type: Object
3271 Changers:
3272 add
3273 set
3274 remove
3275 remove all
3276 delete
3277 Patterns:
3278 [the] ( clicked (block|%-*itemtype/entitydata%)|clicked slot|clicked inventory|click (type|action)|inventory action)
3279 Colour of:
3280 ID: ExprColorOf
3281 Description:
3282 The colour of an item, can also be used to colour chat messages with "<%colour of ...%>this text is coloured!".
3283 Examples:
3284 on click on wool:
3285 message "This wool block is <%colour of block%>%colour of block%<reset>!"
3286 set the colour of the block to black
3287 Since:
3288 1.2
3289 Return type: Colour
3290 Changers:
3291 unknown
3292 Patterns:
3293 [the] colo[u]r[s] of %itemstacks/entities%
3294 %itemstacks/entities%'[s] colo[u]r[s]
3295 Coloured / Uncoloured:
3296 ID: ExprColoured
3297 Description:
3298 Parses <colour>s (including chat styles) in a message or removes any colours & chat styles from the message.
3299 Examples:
3300 on chat:
3301 set message to coloured message
3302 command /fade <player>:
3303 trigger:
3304 set display name of the player-argument to uncoloured display name of the player-argument
3305 Since:
3306 2.0
3307 Return type: Text
3308 Changers:
3309 none
3310 Patterns:
3311 (colo[u]r-|colo[u]red )%strings%
3312 (un|non)[-](colo[u]r-|colo[u]red )%strings%
3313 Command:
3314 ID: ExprCommand
3315 Description:
3316 The command that caused an 'on command' event (excluding the leading slash and all arguments)
3317 Examples:
3318 # prevent any commands except for the /exit command during some game
3319 on command:
3320 {game.%player%.is playing} is true
3321 command is not "exit"
3322 message "You're not allowed to use commands during the game"
3323 cancel the event
3324 Since:
3325 2.0
3326 Return type: Text
3327 Changers:
3328 none
3329 Patterns:
3330 [the] (full|complete|whole) command
3331 [the] command [label]
3332 [the] arguments
3333 Command Sender:
3334 ID: ExprCommandSender
3335 Description:
3336 The player or the console who sent a command. Mostly useful in commands and command events.
3337 Examples:
3338 make the command sender execute "/say hi!"
3339 on command:
3340 log "%executor% used command /%command% %arguments%" to "commands.log"
3341 Since:
3342 2.0
3343 Return type: Command Sender
3344 Changers:
3345 none
3346 Patterns:
3347 [the] [command['s]] (sender|executor)
3348 Compass Target:
3349 ID: ExprCompassTarget
3350 Description:
3351 The location a player's compass is pointing at.
3352 Examples:
3353 # make all player's compasses target a player stored in {compass target.%player%}
3354 every 5 seconds:
3355 loop all players:
3356 set the loop-player's compass target to location of {compass target.%loop-player%}
3357 Since:
3358 2.0
3359 Return type: Location
3360 Changers:
3361 set
3362 reset
3363 Patterns:
3364 [the] compass target of %players%
3365 %players%'[s] compass target
3366 Console:
3367 ID: LitConsole
3368 Description:
3369 Represents the server's console which can receive messages and execute commands
3370 Examples:
3371 execute console command "/stop"
3372 send "message to console" to the console
3373 Since:
3374 1.3.1
3375 Return type: Command Sender
3376 Changers:
3377 none
3378 Patterns:
3379 [the] (console|server)
3380 Cooldown Time/Remaining Time/Elapsed Time/Last Usage Date/Cooldown Bypass Permission:
3381 ID: ExprCmdCooldownInfo
3382 Description:
3383 Only usable in command events. Represents the cooldown time, the remaining time, or the elapsed time, or the last usage date, or the cooldown bypass permission.
3384 Examples:
3385 command /home:
3386 cooldown: 10 seconds
3387 cooldown message: You last teleported home %elapsed time% ago, you may teleport home again in %remaining time%
3388 trigger:
3389 teleport player to {home::%player%}
3390 Since:
3391 2.2-dev33
3392 Return type: Object
3393 Changers:
3394 add
3395 set
3396 remove
3397 remove all
3398 reset
3399 Patterns:
3400 [the] (remaining [time]|elapsed [time]|cooldown [time] [length]|last usage [date]|cooldown bypass perm[ission]) [of] [the] [(cooldown|wait)] [((of|for)[the] [current] command)]
3401 Coordinate:
3402 ID: ExprCoordinate
3403 Description:
3404 Represents a given coordinate of a location.
3405 Examples:
3406 player's y-coordinate is smaller than 40:
3407 message "Watch out for lava!"
3408 Since:
3409 1.4.3
3410 Return type: double
3411 Changers:
3412 unknown
3413 Patterns:
3414 [the] (x|y|z)(-| )(coord[inate]|pos[ition]|loc[ation])[s] of %locations%
3415 %locations%'[s] (x|y|z)(-| )(coord[inate]|pos[ition]|loc[ation])[s]
3416 Creature/Entity/Player/Projectile/Villager/Powered Creeper/etc.:
3417 ID: ExprEntity
3418 Description:
3419 The entity involved in an event (an entity is a player, a creature or an inanimate object like ignited TNT, a dropped item or an arrow).
3420 You can use the specific type of the entity that's involved in the event, e.g. in a 'death of a creeper' event you can use 'the creeper' instead of 'the entity'.
3421 Examples:
3422 give a diamond sword of sharpness 3 to the player
3423 kill the creeper
3424 kill all powered creepers in the wolf's world
3425 projectile is an arrow
3426 Since:
3427 1.0
3428 Return type: Entity
3429 Changers:
3430 unknown
3431 Patterns:
3432 [the] [event-]<.+>
3433 Cursor Slot:
3434 ID: ExprCursorSlot
3435 Description:
3436 The item which player has on their cursor. This slot is always empty if player has no inventories open.
3437 Examples:
3438 cursor slot of player is dirt
3439 set cursor slot of player to 64 diamonds
3440 Since:
3441 2.2-dev17
3442 Return type: Inventory Slot
3443 Changers:
3444 add
3445 set
3446 remove
3447 remove all
3448 delete
3449 Patterns:
3450 [the] cursor slot of %players%
3451 %players%'[s] cursor slot
3452 Custom Chest Inventory:
3453 ID: ExprChestInventory
3454 Description:
3455 Returns a chest inventory with the given amount of rows and the name. Use the open inventoryeffect to open it.
3456 Examples:
3457 open chest inventory with 1 rows named "test"
3458 set {_inventory} to chest inventory with 1 row
3459 Since:
3460 2.2-dev34
3461 Return type: Inventory
3462 Changers:
3463 add
3464 set
3465 remove
3466 remove all
3467 delete
3468 Patterns:
3469 [a [new]] chest inventory (named|with name) %string% [with %-number% row[s]]
3470 [a [new]] chest inventory with %number% row[s] [(named|with name) %-string%]
3471 Damage:
3472 ID: ExprDamage
3473 Description:
3474 How much damage is done in a damage event, possibly ignoring armour, criticals and/or enchantments. Can be changed (remember that in Skript '1' is one full heart, not half a heart).
3475 Examples:
3476 increase the damage by 2
3477 Since:
3478 1.3.5
3479 Return type: double
3480 Changers:
3481 none
3482 Patterns:
3483 [the] damage
3484 Damage Cause:
3485 ID: ExprDamageCause
3486 Description:
3487 The damage cause of a damage event. Please click on the link for more information.
3488 Examples:
3489 damage cause is lava, fire or burning
3490 Since:
3491 2.0
3492 Return type: Damage Cause
3493 Changers:
3494 none
3495 Patterns:
3496 [the] damage (cause|type)
3497 Data Value:
3498 ID: ExprDurability
3499 Description:
3500 The data value of an item.
3501 You usually don't need this expression as you can check and set items with aliases easily, but this expression can e.g. be used to "add 1 to data of <item>", e.g. for cycling through all wool colours.
3502 Examples:
3503 add 1 to the data value of the clicked block
3504 Since:
3505 1.2
3506 Return type: short
3507 Changers:
3508 unknown
3509 Patterns:
3510 [the] ((data|damage)[s] [value[s]]|durabilit(y|ies)) of %itemstacks/slots%
3511 %itemstacks/slots%'[s] ((data|damage)[s] [value[s]]|durabilit(y|ies))
3512 Date Ago/Later:
3513 ID: ExprDateAgoLater
3514 Description:
3515 A date the specified timespan before/after another date.
3516 Examples:
3517 set {_yesterday} to 1 day ago
3518 Since:
3519 2.2-dev33
3520 Return type: Date
3521 Changers:
3522 none
3523 Patterns:
3524 %timespan% (ago|in the past|before [the] [date] %-date%)
3525 %timespan% (later|(from|after) [the] [date] %-date%)
3526 Default Value:
3527 ID: ExprDefaultValue
3528 Description:
3529 A shorthand expression for giving things a default value. If the first thing isn't set, the second thing will be returned.
3530 Examples:
3531 broadcast {score::%player's uuid%} otherwise "%player% has no score!"
3532 Since:
3533 2.2-dev36
3534 Return type: Object
3535 Changers:
3536 none
3537 Patterns:
3538 %objects% (otherwise|?) %objects%
3539 Difference:
3540 ID: ExprDifference
3541 Description:
3542 The difference between two values, e.g. numbers, dates or times.
3543 Examples:
3544 difference between {command.%player%.lastuse} and now is smaller than a minute:
3545 message "You have to wait a minute before using this command again!"
3546 stop
3547 Since:
3548 1.4
3549 Return type: Object
3550 Changers:
3551 unknown
3552 Patterns:
3553 difference (between|of) %object% and %object%
3554 Direction:
3555 ID: ExprDirection
3556 Description:
3557 A helper expression for the direction type.
3558 Examples:
3559 thrust the player upwards
3560 set the block behind the player to water
3561 loop blocks above the player:
3562 set {_rand} to a random integer between 1 and 10
3563 set the block {_rand} meters south east of the loop-block to stone
3564 block in horizontal facing of the clicked entity from the player is air
3565 spawn a creeper 1.5 meters horizontally behind the player
3566 spawn a TNT 5 meters above and 2 meters horizontally behind the player
3567 thrust the last spawned TNT in the horizontal direction of the player with speed 0.2
3568 push the player upwards and horizontally forward at speed 0.5
3569 push the clicked entity in in the direction of the player at speed -0.5
3570 open the inventory of the block 2 blocks below the player to the player
3571 teleport the clicked entity behind the player
3572 grow a regular tree 2 meters horizontally behind the player
3573 Since:
3574 1.0 (basic), 2.0 (extended)
3575 Return type: Direction
3576 Changers:
3577 none
3578 Patterns:
3579 [%-number% [(block|met(er|re))[s]] [to the]] (north[(-| |)(east|west)][(ward(s|ly|)|er(n|ly|))] [of]|south[(-| |)(east|west)][(ward(s|ly|)|er(n|ly|))] [of]|(east|west)[(ward(s|ly|)|er(n|ly|))] [of]|above|over|(up|down)[ward(s|ly|)]|below|under[neath]|beneath) [%-direction%]
3580 [%-number% [(block|met(er|re))[s]]] in [the] (direction|horizontal direction|facing|horizontal facing) of %entity/block% (of|from|)
3581 [%-number% [(block|met(er|re))[s]]] in %entity/block%'[s] (direction|horizontal direction|facing|horizontal facing) (of|from|)
3582 [%-number% [(block|met(er|re))[s]]] (in[ ]front [of]|forward[s]|behind|backwards|[to the] (right|-left) [of])
3583 [%-number% [(block|met(er|re))[s]]] horizontal[ly] (in[ ]front [of]|forward[s]|behind|backwards|to the (right|-left) [of])
3584 Distance:
3585 ID: ExprDistance
3586 Description:
3587 The distance between two points.
3588 Examples:
3589 distance between the player and {%player%.home} is smaller than 20:
3590 message "You're very close to your home!"
3591 Since:
3592 1.0
3593 Return type: double
3594 Changers:
3595 none
3596 Patterns:
3597 [the] distance between %location% and %location%
3598 Drops:
3599 ID: ExprDrops
3600 Description:
3601 Only works in death events. Holds the drops of the dying creature. Drops can be prevented by removing them with "remove ... from drops", e.g. "remove all pickaxes from the drops", or "clear drops" if you don't want any drops at all.
3602 Examples:
3603 clear drops
3604 remove 4 planks from the drops
3605 Since:
3606 1.0
3607 Return type: Item / Material
3608 Changers:
3609 unknown
3610 Patterns:
3611 [the] drops
3612 Element of:
3613 ID: ExprElement
3614 Description:
3615 The first, last or a random element of a set, e.g. a list variable.
3616 See also: random
3617 Examples:
3618 give a random element out of {free items::*} to the player
3619 Since:
3620 2.0
3621 Return type: Object
3622 Changers:
3623 unknown
3624 Patterns:
3625 (-[the] first|[the] last|[a] random|%-number%(st|nd|rd|th)) element [out] of %objects%
3626 Enchantment Level:
3627 ID: ExprEnchantmentLevel
3628 Description:
3629 The level of a particular enchantment on an item
3630 Examples:
3631 player' tool is a sword of sharpness:
3632 message "You have a sword of sharpness %level of sharpness of the player's tool% equipped"
3633 Since:
3634 2.0
3635 Return type: integer
3636 Changers:
3637 none
3638 Patterns:
3639 [the] (%-enchantment% level|level of [[the] enchant[ment]] %-enchantment%) o(f|n) %itemtypes%
3640 %itemtypes%'[s] (%-enchantment% level|level of [[the] enchant[ment]] %-enchantment%)
3641 Ender Chest:
3642 ID: ExprEnderChest
3643 Description:
3644 The ender chest of a player
3645 Examples:
3646 open the player's ender chest to the player
3647 Since:
3648 2.0
3649 Return type: Inventory
3650 Changers:
3651 add
3652 set
3653 remove
3654 remove all
3655 delete
3656 Patterns:
3657 [the] ender[ ]chest[s] of %players%
3658 %players%'[s] ender[ ]chest[s]
3659 Entities:
3660 ID: ExprEntities
3661 Description:
3662 all entities in all world, in a specific world or in a radius around a certain location, e.g. 'all players', 'all creepers in the player's world', or 'players in radius 100 of the player'.
3663 Examples:
3664 kill all creepers in the player's world
3665 send "Psst!" to all players witin 100 meters of the player
3666 give a diamond to all ops
3667 heal all tamed wolves in radius 2000 around {town center}
3668 Since:
3669 1.2.1
3670 Return type: Entity
3671 Changers:
3672 add
3673 remove
3674 remove all
3675 Patterns:
3676 [(all [[of] the]|the)] %*entitydatas% [(in|of) [world[s]] %-worlds%]
3677 [(all [[of] the]|the)] entities of type[s] %entitydatas% [(in|of) [world[s]] %-worlds%]
3678 [(all [[of] the]|the)] %*entitydatas% (within|[with]in radius) %number% [(block[s]|met(er|re)[s])] (of|around) %location%
3679 [(all [[of] the]|the)] entities of type[s] %entitydatas% in radius %number% (of|around) %location%
3680 Exhaustion:
3681 ID: ExprExhaustion
3682 Description:
3683 The exhaustion of a player. This is mainly used to determine the rate of hunger depletion.
3684 Examples:
3685 set exhaustion of all players to 1
3686 Since:
3687 2.2-dev35
3688 Return type: Number
3689 Changers:
3690 add
3691 set
3692 remove
3693 remove all
3694 delete
3695 reset
3696 Patterns:
3697 [the] exhaustion of %players%
3698 %players%'[s] exhaustion
3699 Experience:
3700 ID: ExprExperience
3701 Description:
3702 How much experience was spawned in an experience spawn event. Can be changed.
3703 Examples:
3704 on experience spawn:
3705 add 5 to the spawned experience
3706 Since:
3707 2.1
3708 Return type: Experience
3709 Changers:
3710 add
3711 set
3712 remove
3713 remove all
3714 delete
3715 Patterns:
3716 [the] (spawned|dropped|) [e]xp[erience] [orb[s]]
3717 Facing:
3718 ID: ExprFacing
3719 Description:
3720 The facing of an entity or block, i.e. exactly north, south, east, west, up or down (unlike direction which is the exact direction, e.g. '0.5 south and 0.7 east')
3721 Examples:
3722 # makes a bridge
3723 loop blocks from the block below the player in the horizontal facing of the player:
3724 set block to cobblestone
3725 Since:
3726 1.4
3727 Return type: Direction
3728 Changers:
3729 unknown
3730 Patterns:
3731 [the] (horizontal|) facing of %livingentities/blocks%
3732 %livingentities/blocks%'[s] (horizontal|) facing
3733 Filter:
3734 ID: ExprFilter
3735 Description:
3736 Filters a list based on a condition. For example, if you ran 'broadcast "something" and "something else" where [string input is "something"]only "something" would be broadcast as it is the only string that matched the condition.
3737 Examples:
3738 send "congrats on being staff!" to all players where [player input has permission "staff"]
3739 Since:
3740 2.2-dev36
3741 Return type: Object
3742 Changers:
3743 unknown
3744 Patterns:
3745 %objects% (where|that match) \[<.+>\]
3746 Filter Input:
3747 ID: ExprInput
3748 Description:
3749 Represents the input in a filter expression. For example, if you ran 'broadcast "something" and "something else" where [input is "something"]the condition would be checked twice, using "something" and "something else" as the inputs.
3750 Examples:
3751 send "congrats on being staff!" to all players where [input has permission "staff"]
3752 Since:
3753 2.2-dev36
3754 Return type: Object
3755 Changers:
3756 none
3757 Patterns:
3758 input
3759 %*classinfo% input
3760 Final Damage:
3761 ID: ExprFinalDamage
3762 Description:
3763 How much damage is done in a damage event, considering all types of damage reduction. Can NOT be changed.
3764 Examples:
3765 send "%final damage%" to victim
3766 Since:
3767 2.2-dev19
3768 Return type: double
3769 Changers:
3770 none
3771 Patterns:
3772 [the] final damage
3773 Flight Mode:
3774 ID: ExprFlightMode
3775 Description:
3776 Whether the player(s) are allowed to fly. Use Make Fly effect to force player(s) to fly.
3777 Examples:
3778 set flight mode of player to true
3779 send "%flying state of all players%"
3780 Since:
3781 2.2-dev34
3782 Return type: Boolean
3783 Changers:
3784 set
3785 reset
3786 Patterns:
3787 [the] fl(y[ing]|ight) (mode|state) of %players%
3788 %players%'[s] fl(y[ing]|ight) (mode|state)
3789 Food Level:
3790 ID: ExprFoodLevel
3791 Description:
3792 The food level of a player from 0 to 10. Has several aliases: food/hunger level/meter/bar.
3793 Examples:
3794 set the player's food level to 10
3795 Since:
3796 1.0
3797 Return type: float
3798 Changers:
3799 add
3800 set
3801 remove
3802 delete
3803 reset
3804 Patterns:
3805 [the] (food|hunger)[[ ](level|met(er|re)|bar)] [of %player%]
3806 %player%'[s] (food|hunger)[[ ](level|met(er|re)|bar)]
3807 Formatted time:
3808 ID: ExprFormatTime
3809 Description:
3810 Converts date to human-readable text format. By default, yyyy-MM-dd HH:mm:ss z will be used. For reference, see this Wikipedia article.
3811 Examples:
3812 now formatted human-readable
3813 Since:
3814 2.2-dev31
3815 Return type: Text
3816 Changers:
3817 none
3818 Patterns:
3819 %dates% formatted [human-readable] [(with|as) %-string%]
3820 Former/Future State:
3821 ID: ExprTimeState
3822 Description:
3823 Represents the value of an expression before an event happened or the value it will have directly after the event, e.g. the old or new level respectively in a level change event.
3824 Note: The past, future and present states of an expression are sometimes called 'time states' of an expression.
3825 Note 2: If you don't specify whether to use the past or future state of an expression that has different values, its default value will be used which is usually the value after the event.
3826 Examples:
3827 on teleport:
3828 former world was "world_nether" # or 'world was'
3829 world will be "world" # or 'world after the event is'
3830 on tool change:
3831 past tool is an axe
3832 the tool after the event will be air
3833 on weather change:
3834 set {weather.%world%.old} to past weather
3835 set {weather.%world%.current} to the new weather
3836 Since:
3837 1.1
3838 Return type: Object
3839 Changers:
3840 unknown
3841 Patterns:
3842 [the] (former|past|old) [state] [of] %~object%
3843 %~object% before [the event]
3844 [the] (future|to-be|new) [state] [of] %~object%
3845 %~object%(-to-be| after[(wards| the event)])
3846 Furnace Slot:
3847 ID: ExprFurnaceSlot
3848 Description:
3849 A slot of a furnace, i.e. either the ore, fuel or result slot.
3850 Remember to use 'block' and not 'furnace', as 'furnace' is not an existing expression.
3851 Examples:
3852 set the fuel slot of the clicked block to a lava bucket
3853 set the block's ore slot to 64 iron ore
3854 give the result of the block to the player
3855 clear the result slot of the block
3856 Since:
3857 1.0
3858 Return type: Inventory Slot
3859 Changers:
3860 add
3861 set
3862 remove
3863 remove all
3864 delete
3865 Patterns:
3866 (fuel|result) [slot]
3867 (ore|fuel|result)[s] [slot[s]] of %blocks%
3868 %blocks%'[s] (ore|fuel|result)[s] [slot[s]]
3869 Game Mode:
3870 ID: ExprGameMode
3871 Description:
3872 The gamemode of a player.
3873 Examples:
3874 player's gamemode is survival
3875 set the player's gamemode to creative
3876 Since:
3877 1.0
3878 Return type: Game Mode
3879 Changers:
3880 set
3881 reset
3882 Patterns:
3883 [the] game[ ]mode of %players%
3884 %players%'[s] game[ ]mode
3885 Glowing:
3886 ID: ExprGlowing
3887 Description:
3888 Indicates if targeted entity is glowing (new 1.9 effect) or not. Glowing entities can be seen through walls.
3889 Examples:
3890 set glowing of player on
3891 Since:
3892 2.2-dev18
3893 Return type: Boolean
3894 Changers:
3895 set
3896 reset
3897 Patterns:
3898 [the] glowing of %entities%
3899 %entities%'[s] glowing
3900 Group:
3901 ID: ExprGroup
3902 Description:
3903 The primary group or all groups of a player. This expression requires Vault and a compatible permissions plugin to be installed.
3904 Examples:
3905 on join:
3906 broadcast "%group of player%" # this is the player's primary group
3907 broadcast "%groups of player%" # this is all of the player's groups
3908 Since:
3909 2.2-dev35
3910 Return type: Text
3911 Changers:
3912 add
3913 set
3914 remove
3915 delete
3916 reset
3917 Patterns:
3918 [the] group[(s)] of %offlineplayers%
3919 %offlineplayers%'[s] group[(s)]
3920 Hash:
3921 ID: ExprHash
3922 Description:
3923 Hashes the given text using the MD5 or SHA-256 algorithms. Each algorithm is suitable for different use cases.<p>
3924 MD5 is provided mostly for backwards compatibility, as it is outdated and not secure.
3925 SHA-256 is more secure, and can used to hash somewhat confidental data like IP addresses and even passwords.
3926 It is not that secure out of the box, so please consider using salt when dealing with passwords!
3927 When hashing data, you must specify algorithms that will be used for security reasons!
3928 <p>Please note that a hash cannot be reversed under normal circumstanses. You will not be able to get original value from a hash with Skript.
3929 Examples:
3930 command /setpass <text>:
3931 trigger:
3932 set {password.%player%} to text-argument hashed with SHA-256
3933 command /login <text>:
3934 trigger:
3935 {password.%player%} is text-argument hashed with SHA-256:
3936 message "Login successful."
3937 else:
3938 message "Wrong password!"
3939 Since:
3940 2.0, 2.2-dev32 (SHA-256 algorithm)
3941 Return type: Text
3942 Changers:
3943 none
3944 Patterns:
3945 %strings% hash[ed] with (MD5|SHA-256)
3946 Head location:
3947 ID: ExprEyeLocation
3948 Description:
3949 The location of an entity's head, mostly useful for players and e.g. looping blocks in the player's line of sight.
3950 Please note that this location is only accurate for entities whose head is exactly above their center, i.e. players, endermen, zombies, skeletons, etc., but not sheep, pigs or cows.
3951 Examples:
3952 set the block at the player's head to air
3953 set the block in front of the player's eyes to glass
3954 loop blocks in front of the player's head:
3955 Since:
3956 2.0
3957 Return type: Location
3958 Changers:
3959 none
3960 Patterns:
3961 [the] (head|eye[s]) [location[s]] of %livingentities%
3962 %livingentities%'[s] (head|eye[s]) [location[s]]
3963 Health:
3964 ID: ExprHealth
3965 Description:
3966 The health of a creature, e.g. a player, mob, villager, etc. from 0 to the creature's max health, e.g. 10 for players.
3967 Examples:
3968 message "You have %health% HP left."
3969 Since:
3970 1.0
3971 Return type: double
3972 Changers:
3973 add
3974 set
3975 remove
3976 delete
3977 reset
3978 Patterns:
3979 [the] health of %livingentities%
3980 %livingentities%'[s] health
3981 Hidden Players:
3982 ID: ExprHiddenPlayers
3983 Description:
3984 The players hidden from a player that hidden using the player visibility effect.
3985 Examples:
3986 message "<light red>You are currently hiding: <light gray>%hidden players of the player%"
3987 Since:
3988 INSERT VERSION
3989 Return type: Player
3990 Changers:
3991 add
3992 remove
3993 remove all
3994 Patterns:
3995 [(all [[of] the]|the)] hidden players (of|for) %players%
3996 [(all [[of] the]|the)] players hidden (from|for|by) %players%
3997 Highest Solid Block:
3998 ID: ExprHighestSolidBlock
3999 Description:
4000 Returns the highest solid block at the x and z coordinates of the world of given location
4001 Examples:
4002 highest block at location of arg-player
4003 Since:
4004 2.2-dev34
4005 Return type: Block
4006 Changers:
4007 add
4008 set
4009 remove
4010 remove all
4011 delete
4012 Patterns:
4013 [the] highest [(solid|non-air)] block[s] at %locations%
4014 Hotbar Slot:
4015 ID: ExprHotbarSlot
4016 Description:
4017 The slot number of the currently selected hotbar slot.
4018 Examples:
4019 message "%player's current hotbar slot%"
4020 set player's selected hotbar slot to slot 4 of player
4021 Since:
4022 2.2-dev36
4023 Return type: Inventory Slot
4024 Changers:
4025 set
4026 Patterns:
4027 [the] [([currently] selected|current)] hotbar slot of %players%
4028 %players%'[s] [([currently] selected|current)] hotbar slot
4029 Humidity:
4030 ID: ExprHumidity
4031 Description:
4032 Humidity of given blocks
4033 Since:
4034 2.2-dev35
4035 Return type: double
4036 Changers:
4037 none
4038 Patterns:
4039 [the] humidit(y|ies) of %blocks%
4040 %blocks%'[s] humidit(y|ies)
4041 IP:
4042 ID: ExprIP
4043 Description:
4044 The IP address of a player.
4045 Examples:
4046 IP-ban the player # is equal to the next line
4047 ban the IP-address of the player
4048 broadcast "Banned the IP %IP of player%"
4049 Since:
4050 1.4, 2.2-dev26 (when used in connect event)
4051 Return type: Text
4052 Changers:
4053 none
4054 Patterns:
4055 IP[s][( |-)address[es]] of %players%
4056 %players%'[s] IP[s][( |-)address[es]]
4057 Id:
4058 ID: ExprIdOf
4059 Description:
4060 The id of a specific item. You usually don't need this expression as you can likely do everything with aliases.
4061 Examples:
4062 message "the ID of %type of the clicked block% is %id of the clicked block%."
4063 Since:
4064 1.0
4065 Return type: integer
4066 Changers:
4067 unknown
4068 Patterns:
4069 [the] id(s|) of %itemtype%
4070 %itemtype%'[s] id(s|)
4071 Index Of:
4072 ID: ExprIndexOf
4073 Description:
4074 The first or last index of a character (or text) in a text, or -1 if it doesn't occur in the text. Indices range from 1 to the length of the text.
4075 Examples:
4076 set {_@} to the first index of "@" in the text argument
4077 if {_s} contains "abc":
4078 set {_s} to the first (index of "abc" in {_s} + 3) characters of {_s} # removes everything after the first "abc" from {_s}
4079 Since:
4080 2.1
4081 Return type: integer
4082 Changers:
4083 none
4084 Patterns:
4085 [the] (|first|last) index of %string% in %string%
4086 Indices of List:
4087 ID: ExprIndexes
4088 Description:
4089 Gets indices of a list variable.
4090 Examples:
4091 set {l::*} to "some", "cool" and "values"
4092broadcast "%all indices of {l::*}%" # Result is 1, 2 and 3
4093 Since:
4094 2.2-dev37
4095 Return type: Text
4096 Changers:
4097 none
4098 Patterns:
4099 [(all [[of] the]|the)] indices of %objects%
4100 %objects%'s indices
4101 Inventory:
4102 ID: ExprInventory
4103 Description:
4104 The inventory of a block or player. You can usually omit this expression and can directly add or remove items to/from blocks or players.
4105 Examples:
4106 add a plank to the player's inventory
4107 clear the player's inventory
4108 remove 5 wool from the inventory of the clicked block
4109 Since:
4110 1.0
4111 Return type: Object
4112 Changers:
4113 add
4114 set
4115 remove
4116 remove all
4117 delete
4118 Patterns:
4119 [the] inventor(y|ies) of %inventoryholders%
4120 %inventoryholders%'[s] inventor(y|ies)
4121 Inventory Action:
4122 ID: ExprInventoryAction
4123 Description:
4124 The inventory action of an inventory event. Please click on the link for more information.
4125 Examples:
4126 inventory action is pickup all
4127 Since:
4128 2.2-dev16
4129 Return type: Inventory Action
4130 Changers:
4131 none
4132 Patterns:
4133 [the] inventory action
4134 Inventory Holder/Viewers/Rows:
4135 ID: ExprInventoryInfo
4136 Description:
4137 Gets the rows/size/viewers/holder of an inventory.
4138 Examples:
4139 event-inventory's amount of rows
4140 holder of player's top inventory
4141 {_inventory}'s viewers
4142 Since:
4143 2.2-dev34
4144 Return type: Object
4145 Changers:
4146 add
4147 remove
4148 remove all
4149 Patterns:
4150 [the] (holder[s]|viewers|[amount of] rows) of %inventories%
4151 %inventories%'[s] (holder[s]|viewers|[amount of] rows)
4152 Inventory Slot:
4153 ID: ExprInventorySlot
4154 Description:
4155 Represents a slot in a inventory. It can be used to change the item in a inventory too.
4156 Examples:
4157 if slot 0 of player is air:
4158 set slot 0 of player to 2 stones
4159 remove 1 stone from slot 0 of player
4160 add 2 stones to slot 0 of player
4161 clear slot 1 of player
4162 Since:
4163 2.2-dev24
4164 Return type: Inventory Slot
4165 Changers:
4166 add
4167 set
4168 remove
4169 remove all
4170 delete
4171 Patterns:
4172 [the] slot[s] %numbers% of %inventory%
4173 %inventory%'[s] slot[s] %numbers%
4174 Item:
4175 ID: ExprItem
4176 Description:
4177 The item involved in an event, e.g. in a drop, dispense, pickup or craft event.
4178 Examples:
4179 on dispense:
4180 item is a clock
4181 set the time to 6:00
4182 Since:
4183 <i>unknown</i> (before 2.1)
4184 Return type: Item / Material
4185 Changers:
4186 none
4187 Patterns:
4188 [the] item
4189 Item Amount:
4190 ID: ExprItemAmount
4191 Description:
4192 The amount of an item stack.
4193 Examples:
4194 send "You have got %item amount of player's tool% %player's tool% in your hand !" to player
4195 Since:
4196 2.2-dev24
4197 Return type: Number
4198 Changers:
4199 add
4200 set
4201 remove
4202 delete
4203 reset
4204 Patterns:
4205 [the] item[[ ]stack] (amount|size|number) of %itemstacks%
4206 %itemstacks%'[s] item[[ ]stack] (amount|size|number)
4207 Item Enchantments:
4208 ID: ExprEnchantments
4209 Description:
4210 All the enchantments an item type has.
4211 Examples:
4212 clear enchantments of event-item
4213 Since:
4214 2.2-dev36
4215 Return type: Enchantment Type
4216 Changers:
4217 add
4218 set
4219 remove
4220 remove all
4221 delete
4222 reset
4223 Patterns:
4224 [the] enchantments of %itemtypes%
4225 %itemtypes%'[s] enchantments
4226 Item of an Entity:
4227 ID: ExprItemFrameSlot
4228 Description:
4229 An item associated with an entity. For dropped item entities, it gets, obviously, the item that was dropped. For item frames, the item inside the frame is returned. Other entities do not have items associated with them.
4230 Since:
4231 2.2-dev35, 2.2-dev36 (improved)
4232 Return type: Inventory Slot
4233 Changers:
4234 add
4235 set
4236 remove
4237 remove all
4238 delete
4239 Patterns:
4240 [the] item of %entities%
4241 %entities%'[s] item
4242 Items:
4243 ID: ExprItems
4244 Description:
4245 Items or blocks of a specific type, useful for looping.
4246 Examples:
4247 loop items of type ore and log:
4248 block contains loop-item
4249 message "Theres at least one %loop-item% in this block"
4250 drop all blocks at the player # drops one of every block at the player
4251 Since:
4252 <i>unknown</i> (before 2.1)
4253 Return type: Item / Material
4254 Changers:
4255 none
4256 Patterns:
4257 [(all [[of] the]|the|every)] item(s|[ ]types)
4258 [(all [[of] the]|the)] items of type[s] %itemtypes%
4259 [(all [[of] the]|the|every)] block(s|[ ]types)
4260 [(all [[of] the]|the)] blocks of type[s] %itemtypes%
4261 Items In:
4262 ID: ExprItemsIn
4263 Description:
4264 All items in an inventory. Useful for looping or storing in a list variable.
4265 Please note that the positions of the items in the inventory are not saved, only their order is preserved.
4266 Examples:
4267 loop all items in the player's inventory:
4268 loop-item is enchanted
4269 remove loop-item from the player
4270 set {inventory.%player%} to items in the player's inventory
4271 Since:
4272 2.0
4273 Return type: Inventory Slot
4274 Changers:
4275 add
4276 set
4277 remove
4278 remove all
4279 delete
4280 Patterns:
4281 [(all [[of] the]|the)] items ([with]in|of|contained in|out of) (|inventor(y|ies)) %inventories%
4282 Join & Split:
4283 ID: ExprJoinSplit
4284 Description:
4285 Joins several texts with a common delimiter (e.g. ", "), or splits a text into multiple texts at a given delimiter.
4286 Examples:
4287 message "Online players: %join all players with " | "%" # %all players% would use the default "x, y, and z"
4288 set {_s::} to the string argument split at ","
4289 Since:
4290 2.1
4291 Return type: Text
4292 Changers:
4293 none
4294 Patterns:
4295 (concat[enate]|join) %objects% [(with|using|by) [[the] delimiter] %-string%]
4296 split %string% (at|using|by) [[the] delimiter] %string%
4297 %string% split (at|using|by) [[the] delimiter] %string%
4298 Language:
4299 ID: ExprLanguage
4300 Description:
4301 Currently selected game language of a player. The value of the language is not defined properly.
4302 The vanilla Minecraft client will use lowercase language / country pairs separated by an underscore, but custom resource packs may use any format they wish.
4303 Examples:
4304 message player's current language
4305 Since:
4306 2.2-dev37
4307 Return type: Text
4308 Changers:
4309 none
4310 Patterns:
4311 [the] [([currently] selected|current)] [game] (language|locale) [setting] of %players%
4312 %players%'[s] [([currently] selected|current)] [game] (language|locale) [setting]
4313 Last Damage Cause:
4314 ID: ExprLastDamageCause
4315 Description:
4316 Cause of last damage done to an entity
4317 Examples:
4318 set last damage cause of event-entity to fire tick
4319 Since:
4320 2.2-Fixes-V10
4321 Return type: Damage Cause
4322 Changers:
4323 add
4324 set
4325 remove
4326 delete
4327 reset
4328 Patterns:
4329 [the] last damage (cause|reason|type) of %livingentities%
4330 %livingentities%'[s] last damage (cause|reason|type)
4331 Last Spawned Entity:
4332 ID: ExprLastSpawnedEntity
4333 Description:
4334 Holds the entity that was spawned most recently with the spawn effect, drop with the drop effect or shot with the shoot effect. Please note that even though you can spawn multiple mobs simultaneously (e.g. with 'spawn 5 creepers'), only the last spawned mob is saved and can be used. If you spawn an entity, shoot a projectile and drop a item you can however access all them together.
4335 Examples:
4336 spawn a priest
4337 set {%spawned priest%.healer} to true
4338 shoot an arrow from the last spawned entity
4339 ignite the shot projectile
4340 drop a diamond sword
4341 push last dropped item upwards
4342 Since:
4343 1.3 (spawned entity), 2.0 (shot entity), 2.2-dev26 (dropped item)
4344 Return type: Entity
4345 Changers:
4346 unknown
4347 Patterns:
4348 [the] [last[ly]] (spawned|shot) %*entitydata%
4349 [the] [last[ly]] dropped (item)
4350 Length:
4351 ID: ExprLength
4352 Description:
4353 The length of a text, in number of characters.
4354 Examples:
4355 set {_l} to length of the string argument
4356 Since:
4357 2.1
4358 Return type: integer
4359 Changers:
4360 none
4361 Patterns:
4362 [the] length of %strings%
4363 %strings%'[s] length
4364 Level:
4365 ID: ExprLevel
4366 Description:
4367 The level of a player.
4368 Examples:
4369 reduce the victim's level by 1
4370 set the player's level to 0
4371 Since:
4372 <i>unknown</i> (before 2.1)
4373 Return type: integer
4374 Changers:
4375 add
4376 set
4377 remove
4378 delete
4379 reset
4380 Patterns:
4381 [the] level of %players%
4382 %players%'[s] level
4383 Level Progress:
4384 ID: ExprLevelProgress
4385 Description:
4386 The progress a player has made until the next level. Remember that this value is between 0 and 1, not 0 and 100!
4387 Changing this value can cause a player's level to change if the resulting level progess is negative or larger than 1, e.g.increase the player's level progress by 0.5 will make the player gain a level if his progress was more than 50%.
4388 Examples:
4389 # use the exp bar as mana
4390 on rightclick with a blaze rod:
4391 player's level progress is larger than 0.2
4392 shoot a fireball from the player
4393 reduce the player's level progress by 0.2
4394 every 2 seconds:
4395 loop all players:
4396 level progress of loop-player is smaller than 0.9:
4397 increase level progress of the loop-player by 0.1
4398 else:
4399 set level progress of the loop-player to 0.99
4400 on xp spawn:
4401 cancel event
4402 Since:
4403 2.0
4404 Return type: float
4405 Changers:
4406 add
4407 set
4408 remove
4409 delete
4410 reset
4411 Patterns:
4412 [the] level progress of %players%
4413 %players%'[s] level progress
4414 Light Level:
4415 ID: ExprLightLevel
4416 Description:
4417 Gets the light level at a certain location which ranges from 0 to 15.
4418 It can be separated into sunlight (15 = direct sunlight, 1-14 = indirect) and block light (torches, glowstone, etc.). The total light level of a block is the maximum of the two different light types.
4419 Examples:
4420 # set vampire players standing in bright sunlight on fire
4421 every 5 seconds:
4422 loop all players:
4423 {vampire.%loop-player%} is true
4424 sunlight level at the loop-player is greater than 10
4425 ignite the loop-player for 5 seconds
4426 Since:
4427 1.3.4
4428 Return type: byte
4429 Changers:
4430 none
4431 Patterns:
4432 [(sky|sun|block)[ ]]light[ ]level [(of|%direction%) %location%]
4433 Location:
4434 ID: ExprLocation
4435 Description:
4436 The location where an event happened (e.g. at an entity or block), or a location relative to another (e.g. 1 meter above another location).
4437 Examples:
4438 drop 5 apples at the event-location # exactly the same as writing 'drop 5 apples'
4439 set {_loc} to the location 1 meter above the player
4440 Since:
4441 2.0
4442 Return type: Location
4443 Changers:
4444 unknown
4445 Patterns:
4446 [the] [event-](location|position)
4447 Location:
4448 ID: ExprLocation
4449 Description:
4450 The location where an event happened (e.g. at an entity or block), or a location relative to another (e.g. 1 meter above another location).
4451 Examples:
4452 drop 5 apples at the event-location # exactly the same as writing 'drop 5 apples'
4453 set {_loc} to the location 1 meter above the player
4454 Since:
4455 2.0
4456 Return type: Location
4457 Changers:
4458 unknown
4459 Patterns:
4460 [the] (location|position) %directions% [%location%]
4461 Location:
4462 ID: ExprLocationOf
4463 Description:
4464 The location of a block or entity. This not only represents the x, y and z coordinates of the location but also includes the world and the direction an entity is looking (e.g. teleporting to a saved location will make the teleported entity face the same saved direction every time).
4465 Please note that the location of an entity is at it's feet, use head location to get the location of the head.
4466 Examples:
4467 set {home.%player%} to the location of the player
4468 message "You home was set to %player's location% in %player's world%."
4469 Return type: Location
4470 Changers:
4471 unknown
4472 Patterns:
4473 (location|position) of %location%
4474 %location%'[s] (location|position)
4475 Location At:
4476 ID: ExprLocationAt
4477 Description:
4478 Allows to create a location from three coordinates and a world.
4479 Examples:
4480 set {_loc} to the location at arg-1, arg-2, arg-3 of the world arg-4
4481 distance between the player and the location (0, 0, 0) is less than 200
4482 Since:
4483 2.0
4484 Return type: Location
4485 Changers:
4486 none
4487 Patterns:
4488 [the] (location|position) [at] [(][x[ ][=[ ]]]%number%, [y[ ][=[ ]]]%number%, [and] [z[ ][=[ ]]]%number%[)] [[(in|of) [[the] world]] %world%]
4489 Loop value:
4490 ID: ExprLoopValue
4491 Description:
4492 The currently looped value.
4493 Examples:
4494 # countdown:
4495 loop 10 times:
4496 message "%11 - loop-number%"
4497 wait a second
4498 # generate a 10x10 floor made of randomly coloured wool below the player:
4499 loop blocks from the block below the player to the block 10 east of the block below the player:
4500 loop blocks from the loop-block to the block 10 north of the loop-block:
4501 set loop-block-2 to any wool
4502 Since:
4503 1.0
4504 Return type: Object
4505 Changers:
4506 unknown
4507 Patterns:
4508 [the] loop-<.+>
4509 Lore:
4510 ID: ExprLore
4511 Description:
4512 An item's lore.
4513 Examples:
4514 set the 1st line of the item's lore to "<orange>Excalibur 2.0"
4515 Since:
4516 2.1
4517 Return type: Text
4518 Changers:
4519 unknown
4520 Patterns:
4521 [the] lore of %itemstack/itemtype%
4522 %itemstack/itemtype%'[s] lore
4523 [the] line %number% of [the] lore of %itemstack/itemtype%
4524 [the] line %number% of %itemstack/itemtype%'[s] lore
4525 [the] %number%(st|nd|rd|th) line of [the] lore of %itemstack/itemtype%
4526 [the] %number%(st|nd|rd|th) line of %itemstack/itemtype%'[s] lore
4527 Max Health:
4528 ID: ExprMaxHealth
4529 Description:
4530 The maximum health of an entity, e.g. 10 for a player
4531 Examples:
4532 on join:
4533 set the maximum health of the player to 100
4534 spawn a giant
4535 set the last spawned entity's max health to 1000
4536 Since:
4537 2.0
4538 Return type: double
4539 Changers:
4540 add
4541 set
4542 remove
4543 reset
4544 Patterns:
4545 [the] max[imum] health of %livingentities%
4546 %livingentities%'[s] max[imum] health
4547 Maximum Stack Size:
4548 ID: ExprMaxStack
4549 Description:
4550 The maximum stack size of the specified material, e.g. 64 for torches, 16 for buckets, and 1 for swords.
4551 Examples:
4552 send "You can only pick up %max stack size of player's tool% of %type of (player's tool)%" to player
4553 Since:
4554 2.1
4555 Return type: integer
4556 Changers:
4557 none
4558 Patterns:
4559 [the] max[imum] stack[[ ]size] of %itemstack%
4560 %itemstack%'[s] max[imum] stack[[ ]size]
4561 Me:
4562 ID: ExprMe
4563 Description:
4564 A 'me' expression that can be used in effect commands only.
4565 Examples:
4566 !heal me
4567 !kick myself
4568 !give a diamond axe to me
4569 Since:
4570 2.1.1
4571 Return type: Command Sender
4572 Changers:
4573 none
4574 Patterns:
4575 me
4576 my[self]
4577 Message:
4578 ID: ExprMessage
4579 Description:
4580 The (chat) message of a chat event, the join message of a join event, the quit message of a quit event, or the death message on a death event. This expression is mostly useful for being changed.
4581 Since:
4582 1.4.6 (chat message), 1.4.9 (join & quit messages), 2.0 (death message)
4583 Return type: Text
4584 Changers:
4585 set
4586 Patterns:
4587 [the] [chat( |-)]message
4588 [the] (join|log[ ]in)( |-)message
4589 [the] (quit|leave|log[ ]out|kick)( |-)message
4590 [the] death( |-)message
4591 Metadata:
4592 ID: ExprMetadata
4593 Description:
4594 Metadata is a way to store temporary data on entities, blocks and more thatdisappears after a server restart.
4595 Examples:
4596 set metadata value "healer" of player to true
4597 broadcast "%metadata value ""healer"" of player%"
4598 clear metadata value "healer" of player
4599 Since:
4600 2.2-dev36
4601 Return type: Object
4602 Changers:
4603 set
4604 delete
4605 Patterns:
4606 metadata [(value|tag)[s]] %strings% of %metadataholders%
4607 %metadataholders%'[s] metadata [(value|tag)[s]] %string%
4608 Moved blocks:
4609 ID: ExprPushedBlocks
4610 Description:
4611 Blocks which are moved in piston event. Cannot be used outside of piston events.
4612 Examples:
4613 the moved blocks
4614 Since:
4615 2.2-dev27
4616 Return type: Block
4617 Changers:
4618 add
4619 set
4620 remove
4621 remove all
4622 delete
4623 Patterns:
4624 [the] moved blocks
4625 Name / Display Name:
4626 ID: ExprName
4627 Description:
4628 Represents a player's minecraft account name, chat display name, or playerlist name, or the custom name of an item, en entity or an inventory.
4629 The differences between the different names are:
4630 <ul>
4631 name: Minecraft account name of a player (unmodifiable), or the custom name of an item or mob (modifiable).
4632 display name: The name of a player as displayed in the chat and messages, e.g. when including %player% in a message. This name can be changed freely and can include colour codes, and is shared among all plugins (e.g. chat plugins will use a changed name).
4633 tab list name: The name of a player used in the player lists that usually opens with the tab key. Please note that this is limited to 16 characters, including colour codes which are counted as 2 characters each, and that no two players can have the same tab list name at the same time.
4634 </ul>
4635 Examples:
4636 on join:
4637 player has permission "name.red"
4638 set the player's display name to "<red>[admin]<gold>%name of player%"
4639 set the player's tablist name to "<green>%name of player%"
4640 set the name of the player's tool to "Legendary Sword of Awesomeness"
4641 Since:
4642 1.4.6 (players' name & display name), <i>unknown</i> (player list name), 2.0 (item name), 2.2-dev20 (inventory name)
4643 Return type: Text
4644 Changers:
4645 unknown
4646 Patterns:
4647 [the] ()(player|tab)[ ]list name[s] of %players%
4648 %players%'[s] ()(player|tab)[ ]list name[s]
4649 Name / Display Name:
4650 ID: ExprName
4651 Description:
4652 Represents a player's minecraft account name, chat display name, or playerlist name, or the custom name of an item, en entity or an inventory.
4653 The differences between the different names are:
4654 <ul>
4655 name: Minecraft account name of a player (unmodifiable), or the custom name of an item or mob (modifiable).
4656 display name: The name of a player as displayed in the chat and messages, e.g. when including %player% in a message. This name can be changed freely and can include colour codes, and is shared among all plugins (e.g. chat plugins will use a changed name).
4657 tab list name: The name of a player used in the player lists that usually opens with the tab key. Please note that this is limited to 16 characters, including colour codes which are counted as 2 characters each, and that no two players can have the same tab list name at the same time.
4658 </ul>
4659 Examples:
4660 on join:
4661 player has permission "name.red"
4662 set the player's display name to "<red>[admin]<gold>%name of player%"
4663 set the player's tablist name to "<green>%name of player%"
4664 set the name of the player's tool to "Legendary Sword of Awesomeness"
4665 Since:
4666 1.4.6 (players' name & display name), <i>unknown</i> (player list name), 2.0 (item name), 2.2-dev20 (inventory name)
4667 Return type: Text
4668 Changers:
4669 unknown
4670 Patterns:
4671 [the] ()(display|nick|chat)[ ]name[s] of %itemstacks/slots/livingentities/players/inventories%
4672 %itemstacks/slots/livingentities/players/inventories%'[s] ()(display|nick|chat)[ ]name[s]
4673 Name / Display Name:
4674 ID: ExprName
4675 Description:
4676 Represents a player's minecraft account name, chat display name, or playerlist name, or the custom name of an item, en entity or an inventory.
4677 The differences between the different names are:
4678 <ul>
4679 name: Minecraft account name of a player (unmodifiable), or the custom name of an item or mob (modifiable).
4680 display name: The name of a player as displayed in the chat and messages, e.g. when including %player% in a message. This name can be changed freely and can include colour codes, and is shared among all plugins (e.g. chat plugins will use a changed name).
4681 tab list name: The name of a player used in the player lists that usually opens with the tab key. Please note that this is limited to 16 characters, including colour codes which are counted as 2 characters each, and that no two players can have the same tab list name at the same time.
4682 </ul>
4683 Examples:
4684 on join:
4685 player has permission "name.red"
4686 set the player's display name to "<red>[admin]<gold>%name of player%"
4687 set the player's tablist name to "<green>%name of player%"
4688 set the name of the player's tool to "Legendary Sword of Awesomeness"
4689 Since:
4690 1.4.6 (players' name & display name), <i>unknown</i> (player list name), 2.0 (item name), 2.2-dev20 (inventory name)
4691 Return type: Text
4692 Changers:
4693 unknown
4694 Patterns:
4695 [the] ()name[s] of %itemstacks/slots/livingentities/players/inventories%
4696 %itemstacks/slots/livingentities/players/inventories%'[s] ()name[s]
4697 Named Item/Inventory:
4698 ID: ExprNamed
4699 Description:
4700 Directly names an item/inventory, useful for defining a named item/inventory in a script. If you want to (re)name existing items/inventories you can either use this expression or use set <a href='#ExprName'>name of <item/inventory> to <text></code>.
4701 Examples:
4702 give a diamond sword of sharpness 100 named "<gold>Excalibur" to the player
4703 set tool of player to the player's tool named "<gold>Wand"
4704 set the name of the player's tool to "<gold>Wand"
4705 open hopper inventory named "Magic Hopper" to player
4706 Since:
4707 2.0, 2.2-dev34 (inventories)
4708 Return type: Object
4709 Changers:
4710 none
4711 Patterns:
4712 %itemtype/inventorytype% (named|with name) %string%
4713 Now:
4714 ID: ExprNow
4715 Description:
4716 The current system time of the server. Use time to get the Minecraft time of a world.
4717 Examples:
4718 broadcast "Current server time: %now%"
4719 Since:
4720 1.4
4721 Return type: Date
4722 Changers:
4723 none
4724 Patterns:
4725 now
4726 Numbers:
4727 ID: ExprNumbers
4728 Description:
4729 All numbers between two given numbers, useful for looping.
4730 Use 'numbers' if your start is not an integer and you want to keep the fractional part of the start number constant, or use 'integers' if you only want to loop integers.
4731 An integer loop from 1 to a number x can also be written as 'loop x times'.
4732 Examples:
4733 loop 5 times: # loops 1, 2, 3, 4, 5
4734 loop numbers from 2.5 to 5.5: # loops 2.5, 3.5, 4.5, 5.5
4735 loop integers from 2.9 to 5.1: # same as '3 to 5', i.e. loops 3, 4, 5
4736 Since:
4737 1.4.6
4738 Return type: Number
4739 Changers:
4740 none
4741 Patterns:
4742 [(all [[of] the]|the)] (numbers|integers) (between|from) %number% (and|to) %number%
4743 %number% times
4744 Offline players:
4745 ID: ExprOfflinePlayers
4746 Description:
4747 All player that have ever joined the server. This includes players currently online.
4748 Examples:
4749 send "Size of all players who have joined the server: %size of all offline players%"
4750 Since:
4751 2.2-dev35
4752 Return type: Offlineplayer
4753 Changers:
4754 none
4755 Patterns:
4756 [(all [[of] the]|the)] offline[ ]players
4757 Opened Inventory:
4758 ID: ExprOpenedInventory
4759 Description:
4760 Return the currently opened inventory of a player.
4761 If no inventory is open, it returns the own player's crafting inventory.
4762 Examples:
4763 set slot 1 of player's current inventory to diamond sword
4764 Since:
4765 2.2-dev24, 2.2-dev35 (Just 'current inventory' works in player events)
4766 Return type: Inventory
4767 Changers:
4768 add
4769 set
4770 remove
4771 remove all
4772 delete
4773 Patterns:
4774 [the] (current|open|top) inventory [of %players%]
4775 %players%'[s] (current|open|top) inventory
4776 Parse:
4777 ID: ExprParse
4778 Description:
4779 Parses text as a given type, or as a given pattern.
4780 This expression can be used in two different ways: One which parses the entire text as a single instance of a type, e.g. as a number, and one that parses the text according to a pattern.
4781 If the given text could not be parsed, this expression will return nothing and the parse error will be set if some information is available.
4782 Some notes about parsing with a pattern:
4783 - The pattern must be a Skript pattern, e.g. percent signs are used to define where to parse which types, e.g. put a %number% or %items% in the pattern if you expect a number or some items there.
4784 - You have to save the expression's value in a list variable, e.g. set {parsed::*} to message parsed as "...".
4785 - The list variable will contain the parsed values from all %types% in the pattern in order. If a type was plural, e.g. %items%, the variable's value at the respective index will be a list variable, e.g. the values will be stored in {parsed::1::*}, not {parsed::1}.
4786 Examples:
4787 set {var} to line 1 parsed as number
4788 on chat:
4789 set {var::*} to message parsed as "buying %items% for %money%"
4790 if parse error is set:
4791 message "%parse error%"
4792 else if {var::*} is set:
4793 cancel event
4794 remove {var::2} from the player's balance
4795 give {var::1::*} to the player
4796 Since:
4797 2.0
4798 Return type: Object
4799 Changers:
4800 none
4801 Patterns:
4802 %string% parsed as (%-*classinfo%|"<.*>")
4803 Parse Error:
4804 ID: ExprParseError
4805 Description:
4806 The error which caused the last parse operation to fail, which might not be set if a pattern was used and the pattern didn't match the provided text at all.
4807 Examples:
4808 set {var} to line 1 parsed as integer
4809 if {var} is not set:
4810 parse error is set:
4811 message "<red>Line 1 is invalid: %last parse error%"
4812 else:
4813 message "<red>Please put an integer on line 1!"
4814 Since:
4815 2.0
4816 Return type: Text
4817 Changers:
4818 none
4819 Patterns:
4820 [the] [last] [parse] error
4821 Passenger:
4822 ID: ExprPassenger
4823 Description:
4824 The passenger of a vehicle, or the rider of a mob.
4825 See also: vehicle
4826 For 1.11.2 and above, it returns a list of passengers and you can use all changers in it.
4827 Examples:
4828 #for 1.11 and lower
4829 passenger of the minecart is a creeper or a cow
4830 the saddled pig's passenger is a player
4831 #for 1.11.2+
4832 passengers of the minecart contains a creeper or a cow
4833 the boat's passenger contains a pig
4834 add a cow and a zombie to passengers of last spawned boat
4835 set passengers of player's vehicle to a pig and a horse
4836 remove all pigs from player's vehicle
4837 clear passengers of boat
4838 Since:
4839 2.0, 2.2-dev26 (Multiple passengers for 1.11.2+)
4840 Return type: Entity
4841 Changers:
4842 unknown
4843 Patterns:
4844 [the] passenger[s] of %entities%
4845 %entities%'[s] passenger[s]
4846 Ping:
4847 ID: ExprPing
4848 Description:
4849 Pings of players, as Minecraft server knows them. Note that they will almost certainly be different from the ones you'd get from using ICMP echo requests. This expression is only supported on some server software.
4850 Examples:
4851 command /ping <player=%player%>:
4852 trigger:
4853 send "%arg-1%'s ping is %arg-1's ping%"
4854 Since:
4855 2.2-dev36
4856 Return type: Number
4857 Changers:
4858 none
4859 Patterns:
4860 [the] ping of %players%
4861 %players%'[s] ping
4862 Player Weather:
4863 ID: ExprPlayerWeather
4864 Description:
4865 The weather for a player.
4866 Examples:
4867 set weather of arg-player to rainy
4868 reset player's weather
4869 if arg-player's weather is rainy
4870 Since:
4871 2.2-dev34
4872 Return type: Weather Type
4873 Changers:
4874 set
4875 reset
4876 Patterns:
4877 [the] weather of %players%
4878 %players%'[s] weather
4879 Random:
4880 ID: ExprRandom
4881 Description:
4882 Gets a random item out of a set, e.g. a random player out of all players online.
4883 Examples:
4884 give a diamond to a random player out of all players
4885 give a random item out of all items to the player
4886 Since:
4887 1.4.9
4888 Return type: Object
4889 Changers:
4890 unknown
4891 Patterns:
4892 [a] random %*classinfo% [out] of %objects%
4893 Random Number:
4894 ID: ExprRandomNumber
4895 Description:
4896 A random number or integer between two given numbers. Use 'number' if you want any number with decimal parts, or use use 'integer' if you only want whole numbers.
4897 Please note that the order of the numbers doesn't matter, i.e. random number between 2 and 1 will work as well as random number between 1 and 2.
4898 Examples:
4899 set the player's health to a random number between 5 and 10
4900 send "You rolled a %random integer from 1 to 6%!" to the player
4901 Since:
4902 1.4
4903 Return type: Number
4904 Changers:
4905 none
4906 Patterns:
4907 [a] random (integer|number) (from|between) %number% (to|and) %number%
4908 Raw Name:
4909 ID: ExprRawName
4910 Description:
4911 Raw Minecraft material name for given item. Note that this is not guaranteed to give same results on all servers.
4912 Examples:
4913 raw name of tool of player
4914 Since:
4915 unknown (2.2)
4916 Return type: Text
4917 Changers:
4918 none
4919 Patterns:
4920 (raw|minecraft|vanilla) name of %itemtypes%
4921 Remaining Air:
4922 ID: ExprRemainingAir
4923 Description:
4924 How much time a player has left underwater before starting to drown.
4925 Examples:
4926 player's remaining air is less than 3 seconds:
4927 send "hurry, get to the surface!" to the player
4928 Since:
4929 <i>unknown</i> (before 2.1)
4930 Return type: Timespan
4931 Changers:
4932 add
4933 set
4934 remove
4935 delete
4936 reset
4937 Patterns:
4938 [the] remaining air of %livingentities%
4939 %livingentities%'[s] remaining air
4940 Respawn location:
4941 ID: ExprRespawnLocation
4942 Description:
4943 The location that a player should respawn at. This is used within the respawn event.
4944 Examples:
4945 on respawn:
4946 set respawn location to {example::spawn}
4947 Since:
4948 2.2-dev35
4949 Return type: Location
4950 Changers:
4951 set
4952 Patterns:
4953 [the] respawn location
4954 Rounding:
4955 ID: ExprRound
4956 Description:
4957 Rounds numbers normally, up (ceiling) or down (floor) respectively
4958 Examples:
4959 set {var} to rounded health of player
4960 set line 1 of the block to round(1.5 * player's level)
4961 set {_x} to floor({_y}) - ceil({_x})
4962 add rounded down argument to the player's health
4963 Since:
4964 2.0
4965 Return type: long
4966 Changers:
4967 none
4968 Patterns:
4969 (a|the|) round[ed] down %number%
4970 (a|the|) round[ed] %number%
4971 (a|the|) round[ed] up %number%
4972 Saturation:
4973 ID: ExprSaturation
4974 Description:
4975 The saturation of a player. If used in a player event, it can be omitted and will default to event-player.
4976 Examples:
4977 set saturation of player to 20
4978 Since:
4979 2.2-Fixes-v10, 2.2-dev35 (fully modifiable)
4980 Return type: Number
4981 Changers:
4982 add
4983 set
4984 remove
4985 delete
4986 reset
4987 Patterns:
4988 [the] saturation [of %players%]
4989 %players%'[s] saturation
4990 Script Name:
4991 ID: ExprScript
4992 Description:
4993 Holds the current script's name (the file name without '.sk').
4994 Examples:
4995 on script load:
4996 set {running.%script%} to true
4997 on script unload:
4998 set {running.%script%} to false
4999 Since:
5000 2.0
5001 Return type: Text
5002 Changers:
5003 none
5004 Patterns:
5005 [the] script[['s] name]
5006 Shooter:
5007 ID: ExprShooter
5008 Description:
5009 The shooter of a projectile.
5010 Examples:
5011 shooter is a skeleton
5012 Since:
5013 1.3.7
5014 Return type: Living Entity
5015 Changers:
5016 add
5017 set
5018 remove
5019 remove all
5020 Patterns:
5021 [the] shooter [of %projectile%]
5022 Shuffled List:
5023 ID: ExprShuffledList
5024 Description:
5025 Shuffles given list randomly. This is done by replacing indices by random numbers in resulting list.
5026 Examples:
5027 set {_list::*} to shuffled {_list::*}
5028 Since:
5029 2.2-dev32
5030 Return type: Object
5031 Changers:
5032 none
5033 Patterns:
5034 shuffled %objects%
5035 Sign Text:
5036 ID: ExprSignText
5037 Description:
5038 A line of text on a sign. Can be changed, but remember that there is a 16 character limit per line (including colour codes that use 2 characters each).
5039 Examples:
5040 on rightclick on sign:
5041 line 2 of the clicked block is "[Heal]":
5042 heal the player
5043 set line 3 to "%player%"
5044 Since:
5045 1.3
5046 Return type: Text
5047 Changers:
5048 set
5049 delete
5050 Patterns:
5051 [the] line %number% [of %block%]
5052 [the] (1st|first|2nd|second|3rd|third|4th|fourth) line [of %block%]
5053 Skull:
5054 ID: ExprSkull
5055 Description:
5056 Gets a skull item representing a player or an entity.
5057 Examples:
5058 give the victim's skull to the attacker
5059 set the block at the entity to the entity's skull
5060 Since:
5061 2.0
5062 Return type: Item Type
5063 Changers:
5064 none
5065 Patterns:
5066 [the] skull of %offlineplayers/entities/entitydatas%
5067 %offlineplayers/entities/entitydatas%'[s] skull
5068 Slot Index:
5069 ID: ExprSlotIndex
5070 Description:
5071 Index of an an inventory slot. Other types of slots may or may not have indices. Note that comparing slots with numbers is also possible; if index of slot is same as the number, comparisonsucceeds. This expression is mainly for the cases where you must for some reason save the slot numbers.
5072 Since:
5073 2.2-dev35
5074 Return type: integer
5075 Changers:
5076 none
5077 Patterns:
5078 [the] (index|indices) of %slots%
5079 %slots%'[s] (index|indices)
5080 Sorted List:
5081 ID: ExprSortedList
5082 Description:
5083 Sorts given list in natural order. All objects in list must be comparable; usually if you think you can compare it, it can be compared.
5084 Examples:
5085 set {_list::*} to sorted {_list::*}
5086 Since:
5087 2.2-dev19
5088 Return type: Object
5089 Changers:
5090 none
5091 Patterns:
5092 sorted %objects%
5093 Spawn:
5094 ID: ExprSpawn
5095 Description:
5096 The spawnpoint of a world.
5097 Examples:
5098 teleport all players to spawn
5099 set the spawn point of "world" to the player's location
5100 Since:
5101 1.4.2
5102 Return type: Location
5103 Changers:
5104 set
5105 Patterns:
5106 [the] spawn[s] [(point|location)[s]] [of %worlds%]
5107 %worlds%'[s] spawn[s] [(point|location)[s]]
5108 Special Number:
5109 ID: ExprSpecialNumber
5110 Description:
5111 Special number values, namely NaN, Infinity and -Infinity
5112 Examples:
5113 if {_number} is NaN value:
5114 Since:
5115 2.2-dev32d
5116 Return type: Number
5117 Changers:
5118 none
5119 Patterns:
5120 (NaN|[(-|minus)](infinity|∞)) value
5121 value of (NaN|[(-|minus)](infinity|∞))
5122 Spectator Target:
5123 ID: ExprSpectatorTarget
5124 Description:
5125 The entity a player is currently spectating. This can be set and cleared whenthe given player is in spectator mode.
5126 Examples:
5127 set spectator target of player to last spawned creeper
5128 Since:
5129 2.2-dev37
5130 Return type: Entity
5131 Changers:
5132 set
5133 delete
5134 reset
5135 Patterns:
5136 [the] spectator target of %players%
5137 %players%'[s] spectator target
5138 Speed:
5139 ID: ExprSpeed
5140 Description:
5141 A player's walking or flying speed. Both can be changed, but values must be between -1 and 1 (excessive values will be changed to -1 or 1 respectively). Negative values reverse directions.
5142 Please note that changing a player's speed will change his FOV just like potions do.
5143 Examples:
5144 set the player's walk speed to 1
5145 increase the argument's fly speed by 0.1
5146 Since:
5147 <i>unknown</i> (before 2.1)
5148 Return type: float
5149 Changers:
5150 add
5151 set
5152 remove
5153 reset
5154 Patterns:
5155 [the] (walk[ing]|fl(y[ing]|ight))[( |-])speed of %players%
5156 %players%'[s] (walk[ing]|fl(y[ing]|ight))[( |-])speed
5157 Subtext:
5158 ID: ExprSubstring
5159 Description:
5160 Extracts part of a text. You can either get the first <x> characters, the last <x> characters, or the characters between indices <x> and <y>. The indices <x> and <y> should be between 1 and the length of the text (other values will be fit into this range).
5161 Examples:
5162 set {_s} to the first 5 characters of the text argument
5163 message "%subtext of {_s} from characters 2 to (the length of {_s} - 1)%" # removes the first and last character from {_s} and sends it to the player or console
5164 Since:
5165 2.1
5166 Return type: Text
5167 Changers:
5168 none
5169 Patterns:
5170 [the] (part|sub[ ](text|string)) of %strings% (between|from) (ind(ex|ices)|character[s]|) %number% (and|to) (index|character|) %number%
5171 [the] (first|last) [%-number%] character[s] of %strings%
5172 [the] %number% (first|last) characters of %strings%
5173 TPS (ticks per second):
5174 ID: ExprTPS
5175 Description:
5176 Returns the 3 most recent TPS readings, like the /tps command. This expression is only supported on some server software.
5177 Examples:
5178 broadcast "%tps%"
5179 Since:
5180 2.2-dev36
5181 Return type: double
5182 Changers:
5183 none
5184 Patterns:
5185 tps from [the] last ([1] minute|1[ ]m[inute])
5186 tps from [the] last 5[ ]m[inutes]
5187 tps from [the] last 15[ ]m[inutes]
5188 [the] tps
5189 Tamer:
5190 ID: ExprTamer
5191 Description:
5192 The tamer of an entity. Can only be used in entity tame events. You can use 'event-entity' to refer tamed entity itself.
5193 Since:
5194 2.2-dev25
5195 Return type: Player
5196 Changers:
5197 add
5198 remove
5199 remove all
5200 Patterns:
5201 [the] tamer
5202 Target:
5203 ID: ExprTarget
5204 Description:
5205 For players this is the entity at the crosshair, while for mobs and experience orbs it represents the entity they are attacking/following (if any).
5206 Examples:
5207 on entity target:
5208 entity's target is a player
5209 send "You're being followed by an %entity%!" to target of entity
5210 Since:
5211 <i>unknown</i> (before 2.1)
5212 Return type: Entity
5213 Changers:
5214 add
5215 set
5216 remove
5217 remove all
5218 delete
5219 Patterns:
5220 [the] target[[ed] %-*entitydata%] [of %livingentities%]
5221 %livingentities%'[s] target[[ed] %-*entitydata%]
5222 Targeted Block:
5223 ID: ExprTargetedBlock
5224 Description:
5225 The block at the crosshair. This regards all blocks that are not air as fully opaque, e.g. torches will be like a solid stone block for this expression.
5226 Examples:
5227 # A command to set the block a player looks at to a specific type:
5228 command /setblock <material>:
5229 trigger:
5230 set targeted block to argument
5231 Since:
5232 1.0
5233 Return type: Block
5234 Changers:
5235 add
5236 set
5237 remove
5238 remove all
5239 delete
5240 Patterns:
5241 [the] target[ed] block[s] [of %players%]
5242 %players%'[s] target[ed] block[s]
5243 [the] actual[ly] target[ed] block[s] [of %players%]
5244 %players%'[s] actual[ly] target[ed] block[s]
5245 Teleport Cause:
5246 ID: ExprTeleportCause
5247 Description:
5248 The teleport cause within a player teleport event.
5249 Examples:
5250 teleport cause is nether portal, end portal or end gateway
5251 Since:
5252 2.2-dev35
5253 Return type: Object
5254 Changers:
5255 none
5256 Patterns:
5257 [the] teleport (cause|reason|type)
5258 Temperature:
5259 ID: ExprTemperature
5260 Description:
5261 Temperature at given block.
5262 Since:
5263 2.2-dev35
5264 Return type: double
5265 Changers:
5266 none
5267 Patterns:
5268 [the] temperature[s] of %blocks%
5269 %blocks%'[s] temperature[s]
5270 Ternary:
5271 ID: ExprTernary
5272 Description:
5273 A shorthand expression for returning something based on a condition.
5274 Examples:
5275 set {points} to 500 if {admin::%player's uuid%} is set else 100
5276 Since:
5277 2.2-dev36
5278 Return type: Object
5279 Changers:
5280 none
5281 Patterns:
5282 %objects% if <.+>[,] (otherwise|else) %objects%
5283 Time:
5284 ID: ExprTime
5285 Description:
5286 The time of a world.
5287 Examples:
5288 time in world is between 18:00 and 6:00:
5289 broadcast "It's night-time, watch out for monsters!"
5290 Since:
5291 1.0
5292 Return type: Time
5293 Changers:
5294 add
5295 set
5296 remove
5297 Patterns:
5298 [the] time[s] [([with]in|of) %worlds%]
5299 %worlds%'[s] time[s]
5300 Tool:
5301 ID: ExprTool
5302 Description:
5303 The item a player is holding.
5304 Examples:
5305 player is holding a pickaxe
5306 # is the same as
5307 player's tool is a pickaxe
5308 player's off hand tool is shield #Only for Minecraft 1.9
5309 Since:
5310 1.0
5311 Return type: Inventory Slot
5312 Changers:
5313 add
5314 set
5315 remove
5316 remove all
5317 delete
5318 Patterns:
5319 [the] (off[(-| )]tool|off[(-| )][held ]item|off[(-| )]weapon) [of %livingentities%]
5320 %livingentities%'[s] (off[(-| )]tool|off[(-| )][held ]item|off[(-| )]weapon)
5321 [the] (off[ ]hand tool|off[ ] hand item|shield[ item]) [of %livingentities%]
5322 %livingentities%'[s] (off[ ]hand tool|off[ ] hand item|shield[ item])
5323 Tool:
5324 ID: ExprTool
5325 Description:
5326 The item a player is holding.
5327 Examples:
5328 player is holding a pickaxe
5329 # is the same as
5330 player's tool is a pickaxe
5331 player's off hand tool is shield #Only for Minecraft 1.9
5332 Since:
5333 1.0
5334 Return type: Inventory Slot
5335 Changers:
5336 add
5337 set
5338 remove
5339 remove all
5340 delete
5341 Patterns:
5342 [the] (tool|held item|weapon) [of %livingentities%]
5343 %livingentities%'[s] (tool|held item|weapon)
5344 Type of:
5345 ID: ExprTypeOf
5346 Description:
5347 The type of a block/item or entity. The type of an item is only it's id and data value, i.e. it ignores the amount, enchantments etc., and the type of an entity is e.g. 'wolf' or 'player'.
5348 Examples:
5349 on rightclick on an entity:
5350 message "This is a %type of clicked entity%!"
5351 Since:
5352 1.4
5353 Return type: Object
5354 Changers:
5355 unknown
5356 Patterns:
5357 [the] type of %entitydatas/itemstacks/inventories%
5358 %entitydatas/itemstacks/inventories%'[s] type
5359 UUID:
5360 ID: ExprUUID
5361 Description:
5362 The UUID of a player, entity or world.
5363 In the future there will be an option to use a player's UUID instead of the name in variable names (i.e. when %player% is used), but for now this can be used.
5364 Please note that this expression does not work for offline players if you are under 1.8!
5365 Examples:
5366 # prevents people from joining the server if they use the name of a player
5367 # who has played on this server at least once since this script has been added
5368 on login:
5369 {uuids.%name of player%} exists:
5370 {uuids.%name of player%} is not UUID of player
5371 kick player due to "Someone with your name has played on this server before"
5372 else:
5373 set {uuids.%name of player%} to UUID of player
5374 Since:
5375 2.1.2, 2.2 (offline players' UUIDs), 2.2-dev24 (other entities' UUIDs)
5376 Return type: Text
5377 Changers:
5378 none
5379 Patterns:
5380 [the] UUID of %offlineplayers/worlds/entities%
5381 %offlineplayers/worlds/entities%'[s] UUID
5382 Unbreakable Items:
5383 ID: ExprUnbreakable
5384 Description:
5385 Creates unbreakable copies of given items.
5386 Examples:
5387 unbreakable iron sword #Creates unbreakable iron sword
5388 Since:
5389 2.2-dev13b
5390 Return type: Item Type
5391 Changers:
5392 none
5393 Patterns:
5394 unbreakable %itemtypes%
5395 Unix Timestamp:
5396 ID: ExprUnixTicks
5397 Description:
5398 Converts given date to Unix timestamp. This is roughly how many seconds have elapsed since 1 January 1970.
5399 Examples:
5400 unix timestamp of now
5401 Since:
5402 2.2-dev31
5403 Return type: Number
5404 Changers:
5405 none
5406 Patterns:
5407 [the] unix timestamp of %dates%
5408 %dates%'[s] unix timestamp
5409 Upper/lower Case Text:
5410 ID: ExprStringCase
5411 Description:
5412 Copy of given text in upper or lower case.
5413 Examples:
5414 "oops!" in upper case # OOPS!
5415 Since:
5416 2.2-dev16
5417 Return type: Text
5418 Changers:
5419 none
5420 Patterns:
5421 %string% in (upper|lower) case
5422 capitalized %string%
5423 Vectors - Angle between:
5424 ID: ExprVectorAngleBetween
5425 Description:
5426 Gets the angle between two vectors
5427 Examples:
5428 send "%angle between vector 1, 0, 0 and vector 0, 1, 1%"
5429 Since:
5430 2.2-dev28
5431 Return type: float
5432 Changers:
5433 none
5434 Patterns:
5435 angle between %vector% and %vector%
5436 Vectors - Arithmetic:
5437 ID: ExprVectorArithmetic
5438 Description:
5439 Arithmetic expressions for vectors
5440 Examples:
5441 set {_v} to vector 1, 2, 3 // 5
5442 set {_v} to {_v} ++ {_v}
5443 set {_v} to {_v} ++ 5
5444 set {_v} to {_v} -- {_v}
5445 set {_v} to {_v} -- 5
5446 set {_v} to {_v} ** {_v}
5447 set {_v} to {_v} ** 5
5448 set {_v} to {_v} // {_v}
5449 set {_v} to {_v} // 5
5450 Since:
5451 2.2-dev28
5452 Return type: Vector
5453 Changers:
5454 none
5455 Patterns:
5456 %vector%[ ]++[ ]%vector%
5457 %vector%[ ]--[ ]%vector%
5458 %vector%[ ]**[ ]%vector%
5459 %vector%[ ]//[ ]%vector%
5460 Vectors - Between locations:
5461 ID: ExprVectorBetweenLocations
5462 Description:
5463 Creates a vector between two locations
5464 Examples:
5465 set {_v} to vector between {_loc1} and {_loc2}
5466 Since:
5467 2.2-dev28
5468 Return type: Vector
5469 Changers:
5470 none
5471 Patterns:
5472 vector (from|between) %location% (to|and) %location%
5473 Vectors - Coordinate:
5474 ID: ExprVectorXYZ
5475 Description:
5476 Gets or sets the x, y or z coordinate of a vector
5477 Examples:
5478 set {_v} to vector 1, 2, 3
5479 send "%x of {_v}%, %y of {_v}%, %z of {_v}%"
5480 add 1 to x of {_v}
5481 add 2 to y of {_v}
5482 add 3 to z of {_v}
5483 send "%x of {_v}%, %y of {_v}%, %z of {_v}%"
5484 set x of {_v} to 1
5485 set y of {_v} to 2
5486 set z of {_v} to 3
5487 send "%x of {_v}%, %y of {_v}%, %z of {_v}%"
5488 Since:
5489 2.2-dev28
5490 Return type: Number
5491 Changers:
5492 unknown
5493 Patterns:
5494 (x|y|z) of %vector%
5495 Vectors - Create from XYZ:
5496 ID: ExprVectorFromXYZ
5497 Description:
5498 Creates a vector from an x, y and z value
5499 Examples:
5500 set {_v} to vector 0, 1, 0
5501 Since:
5502 2.2-dev28
5503 Return type: Vector
5504 Changers:
5505 none
5506 Patterns:
5507 [new] vector [(from|at|to)] %number%,[ ]%number%(,[ ]| and )%number%
5508 Vectors - Create from location:
5509 ID: ExprVectorOfLocation
5510 Description:
5511 Creates a vector from a location
5512 Examples:
5513 set {_v} to vector of {_loc}
5514 Since:
5515 2.2-dev28
5516 Return type: Vector
5517 Changers:
5518 none
5519 Patterns:
5520 vector (of|from|to) %location%
5521 %location%['s] vector
5522 Vectors - Create from pitch and yaw:
5523 ID: ExprVectorFromYawAndPitch
5524 Description:
5525 Creates a vector from a yaw and pitch value
5526 Examples:
5527 set {_v} to vector from yaw 45 and pitch 45
5528 Since:
5529 2.2-dev28
5530 Return type: Vector
5531 Changers:
5532 none
5533 Patterns:
5534 [new] vector from yaw %number% and pitch %number%
5535 Vectors - Cross product:
5536 ID: ExprVectorCrossProduct
5537 Description:
5538 Gets the cross product between two vectors
5539 Examples:
5540 send "%vector 1, 0, 0 cross vector 0, 1, 0%"
5541 Since:
5542 2.2-dev28
5543 Return type: Vector
5544 Changers:
5545 none
5546 Patterns:
5547 %vector% cross %vector%
5548 Vectors - Cylindrical shape:
5549 ID: ExprVectorCylindrical
5550 Description:
5551 Forms a 'cylindrical shaped' vector using yaw to manipulate the current point
5552 Examples:
5553 loop 360 times:
5554 set {_v} to cylindrical vector radius 1, yaw loop-value, height 2
5555 set {_v} to cylindrical vector radius 1, yaw 90, height 2
5556 Since:
5557 2.2-dev28
5558 Return type: Vector
5559 Changers:
5560 none
5561 Patterns:
5562 [new] cylindrical vector [(from|with)] [radius] %number%, [yaw] %number%(,| and) [height] %number%
5563 Vectors - Dot product:
5564 ID: ExprVectorDotProduct
5565 Description:
5566 Gets the dot product between two vectors
5567 Examples:
5568 set {_v} to {_v2} dot {_v3}
5569 Since:
5570 2.2-dev28
5571 Return type: double
5572 Changers:
5573 none
5574 Patterns:
5575 %vector% dot %vector%
5576 Vectors - Length:
5577 ID: ExprVectorLength
5578 Description:
5579 Gets or sets the length of a vector
5580 Examples:
5581 send "%standard length of vector 1, 2, 3%"
5582 set {_v} to vector 1, 2, 3
5583 set standard length of {_v} to 2
5584 send "%standard length of {_v}%"
5585 Since:
5586 2.2-dev28
5587 Return type: double
5588 Changers:
5589 add
5590 set
5591 remove
5592 Patterns:
5593 (vector|standard|normal) length of %vector%
5594 %vector%['s] (vector|standard|normal) length
5595 Vectors - Location vector offset:
5596 ID: ExprLocationVectorOffset
5597 Description:
5598 Offset a location by a vector
5599 Examples:
5600 set {_loc} to {_loc} ~ {_v}
5601 Since:
5602 2.2-dev28
5603 Return type: Location
5604 Changers:
5605 none
5606 Patterns:
5607 %location%[ ]~[~][ ]%vectors%
5608 Vectors - Normalize:
5609 ID: ExprVectorNormalize
5610 Description:
5611 Normalizes a vector
5612 Examples:
5613 set {_v} to {_v} normalized
5614 Since:
5615 2.2-dev28
5616 Return type: Vector
5617 Changers:
5618 none
5619 Patterns:
5620 normalize %vector%
5621 %vector% normalized
5622 Vectors - Random:
5623 ID: ExprVectorRandom
5624 Description:
5625 Creates a random vector
5626 Examples:
5627 set {_v} to random vector
5628 Since:
5629 2.2-dev28
5630 Return type: Vector
5631 Changers:
5632 none
5633 Patterns:
5634 random vector
5635 Vectors - Spherical shape:
5636 ID: ExprVectorSpherical
5637 Description:
5638 Forms a 'spherical shaped' vector using yaw and pitch to manipulate the current point
5639 Examples:
5640 loop 360 times:
5641 set {_v} to spherical vector radius 1, yaw loop-value, pitch loop-value
5642 set {_v} to spherical vector radius 1, yaw 45, pitch 90
5643 Since:
5644 2.2-dev28
5645 Return type: Vector
5646 Changers:
5647 none
5648 Patterns:
5649 [new] spherical vector [(from|with)] [radius] %number%, [yaw] %number%(,| and) [pitch] %number%
5650 Vectors - Squared length:
5651 ID: ExprVectorSquaredLength
5652 Description:
5653 Gets the squared length of a vector
5654 Examples:
5655 send "%squared length of vector 1, 2, 3%"
5656 Since:
5657 2.2-dev28
5658 Return type: double
5659 Changers:
5660 none
5661 Patterns:
5662 squared length of %vector%
5663 %vector%['s] squared length
5664 Vectors - Velocity:
5665 ID: ExprVelocity
5666 Description:
5667 Gets, sets, adds or removes velocity to/from/of an entity
5668 Examples:
5669 set player's velocity to {_v}
5670 Since:
5671 2.2-dev31
5672 Return type: Vector
5673 Changers:
5674 add
5675 set
5676 remove
5677 delete
5678 Patterns:
5679 [the] velocity of %entities%
5680 %entities%'[s] velocity
5681 Vectors - Yaw and pitch:
5682 ID: ExprVectorYawPitch
5683 Description:
5684 Gets or sets the yaw or pitch value of a vector
5685 Examples:
5686 set {_v} to vector -1, 1, 1
5687 send "%vector yaw of {_v}%, %vector pitch of {_v}%"
5688 add 45 to vector yaw of {_v}
5689 subtract 45 from vector pitch of {_v}
5690 send "%vector yaw of {_v}%, %vector pitch of {_v}%"
5691 set vector yaw of {_v} to -45
5692 set vector pitch of {_v} to 45
5693 send "%vector yaw of {_v}%, %vector pitch of {_v}%"
5694 Since:
5695 2.2-dev28
5696 Return type: Number
5697 Changers:
5698 unknown
5699 Patterns:
5700 vector (yaw|pitch) of %vector%
5701 Vehicle:
5702 ID: ExprVehicle
5703 Description:
5704 The vehicle an entity is in, if any. This can actually be any entity, e.g. spider jockeys are skeletons that ride on a spider, so the spider is the 'vehicle' of the skeleton.
5705 See also: passenger
5706 Examples:
5707 vehicle of the player is a minecart
5708 Since:
5709 2.0
5710 Return type: Entity
5711 Changers:
5712 add
5713 set
5714 remove
5715 remove all
5716 Patterns:
5717 [the] vehicle[s] of %entities%
5718 %entities%'[s] vehicle[s]
5719 Version:
5720 ID: ExprVersion
5721 Description:
5722 The version of Bukkit, Minecraft or Skript respectively.
5723 Examples:
5724 message "This server is running Minecraft %minecraft version% on Bukkit %bukkit version%"
5725 message "This server is powered by Skript %skript version%"
5726 Since:
5727 2.0
5728 Return type: Text
5729 Changers:
5730 none
5731 Patterns:
5732 ([craft]bukkit|minecraft|skript)( |-)version
5733 Weather:
5734 ID: ExprWeather
5735 Description:
5736 The weather in the given or the current world.
5737 Examples:
5738 set weather to clear
5739 weather in "world" is rainy
5740 Since:
5741 1.0
5742 Return type: Weather Type
5743 Changers:
5744 set
5745 delete
5746 Patterns:
5747 [the] weather [(in|of) %worlds%]
5748 %worlds%'[s] weather
5749 World:
5750 ID: ExprWorld
5751 Description:
5752 The world the event occurred in.
5753 Examples:
5754 world is "world_nether"
5755 teleport the player to the world's spawn
5756 set the weather in the player's world to rain
5757 Since:
5758 1.0
5759 Return type: World
5760 Changers:
5761 set
5762 Patterns:
5763 [the] world [of %locations/entities%]
5764 %locations/entities%'[s] world
5765 World Seed:
5766 ID: ExprSeed
5767 Description:
5768 The seed of given world. Note that it will be returned as Minecraft internally treats seeds, not as you specified it in world configuration.
5769 Examples:
5770 broadcast "Seed: %seed of player's world%"
5771 Since:
5772 2.2-dev35
5773 Return type: long
5774 Changers:
5775 none
5776 Patterns:
5777 [the] seed[s] (from|of) %worlds%
5778 %worlds%'[s] seed[s]
5779 Worlds:
5780 ID: ExprWorlds
5781 Description:
5782 All worlds of the server, useful for looping.
5783 Examples:
5784 loop all worlds:
5785 broadcast "You're in %loop-world%" to loop-world
5786 Since:
5787 1.0
5788 Return type: World
5789 Changers:
5790 none
5791 Patterns:
5792 [(all [[of] the]|the)] worlds
5793 X of Item:
5794 ID: ExprXOf
5795 Description:
5796 An expression to be able to use a certain amount of items where the amount can be any expression. Please note that is expression is not stable and might be replaced in the future.
5797 Examples:
5798 give level of player of pickaxes to the player
5799 Since:
5800 1.2
5801 Return type: Object
5802 Changers:
5803 unknown
5804 Patterns:
5805 %number% of %itemstacks/entitytype%
5806 Yaw / Pitch:
5807 ID: ExprYawPitch
5808 Description:
5809 The yaw or pitch of a location. You likely won't need this expression ever if you don't know what this means.
5810 Examples:
5811 log "%player%: %location of player%, %player's yaw%, %player's pitch%" to "playerlocs.log"
5812 Since:
5813 2.0
5814 Return type: Number
5815 Changers:
5816 add
5817 set
5818 remove
5819 Patterns:
5820 [the] (yaw|pitch) of %locations%
5821 %locations%'[s] (yaw|pitch)
5822Types:
5823 Biome:
5824 ID: Biome
5825 Description:
5826 All possible biomes Minecraft uses to generate a world.
5827 Examples:
5828 biome at the player is desert
5829 Usage: Biome names; you can use F3 ingame
5830 Since:
5831 1.4.4
5832 Patterns:
5833 biome[s]
5834 Block:
5835 ID: Block
5836 Description:
5837 A block in a world. It has a location and a type, and can also have a direction (mostly a facing), an inventory, or other special properties.
5838 Since:
5839 1.0
5840 Patterns:
5841 block[s]
5842 Boolean:
5843 ID: Boolean
5844 Description:
5845 A boolean is a value that is either true or false. Other accepted names are 'on' and 'yes' for true, and 'off' and 'no' for false.
5846 Examples:
5847 set {config.%player%.use mod} to false
5848 Usage: true/yes/on or false/no/off
5849 Since:
5850 1.0
5851 Patterns:
5852 boolean[s]
5853 Chunk:
5854 ID: Chunk
5855 Description:
5856 A chunk is a cuboid of 16×16×128 (x×z×y) blocks. Chunks are spread on a fixed rectangular grid in their world.
5857 Since:
5858 2.0
5859 Patterns:
5860 chunk[s]
5861 Click Type:
5862 ID: ClickType
5863 Description:
5864 Click type, mostly for inventory events. Tells exactly which keys/buttons player pressed, assuming that default keybindings are used in client side.
5865 Usage: left mouse button, left mouse button with shift, right mouse button, right mouse button with shift, window border using right mouse button, window border using left mouse button, middle mouse button, number key, double click using mouse, drop key, drop key with control, creative action, unknown
5866 Since:
5867 2.2-dev16b, 2.2-dev35 (renamed to click type)
5868 Patterns:
5869 click type[s]
5870 Colour:
5871 ID: Color
5872 Description:
5873 Wool, dye and chat colours.
5874 Examples:
5875 color of the sheep is red or black
5876 set the colour of the block to green
5877 message "You're holding a <%color of tool%>%color of tool%<reset> wool block"
5878 Usage: black, dark grey/dark gray, grey/light grey/gray/light gray/silver, white, blue/dark blue, cyan/aqua/dark cyan/dark aqua, light blue/light cyan/light aqua, green/dark green, light green/lime/lime green, yellow/light yellow, orange/gold/dark yellow, red/dark red, pink/light red, purple/dark purple, magenta/light purple, brown/indigo
5879 Patterns:
5880 colo[u]r[s]
5881 Command Sender:
5882 ID: CommandSender
5883 Description:
5884 A player or the console.
5885 Examples:
5886 on command /pm:
5887 command sender is not the console
5888 chance of 10%
5889 give coal to the player
5890 message "You got a piece of coal for sending that PM!"
5891 Usage: use the console for the console
5892see player for players.
5893 Since:
5894 1.0
5895 Patterns:
5896 [command[s]][ ](sender|executor)[s]
5897 Damage Cause:
5898 ID: DamageCause
5899 Description:
5900 The cause/type of a damage event, e.g. lava, fall, fire, drowning, explosion, poison, etc.
5901 Please note that support for this type is very rudimentary, e.g. lava, fire and burning, as well as projectile and attack are considered different types.
5902 Usage: contact, attack, projectile, suffocation, fall, fire, burning, melting, lava, drowning, block explosion, entity explosion, void, lightning, suicide, starvation, poison, potion, wither, falling block, thorns, unknown
5903 Since:
5904 2.0
5905 Patterns:
5906 damage cause[s]
5907 Date:
5908 ID: Date
5909 Description:
5910 A date is a certain point in the real world's time which can currently only be obtained with now.
5911 See time and timespan for the other time types of Skript.
5912 Examples:
5913 set {_yesterday} to now
5914 subtract a day from {_yesterday}
5915 # now {_yesterday} represents the date 24 hours before now
5916 Since:
5917 1.4
5918 Patterns:
5919 date[s]
5920 Direction:
5921 ID: Direction
5922 Description:
5923 A direction, e.g. north, east, behind, 5 south east, 1.3 meters to the right, etc.
5924 Locations and some blocks also have a direction, but without a length.
5925 Please note that directions have changed extensively in the betas and might not work perfectly. They can also not be used as command arguments.
5926 Examples:
5927 set the block below the victim to a chest
5928 loop blocks from the block infront of the player to the block 10 below the player:
5929 set the block behind the loop-block to water
5930 Usage: see direction (expression)
5931 Since:
5932 2.0
5933 Patterns:
5934 direction[s]
5935 Enchantment:
5936 ID: Enchantment
5937 Description:
5938 An enchantment, e.g. 'sharpness' or 'furtune'. Unlike enchantment type this type has no level, but you usually don't need to use this type anyway.
5939 Usage: Protection, Fire Protection, Feather Falling, Blast Protection, Projectile Protection, Respiration, Aqua Affinity, Thorns, Depth Strider, Sharpness, Smite, Bane of Arthropods, Knockback, Fire Aspect, Looting, Efficiency, Silk Touch, Unbreaking, Fortune, Power, Punch, Flame, Infinity, Luck of the Sea, Lure
5940 Since:
5941 1.4.6
5942 Patterns:
5943 enchantment[s]
5944 Enchantment Type:
5945 ID: EnchantmentType
5946 Description:
5947 An enchantment with an optional level, e.g. 'sharpness 2' or 'fortune'.
5948 Examples:
5949 enchant the player's tool with sharpness 5
5950 helmet is enchanted with waterbreathing
5951 Usage: <enchantment> [<level>]
5952 Since:
5953 1.4.6
5954 Patterns:
5955 enchant(ing|ment) type[s]
5956 Entity:
5957 ID: Entity
5958 Description:
5959 An entity is something in a world that's not a block, e.g. a player, a skeleton, or a zombie, but also projectiles like arrows, fireballs or thrown potions, or special entities like dropped items, falling blocks or paintings.
5960 Examples:
5961 entity is a zombie or creeper
5962 player is an op
5963 projectile is an arrow
5964 shoot a fireball from the player
5965 Usage: player, op, wolf, tamed ocelot, powered creeper, zombie, unsaddled pig, fireball, arrow, dropped item, item frame, etc.
5966 Since:
5967 1.0
5968 Patterns:
5969 entit(y|ies)
5970 Entity Type:
5971 ID: EntityData
5972 Description:
5973 The type of an entity, e.g. player, wolf, powered creeper, etc.
5974 Examples:
5975 victim is a cow
5976 spawn a creeper
5977 Usage: Detailed usage will be added eventually
5978 Since:
5979 1.3
5980 Patterns:
5981 entity[ ]type[s]
5982 Game Mode:
5983 ID: GameMode
5984 Description:
5985 The game modes survival, creative and adventure.
5986 Examples:
5987 player's gamemode is survival
5988 set the player argument's game mode to creative
5989 Usage: creative/survival/adventure
5990 Since:
5991 1.0
5992 Patterns:
5993 game[ ]mode[s]
5994 Inventory:
5995 ID: Inventory
5996 Description:
5997 An inventory of a player or block. Inventories have many effects and conditions regarding the items contained.
5998 An inventory has a fixed amount of slots which represent a specific place in the inventory, e.g. the helmet slot for players (Please note that slot support is still very limited but will be improved eventually).
5999 Since:
6000 1.0
6001 Patterns:
6002 inventor(y|ies)
6003 Inventory Action:
6004 ID: InventoryAction
6005 Description:
6006 What player just did in inventory event. Note that when in creative game mode, most actions do not work correctly.
6007 Usage: nothing, pickup all, pickup some, pickup half, pickup one item, place all, place some, place one, swap with cursor, drop all from cursor, drop one from cursor, drop all from slot, drop one from slot, instant move, hotbar move and readd, swap with hotbar, clone stack, collect to cursor, unknown
6008 Since:
6009 2.2-dev16
6010 Patterns:
6011 inventory action[s]
6012 Inventory Slot:
6013 ID: Slot
6014 Description:
6015 Represents a single slot of an inventory. Notable slots are the armour slots and furnace slots.
6016 The most important property that distinguishes a slot from an item is its ability to be changed, e.g. it can be set, deleted, enchanted, etc. (Some item expressions can be changed as well, e.g. items stored in variables. For that matter: slots are never saved to variables, only the items they represent at the time when the variable is set).
6017 Please note that tool can be regarded a slot, but it can actually change it's position, i.e. doesn't represent always the same slot.
6018 Examples:
6019 set tool of player to dirt
6020 delete helmet of the victim
6021 set the colour of the player's tool to green
6022 enchant the player's chestplate with projectile protection 5
6023 Patterns:
6024 [inventory ]slot[s]
6025 Inventory Type:
6026 ID: InventoryType
6027 Description:
6028 Minecraft has several different inventory types with their own use cases.
6029 Usage: chest inventory, dispenser inventory, dropper inventory, furnace inventory, workbench inventory, crafting table inventory, enchanting table inventory, brewing stand inventory, player inventory, creative inventory, merchant inventory, ender chest inventory, anvil inventory, beacon inventory, hopper inventory
6030 Since:
6031 2.2-dev32
6032 Patterns:
6033 inventory type[s]
6034 Item / Material:
6035 ID: ItemStack
6036 Description:
6037 An item, e.g. a stack of torches, a furnace, or a wooden sword of sharpness 2. Unlike item type an item can only represent exactly one item (e.g. an upside-down cobblestone stair facing west), while an item type can represent a whole range of items (e.g. any cobble stone stairs regardless of direction).
6038 You don't usually need this type except when you want to make a command that only accepts an exact item.
6039 Please note that currently 'material' is exactly the same as 'item', i.e. can have an amount & enchantments.
6040 Examples:
6041 set {_item} to type of the targeted block
6042 {_item} is a torch
6043 Usage: [<number> [of]] <alias> [of <enchantment> <level>], Where <alias> must be an alias that represents exactly one item (i.e cannot be a general alias like 'sword' or 'plant')
6044 Since:
6045 1.0
6046 Patterns:
6047 item
6048 material
6049 Item Type:
6050 ID: ItemType
6051 Description:
6052 An item type is an alias, e.g. 'a pickaxe', 'all plants', etc., and can result in different items when added to an inventory, and unlike items they are well suited for checking whether an inventory contains a certain item or whether a certain item is of a certain type.
6053 An item type can also have one or more enchantments with or without a specific level defined, and can optionally start with 'all' or 'every' to make this item type represent all types that the alias represents, including data ranges.
6054 Examples:
6055 give 4 torches to the player
6056 add all slabs to the inventory of the block
6057 player's tool is a diamond sword of sharpness
6058 remove a pickaxes of fortune 4 from {stored items::*}
6059 set {_item} to 10 of every upside-down stair
6060 block is dirt or farmland
6061 Usage: [<number> [of]] [all/every] <alias> [of <enchantment> [<level>] [,/and <more enchantments...>]]
6062 Since:
6063 1.0
6064 Patterns:
6065 item[ ]type[s]
6066 items
6067 materials
6068 Living Entity:
6069 ID: LivingEntity
6070 Description:
6071 A living entity, i.e. a mob or player, not inanimate entities like projectiles or dropped items.
6072 Examples:
6073 spawn 5 powered creepers
6074 shoot a zombie from the creeper
6075 Usage: see entity, but ignore inanimate objects
6076 Since:
6077 1.0
6078 Patterns:
6079 living[ ]entit(y|ies)
6080 Location:
6081 ID: Location
6082 Description:
6083 A location in a world. Locations are world-specific and even store a direction, e.g. if you save a location and later teleport to it you will face the exact same direction you did when you saved the location.
6084 Since:
6085 1.0
6086 Patterns:
6087 location[s]
6088 Metadata Holder:
6089 ID: Metadatable
6090 Description:
6091 Something that can hold metadata (e.g. an entity or block)
6092 Examples:
6093 set metadata value "super cool" of player to true
6094 Since:
6095 2.2-dev36
6096 Patterns:
6097 metadata holder[s]
6098 Number:
6099 ID: Number
6100 Description:
6101 A number, e.g. 2.5, 3, or -9812454.
6102 Please note that many expressions only need integers, i.e. will discard any frational parts of any numbers without producing an error.
6103 Examples:
6104 set the player's health to 5.5
6105 set {_temp} to 2*{_temp} - 2.5
6106 Usage: [-]###[.###]</code> (any amount of digits; very large numbers will be truncated though)
6107 Since:
6108 1.0
6109 Patterns:
6110 num[ber][s]
6111 Object:
6112 ID: Object
6113 Description:
6114 The supertype of all types, meaning that if %object% is used in e.g. a condition it will accept all kinds of expressions.
6115 Since:
6116 1.0
6117 Patterns:
6118 object[s]
6119 Offlineplayer:
6120 ID: OfflinePlayer
6121 Description:
6122 A player that is possibly offline. See player for more information. Please note that while all effects and conditions that require a player can be used with an offline player as well, they will not work if the player is not actually online.
6123 Patterns:
6124 offline[ ]player[s]
6125 Player:
6126 ID: Player
6127 Description:
6128 A player. Depending on whether a player is online or offline several actions can be performed with them, though you won't get any errors when using effects that only work if the player is online (e.g. changing his inventory) on an offline player.
6129 You have two possibilities to use players as command arguments: <player> and <offline player>. The first requires that the player is online and also accepts only part of the name, while the latter doesn't require that the player is online, but the player's name has to be entered exactly.
6130 Since:
6131 1.0
6132 Patterns:
6133 player[s]
6134 Potion Effect Type:
6135 ID: PotionEffectType
6136 Description:
6137 A potion effect type, e.g. 'strength' or 'swiftness'.
6138 Examples:
6139 apply swiftness 5 to the player
6140 apply potion of speed 2 to the player for 60 seconds
6141 remove invisibility from the victim
6142 Usage: null, speed, slowness, haste, mining fatigue, strength, instant health, instant damage, jump boost, nausea, regeneration, resistance, fire resistance, water breathing, invisibility, blindness, night vision, hunger, weakness, poison, wither, health boost, absorption, saturation
6143 Patterns:
6144 potion[[ ]effect][[ ]type][s]
6145 Projectile:
6146 ID: Projectile
6147 Description:
6148 A projectile, e.g. an arrow, snowball or thrown potion.
6149 Examples:
6150 projectile is a snowball
6151 shoot an arrow at speed 5 from the player
6152 Usage: arrow, fireball, snowball, thrown potion, etc.
6153 Since:
6154 1.0
6155 Patterns:
6156 projectile[s]
6157 Text:
6158 ID: String
6159 Description:
6160 Text is simply text, i.e. a sequence of characters, which can optionally contain expressions which will be replaced with a meaningful representation (e.g. %player% will be replaced with the player's name).
6161 Because scripts are also text, you have to put text into double quotes to tell Skript which part of the line is an effect/expression and which part is the text.
6162 Please read the article on Texts and Variable Names to learn more.
6163 Examples:
6164 broadcast "Hello World!"
6165 message "Hello %player%"
6166 message "The id of ""%type of tool%"" is %id of tool%."
6167 Usage: simple: "..."
6168quotes: "...""..."
6169expressions: "...%expression%..."
6170percent signs: "...%%..."
6171 Since:
6172 1.0
6173 Patterns:
6174 (text|string)[s]
6175 Time:
6176 ID: Time
6177 Description:
6178 A time is a point in a minecraft day's time (i.e. ranges from 0:00 to 23:59), which can vary per world.
6179 See date and timespan for the other time types of Skript.
6180 Examples:
6181 at 20:00:
6182 time is 8 pm
6183 broadcast "It's %time%"
6184 Usage: ##:##
6185##[:##][ ]am/pm
6186 Since:
6187 1.0
6188 Patterns:
6189 time[s]
6190 Timeperiod:
6191 ID: Timeperiod
6192 Description:
6193 A period of time between two times. Mostly useful since you can use this to test for whether it's day, night, dusk or dawn in a specific world.
6194 This type might be removed in the future as you can use 'time of world is between x and y' as a replacement.
6195 Examples:
6196 time in world is night
6197 Usage: ##:## - ##:##
6198dusk/day/dawn/night
6199 Since:
6200 1.0
6201 Patterns:
6202 time[ ]period[s]
6203 duration[s]
6204 Timespan:
6205 ID: Timespan
6206 Description:
6207 A timespan is a difference of two different dates or times, e.g '10 minutes'. Timespans are always displayed as real life time, but can be defined as minecraft time, e.g. '5 minecraft days and 12 hours'.
6208 See date and time for the other time types of Skript.
6209 Examples:
6210 every 5 minecraft days:
6211 wait a minecraft second and 5 ticks
6212 every 10 mc days and 12 hours:
6213 halt for 12.7 irl minutes, 12 hours and 120.5 seconds
6214 Usage: <number> [minecraft/mc/real/rl/irl] ticks/seconds/minutes/hours/days [[,/and] <more...>]
6215[###:]##:##[.####] ([hours:]minutes:seconds[.milliseconds])
6216 Since:
6217 1.0
6218 Patterns:
6219 time[ ]span[s]
6220 Tree Type:
6221 ID: StructureType
6222 Description:
6223 A tree type represents a tree species or a huge mushroom species. These can be generated in a world with the generate tree effect.
6224 Examples:
6225 grow any regular tree at the block
6226 grow a huge red mushroom above the block
6227 Usage: [any] <general tree/mushroom type>, e.g. tree/any jungle tree/etc.
6228<specific tree/mushroom species>, e.g. red mushroom/small jungle tree/big regular tree/etc.
6229 Patterns:
6230 tree[ ]type[s]
6231 tree[s]
6232 Type:
6233 ID: ClassInfo
6234 Description:
6235 Represents a type, e.g. number, object, item type, location, block, world, entity type, etc.
6236 This is mostly used for expressions like 'event-<type>', '<type>-argument', 'loop-<type>', etc., e.g. event-world, number-argument and loop-player.
6237 Examples:
6238 {variable} is a number # check whether the variable contains a number, e.g. -1 or 5.5
6239 {variable} is a type # check whether the variable contains a type, e.g. number or player
6240 {variable} is an object # will always succeed if the variable is set as everything is an object, even types.
6241 disable PvP in the event-world
6242 kill the loop-entity
6243 Usage: See the type name patterns of all types - including this one
6244 Since:
6245 2.0
6246 Patterns:
6247 type[s]
6248 Vector:
6249 ID: Vector
6250 Description:
6251 Vector is a collection of numbers. In Minecraft, 3D vectors are used to express velocities of entities.
6252 Usage: vector(x, y, z)
6253 Since:
6254 2.2-dev23
6255 Patterns:
6256 vector[s]
6257 Weather Type:
6258 ID: WeatherType
6259 Description:
6260 The weather types sunny, rainy, and thundering.
6261 Examples:
6262 is raining
6263 is sunny in the player's world
6264 message "It is %weather in the argument's world% in %world of the argument%"
6265 Usage: clear/sun/sunny, rain/rainy/raining, and thunder/thundering/thunderstorm
6266 Since:
6267 1.0
6268 Patterns:
6269 weather[ ]type[s]
6270 weather condition[s]
6271 weather[s]
6272 World:
6273 ID: World
6274 Description:
6275 One of the server's worlds. Worlds can be put into scripts by surrounding their name with double quotes, e.g. "world_nether", but this might not work reliably as text uses the same syntax.
6276 Examples:
6277 broadcast "Hello!" to the world "world_nether"
6278 Usage: "world_name", e.g. "world"
6279 Since:
6280 1.0, 2.2 (alternate syntax)
6281 Patterns:
6282 world[s]
6283Functions:
6284 abs:
6285 Description:
6286 Returns the absolute value of the argument, i.e. makes the argument positive.
6287 Examples:
6288 abs(3) = 3
6289 abs(-2) = 2
6290 Since:
6291 2.2
6292 Return type: Number
6293 Patterns:
6294 abs(n: number)
6295 acos:
6296 Description:
6297 The inverse of the cosine, also called arccos. Returns result in degrees, not radians. Only returns values from 0 to 180.
6298 Examples:
6299 acos(0) = 90
6300 acos(1) = 0
6301 acos(0.5) = 30
6302 Since:
6303 2.2
6304 Return type: Number
6305 Patterns:
6306 acos(n: number)
6307 asin:
6308 Description:
6309 The inverse of the sine, also called arcsin. Returns result in degrees, not radians. Only returns values from -90 to 90.
6310 Examples:
6311 asin(0) = 0
6312 asin(1) = 90
6313 asin(0.5) = 30
6314 Since:
6315 2.2
6316 Return type: Number
6317 Patterns:
6318 asin(n: number)
6319 atan:
6320 Description:
6321 The inverse of the tangent, also called arctan. Returns result in degrees, not radians. Only returns values from -90 to 90.
6322 Examples:
6323 atan(0) = 0
6324 atan(1) = 45
6325 atan(10000) = 89.9943
6326 Since:
6327 2.2
6328 Return type: Number
6329 Patterns:
6330 atan(n: number)
6331 atan2:
6332 Description:
6333 Similar to atan, but requires two coordinates and returns values from -180 to 180.
6334 The returned angle is measured counterclockwise in a standard mathematical coordinate system (x to the right, y to the top).
6335 Examples:
6336 atan2(0, 1) = 0
6337 atan2(10, 0) = 90
6338 atan2(-10, 5) = -63.4349
6339 Since:
6340 2.2
6341 Return type: Number
6342 Patterns:
6343 atan2(x: number, y: number)
6344 calcExperience:
6345 Description:
6346 Calculates experience needed to achieve given level in Minecraft.
6347 Since:
6348 2.2-dev32
6349 Return type: long
6350 Patterns:
6351 calcExperience(level: long)
6352 ceil:
6353 Description:
6354 Rounds a number up, i.e. returns the closest integer larger than or equal to the argument.
6355 Examples:
6356 ceil(2.34) = 3
6357 ceil(2) = 2
6358 ceil(2.99) = 3
6359 Since:
6360 2.2
6361 Return type: long
6362 Patterns:
6363 ceil(n: number)
6364 ceiling:
6365 Description:
6366 Alias of ceil.
6367 Examples:
6368 ceiling(2.34) = 3
6369 ceiling(2) = 2
6370 ceiling(2.99) = 3
6371 Since:
6372 2.2
6373 Return type: long
6374 Patterns:
6375 ceiling(n: number)
6376 cos:
6377 Description:
6378 The cosine function. This is basically the sine shifted by 90°, i.e. cos(a) = sin(a + 90°), for any number a. Uses degrees, not radians.
6379 Examples:
6380 cos(0) = 1
6381 cos(90) = 0
6382 Since:
6383 2.2
6384 Return type: Number
6385 Patterns:
6386 cos(n: number)
6387 date:
6388 Description:
6389 Creates a date from a year, month, and day, and optionally also from hour, minute, second and millisecond.
6390 A time zone and DST offset can be specified as well (in minutes), if they are left out the server's time zone and DST offset are used (the created date will not retain this information).
6391 Examples:
6392 date(2014, 10, 1) # 0:00, 1st October 2014
6393 date(1990, 3, 5, 14, 30) # 14:30, 5th May 1990
6394 date(1999, 12, 31, 23, 59, 59, 999, -3*60, 0) # almost year 2000 in parts of Brazil (-3 hours offset, no DST)
6395 Since:
6396 2.2
6397 Return type: Date
6398 Patterns:
6399 date(year: number, month: number, day: number, hour: number = [[integer:0]], minute: number = [[integer:0]], second: number = [[integer:0]], millisecond: number = [[integer:0]], zone_offset: number = [[double:NaN]], dst_offset: number = [[double:NaN]])
6400 exp:
6401 Description:
6402 The exponential function. You probably don't need this if you don't know what this is.
6403 Examples:
6404 exp(0) = 1
6405 exp(1) = 2.7183
6406 Since:
6407 2.2
6408 Return type: Number
6409 Patterns:
6410 exp(n: number)
6411 floor:
6412 Description:
6413 Rounds a number down, i.e. returns the closest integer smaller than or equal to the argument.
6414 Examples:
6415 floor(2.34) = 2
6416 floor(2) = 2
6417 floor(2.99) = 2
6418 Since:
6419 2.2
6420 Return type: long
6421 Patterns:
6422 floor(n: number)
6423 ln:
6424 Description:
6425 The natural logarithm. You probably don't need this if you don't know what this is.
6426 Returns NaN (not a number) if the argument is negative.
6427 Examples:
6428 ln(1) = 0
6429 ln(exp(5)) = 5
6430 ln(2) = 0.6931
6431 Since:
6432 2.2
6433 Return type: Number
6434 Patterns:
6435 ln(n: number)
6436 location:
6437 Description:
6438 Creates a location from a world and 3 coordinates, with an optional yaw and pitch.
6439 Examples:
6440 location(0, 128, 0)
6441 location(player's x-coordinate, player's y-coordinate + 5, player's z-coordinate, player's world, 0, 90)
6442 Since:
6443 2.2
6444 Return type: Location
6445 Patterns:
6446 location(x: number, y: number, z: number, world: world = event-world, yaw: number = [[integer:0]], pitch: number = [[integer:0]])
6447 log:
6448 Description:
6449 A logarithm, with base 10 if none is specified. This is the inverse operation to exponentiation (for positive bases only), i.e. log(base ^ exponent, base) = exponent for any positive number 'base' and any number 'exponent'.
6450 Another useful equation is base ^ log(a, base) = a for any numbers 'base' and 'a'.
6451 Please note that due to how numbers are represented in computers, these equations do not hold for all numbers, as the computed values may slightly differ from the correct value.
6452 Returns NaN (not a number) if any of the arguments are negative.
6453 Examples:
6454 log(100) = 2 # 10^2 = 100
6455 log(16, 2) = 4 # 2^4 = 16
6456 Since:
6457 2.2
6458 Return type: Number
6459 Patterns:
6460 log(n: number, base: number = [[integer:10]])
6461 max:
6462 Description:
6463 Returns the maximum number from a list of numbers.
6464 Examples:
6465 max(1) = 1
6466 max(1, 2, 3, 4) = 4
6467 max({some list variable::*})
6468 Since:
6469 2.2
6470 Return type: Number
6471 Patterns:
6472 max(ns: numbers)
6473 min:
6474 Description:
6475 Returns the minimum number from a list of numbers.
6476 Examples:
6477 min(1) = 1
6478 min(1, 2, 3, 4) = 1
6479 min({some list variable::*})
6480 Since:
6481 2.2
6482 Return type: Number
6483 Patterns:
6484 min(ns: numbers)
6485 mod:
6486 Description:
6487 Returns the modulo of the given arguments, i.e. the remainder of the division d/m, where d and m are the arguments of this function.
6488 The returned value is always positive. Returns NaN (not a number) if the second argument is zero.
6489 Examples:
6490 mod(3, 2) = 1
6491 mod(256436, 100) = 36
6492 mod(-1, 10) = 9
6493 Since:
6494 2.2
6495 Return type: Number
6496 Patterns:
6497 mod(d: number, m: number)
6498 product:
6499 Description:
6500 Calculates the product of a list of numbers.
6501 Examples:
6502 product(1) = 1
6503 product(2, 3, 4) = 24
6504 product({some list variable::*})
6505 product(2, {_v::*}, and the player's y-coordinate)
6506 Since:
6507 2.2
6508 Return type: Number
6509 Patterns:
6510 product(ns: numbers)
6511 round:
6512 Description:
6513 Rounds a number, i.e. returns the closest integer to the argument.
6514 Examples:
6515 round(2.34) = 2
6516 round(2) = 2
6517 round(2.99) = 3
6518 round(2.5) = 3
6519 Since:
6520 2.2
6521 Return type: long
6522 Patterns:
6523 round(n: number)
6524 sin:
6525 Description:
6526 The sine function. It starts at 0° with a value of 0, goes to 1 at 90°, back to 0 at 180°, to -1 at 270° and then repeats every 360°. Uses degrees, not radians.
6527 Examples:
6528 sin(90) = 1
6529 sin(60) = 0.866
6530 Since:
6531 2.2
6532 Return type: Number
6533 Patterns:
6534 sin(n: number)
6535 sqrt:
6536 Description:
6537 The square root, which is the inverse operation to squaring a number (for positive numbers only). This is the same as (argument) ^ (1/2) – other roots can be calculated via number ^ (1/root), e.g. set {_l} to {_volume}^(1/3).
6538 Returns NaN (not a number) if the argument is negative.
6539 Examples:
6540 sqrt(4) = 2
6541 sqrt(2) = 1.4142
6542 sqrt(-1) = NaN
6543 Since:
6544 2.2
6545 Return type: Number
6546 Patterns:
6547 sqrt(n: number)
6548 sum:
6549 Description:
6550 Sums a list of numbers.
6551 Examples:
6552 sum(1) = 1
6553 sum(2, 3, 4) = 9
6554 sum({some list variable::*})
6555 sum(2, {_v::*}, and the player's y-coordinate)
6556 Since:
6557 2.2
6558 Return type: Number
6559 Patterns:
6560 sum(ns: numbers)
6561 tan:
6562 Description:
6563 The tangent function. This is basically <a href='#sin'>sin(arg)/cos(arg)</code>. Uses degrees, not radians.
6564 Examples:
6565 tan(0) = 0
6566 tan(45) = 1
6567 tan(89.99) = 5729.5779
6568 Since:
6569 2.2
6570 Return type: Number
6571 Patterns:
6572 tan(n: number)
6573 vector:
6574 Description:
6575 Creates a new vector, which can be used with various expressions, effects and functions.
6576 Examples:
6577 vector(0, 0, 0)
6578 Since:
6579 2.2-dev23
6580 Return type: Vector
6581 Patterns:
6582 vector(x: number, y: number, z: number)
6583 world:
6584 Description:
6585 Gets a world from its name.
6586 Examples:
6587 set {_nether} to world("%{_world}%_nether")
6588 Since:
6589 2.2
6590 Return type: World
6591 Patterns:
6592 world(name: string)