Changes between Version 2 and Version 3 of code/doc/ConsoleCommand

Timestamp:

Oct 1, 2008, 12:39:35 AM (16 years ago)

Author:

landauf

Comment:

—

code/doc/ConsoleCommand

@@ -30 +30 @@
 };
 }}}
+
+'''Important''': This works only for static memberfunctions of a class inheriting from [wiki:OrxonoxClass]. For any other combination see [wiki:ConsoleCommand#AdvancedCreation the chapter below].
 
 === Call ===
@@ -76 +78 @@
 Note: The attributes can be specified in any order.
 
+=== Advanced Creation ===
+There are several different macros so create a !ConsoleCommand:
+
+ * Static classfunction, class derived from [wiki:OrxonoxClass]
+  * '''SetConsoleCommand('''''classname, function, bCreateShortcut''''')''':
+   * Simple command, with or without shortcut
+  * '''SetConsoleCommandAlias('''''classname, function, name, bCreateShortcut''''')''':
+   * Command with a different name than the functionname, with or without shortcut
+  * '''SetConsoleCommandAliasMulti('''''classname, function, name, number, bCreateShortcut''''')''':
+   * Several commands with different names calling the same function, number must be different for each command, with or without shortcut[[br]][[br]]
+  * '''SetConsoleCommandGeneric('''''fakevariable, classname, command, bCreateShortcut''''')''':
+   * Custom command, you have to create !ConsoleCommand manually with new, fakevariable must be a unique name
+
+ * Static classfunction, class '''not''' derived from [wiki:OrxonoxClass]
+  * '''SetConsoleCommandShortcut('''''classname, function''''')''':
+   * Simple command, only a shortcut
+  * '''SetConsoleCommandShortcutAlias('''''classname, function, name''''')''':
+   * Shortcut with a different name than the functionname
+  * '''SetConsoleCommandShortcutAliasMulti('''''classname, function, name, number''''')''':
+   * Several shortcuts with different names calling the same function, number must be different for each command
+
+ * C-style function
+  * '''SetConsoleCommandShortcutExtern('''''function''''')''':
+   * Simple command, only a shortcut
+  * '''SetConsoleCommandShortcutExternAlias('''''function, name''''')''':
+   * Shortcut with a different name than the functionname
+  * '''SetConsoleCommandShortcutExternAliasMulti('''''function, name, number''''')''':
+   * Several shortcuts with different names calling the same function, number must be different for each command[[br]][[br]]
+  * '''SetConsoleCommandShortcutGeneric('''''fakevariable, command''''')''':
+   * Custom command, you have to create !ConsoleCommand manually with new, fakevariable must be a unique name
+
 == Access Levels ==
 -to come-