Class ScriptDocCommand

• Defined in File script_doc.hpp

Inheritance Relationships

Base Type

• public Blam::Console::ConsoleCommand (Class ConsoleCommand)

Class Documentation

class ScriptDocCommand : public Blam::Console::ConsoleCommand

Class for the script_doc command.

Writes a file describing each command, script function, and global within a file.

Public Functions

ScriptDocCommand()

~ScriptDocCommand()

CommandStatus onCommand(std::vector<std::string> arguments)

Called upon command execution.

Return

The status of the command execution. See Blam::Console::CommandStatus for details.

Parameters

• arguments: - The list of arguments passed to the command. Any space character in the command line is treated as a new argument.