-
Notifications
You must be signed in to change notification settings - Fork 5
Basics of the shelp command
shelp is a documentation command.
It allows you to get documentation about all actions, variables and enums available.
Important
You do not have to know what actions, variables or enums are for now. Just recognize the patterns and come back later once you need to refresh your knowledge.
It's very simple. Just run the shelp command in your server console (not Remote Admin). There are 2 things that can happen:
-
A text file will open up on your screen (the desired effect).
-
A text file will be created, but not opened. The cause is likely the usage of Pterodactyl.
Pterodactyl does not like opening files on demand and will generally throw a permission error. It will still generate the file inside your EXILED -> Configs -> ScriptedEvents folder, it will just not open it.
When this happens, you will have to manually go to the specified location of the file in the server file system. This can be found in the error it generates:
File was created successfully, but an error occurred when opening external text editor (likely due to permissions).
File will expire in 5 minutes and is located at: /home/container/.config/EXILED/Configs/ScriptedEvents/HelpCommandResponse.txt.
Tip
The shelp command is a server command only. You can use the act help command if you wish to use it while inside Remote Admin.
Note
All of the showcased generated files below will end in ..., this means that there is more content beyond what is shown.
The shelp generate command will generate and open a generator_config.txt file. This file is the config of the generator and should look similar to this:
# Please change each 'y' to a 'n' if you do not want the associated files generated. More files = more space taken up on PC.
# Whether or not to generate pre-written SE tutorials.
generate_tutorials: y
...
Important
Pterodactyl will also block this file from opening, and you will have to manually open it.
After confirming the content of the config, run the shelp gdone command, which will generate the entire documentation in the EXILED -> Configs -> ScriptedEvents -> Documentation folder.
Note
The documentation does not automatically update when a plugin is updated. You will be prompted to regenerate the documentation by hand, if there is a version mismatch.
shelp list, shelp act, shelp actions will generate a list of all actions. Every action found there can be also shelped!
The file generated should look similar to this:
List of all actions. For more information on each action, run the HELP <ACTIONNAME> action (or shelp <ACTIONNAME> in the server console).
== Broadcast Actions ==
CLEARBROADCASTS : Clears all broadcasts for specified player(s).
HINT : Broadcasts a hint to specific player(s).
COUNTDOWN : Displays a countdown on the player(s) screens (using broadcasts).
...
shelp ActionName (where ActionName is the name of the action) will generate documentation about the specified action.
The file generated for BROADCAST action should look similar to this:
+ BROADCAST +
Broadcasts a message to specific player(s).
Action type: Broadcast
Usage: BROADCAST <PLAYERS> <DURATIONSECONDS> <MESSAGE>
Arguments:
<players>
Required: YES
Type: Player List
...
shelp listvar, shelp vars, shelp variables will generate a list of all variables. Every variable found there can be also shelped!
The file generated should look similar to this:
An asterisk [*] before the name of a variable indicates it also stores players, which can be used in numerous actions such as SETROLE.
+ Chances +
{RANDOM} - Returns a random number from provided range.
+ Escapes +
[*] {ESCAPES} - Players which have escaped the facility.
+ Filters +
[*] {FILTER} - Filters a player variable by a certain type.
...
shelp VariableName (where VariableName is the name of the variable) will generate documentation about the specified variable.
The file generated for {INROOM} variable should look similar to this:
Name: {INROOM}
Description: The amount of players in the specified room.
Stores Players: YES
Usage: {INROOM:ROOMTYPE}
Variable Type: Numerical
Arguments:
[roomType]
Required: NO
...
shelp enums will generate a list of all enums. Every enum found there can also be shelped!
The file generated should look similar to this:
Enums are, at the basic level, 'options' in code. Different 'Enum' inputs are required for various actions, such as roles, items, etc.
Type 'shelp <enum name>' to see each different enum's valid options.
RoleTypeId - The list of valid in-game roles.
Team - The list of valid in-game teams.
ItemType - The list of valid in-game items.
...
shelp Enum (where Enum is the name of the enum) will generate documentation about the specified enumerated type.
The file generated for RoleTypeId variable should look similar to this:
Name: RoleTypeId
The list of valid in-game roles.
Options:
0 - Scp173
1 - ClassD
2 - Spectator
3 - Scp106
4 - NtfSpecialist
5 - Scp049
...
-> Next suggested tutorial: Basics of actions
Actions