tgs_chat_command
![code/__DEFINES/tgs.dm 287](git.png)
User definable chat command.
Vars | |
admin_only | If this command should be available to game administrators only. |
---|---|
help_text | The help text displayed for this command. |
ignore_type | A subtype of /datum/tgs_chat_command that is ignored when enumerating available commands. Use this to create shared base /datums for commands. |
name | The string to trigger this command on a chat bot. e.g @bot name ... or !tgs name ... . |
Procs | |
Run | Process command activation. Should return a /datum/tgs_message_content to respond to the issuer with. |
Var Details
admin_only
![code/__DEFINES/tgs.dm 293](git.png)
If this command should be available to game administrators only.
help_text
![code/__DEFINES/tgs.dm 291](git.png)
The help text displayed for this command.
ignore_type
![code/__DEFINES/tgs.dm 297](git.png)
A subtype of /datum/tgs_chat_command that is ignored when enumerating available commands. Use this to create shared base /datums for commands.
name
![code/__DEFINES/tgs.dm 289](git.png)
The string to trigger this command on a chat bot. e.g @bot name ...
or !tgs name ...
.
Proc Details
Run
Process command activation. Should return a /datum/tgs_message_content to respond to the issuer with.
sender - The /datum/tgs_chat_user who issued the command. params - The trimmed string following the command `/datum/tgs_chat_command/var/name].