Command reference
Prog
Command words: prog
Permission: Admin
The prog command is used to view, create and edit progs. Progs are used all over the code to provide customisable logic, and can also be used for 'scripting' systems that fill in gaps in functionality that the engine doesn't cover.
Progs in FutureMUD are strongly-typed and compiled - this means that the engine will check ahead of time whether a prog is valid. It also provides a substantial performance boost to the actual execution of the progs.
You can use the following commands to interact with progs:
prog list - this shows you all progs. It is the same as the show progs command
prog categories - shows a list of categories that existing progs fall into
prog categories <which> - shows a list of all progs in the specified category
prog show <which> - shows you information about a prog. It is the same as the show prog <which> command
prog edit <which> - begins to edit a prog
prog edit close - stops editing a prog
prog edit new <name> - creates and begins editing a new blank prog
prog edit newevent <event> <name> - creates and begins editing a new prog with parameters based on an event type
prog compile - forces all progs to recompile (if necessary for some reason)
prog execute <prog> [<parameters>] - manually executes a prog. You must be able to resolve the parameters.
The following filters can be used with prog list:
<category> - shows only progs in the specified category
*<subcategory> - shows only progs in the specified subcategory
+<keyword> - shows progs with the specified keyword in the name or comments
-<keyword> - shows progs without the specified keyword in the name or comments
&<keyword> - shows progs with the specified keyword in the name, comments or function body
uncompiled - shows progs that haven't compiled and have an error
The following commands are used to edit a prog:
prog set name <name> - sets a new name for this prog
prog set category <category> - changes the category of this prog
prog set subcategory <category> - changes the subcategory of this prog
prog set comment - drops you into an editor to enter an explanatory comment about this prog
prog set anyparameters - toggles this prog accepting any combination of parameters (and ignoring them)
prog set return <type> - changes the return type of this prog
prog set static - toggles this prog being static (same output regardless of input). Use with caution.
prog set text - drops you into an editor to set the content of the prog
prog set append - the same as above, except keeps existing text rather than clearing it.
prog set parameter add <name> <type> - adds an input parameter to the prog
prog set parameter remove <name> - deletes an input parameter from the prog
prog set paramater swap <par1> <par2> - swaps the order of two parameters
There are also a few commands relating to prog help:
prog help types - shows all the variable types
prog help type <type> - shows detailed information about a variable type
prog help functions - shows a (very very long) list of all the in-built functions
prog help function <which> - shows detailed help about a particular function
prog help collections - shows a list of special collection functions
prog help collection <which> - shows help for a specific collection function
prog help statements - shows a list of the basic language syntax and statements
See also the closely related hook and events areas for some further supporting information.
Permission: Admin
The prog command is used to view, create and edit progs. Progs are used all over the code to provide customisable logic, and can also be used for 'scripting' systems that fill in gaps in functionality that the engine doesn't cover.
Progs in FutureMUD are strongly-typed and compiled - this means that the engine will check ahead of time whether a prog is valid. It also provides a substantial performance boost to the actual execution of the progs.
You can use the following commands to interact with progs:
prog list - this shows you all progs. It is the same as the show progs command
prog categories - shows a list of categories that existing progs fall into
prog categories <which> - shows a list of all progs in the specified category
prog show <which> - shows you information about a prog. It is the same as the show prog <which> command
prog edit <which> - begins to edit a prog
prog edit close - stops editing a prog
prog edit new <name> - creates and begins editing a new blank prog
prog edit newevent <event> <name> - creates and begins editing a new prog with parameters based on an event type
prog compile - forces all progs to recompile (if necessary for some reason)
prog execute <prog> [<parameters>] - manually executes a prog. You must be able to resolve the parameters.
The following filters can be used with prog list:
<category> - shows only progs in the specified category
*<subcategory> - shows only progs in the specified subcategory
+<keyword> - shows progs with the specified keyword in the name or comments
-<keyword> - shows progs without the specified keyword in the name or comments
&<keyword> - shows progs with the specified keyword in the name, comments or function body
uncompiled - shows progs that haven't compiled and have an error
The following commands are used to edit a prog:
prog set name <name> - sets a new name for this prog
prog set category <category> - changes the category of this prog
prog set subcategory <category> - changes the subcategory of this prog
prog set comment - drops you into an editor to enter an explanatory comment about this prog
prog set anyparameters - toggles this prog accepting any combination of parameters (and ignoring them)
prog set return <type> - changes the return type of this prog
prog set static - toggles this prog being static (same output regardless of input). Use with caution.
prog set text - drops you into an editor to set the content of the prog
prog set append - the same as above, except keeps existing text rather than clearing it.
prog set parameter add <name> <type> - adds an input parameter to the prog
prog set parameter remove <name> - deletes an input parameter from the prog
prog set paramater swap <par1> <par2> - swaps the order of two parameters
There are also a few commands relating to prog help:
prog help types - shows all the variable types
prog help type <type> - shows detailed information about a variable type
prog help functions - shows a (very very long) list of all the in-built functions
prog help function <which> - shows detailed help about a particular function
prog help collections - shows a list of special collection functions
prog help collection <which> - shows help for a specific collection function
prog help statements - shows a list of the basic language syntax and statements
See also the closely related hook and events areas for some further supporting information.