-
Notifications
You must be signed in to change notification settings - Fork 0
/
Osi.lua
4787 lines (3780 loc) · 140 KB
/
Osi.lua
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
-CombatIsActive--@meta
---@diagnostic disable
--#region Types
--Base Types
---@alias INTEGER64 integer
---@alias GUIDSTRING string
--Alias Types
--Custom Aliases (not generated with story_header.div)
---@alias EQUIPMENTSLOTNAME "Amulet"|"Boots"|"Breast"|"Cloak"|"Gloves"|"Helmet"|"Melee Main Weapon"|"Melee Offhand Weapon"|"Ranged Main Weapon"|"Ranged Offhand Weapon"|"Ring"|"Ring2"|"Underwear"|"VanityBody"|"VanityBoots"
---@alias CHARACTER GUIDSTRING
---@alias ITEM GUIDSTRING
---@alias TRIGGER GUIDSTRING
---@alias SPLINE GUIDSTRING
---@alias LEVELTEMPLATE GUIDSTRING
---@alias DIALOGRESOURCE GUIDSTRING
---@alias EFFECTRESOURCE GUIDSTRING
---@alias VOICEBARKRESOURCE GUIDSTRING
---@alias ANIMATION GUIDSTRING
---@alias TAG GUIDSTRING
---@alias FLAG GUIDSTRING
---@alias FACTION GUIDSTRING
---@alias TIMELINERESOURCE GUIDSTRING
---@alias ROOT GUIDSTRING
---@alias CHARACTERROOT ROOT
---@alias ITEMROOT ROOT
---@alias PLATFORM GUIDSTRING
---@alias DISTURBANCEPROPERTY GUIDSTRING
---@alias SHAPESHIFTRULE GUIDSTRING
---@alias DIFFICULTYCLASS GUIDSTRING
---@alias GOLDREWARD GUIDSTRING
---@alias TUTORIALEVENT GUIDSTRING
---@alias DLC GUIDSTRING
---@alias RULESETMODIFIER GUIDSTRING
---@alias UNIFIEDTUTORIAL GUIDSTRING
--Enum Types
---@alias DEATHTYPE
---| `0` # None
---| `1` # Acid
---| `2` # Chasm
---| `3` # DoT
---| `4` # Electrocution
---| `5` # Explode
---| `6` # Falling
---| `7` # Incinerate
---| `8` # KnockedDown
---| `9` # Lifetime
---| `10` # Necrotic
---| `11` # Physical
---| `12` # Psychic
---| `13` # Radiant
---| `14` # CinematicDeath
---| `15` # Cold
---| `16` # Disintegrate
---@alias GRAVITYTYPE
---| `0` # Enabled
---| `1` # Disabled
---| `2` # DisabledUntilMove
---@alias LQUANT
---| `0` # ANY
---| `1` # ALL
---@alias TAGCATEGORY
---| `0` # Undefined
---| `1` # Code
---| `2` # Dialog
---| `3` # Origin
---| `4` # Identity
---| `5` # Profession
---| `6` # Race
---| `7` # Race_Meta
---| `8` # Story
---| `9` # Voice
---| `10` # Background
---| `11` # Class
---| `12` # DialogHidden
---| `13` # Deity
---| `14` # Class_Deity
---| `15` # PlayerRace
---| `16` # CharacterSheet
---| `17` # SpellCondition
---@alias ARMOURSET
---| `0` # Normal
---| `1` # Vanity
---@alias CROWDBEHAVIOUR
---| `0` # Cower
---| `1` # Disperse
---| `2` # Flee
---@alias SPLATTERTYPE
---| `1` # Blood
---| `2` # Bruise
---| `4` # Dirt
---| `8` # Sweat
---@alias QUANTITY
---| `0` # NONE
---| `1` # BARELY
---| `2` # SOME
---| `3` # HALF
---| `4` # LOTS
---| `5` # MOST
---| `6` # ALL
---@alias TRADABLETYPE
---| `0` # Default
---| `1` # Tradable
---| `2` # NonTradable
---@alias EQUIPMENTSLOT
---| `0` # Helmet
---| `1` # Breast
---| `2` # Cloak
---| `3` # MeleeMainHand
---| `4` # MeleeOffHand
---| `5` # RangedMainHand
---| `6` # RangedOffHand
---| `7` # Ring
---| `8` # Underwear
---| `9` # Boots
---| `10` # Gloves
---| `11` # Amulet
---| `12` # Ring2
---| `13` # Wings
---| `14` # Horns
---| `15` # Overhead
---| `16` # MusicalInstrument
---| `17` # VanityBody
---| `18` # VanityBoots
---@alias UNSHEATHSTATE
---| `0` # Instrument
---| `1` # Melee
---| `2` # Ranged
---| `3` # Sheathed
---@alias CRITICALITYTYPE
---| `0` # None
---| `1` # Success
---| `2` # Fail
---@alias TRADEMODE
---| `0` # Barter
---| `3` # Trade
---| `2` # Donate
---| `1` # Default
---@alias JOINBLOCKTYPE
---| `0` # None
---| `1` # BlockNew
---| `2` # BlockAll
--#endregion
if Osi == nil then Osi = {} end
--#region Queries
---@param difficulty string
---@param level integer
---@return integer abilityValue
function Osi.AbilityGetDifficultyLevelMappedValue(difficulty, level) end
---@param object GUIDSTRING
---@return integer anubisEnabled
function Osi.AnubisGetIsEnabled(object) end
---@param target GUIDSTRING
---@param targetSkill string
---@return integer skillValue
function Osi.CalculatePassiveSkill(target, targetSkill) end
---@return integer longRestIsAllowed
function Osi.CanAllPartiesLongRest() end
---@param entity GUIDSTRING
---@return integer bool
function Osi.CanBePickpocketed(entity) end
---@param character CHARACTER
---@param spellID string
---@return CHARACTER target
function Osi.CanCastSpellOnEnemyInSameCombat(character, spellID) end
---@param entity GUIDSTRING
---@return integer bool
function Osi.CanFight(entity) end
---@param entity GUIDSTRING
---@return integer bool
function Osi.CanJoinCombat(entity) end
---@param character CHARACTER
---@param item ITEM
---@param validateGoldCost integer
---@return integer bool
function Osi.CanLearnSpell(character, item, validateGoldCost) end
---@param character CHARACTER
---@return integer bool
function Osi.CanMove(character) end
---@param source GUIDSTRING
---@param target GUIDSTRING
---@return integer bool
function Osi.CanSee(source, target) end
---@param source GUIDSTRING
---@param target GUIDSTRING
---@return integer bool
function Osi.CanSeeCached(source, target) end
---@param character CHARACTER
---@param spellID string
---@return integer bool
function Osi.CanShowSpellForCharacter(character, spellID) end
---@param item ITEM
---@return integer bool
function Osi.CanSitOn(item) end
---@param character CHARACTER
---@return integer bool
function Osi.CanSpotSneakers(character) end
---@param trader CHARACTER
---@return integer bool
function Osi.CanTrade(trader) end
---@param ratingOwner CHARACTER
---@param ratedCharacter CHARACTER
---@param type integer
---@param delta integer
---@return integer bool
function Osi.ChangeApprovalRating(ratingOwner, ratedCharacter, type, delta) end
---@param character CHARACTER
---@return integer bool
function Osi.CharacterCanIgnoreActiveCrimes(character) end
---@param character CHARACTER
---@return integer bool
function Osi.CharacterCanSpotCrimes(character) end
---@param character CHARACTER
---@return integer instanceID
function Osi.CharacterGetCrimeDialog(character) end
---@param character CHARACTER
---@return string region
function Osi.CharacterGetCrimeRegion(character) end
---@param character CHARACTER
---@return CHARACTER owner
function Osi.CharacterGetOwner(character) end
---@param character CHARACTER
---@param dlc DLC
---@return integer hasDLC
function Osi.CharacterHasDLC(character, dlc) end
---@param character CHARACTER
---@return integer bool
function Osi.CharacterIgnoreActiveCrimes(character) end
---@param character CHARACTER
---@param crime string
---@return integer bool
function Osi.CharacterIsCrimeEnabled(character, crime) end
---@param player CHARACTER
---@param crimeType string
---@param evidence GUIDSTRING
---@param victim CHARACTER
---@param crimeID integer
---@return integer success
function Osi.CharacterRegisterCrime(player, crimeType, evidence, victim, crimeID) end
---@param player CHARACTER
---@param crimeType string
---@param evidence GUIDSTRING
---@param victim CHARACTER
---@param x number
---@param y number
---@param z number
---@param crimeID integer
---@return integer success
function Osi.CharacterRegisterCrimeWithPosition(player, crimeType, evidence, victim, x, y, z, crimeID) end
---@param character CHARACTER
---@param tags string
---@param amount integer
---@return integer amountRemoved
function Osi.CharacterRemoveTaggedItems(character, tags, amount) end
---@param itemTemplate CHARACTERROOT
---@param trigger TRIGGER
---@return integer count
function Osi.CharacterTemplatesInTrigger(itemTemplate, trigger) end
---@param modifier RULESETMODIFIER
---@param value integer
---@return integer result
function Osi.CheckRulesetModifierBool(modifier, value) end
---@param modifier RULESETMODIFIER
---@param value number
---@return integer result
function Osi.CheckRulesetModifierFloat(modifier, value) end
---@param modifier RULESETMODIFIER
---@param value integer
---@return integer result
function Osi.CheckRulesetModifierInt(modifier, value) end
---@param modifier RULESETMODIFIER
---@param value string
---@return integer result
function Osi.CheckRulesetModifierString(modifier, value) end
---@param combatGuid GUIDSTRING
---@return GUIDSTRING currentEntity
function Osi.CombatGetActiveEntity(combatGuid) end
---@param object GUIDSTRING
---@return GUIDSTRING combatGuid
function Osi.CombatGetGuidFor(object) end
---@param combatGuid GUIDSTRING
---@param partyMemberIndex integer
---@return CHARACTER partyMember
function Osi.CombatGetInvolvedPartyMember(combatGuid, partyMemberIndex) end
---@param combatGuid GUIDSTRING
---@return integer numPartyMembers
function Osi.CombatGetInvolvedPartyMembersCount(combatGuid) end
---@param combatGuid GUIDSTRING
---@param playerIndex integer
---@return CHARACTER player
function Osi.CombatGetInvolvedPlayer(combatGuid, playerIndex) end
---@param combatGuid GUIDSTRING
---@return integer numPlayers
function Osi.CombatGetInvolvedPlayersCount(combatGuid) end
---@param combatGuid GUIDSTRING
---@return integer active
function Osi.CombatIsActive(combatGuid) end
---@param stringA string
---@param stringB string
---@return string result
function Osi.Concatenate(stringA, stringB) end
---@param string string
---@param guidString GUIDSTRING
---@return string result
function Osi.ConcatenateGUID(string, guidString) end
---@param string string
---@param number integer
---@return string result
function Osi.ConcatenateInteger(string, number) end
---@param stringA string
---@param stringB string
---@return string result
function Osi.ConcatenateNewLine(stringA, stringB) end
---@param string string
---@param number number
---@return string result
function Osi.ConcatenateReal(string, number) end
---@param templateId GUIDSTRING
---@param x number
---@param y number
---@param z number
---@param temporary integer
---@param playSpawn integer
---@param spawnFinishEvent string
---@return GUIDSTRING createdObject
function Osi.CreateAt(templateId, x, y, z, temporary, playSpawn, spawnFinishEvent) end
---@param templateId GUIDSTRING
---@param anchor GUIDSTRING
---@param temporary integer
---@param playSpawn integer
---@param spawnFinishEvent string
---@param matchOrientation integer
---@return GUIDSTRING createdObject
function Osi.CreateAtObject(templateId, anchor, temporary, playSpawn, spawnFinishEvent, matchOrientation) end
---@return GUIDSTRING combatGuid
function Osi.CreateNarrativeCombat() end
---@param templateId GUIDSTRING
---@param x number
---@param y number
---@param z number
---@param directionAngle integer
---@param temporary integer
---@param playSpawn integer
---@param spawnFinishEvent string
---@return GUIDSTRING createdObject
function Osi.CreateOutOfSightAtDirection(templateId, x, y, z, directionAngle, temporary, playSpawn, spawnFinishEvent) end
---@param templateId GUIDSTRING
---@param anchorObject GUIDSTRING
---@param directionFrom GUIDSTRING
---@param temporary integer
---@param playSpawn integer
---@param spawnFinishEvent string
---@return GUIDSTRING createdObject
function Osi.CreateOutOfSightAtDirectionFromObject(templateId, anchorObject, directionFrom, temporary, playSpawn, spawnFinishEvent) end
---@param crimeID integer
---@param criminal GUIDSTRING
---@return integer bool
function Osi.CrimeAddCriminal(crimeID, criminal) end
---@param crimeID integer
---@param evidence GUIDSTRING
---@return integer bool
function Osi.CrimeAddEvidence(crimeID, evidence) end
---@param crimeID integer
---@param evidence ITEM
---@param evidenceTemplate GUIDSTRING
---@param originalOwner CHARACTER
---@param amount integer
---@param totalGoldValue integer
---@return integer bool
function Osi.CrimeAddItemEvidence(crimeID, evidence, evidenceTemplate, originalOwner, amount, totalGoldValue) end
---@param crimeArea TRIGGER
---@return integer modifier
function Osi.CrimeAreaGetTensionModifier(crimeArea) end
---@param crimeID integer
---@param searcher CHARACTER
---@param criminal1 CHARACTER
---@param criminal2 CHARACTER
---@param criminal3 CHARACTER
---@param criminal4 CHARACTER
---@return integer someEvidenceFoundForCurrentCrime
---@return integer foundAllEvidenceForCurrentCrime
---@return integer guiltyFound
function Osi.CrimeFindEvidence(crimeID, searcher, criminal1, criminal2, criminal3, criminal4) end
---@param crimeID integer
---@param criminalIndex integer
---@return CHARACTER criminal
function Osi.CrimeGetCriminal(crimeID, criminalIndex) end
---@param crimeID integer
---@return CHARACTER criminal1
---@return CHARACTER criminal2
---@return CHARACTER criminal3
---@return CHARACTER criminal4
function Osi.CrimeGetCriminals(crimeID) end
---@param crimeID integer
---@return integer criminalsCount
function Osi.CrimeGetCriminalsCount(crimeID) end
---@param crimeID integer
---@return number range
function Osi.CrimeGetDetectionRange(crimeID) end
---@param crimeID integer
---@param index integer
---@return GUIDSTRING evidence
function Osi.CrimeGetEvidence(crimeID, index) end
---@param crimeID integer
---@return integer goldValue
function Osi.CrimeGetEvidenceValue(crimeID) end
---@param crimeID integer
---@param interrogator CHARACTER
---@return DIALOGRESOURCE interrogationDialog
function Osi.CrimeGetInterrogationDialog(crimeID, interrogator) end
---@param crimeID integer
---@return CHARACTER leadInvestigator
function Osi.CrimeGetLeadInvestigator(crimeID) end
---@return integer crimeID
function Osi.CrimeGetNewID() end
---@param crimeID integer
---@return integer numEvidence
function Osi.CrimeGetNumberOfEvidence(crimeID) end
---@param crimeID integer
---@return integer tension
function Osi.CrimeGetTension(crimeID) end
---@param crimeID integer
---@return string type
function Osi.CrimeGetType(crimeID) end
---@param crimeID integer
---@return CHARACTER crimeVictim
function Osi.CrimeGetVictim(crimeID) end
---@param crimeID integer
---@param evidence GUIDSTRING
---@return integer hasEvidence
function Osi.CrimeHasEvidence(crimeID, evidence) end
---@param crimeID integer
---@param disturbanceProperty DISTURBANCEPROPERTY
---@return integer hasProperty
function Osi.CrimeHasProperty(crimeID, disturbanceProperty) end
---@param crime integer
---@param criminal CHARACTER
---@return integer bool
function Osi.CrimeIgnoreCriminal(crime, criminal) end
---@param crimeID integer
---@param investigator CHARACTER
---@param suspect CHARACTER
---@return integer startInterrogation
---@return integer sucess
function Osi.CrimeInvestigatorConfrontSuspect(crimeID, investigator, suspect) end
---@param crimeID integer
---@param investigator CHARACTER
---@param ignoreCantTalk integer
---@return integer success
function Osi.CrimeInvestigatorEnterInterrogationState(crimeID, investigator, ignoreCantTalk) end
---@param crimeID integer
---@return integer bool
function Osi.CrimeIsContinuous(crimeID) end
---@param crimeID integer
---@return integer isSuspended
function Osi.CrimeIsSuspended(crimeID) end
---@param character CHARACTER
---@return integer bool
function Osi.CrimeIsTensionOverWarningTreshold(character) end
---@param crime integer
---@param criminal CHARACTER
---@return integer bool
function Osi.CrimeStopIgnoringCriminal(crime, criminal) end
---@param oldLead GUIDSTRING
---@param crimeID integer
---@param newLead GUIDSTRING
---@return integer bool
function Osi.CrimeTransferLeadershipTo(oldLead, crimeID, newLead) end
---@param crimeType string
---@return integer tension
function Osi.CrimeTypeGetTension(crimeType) end
---@param disturbanceType string
---@param disturbanceProperty DISTURBANCEPROPERTY
---@return integer hasProperty
function Osi.CrimeTypeHasProperty(disturbanceType, disturbanceProperty) end
---@param origin CHARACTER
---@param index integer
---@return TAG backgroundTag
function Osi.DataGetBackgroundTagAt(origin, index) end
---@param origin CHARACTER
---@return integer count
function Osi.DataGetBackgroundTagCount(origin) end
---@param origin CHARACTER
---@param index integer
---@return TAG godTag
function Osi.DataGetGodTagAt(origin, index) end
---@param origin CHARACTER
---@return integer count
function Osi.DataGetGodTagCount(origin) end
---@param type GOLDREWARD
---@param level integer
---@return integer value
function Osi.DataGetGoldValue(type, level) end
---@param origin CHARACTER
---@param index integer
---@return TAG reallyTag
function Osi.DataGetReallyTagAt(origin, index) end
---@param origin CHARACTER
---@return integer count
function Osi.DataGetReallyTagCount(origin) end
---@param dialog DIALOGRESOURCE
---@return integer allowDeadSpeakers
function Osi.DialogAllowDeadSpeakers(dialog) end
---@param instanceID integer
---@param actor GUIDSTRING
---@return integer speakerSlot
function Osi.DialogFindReservedSpeakerSlot(instanceID, actor) end
---@param instanceID integer
---@return string category
function Osi.DialogGetCategory(instanceID) end
---@param instanceID integer
---@param index integer
---@return GUIDSTRING npc
function Osi.DialogGetInvolvedNPC(instanceID, index) end
---@param instanceID integer
---@param index integer
---@return GUIDSTRING player
function Osi.DialogGetInvolvedPlayer(instanceID, index) end
---@param instanceID integer
---@return integer numberOfNPCs
function Osi.DialogGetNumberOfInvolvedNPCs(instanceID) end
---@param instanceID integer
---@return integer count
function Osi.DialogGetNumberOfInvolvedPlayers(instanceID) end
---@param dialog DIALOGRESOURCE
---@return integer isAllowingJoinCombat
function Osi.DialogIsAllowingJoinCombat(dialog) end
---@param dialog DIALOGRESOURCE
---@return integer isAutomated
function Osi.DialogIsAutomated(dialog) end
---@param instanceID integer
---@return integer isCrimeDialog
function Osi.DialogIsCrimeDialog(instanceID) end
---@param instanceID integer
---@param actor GUIDSTRING
---@return integer success
function Osi.DialogRemoveActorFromDialog(instanceID, actor) end
---@param dialog DIALOGRESOURCE
---@param speakerSlot integer
---@return integer hasLines
function Osi.DialogSpeakerHasLines(dialog, speakerSlot) end
---@param crimeID integer
---@param dialog DIALOGRESOURCE
---@param npc GUIDSTRING
---@param criminal1 GUIDSTRING
---@param criminal2 GUIDSTRING
---@param criminal3 GUIDSTRING
---@param criminal4 GUIDSTRING
---@return integer success
---@return integer dialogInstance
function Osi.DialogStartCrimeDialog(crimeID, dialog, npc, criminal1, criminal2, criminal3, criminal4) end
---@param ownerObject GUIDSTRING
---@param followObject GUIDSTRING
---@param surfaceType string
---@param radius number
---@param lifeTime number
---@return INTEGER64 surfaceActionHandle
function Osi.DrawSurfaceOnPath(ownerObject, followObject, surfaceType, radius, lifeTime) end
---@param object GUIDSTRING
---@return integer bool
function Osi.Exists(object) end
---@param faction FACTION
---@param parentNumber integer
---@return FACTION parentFaction
function Osi.FactionGetParentFaction(faction, parentNumber) end
---@param faction FACTION
---@param howMany LQUANT
---@param tag TAG
---@return integer bool
function Osi.FactionIsTagged(faction, howMany, tag) end
---@param trigger TRIGGER
---@return DIALOGRESOURCE dialog
---@return string type
function Osi.FindGossipCamp(trigger) end
---@param character CHARACTER
---@return DIALOGRESOURCE dialog
---@return string type
function Osi.FindGossipWorld(character) end
---@param sourceX number
---@param sourceY number
---@param sourceZ number
---@param radius number
---@param object GUIDSTRING
---@param avoidDangerousSurfaces integer
---@return number validPositionX
---@return number validPositionY
---@return number validPositionZ
function Osi.FindValidPosition(sourceX, sourceY, sourceZ, radius, object, avoidDangerousSurfaces) end
---@param guidString GUIDSTRING
---@return string result
function Osi.GUIDToString(guidString) end
---@param character CHARACTER
---@param attribute string
---@return integer value
function Osi.GetAbility(character, attribute) end
---@param player CHARACTER
---@param resourceName string
---@param resourceLevel integer
---@return number amount
function Osi.GetActionResourceValuePersonal(player, resourceName, resourceLevel) end
---@param target GUIDSTRING
---@return string archetype
function Osi.GetActiveArchetype(target) end
---@return string levelName
function Osi.GetActiveModStartupLevel() end
---@param target GUIDSTRING
---@return TAG aiHint
function Osi.GetAiHint(target) end
---@param dirFromX number
---@param dirFromZ number
---@param dirToX number
---@param dirToZ number
---@return integer angleDeg
function Osi.GetAngleXToDirection(dirFromX, dirFromZ, dirToX, dirToZ) end
---@param object GUIDSTRING
---@return string anubisConfig
function Osi.GetAnubisConfig(object) end
---@param entity GUIDSTRING
---@param splatterType SPLATTERTYPE
---@return QUANTITY splatterLevel
function Osi.GetAppliedSplatterLevel(entity, splatterType) end
---@param ratingOwner CHARACTER
---@param ratedCharacter CHARACTER
---@return integer rating
function Osi.GetApprovalRating(ratingOwner, ratedCharacter) end
---@param character CHARACTER
---@return ARMOURSET eArmorSet
function Osi.GetArmourSet(character) end
---@param character CHARACTER
---@param player CHARACTER
---@return integer attitude
function Osi.GetAttitudeTowardsPlayer(character, player) end
---@param target GUIDSTRING
---@return string archetype
function Osi.GetBaseArchetype(target) end
---@param target GUIDSTRING
---@return FACTION faction
function Osi.GetBaseFaction(target) end
---@param item ITEM
---@return string damageType
function Osi.GetBaseWeaponDamageType(item) end
---@param character CHARACTER
---@param allowShapeshiftOverride integer
---@return string bodyType
function Osi.GetBodyType(character, allowShapeshiftOverride) end
---@param item ITEM
---@return string bookID
function Osi.GetBookID(item) end
---@param tags string
---@param inventoryHolder GUIDSTRING
---@return GUIDSTRING entity
function Osi.GetByTagInInventory(tags, inventoryHolder) end
---@param item ITEM
---@return integer bool
function Osi.GetCanInteract(item) end
---@param item ITEM
---@return integer bool
function Osi.GetCanPickUp(item) end
---@param target GUIDSTRING
---@return CHARACTER player
---@return number distance
function Osi.GetClosestAlivePlayer(target) end
---@param target GUIDSTRING
---@param userID integer
---@return CHARACTER player
---@return number distance
function Osi.GetClosestAliveUserPlayer(target, userID) end
---@param target GUIDSTRING
---@return CHARACTER player
---@return number distance
function Osi.GetClosestPlayer(target) end
---@param x number
---@param y number
---@param z number
---@return CHARACTER player
---@return number distance
function Osi.GetClosestPlayerToPosition(x, y, z) end
---@param target GUIDSTRING
---@return string groupID
function Osi.GetCombatGroupID(target) end
---@param user integer
---@return CHARACTER character
function Osi.GetCurrentCharacter(user) end
---@param character CHARACTER
---@return string deathType
function Osi.GetDeathType(character) end
---@return CHARACTER character
function Osi.GetDebugCharacter() end
---@param index integer
---@return string template
function Osi.GetDebugItem(index) end
---@param character CHARACTER
---@return DIALOGRESOURCE dialog
function Osi.GetDefaultDialog(character) end
---@param target CHARACTER
---@return string equipmentSet
function Osi.GetDefaultEquipmentSet(target) end
---@param character CHARACTER
---@return string state
function Osi.GetDefaultState(character) end
---@param object GUIDSTRING
---@return GUIDSTRING directInventoryHolder
function Osi.GetDirectInventoryOwner(object) end
---@param item ITEM
---@return integer bool
function Osi.GetDisableUse(item) end
---@param target GUIDSTRING
---@return string translatedStringKey
function Osi.GetDisplayName(target) end
---@param object1 GUIDSTRING
---@param object2 GUIDSTRING
---@return number dist
function Osi.GetDistanceTo(object1, object2) end
---@param object GUIDSTRING
---@param x number
---@param y number
---@param z number
---@return number dist
function Osi.GetDistanceToPosition(object, x, y, z) end
---@return number enterCombatRange
function Osi.GetEnterCombatRange() end
---@param item ITEM
---@return EQUIPMENTSLOT preferredSlot
function Osi.GetEquipmentSlotForItem(item) end
---@param character CHARACTER
---@param slotName EQUIPMENTSLOTNAME
---@return ITEM item
function Osi.GetEquippedItem(character, slotName) end
---@param character CHARACTER
---@return ITEM item
function Osi.GetEquippedShield(character) end
---@param character CHARACTER
---@return ITEM item
function Osi.GetEquippedWeapon(character) end
---@param target GUIDSTRING
---@return FACTION faction
function Osi.GetFaction(target) end
---@param object GUIDSTRING
---@return GUIDSTRING firstInventoryCharacterHolder
function Osi.GetFirstInventoryOwnerCharacter(object) end
---@param flag FLAG
---@param object GUIDSTRING
---@return integer flagState
function Osi.GetFlag(flag, object) end
---@param flag FLAG
---@return string flagDescription
function Osi.GetFlagDescription(flag) end
---@param flag FLAG
---@return string flagName
function Osi.GetFlagName(flag) end
---@param character CHARACTER
---@param allowShapeshiftOverride integer
---@return string gender
function Osi.GetGender(character, allowShapeshiftOverride) end
---@return number modifier
function Osi.GetGlobalPriceModifier() end
---@param inventoryHolder GUIDSTRING
---@return integer amount
function Osi.GetGold(inventoryHolder) end
---@param source GUIDSTRING
---@return integer amount
function Osi.GetGoldInMagicPockets(source) end
---@param dialog DIALOGRESOURCE
---@param index integer
---@return CHARACTER speaker
function Osi.GetGossipSpeaker(dialog, index) end
---@param character CHARACTER
---@return integer crimeID
function Osi.GetHandlingCrimeID(character) end
---@param character CHARACTER
---@return integer hasDefaultDialog
function Osi.GetHasDefaultDialog(character) end
---@param speaker GUIDSTRING
---@return integer hasOsirisDialog
function Osi.GetHasOsirisDialog(speaker) end
---@param proxyObject GUIDSTRING
---@return GUIDSTRING ownerObject
function Osi.GetHitProxyOwner(proxyObject) end
---@param entity GUIDSTRING
---@return integer hp
function Osi.GetHitpoints(entity) end
---@param entity GUIDSTRING
---@return number percentage
function Osi.GetHitpointsPercentage(entity) end
---@return CHARACTER character
function Osi.GetHostCharacter() end
---@param character CHARACTER
---@param allowShapeshiftOverride integer
---@return string identity
function Osi.GetIdentity(character, allowShapeshiftOverride) end
---@param entity GUIDSTRING
---@param faction FACTION
---@return integer relation
function Osi.GetIndividualRelation(entity, faction) end
---@param object1 GUIDSTRING
---@param object2 GUIDSTRING
---@return number dist
function Osi.GetInnerDistanceTo(object1, object2) end
---@param object GUIDSTRING
---@param x number
---@param y number
---@param z number
---@return number dist
function Osi.GetInnerDistanceToPosition(object, x, y, z) end
---@param character CHARACTER
---@return integer interrupts
function Osi.GetInterruptCount(character) end