|
1 |
| -/** |
2 |
| - * This file is part of Skript. |
3 |
| - * |
4 |
| - * Skript is free software: you can redistribute it and/or modify |
5 |
| - * it under the terms of the GNU General Public License as published by |
6 |
| - * the Free Software Foundation, either version 3 of the License, or |
7 |
| - * (at your option) any later version. |
8 |
| - * |
9 |
| - * Skript is distributed in the hope that it will be useful, |
10 |
| - * but WITHOUT ANY WARRANTY; without even the implied warranty of |
11 |
| - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
12 |
| - * GNU General Public License for more details. |
13 |
| - * |
14 |
| - * You should have received a copy of the GNU General Public License |
15 |
| - * along with Skript. If not, see <http://www.gnu.org/licenses/>. |
16 |
| - * |
17 |
| - * Copyright Peter Güttinger, SkriptLang team and contributors |
18 |
| - */ |
19 | 1 | package ch.njol.skript.effects;
|
20 | 2 |
|
21 | 3 | import ch.njol.skript.Skript;
|
|
48 | 30 | import java.util.Set;
|
49 | 31 |
|
50 | 32 | @Name("Sort")
|
51 |
| -@Description({ |
52 |
| - "Sorts a list variable using either the natural ordering of the contents or the results of the given expression.", |
53 |
| - "Be warned, this will overwrite the indices of the list variable." |
54 |
| -}) |
| 33 | +@Description(""" |
| 34 | + Sorts a list variable using either the natural ordering of the contents or the results of the given expression. |
| 35 | + Be warned, this will overwrite the indices of the list variable. |
| 36 | + |
| 37 | + When using the full <code>sort %~objects% (by|based on) <expression></code> pattern, |
| 38 | + the input expression can be used to refer to the current item being sorted. |
| 39 | + (See input expression for more information.)""") |
55 | 40 | @Examples({
|
56 | 41 | "set {_words::*} to \"pineapple\", \"banana\", \"yoghurt\", and \"apple\"",
|
57 | 42 | "sort {_words::*} # alphabetical sort",
|
|
0 commit comments