-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathnamespaceModAPI_1_1Util.html
More file actions
761 lines (713 loc) · 38.7 KB
/
namespaceModAPI_1_1Util.html
File metadata and controls
761 lines (713 loc) · 38.7 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
<!-- HTML header for doxygen 1.16.1-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.8"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MIO Modding API: ModAPI::Util Namespace Reference</title>
<!--BEGIN PROJECT_ICON-->
<link rel="icon" href="$projecticon" type="image/x-icon" />
<!--END PROJECT_ICON-->
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<!--BEGIN COPY_CLIPBOARD-->
<script type="text/javascript" src="clipboard.js"></script>
<!--END COPY_CLIPBOARD-->
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only.css" rel="stylesheet" type="text/css"/>
<link href="doxygen-awesome-sidebar-only-darkmode-toggle.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="doxygen-awesome-darkmode-toggle.js"></script>
<script type="text/javascript">
DoxygenAwesomeDarkModeToggle.init()
</script>
<script type="text/javascript" src="doxygen-awesome-fragment-copy-button.js"></script>
<script type="text/javascript">
DoxygenAwesomeFragmentCopyButton.init()
DoxygenAwesomeFragmentCopyButton.title = "Copy Code Fragment"
</script>
<script type="text/javascript" src="doxygen-awesome-paragraph-link.js"></script>
<script type="text/javascript">
DoxygenAwesomeParagraphLink.init()
</script>
<script type="text/javascript" src="doxygen-awesome-interactive-toc.js"></script>
<script type="text/javascript">
DoxygenAwesomeInteractiveToc.init()
</script>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">MIO Modding API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.8 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(document).ready(function(){initNavTree('namespaceModAPI_1_1Util.html',''); initResizable(); });
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">ModAPI::Util Namespace Reference</div></div>
</div><!--header-->
<div class="contents">
<p>General utility functions for memory manipulation and logging.
<a href="namespaceModAPI_1_1Util.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:a18e02aa2d1a1854a90aea54cc00cd536" id="r_a18e02aa2d1a1854a90aea54cc00cd536"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a18e02aa2d1a1854a90aea54cc00cd536">LogMessage</a> (char *<a class="el" href="dllmain_8cpp.html#a6533a6c44910aeff65ce1539c9743b72">modId</a>, const char *message)</td></tr>
<tr class="memdesc:a18e02aa2d1a1854a90aea54cc00cd536"><td class="mdescLeft"> </td><td class="mdescRight">Logs a message to the console, prefixed with the mod ID. <br /></td></tr>
<tr class="separator:a18e02aa2d1a1854a90aea54cc00cd536"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a00a4c824af319379e0a6a38b36c0fae5" id="r_a00a4c824af319379e0a6a38b36c0fae5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736">Enums::MenuState</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a00a4c824af319379e0a6a38b36c0fae5">GetGameMenuState</a> ()</td></tr>
<tr class="memdesc:a00a4c824af319379e0a6a38b36c0fae5"><td class="mdescLeft"> </td><td class="mdescRight">Gets the current menu state of the game. <br /></td></tr>
<tr class="separator:a00a4c824af319379e0a6a38b36c0fae5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4978974501e64eb7c1f53f94a93a88ed" id="r_a4978974501e64eb7c1f53f94a93a88ed"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a4978974501e64eb7c1f53f94a93a88ed">SetGameMenuState</a> (<a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736">Enums::MenuState</a> state)</td></tr>
<tr class="memdesc:a4978974501e64eb7c1f53f94a93a88ed"><td class="mdescLeft"> </td><td class="mdescRight">Sets the current menu state of the game. <br /></td></tr>
<tr class="separator:a4978974501e64eb7c1f53f94a93a88ed"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ae0827fb6294f04b50fab9b75a88f04d8" id="r_ae0827fb6294f04b50fab9b75a88f04d8"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#ae0827fb6294f04b50fab9b75a88f04d8">CheckIfSaveLoaded</a> ()</td></tr>
<tr class="memdesc:ae0827fb6294f04b50fab9b75a88f04d8"><td class="mdescLeft"> </td><td class="mdescRight">Checks whether a save is currently loaded. <br /></td></tr>
<tr class="separator:ae0827fb6294f04b50fab9b75a88f04d8"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad665083f2eafbd11f7de079a3912b972" id="r_ad665083f2eafbd11f7de079a3912b972"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#ad665083f2eafbd11f7de079a3912b972">WaitForSaveLoaded</a> ()</td></tr>
<tr class="memdesc:ad665083f2eafbd11f7de079a3912b972"><td class="mdescLeft"> </td><td class="mdescRight">Blocks until a save is loaded. <br /></td></tr>
<tr class="separator:ad665083f2eafbd11f7de079a3912b972"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa8d47986ad88565dbf35bb7e70a7f499" id="r_aa8d47986ad88565dbf35bb7e70a7f499"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#aa8d47986ad88565dbf35bb7e70a7f499">WriteMemory</a> (void *address, const void *data, size_t size)</td></tr>
<tr class="memdesc:aa8d47986ad88565dbf35bb7e70a7f499"><td class="mdescLeft"> </td><td class="mdescRight">Writes raw bytes to an arbitrary memory address. <br /></td></tr>
<tr class="separator:aa8d47986ad88565dbf35bb7e70a7f499"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a97340fe85a75d421ee7e4ac24b83996a" id="r_a97340fe85a75d421ee7e4ac24b83996a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a97340fe85a75d421ee7e4ac24b83996a">ReadMemory</a> (void *address, void *buffer, size_t size)</td></tr>
<tr class="memdesc:a97340fe85a75d421ee7e4ac24b83996a"><td class="mdescLeft"> </td><td class="mdescRight">Reads raw bytes from an arbitrary memory address. <br /></td></tr>
<tr class="separator:a97340fe85a75d421ee7e4ac24b83996a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ea8bdc5c88111f815bd4ea051e30612" id="r_a8ea8bdc5c88111f815bd4ea051e30612"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a8ea8bdc5c88111f815bd4ea051e30612">PatchBytes</a> (void *address, const char *bytes, size_t size)</td></tr>
<tr class="memdesc:a8ea8bdc5c88111f815bd4ea051e30612"><td class="mdescLeft"> </td><td class="mdescRight">Patches bytes at a memory address with the given byte string. <br /></td></tr>
<tr class="separator:a8ea8bdc5c88111f815bd4ea051e30612"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a08f40c30d5d6085f2d141b24725a9853" id="r_a08f40c30d5d6085f2d141b24725a9853"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a08f40c30d5d6085f2d141b24725a9853">NopBytes</a> (void *address, size_t count)</td></tr>
<tr class="memdesc:a08f40c30d5d6085f2d141b24725a9853"><td class="mdescLeft"> </td><td class="mdescRight">Overwrites bytes at a memory address with NOP instructions. <br /></td></tr>
<tr class="separator:a08f40c30d5d6085f2d141b24725a9853"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adddc160f920067e14988ab12c95c179c" id="r_adddc160f920067e14988ab12c95c179c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#adddc160f920067e14988ab12c95c179c">PatternScan</a> (HMODULE module, const char *pattern, const char *mask)</td></tr>
<tr class="memdesc:adddc160f920067e14988ab12c95c179c"><td class="mdescLeft"> </td><td class="mdescRight">Scans a module's memory for a byte pattern. <br /></td></tr>
<tr class="separator:adddc160f920067e14988ab12c95c179c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aeef298de24ac370f45cf3660447e45a5" id="r_aeef298de24ac370f45cf3660447e45a5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#aeef298de24ac370f45cf3660447e45a5">PatternScanReverse</a> (HMODULE module, void *from, const char *pattern, const char *mask)</td></tr>
<tr class="memdesc:aeef298de24ac370f45cf3660447e45a5"><td class="mdescLeft"> </td><td class="mdescRight">Scans a module's memory in reverse for a byte pattern, starting from a given address. <br /></td></tr>
<tr class="separator:aeef298de24ac370f45cf3660447e45a5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afac67ecacb7a13840151c2480787ce94" id="r_afac67ecacb7a13840151c2480787ce94"><td class="memItemLeft" align="right" valign="top"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void * </td><td class="memItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#afac67ecacb7a13840151c2480787ce94">FollowPointer</a> (void *basePtr, int offset)</td></tr>
<tr class="memdesc:afac67ecacb7a13840151c2480787ce94"><td class="mdescLeft"> </td><td class="mdescRight">Follows a pointer and applies an offset to resolve an address. <br /></td></tr>
<tr class="separator:afac67ecacb7a13840151c2480787ce94"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a91970aecb8b8ace7f3f67f53a6658876" id="r_a91970aecb8b8ace7f3f67f53a6658876"><td class="memTemplParams" colspan="2">template<typename ReturnType , typename... Args> </td></tr>
<tr class="memitem:a91970aecb8b8ace7f3f67f53a6658876"><td class="memTemplItemLeft" align="right" valign="top">ReturnType </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a91970aecb8b8ace7f3f67f53a6658876">CallAssembly</a> (void *address, Args... args)</td></tr>
<tr class="memdesc:a91970aecb8b8ace7f3f67f53a6658876"><td class="mdescLeft"> </td><td class="mdescRight">Calls a game function at the given address using the __fastcall convention. <br /></td></tr>
<tr class="separator:a91970aecb8b8ace7f3f67f53a6658876"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac6b5c83be9632b62616dc6f77aa488f2" id="r_ac6b5c83be9632b62616dc6f77aa488f2"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:ac6b5c83be9632b62616dc6f77aa488f2"><td class="memTemplItemLeft" align="right" valign="top">T </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#ac6b5c83be9632b62616dc6f77aa488f2">ReadMemoryTyped</a> (void *address)</td></tr>
<tr class="memdesc:ac6b5c83be9632b62616dc6f77aa488f2"><td class="mdescLeft"> </td><td class="mdescRight">Reads a typed value from an arbitrary memory address. <br /></td></tr>
<tr class="separator:ac6b5c83be9632b62616dc6f77aa488f2"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6176042cf4e69aa610a536cd1a78a5bd" id="r_a6176042cf4e69aa610a536cd1a78a5bd"><td class="memTemplParams" colspan="2">template<typename T > </td></tr>
<tr class="memitem:a6176042cf4e69aa610a536cd1a78a5bd"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="namespaceModAPI_1_1Util.html#a6176042cf4e69aa610a536cd1a78a5bd">WriteMemoryTyped</a> (void *address, T value)</td></tr>
<tr class="memdesc:a6176042cf4e69aa610a536cd1a78a5bd"><td class="mdescLeft"> </td><td class="mdescRight">Writes a typed value to an arbitrary memory address. <br /></td></tr>
<tr class="separator:a6176042cf4e69aa610a536cd1a78a5bd"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>General utility functions for memory manipulation and logging. </p>
</div><h2 class="groupheader">Function Documentation</h2>
<a id="a91970aecb8b8ace7f3f67f53a6658876" name="a91970aecb8b8ace7f3f67f53a6658876"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a91970aecb8b8ace7f3f67f53a6658876">◆ </a></span>CallAssembly()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename ReturnType , typename... Args> </div>
<table class="memname">
<tr>
<td class="memname">ReturnType ModAPI::Util::CallAssembly </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">Args... </td>
<td class="paramname"><em>args</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Calls a game function at the given address using the __fastcall convention. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">ReturnType</td><td>The return type of the function. </td></tr>
<tr><td class="paramname">Args</td><td>The argument types of the function. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>The address of the function to call. </td></tr>
<tr><td class="paramname">args</td><td>The arguments to pass to the function. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The return value of the called function. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Calling a function with the wrong address, return type, or argument types will cause a crash. </dd></dl>
</div>
</div>
<a id="ae0827fb6294f04b50fab9b75a88f04d8" name="ae0827fb6294f04b50fab9b75a88f04d8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae0827fb6294f04b50fab9b75a88f04d8">◆ </a></span>CheckIfSaveLoaded()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::Util::CheckIfSaveLoaded </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Checks whether a save is currently loaded. </p>
<dl class="section return"><dt>Returns</dt><dd>True if a save is loaded, false otherwise. </dd></dl>
</div>
</div>
<a id="afac67ecacb7a13840151c2480787ce94" name="afac67ecacb7a13840151c2480787ce94"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afac67ecacb7a13840151c2480787ce94">◆ </a></span>FollowPointer()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void * ModAPI::Util::FollowPointer </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>basePtr</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>offset</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Follows a pointer and applies an offset to resolve an address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">basePtr</td><td>The base pointer to dereference. </td></tr>
<tr><td class="paramname">offset</td><td>The offset to apply after dereferencing. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The resolved address, or nullptr if the pointer could not be followed. </dd></dl>
</div>
</div>
<a id="a00a4c824af319379e0a6a38b36c0fae5" name="a00a4c824af319379e0a6a38b36c0fae5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a00a4c824af319379e0a6a38b36c0fae5">◆ </a></span>GetGameMenuState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> <a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736">Enums::MenuState</a> ModAPI::Util::GetGameMenuState </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Gets the current menu state of the game. </p>
<dl class="section return"><dt>Returns</dt><dd>The current MenuState value. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736" title="Represents the current high-level state of the game's menu system. The names match the names used int...">Enums::MenuState</a> </dd></dl>
</div>
</div>
<a id="a18e02aa2d1a1854a90aea54cc00cd536" name="a18e02aa2d1a1854a90aea54cc00cd536"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a18e02aa2d1a1854a90aea54cc00cd536">◆ </a></span>LogMessage()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void ModAPI::Util::LogMessage </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"><em>modId</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>message</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Logs a message to the console, prefixed with the mod ID. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">modId</td><td>The ID of the mod sending the message. </td></tr>
<tr><td class="paramname">message</td><td>The message to log. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a08f40c30d5d6085f2d141b24725a9853" name="a08f40c30d5d6085f2d141b24725a9853"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a08f40c30d5d6085f2d141b24725a9853">◆ </a></span>NopBytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::Util::NopBytes </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>count</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Overwrites bytes at a memory address with NOP instructions. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Target memory address. </td></tr>
<tr><td class="paramname">count</td><td>Number of bytes to NOP. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the operation failed. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Incorrect use can cause crashes. </dd></dl>
</div>
</div>
<a id="a8ea8bdc5c88111f815bd4ea051e30612" name="a8ea8bdc5c88111f815bd4ea051e30612"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ea8bdc5c88111f815bd4ea051e30612">◆ </a></span>PatchBytes()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::Util::PatchBytes </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>bytes</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Patches bytes at a memory address with the given byte string. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Target memory address. </td></tr>
<tr><td class="paramname">bytes</td><td>Byte string to write. </td></tr>
<tr><td class="paramname">size</td><td>Number of bytes to write. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the patch failed. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Incorrect use can cause crashes. </dd></dl>
</div>
</div>
<a id="adddc160f920067e14988ab12c95c179c" name="adddc160f920067e14988ab12c95c179c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#adddc160f920067e14988ab12c95c179c">◆ </a></span>PatternScan()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void * ModAPI::Util::PatternScan </td>
<td>(</td>
<td class="paramtype">HMODULE </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mask</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Scans a module's memory for a byte pattern. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>Handle to the module to scan. </td></tr>
<tr><td class="paramname">pattern</td><td>Byte pattern to search for. </td></tr>
<tr><td class="paramname">mask</td><td>Mask string where 'x' matches the byte and '?' is a wildcard. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the first match, or nullptr if not found. </dd></dl>
</div>
</div>
<a id="aeef298de24ac370f45cf3660447e45a5" name="aeef298de24ac370f45cf3660447e45a5"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aeef298de24ac370f45cf3660447e45a5">◆ </a></span>PatternScanReverse()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void * ModAPI::Util::PatternScanReverse </td>
<td>(</td>
<td class="paramtype">HMODULE </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>from</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>pattern</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>mask</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Scans a module's memory in reverse for a byte pattern, starting from a given address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">module</td><td>Handle to the module to scan. </td></tr>
<tr><td class="paramname">from</td><td>Address to begin scanning backwards from. </td></tr>
<tr><td class="paramname">pattern</td><td>Byte pattern to search for. </td></tr>
<tr><td class="paramname">mask</td><td>Mask string where 'x' matches the byte and '?' is a wildcard. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to the first match, or nullptr if not found. </dd></dl>
</div>
</div>
<a id="a97340fe85a75d421ee7e4ac24b83996a" name="a97340fe85a75d421ee7e4ac24b83996a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a97340fe85a75d421ee7e4ac24b83996a">◆ </a></span>ReadMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::Util::ReadMemory </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void * </td>
<td class="paramname"><em>buffer</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads raw bytes from an arbitrary memory address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Source memory address. </td></tr>
<tr><td class="paramname">buffer</td><td>Pointer to the buffer to read into. </td></tr>
<tr><td class="paramname">size</td><td>Number of bytes to read. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the read failed. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Incorrect use can cause crashes. </dd></dl>
</div>
</div>
<a id="ac6b5c83be9632b62616dc6f77aa488f2" name="ac6b5c83be9632b62616dc6f77aa488f2"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac6b5c83be9632b62616dc6f77aa488f2">◆ </a></span>ReadMemoryTyped()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">T ModAPI::Util::ReadMemoryTyped </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>address</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Reads a typed value from an arbitrary memory address. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type to read. Must be trivially copyable. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Memory address to read from. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>The value at the given address interpreted as type T. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>No bounds checking is performed. Ensure the address is valid. </dd></dl>
</div>
</div>
<a id="a4978974501e64eb7c1f53f94a93a88ed" name="a4978974501e64eb7c1f53f94a93a88ed"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4978974501e64eb7c1f53f94a93a88ed">◆ </a></span>SetGameMenuState()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::Util::SetGameMenuState </td>
<td>(</td>
<td class="paramtype"><a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736">Enums::MenuState</a> </td>
<td class="paramname"><em>state</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Sets the current menu state of the game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">state</td><td>The MenuState value to set. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the menu state address failed to resolve. </dd></dl>
<dl class="section see"><dt>See also</dt><dd><a class="el" href="namespaceModAPI_1_1Enums.html#a30663a5e0b7359c96dcc76db6a2c6736" title="Represents the current high-level state of the game's menu system. The names match the names used int...">Enums::MenuState</a> </dd></dl>
</div>
</div>
<a id="ad665083f2eafbd11f7de079a3912b972" name="ad665083f2eafbd11f7de079a3912b972"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ad665083f2eafbd11f7de079a3912b972">◆ </a></span>WaitForSaveLoaded()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> void ModAPI::Util::WaitForSaveLoaded </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Blocks until a save is loaded. </p>
<dl class="section note"><dt>Note</dt><dd>This is a blocking call. Do not call this on the main thread. </dd></dl>
</div>
</div>
<a id="aa8d47986ad88565dbf35bb7e70a7f499" name="aa8d47986ad88565dbf35bb7e70a7f499"></a>
<h2 class="memtitle"><span class="permalink"><a href="#aa8d47986ad88565dbf35bb7e70a7f499">◆ </a></span>WriteMemory()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="mio-modding-api_8h.html#ad7b4f6be7732c6c6ce540c181de6bc48">MODDING_API</a> bool ModAPI::Util::WriteMemory </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const void * </td>
<td class="paramname"><em>data</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t </td>
<td class="paramname"><em>size</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes raw bytes to an arbitrary memory address. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Target memory address. </td></tr>
<tr><td class="paramname">data</td><td>Pointer to the data to write. </td></tr>
<tr><td class="paramname">size</td><td>Number of bytes to write. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the write failed. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>Incorrect use can cause crashes. </dd></dl>
</div>
</div>
<a id="a6176042cf4e69aa610a536cd1a78a5bd" name="a6176042cf4e69aa610a536cd1a78a5bd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6176042cf4e69aa610a536cd1a78a5bd">◆ </a></span>WriteMemoryTyped()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<typename T > </div>
<table class="memname">
<tr>
<td class="memname">bool ModAPI::Util::WriteMemoryTyped </td>
<td>(</td>
<td class="paramtype">void * </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">T </td>
<td class="paramname"><em>value</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Writes a typed value to an arbitrary memory address. </p>
<dl class="tparams"><dt>Template Parameters</dt><dd>
<table class="tparams">
<tr><td class="paramname">T</td><td>The type to write. Must be trivially copyable. </td></tr>
</table>
</dd>
</dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">address</td><td>Memory address to write to. </td></tr>
<tr><td class="paramname">value</td><td>The value to write. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>True on success, false if the write failed. </dd></dl>
<dl class="section warning"><dt>Warning</dt><dd>No bounds checking is performed. Ensure the address is valid. </dd></dl>
</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="namespaceModAPI.html">ModAPI</a></li><li class="navelem"><a class="el" href="namespaceModAPI_1_1Util.html">Util</a></li>
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
</ul>
</div>
</body>
</html>