That-One-Nerd/SrcMod
1
0
Fork 0
Code Issues 30 Pull Requests Actions Packages Projects Releases 9 Wiki Activity

added some modules

That_One_Nerd 2023-03-16 11:09:40 -04:00
parent 8499fbbbc6
commit 163af74a03
1 changed files with 12 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
Modules.md

@ -1,5 +1,8 @@
# SrcMod/Modules # Overview
Modules in SrcMod are how commands are grouped. A module can have an id which must be prefixed before the command name and parameters when parsed. Modules are declared by applying the `ModuleAttribute` attribute in the namespace `SrcMod.Shell.Modules.ObjectModels` to a class. The classes can be static. Modules in SrcMod are how commands are grouped. A module can have an id which must be prefixed before the command name and parameters when parsed.
## How to Use
Modules are declared by applying the `ModuleAttribute` attribute in the namespace `SrcMod.Shell.Modules.ObjectModels` to a class. The classes can be static.
Here is an example: Here is an example:
```csharp ```csharp
@ -32,3 +35,10 @@ Inside the class will be the commands in that module.
--- ---
**Note: When using the `srcmod.dll` to add additional custom modules, the new modules will not be recognized due to a reflection bug. This will be fixed in the near future (see issue #2).** **Note: When using the `srcmod.dll` to add additional custom modules, the new modules will not be recognized due to a reflection bug. This will be fixed in the near future (see issue #2).**
# Default Modules
These are the name, prefix, and brief descriptions of each module implemented by default in SrcMod.
| Class Name | Prefix | Description |
|-|-|-|
| `BaseModule` | None (not prefixed) | A module with most system commands. Does not contain any modding functionality. |