Change command-default setting names to be more consistent with other settings; changed Command.msg_share to Command.msg_all_sessions to make it clearer what it does.

This commit is contained in:
Griatch 2017-02-12 10:34:59 +01:00
parent fafe2e779e
commit 80f7bb1cb5
2 changed files with 24 additions and 21 deletions

View file

@ -342,24 +342,26 @@ CMDSET_PATHS = ["commands", "evennia", "contribs"]
# Parent class for all default commands. Changing this class will
# modify all default commands, so do so carefully.
COMMAND_DEFAULT_CLASS = "evennia.commands.default.muxcommand.MuxCommand"
# Command.arg_regex is a regular expression desribing how the arguments
# to the command must be structured for the command to match a given user
# input. By default there is no restriction as long as the input string
# starts with the command name.
COMMAND_DEFAULT_ARG_REGEX = None
# By default, Command.msg will only send data to the Session calling
# the Command in the first place. If set, Command.msg will instead return
# data to all Sessions connected to the Player/Character associated with
# calling the Command. This may be more intuitive for users in certain
# multisession modes.
COMMAND_DEFAULT_MSG_ALL_SESSIONS = False
# The help category of a command if not otherwise specified.
COMMAND_DEFAULT_HELP_CATEGORY = "general"
# The default lockstring of a command.
COMMAND_DEFAULT_LOCKS = ""
# The Channel Handler will create a command to represent each channel,
# creating it with the key of the channel, its aliases, locks etc. The
# default class logs channel messages to a file and allows for /history.
# This setting allows to override the command class used with your own.
CHANNEL_COMMAND_CLASS = "evennia.comms.channelhandler.ChannelCommand"
# These specify defaults to the base Command parent class. Override them
# in order to change default behavior for your commands.
# If specified, DEFAULT_COMMAND_ARG_REGEX forces a command's structure
# to match the given regular expression.
DEFAULT_COMMAND_ARG_REGEX = None
# If True, DEFAULT_COMMAND_MSG_SHARE will share a self.msg() to all sessions
# associated with the caller.
# If False, self.msg() will send a message only self.session.
DEFAULT_COMMAND_MSG_SHARE = False
# The help category of a command if not otherwise specified.
DEFAULT_COMMAND_HELP_CATEGORY = "general"
# The default lockstring of a command.
DEFAULT_COMMAND_LOCKS = ""
######################################################################
# Typeclasses and other paths