Select the class you're interested in from the tree below. Each class documents
the commands that that class defines, plus a class also inherits commands from
its parent. For example nipol
also accepts nanimnode
commands, and every class inherits nroot
commands.
You can use the command getcmds
on any class to see a full
list of commands for that class.
The input / output parameter information for each command uses a single letter code to represent the type of the parameter.
f - float value i - integer value o - object reference s - string value l - list value b - true|false v - no parameters
In order for your commands to be documented here you must put the functions
in a file called *_cmds.cc
. To describe the class use a comment
block like this, usually put in front of the n_initcmds
function:
//------------------------------------------------------------------------------ /** @scriptclass nchannelserver @superclass nroot @classinfo Manages the animation channels. */
Then put a comment block in front of each script function like this:
//------------------------------------------------------------------------------ /** @cmd setchannel1f @input s (ChannelName), f (Value) @output v @info Set channel to a float value. */
This will be output as is so make sure to wrap
your text at a reasonable point, and try to use spaces instead of tabs.
See any *_cmds.cc
file for more detail.