Documentation on adding new built-in commands to FlightGear.
This commit is contained in:
parent
d43dfa54df
commit
4497c6d9e9
1 changed files with 32 additions and 0 deletions
32
docs-mini/README.commands
Normal file
32
docs-mini/README.commands
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
Binding New Commands in FlightGear
|
||||||
|
----------------------------------
|
||||||
|
|
||||||
|
|
||||||
|
To add a new command to FlightGear, you first need to create a
|
||||||
|
function that takes a single SGPropertyNode const pointer as an
|
||||||
|
argument:
|
||||||
|
|
||||||
|
void
|
||||||
|
do_something (SGPropertyNode * arg)
|
||||||
|
{
|
||||||
|
something();
|
||||||
|
}
|
||||||
|
|
||||||
|
Next, you need to register it with the command manager:
|
||||||
|
|
||||||
|
globals->get_commands()->addCommand("something", do_something);
|
||||||
|
|
||||||
|
Now, the command "something" is available to any mouse, joystick,
|
||||||
|
panel, or keyboard bindings. If the bindings pass any arguments, they
|
||||||
|
will be children of the SGPropertyNode passed in:
|
||||||
|
|
||||||
|
void
|
||||||
|
do_something (const SGPropertyNode * arg)
|
||||||
|
{
|
||||||
|
something(arg->getStringValue("foo"), arg->getDoubleValue("bar"));
|
||||||
|
}
|
||||||
|
|
||||||
|
That's pretty-much it. Apologies in advance for not making things any
|
||||||
|
more complicated.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue