This repository was archived by the owner on Jun 28, 2026. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 24
Expand file tree
/
Copy pathEntitySystem.Proxy.cs
More file actions
1911 lines (1659 loc) · 74.2 KB
/
Copy pathEntitySystem.Proxy.cs
File metadata and controls
1911 lines (1659 loc) · 74.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
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
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
using System;
using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Numerics;
using System.Runtime.CompilerServices;
using JetBrains.Annotations;
using Robust.Shared.Containers;
using Robust.Shared.Map;
using Robust.Shared.Maths;
using Robust.Shared.Prototypes;
using Robust.Shared.Timing;
using Robust.Shared.Utility;
namespace Robust.Shared.GameObjects;
public partial class EntitySystem
{
#region Entity LifeStage
/// <inheritdoc cref="IEntityManager.EntityExists(EntityUid)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.EntityExists))]
protected bool Exists(EntityUid uid)
{
return EntityManager.EntityExists(uid);
}
/// <inheritdoc cref="IEntityManager.EntityExists(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.EntityExists))]
protected bool Exists([NotNullWhen(true)] EntityUid? uid)
{
return EntityManager.EntityExists(uid);
}
/// <summary>
/// Retrieves whether the entity is initializing.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool Initializing(EntityUid uid, MetaDataComponent? metaData = null)
{
return LifeStage(uid, metaData) == EntityLifeStage.Initializing;
}
/// <summary>
/// Retrieves whether the entity has been initialized and has not yet been deleted.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool Initialized(EntityUid uid, MetaDataComponent? metaData = null)
{
return LifeStage(uid, metaData) is >= EntityLifeStage.Initialized and < EntityLifeStage.Terminating;
}
/// <summary>
/// Retrieves whether the entity is being terminated.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool Terminating(EntityUid uid, MetaDataComponent? metaData = null)
{
return LifeStage(uid, metaData) == EntityLifeStage.Terminating;
}
/// <summary>
/// Retrieves whether the entity is deleted or is nonexistent. Returns false if the entity is currently in the
/// process of being deleted.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool Deleted(EntityUid uid, MetaDataComponent? metaData = null)
{
return LifeStage(uid, metaData) >= EntityLifeStage.Deleted;
}
/// <summary>
/// Checks whether the entity is being or has been deleted (or never existed in the first place).
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TerminatingOrDeleted(EntityUid uid, MetaDataComponent? metaData = null)
{
return LifeStage(uid, metaData) >= EntityLifeStage.Terminating;
}
/// <summary>
/// Checks whether the entity is being or has been deleted (or never existed in the first place).
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TerminatingOrDeleted(EntityUid? uid, MetaDataComponent? metaData = null)
{
return !uid.HasValue || TerminatingOrDeleted(uid.Value, metaData);
}
[Obsolete("Use override without the EntityQuery")]
protected bool Deleted(EntityUid uid, EntityQuery<MetaDataComponent> metaQuery) => Deleted(uid);
/// <summary>
/// Retrieves whether the entity is deleted or is nonexistent.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool Deleted([NotNullWhen(false)] EntityUid? uid)
{
return !uid.HasValue || Deleted(uid.Value);
}
/// <inheritdoc cref="MetaDataComponent.EntityLifeStage" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected EntityLifeStage LifeStage(EntityUid uid, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
return EntityLifeStage.Deleted;
return metaData.EntityLifeStage;
}
[Obsolete("Use LifeStage()")]
protected bool TryLifeStage(EntityUid uid, [NotNullWhen(true)] out EntityLifeStage? lifeStage, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
{
lifeStage = null;
return false;
}
lifeStage = metaData.EntityLifeStage;
return true;
}
#endregion
#region Entity Metadata
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected bool IsPaused(EntityUid? uid, MetaDataComponent? metadata = null)
{
return EntityManager.IsPaused(uid, metadata);
}
/// <summary>
/// Marks this entity as dirty so that it will be updated over the network.
/// </summary>
/// <remarks>
/// Calling Dirty on a component will call this directly.
/// </remarks>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void DirtyEntity(EntityUid uid, MetaDataComponent? meta = null)
{
EntityManager.DirtyEntity(uid, meta);
}
/// <inheritdoc cref="Dirty{T}"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void Dirty(EntityUid uid, IComponent component, MetaDataComponent? meta = null)
{
EntityManager.Dirty(uid, component, meta);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void DirtyField(EntityUid uid, IComponentDelta delta, string fieldName, MetaDataComponent? meta = null)
{
EntityManager.DirtyField(uid, delta, fieldName, meta);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected void DirtyField<T>(Entity<T?> entity, [ValidateMember]string fieldName, MetaDataComponent? meta = null)
where T : IComponentDelta
{
if (!Resolve(entity.Owner, ref entity.Comp))
return;
EntityManager.DirtyField(entity.Owner, entity.Comp, fieldName, meta);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void DirtyField<T>(EntityUid uid, T component, [ValidateMember]string fieldName, MetaDataComponent? meta = null)
where T : IComponentDelta
{
EntityManager.DirtyField(uid, component, fieldName, meta);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void DirtyFields<T>(EntityUid uid, T comp, MetaDataComponent? meta, params string[] fields)
where T : IComponentDelta
{
EntityManager.DirtyFields(uid, comp, meta, fields);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected void DirtyFields<T>(Entity<T?> ent, MetaDataComponent? meta, params string[] fields)
where T : IComponentDelta
{
if (!Resolve(ent, ref ent.Comp))
return;
EntityManager.DirtyFields(ent, ent.Comp, meta, fields);
}
/// <summary>
/// Marks a component as dirty. This also implicitly dirties the entity this component belongs to.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void Dirty<T>(Entity<T> ent, MetaDataComponent? meta = null) where T : IComponent?
{
var comp = ent.Comp;
if (comp == null && !EntityManager.TryGetComponent(ent.Owner, out comp))
return;
EntityManager.Dirty(ent, comp, meta);
}
/// <inheritdoc cref="Dirty{T}"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void Dirty<T1, T2>(Entity<T1, T2> ent, MetaDataComponent? meta = null)
where T1 : IComponent
where T2 : IComponent
{
EntityManager.Dirty(ent, meta);
}
/// <inheritdoc cref="Dirty{T}"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void Dirty<T1, T2, T3>(Entity<T1, T2, T3> ent, MetaDataComponent? meta = null)
where T1 : IComponent
where T2 : IComponent
where T3 : IComponent
{
EntityManager.Dirty(ent, meta);
}
/// <inheritdoc cref="Dirty{T}"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected void Dirty<T1, T2, T3, T4>(Entity<T1, T2, T3, T4> ent, MetaDataComponent? meta = null)
where T1 : IComponent
where T2 : IComponent
where T3 : IComponent
where T4 : IComponent
{
EntityManager.Dirty(ent, meta);
}
/// <summary>
/// Retrieves the name of an entity.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected string Name(EntityUid uid, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
throw CompNotFound<MetaDataComponent>(uid);
return metaData.EntityName;
}
/// <summary>
/// Retrieves the description of an entity.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected string Description(EntityUid uid, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
throw CompNotFound<MetaDataComponent>(uid);
return metaData.EntityDescription;
}
/// <summary>
/// Retrieves the prototype of an entity, if any.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected EntityPrototype? Prototype(EntityUid uid, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
throw CompNotFound<MetaDataComponent>(uid);
return metaData.EntityPrototype;
}
/// <summary>
/// Retrieves the last <see cref="GameTick"/> the entity was modified at.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
protected GameTick LastModifiedTick(EntityUid uid, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
throw CompNotFound<MetaDataComponent>(uid);
return metaData.EntityLastModifiedTick;
}
/// <summary>
/// Retrieves whether the entity is paused or not.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool Paused(EntityUid uid, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
throw CompNotFound<MetaDataComponent>(uid);
return metaData.EntityPaused;
}
/// <summary>
/// Sets the paused status on an entity.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected void SetPaused(EntityUid uid, bool paused, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
throw CompNotFound<MetaDataComponent>(uid);
EntityManager.EntitySysManager.GetEntitySystem<MetaDataSystem>().SetEntityPaused(uid, paused, metaData);
}
/// <summary>
/// Attempts to mark an entity as dirty.
/// </summary>
/// <returns>Whether the operation succeeded.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryDirty(EntityUid uid, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
return false;
DirtyEntity(uid, metaData);
return true;
}
/// <summary>
/// Attempts to retrieve the name of an entity.
/// </summary>
/// <returns>Whether the name could be retrieved.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryName(EntityUid uid, [NotNullWhen(true)] out string? name, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
{
name = null;
return false;
}
name = metaData.EntityName;
return true;
}
/// <summary>
/// Attempts to retrieve the description of an entity.
/// </summary>
/// <returns>Whether the description could be retrieved.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryDescription(EntityUid uid, [NotNullWhen(true)] out string? description, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
{
description = null;
return false;
}
description = metaData.EntityDescription;
return true;
}
/// <summary>
/// Attempts to retrieve the prototype of an entity.
/// </summary>
/// <returns>Whether the prototype could be retrieved and was not null.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryPrototype(EntityUid uid, [NotNullWhen(true)] out EntityPrototype? prototype, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
{
prototype = null;
return false;
}
prototype = metaData.EntityPrototype;
return prototype != null;
}
/// <summary>
/// Attempts to retrieve the last <see cref="GameTick"/> the entity was modified at.
/// </summary>
/// <returns>Whether the last modified tick could be retrieved.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryLastModifiedTick(EntityUid uid, [NotNullWhen(true)] out GameTick? lastModifiedTick, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
{
lastModifiedTick = null;
return false;
}
lastModifiedTick = metaData.EntityLastModifiedTick;
return true;
}
/// <summary>
/// Attempts to retrieve the paused status on an entity.
/// </summary>
/// <returns>Whether the pause status could be retrieved.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryPaused(EntityUid uid, [NotNullWhen(true)] out bool? paused, MetaDataComponent? metaData = null)
{
if (!EntityManager.MetaQuery.Resolve(uid, ref metaData, false))
{
paused = null;
return false;
}
paused = metaData.EntityPaused;
return true;
}
/// <inheritdoc cref="IEntityManager.ToPrettyString(EntityUid, MetaDataComponent?)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
[return: NotNullIfNotNull("uid")]
protected EntityStringRepresentation? ToPrettyString(EntityUid? uid, MetaDataComponent? metadata = null)
{
return EntityManager.ToPrettyString(uid, metadata);
}
/// <inheritdoc cref="IEntityManager.ToPrettyString(EntityUid, MetaDataComponent?)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
[return: NotNullIfNotNull("netEntity")]
protected EntityStringRepresentation? ToPrettyString(NetEntity? netEntity)
{
return EntityManager.ToPrettyString(netEntity);
}
/// <inheritdoc cref="IEntityManager.ToPrettyString(EntityUid, MetaDataComponent?)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected EntityStringRepresentation ToPrettyString(EntityUid uid, MetaDataComponent? metadata)
=> EntityManager.ToPrettyString((uid, metadata));
/// <inheritdoc cref="IEntityManager.ToPrettyString(EntityUid, MetaDataComponent?)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected EntityStringRepresentation ToPrettyString(Entity<MetaDataComponent?> entity)
=> EntityManager.ToPrettyString(entity);
/// <inheritdoc cref="IEntityManager.ToPrettyString(EntityUid, MetaDataComponent?)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected EntityStringRepresentation ToPrettyString(NetEntity netEntity)
=> EntityManager.ToPrettyString(netEntity);
#endregion
#region Component Get
/// <inheritdoc cref="IEntityManager.GetComponent<T>"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.GetComponent))]
protected T Comp<T>(EntityUid uid) where T : IComponent
{
return EntityManager.GetComponent<T>(uid);
}
/// <summary>
/// Returns the component of a specific type, or null when it's missing or the entity does not exist.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected T? CompOrNull<T>(EntityUid uid) where T : IComponent
{
return EntityManager.GetComponentOrNull<T>(uid);
}
/// <summary>
/// Returns the component of a specific type, or null when it's missing or the entity does not exist.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected T? CompOrNull<T>(EntityUid? uid) where T : IComponent
{
return uid.HasValue ? EntityManager.GetComponentOrNull<T>(uid.Value) : default;
}
/// <inheritdoc cref="IEntityManager.TryGetComponent<T>(EntityUid, out T)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[PreferNonGenericVariantFor(typeof(TransformComponent), typeof(MetaDataComponent))]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.TryGetComponent))]
protected bool TryComp<T>(EntityUid uid, [NotNullWhen(true)] out T? comp) where T : IComponent
{
return EntityManager.TryGetComponent(uid, out comp);
}
/// <inheritdoc cref="IEntityManager.TryGetComponent<T>(EntityUid, out T)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryComp(EntityUid uid, [NotNullWhen(true)] out TransformComponent? comp)
{
return EntityManager.TransformQuery.TryGetComponent(uid, out comp);
}
/// <inheritdoc cref="IEntityManager.TryGetComponent<T>(EntityUid, out T)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool TryComp(EntityUid uid, [NotNullWhen(true)] out MetaDataComponent? comp)
{
return EntityManager.MetaQuery.TryGetComponent(uid, out comp);
}
/// <inheritdoc cref="IEntityManager.TryGetComponent<T>(EntityUid?, out T)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.TryGetComponent))]
protected bool TryComp<T>([NotNullWhen(true)] EntityUid? uid, [NotNullWhen(true)] out T? comp) where T : IComponent
{
if (!uid.HasValue)
{
comp = default;
return false;
}
return EntityManager.TryGetComponent(uid.Value, out comp);
}
/// <inheritdoc cref="IEntityManager.TryGetComponent<T>(EntityUid?, out T)"/>
protected bool TryComp([NotNullWhen(true)] EntityUid? uid, [NotNullWhen(true)] out TransformComponent? comp)
{
if (!uid.HasValue)
{
comp = default;
return false;
}
return EntityManager.TransformQuery.TryGetComponent(uid.Value, out comp);
}
/// <inheritdoc cref="IEntityManager.TryGetComponent<T>(EntityUid?, out T)"/>
protected bool TryComp([NotNullWhen(true)] EntityUid? uid, [NotNullWhen(true)] out MetaDataComponent? comp)
{
if (!uid.HasValue)
{
comp = default;
return false;
}
return EntityManager.MetaQuery.TryGetComponent(uid.Value, out comp);
}
/// <inheritdoc cref="IEntityManager.GetComponents"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.GetComponents))]
protected IEnumerable<IComponent> AllComps(EntityUid uid)
{
return EntityManager.GetComponents(uid);
}
/// <inheritdoc cref="IEntityManager.GetComponents<T>"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.GetComponents))]
protected IEnumerable<T> AllComps<T>(EntityUid uid)
{
return EntityManager.GetComponents<T>(uid);
}
/// <summary>
/// Returns the <see cref="TransformComponent"/> on an entity.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected TransformComponent Transform(EntityUid uid)
{
return EntityManager.TransformQuery.GetComponent(uid);
}
/// <summary>
/// Returns the <see cref="MetaDataComponent"/> on an entity.
/// </summary>
/// <exception cref="KeyNotFoundException">Thrown when the entity doesn't exist.</exception>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected MetaDataComponent MetaData(EntityUid uid)
{
return EntityManager.MetaQuery.GetComponent(uid);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected (EntityUid, MetaDataComponent) GetEntityData(NetEntity nuid)
{
return EntityManager.GetEntityData(nuid);
}
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected bool TryGetEntityData(NetEntity nuid, [NotNullWhen(true)] out EntityUid? uid,
[NotNullWhen(true)] out MetaDataComponent? meta)
{
return EntityManager.TryGetEntityData(nuid, out uid, out meta);
}
#endregion
#region Component Copy
/// <inheritdoc cref="IEntityManager.TryCopyComponent"/>
[ProxyFor(typeof(EntityManager))]
protected bool TryCopyComponent<T>(
EntityUid source,
EntityUid target,
ref T? sourceComponent,
[NotNullWhen(true)] out T? targetComp,
MetaDataComponent? meta = null) where T : IComponent
{
return EntityManager.TryCopyComponent(source, target, ref sourceComponent, out targetComp, meta);
}
/// <inheritdoc cref="IEntityManager.TryCopyComponents"/>
[ProxyFor(typeof(EntityManager))]
protected bool TryCopyComponents(
EntityUid source,
EntityUid target,
MetaDataComponent? meta = null,
params Type[] sourceComponents)
{
return EntityManager.TryCopyComponents(source, target, meta, sourceComponents);
}
/// <inheritdoc cref="IEntityManager.CopyComponent"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.CopyComponent))]
protected IComponent CopyComp(EntityUid source, EntityUid target, IComponent sourceComponent, MetaDataComponent? meta = null)
{
return EntityManager.CopyComponent(source, target, sourceComponent, meta);
}
/// <inheritdoc cref="IEntityManager.CopyComponent{T}"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.CopyComponent))]
protected T CopyComp<T>(EntityUid source, EntityUid target, T sourceComponent, MetaDataComponent? meta = null) where T : IComponent
{
return EntityManager.CopyComponent(source, target, sourceComponent, meta);
}
/// <inheritdoc cref="IEntityManager.CopyComponents"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.CopyComponents))]
protected void CopyComps(EntityUid source, EntityUid target, MetaDataComponent? meta = null, params IComponent[] sourceComponents)
{
EntityManager.CopyComponents(source, target, meta, sourceComponents);
}
#endregion
#region Component Has
/// <summary>
/// Retrieves whether the entity has the specified component or not.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.HasComponent))]
protected bool HasComp<T>(EntityUid uid) where T : IComponent
{
return EntityManager.HasComponent<T>(uid);
}
/// <summary>
/// Retrieves whether the entity has the specified component or not.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.HasComponent))]
protected bool HasComp(EntityUid uid, Type type)
{
return EntityManager.HasComponent(uid, type);
}
/// <summary>
/// Retrieves whether the entity has the specified component or not.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.HasComponent))]
protected bool HasComp<T>([NotNullWhen(true)] EntityUid? uid) where T : IComponent
{
return EntityManager.HasComponent<T>(uid);
}
/// <summary>
/// Retrieves whether the entity has the specified component or not.
/// </summary>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.HasComponent))]
protected bool HasComp([NotNullWhen(true)] EntityUid? uid, Type type)
{
return EntityManager.HasComponent(uid, type);
}
/// <summary>
/// Returns true if an entity prototype has a <typeparamref name="T"/>.
/// </summary>
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool HasComp<T>([ForbidLiteral] EntProtoId id) where T : IComponent, new()
=> HasComp(id, Factory.CompName<T>());
/// <summary>
/// Returns true if an entity prototype has a component with a given type.
/// Will throw if the type does not belong to a component.
/// </summary>
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool HasComp([ForbidLiteral] EntProtoId id, Type type)
=> HasComp(id, Factory.CompName(type));
/// <summary>
/// Returns true if a entity prototype contains a component with a given name.
/// Logs errors in case of the prototype not existing.
/// If you call this a lot on the same prototype, resolve it first and call the <see cref="EntityPrototype"/>-using <c>HasComp</c> variants.
/// </summary>
[Pure]
protected bool HasComp([ForbidLiteral] EntProtoId id, CompName name)
=> ProtoMan.Resolve(id, out var proto) && proto.HasComp(name);
/// <summary>
/// Returns true if an already-resolved entity prototype has a component of type <typeparamref name="T"/>.
/// </summary>
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool HasComp<T>(EntityPrototype proto) where T : IComponent, new()
=> proto.HasComp(Factory.CompName<T>());
/// <summary>
/// Returns true if an already-resolved entity prototype has a component with a given type.
/// Will throw if the type does not belong to a component.
/// </summary>
[Pure]
[MethodImpl(MethodImplOptions.AggressiveInlining)]
protected bool HasComp(EntityPrototype proto, Type type)
=> proto.HasComp(Factory.CompName(type));
#endregion
#region Component Add
/// <inheritdoc cref="IEntityManager.AddComponent<T>(EntityUid)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.AddComponent))]
protected T AddComp<T>(EntityUid uid) where T : IComponent, new()
{
return EntityManager.AddComponent<T>(uid);
}
/// <inheritdoc cref="IEntityManager.AddComponent<T>(EntityUid, T, bool)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.AddComponent))]
protected void AddComp<T>(EntityUid uid, T component, bool overwrite = false) where T : IComponent
{
EntityManager.AddComponent(uid, component, overwrite);
}
/// <inheritdoc cref="IEntityManager.EnsureComponent<T>(EntityUid)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.EnsureComponent))]
protected T EnsureComp<T>(EntityUid uid) where T : IComponent, new()
{
return EntityManager.EnsureComponent<T>(uid);
}
/// <inheritdoc cref="IEntityManager.EnsureComponent<T>(EntityUid, out T)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.EnsureComponent))]
protected bool EnsureComp<T>(EntityUid uid, out T comp) where T : IComponent, new()
{
return EntityManager.EnsureComponent(uid, out comp);
}
/// <inheritdoc cref="IEntityManager.EnsureComponent<T>(ref Entity<T>)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.EnsureComponent))]
protected bool EnsureComp<T>(ref Entity<T?> entity) where T : IComponent, new()
{
return EntityManager.EnsureComponent(ref entity);
}
#endregion
#region Component Remove Deferred
/// <inheritdoc cref="IEntityManager.RemoveComponentDeferred<T>(EntityUid)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.RemoveComponentDeferred))]
protected bool RemCompDeferred<T>(EntityUid uid) where T : IComponent
{
return EntityManager.RemoveComponentDeferred<T>(uid);
}
/// <inheritdoc cref="IEntityManager.RemoveComponentDeferred(EntityUid, Type)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.RemoveComponentDeferred))]
protected bool RemCompDeferred(EntityUid uid, Type type)
{
return EntityManager.RemoveComponentDeferred(uid, type);
}
/// <inheritdoc cref="IEntityManager.RemoveComponentDeferred(EntityUid, IComponent)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.RemoveComponentDeferred))]
protected void RemCompDeferred(EntityUid uid, IComponent component)
{
EntityManager.RemoveComponentDeferred(uid, component);
}
#endregion
#region Component count
/// <inheritdoc cref="IEntityManager.Count" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected int Count<T>() where T : IComponent
{
return EntityManager.Count<T>();
}
/// <inheritdoc cref="IEntityManager.Count" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected int Count(Type type)
{
return EntityManager.Count(type);
}
#endregion
#region Component Remove
/// <inheritdoc cref="IEntityManager.RemoveComponent<T>(EntityUid)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.RemoveComponent))]
protected bool RemComp<T>(EntityUid uid) where T : IComponent
{
return EntityManager.RemoveComponent<T>(uid);
}
/// <inheritdoc cref="IEntityManager.RemoveComponent(EntityUid, Type)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.RemoveComponent))]
protected bool RemComp(EntityUid uid, Type type)
{
return EntityManager.RemoveComponent(uid, type);
}
/// <inheritdoc cref="IEntityManager.RemoveComponent(EntityUid, IComponent)"/>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.RemoveComponent))]
protected void RemComp(EntityUid uid, IComponent component)
{
EntityManager.RemoveComponent(uid, component);
}
#endregion
#region Entity Delete
/// <inheritdoc cref="IEntityManager.DeleteEntity(EntityUid)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.DeleteEntity))]
protected void Del(EntityUid? uid)
{
EntityManager.DeleteEntity(uid);
}
/// <inheritdoc cref="IEntityManager.QueueDeleteEntity(EntityUid)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.QueueDeleteEntity))]
protected void QueueDel(EntityUid? uid)
{
EntityManager.QueueDeleteEntity(uid);
}
/// <inheritdoc cref="IEntityManager.DeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.PredictedDeleteEntity))]
protected void PredictedDel(Entity<MetaDataComponent?, TransformComponent?> ent)
{
EntityManager.PredictedDeleteEntity(ent);
}
/// <inheritdoc cref="IEntityManager.DeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.PredictedDeleteEntity))]
protected void PredictedDel(Entity<MetaDataComponent?, TransformComponent?>? ent)
{
EntityManager.PredictedDeleteEntity(ent);
}
/// <inheritdoc cref="IEntityManager.QueueDeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.PredictedQueueDeleteEntity))]
protected void PredictedQueueDel(Entity<MetaDataComponent?> ent)
{
EntityManager.PredictedQueueDeleteEntity(ent);
}
/// <inheritdoc cref="IEntityManager.QueueDeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.PredictedQueueDeleteEntity))]
protected void PredictedQueueDel(Entity<MetaDataComponent?>? ent)
{
EntityManager.PredictedQueueDeleteEntity(ent);
}
/// <inheritdoc cref="IEntityManager.DeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.PredictedQueueDeleteEntity))]
protected void PredictedQueueDel(EntityUid uid)
{
EntityManager.PredictedQueueDeleteEntity(uid);
}
/// <inheritdoc cref="IEntityManager.QueueDeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.PredictedQueueDeleteEntity))]
protected void PredictedQueueDel(EntityUid? uid)
{
EntityManager.PredictedQueueDeleteEntity(uid);
}
/// <inheritdoc cref="IEntityManager.QueueDeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[Obsolete("use variant without TransformComponent")]
protected void PredictedQueueDel(Entity<MetaDataComponent?, TransformComponent?> ent)
{
EntityManager.PredictedQueueDeleteEntity(ent);
}
/// <inheritdoc cref="IEntityManager.QueueDeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[Obsolete("use variant without TransformComponent")]
protected void PredictedQueueDel(Entity<MetaDataComponent?, TransformComponent?>? ent)
{
EntityManager.PredictedQueueDeleteEntity(ent);
}
/// <inheritdoc cref="IEntityManager.TryQueueDeleteEntity(EntityUid?)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.TryQueueDeleteEntity))]
protected bool TryQueueDel(EntityUid? uid)
{
return EntityManager.TryQueueDeleteEntity(uid);
}
#endregion
#region Entity Spawning
// This method will be obsoleted soon(TM).
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager), nameof(EntityManager.SpawnEntity))]
protected EntityUid Spawn(string? prototype, EntityCoordinates coordinates)
{
return ((IEntityManager)EntityManager).SpawnEntity(prototype, coordinates);
}
/// <inheritdoc cref="IEntityManager.Spawn(string?, MapCoordinates, ComponentRegistry?, Angle)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected EntityUid Spawn(string? prototype, MapCoordinates coordinates, ComponentRegistry? overrides = null, Angle rotation = default)
=> EntityManager.Spawn(prototype, coordinates, overrides, rotation);
/// <inheritdoc cref="IEntityManager.Spawn(string?, ComponentRegistry?, bool)" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected EntityUid Spawn(string? prototype = null, ComponentRegistry? overrides = null, bool doMapInit = true)
=> EntityManager.Spawn(prototype, overrides, doMapInit);
/// <inheritdoc cref="IEntityManager.SpawnAttachedTo" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected EntityUid SpawnAttachedTo(string? prototype, EntityCoordinates coordinates, ComponentRegistry? overrides = null, Angle rotation = default)
=> EntityManager.SpawnAttachedTo(prototype, coordinates, overrides, rotation);
/// <inheritdoc cref="IEntityManager.SpawnAtPosition" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected EntityUid SpawnAtPosition(string? prototype, EntityCoordinates coordinates, ComponentRegistry? overrides = null)
=> EntityManager.SpawnAtPosition(prototype, coordinates, overrides);
/// <inheritdoc cref="IEntityManager.TrySpawnInContainer" />
[MethodImpl(MethodImplOptions.AggressiveInlining)]
[ProxyFor(typeof(EntityManager))]
protected bool TrySpawnInContainer(
string? protoName,
EntityUid containerUid,
string containerId,
[NotNullWhen(true)] out EntityUid? uid,
ContainerManagerComponent? containerComp = null,
ComponentRegistry? overrides = null)
{
return EntityManager.TrySpawnInContainer(protoName, containerUid, containerId, out uid, containerComp, overrides);
}
/// <inheritdoc cref="IEntityManager.TrySpawnNextTo" />