summaryrefslogtreecommitdiffstats
path: root/Server/Plugins/APIDump/Classes/Plugins.lua
blob: 63f4172e6d5ad64047de7b1d58c53d338babeec6 (plain) (blame)
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
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
return
{
	cPlugin =
	{
		Desc = "cPlugin describes a Lua plugin. Each plugin has its own cPlugin object.",
		Functions =
		{
			GetDirectory =
			{
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "<b>OBSOLETE</b>, use GetFolderName() instead!",
			},
			GetFolderName =
			{
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns the name of the folder where the plugin's files are. (APIDump)",
			},
			GetLoadError =
			{
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "If the plugin failed to load, returns the error message for the failure.",
			},
			GetLocalDirectory =
			{
				Notes = "<b>OBSOLETE</b>, use GetLocalFolder instead.",
			},
			GetLocalFolder =
			{
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns the path where the plugin's files are. (Plugins/APIDump)",
			},
			GetName =
			{
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns the name of the plugin.",
			},
			GetStatus =
			{
				Returns =
				{
					{
						Name = "PluginStatus",
						Type = "cPluginManager#ePluginStatus",
					},
				},
				Notes = "Returns the status of the plugin (loaded, disabled, unloaded, error, not found)",
			},
			GetVersion =
			{
				Returns =
				{
					{
						Type = "number",
					},
				},
				Notes = "Returns the version of the plugin.",
			},
			IsLoaded =
			{
				Notes = "",
				Returns =
				{
					{
						Type = "boolean",
					},
				},
			},
			SetName =
			{
				Params =
				{
					{
						Name = "PluginApiName",
						Type = "string",
					},
				},
				Notes = "Sets the API name of the Plugin that is used by {{cPluginManager}}:CallPlugin() to identify the plugin.",
			},
			SetVersion =
			{
				Params =
				{
					{
						Name = "PluginApiVersion",
						Type = "number",
					},
				},
				Notes = "Sets the API version of the plugin. Currently unused.",
			},
		},
	},  -- cPlugin

	cPluginLua =
	{
		Desc = "(<b>OBSOLETE</b>) This class is no longer useful in the API and will be removed as soon as all core plugins are migrated away from it. The {{cPlugin}} class serves as the main plugin instance's interface.",
		Functions =
		{
			AddWebTab =
			{
				Params =
				{
					{
						Name = "Title",
						Type = "string",
					},
					{
						Name = "HandlerFn",
						Type = "function",
					},
				},
				Notes = "<b>OBSOLETE</b> - Use {{cWebAdmin}}:AddWebTab() instead.",
			},
		},
		Inherits = "cPlugin",
	},  -- cPluginLua

	cPluginManager =
	{
		Desc = [[
			This class is used for generic plugin-related functionality. The plugin manager has a list of all
			plugins, can enable or disable plugins, manages hooks and in-game console commands.</p>
			<p>
			Plugins can be identified by either the PluginFolder or PluginName. Note that these two can differ,
			refer to <a href="https://forum.cuberite.org/thread-1877.html">the forum</a> for detailed discussion.
			<p>
			There is one instance of cPluginManager in Cuberite, to get it, call either
			{{cRoot|cRoot}}:Get():GetPluginManager() or cPluginManager:Get() function.</p>
			<p>
			Note that some functions are "static", that means that they are called using a dot operator instead
			of the colon operator. For example:
<pre class="prettyprint lang-lua">
cPluginManager.AddHook(cPluginManager.HOOK_CHAT, OnChatMessage);
</pre></p>
		]],
		Functions =
		{
			AddHook =
			{
				{
					IsStatic = true,
					Params =
					{
						{
							Name = "HookType",
							Type = "cPluginManager#PluginHook",
						},
						{
							Name = "Callback",
							Type = "function",
							IsOptional = true,
						},
					},
					Notes = "Informs the plugin manager that it should call the specified function when the specified hook event occurs. If a function is not specified, a default global function name is looked up, based on the hook type",
				},
			},
			BindCommand =
			{
				{
					Params =
					{
						{
							Name = "Command",
							Type = "string",
						},
						{
							Name = "Permission",
							Type = "string",
						},
						{
							Name = "Callback",
							Type = "function",
						},
						{
							Name = "HelpString",
							Type = "string",
						},
					},
					Returns =
					{
						{
							Type = "boolean",
						},
					},
					Notes = "Binds an in-game command with the specified callback function, permission and help string. By common convention, providing an empty string for HelpString will hide the command from the /help display. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split, {{cPlayer|Player}})</pre> The Split parameter contains an array-table of the words that the player has sent, Player is the {{cPlayer}} object representing the player who sent the command. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server sends a warning to the player that the command is unknown (this is so that subcommands can be implemented).",
				},
				{
					IsStatic = true,
					Params =
					{
						{
							Name = "Command",
							Type = "string",
						},
						{
							Name = "Permission",
							Type = "string",
						},
						{
							Name = "Callback",
							Type = "function",
						},
						{
							Name = "HelpString",
							Type = "string",
						},
					},
					Returns =
					{
						{
							Type = "boolean",
						},
					},
					Notes = "Binds an in-game command with the specified callback function, permission and help string. By common convention, providing an empty string for HelpString will hide the command from the /help display. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split, {{cPlayer|Player}})</pre> The Split parameter contains an array-table of the words that the player has sent, Player is the {{cPlayer}} object representing the player who sent the command. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server sends a warning to the player that the command is unknown (this is so that subcommands can be implemented).",
				},
			},
			BindConsoleCommand =
			{
				{
					IsStatic = true,
					Params =
					{
						{
							Name = "Command",
							Type = "string",
						},
						{
							Name = "Callback",
							Type = "function",
						},
						{
							Name = "HelpString",
							Type = "string",
						},
					},
					Returns =
					{
						{
							Type = "boolean",
							IsOptional = true,
						},
					},
					Notes = "Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split)</pre> The Split parameter contains an array-table of the words that the admin has typed. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server issues a warning to the console that the command is unknown (this is so that subcommands can be implemented).",
				},
				{
					Params =
					{
						{
							Name = "Command",
							Type = "string",
						},
						{
							Name = "Callback",
							Type = "function",
						},
						{
							Name = "HelpString",
							Type = "string",
						},
					},
					Returns =
					{
						{
							Type = "boolean",
							IsOptional = true,
						},
					},
					Notes = "Binds a console command with the specified callback function and help string. By common convention, providing an empty string for HelpString will hide the command from the \"help\" console command. Returns true if successful, logs to console and returns no value on error. The callback uses the following signature: <pre class=\"prettyprint lang-lua\">function(Split)</pre> The Split parameter contains an array-table of the words that the admin has typed. If the callback returns true, the command is assumed to have executed successfully; in all other cases the server issues a warning to the console that the command is unknown (this is so that subcommands can be implemented).",
				},
			},
			CallPlugin =
			{
				IsStatic = true,
				Params =
				{
					{
						Name = "PluginName",
						Type = "string",
					},
					{
						Name = "FunctionName",
						Type = "string",
					},
					{
						Name = "FunctionArgs...",
						Type = "...",
						IsOptional = true,
					},
				},
				Returns =
				{
					{
						Name = "FunctionRets",
						Type = "...",
						IsOptional = true,
					},
				},
				Notes = "Calls the specified function in the specified plugin, passing all the given arguments to it. If it succeeds, it returns all the values returned by that function. If it fails, returns no value at all. Note that only strings, numbers, bools, nils, API classes and simple tables can be used for parameters and return values; functions cannot be copied across plugins.",
			},
			DoWithPlugin =
			{
				IsStatic = true,
				Params =
				{
					{
						Name = "PluginName",
						Type = "string",
					},
					{
						Name = "CallbackFn",
						Type = "function",
					},
				},
				Returns =
				{
					{
						Type = "boolean",
					},
				},
				Notes = "Calls the CallbackFn for the specified plugin, if found. A plugin can be found even if it is currently unloaded, disabled or errored, the callback should check the plugin status. If the plugin is not found, this function returns false, otherwise it returns the bool value that the callback has returned. The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</pre>",
			},
			ExecuteCommand =
			{
				Params =
				{
					{
						Name = "Player",
						Type = "cPlayer",
					},
					{
						Name = "CommandStr",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Name = "CommandResult",
						Type = "cPluginManager#CommandResult",
					},
				},
				Notes = "Executes the command as if given by the specified Player. Checks permissions.",
			},
			ExecuteConsoleCommand =
			{
				Params =
				{
					{
						Name = "CommandStr",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "boolean",
					},
					{
						Type = "string",
					},
				},
				Notes = "Executes the console command as if given by the admin on the console. If the command is successfully executed, returns true and the text that would be output to the console normally. On error it returns false and an error message.",
			},
			FindPlugins =
			{
				Notes = "<b>OBSOLETE</b>, use RefreshPluginList() instead",
			},
			ForceExecuteCommand =
			{
				Params =
				{
					{
						Name = "Player",
						Type = "cPlayer",
					},
					{
						Name = "CommandStr",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Name = "CommandResult",
						Type = "cPluginManager#CommandResult",
					},
				},
				Notes = "Same as ExecuteCommand, but doesn't check permissions",
			},
			ForEachCommand =
			{
				Params =
				{
					{
						Name = "CallbackFn",
						Type = "function",
					},
				},
				Returns =
				{
					{
						Type = "boolean",
					},
				},
				Notes = "Calls the CallbackFn function for each command that has been bound using BindCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function(Command, Permission, HelpString)</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
			},
			ForEachConsoleCommand =
			{
				Params =
				{
					{
						Name = "CallbackFn",
						Type = "function",
					},
				},
				Returns =
				{
					{
						Type = "boolean",
					},
				},
				Notes = "Calls the CallbackFn function for each command that has been bound using BindConsoleCommand(). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function (Command, HelpString)</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
			},
			ForEachPlugin =
			{
				{
					IsStatic = true,
					Params =
					{
						{
							Name = "CallbackFn",
							Type = "function",
						},
					},
					Returns =
					{
						{
							Type = "boolean",
						},
					},
					Notes = "Calls the CallbackFn function for each plugin that is currently discovered by Cuberite (including disabled, unloaded and errrored plugins). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
				},
				{
					Params =
					{
						{
							Name = "CallbackFn",
							Type = "function",
						},
					},
					Returns =
					{
						{
							Type = "boolean",
						},
					},
					Notes = "Calls the CallbackFn function for each plugin that is currently discovered by Cuberite (including disabled, unloaded and errrored plugins). The CallbackFn has the following signature: <pre class=\"prettyprint lang-lua\">function ({{cPlugin|Plugin}})</pre> If the callback returns true, the enumeration is aborted and this API function returns false; if it returns false or no value, the enumeration continues with the next command, and the API function returns true.",
				}
			},
			Get =
			{
				IsStatic = true,
				Returns =
				{
					{
						Type = "cPluginManager",
					},
				},
				Notes = "Returns the single instance of the plugin manager",
			},
			GetAllPlugins =
			{
				Returns =
				{
					{
						Type = "table",
					},
				},
				Notes = "Returns a table (dictionary) of all plugins, [name => value], where value is a valid {{cPlugin}} if the plugin is loaded, or the bool value false if the plugin is not loaded.",
			},
			GetCommandPermission =
			{
				Params =
				{
					{
						Name = "Command",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Name = "Permission",
						Type = "string",
					},
				},
				Notes = "Returns the permission needed for executing the specified command",
			},
			GetCurrentPlugin =
			{
				Returns =
				{
					{
						Type = "cPlugin",
					},
				},
				Notes = "Returns the {{cPlugin}} object for the calling plugin. This is the same object that the Initialize function receives as the argument.",
			},
			GetNumLoadedPlugins =
			{
				Returns =
				{
					{
						Type = "number",
					},
				},
				Notes = "Returns the number of loaded plugins (psLoaded only)",
			},
			GetNumPlugins =
			{
				Returns =
				{
					{
						Type = "number",
					},
				},
				Notes = "Returns the number of plugins, including the disabled, errored, unloaded and not-found ones",
			},
			GetPlugin =
			{
				Params =
				{
					{
						Name = "PluginName",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "cPlugin",
					},
				},
				Notes = "(<b>DEPRECATED, UNSAFE</b>) Returns a plugin handle of the specified plugin, or nil if such plugin is not loaded. Note thatdue to multithreading the handle is not guaranteed to be safe for use when stored - a single-plugin reload may have been triggered in the mean time for the requested plugin.",
			},
			GetPluginFolderName =
			{
				Params =
				{
					{
						Name = "PluginName",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns the name of the folder from which the plugin was loaded (without the \"Plugins\" part). Used as a plugin's display name.",
			},
			GetPluginsPath =
			{
				IsStatic = true,
				Returns =
				{
					{
						Type = "string",
					},
				},
				Notes = "Returns the path where the individual plugin folders are located. Doesn't include the path separator at the end of the returned string.",
			},
			IsCommandBound =
			{
				Params =
				{
					{
						Name = "Command",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "boolean",
					},
				},
				Notes = "Returns true if in-game Command is already bound (by any plugin)",
			},
			IsConsoleCommandBound =
			{
				Params =
				{
					{
						Name = "Command",
						Type = "string",
					},
				},
				Returns =
				{
					{
						Type = "boolean",
					},
				},
				Notes = "Returns true if console Command is already bound (by any plugin)",
			},
			IsPluginLoaded =
			{
				Params =
				{
					{
						Name = "PluginName",
						Type = "string",
					},
				},
				Notes = "Returns true if the specified plugin is loaded.",
			},
			LoadPlugin =
			{
				Params =
				{
					{
						Name = "PluginFolder",
						Type = "string",
					},
				},
				Notes = "(<b>DEPRECATED</b>) Loads a plugin from the specified folder. NOTE: Loading plugins may be an unsafe operation and may result in a deadlock or a crash. This API is deprecated and might be removed.",
			},
			LogStackTrace =
			{
				IsStatic = true,
				Notes = "Logs a current stack trace of the Lua engine to the server console log. Same format as is used when the plugin fails.",
			},
			RefreshPluginList =
			{
				Notes = "Refreshes the list of plugins to include all folders inside the Plugins folder (potentially new disabled plugins)",
			},
			ReloadPlugins =
			{
				Notes = "Reloads all active plugins",
			},
			UnloadPlugin =
			{
				Params =
				{
					{
						Name = "PluginName",
						Type = "string",
					},
				},
				Notes = "Queues the specified plugin to be unloaded. To avoid deadlocks, the unloading happens in the main tick thread asynchronously.",
			},
		},
		Constants =
		{
			crBlocked =
			{
				Notes = "When a plugin stopped the command using the OnExecuteCommand hook",
			},
			crError =
			{
				Notes = "When the command handler for the given command results in an error",
			},
			crExecuted =
			{
				Notes = "When the command is successfully executed.",
			},
			crNoPermission =
			{
				Notes = "When the player doesn't have permission to execute the given command.",
			},
			crUnknownCommand =
			{
				Notes = "When the given command doesn't exist.",
			},
			HOOK_BLOCK_SPREAD =
			{
				Notes = "Called when a block spreads based on world conditions",
			},
			HOOK_BLOCK_TO_PICKUPS =
			{
				Notes = "Called when a block has been dug and is being converted to pickups. The server has provided the default pickups and the plugins may modify them.",
			},
			HOOK_BREWING_COMPLETED =
			{
				Notes = "Called when a brewing stand completed a brewing process.",
			},
			HOOK_BREWING_COMPLETING =
			{
				Notes = "Called before a brewing stand completes a brewing process.",
			},
			HOOK_CHAT =
			{
				Notes = "Called when a client sends a chat message that is not a command. The plugin may modify the chat message",
			},
			HOOK_CHUNK_AVAILABLE =
			{
				Notes = "Called when a chunk is loaded or generated and becomes available in the {{cWorld|world}}.",
			},
			HOOK_CHUNK_GENERATED =
			{
				Notes = "Called after a chunk is generated. A plugin may do last modifications on the generated chunk before it is handed of to the {{cWorld|world}}.",
			},
			HOOK_CHUNK_GENERATING =
			{
				Notes = "Called before a chunk is generated. A plugin may override some parts of the generation algorithm.",
			},
			HOOK_CHUNK_UNLOADED =
			{
				Notes = "Called after a chunk has been unloaded from a {{cWorld|world}}.",
			},
			HOOK_CHUNK_UNLOADING =
			{
				Notes = "Called before a chunk is unloaded from a {{cWorld|world}}. The chunk has already been saved.",
			},
			HOOK_COLLECTING_PICKUP =
			{
				Notes = "Called when a player is about to collect a pickup.",
			},
			HOOK_CRAFTING_NO_RECIPE =
			{
				Notes = "Called when a player has items in the crafting slots and the server cannot locate any recipe. Plugin may provide a recipe.",
			},
			HOOK_DISCONNECT =
			{
				Notes = "Called after the player has disconnected.",
			},
			HOOK_ENTITY_ADD_EFFECT =
			{
				Notes = "Called when an effect is being added to an {{cEntity|entity}}. Plugin may refuse the effect.",
			},
			HOOK_ENTITY_CHANGED_WORLD =
			{
				Notes = "Called after a entity has changed the world.",
			},
			HOOK_ENTITY_CHANGING_WORLD =
			{
				Notes = "Called before a entity has changed the world. Plugin may disallow a entity to change the world.",
			},
			HOOK_ENTITY_TELEPORT =
			{
				Notes = "Called when an {{cEntity|entity}} is being teleported. Plugin may refuse the teleportation.",
			},
			HOOK_EXECUTE_COMMAND =
			{
				Notes = "Called when a client sends a chat message that is recognized as a command, before handing that command to the regular command handler. A plugin may stop the command from being handled. This hook is called even when the player doesn't have permissions for the command.",
			},
			HOOK_EXPLODED =
			{
				Notes = "Called after an explosion has been processed in a {{cWorld|world}}.",
			},
			HOOK_EXPLODING =
			{
				Notes = "Called before an explosion is processed in a {{cWorld|world}}. A plugin may alter the explosion parameters or cancel the explosion altogether.",
			},
			HOOK_HANDSHAKE =
			{
				Notes = "Called when a Handshake packet is received from a client.",
			},
			HOOK_HOPPER_PULLING_ITEM =
			{
				Notes = "Called when a hopper is pulling an item from the container above it.",
			},
			HOOK_HOPPER_PUSHING_ITEM =
			{
				Notes = "Called when a hopper is pushing an item into the container it is aimed at.",
			},
			HOOK_DROPSPENSE =
			{
				Notes = "Called when a {{cDropSpenserEntity|DropSpenser}} is dropspensing an {{cItem|item}}.",
			},
			HOOK_KILLED =
			{
				Notes = "Called when an entity has been killed.",
			},
			HOOK_KILLING =
			{
				Notes = "Called when an entity has just been killed. A plugin may resurrect the entity by setting its health to above zero.",
			},
			HOOK_LOGIN =
			{
				Notes = "Called when a Login packet is sent to the client, before the client is queued for authentication.",
			},
			HOOK_LOGIN_FORGE =
			{
				Notes = "Called when a Forge client has sent its ModList to the server, during the login handshake.",
			},
			HOOK_PLAYER_ANIMATION =
			{
				Notes = "Called when a client send the Animation packet.",
			},
			HOOK_PLAYER_BREAKING_BLOCK =
			{
				Notes = "Called when a player is about to break a block. A plugin may cancel the event.",
			},
			HOOK_PLAYER_BROKEN_BLOCK =
			{
				Notes = "Called after a player has broken a block.",
			},
			HOOK_PLAYER_CROUCHED =
			{
				Notes = "Called when a player crouches.",
			},
			HOOK_PLAYER_DESTROYED =
			{
				Notes = "Called when the {{cPlayer}} object is destroyed - a player has disconnected.",
			},
			HOOK_PLAYER_EATING =
			{
				Notes = "Called when the player starts eating a held item. Plugins may abort the eating.",
			},
			HOOK_PLAYER_FISHED =
			{
				Notes = "Called when the player reels the fishing rod back in, after the server decides the player's fishing reward.",
			},
			HOOK_PLAYER_FISHING =
			{
				Notes = "Called when the player reels the fishing rod back in, plugins may alter the fishing reward.",
			},
			HOOK_PLAYER_FOOD_LEVEL_CHANGE =
			{
				Notes = "Called when the player's food level is changing. Plugins may refuse the change.",
			},
			HOOK_PLAYER_JOINED =
			{
				Notes = "Called when the player entity has been created. It has not yet been fully initialized.",
			},
			HOOK_PLAYER_LEFT_CLICK =
			{
				Notes = "Called when the client sends the LeftClick packet.",
			},
			HOOK_PLAYER_MOVING =
			{
				Notes = "Called when the player has moved and the movement is now being applied.",
			},
			HOOK_PLAYER_OPENING_WINDOW =
			{
				Notes = "Called when the player is about to open a window. The plugin can return true to cancel the window opening.",
			},
			HOOK_PLAYER_PLACED_BLOCK =
			{
				Notes = "Called when the player has just placed a block",
			},
			HOOK_PLAYER_PLACING_BLOCK =
			{
				Notes = "Called when the player is about to place a block. A plugin may cancel the event.",
			},
			HOOK_PLAYER_RIGHT_CLICK =
			{
				Notes = "Called when the client sends the RightClick packet.",
			},
			HOOK_PLAYER_RIGHT_CLICKING_ENTITY =
			{
				Notes = "Called when the client sends the UseEntity packet.",
			},
			HOOK_PLAYER_SHOOTING =
			{
				Notes = "Called when the player releases the mouse button to fire their bow.",
			},
			HOOK_PLAYER_SPAWNED =
			{
				Notes = "Called after the player entity has been created. The entity is fully initialized and is spawning in the {{cWorld|world}}.",
			},
			HOOK_PLAYER_TOSSING_ITEM =
			{
				Notes = "Called when the player is tossing the held item (keypress Q)",
			},
			HOOK_PLAYER_USED_BLOCK =
			{
				Notes = "Called after the player has right-clicked a block",
			},
			HOOK_PLAYER_USED_ITEM =
			{
				Notes = "Called after the player has right-clicked with a usable item in their hand.",
			},
			HOOK_PLAYER_USING_BLOCK =
			{
				Notes = "Called when the player is about to use (right-click) a block",
			},
			HOOK_PLAYER_USING_ITEM =
			{
				Notes = "Called when the player is about to right-click with a usable item in their hand.",
			},
			HOOK_PLUGIN_MESSAGE =
			{
				Notes = "Called when a PluginMessage packet is received from a client.",
			},
			HOOK_PLUGINS_LOADED =
			{
				Notes = "Called after all plugins have loaded.",
			},
			HOOK_POST_CRAFTING =
			{
				Notes = "Called after a valid recipe has been chosen for the current contents of the crafting grid. Plugins may modify the recipe.",
			},
			HOOK_PRE_CRAFTING =
			{
				Notes = "Called before a recipe is searched for the current contents of the crafting grid. Plugins may provide a recipe and cancel the built-in search.",
			},
			HOOK_PROJECTILE_HIT_BLOCK =
			{
				Notes = "Called when a {{cProjectileEntity|projectile}} hits a block.",
			},
			HOOK_PROJECTILE_HIT_ENTITY =
			{
				Notes = "Called when a {{cProjectileEntity|projectile}} hits an {{cEntity|entity}}.",
			},
			HOOK_SERVER_PING =
			{
				Notes = "Called when a client pings the server from the server list. Plugins may change the favicon, server description, players online and maximum players values.",
			},
			HOOK_SPAWNED_ENTITY =
			{
				Notes = "Called after an entity is spawned in a {{cWorld|world}}. The entity is already part of the world.",
			},
			HOOK_SPAWNED_MONSTER =
			{
				Notes = "Called after a mob is spawned in a {{cWorld|world}}. The mob is already part of the world.",
			},
			HOOK_SPAWNING_ENTITY =
			{
				Notes = "Called just before an entity is spawned in a {{cWorld|world}}.",
			},
			HOOK_SPAWNING_MONSTER =
			{
				Notes = "Called just before a mob is spawned in a {{cWorld|world}}.",
			},
			HOOK_TAKE_DAMAGE =
			{
				Notes = "Called when an entity is taking any kind of damage. Plugins may modify the damage value, effects, source or cancel the damage.",
			},
			HOOK_TICK =
			{
				Notes = "Called when the main server thread ticks - 20 times a second.",
			},
			HOOK_UPDATED_SIGN =
			{
				Notes = "Called after a {{cSignEntity|sign}} text has been updated, either by a player or by any external means.",
			},
			HOOK_UPDATING_SIGN =
			{
				Notes = "Called before a {{cSignEntity|sign}} text is updated, either by a player or by any external means.",
			},
			HOOK_WEATHER_CHANGED =
			{
				Notes = "Called after the weather has changed.",
			},
			HOOK_WEATHER_CHANGING =
			{
				Notes = "Called just before the weather changes",
			},
			HOOK_WORLD_STARTED =
			{
				Notes = "Called when a world has been started.",
			},
			HOOK_WORLD_TICK =
			{
				Notes = "Called in each world's tick thread when the game logic is about to tick (20 times a second).",
			},
			psDisabled =
			{
				Notes = "The plugin is not enabled in settings.ini",
			},
			psError =
			{
				Notes = "The plugin is enabled in settings.ini, but it has run into an error while loading. Use {{cPlugin}}:GetLoadError() to identify the error.",
			},
			psLoaded =
			{
				Notes = "The plugin is enabled and loaded.",
			},
			psNotFound =
			{
				Notes = "The plugin has been loaded, but is no longer present on disk.",
			},
			psUnloaded =
			{
				Notes = "The plugin is enabled in settings.ini, but it has been unloaded (by a command).",
			},
		},
		ConstantGroups =
		{
			CommandResult =
			{
				Include =
				{
					"^cr.*",
				},
				TextBefore = "Results that the (Force)ExecuteCommand functions return. This gives information whether the command was executed or not, and the reason.",
			},
			PluginHook =
			{
				Include =
				{
					"HOOK_.*",
				},
				TextBefore = [[
					These constants identify individual hooks. To register the plugin to receive notifications on hooks, use the
					cPluginManager:AddHook() function. For detailed description of each hook, see the <a href='index.html#hooks'>
					hooks reference</a>.]],
			},
			ePluginStatus =
			{
				Include =
				{
					"ps.*",
				},
				TextBefore = [[
					These constants are used to report status of individual plugins. Use {{cPlugin}}:GetStatus() to query the
					status of a plugin; use cPluginManager::ForEachPlugin() to iterate over plugins.]],
			},
		},
	},
}