This repository was archived by the owner on Aug 28, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathRogueLibsCore.xml
More file actions
4815 lines (4815 loc) · 278 KB
/
RogueLibsCore.xml
File metadata and controls
4815 lines (4815 loc) · 278 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
<?xml version="1.0"?>
<doc>
<assembly>
<name>RogueLibsCore</name>
</assembly>
<members>
<member name="T:RogueLibsCore.DebugFlags">
<summary>
<para>Represents the debugging flags.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.None">
<summary>
<para>No debug flags specified.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Names">
<summary>
<para>Specifies that names stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Unlocks">
<summary>
<para>Specifies that unlocks stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.UnlockMenus">
<summary>
<para>Specifies that unlock menus stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Sprites">
<summary>
<para>Specifies that sprites stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Items">
<summary>
<para>Specifies that items stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Traits">
<summary>
<para>Specifies that traits stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Effects">
<summary>
<para>Specifies that effects stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Abilities">
<summary>
<para>Specifies that abilities stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.Interactions">
<summary>
<para>Specifies that interactions stuff should be logged.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.EnableTools">
<summary>
<para>Specifies that various debug tools should be enabled.</para>
</summary>
</member>
<member name="F:RogueLibsCore.DebugFlags.All">
<summary>
<para>Specifies all debug flags. Expect a giant wall of constantly flowing text.</para>
</summary>
</member>
<member name="T:RogueLibsCore.AbilityHeldArgs">
<summary>
<para>Represents the custom ability's holding args.</para>
</summary>
</member>
<member name="P:RogueLibsCore.AbilityHeldArgs.HeldTime">
<summary>
<para>Gets or sets the current holding time, in seconds.</para>
</summary>
</member>
<member name="M:RogueLibsCore.AbilityHeldArgs.Interrupt">
<summary>
<para>Interrupts the custom ability's holding.</para>
</summary>
</member>
<member name="T:RogueLibsCore.AbilityRechargingArgs">
<summary>
<para>Represents the custom ability's recharging args.</para>
</summary>
</member>
<member name="P:RogueLibsCore.AbilityRechargingArgs.UpdateDelay">
<summary>
<para>Gets or sets the update delay of the recharging coroutine, in seconds.</para>
</summary>
</member>
<member name="P:RogueLibsCore.AbilityRechargingArgs.ShowRechargedText">
<summary>
<para>Gets or sets whether to display the Recharged text, when the custom ability is recharged.</para>
</summary>
</member>
<member name="T:RogueLibsCore.AbilityReleasedArgs">
<summary>
<para>Represents the custom ability's released args.</para>
</summary>
</member>
<member name="M:RogueLibsCore.AbilityReleasedArgs.#ctor(System.Single)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.AbilityReleasedArgs"/> class with the specified <paramref name="heldTime"/>.</para>
</summary>
<param name="heldTime">The custom ability's held time.</param>
</member>
<member name="P:RogueLibsCore.AbilityReleasedArgs.HeldTime">
<summary>
<para>Gets the last holding time, in seconds.</para>
</summary>
</member>
<member name="T:RogueLibsCore.CustomAbility">
<summary>
<para>Represents a custom ability.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomAbility.SetupDetails">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.CustomAbility.OnAdded">
<summary>
<para>The method that is called when the special ability is added.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomAbility.OnPressed">
<summary>
<para>The method that is called when the special ability is pressed.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomAbility.GetIndicator">
<summary>
<para>The method that is called to determine the special ability indicator over the current target.</para>
</summary>
<returns>The sprite to display over the current target.</returns>
</member>
<member name="P:RogueLibsCore.CustomAbility.CurrentTarget">
<summary>
<para>Gets the last <see cref="T:PlayfieldObject"/> returned by the <see cref="M:RogueLibsCore.IAbilityTargetable.FindTarget"/> method.</para>
</summary>
</member>
<member name="T:RogueLibsCore.IAbilityChargeable">
<summary>
<para>Indicates that a custom ability is chargeable.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IAbilityChargeable.OnHeld(RogueLibsCore.AbilityHeldArgs)">
<summary>
<para>The method that is called each frame when the special ability is held.</para>
</summary>
<param name="e">The custom ability's holding data.</param>
</member>
<member name="M:RogueLibsCore.IAbilityChargeable.OnReleased(RogueLibsCore.AbilityReleasedArgs)">
<summary>
<para>The method that is called when the special ability is released.</para>
</summary>
<param name="e">The custom ability's release data.</param>
</member>
<member name="T:RogueLibsCore.IAbilityRechargeable">
<summary>
<para>Indicates that a custom ability is rechargeable.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IAbilityRechargeable.OnRecharging(RogueLibsCore.AbilityRechargingArgs)">
<summary>
<para>The method that is called as a part of the special ability's recharging coroutine.</para>
</summary>
<param name="e">The custom ability's recharging data.</param>
</member>
<member name="T:RogueLibsCore.IAbilityTargetable">
<summary>
<para>Indicates that a custom ability is targetable.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IAbilityTargetable.FindTarget">
<summary>
<para>The method that is called to determine what the special ability owner can use the ability on.</para>
</summary>
<returns>The target object, if the special ability can be used; otherwise, <see langword="null"/>.</returns>
</member>
<member name="T:RogueLibsCore.CustomEffect">
<summary>
<para>Represents a custom status effect.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomEffect.Effect">
<summary>
<para>Gets the current <see cref="T:StatusEffect"/> instance.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomEffect.StatusEffects">
<summary>
<para>Gets the status effect's <see cref="T:StatusEffects"/> instance.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomEffect.Owner">
<summary>
<para>Gets the status effect's owner.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomEffect.CausedBy">
<summary>
<para>Gets the agent that caused the status effect.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomEffect.CurrentTime">
<summary>
<para>Gets or sets the status effect's current time.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomEffect.gc">
<summary>
<para>Gets the currently used instance of <see cref="T:GameController"/>.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomEffect.EffectInfo">
<summary>
<para>Gets the custom effect's metadata.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomEffect.Initialize">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.CustomEffect.GetEffectTime">
<summary>
<para>Gets the default status effect time. Might get called on a partially initialized status effect.</para>
</summary>
<returns>The default status effect time, in seconds.</returns>
</member>
<member name="M:RogueLibsCore.CustomEffect.GetEffectHate">
<summary>
<para>Gets the default status effect hate. Might get called on a partially initialized status effect.
<br/>Usually, it's 5 for negative effects and 0 for positive.</para>
</summary>
<returns>The default status effect hate.</returns>
</member>
<member name="M:RogueLibsCore.CustomEffect.OnAdded">
<summary>
<para>The method that is called when the status effect is added.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomEffect.OnRefreshed">
<summary>
<para>The method that is called when the status effect is refreshed.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomEffect.OnRemoved">
<summary>
<para>The method that is called when the status effect is removed.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomEffect.OnUpdated(RogueLibsCore.EffectUpdatedArgs)">
<summary>
<para>The method that is called as a part of the status effect's update coroutine.</para>
</summary>
<param name="e">The custom effect's update data.</param>
</member>
<member name="T:RogueLibsCore.CustomEffectFactory">
<summary>
<para>Represents a factory of <see cref="T:RogueLibsCore.CustomEffect"/> hooks.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomEffectFactory.TryCreate(StatusEffect,RogueLibsCore.IHook{StatusEffect}@)">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.CustomEffectFactory.AddEffect``1">
<summary>
<para>Adds the specified <typeparamref name="TEffect"/> type to the factory.</para>
</summary>
<typeparam name="TEffect">The <see cref="T:RogueLibsCore.CustomEffect"/> type to add.</typeparam>
<returns>The added effect's metadata.</returns>
</member>
<member name="T:RogueLibsCore.EffectInfo">
<summary>
<para>Represents the <see cref="T:RogueLibsCore.CustomEffect"/> type metadata.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectInfo.Name">
<summary>
<para>Gets the custom effect's name.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectInfo.Limitations">
<summary>
<para>Gets the custom effect's limitations flags.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectInfo.RemoveOnDeath">
<summary>
<para>Determines whether the status effect is removed on death.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectInfo.RemoveOnKnockOut">
<summary>
<para>Determines whether the status effect is removed on knockout.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectInfo.RemoveOnNextLevel">
<summary>
<para>Determines whether the status effect is removed between levels.</para>
</summary>
</member>
<member name="M:RogueLibsCore.EffectInfo.Get(System.Type)">
<summary>
<para>Gets the specified <see cref="T:RogueLibsCore.CustomEffect"/> <paramref name="type"/>'s metadata.</para>
</summary>
<param name="type">The <see cref="T:RogueLibsCore.CustomEffect"/> type to get the metadata for.</param>
<returns>The specified <paramref name="type"/>'s metadata.</returns>
<exception cref="T:System.ArgumentException"><paramref name="type"/> is not a <see cref="T:RogueLibsCore.CustomEffect"/>.</exception>
</member>
<member name="M:RogueLibsCore.EffectInfo.Get``1">
<summary>
<para>Gets the specified <typeparamref name="TEffect"/>'s metadata.</para>
</summary>
<typeparam name="TEffect">The <see cref="T:RogueLibsCore.CustomEffect"/> type get the metadata for.</typeparam>
<returns>The specified <typeparamref name="TEffect"/>'s metadata.</returns>
</member>
<member name="T:RogueLibsCore.EffectLimitations">
<summary>
<para>Represents a custom effect's limitations.</para>
</summary>
</member>
<member name="F:RogueLibsCore.EffectLimitations.None">
<summary>
<para>No limitations.</para>
</summary>
</member>
<member name="F:RogueLibsCore.EffectLimitations.RemoveOnDeath">
<summary>
<para>The effect will be removed on death.</para>
</summary>
</member>
<member name="F:RogueLibsCore.EffectLimitations.RemoveOnKnockOut">
<summary>
<para>The effect will be removed on knockout.</para>
</summary>
</member>
<member name="F:RogueLibsCore.EffectLimitations.RemoveOnNextLevel">
<summary>
<para>The effect will be removed on the next level.</para>
</summary>
</member>
<member name="T:RogueLibsCore.EffectNameAttribute">
<summary>
<para>Specifies a different name for the custom item to use.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectNameAttribute.Name">
<summary>
<para>Gets the custom effect's name.</para>
</summary>
</member>
<member name="M:RogueLibsCore.EffectNameAttribute.#ctor(System.String)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.EffectNameAttribute"/> class with the specified <paramref name="name"/>.</para>
</summary>
<param name="name">The custom effect's name.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="name"/> is <see langword="null"/>.</exception>
</member>
<member name="T:RogueLibsCore.EffectParametersAttribute">
<summary>
<para>Specifies custom effect's parameters.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectParametersAttribute.Limitations">
<summary>
<para>Gets the custom effect's limitations.</para>
</summary>
</member>
<member name="M:RogueLibsCore.EffectParametersAttribute.#ctor(RogueLibsCore.EffectLimitations)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.EffectParametersAttribute"/> class with the specified <paramref name="limitations"/>.</para>
</summary>
<param name="limitations"></param>
</member>
<member name="T:RogueLibsCore.EffectUpdatedArgs">
<summary>
<para>Represents the custom effect's update coroutine args.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectUpdatedArgs.UpdateDelay">
<summary>
<para>Gets or sets the update delay of the coroutine, in seconds.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectUpdatedArgs.ShowTextOnRemoval">
<summary>
<para>Gets or sets whether to display the removal text, when the custom effect is removed.</para>
</summary>
</member>
<member name="P:RogueLibsCore.EffectUpdatedArgs.IsFirstTick">
<summary>
<para>Gets or sets whether it's the first tick of the coroutine.</para>
</summary>
</member>
<member name="T:RogueLibsCore.HookBase`1">
<summary>
<para>Represents a hook base. Implements the interfaces, leaving only one abstract method to implement.</para>
</summary>
<typeparam name="T">The type of objects that the hook can be attached to.</typeparam>
</member>
<member name="M:RogueLibsCore.HookBase`1.Initialize">
<summary>
<para>Initializes the hook.</para>
</summary>
</member>
<member name="P:RogueLibsCore.HookBase`1.Instance">
<summary>
<para>Gets or sets the instance that the hook is attached to.</para>
</summary>
</member>
<member name="T:RogueLibsCore.HookController`1">
<summary>
<para>The default implementation of <see cref="T:RogueLibsCore.IHookController`1"/>.</para>
</summary>
<typeparam name="T">The type of objects that the hooks can be attached to.</typeparam>
</member>
<member name="M:RogueLibsCore.HookController`1.#ctor(`0)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.HookController`1"/> class with the specified <paramref name="instance"/>.</para>
</summary>
<param name="instance">An object that the hooks will be attached to.</param>
</member>
<member name="P:RogueLibsCore.HookController`1.Instance">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.HookController`1.AddHook(RogueLibsCore.IHook{`0})">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.HookController`1.AddHook``1">
<summary>
<para>Creates a hook of the specified <typeparamref name="THook"/> type using its default constructor and attaches it to the current instance.</para>
</summary>
<typeparam name="THook">The type of the hook to create and attach to the current instance.</typeparam>
<returns>The created hook of the specified <typeparamref name="THook"/> type.</returns>
</member>
<member name="M:RogueLibsCore.HookController`1.RemoveHook(RogueLibsCore.IHook{`0})">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.HookController`1.RemoveHook``1">
<summary>
<para>Detaches a hook of the specified <typeparamref name="THook"/> type from the current instance.</para>
</summary>
<typeparam name="THook">The type of the hook to detach from the current instance.</typeparam>
<returns><see langword="true"/>, if a hook of the specified <typeparamref name="THook"/> type was successfully detached; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.HookController`1.GetHook``1">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.HookController`1.GetHooks``1">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.HookController`1.GetHooks">
<summary>
<para>Gets all hooks attached to the current instance.</para>
</summary>
<returns>A collection of hooks attached to the current instance.</returns>
</member>
<member name="T:RogueLibsCore.HookFactoryBase`1">
<summary>
<para>Represents a hook factory base. Implements the interfaces, leaving only one abstract method to implement.</para>
</summary>
<typeparam name="T">The type of objects that the created hooks can be attached to.</typeparam>
</member>
<member name="M:RogueLibsCore.HookFactoryBase`1.TryCreate(`0,RogueLibsCore.IHook{`0}@)">
<inheritdoc/>
</member>
<member name="T:RogueLibsCore.IDoFixedUpdate">
<summary>
<para>Indicates that this hook class should be updated with Unity's FixedUpdate method.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IDoFixedUpdate.FixedUpdate">
<summary>
<para>The Unity's FixedUpdate method, that is called approximately 60 times per second, or 100 times per second when everything's slowed down.</para>
</summary>
</member>
<member name="T:RogueLibsCore.IDoUpdate">
<summary>
<para>Indicates that this hook class should be updated with Unity's Update method.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IDoUpdate.Update">
<summary>
<para>The Unity's Update method, that is called once per frame.</para>
</summary>
</member>
<member name="T:RogueLibsCore.IHook">
<summary>
<para>Represents a hook.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IHook.Initialize">
<summary>
<para>Initializes the hook.</para>
</summary>
</member>
<member name="P:RogueLibsCore.IHook.Instance">
<summary>
<para>Gets or sets the instance that the hook is attached to.</para>
</summary>
</member>
<member name="T:RogueLibsCore.IHook`1">
<summary>
<para>Represents a hook, attachable to instances of type <typeparamref name="T"/>.</para>
</summary>
<typeparam name="T">The type of objects that the hook can be attached to.</typeparam>
</member>
<member name="P:RogueLibsCore.IHook`1.Instance">
<summary>
<para>Gets or sets the instance that the hook is attached to.</para>
</summary>
</member>
<member name="T:RogueLibsCore.IHookController">
<summary>
<para>Represents a collection of hooks, attached to a single object.</para>
</summary>
</member>
<member name="P:RogueLibsCore.IHookController.Instance">
<summary>
<para>Gets the object that the hooks are attached to.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IHookController.AddHook(RogueLibsCore.IHook)">
<summary>
<para>Attaches the specified <paramref name="hook"/> to the current instance.</para>
</summary>
<param name="hook">The hook to attach to the current instance.</param>
</member>
<member name="M:RogueLibsCore.IHookController.RemoveHook(RogueLibsCore.IHook)">
<summary>
<para>Detaches the specified <paramref name="hook"/> from the current instance.</para>
</summary>
<param name="hook">The hook to detach from the current instance.</param>
<returns><see langword="true"/>, if the hook was successfully detached; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.IHookController.GetHook``1">
<summary>
<para>Gets a hook from the collection that is assignable to a variable of <typeparamref name="THook"/> type.</para>
</summary>
<typeparam name="THook">The type of the hook to search for.</typeparam>
<returns>A hook that is assignable to a variable of <typeparamref name="THook"/> type, if found; otherwise, <see langword="null"/>.</returns>
</member>
<member name="M:RogueLibsCore.IHookController.GetHooks``1">
<summary>
<para>Returns an enumerable collection of all hooks in the collection that are assignable to a variable of <typeparamref name="THook"/> type.</para>
</summary>
<typeparam name="THook">The type of the hooks to search for.</typeparam>
<returns>An enumerable collection of hooks that are assignable to a variable of <typeparamref name="THook"/> type.</returns>
</member>
<member name="T:RogueLibsCore.IHookController`1">
<summary>
<para>Represents a collection of hooks, attached to a single instance of type <typeparamref name="T"/>.</para>
</summary>
<typeparam name="T">The type of objects, that the hooks can be attached to.</typeparam>
</member>
<member name="P:RogueLibsCore.IHookController`1.Instance">
<summary>
<para>Gets the instance of type <typeparamref name="T"/> that the hooks are attached to.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IHookController`1.AddHook(RogueLibsCore.IHook{`0})">
<summary>
<para>Attaches the specified <paramref name="hook"/> to the current instance.</para>
</summary>
<param name="hook">The hook to attach to the current instance.</param>
</member>
<member name="M:RogueLibsCore.IHookController`1.RemoveHook(RogueLibsCore.IHook{`0})">
<summary>
<para>Detaches the specified <paramref name="hook"/> from the current instance.</para>
</summary>
<param name="hook">The hook to detach from the current instance.</param>
<returns><see langword="true"/>, if the hook was successfully detached; otherwise, <see langword="false"/>.</returns>
</member>
<member name="T:RogueLibsCore.IHookFactory">
<summary>
<para>Represents a hook factory.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IHookFactory.TryCreate(System.Object,RogueLibsCore.IHook@)">
<summary>
<para>Tries to create a hook for the specified <paramref name="instance"/>, and returns a value that indicates whether a hook was created successfully.</para>
</summary>
<param name="instance">The object to create a hook for.</param>
<param name="hook">A hook created for the specified <paramref name="instance"/>.</param>
<returns><see langword="true"/>, if a hook was successfully created; otherwise, <see langword="false"/>.</returns>
</member>
<member name="T:RogueLibsCore.IHookFactory`1">
<summary>
<para>Represents a hook factory, that creates hooks attachable to instances of type <typeparamref name="T"/>.</para>
</summary>
<typeparam name="T">The type of objects that the created hooks can be attached to.</typeparam>
</member>
<member name="M:RogueLibsCore.IHookFactory`1.TryCreate(`0,RogueLibsCore.IHook{`0}@)">
<summary>
<para>Tries to create a hook for the specified <paramref name="instance"/> of type <typeparamref name="T"/>, and returns a value that indicates whether a hook was created successfully.</para>
</summary>
<param name="instance">The instance of type <typeparamref name="T"/> to create a hook for.</param>
<param name="hook">A hook created for the specified <paramref name="instance"/> of type <typeparamref name="T"/>.</param>
<returns><see langword="true"/>, if a hook was successfully created; otherwise, <see langword="false"/>.</returns>
</member>
<member name="T:RogueLibsCore.CustomItem">
<summary>
<para>Represents a custom item.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomItem.Item">
<summary>
<para>Gets the current <see cref="T:InvItem"/> instance.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomItem.Inventory">
<summary>
<para>Gets the item's inventory.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomItem.Owner">
<summary>
<para>Gets the item's owner.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomItem.Count">
<summary>
<para>Gets or sets the item's current count.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomItem.gc">
<summary>
<para>Gets the currently used instance of <see cref="T:GameController"/>.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomItem.ItemInfo">
<summary>
<para>Gets the custom item's metadata.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomItem.Initialize">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.CustomItem.SetupDetails">
<summary>
<para>The method that is called when the item's details are set up.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomItem.GetCountString">
<summary>
<para>Returns the custom item's count text.</para>
</summary>
<returns>The custom count string, if overriden; otherwise, <see langword="null"/>.</returns>
</member>
<member name="T:RogueLibsCore.CustomItemFactory">
<summary>
<para>Represents a factory of <see cref="T:RogueLibsCore.CustomItem"/> hooks.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomItemFactory.TryCreate(InvItem,RogueLibsCore.IHook{InvItem}@)">
<inheritdoc/>
</member>
<member name="M:RogueLibsCore.CustomItemFactory.AddItem``1">
<summary>
<para>Adds the specified <typeparamref name="TItem"/> type to the factory.</para>
</summary>
<typeparam name="TItem">The <see cref="T:RogueLibsCore.CustomItem"/> type to add.</typeparam>
<returns>The added item's metadata.</returns>
</member>
<member name="T:RogueLibsCore.CustomTooltip">
<summary>
<para>Represents a custom tooltip.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomTooltip.#ctor(System.String)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.CustomTooltip"/> structure with the specified <paramref name="text"/>.</para>
</summary>
<param name="text">The text of the tooltip.</param>
</member>
<member name="M:RogueLibsCore.CustomTooltip.#ctor(System.String,UnityEngine.Color)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.CustomTooltip"/> structure with the specified <paramref name="text"/> and <paramref name="color"/>.</para>
</summary>
<param name="text">The text of the tooltip.</param>
<param name="color">The color of the text.</param>
</member>
<member name="M:RogueLibsCore.CustomTooltip.#ctor(System.Object)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.CustomTooltip"/> structure with the specified <paramref name="obj"/>.</para>
</summary>
<param name="obj">An object representing the text of the tooltip.</param>
</member>
<member name="M:RogueLibsCore.CustomTooltip.#ctor(System.Object,UnityEngine.Color)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.CustomTooltip"/> structure with the specified <paramref name="obj"/> and <paramref name="color"/>.</para>
</summary>
<param name="obj">An object representing the text of the tooltip.</param>
<param name="color">The color of the tooltip text.</param>
</member>
<member name="P:RogueLibsCore.CustomTooltip.Text">
<summary>
<para>Gets the text of the tooltip.</para>
</summary>
</member>
<member name="P:RogueLibsCore.CustomTooltip.Color">
<summary>
<para>Gets the color of the tooltip text.</para>
</summary>
</member>
<member name="M:RogueLibsCore.CustomTooltip.op_Implicit(System.String)~RogueLibsCore.CustomTooltip">
<summary>
<para>Implicitly converts a <see cref="T:System.String"/> into a <see cref="T:RogueLibsCore.CustomTooltip"/>.</para>
</summary>
<param name="text">The text of the tooltip.</param>
</member>
<member name="M:RogueLibsCore.CustomTooltip.op_Implicit(System.Int32)~RogueLibsCore.CustomTooltip">
<summary>
<para>Implicitly converts an <see cref="T:System.Int32"/> into a <see cref="T:RogueLibsCore.CustomTooltip"/>.</para>
</summary>
<param name="number">The text of the tooltip.</param>
</member>
<member name="M:RogueLibsCore.CustomTooltip.op_Implicit(System.Single)~RogueLibsCore.CustomTooltip">
<summary>
<para>Implicitly converts a <see cref="T:System.Single"/> into a <see cref="T:RogueLibsCore.CustomTooltip"/>.</para>
</summary>
<param name="number">The text of the tooltip.</param>
</member>
<member name="M:RogueLibsCore.CustomTooltip.op_Implicit(RogueLibsCore.CustomName)~RogueLibsCore.CustomTooltip">
<summary>
<para>Implicitly converts a <see cref="T:RogueLibsCore.CustomName"/> into a <see cref="T:RogueLibsCore.CustomTooltip"/>.</para>
</summary>
<param name="name">The localizable string representing the text of the tooltip.</param>
</member>
<member name="M:RogueLibsCore.CustomTooltip.op_Implicit(RogueLibsCore.CustomNameInfo)~RogueLibsCore.CustomTooltip">
<summary>
<para>Implicitly converts a <see cref="T:RogueLibsCore.CustomNameInfo"/> into a <see cref="T:RogueLibsCore.CustomTooltip"/>.</para>
</summary>
<param name="nameInfo">The localizable string representing the text of the tooltip.</param>
</member>
<member name="T:RogueLibsCore.IItemCombinable">
<summary>
<para>Indicates that a custom item is combinable.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IItemCombinable.CombineFilter(InvItem)">
<summary>
<para>Determines whether to highlight the <paramref name="other"/> item in the inventory when combining the current item.</para>
</summary>
<param name="other">The other item.</param>
<returns><see langword="true"/>, if the current item can be combined with the <paramref name="other"/> item; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.IItemCombinable.CombineItems(InvItem)">
<summary>
<para>Combines the current item with the <paramref name="other"/> item. The return value indicates whether the combining succeeded or failed.</para>
</summary>
<param name="other">The other item.</param>
<returns><see langword="true"/>, if the current item was successfully combined with the <paramref name="other"/> item; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.IItemCombinable.CombineCursorText(InvItem)">
<summary>
<para>Determines the cursor text when hovering over the <paramref name="other"/> item.</para>
</summary>
<param name="other">The other item.</param>
<returns>The cursor text to display, or <see langword="null"/> to display the default cursor text.</returns>
</member>
<member name="M:RogueLibsCore.IItemCombinable.CombineTooltip(InvItem)">
<summary>
<para>Determines the combine tooltip in the <paramref name="other"/> item's slot.</para>
</summary>
<param name="other">The other item.</param>
<returns>The combine tooltip to display, or <see langword="null"/> to not display anything.</returns>
</member>
<member name="T:RogueLibsCore.IItemTargetable">
<summary>
<para>Indicates that a custom item is targetable.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IItemTargetable.TargetFilter(PlayfieldObject)">
<summary>
<para>Determines whether to highlight the <paramref name="target"/> object when targeting the current item.</para>
</summary>
<param name="target">The target object.</param>
<returns><see langword="true"/>, if the current item can be targeted at the <paramref name="target"/> object; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.IItemTargetable.TargetObject(PlayfieldObject)">
<summary>
<para>Uses the current item on the <paramref name="target"/> object. The return value indicates whether the usage succeeded or failed.</para>
</summary>
<param name="target">The target object.</param>
<returns><see langword="true"/>, if the item was successfully used on the <paramref name="target"/> object; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.IItemTargetable.TargetCursorText(PlayfieldObject)">
<summary>
<para>Determines the cursor text when hovering over the <paramref name="target"/> object.</para>
</summary>
<param name="target">The target object.</param>
<returns>The cursor text to display, or <see langword="null"/> to display the default cursor text.</returns>
</member>
<member name="T:RogueLibsCore.IItemTargetableAnywhere">
<summary>
<para>Indicates that a custom item is targetable anywhere.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IItemTargetableAnywhere.TargetFilter(UnityEngine.Vector2)">
<summary>
<para>Determines whether to highlight the cursor when hovering over the specified <paramref name="position"/> and combining the current item.</para>
</summary>
<param name="position">The target position.</param>
<returns><see langword="true"/>, if the current item can be targeted at the specified <paramref name="position"/>; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.IItemTargetableAnywhere.TargetPosition(UnityEngine.Vector2)">
<summary>
<para>Uses the current item on the specified <paramref name="position"/>. The return value indicates whether the usage succeeded or failed.</para>
</summary>
<param name="position">The target position.</param>
<returns><see langword="true"/>, if the item was successfully used on the specified <paramref name="position"/>; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.IItemTargetableAnywhere.TargetCursorText(UnityEngine.Vector2)">
<summary>
<para>Determines the cursor text when hovering over the specified <paramref name="position"/>.</para>
</summary>
<param name="position">The target position.</param>
<returns>The cursor text to display, or <see langword="null"/> to display the default cursor text.</returns>
</member>
<member name="T:RogueLibsCore.IItemUsable">
<summary>
<para>Indicates that a custom item is usable.</para>
</summary>
</member>
<member name="M:RogueLibsCore.IItemUsable.UseItem">
<summary>
<para>Uses the item. The return value indicates whether the usage succeeded or failed.</para>
</summary>
<returns><see langword="true"/>, if the current item was successfully used; otherwise, <see langword="false"/>.</returns>
</member>
<member name="T:RogueLibsCore.DefaultInventoryChecks">
<summary>
<para>The collection of default inventory checks.</para>
</summary>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.GhostCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents ghost agents from using items.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.PeaBrainedCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Pea-Brained" agents from using non-Food items.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.OnlyOilCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Oil-Reliant" agents from consuming food.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.OnlyOilMedicineCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Oil-Reliant" agents from using medicine.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.OnlyBloodCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Jugularious" agents from consuming food.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.OnlyBloodMedicineCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Jugularious" agents from using medicine.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.OnlyChargeCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Electronic" agents from consuming food.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.OnlyChargeMedicineCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Electronic" agents from using medicine.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.OnlyHumanFleshCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents "Strict Cannibal" agents from consuming non-alcohol food.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="M:RogueLibsCore.DefaultInventoryChecks.FullHealthCheck(RogueLibsCore.OnItemUsingArgs)">
<summary>
<para>Prevents agents with full health from consuming healing items.</para>
</summary>
<param name="e">The item usage event args.</param>
</member>
<member name="T:RogueLibsCore.InventoryChecks">
<summary>
<para>Provides methods to add inventory checks.</para>
</summary>
</member>
<member name="M:RogueLibsCore.InventoryChecks.AddItemUsingCheck(System.String,RogueLibsCore.RogueEventHandler{RogueLibsCore.OnItemUsingArgs})">
<summary>
<para>Adds an item usage inventory check with the specified <paramref name="name"/> and <paramref name="handler"/>.</para>
</summary>
<param name="name">The name of the inventory check to add.</param>
<param name="handler">The inventory check handler.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="handler"/> is <see langword="null"/>.</exception>
</member>
<member name="M:RogueLibsCore.InventoryChecks.AddItemsCombiningCheck(System.String,RogueLibsCore.RogueEventHandler{RogueLibsCore.OnItemsCombiningArgs})">
<summary>
<para>Adds an item combining inventory check with the specified <paramref name="name"/> and <paramref name="handler"/>.</para>
</summary>
<param name="name">The name of the inventory check to add.</param>
<param name="handler">The inventory check handler.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="handler"/> is <see langword="null"/>.</exception>
</member>
<member name="M:RogueLibsCore.InventoryChecks.AddItemTargetingCheck(System.String,RogueLibsCore.RogueEventHandler{RogueLibsCore.OnItemTargetingArgs})">
<summary>
<para>Adds an item targeting inventory check with the specified <paramref name="name"/> and <paramref name="handler"/>.</para>
</summary>
<param name="name">The name of the inventory check to add.</param>
<param name="handler">The inventory check handler.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="handler"/> is <see langword="null"/>.</exception>
</member>
<member name="M:RogueLibsCore.InventoryChecks.AddItemTargetingAnywhereCheck(System.String,RogueLibsCore.RogueEventHandler{RogueLibsCore.OnItemTargetingAnywhereArgs})">
<summary>
<para>Adds an item targeting anywhere inventory check with the specified <paramref name="name"/> and <paramref name="handler"/>.</para>
</summary>
<param name="name">The name of the inventory check to add.</param>
<param name="handler">The inventory check handler.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="handler"/> is <see langword="null"/>.</exception>
</member>
<member name="M:RogueLibsCore.InventoryChecks.IsCheckAllowed(InvItem,System.String)">
<summary>
<para>Determines whether the specified <paramref name="checkName"/> is allowed on the specified <paramref name="item"/>.</para>
</summary>
<param name="item">The item to check whether the inventory check is allowed for.</param>
<param name="checkName">The name of the inventory check.</param>
<returns><see langword="true"/>, if the inventory check is allowed; otherwise, <see langword="false"/>.</returns>
</member>
<member name="M:RogueLibsCore.InventoryChecks.IsCheckAllowed(RogueLibsCore.CustomItem,System.String)">
<summary>
<para>Determines whether the specified <paramref name="checkName"/> is allowed on the specified <paramref name="customItem"/>.</para>
</summary>
<param name="customItem">The custom item to check whether the inventory check is allowed for.</param>
<param name="checkName">The name of the inventory check.</param>
<returns><see langword="true"/>, if the inventory check is allowed; otherwise, <see langword="false"/>.</returns>
</member>
<member name="T:RogueLibsCore.OnItemsCombiningArgs">
<summary>
<para>Represents the item combining inventory check args.</para>
</summary>
</member>
<member name="M:RogueLibsCore.OnItemsCombiningArgs.#ctor(InvItem,InvItem,Agent)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.OnItemsCombiningArgs"/> class with the specified <paramref name="item"/>, <paramref name="otherItem"/> and <paramref name="combiner"/>.</para>
</summary>
<param name="item">The item being combined.</param>
<param name="otherItem">The item being combined with.</param>
<param name="combiner">The agent combining the two items.</param>
<exception cref="T:System.ArgumentNullException"><paramref name="item"/>, <paramref name="otherItem"/> or <paramref name="combiner"/> is <see langword="null"/>.</exception>
</member>
<member name="P:RogueLibsCore.OnItemsCombiningArgs.Inventory">
<summary>
<para>Gets the item's inventory.</para>
</summary>
</member>
<member name="P:RogueLibsCore.OnItemsCombiningArgs.Item">
<summary>
<para>Gets the item being combined.</para>
</summary>
</member>
<member name="P:RogueLibsCore.OnItemsCombiningArgs.OtherItem">
<summary>
<para>Gets or sets the item being combined with.</para>
</summary>
</member>
<member name="P:RogueLibsCore.OnItemsCombiningArgs.Combiner">
<summary>
<para>Gets or sets the agent combining the two items.</para>
</summary>
</member>
<member name="T:RogueLibsCore.OnItemTargetingAnywhereArgs">
<summary>
<para>Represents the item targeting anywhere inventory check args.</para>
</summary>
</member>
<member name="M:RogueLibsCore.OnItemTargetingAnywhereArgs.#ctor(InvItem,UnityEngine.Vector2,Agent)">
<summary>
<para>Initializes a new instance of the <see cref="T:RogueLibsCore.OnItemTargetingAnywhereArgs"/> class with the specified <paramref name="item"/>, <paramref name="position"/> and <paramref name="user"/>.</para>
</summary>
<param name="item">The item being used.</param>
<param name="position">The position being targeted.</param>