forked from Source-Python-Dev-Team/Source.Python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathlisteners.html
More file actions
949 lines (692 loc) · 78.5 KB
/
Copy pathlisteners.html
File metadata and controls
949 lines (692 loc) · 78.5 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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
<!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>listeners — 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="">listeners</a></li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<h1>Source code for listeners</h1><div class="highlight"><pre>
<span></span><span class="c1"># ../listeners/__init__.py</span>
<span class="sd">"""Provides listener based functionality."""</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> IMPORTS</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># Python Imports</span>
<span class="kn">import</span><span class="w"> </span><span class="nn">socket</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">enum</span><span class="w"> </span><span class="kn">import</span> <span class="n">IntEnum</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">urllib.error</span><span class="w"> </span><span class="kn">import</span> <span class="n">URLError</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="kn">from</span><span class="w"> </span><span class="nn">core</span><span class="w"> </span><span class="kn">import</span> <span class="n">SOURCE_ENGINE</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">PLATFORM</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">core.settings</span><span class="w"> </span><span class="kn">import</span> <span class="n">_core_settings</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">core.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_last_successful_build_number</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">core.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">is_unversioned</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">core.version</span><span class="w"> </span><span class="kn">import</span> <span class="n">VERSION</span>
<span class="c1"># Cvars</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">cvars</span><span class="w"> </span><span class="kn">import</span> <span class="n">ConVar</span>
<span class="c1"># Engines</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">engines.server</span><span class="w"> </span><span class="kn">import</span> <span class="n">server_game_dll</span>
<span class="c1"># Entities</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">entities</span><span class="w"> </span><span class="kn">import</span> <span class="n">BaseEntityOutput</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">entities.datamaps</span><span class="w"> </span><span class="kn">import</span> <span class="n">Variant</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">find_output_name</span>
<span class="c1"># Memory</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">memory</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_virtual_function</span>
<span class="c1"># Players</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">players.constants</span><span class="w"> </span><span class="kn">import</span> <span class="n">PlayerButtons</span>
<span class="c1"># Loggers</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">loggers</span><span class="w"> </span><span class="kn">import</span> <span class="n">_sp_logger</span>
<span class="c1"># Memory</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">memory</span><span class="w"> </span><span class="kn">import</span> <span class="n">get_virtual_function</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">memory</span><span class="w"> </span><span class="kn">import</span> <span class="n">make_object</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">PreHook</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> FORWARD IMPORTS</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># Source.Python Imports</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">ListenerManager</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_client_active_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_client_connect_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_client_disconnect_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_client_fully_connect_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_client_put_in_server_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_client_settings_changed_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_convar_changed_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_level_init_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_level_shutdown_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_network_id_validated_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_edict_allocated_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_edict_freed_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_entity_pre_spawned_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_pre_spawned_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_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_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_entity_spawned_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_spawned_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_entity_deleted_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="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_entity_collision_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_entity_transmit_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_data_loaded_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_combiner_pre_cache_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_data_unloaded_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_query_cvar_value_finished_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_server_activate_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_tick_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_server_output_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_player_collision_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_player_transmit_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_player_run_command_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_player_post_run_command_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_button_state_changed_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">'ButtonStatus'</span><span class="p">,</span>
<span class="s1">'ListenerManager'</span><span class="p">,</span>
<span class="s1">'ListenerManagerDecorator'</span><span class="p">,</span>
<span class="s1">'OnClientActive'</span><span class="p">,</span>
<span class="s1">'OnClientConnect'</span><span class="p">,</span>
<span class="s1">'OnClientDisconnect'</span><span class="p">,</span>
<span class="s1">'OnClientFullyConnect'</span><span class="p">,</span>
<span class="s1">'OnClientPutInServer'</span><span class="p">,</span>
<span class="s1">'OnClientSettingsChanged'</span><span class="p">,</span>
<span class="s1">'OnCombinerPreCache'</span><span class="p">,</span>
<span class="s1">'OnConVarChanged'</span><span class="p">,</span>
<span class="s1">'OnDataLoaded'</span><span class="p">,</span>
<span class="s1">'OnDataUnloaded'</span><span class="p">,</span>
<span class="s1">'OnEdictAllocated'</span><span class="p">,</span>
<span class="s1">'OnEdictFreed'</span><span class="p">,</span>
<span class="s1">'OnEntityCreated'</span><span class="p">,</span>
<span class="s1">'OnNetworkedEntityCreated'</span><span class="p">,</span>
<span class="s1">'OnEntityDeleted'</span><span class="p">,</span>
<span class="s1">'OnNetworkedEntityDeleted'</span><span class="p">,</span>
<span class="s1">'OnEntityCollision'</span><span class="p">,</span>
<span class="s1">'OnEntityTransmit'</span><span class="p">,</span>
<span class="s1">'OnEntityOutput'</span><span class="p">,</span>
<span class="s1">'OnEntityOutputListenerManager'</span><span class="p">,</span>
<span class="s1">'OnEntityPreSpawned'</span><span class="p">,</span>
<span class="s1">'OnNetworkedEntityPreSpawned'</span><span class="p">,</span>
<span class="s1">'OnEntitySpawned'</span><span class="p">,</span>
<span class="s1">'OnNetworkedEntitySpawned'</span><span class="p">,</span>
<span class="s1">'OnLevelInit'</span><span class="p">,</span>
<span class="s1">'OnLevelShutdown'</span><span class="p">,</span>
<span class="s1">'OnLevelEnd'</span><span class="p">,</span>
<span class="s1">'OnNetworkidValidated'</span><span class="p">,</span>
<span class="s1">'OnButtonStateChanged'</span><span class="p">,</span>
<span class="s1">'OnPlayerCollision'</span><span class="p">,</span>
<span class="s1">'OnPlayerTransmit'</span><span class="p">,</span>
<span class="s1">'OnPlayerRunCommand'</span><span class="p">,</span>
<span class="s1">'OnPlayerPostRunCommand'</span><span class="p">,</span>
<span class="s1">'OnPluginLoaded'</span><span class="p">,</span>
<span class="s1">'OnPluginLoading'</span><span class="p">,</span>
<span class="s1">'OnPluginUnloaded'</span><span class="p">,</span>
<span class="s1">'OnPluginUnloading'</span><span class="p">,</span>
<span class="s1">'OnQueryCvarValueFinished'</span><span class="p">,</span>
<span class="s1">'OnServerActivate'</span><span class="p">,</span>
<span class="s1">'OnTick'</span><span class="p">,</span>
<span class="s1">'OnVersionUpdate'</span><span class="p">,</span>
<span class="s1">'OnServerOutput'</span><span class="p">,</span>
<span class="s1">'get_button_combination_status'</span><span class="p">,</span>
<span class="s1">'on_client_active_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_client_connect_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_client_disconnect_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_client_fully_connect_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_client_put_in_server_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_client_settings_changed_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_combiner_pre_cache_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_convar_changed_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_data_loaded_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_data_unloaded_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_edict_allocated_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_edict_freed_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_entity_created_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_networked_entity_created_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_entity_deleted_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_networked_entity_deleted_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_entity_collision_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_entity_transmit_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_entity_output_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_entity_pre_spawned_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_networked_entity_pre_spawned_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_entity_spawned_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_networked_entity_spawned_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_level_end_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_level_init_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_level_shutdown_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_network_id_validated_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_plugin_loaded_manager'</span><span class="p">,</span>
<span class="s1">'on_plugin_loading_manager'</span><span class="p">,</span>
<span class="s1">'on_plugin_unloaded_manager'</span><span class="p">,</span>
<span class="s1">'on_plugin_unloading_manager'</span><span class="p">,</span>
<span class="s1">'on_query_cvar_value_finished_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_server_activate_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_tick_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_version_update_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_server_output_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_player_collision_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_player_transmit_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_player_run_command_listener_manager'</span><span class="p">,</span>
<span class="s1">'on_button_state_changed_listener_manager'</span><span class="p">,</span>
<span class="p">)</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> GLOBAL VARIABLES</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># Get the sp.listeners logger</span>
<span class="n">listeners_logger</span> <span class="o">=</span> <span class="n">_sp_logger</span><span class="o">.</span><span class="n">listeners</span>
<span class="n">on_version_update_listener_manager</span> <span class="o">=</span> <span class="n">ListenerManager</span><span class="p">()</span>
<span class="n">on_plugin_loaded_manager</span> <span class="o">=</span> <span class="n">ListenerManager</span><span class="p">()</span>
<span class="n">on_plugin_unloaded_manager</span> <span class="o">=</span> <span class="n">ListenerManager</span><span class="p">()</span>
<span class="n">on_plugin_loading_manager</span> <span class="o">=</span> <span class="n">ListenerManager</span><span class="p">()</span>
<span class="n">on_plugin_unloading_manager</span> <span class="o">=</span> <span class="n">ListenerManager</span><span class="p">()</span>
<span class="n">on_level_end_listener_manager</span> <span class="o">=</span> <span class="n">ListenerManager</span><span class="p">()</span>
<span class="n">_check_for_update</span> <span class="o">=</span> <span class="n">ConVar</span><span class="p">(</span>
<span class="s1">'sp_check_for_update'</span><span class="p">,</span>
<span class="n">_core_settings</span><span class="p">[</span><span class="s1">'VERSION_SETTINGS'</span><span class="p">][</span><span class="s1">'check_for_update'</span><span class="p">],</span>
<span class="s1">'Enable/disable checking for version updates.'</span><span class="p">,</span> <span class="n">min_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_value</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="n">_notify_on_update</span> <span class="o">=</span> <span class="n">ConVar</span><span class="p">(</span>
<span class="s1">'sp_notify_on_update'</span><span class="p">,</span>
<span class="n">_core_settings</span><span class="p">[</span><span class="s1">'VERSION_SETTINGS'</span><span class="p">][</span><span class="s1">'notify_on_update'</span><span class="p">],</span>
<span class="s1">'Log a warning when a Source.Python update is available.'</span> <span class="o">+</span>
<span class="s1">' Requires sp_check_for_update to be set to 1.'</span><span class="p">,</span>
<span class="n">min_value</span><span class="o">=</span><span class="mi">0</span><span class="p">,</span> <span class="n">max_value</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> CLASSES</span>
<span class="c1"># =============================================================================</span>
<div class="viewcode-block" id="ButtonStatus">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.ButtonStatus">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">ButtonStatus</span><span class="p">(</span><span class="n">IntEnum</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Indicate whether a button has been pressed or released."""</span>
<span class="n">RELEASED</span> <span class="o">=</span> <span class="mi">0</span>
<span class="n">PRESSED</span> <span class="o">=</span> <span class="mi">1</span></div>
<div class="viewcode-block" id="ListenerManagerDecorator">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.ListenerManagerDecorator">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">ListenerManagerDecorator</span><span class="p">(</span><span class="n">AutoUnload</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Base decorator class used to register/unregister a listener."""</span>
<div class="viewcode-block" id="ListenerManagerDecorator.__init__">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.ListenerManagerDecorator.__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">callback</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Store the callback and register the listener."""</span>
<span class="c1"># Log the <instance>.__init__ message</span>
<span class="n">listeners_logger</span><span class="o">.</span><span class="n">log_debug</span><span class="p">(</span>
<span class="s1">'</span><span class="si">{0}</span><span class="s1">.__init__<</span><span class="si">{1}</span><span class="s1">>'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">callback</span><span class="p">))</span>
<span class="c1"># Set the callback to 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="c1"># Is the callback callable?</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="c1"># Raise an error</span>
<span class="k">raise</span> <span class="ne">TypeError</span><span class="p">(</span>
<span class="s2">"'"</span> <span class="o">+</span> <span class="nb">type</span><span class="p">(</span><span class="n">callback</span><span class="p">)</span><span class="o">.</span><span class="vm">__name__</span> <span class="o">+</span> <span class="s2">"' object is not callable."</span><span class="p">)</span>
<span class="c1"># Log the registering message</span>
<span class="n">listeners_logger</span><span class="o">.</span><span class="n">log_debug</span><span class="p">(</span>
<span class="s1">'</span><span class="si">{0}</span><span class="s1">.__init__ - Registering'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">))</span>
<span class="c1"># Store the callback</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"># Register the listener</span>
<span class="bp">self</span><span class="o">.</span><span class="n">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">callback</span><span class="p">)</span></div>
<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="o">*</span><span class="n">args</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Call the listener."""</span>
<span class="c1"># Log the calling</span>
<span class="n">listeners_logger</span><span class="o">.</span><span class="n">log_debug</span><span class="p">(</span>
<span class="s1">'</span><span class="si">{0}</span><span class="s1">.__call__<</span><span class="si">{1}</span><span class="s1">>'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">args</span><span class="p">))</span>
<span class="c1"># Call the listener</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">callback</span><span class="p">(</span><span class="o">*</span><span class="n">args</span><span class="p">)</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">name</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the class name of the instance."""</span>
<span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="vm">__class__</span><span class="o">.</span><span class="vm">__name__</span>
<span class="nd">@property</span>
<span class="k">def</span><span class="w"> </span><span class="nf">manager</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return a :class:`ListenerManager` object."""</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'Must be implemented by a subclass.'</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 the listener."""</span>
<span class="c1"># Was the 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"># Log the unregistering</span>
<span class="n">listeners_logger</span><span class="o">.</span><span class="n">log_debug</span><span class="p">(</span>
<span class="s1">'</span><span class="si">{0}</span><span class="s1">._unload_instance - Unregistering <</span><span class="si">{1}</span><span class="s1">>'</span><span class="o">.</span><span class="n">format</span><span class="p">(</span>
<span class="bp">self</span><span class="o">.</span><span class="n">name</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"># Unregister the listener</span>
<span class="bp">self</span><span class="o">.</span><span class="n">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">callback</span><span class="p">)</span></div>
<div class="viewcode-block" id="OnClientActive">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnClientActive">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnClientActive</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ClientActive listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_client_active_listener_manager</span></div>
<div class="viewcode-block" id="OnClientConnect">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnClientConnect">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnClientConnect</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ClientConnect listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_client_connect_listener_manager</span></div>
<div class="viewcode-block" id="OnClientDisconnect">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnClientDisconnect">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnClientDisconnect</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ClientDisconnect listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_client_disconnect_listener_manager</span></div>
<div class="viewcode-block" id="OnClientFullyConnect">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnClientFullyConnect">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnClientFullyConnect</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ClientFullyConnect listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_client_fully_connect_listener_manager</span></div>
<div class="viewcode-block" id="OnClientPutInServer">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnClientPutInServer">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnClientPutInServer</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ClientPutInServer listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_client_put_in_server_listener_manager</span></div>
<div class="viewcode-block" id="OnClientSettingsChanged">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnClientSettingsChanged">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnClientSettingsChanged</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ClientSettingsChanged listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_client_settings_changed_listener_manager</span></div>
<div class="viewcode-block" id="OnEntityOutputListenerManager">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityOutputListenerManager">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntityOutputListenerManager</span><span class="p">(</span><span class="n">ListenerManager</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister an EntityOutput listener."""</span>
<div class="viewcode-block" id="OnEntityOutputListenerManager.initialize">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityOutputListenerManager.initialize">[docs]</a>
<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="w"> </span><span class="sd">"""Called when the first callback is being registered."""</span>
<span class="c1"># Get the fire_output method</span>
<span class="n">fire_output</span> <span class="o">=</span> <span class="n">BaseEntityOutput</span><span class="o">.</span><span class="n">fire_output</span>
<span class="c1"># If the fire_output method is not implemented, exit the call</span>
<span class="k">if</span> <span class="n">fire_output</span> <span class="ow">is</span> <span class="bp">NotImplemented</span><span class="p">:</span>
<span class="k">return</span>
<span class="c1"># Register the hook on fire_output</span>
<span class="n">fire_output</span><span class="o">.</span><span class="n">add_pre_hook</span><span class="p">(</span><span class="n">_pre_fire_output</span><span class="p">)</span></div>
<div class="viewcode-block" id="OnEntityOutputListenerManager.finalize">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityOutputListenerManager.finalize">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">finalize</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when the last callback is being unregistered."""</span>
<span class="c1"># Get the fire_output method</span>
<span class="n">fire_output</span> <span class="o">=</span> <span class="n">BaseEntityOutput</span><span class="o">.</span><span class="n">fire_output</span>
<span class="c1"># If the fire_output method is not implemented, exit the call</span>
<span class="k">if</span> <span class="n">fire_output</span> <span class="ow">is</span> <span class="bp">NotImplemented</span><span class="p">:</span>
<span class="k">return</span>
<span class="c1"># Unregister the hook on fire_output</span>
<span class="n">fire_output</span><span class="o">.</span><span class="n">remove_pre_hook</span><span class="p">(</span><span class="n">_pre_fire_output</span><span class="p">)</span></div>
</div>
<span class="n">on_entity_output_listener_manager</span> <span class="o">=</span> <span class="n">OnEntityOutputListenerManager</span><span class="p">()</span>
<div class="viewcode-block" id="OnEntityOutput">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityOutput">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntityOutput</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister an EntityOutput listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_entity_output_listener_manager</span></div>
<div class="viewcode-block" id="OnLevelInit">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnLevelInit">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnLevelInit</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a LevelInit listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_level_init_listener_manager</span></div>
<div class="viewcode-block" id="OnLevelShutdown">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnLevelShutdown">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnLevelShutdown</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a LevelShutdown listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_level_shutdown_listener_manager</span></div>
<div class="viewcode-block" id="OnNetworkidValidated">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnNetworkidValidated">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnNetworkidValidated</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a NetworkidValidated listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_network_id_validated_listener_manager</span></div>
<div class="viewcode-block" id="OnEdictAllocated">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEdictAllocated">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEdictAllocated</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister an OnEdictAllocated listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_edict_allocated_listener_manager</span></div>
<div class="viewcode-block" id="OnEdictFreed">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEdictFreed">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEdictFreed</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister an OnEdictFreed listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_edict_freed_listener_manager</span></div>
<div class="viewcode-block" id="OnEntityPreSpawned">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityPreSpawned">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntityPreSpawned</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnEntityPreSpawned listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_entity_pre_spawned_listener_manager</span></div>
<div class="viewcode-block" id="OnNetworkedEntityPreSpawned">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnNetworkedEntityPreSpawned">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnNetworkedEntityPreSpawned</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnNetworkedEntityPreSpawned listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_networked_entity_pre_spawned_listener_manager</span></div>
<div class="viewcode-block" id="OnEntityCreated">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityCreated">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntityCreated</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnEntityCreated listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_entity_created_listener_manager</span></div>
<div class="viewcode-block" id="OnNetworkedEntityCreated">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnNetworkedEntityCreated">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnNetworkedEntityCreated</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnNetworkedEntityCreated listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_networked_entity_created_listener_manager</span></div>
<div class="viewcode-block" id="OnEntitySpawned">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntitySpawned">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntitySpawned</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnEntitySpawned listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_entity_spawned_listener_manager</span></div>
<div class="viewcode-block" id="OnNetworkedEntitySpawned">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnNetworkedEntitySpawned">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnNetworkedEntitySpawned</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnNetworkedEntitySpawned listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_networked_entity_spawned_listener_manager</span></div>
<div class="viewcode-block" id="OnEntityDeleted">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityDeleted">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntityDeleted</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnEntityDeleted listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_entity_deleted_listener_manager</span></div>
<div class="viewcode-block" id="OnNetworkedEntityDeleted">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnNetworkedEntityDeleted">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnNetworkedEntityDeleted</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnNetworkedEntityDeleted listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_networked_entity_deleted_listener_manager</span></div>
<div class="viewcode-block" id="OnEntityCollision">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityCollision">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntityCollision</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnEntityCollision listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_entity_collision_listener_manager</span></div>
<div class="viewcode-block" id="OnEntityTransmit">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnEntityTransmit">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnEntityTransmit</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnEntityTransmit listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_entity_transmit_listener_manager</span></div>
<div class="viewcode-block" id="OnDataLoaded">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnDataLoaded">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnDataLoaded</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnDataLoaded listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_data_loaded_listener_manager</span></div>
<div class="viewcode-block" id="OnCombinerPreCache">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnCombinerPreCache">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnCombinerPreCache</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnCombinerPreCache listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_combiner_pre_cache_listener_manager</span></div>
<div class="viewcode-block" id="OnDataUnloaded">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnDataUnloaded">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnDataUnloaded</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnDataUnloaded listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_data_unloaded_listener_manager</span></div>
<div class="viewcode-block" id="OnQueryCvarValueFinished">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnQueryCvarValueFinished">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnQueryCvarValueFinished</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister an OnQueryCvarValueFinished listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_query_cvar_value_finished_listener_manager</span></div>
<div class="viewcode-block" id="OnServerActivate">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnServerActivate">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnServerActivate</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ServerActivate listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_server_activate_listener_manager</span></div>
<div class="viewcode-block" id="OnTick">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnTick">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnTick</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a Tick listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_tick_listener_manager</span></div>
<div class="viewcode-block" id="OnVersionUpdate">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnVersionUpdate">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnVersionUpdate</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a version update listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_version_update_listener_manager</span></div>
<div class="viewcode-block" id="OnConVarChanged">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnConVarChanged">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnConVarChanged</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a ConVar listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_convar_changed_listener_manager</span></div>
<div class="viewcode-block" id="OnPluginLoaded">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPluginLoaded">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPluginLoaded</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a plugin loaded listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_plugin_loaded_manager</span></div>
<div class="viewcode-block" id="OnPluginLoading">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPluginLoading">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPluginLoading</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a plugin loading listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_plugin_loading_manager</span></div>
<div class="viewcode-block" id="OnPluginUnloaded">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPluginUnloaded">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPluginUnloaded</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a plugin unloaded listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_plugin_unloaded_manager</span></div>
<div class="viewcode-block" id="OnPluginUnloading">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPluginUnloading">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPluginUnloading</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a plugin unloading listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_plugin_unloading_manager</span></div>
<div class="viewcode-block" id="OnLevelEnd">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnLevelEnd">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnLevelEnd</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a map end listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_level_end_listener_manager</span>
<span class="c1"># Guard variable to ensure this listener gets called only once per map.</span>
<span class="n">_level_initialized</span> <span class="o">=</span> <span class="kc">False</span></div>
<div class="viewcode-block" id="OnPlayerCollision">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPlayerCollision">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPlayerCollision</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnPlayerCollision listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_player_collision_listener_manager</span></div>
<div class="viewcode-block" id="OnPlayerTransmit">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPlayerTransmit">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPlayerTransmit</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a OnPlayerTransmit listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_player_transmit_listener_manager</span></div>
<div class="viewcode-block" id="OnPlayerRunCommand">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPlayerRunCommand">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPlayerRunCommand</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a run command listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_player_run_command_listener_manager</span></div>
<div class="viewcode-block" id="OnPlayerPostRunCommand">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnPlayerPostRunCommand">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnPlayerPostRunCommand</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a post run command listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_player_post_run_command_listener_manager</span></div>
<div class="viewcode-block" id="OnButtonStateChanged">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnButtonStateChanged">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnButtonStateChanged</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a button state change listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_button_state_changed_listener_manager</span></div>
<div class="viewcode-block" id="OnServerOutput">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.OnServerOutput">[docs]</a>
<span class="k">class</span><span class="w"> </span><span class="nc">OnServerOutput</span><span class="p">(</span><span class="n">ListenerManagerDecorator</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Register/unregister a server output listener."""</span>
<span class="n">manager</span> <span class="o">=</span> <span class="n">on_server_output_listener_manager</span></div>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> FUNCTIONS</span>
<span class="c1"># =============================================================================</span>
<div class="viewcode-block" id="get_button_combination_status">
<a class="viewcode-back" href="../developing/modules/listeners.html#listeners.get_button_combination_status">[docs]</a>
<span class="k">def</span><span class="w"> </span><span class="nf">get_button_combination_status</span><span class="p">(</span><span class="n">old_buttons</span><span class="p">,</span> <span class="n">new_buttons</span><span class="p">,</span> <span class="n">combination</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Return the status of a button combination.</span>
<span class="sd"> :param PlayerButtons old_buttons:</span>
<span class="sd"> Previously pressed buttons.</span>
<span class="sd"> :param PlayerButtons new_buttons:</span>
<span class="sd"> Now pressed buttons.</span>
<span class="sd"> :param PlayerButtons combination:</span>
<span class="sd"> Button combination to check.</span>
<span class="sd"> :return:</span>
<span class="sd"> Return the status of the button combination. If the combination was</span>
<span class="sd"> neither pressed nor released, None will be returned.</span>
<span class="sd"> :rtype: ButtonStatus</span>
<span class="sd"> Example:</span>
<span class="sd"> .. code:: python</span>
<span class="sd"> @OnButtonStateChanged</span>
<span class="sd"> def on_buttons_state_changed(player, old_buttons, new_buttons):</span>
<span class="sd"> status = get_button_combination_status(old_buttons, new_buttons,</span>
<span class="sd"> PlayerButtons.ATTACK|PlayerButtons.JUMP)</span>
<span class="sd"> if status == ButtonStatus.PRESSED:</span>
<span class="sd"> SayText2(</span>
<span class="sd"> '{} is jumping and attacking.'.format(player.name)).send()</span>
<span class="sd"> elif status == ButtonStatus.RELEASED:</span>
<span class="sd"> SayText2(</span>
<span class="sd"> '{} stopped jumping and attacking at the same time.'.format(</span>
<span class="sd"> player.name)).send()</span>
<span class="sd"> """</span>
<span class="n">previously_pressed</span> <span class="o">=</span> <span class="n">old_buttons</span> <span class="o">&</span> <span class="n">combination</span> <span class="o">==</span> <span class="n">combination</span>
<span class="n">now_pressed</span> <span class="o">=</span> <span class="n">new_buttons</span> <span class="o">&</span> <span class="n">combination</span> <span class="o">==</span> <span class="n">combination</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">previously_pressed</span> <span class="ow">and</span> <span class="n">now_pressed</span><span class="p">:</span>
<span class="k">return</span> <span class="n">ButtonStatus</span><span class="o">.</span><span class="n">PRESSED</span>
<span class="k">elif</span> <span class="n">previously_pressed</span> <span class="ow">and</span> <span class="ow">not</span> <span class="n">now_pressed</span><span class="p">:</span>
<span class="k">return</span> <span class="n">ButtonStatus</span><span class="o">.</span><span class="n">RELEASED</span>
<span class="k">return</span> <span class="kc">None</span></div>
<span class="c1"># =============================================================================</span>
<span class="c1"># >> CALLBACKS</span>
<span class="c1"># =============================================================================</span>
<span class="nd">@OnLevelInit</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_on_level_init</span><span class="p">(</span><span class="n">map_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when a new map gets initialized."""</span>
<span class="n">OnLevelEnd</span><span class="o">.</span><span class="n">_level_initialized</span> <span class="o">=</span> <span class="kc">True</span>
<span class="c1"># Don't check if it's an unversioned build (dev version)</span>
<span class="k">if</span> <span class="n">is_unversioned</span><span class="p">():</span>
<span class="k">return</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">_check_for_update</span><span class="o">.</span><span class="n">get_int</span><span class="p">():</span>
<span class="k">return</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">latest_version</span> <span class="o">=</span> <span class="n">get_last_successful_build_number</span><span class="p">()</span>
<span class="k">except</span> <span class="p">(</span><span class="n">URLError</span><span class="p">,</span> <span class="n">socket</span><span class="o">.</span><span class="n">timeout</span><span class="p">):</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">VERSION</span> <span class="o">>=</span> <span class="n">latest_version</span><span class="p">:</span>
<span class="k">return</span>
<span class="k">if</span> <span class="n">_notify_on_update</span><span class="o">.</span><span class="n">get_int</span><span class="p">():</span>
<span class="c1"># TODO: Add translations</span>
<span class="n">listeners_logger</span><span class="o">.</span><span class="n">log_warning</span><span class="p">(</span>
<span class="s1">'A new Source.Python version is available!'</span><span class="p">)</span>
<span class="n">on_version_update_listener_manager</span><span class="o">.</span><span class="n">notify</span><span class="p">(</span><span class="n">VERSION</span><span class="p">,</span> <span class="n">latest_version</span><span class="p">)</span>
<span class="nd">@OnLevelShutdown</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_on_level_shutdown</span><span class="p">():</span>
<span class="w"> </span><span class="sd">"""Called on level end."""</span>
<span class="c1"># Was no map initialized?</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">OnLevelEnd</span><span class="o">.</span><span class="n">_level_initialized</span><span class="p">:</span>
<span class="k">return</span>
<span class="c1"># Notify all registred callbacks</span>
<span class="n">on_level_end_listener_manager</span><span class="o">.</span><span class="n">notify</span><span class="p">()</span>
<span class="c1"># Make sure we don't get called more than once per map change</span>
<span class="n">OnLevelEnd</span><span class="o">.</span><span class="n">_level_initialized</span> <span class="o">=</span> <span class="kc">False</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_pre_fire_output</span><span class="p">(</span><span class="n">args</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when an output is about to be fired."""</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">on_entity_output_listener_manager</span><span class="p">:</span>
<span class="k">return</span>
<span class="c1"># Windows is a bit weird: the function takes 4 additional arguments...</span>
<span class="k">if</span> <span class="n">PLATFORM</span> <span class="o">==</span> <span class="s1">'windows'</span><span class="p">:</span>
<span class="n">args</span> <span class="o">=</span> <span class="p">(</span><span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">],)</span> <span class="o">+</span> <span class="nb">tuple</span><span class="p">(</span><span class="n">args</span><span class="p">)[</span><span class="mi">5</span><span class="p">:]</span>
<span class="n">caller_ptr</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">3</span><span class="p">]</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">caller_ptr</span><span class="p">:</span>
<span class="c1"># If we don't know the caller, we won't be able to retrieve the</span>
<span class="c1"># output name</span>
<span class="k">return</span>
<span class="c1"># Done here to fix cyclic import...</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">BaseEntity</span>
<span class="n">caller</span> <span class="o">=</span> <span class="n">make_object</span><span class="p">(</span><span class="n">BaseEntity</span><span class="p">,</span> <span class="n">caller_ptr</span><span class="p">)</span>
<span class="n">output_name</span> <span class="o">=</span> <span class="n">find_output_name</span><span class="p">(</span><span class="n">caller</span><span class="p">,</span> <span class="n">args</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
<span class="k">if</span> <span class="n">output_name</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
<span class="k">return</span> <span class="kc">None</span>
<span class="c1"># Done here to fix cyclic import...</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="k">if</span> <span class="n">caller</span><span class="o">.</span><span class="n">is_networked</span><span class="p">():</span>
<span class="n">caller</span> <span class="o">=</span> <span class="n">make_object</span><span class="p">(</span><span class="n">Entity</span><span class="p">,</span> <span class="n">caller_ptr</span><span class="p">)</span>
<span class="n">value_ptr</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">1</span><span class="p">]</span>
<span class="n">value</span> <span class="o">=</span> <span class="p">(</span><span class="n">value_ptr</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">and</span> <span class="n">make_object</span><span class="p">(</span><span class="n">Variant</span><span class="p">,</span> <span class="n">value_ptr</span><span class="p">)</span>
<span class="n">activator_ptr</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">2</span><span class="p">]</span>
<span class="n">activator</span> <span class="o">=</span> <span class="p">((</span><span class="n">activator_ptr</span> <span class="ow">or</span> <span class="kc">None</span><span class="p">)</span> <span class="ow">and</span> <span class="n">make_object</span><span class="p">(</span>
<span class="n">BaseEntity</span><span class="p">,</span> <span class="n">activator_ptr</span><span class="p">))</span>
<span class="k">if</span> <span class="n">activator</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span> <span class="ow">and</span> <span class="n">activator</span><span class="o">.</span><span class="n">is_networked</span><span class="p">():</span>
<span class="n">activator</span> <span class="o">=</span> <span class="n">make_object</span><span class="p">(</span><span class="n">Entity</span><span class="p">,</span> <span class="n">activator_ptr</span><span class="p">)</span>
<span class="n">delay</span> <span class="o">=</span> <span class="n">args</span><span class="p">[</span><span class="mi">4</span><span class="p">]</span>
<span class="n">on_entity_output_listener_manager</span><span class="o">.</span><span class="n">notify</span><span class="p">(</span>
<span class="n">output_name</span><span class="p">,</span> <span class="n">activator</span><span class="p">,</span> <span class="n">caller</span><span class="p">,</span> <span class="n">value</span><span class="p">,</span> <span class="n">delay</span><span class="p">)</span>
<span class="c1"># ============================================================================</span>
<span class="c1"># >> Fix for issue #181.</span>
<span class="c1"># ============================================================================</span>
<span class="c1"># Get the function name to hook...</span>
<span class="k">if</span> <span class="n">SOURCE_ENGINE</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'bms'</span><span class="p">,</span> <span class="s1">'orangebox'</span><span class="p">,</span> <span class="s1">'gmod'</span><span class="p">):</span>
<span class="n">_hibernation_function_name</span> <span class="o">=</span> <span class="s1">'SetServerHibernation'</span>
<span class="k">elif</span> <span class="n">SOURCE_ENGINE</span> <span class="ow">in</span> <span class="p">(</span><span class="s1">'blade'</span><span class="p">,</span> <span class="s1">'csgo'</span><span class="p">,</span> <span class="s1">'l4d2'</span><span class="p">):</span>
<span class="n">_hibernation_function_name</span> <span class="o">=</span> <span class="s1">'ServerHibernationUpdate'</span>
<span class="k">else</span><span class="p">:</span>
<span class="c1"># To remind us to add newly supported engines...</span>
<span class="k">raise</span> <span class="ne">NotImplementedError</span><span class="p">(</span><span class="s1">'No hibernation function exposed.'</span><span class="p">)</span>
<span class="nd">@PreHook</span><span class="p">(</span><span class="n">get_virtual_function</span><span class="p">(</span><span class="n">server_game_dll</span><span class="p">,</span> <span class="n">_hibernation_function_name</span><span class="p">))</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_pre_hibernation_function</span><span class="p">(</span><span class="n">stack_data</span><span class="p">):</span>
<span class="w"> </span><span class="sd">"""Called when the server is hibernating."""</span>
<span class="k">if</span> <span class="ow">not</span> <span class="n">stack_data</span><span class="p">[</span><span class="mi">1</span><span class="p">]:</span>
<span class="k">return</span>
<span class="c1"># Disconnect all bots...</span>
<span class="n">_disconnect_bots</span><span class="p">()</span>
<span class="nd">@OnLevelEnd</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_on_level_end</span><span class="p">():</span>
<span class="w"> </span><span class="sd">"""Disconnect all bots on level end."""</span>
<span class="n">_disconnect_bots</span><span class="p">()</span>
<span class="k">def</span><span class="w"> </span><span class="nf">_disconnect_bots</span><span class="p">():</span>
<span class="w"> </span><span class="sd">"""Disconnect all bots."""</span>
<span class="c1"># Cyclic import...</span>
<span class="kn">from</span><span class="w"> </span><span class="nn">filters.players</span><span class="w"> </span><span class="kn">import</span> <span class="n">PlayerIter</span>
<span class="c1"># Notify OnClientDisconnect listener for all bots...</span>
<span class="k">for</span> <span class="n">bot</span> <span class="ow">in</span> <span class="n">PlayerIter</span><span class="p">(</span><span class="s1">'bot'</span><span class="p">):</span>
<span class="n">on_client_disconnect_listener_manager</span><span class="o">.</span><span class="n">notify</span><span class="p">(</span><span class="n">bot</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 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="">listeners</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>