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
340 lines (276 loc) · 26.2 KB
/
Copy pathdictionary.html
File metadata and controls
340 lines (276 loc) · 26.2 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
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
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
<!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>entities.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="">entities.dictionary</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for entities.dictionary</h1><div class="highlight"><pre>
<span></span><span class="c1"># ../entities/dictionary.py</span>
<span class="sd">"""Provides helper class to store entity 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"># Core</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">core</span><span class="w"> </span><span class="kn">import</span> <span class="n">AutoUnload</span>
<span class="c1"># Filters</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">filters.entities</span><span class="w"> </span><span class="kn">import</span> <span class="n">EntityIter</span>
<span class="c1"># Entities</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">entities.entity</span><span class="w"> </span><span class="kn">import</span> <span class="n">Entity</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">entities.helpers</span><span class="w"> </span><span class="kn">import</span> <span class="n">index_from_inthandle</span>
<span class="c1"># Listeners</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">listeners</span><span class="w"> </span><span class="kn">import</span> <span class="n">on_networked_entity_created_listener_manager</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">listeners</span><span class="w"> </span><span class="kn">import</span> <span class="n">on_networked_entity_deleted_listener_manager</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">'EntityDictionary'</span><span class="p">,</span>
<span class="s1">'SyncedEntityDictionary'</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="EntityDictionary">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.EntityDictionary">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">EntityDictionary</span><span class="p">(</span><span class="n">AutoUnload</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Helper class used to store entity instances."""</span>
<div class="viewcode-block" id="EntityDictionary.__init__">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.EntityDictionary.__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">Entity</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="c1"># Store the given entity class...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_factory</span> <span class="o">=</span> <span class="n">factory</span>
<span class="c1"># Store given arguments/keywords</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_args</span> <span class="o">=</span> <span class="n">args</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_kwargs</span> <span class="o">=</span> <span class="n">kwargs</span>
<span class="c1"># Register our networked entity deletion listener...</span>
<span class="n">on_networked_entity_deleted_listener_manager</span><span class="o">.</span><span class="n">register_listener</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_on_networked_entity_deleted</span><span class="p">)</span>
<span class="c1"># Initialize the dictionary...</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span></div>
<span class="k">def</span><span class="w"> </span><span class="fm">__missing__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when an instance is requested but missing.</span>
<span class="sd"> :param int index:</span>
<span class="sd"> The index of the entity instance requested.</span>
<span class="sd"> :raises KeyError:</span>
<span class="sd"> If the auto-construction of missing instances is disabled or the</span>
<span class="sd"> factory class or function fails to return an instance.</span>
<span class="sd"> """</span>
<span class="c1"># Get the factory</span>
<span class="n">factory</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">_factory</span>
<span class="c1"># Let's mimic dict's behaviour if the factory is set to None</span>
<span class="k">if</span> <span class="n">factory</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="c1"># For uniformity reasons, ensure we only raise a KeyError</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">instance</span> <span class="o">=</span> <span class="n">factory</span><span class="p">(</span><span class="n">index</span><span class="p">,</span> <span class="o">*</span><span class="bp">self</span><span class="o">.</span><span class="n">_args</span><span class="p">,</span> <span class="o">**</span><span class="bp">self</span><span class="o">.</span><span class="n">_kwargs</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">e</span><span class="p">)</span><span class="o">.</span><span class="n">with_traceback</span><span class="p">(</span><span class="n">e</span><span class="o">.</span><span class="n">__traceback__</span><span class="p">)</span> <span class="kn">from</span><span class="w"> </span><span class="kc">None</span>
<span class="c1"># Only cache entities that are not marked for deletion.</span>
<span class="c1"># This is required, because if someone request an entity instance</span>
<span class="c1"># after we invalidated our cache but before the engine processed</span>
<span class="c1"># the deletion we would now have an invalid instance in the cache.</span>
<span class="k">if</span> <span class="p">(</span><span class="ow">not</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">instance</span><span class="p">,</span> <span class="n">Entity</span><span class="p">)</span> <span class="ow">or</span>
<span class="ow">not</span> <span class="n">instance</span><span class="o">.</span><span class="n">is_marked_for_deletion</span><span class="p">()):</span>
<span class="bp">self</span><span class="p">[</span><span class="n">index</span><span class="p">]</span> <span class="o">=</span> <span class="n">instance</span>
<span class="k">return</span> <span class="n">instance</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__delitem__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Removes the given index from the dictionary.</span>
<span class="sd"> :param int index:</span>
<span class="sd"> The index of the entity instance being removed.</span>
<span class="sd"> """</span>
<span class="c1"># Remove the given index from the dictionary...</span>
<span class="k">try</span><span class="p">:</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__delitem__</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">KeyError</span><span class="p">:</span>
<span class="k">pass</span>
<div class="viewcode-block" id="EntityDictionary.from_inthandle">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.EntityDictionary.from_inthandle">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">from_inthandle</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">inthandle</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Returns an entity instance from an inthandle.</span>
<span class="sd"> </span>
<span class="sd"> :param int inthandle:</span>
<span class="sd"> The inthandle.</span>
<span class="sd"> :rtype: Entity</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="bp">self</span><span class="p">[</span><span class="n">index_from_inthandle</span><span class="p">(</span><span class="n">inthandle</span><span class="p">)]</span></div>
<div class="viewcode-block" id="EntityDictionary.on_automatically_removed">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.EntityDictionary.on_automatically_removed">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">on_automatically_removed</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when an index is automatically removed.</span>
<span class="sd"> :param int index:</span>
<span class="sd"> The index of the entity instance being removed.</span>
<span class="sd"> """</span></div>
<span class="k">def</span><span class="w"> </span><span class="nf">_on_networked_entity_deleted</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entity</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Internal networked entity deletion callback.</span>
<span class="sd"> :param Entity entity:</span>
<span class="sd"> The networked entity being removed.</span>
<span class="sd"> """</span>
<span class="c1"># Get the index of the entity</span>
<span class="n">index</span> <span class="o">=</span> <span class="n">entity</span><span class="o">.</span><span class="n">index</span>
<span class="c1"># No need to go further if there is no object associated to this index</span>
<span class="k">if</span> <span class="n">index</span> <span class="ow">not</span> <span class="ow">in</span> <span class="bp">self</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">try</span><span class="p">:</span>
<span class="c1"># Call the deletion callback for the index...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_automatically_removed</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="k">finally</span><span class="p">:</span>
<span class="c1"># Remove the index from the dictionary...</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__delitem__</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_unload_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Unregister our networked entity deletion listener."""</span>
<span class="n">on_networked_entity_deleted_listener_manager</span><span class="o">.</span><span class="n">unregister_listener</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_on_networked_entity_deleted</span><span class="p">)</span></div>
<div class="viewcode-block" id="SyncedEntityDictionary">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.SyncedEntityDictionary">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">SyncedEntityDictionary</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 keep entity instances synced with the game."""</span>
<div class="viewcode-block" id="SyncedEntityDictionary.__init__">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.SyncedEntityDictionary.__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">Entity</span><span class="p">,</span> <span class="n">iterator</span><span class="o">=</span><span class="n">EntityIter</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.</span>
<span class="sd"> Factory signature: index, *args, **kwargs</span>
<span class="sd"> :param iterable iterator:</span>
<span class="sd"> Iterator used to generates instances on initialization and resync.</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"> :raise ValueError:</span>
<span class="sd"> If the factory is set to None.</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="n">factory</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">raise</span> <span class="ne">ValueError</span><span class="p">(</span>
<span class="s1">'Factory cannot be None for synced dictionaries.'</span><span class="p">)</span>
<span class="c1"># Initialize the dictionary</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>
<span class="c1"># Store the given iterator and resync the dictionary</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_iterator</span> <span class="o">=</span> <span class="n">iterator</span>
<span class="bp">self</span><span class="o">.</span><span class="n">resync</span><span class="p">()</span>
<span class="c1"># Register our networked entity creation listener</span>
<span class="n">on_networked_entity_created_listener_manager</span><span class="o">.</span><span class="n">register_listener</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_on_networked_entity_created</span><span class="p">)</span></div>
<span class="k">def</span><span class="w"> </span><span class="fm">__missing__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Raises a KeyError, because creation of missing instances is not</span>
<span class="sd"> allowed for synced dictionaries.</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<div class="viewcode-block" id="SyncedEntityDictionary.resync">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.SyncedEntityDictionary.resync">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">resync</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Resync the dictionary with the game."""</span>
<span class="c1"># Clear the dictionary</span>
<span class="bp">self</span><span class="o">.</span><span class="n">clear</span><span class="p">()</span>
<span class="c1"># Loop through all entities and add them to the dictionary</span>
<span class="k">for</span> <span class="n">entity</span> <span class="ow">in</span> <span class="bp">self</span><span class="o">.</span><span class="n">_iterator</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_on_networked_entity_created</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span></div>
<div class="viewcode-block" id="SyncedEntityDictionary.on_automatically_created">
<a class="viewcode-back" href="../../developing/modules/entities.dictionary.html#entities.dictionary.SyncedEntityDictionary.on_automatically_created">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">on_automatically_created</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">index</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when an index is automatically added.</span>
<span class="sd"> :param int index:</span>
<span class="sd"> The index of the entity instance being added.</span>
<span class="sd"> """</span></div>
<span class="k">def</span><span class="w"> </span><span class="nf">_on_networked_entity_created</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">entity</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Internal networked entity creation callback.</span>
<span class="sd"> :param Entity entity:</span>
<span class="sd"> The networked entity being created.</span>
<span class="sd"> """</span>
<span class="c1"># Validate the entity</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">_iterator</span><span class="o">.</span><span class="n">_is_valid</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="k">return</span>
<span class="c1"># Get the index of the entity</span>
<span class="n">index</span> <span class="o">=</span> <span class="n">entity</span><span class="o">.</span><span class="n">index</span>
<span class="c1"># Add the index to the dictionary</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__missing__</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="c1"># Call the creation callback for the index</span>
<span class="bp">self</span><span class="o">.</span><span class="n">on_automatically_created</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_unload_instance</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Unregister our networked entity creation listener."""</span>
<span class="n">on_networked_entity_created_listener_manager</span><span class="o">.</span><span class="n">unregister_listener</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">_on_networked_entity_created</span><span class="p">)</span>
<span class="c1"># Unload the dictionary</span>
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="n">_unload_instance</span><span class="p">()</span></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="">entities.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>