Orxonox: src/core/ConsoleCommand.h File Reference

# ConsoleCommand.h File Reference

`#include "CorePrereqs.h"`
`#include <boost/preprocessor/cat.hpp>`
`#include "ArgumentCompletionFunctions.h"`
`#include "CommandExecutor.h"`
`#include "Executor.h"`
`#include "Identifier.h"`

## Namespaces

namespace | orxonox
namespace | orxonox::AccessLevel

## Classes

class | orxonox::ConsoleCommand

## Defines

#define | SetConsoleCommand(classname, function, bCreateShortcut) SetConsoleCommandGeneric(classname, function, #function, bCreateShortcut)
#define | SetConsoleCommandAlias(classname, function, name, bCreateShortcut) SetConsoleCommandGeneric(classname, function, name, bCreateShortcut)
#define | SetConsoleCommandGeneric(classname, function, name, bCreateShortcut) orxonox::ConsoleCommand& BOOST_PP_CAT(classname##function##consolecommand__, __LINE__) = orxonox::ClassIdentifier<classname>::getIdentifier(#classname)->addConsoleCommand(orxonox::createConsoleCommand(orxonox::createFunctor(&classname::function), name), bCreateShortcut)
#define | SetConsoleCommandShortcut(classname, function) SetConsoleCommandShortcutAliasGeneric(classname, function, #function)
#define | SetConsoleCommandShortcutAlias(classname, function, name) SetConsoleCommandShortcutAliasGeneric(classname, function, name)
#define | SetConsoleCommandShortcutAliasGeneric(classname, function, name) SetConsoleCommandShortcutGeneric(BOOST_PP_CAT(function##consolecommand__, __LINE__), orxonox::createConsoleCommand(orxonox::createFunctor(&classname::function), name))
#define | SetConsoleCommandShortcutExtern(function) SetConsoleCommandShortcutExternAliasGeneric(function, #function)
#define | SetConsoleCommandShortcutExternAlias(function, name) SetConsoleCommandShortcutExternAliasGeneric(function, name)
#define | SetConsoleCommandShortcutExternAliasGeneric(function, name) SetConsoleCommandShortcutGeneric(BOOST_PP_CAT(function##consolecommand__, __LINE__), orxonox::createConsoleCommand(orxonox::createFunctor(&function), name))
#define | SetConsoleCommandShortcutGeneric(fakevariable, command) orxonox::ConsoleCommand& fakevariable = orxonox::CommandExecutor::addConsoleCommandShortcut(command, true)

## Enumerations

enum | orxonox::AccessLevel::Value { orxonox::AccessLevel::None, orxonox::AccessLevel::User, orxonox::AccessLevel::Admin, orxonox::AccessLevel::Offline, orxonox::AccessLevel::Debug, orxonox::AccessLevel::Disabled }

## Functions

ConsoleCommand * | orxonox::createConsoleCommand (Functor *functor, const std::string &name="")

## Define Documentation

#define SetConsoleCommand | ( | classname,
|  | function,
|  | bCreateShortcut |  | ) | SetConsoleCommandGeneric(classname, function, #function, bCreateShortcut)

#define SetConsoleCommandAlias | ( | classname,
|  | function,
|  | name,
|  | bCreateShortcut |  | ) | SetConsoleCommandGeneric(classname, function, name, bCreateShortcut)

#define SetConsoleCommandGeneric | ( | classname,
|  | function,
|  | name,
|  | bCreateShortcut |  | ) | orxonox::ConsoleCommand& BOOST_PP_CAT(classname##function##consolecommand__, __LINE__) = orxonox::ClassIdentifier<classname>::getIdentifier(#classname)->addConsoleCommand(orxonox::createConsoleCommand(orxonox::createFunctor(&classname::function), name), bCreateShortcut)

#define SetConsoleCommandShortcut | ( | classname,
|  | function |  | ) | SetConsoleCommandShortcutAliasGeneric(classname, function, #function)

#define SetConsoleCommandShortcutAlias | ( | classname,
|  | function,
|  | name |  | ) | SetConsoleCommandShortcutAliasGeneric(classname, function, name)

#define SetConsoleCommandShortcutAliasGeneric | ( | classname,
|  | function,
|  | name |  | ) | SetConsoleCommandShortcutGeneric(BOOST_PP_CAT(function##consolecommand__, __LINE__), orxonox::createConsoleCommand(orxonox::createFunctor(&classname::function), name))

#define SetConsoleCommandShortcutExtern | ( | function |  | ) | SetConsoleCommandShortcutExternAliasGeneric(function, #function)

#define SetConsoleCommandShortcutExternAlias | ( | function,
|  | name |  | ) | SetConsoleCommandShortcutExternAliasGeneric(function, name)

#define SetConsoleCommandShortcutExternAliasGeneric | ( | function,
|  | name |  | ) | SetConsoleCommandShortcutGeneric(BOOST_PP_CAT(function##consolecommand__, __LINE__), orxonox::createConsoleCommand(orxonox::createFunctor(&function), name))

#define SetConsoleCommandShortcutGeneric | ( | fakevariable,
|  | command |  | ) | orxonox::ConsoleCommand& fakevariable = orxonox::CommandExecutor::addConsoleCommandShortcut(command, true)