-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathVehicleFramework.lua
More file actions
2250 lines (1905 loc) · 112 KB
/
VehicleFramework.lua
File metadata and controls
2250 lines (1905 loc) · 112 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
require("BaseClassModifications");
require("SpringFramework/SpringFramework");
VehicleFramework = {};
VehicleFramework.vehicles = {};
-------------
--Constants--
-------------
VehicleFramework.AUTO_GENERATE = "autoGenerate";
---------
--Enums--
---------
VehicleFramework.SuspensionVisualsType = {NONE = 1, SPRITE = 2, DRAWN = 3};
VehicleFramework.TrackAnchorType = {ALL = 1, FIRST_AND_LAST = 2};
VehicleFramework.EventType = {IS_DRIVING = 1, NOT_DRIVING = 2, CHANGED_DIRECTION = 3, IS_STUCK = 4, LANDED_ON_GROUND = 5, FIRED_WEAPON = 6, SUSPENSION_CHANGED_LENGTH = 7, SUSPENSION_REACHED_LIMIT = 8};
VehicleFramework.TraversalOrderType = {FORWARDS = 1, BACKWARDS = 2, RANDOM = 3, STATELESS_RANDOM = 4};
VehicleFramework.OperatorType = {EQUAL = "==", NOT_EQUAL = "~", LESS_THAN = "<", GREATER_THAN = ">", LESS_THAN_OR_EQUAL = "<=", GREATER_THAN_OR_EQUAL = ">="};
--------------------
--Static Functions--
--------------------
function VehicleFramework.getVersion()
return "0.9.2"
end
-------------------------------------------------------------------------------------------------------------------------
--*********************************************************************************************************************--
----------------------------------------------------FRAMEWORK BEGINS!----------------------------------------------------
--*********************************************************************************************************************--
-------------------------------------------------------------------------------------------------------------------------
function VehicleFramework.createVehicle(self, vehicleConfig)
local vehicle = vehicleConfig;
vehicle.self = self;
--Initialize necessary configs if they don't exist
vehicle.general = vehicle.general or {};
vehicle.chassis = vehicle.chassis or {};
vehicle.suspension = vehicle.suspension or {};
vehicle.wheel = vehicle.wheel or {};
vehicle.tensioner = vehicle.tensioner or nil;
vehicle.track = vehicle.track == true and {} or vehicle.track;
vehicle.destruction = vehicle.destruction or {};
vehicle.layer = vehicle.layer or {};
vehicle.events = vehicle.events or {};
vehicle.audio = vehicle.audio or {};
--------------------
--GENERAL SETTINGS--
--------------------
--Necessary setup before setting defaults and limits
vehicle.general.RTE = string.sub(self:GetModuleAndPresetName(), 1, string.find(self:GetModuleAndPresetName(), "/") - 1);
vehicle.general.humanPlayers = {};
for player = 0, ActivityMan:GetActivity().PlayerCount - 1 do
if (ActivityMan:GetActivity():PlayerHuman(player)) then
table.insert(vehicle.general.humanPlayers, player);
end
end
vehicle.general.playerScreens = {};
for _, player in ipairs(vehicle.general.humanPlayers) do
vehicle.general.playerScreens[player] = ActivityMan:GetActivity():ScreenOfPlayer(player);
end
VehicleFramework.setCustomisationDefaultsAndLimits(vehicle);
VehicleFramework.ensureVehicleConfigIsValid(vehicle);
--TODO remove all these unnecessary assignments since can just use vehicle.self
vehicle.general.pos = self.Pos;
vehicle.general.vel = self.Vel;
vehicle.general.controller = self:GetController();
vehicle.general.throttle = 0;
vehicle.general.isInAir = false;
vehicle.general.halfOrMoreInAir = false;
vehicle.general.distanceFallen = 0
vehicle.general.resetDistanceFallenForGround = true;
vehicle.general.isDriving = false;
vehicle.general.isStronglyDecelerating = false;
vehicle.previous = {};
vehicle.previous.pos = Vector(vehicle.general.pos.X, vehicle.general.pos.Y);
vehicle.previous.vel = Vector(vehicle.general.vel.X, vehicle.general.vel.Y);
vehicle.previous.hFlipped = self.HFlipped;
vehicle.previous.springDistanceFromRest = {};
--------------------
--CHASSIS SETTINGS--
--------------------
vehicle.chassis.size = self.SpriteOffset * -2;
-----------------------
--Suspension SETTINGS--
-----------------------
vehicle.suspension.springs = {};
vehicle.suspension.objects = {};
vehicle.suspension.offsets = {main = {}, midPoint = {}};
vehicle.suspension.length = {};
vehicle.suspension.longest = {max = 0};
for i = 1, vehicle.wheel.count do
if (vehicle.suspension.defaultLength ~= VehicleFramework.AUTO_GENERATE) then
vehicle.suspension.length[i] = {min = vehicle.suspension.defaultLength.min, normal = vehicle.suspension.defaultLength.normal, max = vehicle.suspension.defaultLength.max};
else
vehicle.suspension.length[i] = VehicleFramework.AUTO_GENERATE;
end
if (vehicle.suspension.lengthOverride ~= nil and vehicle.suspension.lengthOverride[i] ~= nil) then
vehicle.suspension.length[i] = {min = vehicle.suspension.lengthOverride[i].min, normal = vehicle.suspension.lengthOverride[i].normal, max = vehicle.suspension.lengthOverride[i].max};
end
if (vehicle.suspension.length[i] ~= VehicleFramework.AUTO_GENERATE) then
vehicle.suspension.length[i].difference = vehicle.suspension.length[i].max - vehicle.suspension.length[i].min;
vehicle.suspension.length[i].mid = vehicle.suspension.length[i].min + vehicle.suspension.length[i].difference * 0.5;
vehicle.suspension.length[i].normal = vehicle.suspension.length[i].normal or vehicle.suspension.length[i].mid;
end
end
vehicle.suspension.defaultLength = nil; vehicle.suspension.lengthOverride = nil; --Clean these up so we don't use them accidentally in future
if (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.DRAWN) then
vehicle.suspension.visualsConfig.widths = {};
for i = 1, vehicle.wheel.count do
vehicle.suspension.visualsConfig.widths[i] = vehicle.suspension.visualsConfig.width;
end
vehicle.suspension.visualsConfig.width = nil; --Clean this up so we don't use it accidentally in future
end
------------------
--WHEEL SETTINGS--
------------------
vehicle.wheel.objects = {};
vehicle.wheel.size = {};
vehicle.wheel.evenWheelCount = vehicle.wheel.count % 2 == 0;
vehicle.wheel.midWheel = vehicle.wheel.evenWheelCount and vehicle.wheel.count * 0.5 or math.ceil(vehicle.wheel.count * 0.5);
vehicle.wheel.isInAir = {};
vehicle.wheel.terrainBelowWheels = {};
vehicle.wheel.checkTerrainBelowWheelsTimer = vehicle.wheel.checkTerrainBelowWheels ~= false and Timer() or nil;
-----------------------
--TENSIONER SETTINGS--
-----------------------
if (vehicle.tensioner ~= nil) then
vehicle.tensioner.objects = {};
vehicle.tensioner.unrotatedOffsets = {};
vehicle.tensioner.spacing = vehicle.tensioner.spacing or vehicle.wheel.spacing;
vehicle.tensioner.size = {};
vehicle.tensioner.evenTensionerCount = vehicle.tensioner.count % 2 == 0;
vehicle.tensioner.midTensioner = vehicle.tensioner.evenTensionerCount and vehicle.tensioner.count * 0.5 or math.ceil(vehicle.tensioner.count * 0.5);
end
------------------
--TRACK SETTINGS--
------------------
if (vehicle.track ~= nil) then
vehicle.track.count = 0;
vehicle.track.unrotatedOffsets = {};
vehicle.track.trackStarts = {};
vehicle.track.trackEnds = {};
vehicle.track.extraFillers = {};
vehicle.track.skippedEnds = {};
vehicle.track.directions = {};
vehicle.track.objects = {};
end
------------------------
--DESTRUCTION SETTINGS--
------------------------
vehicle.destruction.overturnedTimer = Timer();
vehicle.destruction.overturnedInterval = 1000;
vehicle.destruction.overturnedCounter = 0;
------------------
--EVENT SETTINGS--
------------------
------------------
--AUDIO SETTINGS--
------------------
for _, audioConfig in ipairs(vehicle.audio) do
audioConfig.sounds = {};
for __, player in ipairs(vehicle.general.humanPlayers) do
audioConfig.sounds[player] = {};
end
end
------------------
--LAYER SETTINGS--
------------------
vehicle.layer.current = 1;
vehicle.layer.allObjectsAddedForCurrentLayer = true;
vehicle.layer.allLayersAdded = false;
vehicle.layer.addLayerTimer = Timer();
-----------------------------
--OBJECT CREATION AND SETUP--
-----------------------------
VehicleFramework.setCreationFunctionsForObjects(vehicle);
if (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.SPRITE) then
VehicleFramework.createSuspensionSprites(vehicle);
end
VehicleFramework.createWheels(vehicle);
--Handle AUTO_GENERATE for vehicle.suspension.visualsConfig.widths
if (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.DRAWN) then
for i = 1, vehicle.wheel.count do
vehicle.suspension.visualsConfig.widths[i] = vehicle.suspension.visualsConfig.widths[i] == VehicleFramework.AUTO_GENERATE and vehicle.wheel.size[i]/3 or vehicle.suspension.visualsConfig.widths[i];
end
end
VehicleFramework.createSprings(vehicle);
VehicleFramework.createTensioners(vehicle);
VehicleFramework.createTrack(vehicle);
VehicleFramework.Audio.createSoundTablesAndTimersAndEvents(vehicle);
VehicleFramework.vehicles[self.UniqueID] = vehicle;
return vehicle;
end
function VehicleFramework.setCustomisationDefaultsAndLimits(vehicle)
--General
vehicle.general.maxSpeed = vehicle.general.maxSpeed or vehicle.general.maxThrottle;
assert(vehicle.general.maxSpeed, "Only one of vehicle.general.maxSpeed and vehicle.general.maxThrottle can be nil. Please check the Vehicle Configuration Documentation.");
vehicle.general.maxSpeed = Clamp(vehicle.general.maxSpeed, 0, 1000000000);
vehicle.general.maxThrottle = vehicle.general.maxThrottle or vehicle.general.maxSpeed;
vehicle.general.maxThrottle = Clamp(vehicle.general.maxThrottle, 0, 1000000000);
vehicle.general.acceleration = vehicle.general.acceleration or vehicle.general.maxThrottle/40;
vehicle.general.acceleration = Clamp(vehicle.general.acceleration, 0, vehicle.general.maxThrottle);
vehicle.general.deceleration = vehicle.general.deceleration or vehicle.general.acceleration/20;
vehicle.general.deceleration = Clamp(vehicle.general.deceleration, 0, vehicle.general.maxThrottle);
vehicle.general.maxErasableTerrainStrength = vehicle.general.maxErasableTerrainStrength or 100;
vehicle.general.maxErasableTerrainStrength = Clamp(vehicle.general.maxErasableTerrainStrength, 0, 1000000000);
if (vehicle.general.forceWheelHorizontalLocking == nil) then
vehicle.general.forceWheelHorizontalLocking = (vehicle.track ~= nil or vehicle.tensioner ~= nil) and true or false;
end
vehicle.general.allowSlidingWhileStopped = vehicle.general.allowSlidingWhileStopped or false;
vehicle.general.checkTerrainBelowWheels = vehicle.general.checkTerrainBelowWheels == nil and 50 or vehicle.general.checkTerrainBelowWheels;
vehicle.general.showDebug = vehicle.general.showDebug == nil and false or vehicle.general.showDebug;
--Chassis
vehicle.chassis.rotAngleCorrectionRate = vehicle.chassis.rotAngleCorrectionRate or 0.04;
vehicle.chassis.rotAngleCorrectionRate = Clamp(vehicle.chassis.rotAngleCorrectionRate, 0, 2*math.pi);
vehicle.chassis.rotAngleCorrectionRateInAir = vehicle.chassis.rotAngleCorrectionRateInAir or vehicle.chassis.rotAngleCorrectionRate;
vehicle.chassis.rotAngleCorrectionRateInAir = Clamp(vehicle.chassis.rotAngleCorrectionRateInAir, 0, 2*math.pi);
vehicle.chassis.rotationAffectingWheels = vehicle.chassis.rotationAffectingWheels or {};
if (vehicle.chassis.rotationAffectingWheels[1] == nil) then
table.insert(vehicle.chassis.rotationAffectingWheels, 1);
end
--TODO properly support single wheel vehicles, this is commented out to avoid errors elsewhere
if (vehicle.chassis.rotationAffectingWheels[2] == nil) then-- and vehicle.wheel.count > 1) then
table.insert(vehicle.chassis.rotationAffectingWheels, vehicle.wheel.count);
end
assert(vehicle.wheel.count == 1 and #vehicle.chassis.rotationAffectingWheels == 1 or #vehicle.chassis.rotationAffectingWheels == 2, (vehicle.wheel.count == 1 and "You can only have 1 entry in vehicle.chassis.rotationAffectingWheels" or "You can only have 2 entries in vehicle.chassis.rotationAffectingWheels")..". Please check the Vehicle Configuration Documentation.");
assert(type(vehicle.chassis.rotationAffectingWheels[1]) == "number", "vehicle.chassis.rotationAffectingWheels entries must be numbers. Please check the Vehicle Configuration Documentation.");
assert(type(vehicle.chassis.rotationAffectingWheels[2]) == "nil" or type(vehicle.chassis.rotationAffectingWheels[2]) == "number", "vehicle.chassis.rotationAffectingWheels must be numbers. Please check the Vehicle Configuration Documentation.");
--Suspension
vehicle.suspension.defaultLength = vehicle.suspension.defaultLength or VehicleFramework.AUTO_GENERATE;
--vehicle.suspension.lengthOverride is handled separately elsewhere
vehicle.suspension.stiffness = Clamp(vehicle.suspension.stiffness, 0, 1000000000);
vehicle.suspension.chassisStiffnessModifier = vehicle.suspension.chassisStiffnessModifier or VehicleFramework.AUTO_GENERATE;
if (type(vehicle.suspension.chassisStiffnessModifier) == number) then
vehicle.suspension.chassisStiffnessModifier = Clamp(vehicle.suspension.chassisStiffnessModifier, 1, 1000000000);
end
vehicle.suspension.wheelStiffnessModifier = vehicle.suspension.wheelStiffnessModifier or VehicleFramework.AUTO_GENERATE;
if (type(vehicle.suspension.wheelStiffnessModifier) == number) then
vehicle.suspension.wheelStiffnessModifier = Clamp(vehicle.suspension.wheelStiffnessModifier, 1, 1000000000);
end
vehicle.suspension.visualsType = vehicle.suspension.visualsType or (vehicle.track ~= nil or vehicle.tensioner ~= nil) and VehicleFramework.SuspensionVisualsType.NONE or VehicleFramework.SuspensionVisualsType.DRAWN;
vehicle.suspension.visualsConfig = vehicle.suspension.visualsConfig or {};
if (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.NONE) then
vehicle.suspension.visualsConfig = nil;
elseif (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.SPRITE) then
vehicle.suspension.visualsConfig.objectRTE = vehicle.suspension.visualsConfig.objectRTE or vehicle.general.RTE;
if (vehicle.suspension.visualsConfig.objectName == nil) then
local objectPreset = VehicleFramework.Util.searchForAppropriatePreset(vehicle.suspension.visualsConfig.objectRTE, {include = "suspension", optionalInclude = vehicle.self.PresetName})
assert(objectPreset ~= nil, "Unable to find any presets in "..tostring(vehicle.suspension.visualsConfig.objectRTE).." that matched the Sprite based suspension naming criteria. Your suspension's PresetNames should include the word 'suspension' and, optionally, the preset name of the vehicle to narrow it down. Please check the Vehicle Configuration Documentation.");
vehicle.suspension.visualsConfig.objectName = objectPreset.PresetName;
if (vehicle.general.showDebug) then
print("Setting vehicle.suspension.visualsConfig.objectName to "..tostring(vehicle.suspension.visualsConfig.objectName));
end
end
vehicle.suspension.visualsConfig.objectName = vehicle.suspension.visualsConfig.objectName or vehicle.self.PresetName.." Suspension";
elseif (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.DRAWN) then
vehicle.suspension.visualsConfig.width = vehicle.suspension.visualsConfig.width or VehicleFramework.AUTO_GENERATE;
if (type(vehicle.suspension.visualsConfig.width) == number) then
vehicle.suspension.visualsConfig.width = Clamp(vehicle.suspension.visualsConfig.width, 1, 1000000000);
end
vehicle.suspension.visualsConfig.colourIndex = vehicle.suspension.visualsConfig.colourIndex or 247;
vehicle.suspension.visualsConfig.colourIndex = Clamp(vehicle.suspension.visualsConfig.colourIndex, 0, 255);
end
--Wheel
assert(vehicle.wheel.count ~= nil, "You must specify the number of wheels for your Vehicle. Please check the Vehicle Configuration Documentation.")
vehicle.wheel.spacing = vehicle.wheel.spacing or VehicleFramework.AUTO_GENERATE;
if (type(vehicle.wheel.spacing) == "number") then
vehicle.wheel.spacing = Clamp(vehicle.wheel.spacing, 0, 1000000000);
end
vehicle.wheel.objectRTE = vehicle.wheel.objectRTE or vehicle.general.RTE;
if (vehicle.wheel.objectName == nil) then
local objectPreset = VehicleFramework.Util.searchForAppropriatePreset(vehicle.wheel.objectRTE, {include = "wheel", optionalInclude = vehicle.self.PresetName, exclude = "tensioner"})
assert(objectPreset ~= nil, "Unable to find any presets in "..tostring(vehicle.wheel.objectRTE).." that matched the wheel naming criteria. Your wheel's PresetNames should include the word 'wheel' and, optionally, the preset name of the vehicle to narrow it down. Please check the Vehicle Configuration Documentation.");
vehicle.wheel.objectName = objectPreset.PresetName;
if (vehicle.general.showDebug) then
print("Setting vehicle.wheel.objectName to "..tostring(vehicle.wheel.objectName));
end
end
--Tensioner
if (vehicle.tensioner ~= nil) then
vehicle.tensioner.count = vehicle.tensioner.count or vehicle.wheel.count + 1;
vehicle.tensioner.count = Clamp(vehicle.tensioner.count, 0, 1000000000);
assert(vehicle.tensioner.offsetLength, "You must specify an offsetLength for your tensioners. Please check the Vehicle Configuration Documentation.");
if (type(vehicle.tensioner.offsetLength) == "number") then
local offsetLength = vehicle.tensioner.offsetLength;
vehicle.tensioner.offsetLength = {};
for i = 1, vehicle.tensioner.count do
vehicle.tensioner.offsetLength[i] = offsetLength;
end
elseif (type(vehicle.tensioner.offsetLength) == "table") then
if (vehicle.tensioner.offsetLength.inside ~= nil and vehicle.tensioner.offsetLength.outside ~= nil) then
for i = 1, vehicle.tensioner.count do
if (i == 1 or i == vehicle.tensioner.count) then
vehicle.tensioner.offsetLength[i] = vehicle.tensioner.offsetLength.outside;
else
vehicle.tensioner.offsetLength[i] = vehicle.tensioner.offsetLength.inside;
end
end
vehicle.tensioner.offsetLength.inside = nil;
vehicle.tensioner.offsetLength.outside = nil;
elseif (vehicle.tensioner.offsetLength[1] ~= nil) then
for i = 1, vehicle.tensioner.count do
assert(type(vehicle.tensioner.offsetLength[i]) == "number", "You have specified displacements for individual tensioners but are missing a number for tensioner "..tostring(i)..". Please check the Vehicle Configuration Documentation.");
end
else
error("You have used a table for your tensioner displacements, but have not populated it properly. Please check the Vehicle Configuration Documentation.");
end
end
vehicle.tensioner.spacing = vehicle.tensioner.spacing or vehicle.wheel.spacing;
if (type(vehicle.tensioner.spacing) == "number") then
vehicle.tensioner.spacing = Clamp(vehicle.tensioner.spacing, 0, 1000000000);
end
vehicle.tensioner.objectRTE = vehicle.tensioner.objectRTE or vehicle.general.RTE;
if (vehicle.tensioner.objectName == nil) then
local objectPreset = VehicleFramework.Util.searchForAppropriatePreset(vehicle.tensioner.objectRTE, {include = "tensioner", optionalInclude = {vehicle.self.PresetName, "wheel"}})
assert(objectPreset ~= nil, "Unable to find any presets in "..tostring(vehicle.tensioner.objectRTE).." that matched the tensioner naming criteria. Your tensioner's PresetNames should include the word 'tensioner' and, optionally, the preset name of the vehicle to narrow it down. Please check the Vehicle Configuration Documentation.");
vehicle.tensioner.objectName = objectPreset.PresetName;
if (vehicle.general.showDebug) then
print("Setting vehicle.tensioner.objectName to "..tostring(vehicle.tensioner.objectName));
end
end
end
--Track
if (vehicle.track ~= nil) then
--vehicle.track.size is handled elsewhere
vehicle.track.tightness = vehicle.track.tightness or 1.5;
vehicle.track.tightness = Clamp(vehicle.track.tightness, 0.000001, 1000000000);
vehicle.track.maxRotationDeviation = vehicle.track.maxRotationDeviation or (15 * math.pi)/180;
vehicle.track.maxRotationDeviation = Clamp(vehicle.track.maxRotationDeviation, 0, math.pi * 2);
vehicle.track.maxWounds = vehicle.track.maxWounds or 50;
vehicle.track.maxWounds = Clamp(vehicle.track.maxWounds, 0, 1000000000);
vehicle.track.tensionerAnchorType = vehicle.track.tensionerAnchorType or VehicleFramework.TrackAnchorType.ALL;
vehicle.track.wheelAnchorType = vehicle.track.wheelAnchorType or VehicleFramework.TrackAnchorType.ALL;
vehicle.track.objectRTE = vehicle.track.objectRTE or vehicle.general.RTE;
if (vehicle.track.objectName == nil) then
local objectPreset = VehicleFramework.Util.searchForAppropriatePreset(vehicle.track.objectRTE, {include = {"track", "tread"}, optionalInclude = vehicle.self.PresetName})
assert(objectPreset ~= nil, "Unable to find any presets in "..tostring(vehicle.track.objectRTE).." that matched the track naming criteria. Your track's PresetNames should include the word 'track' or 'tread' and, optionally, the preset name of the vehicle to narrow it down. Please check the Vehicle Configuration Documentation.");
vehicle.track.objectName = objectPreset.PresetName;
if (vehicle.general.showDebug) then
print("Setting vehicle.track.objectName to "..tostring(vehicle.track.objectName));
end
end
vehicle.track.inflectionStartOffsetDirection = vehicle.track.inflectionStartOffsetDirection or Vector(0, -1);
end
--Destruction
vehicle.destruction.overturnedLimit = vehicle.destruction.overturnedLimit or 10;
vehicle.destruction.overturnedLimit = Clamp(vehicle.destruction.overturnedLimit, 1, 1000000000);
--Layer
--If there's a custom layer config, ensure it has required layers
if (next(vehicle.layer) ~= nil) then
local necessaryLayers = {};
if (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.SPRITE) then
necessaryLayers.suspension = false;
end
necessaryLayers.wheel = false;
if (vehicle.tensioner ~= nil) then
necessaryLayers.tensioner = false;
end
if (vehicle.track ~= nil) then
necessaryLayers.track = false;
end
for necessaryLayer, value in pairs(necessaryLayers) do
for _, layer in ipairs(vehicle.layer) do
if (layer == necessaryLayer) then
value = true;
break;
end
end
assert(value == true, "Your layer config is missing the necessary layer entry for "..necessaryLayer..". Please check the Vehicle Configuration Documentation.");
end
else
if (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.SPRITE) then
table.insert(vehicle.layer, "suspension");
end
table.insert(vehicle.layer, "wheel");
if (vehicle.tensioner ~= nil) then
table.insert(vehicle.layer, "tensioner");
end
if (vehicle.track ~= nil) then
table.insert(vehicle.layer, "track");
end
end
vehicle.layer.addLayerInterval = vehicle.layer.addLayerInterval or 10;
vehicle.layer.addLayerInterval = Clamp(vehicle.layer.addLayerInterval, 1, 1000000000);
vehicle.layer.numberOfObjectsToAddPerInterval = vehicle.layer.numberOfObjectsToAddPerInterval or 0;
vehicle.layer.numberOfObjectsToAddPerInterval = Clamp(vehicle.layer.numberOfObjectsToAddPerInterval, 0, 1000000000);
--Events
for eventTypeKey, eventType in pairs(VehicleFramework.EventType) do
vehicle.events[eventType] = vehicle.events[eventType] or {};
end
for eventType, eventTable in ipairs(vehicle.events) do
assert(type(eventTable) == "table", "Custom event config for eventType "..tostring(eventType).." is a "..type(eventTable).." when it should be a table. Please check the Vehicle Configuration Documentation.");
for eventHandlerIndex, eventHandler in ipairs(eventTable) do
assert(type(eventFunction) == "function", "Custom event handler "..tostring(eventHandlerIndex).." for eventType "..tostring(eventType).." is a "..type(eventHandler).." when it should be a function. Please check the Vehicle Configuration Documentation.");
end
end
--Audio
VehicleFramework.Audio.doAutoGeneration(vehicle);
VehicleFramework.Audio.setCustomisationDefaultsAndLimitsAndCheckValidity(vehicle);
return vehicle;
end
function VehicleFramework.ensureVehicleConfigIsValid(vehicle)
local ignoredKeys = {
general = {RTE = true, humanPlayers = true, playerScreens = true},
layer = {_any = {"number"}},
audio = {allAudioTables = true, allAudioStageTables = true}
};
local supportedTypes = {
general = {
maxSpeed = "number",
maxThrottle = "number",
acceleration = "number",
deceleration = "number",
maxErasableTerrainStrength = "number",
forceWheelHorizontalLocking = "boolean",
allowSlidingWhileStopped = "boolean",
checkTerrainBelowWheels = {"boolean", "number"},
showDebug = "boolean"
},
chassis = {
rotAngleCorrectionRate = "number",
rotAngleCorrectionRateInAir = "number",
rotationAffectingWheels = "table"
},
suspension = {
defaultLength = {"table", "string"},
lengthOverride = {"table", "nil"},
stiffness = "number",
chassisStiffnessModifier = {"number", "string"},
wheelStiffnessModifier = {"number", "string"},
visualsType = "number",
visualsConfig = {"table", "nil"}
},
wheel = {
spacing = {"number", "string"},
count = "number",
objectName = "string",
objectRTE = "string"
},
tensioner = {
offsetLength = {"number", "table"},
spacing = {"number", "string"},
count = "number",
objectName = "string",
objectRTE = "string"
},
track = {
maxWounds = "number",
objectName = "string",
objectRTE = "string",
tightness = "number",
maxRotationDeviation = "number",
tensionerAnchorType = "number",
wheelAnchorType = "number",
inflectionStartOffsetDirection = {"userdata", "nil"},
inflection = {"table", "nil"}
},
destruction = {
overturnedLimit = "number"
},
layer = {
addLayerInterval = "number",
numberOfObjectsToAddPerInterval = "number"
},
events = {
_anyNumber = "table"
},
audio = {
_anyNumber = "table"
}
}
--Ensure everything is a real configuration option and has the correct type
for categoryKey, categoryTable in pairs(vehicle) do
if (categoryKey ~= "self") then
for optionKey, optionValue in pairs(categoryTable) do
if (ignoredKeys[categoryKey] == nil or (ignoredKeys[categoryKey][optionKey] ~= true and ignoredKeys[categoryKey]._all ~= true)) then
assert(supportedTypes[categoryKey], "vehicle."..tostring(categoryKey).." is an invalid configuration option category. Please check the Vehicle Configuration Documentation.");
--Handle special _any ignore values to ignore any keys of a given type
local continueChecks = true;
if (ignoredKeys[categoryKey] ~= nil and ignoredKeys[categoryKey]._any ~= nil) then
for _, ignoredKeyType in ipairs(ignoredKeys[categoryKey]._any) do
if (type(optionKey) == ignoredKeyType) then
continueChecks = false;
end
end
end
if (continueChecks) then
for supportedOptionKey, _ in pairs(supportedTypes[categoryKey]) do
if (supportedOptionKey:find("_any") ~= nil) then
local dataType = supportedOptionKey:sub(string.len("_any") + 1, supportedOptionKey:len()):lower();
if (type(optionKey) == dataType) then
optionKey = supportedOptionKey;
end
end
end
assert(supportedTypes[categoryKey][optionKey], "vehicle."..tostring(categoryKey).."."..tostring(optionKey).." is an invalid configuration option. Please check the Vehicle Configuration Documentation.");
if (type(supportedTypes[categoryKey][optionKey]) == "string") then
assert(type(optionValue) == supportedTypes[categoryKey][optionKey], "vehicle."..tostring(categoryKey).."."..tostring(optionKey).." must be a "..tostring(supportedTypes[categoryKey][optionKey]).." but is a "..tostring(type(optionValue))..". Please check the Vehicle Configuration Documentation.");
elseif (type(supportedTypes[categoryKey][optionKey]) == "table") then
local typeIsSupported = false;
for _, supportedType in pairs(supportedTypes[categoryKey][optionKey]) do
if (type(optionValue) == supportedType) then
typeIsSupported = true;
break;
end
end
assert(typeIsSupported, "vehicle."..tostring(categoryKey).."."..tostring(optionKey).." must be one of the following: "..tostring(table.concat(supportedTypes[categoryKey][optionKey], ", "))..". Please check the Vehicle Configuration Documentation.");
end
end
end
end
end
end
end
function VehicleFramework.setCreationFunctionsForObjects(vehicle)
local objectGroupsToSetupCreationFunctionsFor = {suspension = vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.SPRITE, wheel = true, tensioner = vehicle.tensioner ~= nil, track = vehicle.track ~= nil}
local presetModuleId, preset;
for objectGroup, objectWillBeCreated in pairs(objectGroupsToSetupCreationFunctionsFor) do
if (objectWillBeCreated) then
presetModuleId = PresetMan:GetModuleIDFromPath(vehicle[objectGroup].objectRTE);
assert(presetModuleId > -1, "Your vehicle "..tostring(objectGroup).." objects used a nonexistant RTE, "..tostring(vehicle[objectGroup].objectRTE)..". Please see the Vehicle Configuration Documentation");
for preset in PresetMan:GetDataModule(presetModuleId).Presets do
if (preset.PresetName == vehicle[objectGroup].objectName) then
vehicle[objectGroup].creationFunction = loadstring("return Create"..preset.ClassName.."(...)");
break;
end
end
assert(vehicle[objectGroup].creationFunction ~= nil, "Unable to find a preset named "..tostring(vehicle[objectGroup].objectName).." in RTE "..tostring(vehicle[objectGroup].objectRTE).." so could not set up a creation function for "..tostring(objectGroup).." objects. Please check the Vehicle Configuration Documentation.");
end
end
end
function VehicleFramework.createSuspensionSprites(vehicle)
for i = 1, vehicle.suspension.count do
if not MovableMan:ValidMO(vehicle.suspension.objects[i]) then
vehicle.suspension.objects[i] = vehicle.suspension.creationFunction(vehicle.suspension.objectName, vehicle.suspension.objectRTE);
vehicle.suspension.objects[i].Pos = vehicle.general.pos;
vehicle.suspension.objects[i].Team = vehicle.self.Team;
vehicle.suspension.objects[i].MissionCritical = true;
end
end
end
function VehicleFramework.createWheels(vehicle)
local calculateAutoGeneratedSuspensionLength = function(wheelSize)
local length = {min = wheelSize * 0.5, normal = wheelSize, max = wheelSize * 1.5};
length.difference = length.max - length.min;
length.mid = length.min + length.difference * 0.5;
length.normal = length.normal or length.mid;
return length;
end
local calculateWheelOffsetAndPosition = function(rotAngle, vehicle, wheelNumber)
local xOffset;
if (wheelNumber == vehicle.wheel.midWheel) then
xOffset = vehicle.wheel.evenWheelCount and -vehicle.wheel.spacing * 0.5 or 0;
else
xOffset = vehicle.wheel.spacing * (wheelNumber - vehicle.wheel.midWheel) + (vehicle.wheel.evenWheelCount and -vehicle.wheel.spacing * 0.5 or 0);
end
vehicle.wheel.unrotatedOffsets[wheelNumber] = Vector(xOffset, vehicle.suspension.length[wheelNumber].normal);
return vehicle.general.pos + Vector(vehicle.wheel.unrotatedOffsets[wheelNumber].X, vehicle.wheel.unrotatedOffsets[wheelNumber].Y):RadRotate(rotAngle);
end
vehicle.wheel.unrotatedOffsets = {};
for i = 1, vehicle.wheel.count do
if not MovableMan:ValidMO(vehicle.wheel.objects[i]) then
vehicle.wheel.objects[i] = vehicle.wheel.creationFunction(vehicle.wheel.objectName, vehicle.wheel.objectRTE);
vehicle.wheel.size[i] = vehicle.wheel.objects[i].Diameter/math.sqrt(2);
--Handle AUTO_GENERATE for vehicle.suspension.length
if (vehicle.suspension.length[i] == VehicleFramework.AUTO_GENERATE) then
vehicle.suspension.length[i] = calculateAutoGeneratedSuspensionLength(vehicle.wheel.size[i]);
end
--Handle AUTO_GENERATE for vehicle.wheel.spacing
if (i == 1 and vehicle.wheel.spacing == VehicleFramework.AUTO_GENERATE) then
vehicle.wheel.spacing = math.ceil(vehicle.wheel.size[i] * 1.15);
end
vehicle.wheel.objects[i].Team = vehicle.self.Team;
vehicle.wheel.objects[i].Pos = calculateWheelOffsetAndPosition(vehicle.self.RotAngle, vehicle, i);
vehicle.wheel.objects[i].Vel = Vector(0, 0);
vehicle.wheel.objects[i].IgnoresTeamHits = vehicle.general.forceWheelHorizontalLocking;
vehicle.wheel.objects[i].MissionCritical = true;
end
vehicle.suspension.longest = vehicle.suspension.length[i].max > vehicle.suspension.longest.max and vehicle.suspension.length[i] or vehicle.suspension.longest;
end
end
function VehicleFramework.createSprings(vehicle)
--Handle AUTO_GENERATE for vehicle.suspension.chassisStiffnessModifier
if (vehicle.suspension.chassisStiffnessModifier == VehicleFramework.AUTO_GENERATE) then
vehicle.suspension.chassisStiffnessModifier = vehicle.self.Mass/vehicle.wheel.count;
end
for i, wheelObject in ipairs(vehicle.wheel.objects) do
--Handle AUTO_GENERATE for vehicle.suspension.wheelStiffnessModifier
if (vehicle.suspension.wheelStiffnessModifier == VehicleFramework.AUTO_GENERATE) then
vehicle.suspension.wheelStiffnessModifier = wheelObject.Mass;
end
local springConfig = {
length = {vehicle.suspension.length[i].min, vehicle.suspension.length[i].normal, vehicle.suspension.length[i].max},
primaryTarget = 1,
stiffness = vehicle.suspension.stiffness,
stiffnessMultiplier = {vehicle.suspension.chassisStiffnessModifier, vehicle.suspension.wheelStiffnessModifier},
offsets = Vector(vehicle.wheel.objects[i].Pos.X - vehicle.general.pos.X, 0),
applyForcesAtOffset = true,
lockToSpringRotation = not vehicle.general.forceWheelHorizontalLocking,
inheritsRotAngle = 1,
rotAngleOffset = -math.pi*0.5,
outsideOfConfinesAction = {SpringFramework.OutsideOfConfinesOptions.DO_NOTHING, SpringFramework.OutsideOfConfinesOptions.MOVE_TO_REST_POSITION},
confinesToCheck = {min = false, absolute = true, max = true},
showDebug = vehicle.general.showDebug
}
vehicle.suspension.springs[i] = SpringFramework.create(vehicle.self, vehicle.wheel.objects[i], springConfig);
vehicle.previous.springDistanceFromRest[i] = Vector(vehicle.suspension.springs[i].unrotatedDistances[2].rest.X, vehicle.suspension.springs[i].unrotatedDistances[2].rest.Y);
end
end
function VehicleFramework.createTensioners(vehicle)
if (vehicle.tensioner ~= nil) then
local xOffset;
for i = 1, vehicle.tensioner.count do
if not MovableMan:ValidMO(vehicle.tensioner.objects[i]) then
vehicle.tensioner.objects[i] = vehicle.tensioner.creationFunction(vehicle.tensioner.objectName, vehicle.tensioner.objectRTE);
vehicle.tensioner.size[i] = vehicle.tensioner.objects[i].Diameter/math.sqrt(2);
--Handle AUTO_GENERATE for vehicle.tensioner.spacing
if (vehicle.tensioner.spacing == VehicleFramework.AUTO_GENERATE) then
vehicle.tensioner.spacing = vehicle.wheel.spacing;
end
if (i == vehicle.tensioner.midTensioner) then
xOffset = vehicle.tensioner.evenTensionerCount and -vehicle.tensioner.spacing * 0.5 or 0;
else
xOffset = vehicle.tensioner.spacing * (i - vehicle.tensioner.midTensioner) + (vehicle.tensioner.evenTensionerCount and -vehicle.tensioner.spacing * 0.5 or 0);
end
vehicle.tensioner.unrotatedOffsets[i] = Vector(xOffset, vehicle.tensioner.offsetLength[i]);
vehicle.tensioner.objects[i].Team = vehicle.self.Team;
vehicle.tensioner.objects[i].Vel = Vector(0, 0);
vehicle.tensioner.objects[i].IgnoresTeamHits = true;
vehicle.tensioner.objects[i].MissionCritical = true;
end
end
VehicleFramework.updateTensioners(vehicle);
end
end
function VehicleFramework.createTrack(vehicle)
if (vehicle.track ~= nil) then
local trackSizer = vehicle.track.creationFunction(vehicle.track.objectName, vehicle.track.objectRTE);
vehicle.track.size = trackSizer.SpriteOffset * -2;
trackSizer.ToDelete = true;
trackSizer = nil;
VehicleFramework.setupTrackInflection(vehicle);
VehicleFramework.calculateTrackOffsets(vehicle);
for i = 1, vehicle.track.count do
if not MovableMan:ValidMO(vehicle.track.objects[i]) then
vehicle.track.objects[i] = vehicle.track.creationFunction(vehicle.track.objectName, vehicle.track.objectRTE);
vehicle.track.objects[i].Team = vehicle.self.Team;
vehicle.track.objects[i].Vel = Vector();
vehicle.track.objects[i].Pos = vehicle.general.pos + Vector(vehicle.track.unrotatedOffsets[i].X, vehicle.track.unrotatedOffsets[i].Y):RadRotate(vehicle.self.RotAngle);
vehicle.track.objects[i].RotAngle = vehicle.self.RotAngle + vehicle.track.directions[i];
vehicle.track.objects[i].IgnoresTeamHits = true;
vehicle.track.objects[i].MissionCritical = true;
end
end
end
end
function VehicleFramework.setupTrackInflection(vehicle)
if (vehicle.track.inflection == nil) then
vehicle.track.inflection = {};
local inflectionConfig, iteratorIncrement;
if (vehicle.tensioner ~= nil) then
iteratorIncrement = vehicle.track.tensionerAnchorType == VehicleFramework.TrackAnchorType.FIRST_AND_LAST and (vehicle.tensioner.count - 1) or 1;
for i = 1, vehicle.tensioner.count, iteratorIncrement do
inflectionConfig = {
point = vehicle.tensioner.unrotatedOffsets[i],
objectTable = vehicle.tensioner,
objectIndex = i,
object = vehicle.tensioner.objects[i],
objectSize = vehicle.tensioner.size[i]
}
table.insert(vehicle.track.inflection, inflectionConfig);
end
end
iteratorIncrement = vehicle.track.wheelAnchorType == VehicleFramework.TrackAnchorType.FIRST_AND_LAST and (vehicle.wheel.count - 1) or 1;
for i = vehicle.wheel.count, 1, -iteratorIncrement do
inflectionConfig = {
point = vehicle.wheel.unrotatedOffsets[i],
objectTable = vehicle.wheel,
objectIndex = i,
object = vehicle.wheel.objects[i],
objectSize = vehicle.wheel.size[i]
}
table.insert(vehicle.track.inflection, inflectionConfig);
end
end
for i, inflection in ipairs(vehicle.track.inflection) do
inflection.next = vehicle.track.inflection[i%#vehicle.track.inflection + 1];
inflection.distanceToNext = SceneMan:ShortestDistance(inflection.point, inflection.next.point, SceneMan.SceneWrapsX);
inflection.directionToNext = inflection.distanceToNext.AbsRadAngle;
inflection.directionVectorToNext = Vector(math.cos(inflection.directionToNext), -math.sin(inflection.directionToNext)).Normalized;
end
local offsetDirection;
local trackTightnessMultiplier = 0.5/vehicle.track.tightness;
for i, inflection in ipairs(vehicle.track.inflection) do
local offsetDirection = Vector(vehicle.track.inflectionStartOffsetDirection.X, vehicle.track.inflectionStartOffsetDirection.Y):RadRotate(inflection.directionToNext);
inflection.trackStart = inflection.point + offsetDirection * (inflection.objectSize * trackTightnessMultiplier + vehicle.track.size.Y * trackTightnessMultiplier);
inflection.trackEnd = inflection.next.point + offsetDirection * (inflection.next.objectSize * trackTightnessMultiplier + vehicle.track.size.Y * trackTightnessMultiplier);
inflection.trackDistance = SceneMan:ShortestDistance(inflection.trackStart, inflection.trackEnd, SceneMan.SceneWrapsX);
inflection.trackDirection = inflection.trackDistance.AbsRadAngle;
inflection.trackDirectionVector = Vector(math.cos(inflection.trackDirection), -math.sin(inflection.trackDirection)).Normalized;
end
end
function VehicleFramework.calculateTrackOffsets(vehicle)
local numberOfTracks, remainderDistance, extraFillerTrack, extraCornerTrack, stretchTreadMultiplier;
for i, inflection in ipairs(vehicle.track.inflection) do
numberOfTracks = math.ceil(inflection.trackDistance.Magnitude/vehicle.track.size.X);
--Add an extra track to fill in space if necessary, i.e. the remainder distance is more than 1/10th of number of tracks (so 5 tracks would become 6 if the remainder distance is > 0.5 track width)
if (numberOfTracks == 1) then
numberOfTracks = 2;
remainderDistance = 0;
extraFillerTrack = false;
else
remainderDistance = (inflection.trackDistance.Magnitude%vehicle.track.size.X)/vehicle.track.size.X;
extraFillerTrack = remainderDistance > numberOfTracks * 0.06;
if (vehicle.general.showDebug) then
if (extraFillerTrack == true) then
print("Adding extra filler track for inflection "..tostring(i));
else
print("NOT Adding extra filler track for inflection "..tostring(i));
end
end
end
numberOfTracks = extraFillerTrack and numberOfTracks + 1 or numberOfTracks;
--Add an extra track if the angle difference between this inflection and the next is significant, to support corners
extraCornerTrack = false;
do
end
numberOfTracks = extraCornerTrack and numberOfTracks + 1 or numberOfTracks;
stretchTreadMultiplier = (extraFillerTrack == false and remainderDistance > 0) and remainderDistance/numberOfTracks - (extraCornerTrack and 3 or 2) or 1;
for j = 1, numberOfTracks do
if (j == 1) then
table.insert(vehicle.track.unrotatedOffsets, inflection.trackStart);-- + (i ~= 1 and Vector(vehicle.track.size.X * 0.5, 0):RadRotate(inflection.trackDirection) or Vector()));
table.insert(vehicle.track.trackStarts, #vehicle.track.unrotatedOffsets);
--If the last inflection skipped its end cause it would be duplicated by this start, set this start as the previous inflection's
if (vehicle.track.skippedEnds[i-1] == true) then
table.insert(vehicle.track.trackEnds, #vehicle.track.unrotatedOffsets);
end
elseif (j == numberOfTracks) then
if (vehicle.general.showDebug) then
--print("direction difference: "..tostring(math.abs(inflection.next.trackDirection - inflection.trackDirection))..", distance magnitude: "..tostring(SceneMan:ShortestDistance(inflection.trackEnd, inflection.next.trackStart, SceneMan.SceneWrapsX).Magnitude));
end
if (math.abs(inflection.next.trackDirection - inflection.trackDirection) > (30 * math.pi/180) and SceneMan:ShortestDistance(inflection.trackEnd, inflection.next.trackStart, SceneMan.SceneWrapsX).Magnitude > vehicle.track.size.Magnitude * 0.1) then
table.insert(vehicle.track.unrotatedOffsets, inflection.trackEnd);
table.insert(vehicle.track.trackEnds, #vehicle.track.unrotatedOffsets);
vehicle.track.skippedEnds[i] = false;
if (vehicle.general.showDebug) then
print("Adding end track for inflection "..tostring(i));
end
else
numberOfTracks = numberOfTracks - 1;
vehicle.track.skippedEnds[i] = true;
if (vehicle.general.showDebug) then
print("Not adding end track for inflection "..tostring(i));
end
break;
end
--elseif (j == numberOfTracks) then
-- table.insert(vehicle.track.unrotatedOffsets, (inflection.trackEnd + inflection.next.trackStart) * 0.5);
else
table.insert(vehicle.track.unrotatedOffsets, vehicle.track.unrotatedOffsets[#vehicle.track.unrotatedOffsets] + inflection.trackDirectionVector * vehicle.track.size.X * stretchTreadMultiplier);
if (extraFillerTrack and j == numberOfTracks - 1) then
table.insert(vehicle.track.extraFillers, #vehicle.track.unrotatedOffsets);
end
end
--table.insert(vehicle.track.directions, j == numberOfTracks and (inflection.trackDirection + inflection.next.trackDirection) * 0.5 or inflection.trackDirection);
table.insert(vehicle.track.directions, inflection.trackDirection);
end
--Move filler tracks to the middle of their neighbouring tracks
if (extraFillerTrack) then
local fillerNumber = vehicle.track.extraFillers[#vehicle.track.extraFillers];
vehicle.track.unrotatedOffsets[fillerNumber] = (vehicle.track.unrotatedOffsets[fillerNumber - 1] + (vehicle.track.unrotatedOffsets[fillerNumber + 1] or inflection.trackEnd)) * 0.5;
end
vehicle.track.count = vehicle.track.count + numberOfTracks;
end
end
function VehicleFramework.deleteVehicle(vehicle)
if (vehicle) then
if (vehicle.suspension.visualsType == VehicleFramework.SuspensionVisualsType.SPRITE) then
for _, suspensionObject in ipairs(vehicle.suspension.objects) do
if MovableMan:ValidMO(suspensionObject) then
suspensionObject.ToDelete = true;
end
end
end
for _, wheelObject in ipairs(vehicle.wheel.objects) do
if MovableMan:ValidMO(wheelObject) then
wheelObject.ToDelete = true;
end
end
if (vehicle.tensioner ~= nil) then
for _, tensionerObject in ipairs(vehicle.tensioner.objects) do
if MovableMan:ValidMO(tensionerObject) then
tensionerObject.ToDelete = true;
end
end
end
if (vehicle.track ~= nil) then
for _, trackObject in ipairs(vehicle.track.objects) do
if MovableMan:ValidMO(trackObject) then
trackObject.ToDelete = true;
end
end
end
end
end
function VehicleFramework.updateVehicle(vehicle)
if (vehicle == nil) then
print("******************************************************************************************************");
print("Your vehicle has been incorrectly configured and cannot run. Please check the Vehicle Configuration Documentation.");
print("******************************************************************************************************");
vehicle = false;
end
if (vehicle) then
if (not vehicle.layer.allLayersAdded) then
VehicleFramework.updateLayers(vehicle);
end
local destroyed = VehicleFramework.updateDestruction(vehicle);
if (not destroyed) then
VehicleFramework.updateAltitudeChecks(vehicle);
VehicleFramework.updateThrottle(vehicle);
VehicleFramework.updateWheels(vehicle);
VehicleFramework.updateSprings(vehicle);
VehicleFramework.updateTerrainBelowWheels(vehicle);
VehicleFramework.updateTensioners(vehicle);
VehicleFramework.updateTrack(vehicle);
VehicleFramework.updateChassis(vehicle);
VehicleFramework.Audio.earlyUpdate(vehicle);
VehicleFramework.updateEvents(vehicle);
VehicleFramework.Audio.update(vehicle);
VehicleFramework.updateVisuals(vehicle);
end
VehicleFramework.updatePreviousValues(vehicle);
end
return vehicle;
end
function VehicleFramework.updateLayers(vehicle)
if (vehicle.layer.addLayerTimer:IsPastSimMS(vehicle.layer.addLayerInterval)) then
vehicle.layer.allObjectsAddedForCurrentLayer = true;
local layer = vehicle.layer[vehicle.layer.current];
local addedObjectCount = 0;
if (type(layer) == "userdata") then
MovableMan:AddParticle(layer);
elseif(type(layer) == "table") then
for layerObjectIndex, layerObject in ipairs(layer) do
assert(type(layerObject) == "userdata", "Layer "..tostring(vehicle.layer.current).."'s entry with the index "..tostring(layerObjectKey).." is a "..tostring(type(layerObject)).." which is not valid. Please check the Vehicle Configuration Documentation.");
if (layerObject.ClassName == "AHuman" or layerObject.ClassName == "ACrab" or layerObject.ClassName == "ACRocket" or layerObject.ClassName == "ACDropship" or layerObject.ClassName == "ACraft" or layerObject.ClassName == "Actor") then
MovableMan:AddActor(layerObject);
else
MovableMan:AddParticle(layerObject);
end
if (vehicle.layer.numberOfObjectsToAddPerInterval > 0) then
addedObjectCount = addedObjectCount + 1;
if (addedObjectCount >= vehicle.layer.numberOfObjectsToAddPerInterval) then
vehicle.layer.allObjectsAddedForCurrentLayer = false;
break;