-
Notifications
You must be signed in to change notification settings - Fork 38
Expand file tree
/
Copy pathhooks.html
More file actions
336 lines (269 loc) · 25.7 KB
/
Copy pathhooks.html
File metadata and controls
336 lines (269 loc) · 25.7 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
<!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.hooks — Source.Python v742 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=12c636f2"></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 v742 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.hooks</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for entities.hooks</h1><div class="highlight"><pre>
<span></span><span class="c1"># ../entities/hooks.py</span>
<span class="sd">"""Provides memory hooking functionality for entities."""</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"># Entities</span>
<span class="c1"># Memory</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">memory.hooks</span><span class="w"> </span><span class="kn">import</span> <span class="n">HookType</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"># 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">OnNetworkedEntityCreated</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="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="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">'EntityCondition'</span><span class="p">,</span>
<span class="s1">'EntityPostHook'</span><span class="p">,</span>
<span class="s1">'EntityPreHook'</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="EntityCondition">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityCondition">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">EntityCondition</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Store some default entity conditions."""</span>
<div class="viewcode-block" id="EntityCondition.is_player">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityCondition.is_player">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_player</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return ``True`` if the entity is a player.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">entity</span><span class="o">.</span><span class="n">is_player</span><span class="p">()</span></div>
<div class="viewcode-block" id="EntityCondition.is_not_player">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityCondition.is_not_player">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_not_player</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return ``True`` if the entity is not a player.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="ow">not</span> <span class="n">entity</span><span class="o">.</span><span class="n">is_player</span><span class="p">()</span></div>
<div class="viewcode-block" id="EntityCondition.is_human_player">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityCondition.is_human_player">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_human_player</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return ``True`` if the entity is a human player.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">entity</span><span class="o">.</span><span class="n">is_player</span><span class="p">()</span> <span class="ow">and</span> <span class="n">Player</span><span class="p">(</span><span class="n">entity</span><span class="o">.</span><span class="n">index</span><span class="p">)</span><span class="o">.</span><span class="n">steamid</span> <span class="o">!=</span> <span class="s1">'BOT'</span></div>
<div class="viewcode-block" id="EntityCondition.is_bot_player">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityCondition.is_bot_player">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">is_bot_player</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return ``True`` if the entity is a bot.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="n">entity</span><span class="o">.</span><span class="n">is_player</span><span class="p">()</span> <span class="ow">and</span> <span class="n">Player</span><span class="p">(</span><span class="n">entity</span><span class="o">.</span><span class="n">index</span><span class="p">)</span><span class="o">.</span><span class="n">steamid</span> <span class="o">==</span> <span class="s1">'BOT'</span></div>
<div class="viewcode-block" id="EntityCondition.equals_entity_classname">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityCondition.equals_entity_classname">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">equals_entity_classname</span><span class="p">(</span><span class="o">*</span><span class="n">classnames</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return a function that requires an :class:`entities.entity.Entity``</span>
<span class="sd"> instace. The returned function returns ``True`` if the entity's</span>
<span class="sd"> classname equals one of the passed classnames.</span>
<span class="sd"> :rtype: lambda</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="k">lambda</span> <span class="n">entity</span><span class="p">:</span> <span class="n">entity</span><span class="o">.</span><span class="n">classname</span> <span class="ow">in</span> <span class="n">classnames</span></div>
<div class="viewcode-block" id="EntityCondition.equals_datamap_classname">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityCondition.equals_datamap_classname">[docs]</a>
<span class="nd">@staticmethod</span>
<span class="k">def</span><span class="w"> </span><span class="nf">equals_datamap_classname</span><span class="p">(</span><span class="o">*</span><span class="n">classnames</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return a function that requires an :class:`entities.entity.Entity``</span>
<span class="sd"> instance. The returned function returns ``True`` if the entity's</span>
<span class="sd"> datamap classname equals one of the passed classnames.</span>
<span class="sd"> :rtype: lambda</span>
<span class="sd"> """</span>
<span class="k">return</span> <span class="k">lambda</span> <span class="n">entity</span><span class="p">:</span> <span class="n">entity</span><span class="o">.</span><span class="n">datamap</span><span class="o">.</span><span class="n">class_name</span> <span class="ow">in</span> <span class="n">classnames</span></div>
</div>
<span class="k">class</span><span class="w"> </span><span class="nc">_EntityHook</span><span class="p">(</span><span class="n">AutoUnload</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Create entity pre and post hooks that auto unload."""</span>
<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">test_function</span><span class="p">,</span> <span class="n">function</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Initialize the hook object.</span>
<span class="sd"> :param callable test_function:</span>
<span class="sd"> A callable object that accepts an :class:`entities.entity.Entity`</span>
<span class="sd"> instance as a parameter. The function should return ``True`` if</span>
<span class="sd"> the entity matches the required one.</span>
<span class="sd"> :param str/callable function:</span>
<span class="sd"> This is the function to hook. It can be either a string that</span>
<span class="sd"> defines the name of a function of the entity or a callable object</span>
<span class="sd"> that returns a :class:`memory.Function` instance.</span>
<span class="sd"> """</span>
<span class="bp">self</span><span class="o">.</span><span class="n">test_function</span> <span class="o">=</span> <span class="n">test_function</span>
<span class="bp">self</span><span class="o">.</span><span class="n">function</span> <span class="o">=</span> <span class="n">function</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hooked_function</span> <span class="o">=</span> <span class="kc">None</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callback</span> <span class="o">=</span> <span class="kc">None</span>
<span class="k">def</span><span class="w"> </span><span class="fm">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">callback</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Store the callback and try initializing the hook.</span>
<span class="sd"> :param callable callback:</span>
<span class="sd"> The callback to store.</span>
<span class="sd"> :return:</span>
<span class="sd"> The passed callback.</span>
<span class="sd"> :rtype: callable</span>
<span class="sd"> """</span>
<span class="c1"># Validate the given callback...</span>
<span class="k">if</span> <span class="ow">not</span> <span class="nb">callable</span><span class="p">(</span><span class="n">callback</span><span class="p">):</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span><span class="s1">'Given callback is not callable.'</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">callback</span> <span class="o">=</span> <span class="n">callback</span>
<span class="c1"># Try initializing the hook...</span>
<span class="k">for</span> <span class="n">entity</span> <span class="ow">in</span> <span class="n">EntityIter</span><span class="p">():</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">initialize</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="c1"># Yay! The entity was the one we were looking for</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">callback</span>
<span class="c1"># Initialization failed. There is currently no entity with the given</span>
<span class="c1"># class name. So, we need to wait until such an entity has been</span>
<span class="c1"># created.</span>
<span class="n">_waiting_entity_hooks</span><span class="o">.</span><span class="n">append</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<span class="c1"># Return the callback</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">callback</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">hook_type</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the hook type of the decorator.</span>
<span class="sd"> :rtype: HookType</span>
<span class="sd"> """</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'No hook_type defined for class.'</span><span class="p">)</span>
<span class="k">def</span><span class="w"> </span><span class="nf">initialize</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">"""Initialize the hook.</span>
<span class="sd"> Return ``True`` if the initialization was successful.</span>
<span class="sd"> :rtype: bool</span>
<span class="sd"> """</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="o">.</span><span class="n">test_function</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="k">return</span> <span class="kc">False</span>
<span class="k">if</span> <span class="nb">callable</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">function</span><span class="p">):</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hooked_function</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</span><span class="p">(</span><span class="n">entity</span><span class="p">)</span>
<span class="k">else</span><span class="p">:</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hooked_function</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">entity</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">function</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hooked_function</span><span class="o">.</span><span class="n">add_hook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">hook_type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">callback</span><span class="p">)</span>
<span class="k">return</span> <span class="kc">True</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">"""Unload the hook."""</span>
<span class="c1"># Was a function hooked?</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">hooked_function</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span><span class="p">:</span>
<span class="c1"># Was no callback registered?</span>
<span class="k">if</span> <span class="bp">self</span><span class="o">.</span><span class="n">callback</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span>
<span class="c1"># Unregister the hook...</span>
<span class="bp">self</span><span class="o">.</span><span class="n">hooked_function</span><span class="o">.</span><span class="n">remove_hook</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">hook_type</span><span class="p">,</span> <span class="bp">self</span><span class="o">.</span><span class="n">callback</span><span class="p">)</span>
<span class="c1"># Otherwise, make sure the hook is still pending before removing it...</span>
<span class="k">elif</span> <span class="bp">self</span> <span class="ow">in</span> <span class="n">_waiting_entity_hooks</span><span class="p">:</span>
<span class="n">_waiting_entity_hooks</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
<div class="viewcode-block" id="EntityPreHook">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityPreHook">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">EntityPreHook</span><span class="p">(</span><span class="n">_EntityHook</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Decorator class used to create entity pre hooks that auto unload."""</span>
<span class="n">hook_type</span> <span class="o">=</span> <span class="n">HookType</span><span class="o">.</span><span class="n">PRE</span></div>
<div class="viewcode-block" id="EntityPostHook">
<a class="viewcode-back" href="../../developing/modules/entities.hooks.html#entities.hooks.EntityPostHook">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">EntityPostHook</span><span class="p">(</span><span class="n">_EntityHook</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Decorator class used to create entity post hooks that auto unload."""</span>
<span class="n">hook_type</span> <span class="o">=</span> <span class="n">HookType</span><span class="o">.</span><span class="n">POST</span></div>
<span class="k">class</span><span class="w"> </span><span class="nc">_WaitingEntityHooks</span><span class="p">(</span><span class="nb">list</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""A dictionary to store hooks waiting for intialization."""</span>
<span class="k">def</span><span class="w"> </span><span class="nf">initialize</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">"""Initialize all hooks waiting for the given entity.</span>
<span class="sd"> :param int index:</span>
<span class="sd"> Index of the entity that should be used to initialize the hooks.</span>
<span class="sd"> """</span>
<span class="c1"># There is nothing to do if no hook is waiting</span>
<span class="k">if</span> <span class="ow">not</span> <span class="bp">self</span><span class="p">:</span>
<span class="k">return</span>
<span class="n">entity</span> <span class="o">=</span> <span class="n">Entity</span><span class="p">(</span><span class="n">index</span><span class="p">)</span>
<span class="k">for</span> <span class="n">hook</span> <span class="ow">in</span> <span class="nb">tuple</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="c1"># Try initializing the hook</span>
<span class="k">if</span> <span class="n">hook</span><span class="o">.</span><span class="n">initialize</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="c1"># If it succeeded, remove the hook from the waiting list</span>
<span class="bp">self</span><span class="o">.</span><span class="n">remove</span><span class="p">(</span><span class="n">hook</span><span class="p">)</span>
<span class="n">_waiting_entity_hooks</span> <span class="o">=</span> <span class="n">_WaitingEntityHooks</span><span class="p">()</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> LISTENERS</span>
<span class="c1"># =============================================================================</span>
<span class="nd">@OnNetworkedEntityCreated</span>
<span class="k">def</span><span class="w"> </span><span class="nf">on_networked_entity_created</span><span class="p">(</span><span class="n">entity</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when a new networked entity has been created."""</span>
<span class="n">_waiting_entity_hooks</span><span class="o">.</span><span class="n">initialize</span><span class="p">(</span><span class="n">entity</span><span class="o">.</span><span class="n">index</span><span class="p">)</span>
</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 v742 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.hooks</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>