Nebula 2 Script Interface
Notes for Users
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 examplenanimator also accepts nscenenode commands, and every class inherits nobject 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
Scriptable Classes
- nobject
- nroot
- napplication
- naudioserver3
- nbuddyclient
- ncaptureserver
- nconserver
- nenv
- nfilenode
- nfileserver2
- ngfxserver2
- nguiserver
- nguiskin
- nguiwidget
- nhttpserver
- ninputserver
- nluatest
- nnetclient
- nnetserver
- npersistserver
- nprefserver
- nscenenode
- nsceneserver
- nsessionclient
- nsessionclientcontext
- nsessionserver
- nsessionservercontext
- nshadowserver
- nsqlserver
- ntimeserver
- ntoolkitserver
- nvariableserver
- nvideoserver
- nroot
Notes for Developers
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
ntimeserver
@ superclass
nroot
@ classinfo
The ntimeserver object lives under the name /sys/servers/time
and provides a central time source for Nebula.
*/
Then put a comment block in front of each script function like this:
/**
@ cmd
gettime
@ input
v
@ output
f (Time)
@ info
Return current global time in seconds since the time server
was created.
*/
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.
