code/__DEFINES/admin_verb.dm
_ADMIN_VERB | This is the only macro you should use to define admin verbs.
It will define the verb and the verb holder for you.
Using it is very simple:
ADMIN_VERB(verb_path, R_PERM, "Name", "Description", "Admin.Category", args...)
This sets up all of the above and also acts as syntatic sugar as a verb delcaration for the verb itself.
Note that the verb args have an injected client/user argument that is the user that called the verb.
Do not use usr in your verb; technically you can but I'll kill you. |
---|---|
ADMIN_VERB_CUSTOM_EXIST_CHECK | Used to define a special check to determine if the admin verb should exist at all. Useful for verbs such as play sound which require configuration. |
ADMIN_VERB_VISIBILITY | Used to define the visibility flag of the verb. If the admin does not have this flag enabled they will not see the verb. |
ADMIN_VERB_NO_DESCRIPTION | Use this to mark your verb as not having a description. Should ONLY be used if you are also hiding the verb! |
ADMIN_CATEGORY_HIDDEN | Used to verbs you do not want to show up in the master verb panel. |
Define Details
ADMIN_CATEGORY_HIDDEN
Used to verbs you do not want to show up in the master verb panel.
ADMIN_VERB_CUSTOM_EXIST_CHECK
Used to define a special check to determine if the admin verb should exist at all. Useful for verbs such as play sound which require configuration.
ADMIN_VERB_NO_DESCRIPTION
Use this to mark your verb as not having a description. Should ONLY be used if you are also hiding the verb!
ADMIN_VERB_VISIBILITY
Used to define the visibility flag of the verb. If the admin does not have this flag enabled they will not see the verb.
_ADMIN_VERB
This is the only macro you should use to define admin verbs.
It will define the verb and the verb holder for you.
Using it is very simple:
ADMIN_VERB(verb_path, R_PERM, "Name", "Description", "Admin.Category", args...)
This sets up all of the above and also acts as syntatic sugar as a verb delcaration for the verb itself.
Note that the verb args have an injected client/user
argument that is the user that called the verb.
Do not use usr in your verb; technically you can but I'll kill you.