Skip to content
Navigation Menu
{{ message }}
forked from TomGrobbe/MenuAPI
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathMenu.cs
More file actions
1610 lines (1438 loc) · 67.5 KB
/
Copy pathMenu.cs
File metadata and controls
1610 lines (1438 loc) · 67.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
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.Linq;
using System.Threading.Tasks;
using CitizenFX.Core;
using static CitizenFX.Core.Native.API;
namespace MenuAPI
{
public class Menu
{
#region Setting up events
#region delegates
/// <summary>
/// Triggered when a <see cref="MenuItem"/> is selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this event occurred.</param>
/// <param name="menuItem">The <see cref="MenuItem"/> that was selected.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of this <see cref="MenuItem"/>.</param>
public delegate void ItemSelectEvent(Menu menu, MenuItem menuItem, int itemIndex);
/// <summary>
/// Triggered when a <see cref="MenuCheckboxItem"/> was toggled.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this event occurred.</param>
/// <param name="menuItem">The <see cref="MenuCheckboxItem"/> that was toggled.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of this <see cref="MenuCheckboxItem"/>.</param>
/// <param name="newCheckedState">The new <see cref="MenuCheckboxItem.Checked"/> state of this <see cref="MenuCheckboxItem"/>.</param>
public delegate void CheckboxItemChangeEvent(Menu menu, MenuCheckboxItem menuItem, int itemIndex, bool newCheckedState);
/// <summary>
/// Triggered when a <see cref="MenuListItem"/> is selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnListItemSelect"/> event occurred.</param>
/// <param name="listItem">The <see cref="MenuListItem"/> that was selected.</param>
/// <param name="selectedIndex">The <see cref="MenuListItem.ListIndex"/> of the <see cref="MenuListItem"/>.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of the <see cref="MenuListItem"/> in the <see cref="Menu"/>.</param>
public delegate void ListItemSelectedEvent(Menu menu, MenuListItem listItem, int selectedIndex, int itemIndex);
/// <summary>
/// Triggered when a <see cref="MenuListItem"/>'s index was changed.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnListIndexChange"/> event occurred.</param>
/// <param name="listItem">The <see cref="MenuListItem"/> that was changed.</param>
/// <param name="oldSelectionIndex">The old <see cref="MenuListItem.ListIndex"/> of the <see cref="MenuListItem"/>.</param>
/// <param name="newSelectionIndex">The new <see cref="MenuListItem.ListIndex"/> of the <see cref="MenuListItem"/>.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of the <see cref="MenuListItem"/> in the <see cref="Menu"/>.</param>
public delegate void ListItemIndexChangedEvent(Menu menu, MenuListItem listItem, int oldSelectionIndex, int newSelectionIndex, int itemIndex);
/// <summary>
/// Triggered when a <see cref="Menu"/> is closed.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> that was closed.</param>
public delegate void MenuClosedEvent(Menu menu);
/// <summary>
/// Triggered when a <see cref="Menu"/> is opened.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> that has been opened.</param>
public delegate void MenuOpenedEvent(Menu menu);
/// <summary>
/// Triggered when the <see cref="CurrentIndex"/> changes.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnIndexChange"/></param> event occurred.
/// <param name="oldItem">The old <see cref="MenuItem"/> that was previously selected.</param>
/// <param name="newItem">The new <see cref="MenuItem"/> that is now selected.</param>
/// <param name="oldIndex">The old <see cref="MenuItem.Index"/> of this item.</param>
/// <param name="newIndex">The new <see cref="MenuItem.Index"/> of this item.</param>
public delegate void IndexChangedEvent(Menu menu, MenuItem oldItem, MenuItem newItem, int oldIndex, int newIndex);
/// <summary>
/// Triggered when the <see cref="MenuSliderItem.Position"/> changes.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnSliderPositionChange"/> event occurred.</param>
/// <param name="sliderItem">The <see cref="MenuSliderItem>"/> that was changed.</param>
/// <param name="oldPosition">The old position of the slider bar.</param>
/// <param name="newPosition">The new position of the slider bar.</param>
/// <param name="itemIndex">The index of this <see cref="MenuSliderItem"/>.</param>
public delegate void SliderPositionChangedEvent(Menu menu, MenuSliderItem sliderItem, int oldPosition, int newPosition, int itemIndex);
/// <summary>
/// Triggered when a <see cref="MenuSliderItem"/> was selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnSliderItemSelect"/> event occurred.</param>
/// <param name="sliderItem">The <see cref="MenuSliderItem>"/> that was pressed.</param>
/// <param name="sliderPosition">The current position of the slider bar.</param>
/// <param name="itemIndex">The index of this <see cref="MenuSliderItem"/>.</param>
public delegate void SliderItemSelectedEvent(Menu menu, MenuSliderItem sliderItem, int sliderPosition, int itemIndex);
/// <summary>
/// Triggered when a <see cref="MenuDynamicListItem"/>'s value was changed.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnDynamicListItemCurrentItemChange"/> event occurred.</param>
/// <param name="dynamicListItem">The <see cref="MenuDynamicListItem"/> that was changed.</param>
/// <param name="oldValue">The old <see cref="MenuDynamicListItem.CurrentItem"/> of the <see cref="MenuDynamicListItem"/>.</param>
/// <param name="newValue">The new <see cref="MenuDynamicListItem.CurrentItem"/> of the <see cref="MenuDynamicListItem"/>.</param>
public delegate void DynamicListItemCurrentItemChangedEvent(Menu menu, MenuDynamicListItem dynamicListItem, string oldValue, string newValue);
/// <summary>
/// Triggered when a <see cref="MenuDynamicListItem"/> is selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnDynamicListItemSelect"/> event occurred.</param>
/// <param name="dynamicListItem">The <see cref="MenuDynamicListItem"/> that was selected.</param>
/// <param name="currentItem">The <see cref="MenuDynamicListItem.CurrentItem"/> of the <see cref="MenuDynamicListItem"/> in the <see cref="Menu"/>.</param>
public delegate void DynamicListItemSelectedEvent(Menu menu, MenuDynamicListItem dynamicListItem, string currentItem);
#endregion
#region events
/// <summary>
/// Triggered when a <see cref="MenuItem"/> is selected.
/// Parameters: <see cref="Menu"/> parentMenu, <see cref="MenuItem"/> menuItem, <see cref="int"/> itemIndex.
/// </summary>
public event ItemSelectEvent OnItemSelect;
/// <summary>
/// Triggered when a <see cref="MenuCheckboxItem"/> was toggled.
/// Parameters: <see cref="Menu"/> parentMenu, <see cref="MenuCheckboxItem"/> menuItem, <see cref="int"/> itemIndex, <see cref="bool"/> newCheckedState.
/// </summary>
public event CheckboxItemChangeEvent OnCheckboxChange;
/// <summary>
/// Triggered when a <see cref="MenuListItem"/> is selected.
/// Parameters: <see cref="Menu"/> menu, <see cref="MenuListItem"/> listItem, <see cref="MenuListItem.ListIndex"/> selectedIndex, <see cref="int"/> itemIndex.
/// </summary>
public event ListItemSelectedEvent OnListItemSelect;
/// <summary>
/// Triggered when a <see cref="MenuListItem"/>'s index was changed.
/// Parameters: <see cref="Menu"/> menu, <see cref="MenuListItem"/> listItem, <see cref="MenuListItem.ListIndex"/> oldSelectionIndex, <see cref="int"/> newSelectionIndex, <see cref="int"/> itemIndex.
/// </summary>
public event ListItemIndexChangedEvent OnListIndexChange;
/// <summary>
/// Triggered when a <see cref="Menu"/> is closed.
/// Parameters: <see cref="Menu"/> closedMenu.
/// </summary>
public event MenuClosedEvent OnMenuClose;
/// <summary>
/// Triggered when a <see cref="Menu"/> is opened.
/// Parameters: <see cref="Menu"/> openedMenu.
/// </summary>
public event MenuOpenedEvent OnMenuOpen;
/// <summary>
/// Triggered when the <see cref="CurrentIndex"/> changes.
/// Parameters: <see cref="Menu"/> menu, <see cref="MenuItem"/> oldSelectedItem, <see cref="MenuItem"/> newSelectedItem, <see cref="int"/> oldIndex, <see cref="int"/> newIndex.
/// </summary>
public event IndexChangedEvent OnIndexChange;
/// <summary>
/// Triggered when the <see cref="MenuSliderItem.Position"/> changes.
/// Parameters: <see cref="Menu"/> menu, <see cref="MenuSliderItem"/> sliderItem, <see cref="int"/> oldPosition, <see cref="int"/> newPosition, <see cref="int"/> itemIndex
/// </summary>
public event SliderPositionChangedEvent OnSliderPositionChange;
/// <summary>
/// Triggered when a <see cref="MenuSliderItem"/> was selected.
/// Parameters: <see cref="Menu"/> menu, <see cref="MenuSliderItem"/> sliderItem, <see cref="int"/> sliderPosition, <see cref="int"/> itemIndex.
/// </summary>
public event SliderItemSelectedEvent OnSliderItemSelect;
/// <summary>
/// Triggered when a <see cref="MenuDynamicListItem"/>'s value was changed.
/// Parameters: <see cref="Menu"/> menu, <see cref="MenuListItem"/> dynamicListItem, <see cref="MenuDynamicListItem.CurrentItem"/> oldValue, <see cref="MenuDynamicListItem.CurrentItem"/> newValue.
/// </summary>
public event DynamicListItemCurrentItemChangedEvent OnDynamicListItemCurrentItemChange;
/// <summary>
/// Triggered when a <see cref="MenuDynamicListItem"/> is selected.
/// Parameters: <see cref="Menu"/> menu, <see cref="MenuDynamicListItem"/> dynamicListItem, <see cref="MenuDynamicListItem.CurrentItem"/> itemValue.
/// </summary>
public event DynamicListItemSelectedEvent OnDynamicListItemSelect;
#endregion
#region virtual voids
/// <summary>
/// Triggered when a <see cref="MenuItem"/> is selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this event occurred.</param>
/// <param name="menuItem">The <see cref="MenuItem"/> that was selected.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of this <see cref="MenuItem"/>.</param>
internal virtual void ItemSelectedEvent(MenuItem menuItem, int itemIndex)
{
OnItemSelect?.Invoke(this, menuItem, itemIndex);
}
/// <summary>
/// Triggered when a <see cref="MenuCheckboxItem"/> was toggled.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this event occurred.</param>
/// <param name="menuItem">The <see cref="MenuCheckboxItem"/> that was toggled.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of this <see cref="MenuCheckboxItem"/>.</param>
/// <param name="newCheckedState">The new <see cref="MenuCheckboxItem.Checked"/> state of this <see cref="MenuCheckboxItem"/>.</param>
internal virtual void CheckboxChangedEvent(MenuCheckboxItem menuItem, int itemIndex, bool _checked)
{
OnCheckboxChange?.Invoke(this, menuItem, itemIndex, _checked);
}
/// <summary>
/// Triggered when a <see cref="MenuListItem"/> is selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnListItemSelect"/> event occurred.</param>
/// <param name="listItem">The <see cref="MenuListItem"/> that was selected.</param>
/// <param name="selectedIndex">The <see cref="MenuListItem.ListIndex"/> of the <see cref="MenuListItem"/>.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of the <see cref="MenuListItem"/> in the <see cref="Menu"/>.</param>
internal virtual void ListItemSelectEvent(Menu menu, MenuListItem listItem, int selectedIndex, int itemIndex)
{
OnListItemSelect?.Invoke(menu, listItem, selectedIndex, itemIndex);
}
/// <summary>
/// Triggered when a <see cref="MenuListItem"/>'s index was changed.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnListIndexChange"/> event occurred.</param>
/// <param name="listItem">The <see cref="MenuListItem"/> that was changed.</param>
/// <param name="oldSelectionIndex">The old <see cref="MenuListItem.ListIndex"/> of the <see cref="MenuListItem"/>.</param>
/// <param name="newSelectionIndex">The new <see cref="MenuListItem.ListIndex"/> of the <see cref="MenuListItem"/>.</param>
/// <param name="itemIndex">The <see cref="MenuItem.Index"/> of the <see cref="MenuListItem"/> in the <see cref="Menu"/>.</param>
internal virtual void ListItemIndexChangeEvent(Menu menu, MenuListItem listItem, int oldSelectionIndex, int newSelectionIndex, int itemIndex)
{
OnListIndexChange?.Invoke(menu, listItem, oldSelectionIndex, newSelectionIndex, itemIndex);
}
/// <summary>
/// Triggered when a <see cref="Menu"/> is closed.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> that was closed.</param>
internal virtual void MenuCloseEvent(Menu menu)
{
OnMenuClose?.Invoke(menu);
}
/// <summary>
/// Triggered when a <see cref="Menu"/> is opened.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> that has been opened.</param>
internal virtual void MenuOpenEvent(Menu menu)
{
OnMenuOpen?.Invoke(menu);
}
/// <summary>
/// Triggered when the <see cref="CurrentIndex"/> changes.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnIndexChange"/> event occurred.</param>
/// <param name="oldItem">The old <see cref="MenuItem"/> that was previously selected.</param>
/// <param name="newItem">The new <see cref="MenuItem"/> that is now selected.</param>
/// <param name="oldIndex">The old <see cref="MenuItem.Index"/> of this item.</param>
/// <param name="newIndex">The new <see cref="MenuItem.Index"/> of this item.</param>
internal virtual void IndexChangeEvent(Menu menu, MenuItem oldItem, MenuItem newItem, int oldIndex, int newIndex)
{
OnIndexChange?.Invoke(menu, oldItem, newItem, oldIndex, newIndex);
}
/// <summary>
/// Triggered when the <see cref="MenuSliderItem.Position"/> changes.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnSliderPositionChange"/> event occurred.</param>
/// <param name="sliderItem">The <see cref="MenuSliderItem>"/> that was changed.</param>
/// <param name="oldPosition">The old position of the slider bar.</param>
/// <param name="newPosition">The new position of the slider bar.</param>
/// <param name="itemIndex">The index of this <see cref="MenuSliderItem"/>.</param>
internal virtual void SliderItemChangedEvent(Menu menu, MenuSliderItem sliderItem, int oldPosition, int newPosition, int itemIndex)
{
OnSliderPositionChange?.Invoke(menu, sliderItem, oldPosition, newPosition, itemIndex);
}
/// <summary>
/// Triggered when a <see cref="MenuSliderItem"/> was selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnSliderItemSelect"/> event occurred.</param>
/// <param name="sliderItem">The <see cref="MenuSliderItem>"/> that was pressed.</param>
/// <param name="sliderPosition">The current position of the slider bar.</param>
/// <param name="itemIndex">The index of this <see cref="MenuSliderItem"/>.</param>
internal virtual void SliderSelectedEvent(Menu menu, MenuSliderItem sliderItem, int sliderPosition, int itemIndex)
{
OnSliderItemSelect?.Invoke(menu, sliderItem, sliderPosition, itemIndex);
}
/// <summary>
/// Triggered when a <see cref="MenuDynamicListItem"/>'s value was changed.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnDynamicListItemCurrentItemChange"/> event occurred.</param>
/// <param name="dynamicListItem">The <see cref="MenuDynamicListItem"/> that was changed.</param>
/// <param name="oldValue">The old <see cref="MenuDynamicListItem.CurrentItem"/> of the <see cref="MenuDynamicListItem"/>.</param>
/// <param name="newValue">The new <see cref="MenuDynamicListItem.CurrentItem"/> of the <see cref="MenuDynamicListItem"/>.</param>
internal virtual void DynamicListItemCurrentItemChanged(Menu menu, MenuDynamicListItem dynamicListItem, string oldValue, string newValue)
{
OnDynamicListItemCurrentItemChange?.Invoke(menu, dynamicListItem, oldValue, newValue);
}
/// <summary>
/// Triggered when a <see cref="MenuDynamicListItem"/> is selected.
/// </summary>
/// <param name="menu">The <see cref="Menu"/> in which this <see cref="OnDynamicListItemSelect"/> event occurred.</param>
/// <param name="dynamicListItem">The <see cref="MenuDynamicListItem"/> that was selected.</param>
/// <param name="currentItem">The <see cref="MenuDynamicListItem.CurrentItem"/> of the <see cref="MenuDynamicListItem"/> in the <see cref="Menu"/>.</param>
internal virtual void DynamicListItemSelectEvent(Menu menu, MenuDynamicListItem dynamicListItem, string currentItem)
{
OnDynamicListItemSelect?.Invoke(menu, dynamicListItem, currentItem);
}
#endregion
#endregion
#region constants or readonlys
public const float Width = 500f;
#endregion
#region private variables
private static KeyValuePair<float, float> headerSize = new KeyValuePair<float, float>(Width, 110f);
private int index = 0;
private bool visible = false;
public int ViewIndexOffset { get; private set; } = 0;
private List<MenuItem> VisibleMenuItems
{
get
{
// Create a duplicate list, just in case the original list is modified while we're looping through it.
if (filterActive)
{
var items = FilterItems.ToList().GetRange(ViewIndexOffset, Math.Min(MaxItemsOnScreen, Size - ViewIndexOffset));
return items;
}
else
{
var items = GetMenuItems().ToList().GetRange(ViewIndexOffset, Math.Min(MaxItemsOnScreen, Size - ViewIndexOffset));
return items;
}
}
}
private List<MenuItem> FilterItems { get; set; } = new List<MenuItem>();
private List<MenuItem> MenuItems { get; set; } = new List<MenuItem>();
private readonly int ColorPanelScaleform = RequestScaleformMovie("COLOUR_SWITCHER_02"); // Could probably be improved, but was getting some glitchy results if it wasn't pre-loaded.
private readonly int OpacityPanelScaleform = RequestScaleformMovie("COLOUR_SWITCHER_01"); // Could probably be improved, but was getting some glitchy results if it wasn't pre-loaded.
#endregion
#region Public Variables
public string MenuTitle { get; set; }
public string MenuSubtitle { get; set; }
public KeyValuePair<string, string> HeaderTexture { get; set; } = new KeyValuePair<string, string>();
public bool IgnoreDontOpenMenus { get; set; } = false;
public int MaxItemsOnScreen { get; internal set; } = 10;
public int Size => filterActive ? FilterItems.Count : MenuItems.Count;
public bool Visible
{
get
{
return visible;
}
set
{
if (value)
{
MenuController.VisibleMenus.Add(this);
}
else
{
MenuController.VisibleMenus.Remove(this);
}
visible = value;
}
}
public bool LeftAligned => MenuController.MenuAlignment == MenuController.MenuAlignmentOption.Left;
public KeyValuePair<float, float> Position { get; private set; } = new KeyValuePair<float, float>(0f, 0f);
public float MenuItemsYOffset { get; private set; } = 0f;
public string CounterPreText { get; set; }
public Menu ParentMenu { get; internal set; } = null;
public int CurrentIndex { get { return index; } internal set { index = MathUtil.Clamp(value, 0, Math.Max(0, Size - 1)); } }
public bool EnableInstructionalButtons { get; set; } = true;
/// <summary>
/// Should contain 4 floats.
/// </summary>
public float[] WeaponStats { get; private set; } = new float[4] { 0f, 0f, 0f, 0f };
/// <summary>
/// Should contain 4 floats.
/// </summary>
public float[] WeaponComponentStats { get; private set; } = new float[4] { 0f, 0f, 0f, 0f };
/// <summary>
/// Should contain 4 floats.
/// </summary>
public float[] VehicleStats { get; private set; } = new float[4] { 0f, 0f, 0f, 0f };
/// <summary>
/// Should contain 4 floats.
/// </summary>
public float[] VehicleUpgradeStats { get; private set; } = new float[4] { 0f, 0f, 0f, 0f };
public bool ShowWeaponStatsPanel { get; set; } = false;
public bool ShowVehicleStatsPanel { get; set; } = false;
private readonly string[] weaponStatNames = new string[4] { "PM_DAMAGE", "PM_FIRERATE", "PM_ACCURACY", "PM_RANGE" };
private readonly string[] vehicleStatNames = new string[4] { "FMMC_VEHST_0", "FMMC_VEHST_1", "FMMC_VEHST_2", "FMMC_VEHST_3" };
private bool filterActive = false;
public Dictionary<Control, string> InstructionalButtons = new Dictionary<Control, string>() { { Control.FrontendAccept, GetLabelText("HUD_INPUT28") }, { Control.FrontendCancel, GetLabelText("HUD_INPUT53") } };
public List<InstructionalButton> CustomInstructionalButtons = new List<InstructionalButton>();
public struct InstructionalButton
{
public string controlString;
public string instructionText;
public InstructionalButton(string controlString, string instructionText)
{
this.controlString = controlString;
this.instructionText = instructionText;
}
}
public enum ControlPressCheckType
{
JUST_RELEASED,
JUST_PRESSED,
RELEASED,
PRESSED
}
public struct ButtonPressHandler
{
// The control to listen for.
internal Control control;
// The type.
internal ControlPressCheckType pressType;
// The function to call when the control is triggered.
internal Action<Menu, Control> function;
// Whether or not the control needs to be disabled if the menu is visible.
internal bool disableControl;
public ButtonPressHandler(Control control, ControlPressCheckType pressType, Action<Menu, Control> function, bool disableControl)
{
this.control = control;
this.pressType = pressType;
this.function = function;
this.disableControl = disableControl;
}
}
public List<ButtonPressHandler> ButtonPressHandlers = new List<ButtonPressHandler>();
#endregion
#region Constructors
/// <summary>
/// Creates a new <see cref="Menu"/>.
/// </summary>
/// <param name="name"></param>
public Menu(string name) : this(name, null) { }
/// <summary>
/// Creates a new <see cref="Menu"/>.
/// </summary>
/// <param name="name"></param>
/// <param name="subtitle"></param>
public Menu(string name, string subtitle)
{
MenuTitle = name;
MenuSubtitle = subtitle;
SetWeaponStats(0f, 0f, 0f, 0f);
SetWeaponComponentStats(0f, 0f, 0f, 0f);
SetVehicleStats(0f, 0f, 0f, 0f);
SetVehicleUpgradeStats(0f, 0f, 0f, 0f);
}
#endregion
#region Public functions
/// <summary>
/// Sets the max amount of visible items on screen at a time.
/// Min = 3, max = 10.
/// </summary>
/// <param name="max">A value between 3 and 10 (inclusive).</param>
public void SetMaxItemsOnScreen(int max)
{
MaxItemsOnScreen = MathUtil.Clamp(max, 3, 10);
}
/// <summary>
/// Resets the index to 0
/// </summary>
public void RefreshIndex() => RefreshIndex(0, 0);
public void RefreshIndex(int index) => RefreshIndex(index, index > MaxItemsOnScreen ? index - MaxItemsOnScreen : 0);
public void RefreshIndex(int index, int viewOffset) { CurrentIndex = index; ViewIndexOffset = viewOffset; }
/// <summary>
/// Returns the menu items in this menu.
/// </summary>
/// <returns></returns>
public List<MenuItem> GetMenuItems()
{
return filterActive ? FilterItems.ToList() : MenuItems.ToList();
}
/// <summary>
/// Gets the currently selected (highlighted) menu item.
/// </summary>
/// <returns>Retuns the currently selected menu item. Or null if there are no menu items, or the current menu index is out of range.</returns>
public MenuItem GetCurrentMenuItem()
{
return GetMenuItems().ElementAtOrDefault(CurrentIndex);
}
/// <summary>
/// Removes all menu items.
/// </summary>
public void ClearMenuItems()
{
CurrentIndex = 0;
ViewIndexOffset = 0;
MenuItems.Clear();
FilterItems.Clear();
}
/// <summary>
/// Removes all menu items.
/// </summary>
public void ClearMenuItems(bool dontResetIndex)
{
if (!dontResetIndex)
{
CurrentIndex = 0;
ViewIndexOffset = 0;
}
MenuItems.Clear();
FilterItems.Clear();
}
/// <summary>
/// Adds a <see cref="MenuItem"/> to this <see cref="Menu"/>.
/// </summary>
/// <param name="item"></param>
public void AddMenuItem(MenuItem item)
{
MenuItems.Add(item);
item.PositionOnScreen = item.Index;
item.ParentMenu = this;
}
/// <summary>
/// Removes the item at that index.
/// </summary>
/// <param name="itemIndex"></param>
public void RemoveMenuItem(int itemIndex)
{
if (CurrentIndex >= itemIndex)
{
if (Size > CurrentIndex)
{
CurrentIndex--;
}
else
{
CurrentIndex = 0;
}
}
if (itemIndex < Size && itemIndex > -1)
{
RemoveMenuItem(MenuItems[itemIndex]);
}
}
/// <summary>
/// Removes the specified <see cref="MenuItem"/> from this <see cref="Menu"/>.
/// </summary>
/// <param name="item"></param>
public void RemoveMenuItem(MenuItem item)
{
if (!MenuItems.Contains(item))
{
return;
}
if (CurrentIndex >= item.Index)
{
if (Size > CurrentIndex)
{
CurrentIndex--;
}
else
{
CurrentIndex = 0;
}
}
MenuItems.Remove(item);
}
/// <summary>
/// Triggers the <see cref="ItemSelectedEvent(MenuItem, int)"/> event function.
/// </summary>
/// <param name="index"></param>
public void SelectItem(int index)
{
if (!filterActive)
{
if (index > -1 && MenuItems.Count - 1 >= index)
{
SelectItem(MenuItems[index]);
}
}
else
{
if (index > -1 && FilterItems.Count - 1 >= index)
{
SelectItem(FilterItems[index]);
}
}
}
/// <summary>
/// Triggers the <see cref="ItemSelectedEvent(MenuItem, int)"/> event function.
/// </summary>
/// <param name="index"></param>
public void SelectItem(MenuItem item)
{
if (item == null)
{
return;
}
if (!item.Enabled)
{
PlaySoundFrontend(-1, "ERROR", "HUD_FRONTEND_DEFAULT_SOUNDSET", false);
}
else
{
PlaySoundFrontend(-1, "SELECT", "HUD_FRONTEND_DEFAULT_SOUNDSET", false);
item.Select();
if (MenuController.MenuButtons.ContainsKey(item))
{
// this updates the parent menu.
MenuController.AddSubmenu(MenuController.GetCurrentMenu(), MenuController.MenuButtons[item]);
MenuController.GetCurrentMenu().CloseMenu();
MenuController.MenuButtons[item].OpenMenu();
}
}
}
/// <summary>
/// Returns to the parent menu. If there's no parent menu, then the current menu just closes.
/// </summary>
public void GoBack()
{
PlaySoundFrontend(-1, "BACK", "HUD_FRONTEND_DEFAULT_SOUNDSET", false);
CloseMenu();
if (ParentMenu != null)
{
ParentMenu.OpenMenu();
}
}
/// <summary>
/// Closes the menu. Also triggers the <see cref="OnMenuClose"/> event.
/// </summary>
public void CloseMenu()
{
Visible = false;
MenuCloseEvent(this);
}
/// <summary>
/// Opens the menu and triggers the <see cref="OnMenuOpen"/> event.
/// </summary>
public void OpenMenu()
{
Visible = true;
MenuOpenEvent(this);
}
/// <summary>
/// Goes up one menu item if possible.
/// </summary>
public void GoUp()
{
if (!Visible || Size < 2)
{
return;
}
MenuItem oldItem;
if (filterActive)
{
oldItem = FilterItems[CurrentIndex];
}
else
{
oldItem = MenuItems[CurrentIndex];
}
if (CurrentIndex == 0)
{
CurrentIndex = Size - 1;
}
else
{
CurrentIndex--;
}
var currItem = GetCurrentMenuItem();
if (currItem == null || !VisibleMenuItems.Contains(currItem))
{
ViewIndexOffset--;
if (ViewIndexOffset < 0)
{
ViewIndexOffset = Math.Max(Size - MaxItemsOnScreen, 0);
}
}
IndexChangeEvent(this, oldItem, currItem, oldItem.Index, CurrentIndex);
PlaySoundFrontend(-1, "NAV_UP_DOWN", "HUD_FRONTEND_DEFAULT_SOUNDSET", false);
}
/// <summary>
/// Goes down one menu item if possible.
/// </summary>
public void GoDown()
{
if (!Visible || Size < 2)
{
return;
}
MenuItem oldItem;
if (filterActive)
{
oldItem = FilterItems[CurrentIndex];
}
else
{
oldItem = MenuItems[CurrentIndex];
}
if (CurrentIndex > 0 && CurrentIndex >= Size - 1)
{
CurrentIndex = 0;
}
else
{
CurrentIndex++;
}
var currItem = GetCurrentMenuItem();
if (currItem == null || !VisibleMenuItems.Contains(currItem))
{
ViewIndexOffset++;
if (CurrentIndex == 0)
{
ViewIndexOffset = 0;
}
}
IndexChangeEvent(this, oldItem, currItem, oldItem.Index, CurrentIndex);
PlaySoundFrontend(-1, "NAV_UP_DOWN", "HUD_FRONTEND_DEFAULT_SOUNDSET", false);
}
/// <summary>
/// If the item is a <see cref="MenuListItem"/> or a <see cref="MenuSliderItem"/> then it'll go left if possible.
/// </summary>
public void GoLeft()
{
if (!MenuController.AreMenuButtonsEnabled)
{
return;
}
var item = GetCurrentMenuItem();
if (item != null)
{
item.GoLeft();
}
// If the item is not any of the above, return to parent menu.
else if (MenuController.NavigateMenuUsingArrows && !MenuController.DisableBackButton && !(MenuController.PreventExitingMenu && ParentMenu == null))
{
GoBack();
}
}
/// <summary>
/// If the item is a <see cref="MenuListItem"/> or a <see cref="MenuSliderItem"/> then it'll go right if possible.
/// </summary>
public void GoRight()
{
if (!MenuController.AreMenuButtonsEnabled)
{
return;
}
var item = GetCurrentMenuItem();
if (item != null)
{
item.GoRight();
}
}
/// <summary>
/// Sorts the menu items using the provided compare function.
/// </summary>
/// <param name="compare"></param>
public void SortMenuItems(Comparison<MenuItem> compare)
{
if (filterActive)
{
filterActive = false;
FilterItems.Clear();
}
MenuItems.Sort(compare);
}
/// <summary>
/// Filters menu items using the provided filter function.
/// </summary>
/// <param name="predicate"></param>
public void FilterMenuItems(Func<MenuItem, bool> predicate)
{
if (filterActive)
{
ResetFilter();
}
RefreshIndex(0, 0);
ViewIndexOffset = 0;
FilterItems = MenuItems.Where(i => predicate.Invoke(i)).ToList();
filterActive = true;
}
/// <summary>
/// Clears the current menu items filter for this menu.
/// </summary>
public void ResetFilter()
{
RefreshIndex(0, 0);
filterActive = false;
FilterItems.Clear();
}
/// <summary>
/// Values should be between 0 and 1.
/// </summary>
/// <param name="damage"></param>
/// <param name="fireRate"></param>
/// <param name="accuracy"></param>
/// <param name="range"></param>
public void SetWeaponStats(float damage, float fireRate, float accuracy, float range)
{
WeaponStats = new float[4]
{
MathUtil.Clamp(damage, 0f, 1f),
MathUtil.Clamp(fireRate, 0f, 1f),
MathUtil.Clamp(accuracy, 0f, 1f),
MathUtil.Clamp(range, 0f, 1f)
};
}
/// <summary>
/// Values should be between 0 and 1.
/// </summary>
/// <param name="damage"></param>
/// <param name="fireRate"></param>
/// <param name="accuracy"></param>
/// <param name="range"></param>
public void SetWeaponComponentStats(float damage, float fireRate, float accuracy, float range)
{
WeaponComponentStats = new float[4]
{
MathUtil.Clamp(WeaponStats[0] + damage, 0f, 1f),
MathUtil.Clamp(WeaponStats[1] + fireRate, 0f, 1f),
MathUtil.Clamp(WeaponStats[2] + accuracy, 0f, 1f),
MathUtil.Clamp(WeaponStats[3] + range, 0f, 1f)
};
}
/// <summary>
/// Values should be between 0 and 1.
/// </summary>
/// <param name="topSpeed"></param>
/// <param name="acceleration"></param>
/// <param name="braking"></param>
/// <param name="traction"></param>
public void SetVehicleStats(float topSpeed, float acceleration, float braking, float traction)
{
VehicleStats = new float[4]
{
MathUtil.Clamp(topSpeed, 0f, 1f),
MathUtil.Clamp(acceleration, 0f, 1f),
MathUtil.Clamp(braking, 0f, 1f),
MathUtil.Clamp(traction, 0f, 1f)
};
}
/// <summary>
/// Each upgrade value gets added on top of the already existing vehicle stats.
/// So if the normal topspeed value is set to 0.5, and you provide 0.2 here, the total
/// top speed value will be 0.7, where the last section (0.2) will be colored in blue.
/// The bar can only show values between 0 and 1, so the total value will be clamped between 0 and 1.
/// </summary>
/// <param name="topSpeed"></param>
/// <param name="acceleration"></param>
/// <param name="braking"></param>
/// <param name="traction"></param>
public void SetVehicleUpgradeStats(float topSpeed, float acceleration, float braking, float traction)
{
VehicleUpgradeStats = new float[4]
{
MathUtil.Clamp(VehicleStats[0] + topSpeed, 0f, 1f),
MathUtil.Clamp(VehicleStats[1] + acceleration, 0f, 1f),
MathUtil.Clamp(VehicleStats[2] + braking, 0f, 1f),
MathUtil.Clamp(VehicleStats[3] + traction, 0f, 1f)
};
}
#endregion
#region internal/private task functions
/// <summary>
/// Processes any custom button press handlers for this menu.
/// </summary>
private void ProcessButtonPressHandlers()
{
if (ButtonPressHandlers.Any())
{
if (!MenuController.DisableMenuButtons)
{
foreach (ButtonPressHandler handler in ButtonPressHandlers)
{
if (handler.disableControl)
{
Game.DisableControlThisFrame(0, handler.control);
}
switch (handler.pressType)
{
case ControlPressCheckType.JUST_PRESSED:
if (Game.IsControlJustPressed(0, handler.control) || Game.IsDisabledControlJustPressed(0, handler.control))
handler.function.Invoke(this, handler.control);
break;
case ControlPressCheckType.JUST_RELEASED:
if (Game.IsControlJustReleased(0, handler.control) || Game.IsDisabledControlJustReleased(0, handler.control))
handler.function.Invoke(this, handler.control);
break;
case ControlPressCheckType.PRESSED:
if (Game.IsControlPressed(0, handler.control) || Game.IsDisabledControlPressed(0, handler.control))
handler.function.Invoke(this, handler.control);
break;
case ControlPressCheckType.RELEASED:
if (!Game.IsControlPressed(0, handler.control) && !Game.IsDisabledControlPressed(0, handler.control))
handler.function.Invoke(this, handler.control);
break;
default:
break;
}
}
}
}
}
/// <summary>
/// Draws the menu header.
/// </summary>
/// <param name="menuItemsOffset"></param>
/// <returns>The new menuItemsOffset value</returns>
private async Task<float> DrawHeader(float menuItemsOffset)
{
if (!string.IsNullOrEmpty(MenuTitle))
{
#region Draw Header Background
SetScriptGfxAlign(LeftAligned ? 76 : 82, 84);
SetScriptGfxAlignParams(0f, 0f, 0f, 0f);
float x = (Position.Key + (headerSize.Key / 2f)) / MenuController.ScreenWidth;
float y = (Position.Value + (headerSize.Value / 2f)) / MenuController.ScreenHeight;
float width = headerSize.Key / MenuController.ScreenWidth;
float height = headerSize.Value / MenuController.ScreenHeight;
if (!string.IsNullOrEmpty(HeaderTexture.Key) && !string.IsNullOrEmpty(HeaderTexture.Value))
{
if (!HasStreamedTextureDictLoaded(HeaderTexture.Key))
{
RequestStreamedTextureDict(HeaderTexture.Key, false);
while (!HasStreamedTextureDictLoaded(HeaderTexture.Key))
{
await BaseScript.Delay(0);
}
}
DrawSprite(HeaderTexture.Key, HeaderTexture.Value, x, y, width, height, 0f, 255, 255, 255, 255);
}
else
{
You can’t perform that action at this time.