commands.cpp File Reference

#include "fcintl.h"
#include "connection.h"
#include "mapimg.h"
#include "commands.h"
#include "voting.h"
#include "difficulty.h"

Include dependency graph for commands.cpp:

Go to the source code of this file.

Classes
struct	command

Macros
#define	SYN_ORIG_(String)   "*" String
#define	SYN_TRANS_(String)   ('*' == String[0] ? String + 1 : _(String))

Functions
const struct command *	command_by_number (int i)
	Return command by its number. More...
const char *	command_name (const struct command *pcommand)
	Return name of the command. More...
const char *	command_name_by_number (int i)
	Return name of the command by commands number. More...
const char *	command_synopsis (const struct command *pcommand)
	Returns the synopsis text of the command (translated). More...
const char *	command_short_help (const struct command *pcommand)
	Returns the short help text of the command (translated). More...
char *	command_extra_help (const struct command *pcommand)
	Returns the extra help text of the command (translated). More...
enum cmdlevel	command_level (const struct command *pcommand)
	What is the permissions level required for running the command? More...
enum cmd_echo	command_echo (const struct command *pcommand)
	Returns the flag of the command to notify the users about its usage. More...
int	command_vote_flags (const struct command *pcommand)
	Returns a bit-wise combination of all vote flags set for this command. More...
int	command_vote_percent (const struct command *pcommand)
	Returns the vote percent required for this command to pass in a vote. More...

Variables
static struct command	commands []

Macro Definition Documentation

SYN_ORIG_

#define SYN_ORIG_

(

String

)

"*" String

Definition at line 27 of file commands.cpp.

SYN_TRANS_

#define SYN_TRANS_

(

String

)

('*' == String[0] ? String + 1 : _(String))

Definition at line 29 of file commands.cpp.

Function Documentation

command_by_number()

const struct command* command_by_number

(

int

i

)

Return command by its number.

Definition at line 701 of file commands.cpp.

Referenced by command_name_by_number(), debug_command(), detach_command(), handle_stdin_input_real(), load_command(), lookup_option_level(), manual_command(), may_use(), observe_command(), set_command(), show_help_command(), take_command(), team_command(), vote_command(), vote_new(), and vote_would_pass_immediately().

command_echo()

enum cmd_echo command_echo

(

const struct command *

pcommand

)

Returns the flag of the command to notify the users about its usage.

Definition at line 743 of file commands.cpp.

Referenced by handle_stdin_input_real().

command_extra_help()

char* command_extra_help

(

const struct command *

pcommand

)

Returns the extra help text of the command (translated).

The caller must free this string.

Definition at line 743 of file commands.cpp.

Referenced by manual_command(), and show_help_command().

command_level()

enum cmdlevel command_level

(

const struct command *

pcommand

)

What is the permissions level required for running the command?

Definition at line 743 of file commands.cpp.

Referenced by handle_stdin_input_real(), manual_command(), may_use(), and show_help_command().

command_name()

const char* command_name

(

const struct command *

pcommand

)

Return name of the command.

Definition at line 710 of file commands.cpp.

Referenced by manual_command(), show_help_command(), and vote_new().

command_name_by_number()

const char* command_name_by_number

(

int

i

)

Return name of the command by commands number.

Definition at line 718 of file commands.cpp.

Referenced by cmd_reply_line(), command_generator(), handle_stdin_input_real(), helparg_accessor(), is_cmdlevel_arg1(), is_cmdlevel_arg2(), is_command(), is_connection(), is_create_arg2(), is_delegate_arg1(), is_enum_option_value(), is_fcdb(), is_filename(), is_help(), is_list(), is_lua(), is_mapimg(), is_option_level(), is_player(), is_reset(), is_server_option(), is_vote(), and show_help_command_list().

command_short_help()

const char* command_short_help

(

const struct command *

pcommand

)

Returns the short help text of the command (translated).

Definition at line 734 of file commands.cpp.

Referenced by manual_command(), and show_help_command().

command_synopsis()

const char* command_synopsis

(

const struct command *

pcommand

)

Returns the synopsis text of the command (translated).

Definition at line 726 of file commands.cpp.

Referenced by debug_command(), detach_command(), load_command(), lookup_option_level(), manual_command(), observe_command(), set_command(), show_help_command(), take_command(), team_command(), and vote_command().

command_vote_flags()

int command_vote_flags

(

const struct command *

pcommand

)

Returns a bit-wise combination of all vote flags set for this command.

Definition at line 774 of file commands.cpp.

Referenced by vote_new(), and vote_would_pass_immediately().

command_vote_percent()

int command_vote_percent

(

const struct command *

pcommand

)

Returns the vote percent required for this command to pass in a vote.

Definition at line 782 of file commands.cpp.

Referenced by vote_new(), and vote_would_pass_immediately().

Variable Documentation

commands

struct command commands[]

static

Definition at line 1 of file commands.cpp.

Referenced by command_by_number().