Source.Python/docs/developing/modules/commands.say.html at Data-Update · srpg/Source.Python · GitHub

Repository navigation

History

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

172

173

174

175

176

177

178

179

180

181

182

183

184

185

186

187

188

189

190

191

192

<!DOCTYPE html>

<head>

<title>commands.say package — Source.Python v743 documentation</title>

</head><body>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

accesskey="I">index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-this"><a href="">commands.say package</a></li>

</ul>

</div>

<h1>commands.say package<a class="headerlink" href="#module-commands.say" title="Link to this heading">¶</a></h1>

Provides say command and say filter functionality.

class commands.say.SayCommand(*args, **kwargs)<a class="reference internal" href="../../_modules/commands/say.html#SayCommand">[source]</a><a class="headerlink" href="#commands.say.SayCommand" title="Link to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">_BaseCommand</code>

Decorator class used to register a say command.

</dd></dl>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">instance</code>

__init__()<a class="headerlink" href="#commands.say.SayCommandDispatcher.__init__" title="Link to this definition">¶</a></dt>

<dd>Raises an exception

This class cannot be instantiated from Python

</dd></dl>

add_callback((SayCommandDispatcher)arg1, (object)callable) → None :<a class="headerlink" href="#commands.say.SayCommandDispatcher.add_callback" title="Link to this definition">¶</a></dt>

<dd>Adds a callback to the say command’s list.

</dd></dl>

remove_callback((SayCommandDispatcher)arg1, (object)callable) → None :<a class="headerlink" href="#commands.say.SayCommandDispatcher.remove_callback" title="Link to this definition">¶</a></dt>

<dd>Removes a callback from the say command’s list.

</dd></dl>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">instance</code>

__init__((object)arg1) → <a class="reference external" href="https://docs.python.org/3.13/library/constants.html#None" title="(in Python v3.13)">None</a><a class="headerlink" href="#commands.say.SayCommandGenerator.__init__" title="Link to this definition">¶</a></dt>

</dd></dl>

class commands.say.SayFilter(*args, **kwargs)<a class="reference internal" href="../../_modules/commands/say.html#SayFilter">[source]</a><a class="headerlink" href="#commands.say.SayFilter" title="Link to this definition">¶</a></dt>

<dd>Bases: <code class="xref py py-class docutils literal notranslate">_BaseFilter</code>

Class used to register a say filter.

</dd></dl>

commands.say.get_say_command((str)name) → SayCommandDispatcher :<a class="headerlink" href="#commands.say.get_say_command" title="Link to this definition">¶</a></dt>

<dd>Returns the SayCommandDispatcher instance for the given command

</dd></dl>

commands.say.register_say_filter((object)callable) → None :<a class="headerlink" href="#commands.say.register_say_filter" title="Link to this definition">¶</a></dt>

<dd>Registers a callable to be called when clients use the say commands (say, say_team).

</dd></dl>

commands.say.unregister_say_filter((object)callable) → None :<a class="headerlink" href="#commands.say.unregister_say_filter" title="Link to this definition">¶</a></dt>

<dd>Unregisters a say filter.

</dd></dl>

commands.say.say_command_manager<a class="headerlink" href="#commands.say.say_command_manager" title="Link to this definition">¶</a></dt>

<dd>The singleton object of the <code class="xref py py-class docutils literal notranslate">_SayCommandManager</code> class.

</dd></dl>

</section>

</div>

</a>

<div>

<h3><a href="../../index.html">Table of Contents</a></h3>

<ul>

<li><a class="reference internal" href="#">commands.say package</a><ul>

<li><a class="reference internal" href="#commands.say.SayCommand"><code class="docutils literal notranslate">SayCommand</code></a></li>

<li><a class="reference internal" href="#commands.say.SayCommandDispatcher"><code class="docutils literal notranslate">SayCommandDispatcher</code></a><ul>

<li><a class="reference internal" href="#commands.say.SayCommandDispatcher.__init__"><code class="docutils literal notranslate">SayCommandDispatcher.__init__()</code></a></li>

<li><a class="reference internal" href="#commands.say.SayCommandDispatcher.add_callback"><code class="docutils literal notranslate">SayCommandDispatcher.add_callback()</code></a></li>

<li><a class="reference internal" href="#commands.say.SayCommandDispatcher.remove_callback"><code class="docutils literal notranslate">SayCommandDispatcher.remove_callback()</code></a></li>

</ul>

</li>

<li><a class="reference internal" href="#commands.say.SayCommandGenerator"><code class="docutils literal notranslate">SayCommandGenerator</code></a><ul>

<li><a class="reference internal" href="#commands.say.SayCommandGenerator.__init__"><code class="docutils literal notranslate">SayCommandGenerator.__init__()</code></a></li>

</ul>

</li>

<li><a class="reference internal" href="#commands.say.SayFilter"><code class="docutils literal notranslate">SayFilter</code></a></li>

<li><a class="reference internal" href="#commands.say.get_say_command"><code class="docutils literal notranslate">get_say_command()</code></a></li>

<li><a class="reference internal" href="#commands.say.register_say_filter"><code class="docutils literal notranslate">register_say_filter()</code></a></li>

<li><a class="reference internal" href="#commands.say.unregister_say_filter"><code class="docutils literal notranslate">unregister_say_filter()</code></a></li>

<li><a class="reference internal" href="#commands.say.say_command_manager"><code class="docutils literal notranslate">say_command_manager</code></a></li>

</ul>

</li>

</ul>

</div>

<li><a href="../../_sources/developing/modules/commands.say.rst.txt"

rel="nofollow">Show Source</a></li>

</ul>

</div>

<h3 id="searchlabel">Quick search</h3>

</form>

</div>

</search>

</div>

</div>

<h3>Navigation</h3>

<ul>

<a href="../../genindex.html" title="General Index"

>index</a></li>

<a href="../../py-modindex.html" title="Python Module Index"

>modules</a> |</li>

<li class="nav-item nav-item-0"><a href="../../index.html"> Source.Python v743 documentation</a> »</li>

<li class="nav-item nav-item-this"><a href="">commands.say package</a></li>

</ul>

</div>

Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.

</div>

</body>

</html>

Source.Python/docs/developing/modules/commands.say.html at Data-Update · srpg/Source.Python · GitHub

Repository navigation

Expand file tree

Breadcrumbs

commands.say.html

Latest commit

History

Breadcrumbs

commands.say.html

File metadata and controls