Package command_system :: Package implementation :: Module custom :: Class CustomCommonCommands
[hide private]
[frames] | no frames]

Class CustomCommonCommands

source code


The AUTOMATIC class variable, set to a positive value, instructs the command system to automatically discover the command container and enable it.

This command container bounds to all three available in the default implementation command hosts. This means that commands defined in this container will be available to all: chat, private chat and a group chat.

Nested Classes [hide private]

Inherited from framework.CommandContainer: __metaclass__

Instance Methods [hide private]
 
dance(self)
First line of the doc string is called a description and will be programmatically extracted and formatted.
source code

Inherited from object: __delattr__, __getattribute__, __hash__, __init__, __new__, __reduce__, __reduce_ex__, __repr__, __setattr__, __str__

Class Variables [hide private]
  AUTOMATIC = True
  HOSTS = ChatCommands, PrivateChatCommands, GroupChatCommands
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

dance(self)

source code 

First line of the doc string is called a description and will be programmatically extracted and formatted.

After that you can give more help, like explanation of the options. This one will be programatically extracted and formatted too.

After all the documentation - there will be autogenerated (based on the method signature) usage information appended. You can turn it off, if you want.

Decorators:
  • @command

Class Variable Details [hide private]

AUTOMATIC

Value:
True

HOSTS

Value:
ChatCommands, PrivateChatCommands, GroupChatCommands