ScriptsLab
WikiDownloadsSourcesSupport
ScriptsLab
DocumentationDownloadsGitHubDiscord

© 2026 ScriptsLab

Back to wiki
M

script-api.md

Markdown · 890 lines · 21.0 KB

wiki/script-api.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
# 📜 Script API

Полный справочник по JavaScript API для ScriptsLab. Здесь описаны все доступные объекты и методы для создания скриптов.

---

## Глобальные объекты

При запуске скрипта вам доступны следующие глобальные объекты:

| Объект | Описание |
|--------|---------|
| `Console` | Логирование в консоль сервера |
| `Commands` | Регистрация команд |
| `Events` | Обработка событий |
| `Scheduler` | Планирование задач |
| `Players` | Управление игроками |
| `Server` | Управление сервером |
| `World` | Управление мирами |
| `Items` | Создание предметов |
| `Storage` | Сохранение данных |
| `API` | Расширенный API |

---

## Console - Логирование

Вывод сообщений в консоль сервера.

### Методы

```javascript
// Информационное сообщение
Console.log('Сообщение');

// Предупреждение
Console.warn('Предупреждение');

// Ошибка
Console.error('Ошибка');

// Отладочное сообщение (только при debug: true)
Console.debug('Отладка');
```

### Пример

```javascript
Console.log('Скрипт загружен');
Console.warn('Внимание: что-то не так');
Console.error('Произошла ошибка: ' + errorMessage);
Console.debug('Переменная x = ' + x);
```

---

## Commands - Команды

Регистрация и управление командами сервера.

### Регистрация команды

```javascript
Commands.register(name, handler, permission);
```

| Параметр | Тип | Описание |
|----------|-----|---------|
| `name` | string | Имя команды |
| `handler` | function | Функция-обработчик |
| `permission` | string | Право доступа (опционально) |

### Обработчик команды

```javascript
function handler(sender, args) {
    // sender - отправитель команды
    // args - массив аргументов
}
```

### Примеры

#### Простая команда

```javascript
Commands.register('hello', function(sender, args) {
    sender.sendMessage('§aПривет, ' + sender.getName() + '!');
});
```

#### Команда с правами

```javascript
Commands.register('heal', function(sender, args) {
    if (!sender.isPlayer()) {
        sender.sendMessage('§cТолько для игроков!');
        return;
    }
    
    var player = sender;
    player.setHealth(player.getMaxHealth());
    player.sendMessage('§aВы исцелены!');
}, 'scriptslab.heal');
```

#### Команда с аргументами

```javascript
Commands.register('warp', function(sender, args) {
    if (args.length === 0) {
        sender.sendMessage('§cИспользование: /warp <название>');
        return;
    }
    
    var warpName = args[0];
    // Логика телепортации
    sender.sendMessage('§aТелепорт на §e' + warpName);
});
```

#### Команда с проверкой игрока

```javascript
Commands.register('fly', function(sender, args) {
    if (!sender.isPlayer()) {
        sender.sendMessage('§cТолько для игроков!');
        return;
    }
    
    var player = sender;
    var canFly = player.getAllowFlight();
    player.setAllowFlight(!canFly);
    
    var msg = !canFly ? '§aПолёт включен!' : '§cПолёт выключен!';
    player.sendMessage(msg);
}, 'scriptslab.fly');
```

---

## Events - События

Обработка событий Bukkit.

### Подписка на событие

```javascript
Events.on(eventName, handler);
```

| Параметр | Тип | Описание |
|----------|-----|---------|
| `eventName` | string | Имя события (например, PlayerJoinEvent) |
| `handler` | function | Функция-обработчик |

### Обработчик события

```javascript
function handler(event) {
    // event - объект события Bukkit
}
```

### Доступные события

#### События игрока

| Событие | Описание |
|---------|---------|
| `PlayerJoinEvent` | Вход на сервер |
| `PlayerQuitEvent` | Выход с сервера |
| `PlayerChatEvent` | Чат (синхронный) |
| `AsyncPlayerChatEvent` | Чат (асинхронный) |
| `PlayerMoveEvent` | Движение |
| `PlayerInteractEvent` | Взаимодействие |
| `PlayerItemHeldEvent` | Смена предмета в руке |
| `PlayerDeathEvent` | Смерть |
| `PlayerRespawnEvent` | Возрождение |

#### События сущностей

| Событие | Описание |
|---------|---------|
| `EntityDamageEvent` | Получение урона |
| `EntityDamageByEntityEvent` | Урон от сущности |
| `EntityDeathEvent` | Смерть сущности |
| `EntityShootBowEvent` | Выстрел из лука |

#### События блоков

| Событие | Описание |
|---------|---------|
| `BlockPlaceEvent` | Установка блока |
| `BlockBreakEvent` | Разрушение блока |
| `BlockInteractEvent` | Взаимодействие с блоком |

### Примеры

#### Вход игрока

```javascript
Events.on('PlayerJoinEvent', function(event) {
    var player = event.getPlayer();
    player.sendMessage('§aДобро пожаловать!');
    Console.log(player.getName() + ' зашёл на сервер');
});
```

#### Выход игрока

```javascript
Events.on('PlayerQuitEvent', function(event) {
    var player = event.getPlayer();
    Console.log(player.getName() + ' вышел с сервера');
});
```

#### Чат

```javascript
Events.on('AsyncPlayerChatEvent', function(event) {
    var player = event.getPlayer();
    var message = event.getMessage();
    
    // Фильтр плохих слов
    if (message.toLowerCase().indexOf('badword') !== -1) {
        event.setCancelled(true);
        player.sendMessage('§cТакое говорить нельзя!');
        return;
    }
});
```

#### Смерть игрока

```javascript
Events.on('PlayerDeathEvent', function(event) {
    var entity = event.getEntity();
    var killer = entity.getKiller();
    
    if (killer !== null) {
        Console.log(entity.getName() + ' был убит ' + killer.getName());
    }
});
```

#### Урон от игрока

```javascript
Events.on('EntityDamageByEntityEvent', function(event) {
    var damager = event.getDamager();
    var victim = event.getEntity();
    
    // Проверяем, что атаковал игрок
    var Player = Java.type('org.bukkit.entity.Player');
    if (damager instanceof Player) {
        Console.log(damager.getName() + ' атаковал ' + victim.getName());
    }
});
```

---

## Scheduler - Планировщик

Планирование отложенных и повторяющихся задач.

> **Важно**: Все методы Bukkit API автоматически выполняются в главном потоке!

### Методы

#### runLater - Выполнить один раз

```javascript
Scheduler.runLater(handler, delay);
```

| Параметр | Тип | Описание |
|----------|-----|---------|
| `handler` | function | Функция для выполнения |
| `delay` | integer | Задержка в тиках (20 тиков = 1 секунда) |

```javascript
// Выполнить через 5 секунд (100 тиков)
Scheduler.runLater(function() {
    player.sendMessage('§aСообщение через 5 секунд!');
}, 100);
```

#### runTimer - Повторяющаяся задача

```javascript
Scheduler.runTimer(handler, delay, period);
```

| Параметр | Тип | Описание |
|----------|-----|---------|
| `handler` | function | Функция для выполнения |
| `delay` | integer | Начальная задержка |
| `period` | integer | Интервал повторения |

```javascript
// Выполнять каждую минуту (1200 тиков)
Scheduler.runTimer(function() {
    Server.broadcast('§eНе забудьте проголосовать!');
}, 0, 1200);
```

### Примеры

#### Отложенное сообщение

```javascript
Scheduler.runLater(function() {
    Server.broadcast('§eСервер перезагрузится через 10 минут!');
}, 12000); // 12000 тиков = 10 минут
```

#### Повторяющееся объявление

```javascript
var messages = [
    '§eНе забудьте проголосовать!',
    '§aПрисоединяйтесь к Discord!',
    '§6Голосуйте за сервер!'
];

var index = 0;

Scheduler.runTimer(function() {
    Server.broadcast(messages[index]);
    index = (index + 1) % messages.length;
}, 0, 6000); // Каждые 5 минут
```

#### Таймер с отменой

```javascript
// Сохраняем ID задачи
var taskId = Scheduler.runTimer(function() {
    // Код
}, 0, 20);

// Отмена задачи
// Scheduler.cancel(taskId);
```

---

## Players - Игроки

Управление игроками.

### Методы

#### get - Получить игрока

```javascript
var player = Players.get('NickName');
```

| Параметр | Тип | Описание |
|----------|-----|---------|
| `name` | string | Имя игрока |

```javascript
var player = Players.get('Steve');
if (player !== null) {
    player.sendMessage('§aПривет!');
}
```

#### getAll - Все онлайн игроки

```javascript
var players = Players.getAll();
```

```javascript
var players = Players.getAll();
for (var i = 0; i < players.length; i++) {
    players[i].sendMessage('§eОбъявление для всех!');
}
```

#### teleport - Телепортация

```javascript
Players.teleport(player, world, x, y, z);
```

```javascript
var player = Players.get('Steve');
var world = org.bukkit.Bukkit.getWorld('world');
Players.teleport(player, world, 0, 100, 0);
```

#### giveItem - Дать предмет

```javascript
Players.giveItem(player, itemId, amount);
```

```javascript
var player = Players.get('Steve');
Players.giveItem(player, 'custom_sword', 1);
```

---

## Server - Сервер

Управление сервером.

### Методы

#### broadcast - Сообщение всем

```javascript
Server.broadcast(message);
```

```javascript
Server.broadcast('§aПривет всем игрокам!');
```

#### executeCommand - Выполнить команду

```javascript
Server.executeCommand(command);
```

```javascript
Server.executeCommand('say Сообщение от сервера!');
Server.executeCommand('give Steve DIAMOND 1');
```

#### getOnlinePlayers - Онлайн игроки

```javascript
var players = Server.getOnlinePlayers();
```

```javascript
var count = Server.getOnlinePlayers().size();
Console.log('Онлайн: ' + count);
```

---

## World - Мир

Управление мирами.

### Методы

#### get - Получить мир

```javascript
var world = World.get('world_name');
```

```javascript
var world = World.get('world');
```

#### setTime - Установить время

```javascript
World.setTime(world, time);
```

```javascript
var world = World.get('world');
World.setTime(world, 1000); // День (0-24000)
```

#### setWeather - Установить погоду

```javascript
World.setWeather(world, weather);
```

```javascript
var world = World.get('world');
World.setWeather(world, 'CLEAR');  // Ясно
World.setWeather(world, 'RAIN');   // Дождь
World.setWeather(world, 'THUNDER'); // Гроза
```

#### spawnEntity - Создать сущность

```javascript
World.spawnEntity(world, x, y, z, entityType);
```

```javascript
var world = World.get('world');
World.spawnEntity(world, 0, 100, 0, 'ZOMBIE');
World.spawnEntity(world, 0, 100, 0, 'CREEPER');
```

---

## Items - Предметы

Создание кастомных предметов.

### Методы

#### create - Создать предмет

```javascript
var item = Items.create(id, material, displayName);
```

| Параметр | Тип | Описание |
|----------|-----|---------|
| `id` | string | Уникальный ID |
| `material` | string | Материал (например, DIAMOND_SWORD) |
| `displayName` | string | Отображаемое имя |

```javascript
var sword = Items.create('fire_sword', 'DIAMOND_SWORD', '§cОгненный меч');
sword.setLore(['§7Поджигает врагов']);
```

#### setLore - Установить описание

```javascript
item.setLore(loreArray);
```

```javascript
var sword = Items.create('fire_sword', 'DIAMOND_SWORD', '§cОгненный меч');
sword.setLore([
    '§7Поджигает врагов',
    '§cЛегендарный предмет'
]);
```

#### addAbility - Добавить способность

```javascript
item.addAbility(triggerType, handler);
```

| triggerType | Описание |
|-------------|----------|
| `HIT` | При ударе |
| `RIGHT_CLICK` | Правый клик |
| `LEFT_CLICK` | Левый клик |

```javascript
var sword = Items.create('fire_sword', 'DIAMOND_SWORD', '§cОгненный меч');
sword.setLore(['§7Поджигает врагов']);

sword.addAbility('HIT', function(player, target, item) {
    target.setFireTicks(100); // Поджечь на 5 секунд
    player.sendMessage('§cВраг горит!');
});

Items.register(sword);
```

#### register - Зарегистрировать предмет

```javascript
Items.register(item);
```

```javascript
Items.register(sword);
```

---

## Storage - Хранилище

Сохранение и загрузка данных.

### Методы

#### save - Сохранить данные

```javascript
Storage.save(key, value);
```

```javascript
Storage.save('player.steve.coins', 100);
Storage.save('player.steve.level', 5);
```

#### load - Загрузить данные

```javascript
Storage.load(key).then(function(value) {
    // value - загруженное значение
});
```

```javascript
Storage.load('player.steve.coins').then(function(coins) {
    if (coins === null) {
        coins = 0;
    }
    Console.log('Монет: ' + coins);
});
```

#### delete - Удалить данные

```javascript
Storage.delete(key);
```

```javascript
Storage.delete('player.steve.temp');
```

#### exists - Проверить существование

```javascript
Storage.exists(key).then(function(exists) {
    if (exists) {
        Console.log('Данные существуют');
    }
});
```

---

## API - Расширенный API

Дополнительные методы для удобной работы.

### Методы

#### registerEvent - Регистрация события

```javascript
API.registerEvent(eventName, handler);
```

```javascript
API.registerEvent('PlayerJoinEvent', function(event) {
    var player = event.getPlayer();
    player.sendMessage('§aДобро пожаловать!');
});
```

#### broadcast - Сообщение всем

```javascript
API.broadcast(message);
```

```javascript
API.broadcast('§eОбъявление для всех!');
```

#### getOnlinePlayers - Получить игроков

```javascript
var players = API.getOnlinePlayers();
```

```javascript
var count = API.getOnlinePlayers().size();
```

#### strikeLightningSync - Молния (безопасно)

```javascript
API.strikeLightningSync(location);
```

```javascript
API.strikeLightningSync(player.getLocation());
```

#### addPotionEffectSync - Эффект зелья (безопасно)

```javascript
API.addPotionEffectSync(player, effectType, duration, amplifier, ambient, particles);
```

```javascript
var PotionEffectType = Java.type('org.bukkit.potion.PotionEffectType');
API.addPotionEffectSync(player, PotionEffectType.SPEED, 999999, 2, false, false);
```

#### removePotionEffectSync - Убрать эффект (безопасно)

```javascript
API.removePotionEffectSync(player, effectType);
```

```javascript
var PotionEffectType = Java.type('org.bukkit.potion.PotionEffectType');
API.removePotionEffectSync(player, PotionEffectType.SPEED);
```

#### addAttribute - Атрибут предмета

```javascript
API.addAttribute(itemMeta, attributeName, modifierName, value, operation, slot);
```

| Параметр | Описани�� |
|----------|---------|
| `itemMeta` | ItemMeta предмета |
| `attributeName` | GENERIC_ATTACK_DAMAGE, GENERIC_ATTACK_SPEED и т.д. |
| `modifierName` | Уникальное имя модификатора |
| `value` | Значение |
| `operation` | ADD_NUMBER, MULTIPLY_SCALAR_1 |
| `slot` | HAND, FEET, LEGS, etc. |

```javascript
var Attribute = Java.type('org.bukkit.attribute.Attribute');
var AttributeModifier = Java.type('org.bukkit.attribute.AttributeModifier');
var UUID = Java.type('java.util.UUID');

API.addAttribute(meta, 'GENERIC_ATTACK_DAMAGE', 'damage_boost', 10.0, 'ADD_NUMBER', 'HAND');
```

#### log - Логирование

```javascript
API.log(message);
```

```javascript
API.log('Скрипт загружен');
```

---

## Работа с Java

ScriptsLab позволяет использовать Java классы напрямую.

### Импорт классов

```javascript
var Material = Java.type('org.bukkit.Material');
var ItemStack = Java.type('org.bukkit.inventory.ItemStack');
var Enchantment = Java.type('org.bukkit.enchantments.Enchantment');
var ItemFlag = Java.type('org.bukkit.inventory.ItemFlag');
var Attribute = Java.type('org.bukkit.attribute.Attribute');
var AttributeModifier = Java.type('org.bukkit.attribute.AttributeModifier');
var EquipmentSlot = Java.type('org.bukkit.inventory.EquipmentSlot');
var UUID = Java.type('java.util.UUID');
var ArrayList = Java.type('java.util.ArrayList');
var PotionEffect = Java.type('org.bukkit.potion.PotionEffect');
var PotionEffectType = Java.type('org.bukkit.potion.PotionEffectType');
```

### Создание объектов

```javascript
var item = new ItemStack(Material.DIAMOND_SWORD);
item.setAmount(64);

var list = new ArrayList();
list.add('элемент');
```

### Использование методов

```javascript
item.setAmount(64);
list.add('элемент');
var size = list.size();
```

### instanceof - Проверка типа

```javascript
var Player = Java.type('org.bukkit.entity.Player');
if (entity instanceof Player) {
    // Это игрок
}
```

---

## Работа с отправителем команды

### Типы отправителя

| Метод | Описание |
|--------|---------|
| `sender.isPlayer()` | Проверить, является ли игроком |
| `sender.isOp()` | Проверить, является ли OP |

### Примеры

```javascript
Commands.register('test', function(sender, args) {
    // Проверка игрок ли
    if (!sender.isPlayer()) {
        sender.sendMessage('§cТолько для игроков!');
        return;
    }
    
    var player = sender;
    player.sendMessage('§aПривет, игрок!');
});
```

### Получение игрока из отправителя

```javascript
var player = sender; // Если проверено isPlayer()
```

---

## Обработка ошибок

### try-catch

```javascript
try {
    // Ваш код
    var result = dangerousOperation();
} catch (error) {
    Console.error('Ошибка: ' + error);
}
```

### Проверка на null

```javascript
var player = Players.get('Steve');
if (player !== null) {
    // Безопасно использовать
} else {
    Console.warn('Игрок не найден');
}
```

---

## Типы данных

### JavaScript → Java

| JavaScript | Java |
|-----------|------|
| `number` | int, double, float |
| `string` | String |
| `boolean` | boolean |
| `array` | ArrayList, List |
| `function` | Consumer, Function |
| `object` | Object |

### Java → JavaScript

| Java | JavaScript |
|------|----------|
| `int` | number |
| `double` | number |
| `boolean` | boolean |
| `String` | string |
| `List` | array |
| `Map` | object |
| `Object` | object |

---

## Ограничения

- **Таймаут**: 5 секунд по умолчанию (настраивается)
- **Память**: 128MB на скрипт (настраивается)
- **Песочница**: Ограниченный доступ к Java API (при sandbox: true)
- **Потоки**: GraalVM JS однопоточный

---

## Следующие шаги

| Шаг | Описание |
|-----|----------|
| [Примеры](examples/) | Готовые примеры скриптов |
| [Модули](modules.md) | Система модулей |
| [Безопасность](configuration.md#security) | Настройка безопасности |