forked from Source-Python-Dev-Team/Source.Python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdictionary.html
More file actions
143 lines (125 loc) · 8.47 KB
/
Copy pathdictionary.html
File metadata and controls
143 lines (125 loc) · 8.47 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
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
<!DOCTYPE html>
<html lang="en" data-content_root="../../">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>players.dictionary — Source.Python v743 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=03e43079" />
<link rel="stylesheet" type="text/css" href="../../_static/classic.css?v=2780edc4" />
<script src="../../_static/documentation_options.js?v=b6beb2eb"></script>
<script src="../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<link rel="icon" href="../../_static/sp_wiki_favicon.png"/>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
</head><body>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<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-1"><a href="../index.html" accesskey="U">Module code</a> »</li>
<li class="nav-item nav-item-this"><a href="">players.dictionary</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for players.dictionary</h1><div class="highlight"><pre>
<span></span><span class="c1"># ../players/dictionary.py</span>
<span class="sd">"""Provides helper class to store player instances."""</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> IMPORTS</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># Source.Python Imports</span>
<span class="c1"># Entities</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">entities.dictionary</span><span class="w"> </span><span class="kn">import</span> <span class="n">EntityDictionary</span>
<span class="c1"># Players</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">players.entity</span><span class="w"> </span><span class="kn">import</span> <span class="n">Player</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">players.helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">index_from_userid</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> ALL DECLARATION</span>
<span class="c1"># =============================================================================</span>
<span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s1">'PlayerDictionary'</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># ============================================================================</span>
<span class="c1"># >> CLASSES</span>
<span class="c1"># ============================================================================</span>
<div class="viewcode-block" id="PlayerDictionary">
<a class="viewcode-back" href="../../developing/modules/players.dictionary.html#players.dictionary.PlayerDictionary">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">PlayerDictionary</span><span class="p">(</span><span class="n">EntityDictionary</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Helper class used to store player instances."""</span>
<div class="viewcode-block" id="PlayerDictionary.__init__">
<a class="viewcode-back" href="../../developing/modules/players.dictionary.html#players.dictionary.PlayerDictionary.__init__">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">factory</span><span class="o">=</span><span class="n">Player</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Initializes the dictionary.</span>
<span class="sd"> :param callable factory:</span>
<span class="sd"> Factory class or function used to create missing instances. Set to</span>
<span class="sd"> `None` to disable this feature.</span>
<span class="sd"> Factory signature: index, *args, **kwargs</span>
<span class="sd"> :param tuple args:</span>
<span class="sd"> Arguments passed to the factory class or function.</span>
<span class="sd"> :param dict kwargs:</span>
<span class="sd"> Keyword arguments passed to the factory class or function.</span>
<span class="sd"> """</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">factory</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kwargs</span><span class="p">)</span></div>
<div class="viewcode-block" id="PlayerDictionary.from_userid">
<a class="viewcode-back" href="../../developing/modules/players.dictionary.html#players.dictionary.PlayerDictionary.from_userid">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">from_userid</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">userid</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Returns a player instance from a userid.</span>
<span class="sd"> </span>
<span class="sd"> :param int userid: The userid.</span>
<span class="sd"> :rtype: Player</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="p">[</span><span class="n">index_from_userid</span><span class="p">(</span><span class="n">userid</span><span class="p">)]</span></div>
</div>
</pre></div>
<div class="clearer"></div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="Main">
<div class="sphinxsidebarwrapper">
<p class="logo"><a href="../../index.html">
<img class="logo" src="../../_static/sp_wiki_banner.png" alt="Logo of Source.Python"/>
</a></p>
<search id="searchbox" style="display: none" role="search">
<h3 id="searchlabel">Quick search</h3>
<div class="searchformwrapper">
<form class="search" action="../../search.html" method="get">
<input type="text" name="q" aria-labelledby="searchlabel" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false"/>
<input type="submit" value="Go" />
</form>
</div>
</search>
<script>document.getElementById('searchbox').style.display = "block"</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="Related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="../../genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<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-1"><a href="../index.html" >Module code</a> »</li>
<li class="nav-item nav-item-this"><a href="">players.dictionary</a></li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2025, Source.Python Development Team.
Created using <a href="https://www.sphinx-doc.org/">Sphinx</a> 8.2.3.
</div>
</body>
</html>