-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathgroup__cpp__kodi__addon__game___operation.html
516 lines (484 loc) · 33.9 KB
/
group__cpp__kodi__addon__game___operation.html
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
<!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">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.9.1"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Kodi Development: 2. Game operations</title>
<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>
<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>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function() { init_search(); });
/* @license-end */
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</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 style="height: 56px;">
<td id="projectlogo"><img alt="Logo" src="kodi-dev.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">Kodi Development
 <span id="projectnumber">20.0</span>
</div>
<div id="projectbrief">for Binary and Script based Add-Ons</div>
</td>
<td> <div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.svg"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.svg" alt=""/></a>
</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.1 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
/* @license-end */
</script>
</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:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('group__cpp__kodi__addon__game___operation.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">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#groups">Modules</a> </div>
<div class="headertitle">
<div class="title">2. Game operations<div class="ingroups"><a class="el" href="group__cpp.html">C++</a> » <a class="el" href="group__cpp__kodi__addon.html">Interface - kodi::addon</a> » <a class="el" href="group__cpp__kodi__addon__instances.html">Addon type instances</a> » <a class="el" href="group__cpp__kodi__addon__game.html">Game</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<p><b>Game operations</b> </p>
<p>These are mandatory functions for using this addon to get the available channels.</p>
<hr />
<p><b>Game operation parts in interface:</b><br />
Copy this to your project and extend with your parts or leave functions complete away where not used or supported.</p>
<p><em>Header parts:</em> </p><div class="fragment"><div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#gae57f40435a8996393b3b151586ca8d19">LoadGame</a>(<span class="keyword">const</span> std::string& url) <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#ga024f7ff502652263acdc28d5086e0ca6">LoadGameSpecial</a>(<a class="code" href="group__cpp__kodi__addon__game___defs___game_types.html#gae227c65af490275c3e3c9b885457ac38">SPECIAL_GAME_TYPE</a> type, <span class="keyword">const</span> std::vector<std::string>& urls) <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#ga88b7876256d63c652dd8743c255380f9">LoadStandalone</a>() <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#ga03d0df14967c92b5ae74ab7e322f74ba">UnloadGame</a>() <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#ga254a2c23c58b85b64f25fb6e44389555">GetGameTiming</a>(<a class="code" href="group__cpp__kodi__addon__game___defs___environment_types.html#structgame__system__timing">game_system_timing</a>& timing_info) <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs___game_types.html#gac33f5cc9e9651c9cb1693afb1b884e60">GAME_REGION</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#gafcb76519f7333ac37e190ad109cecd60">GetRegion</a>() <span class="keyword">override</span>;</div>
<div class="line"><span class="keywordtype">bool</span> <a class="code" href="group__cpp__kodi__addon__game___operation.html#ga4c29e16c942758334004e577cdc3cb03">RequiresGameLoop</a>() <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#ga3749c6dd93b1a869e80961f8a4377272">RunFrame</a>() <span class="keyword">override</span>;</div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> <a class="code" href="group__cpp__kodi__addon__game___operation.html#ga8452850b86c09572d0e6a08a2d0b4eeb">Reset</a>() <span class="keyword">override</span>;</div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs___environment_types_html_structgame__system__timing"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs___environment_types.html#structgame__system__timing">game_system_timing</a></div><div class="ttdoc">Game system timing.</div><div class="ttdef"><b>Definition:</b> game.h:1050</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs___game_types_html_gac33f5cc9e9651c9cb1693afb1b884e60"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs___game_types.html#gac33f5cc9e9651c9cb1693afb1b884e60">GAME_REGION</a></div><div class="ttdeci">GAME_REGION</div><div class="ttdoc">Game reguin definition</div><div class="ttdef"><b>Definition:</b> game.h:563</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs___game_types_html_gae227c65af490275c3e3c9b885457ac38"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs___game_types.html#gae227c65af490275c3e3c9b885457ac38">SPECIAL_GAME_TYPE</a></div><div class="ttdeci">SPECIAL_GAME_TYPE</div><div class="ttdoc">Special game types passed into game_load_game_special().</div><div class="ttdef"><b>Definition:</b> game.h:581</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs_html_gad0fb9f502cf7b3a84f8edb0dc6cbd6ef"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a></div><div class="ttdeci">GAME_ERROR</div><div class="ttdoc">Game add-on error codes</div><div class="ttdef"><b>Definition:</b> game.h:34</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_ga024f7ff502652263acdc28d5086e0ca6"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#ga024f7ff502652263acdc28d5086e0ca6">kodi::addon::CInstanceGame::LoadGameSpecial</a></div><div class="ttdeci">virtual GAME_ERROR LoadGameSpecial(SPECIAL_GAME_TYPE type, const std::vector< std::string > &urls)</div><div class="ttdoc">Load a game that requires multiple files.</div><div class="ttdef"><b>Definition:</b> Game.h:321</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_ga03d0df14967c92b5ae74ab7e322f74ba"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#ga03d0df14967c92b5ae74ab7e322f74ba">kodi::addon::CInstanceGame::UnloadGame</a></div><div class="ttdeci">virtual GAME_ERROR UnloadGame()</div><div class="ttdoc">Unload the current game.</div><div class="ttdef"><b>Definition:</b> Game.h:350</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_ga254a2c23c58b85b64f25fb6e44389555"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#ga254a2c23c58b85b64f25fb6e44389555">kodi::addon::CInstanceGame::GetGameTiming</a></div><div class="ttdeci">virtual GAME_ERROR GetGameTiming(game_system_timing &timing_info)</div><div class="ttdoc">Get timing information about the loaded game.</div><div class="ttdef"><b>Definition:</b> Game.h:363</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_ga3749c6dd93b1a869e80961f8a4377272"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#ga3749c6dd93b1a869e80961f8a4377272">kodi::addon::CInstanceGame::RunFrame</a></div><div class="ttdeci">virtual GAME_ERROR RunFrame()</div><div class="ttdoc">Run a single frame for add-ons that use a game loop.</div><div class="ttdef"><b>Definition:</b> Game.h:399</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_ga4c29e16c942758334004e577cdc3cb03"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#ga4c29e16c942758334004e577cdc3cb03">kodi::addon::CInstanceGame::RequiresGameLoop</a></div><div class="ttdeci">virtual bool RequiresGameLoop()</div><div class="ttdoc">Return true if the client requires the frontend to provide a game loop.</div><div class="ttdef"><b>Definition:</b> Game.h:388</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_ga8452850b86c09572d0e6a08a2d0b4eeb"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#ga8452850b86c09572d0e6a08a2d0b4eeb">kodi::addon::CInstanceGame::Reset</a></div><div class="ttdeci">virtual GAME_ERROR Reset()</div><div class="ttdoc">Reset the current game.</div><div class="ttdef"><b>Definition:</b> Game.h:410</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_ga88b7876256d63c652dd8743c255380f9"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#ga88b7876256d63c652dd8743c255380f9">kodi::addon::CInstanceGame::LoadStandalone</a></div><div class="ttdeci">virtual GAME_ERROR LoadStandalone()</div><div class="ttdoc">Begin playing without a game file.</div><div class="ttdef"><b>Definition:</b> Game.h:337</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_gae57f40435a8996393b3b151586ca8d19"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#gae57f40435a8996393b3b151586ca8d19">kodi::addon::CInstanceGame::LoadGame</a></div><div class="ttdeci">virtual GAME_ERROR LoadGame(const std::string &url)</div><div class="ttdoc">Load a game.</div><div class="ttdef"><b>Definition:</b> Game.h:308</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___operation_html_gafcb76519f7333ac37e190ad109cecd60"><div class="ttname"><a href="group__cpp__kodi__addon__game___operation.html#gafcb76519f7333ac37e190ad109cecd60">kodi::addon::CInstanceGame::GetRegion</a></div><div class="ttdeci">virtual GAME_REGION GetRegion()</div><div class="ttdoc">Get region of the loaded game.</div><div class="ttdef"><b>Definition:</b> Game.h:374</div></div>
</div><!-- fragment --><p> <em>Source parts:</em> </p><div class="fragment"><div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::LoadGame(<span class="keyword">const</span> std::string& url)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::LoadGameSpecial(<a class="code" href="group__cpp__kodi__addon__game___defs___game_types.html#gae227c65af490275c3e3c9b885457ac38">SPECIAL_GAME_TYPE</a> type, <span class="keyword">const</span> std::vector<std::string>& urls)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::LoadStandalone()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::UnloadGame()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::GetGameTiming(<a class="code" href="group__cpp__kodi__addon__game___defs___environment_types.html#structgame__system__timing">game_system_timing</a>& timing_info)</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs___game_types.html#gac33f5cc9e9651c9cb1693afb1b884e60">GAME_REGION</a> <a class="code" href="group__cpp__kodi.html#ga999b45568e7ff08f0f448305828cd9f0">CMyInstance::GetRegion</a>()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs___game_types.html#ggac33f5cc9e9651c9cb1693afb1b884e60acdbaf601ad806397966ab91c3fe92906">GAME_REGION_UNKNOWN</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><span class="keywordtype">bool</span> CMyInstance::RequiresGameLoop()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <span class="keyword">false</span>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::RunFrame()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="line"> </div>
<div class="line"><a class="code" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> CMyInstance::Reset()</div>
<div class="line">{</div>
<div class="line"> <span class="keywordflow">return</span> <a class="code" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a>;</div>
<div class="line">}</div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs___game_types_html_ggac33f5cc9e9651c9cb1693afb1b884e60acdbaf601ad806397966ab91c3fe92906"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs___game_types.html#ggac33f5cc9e9651c9cb1693afb1b884e60acdbaf601ad806397966ab91c3fe92906">GAME_REGION_UNKNOWN</a></div><div class="ttdeci">@ GAME_REGION_UNKNOWN</div><div class="ttdoc">Game region unknown.</div><div class="ttdef"><b>Definition:</b> game.h:565</div></div>
<div class="ttc" id="agroup__cpp__kodi__addon__game___defs_html_ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014"><div class="ttname"><a href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efaf397002d4590537629461eff8b98d014">GAME_ERROR_NOT_IMPLEMENTED</a></div><div class="ttdeci">@ GAME_ERROR_NOT_IMPLEMENTED</div><div class="ttdoc">the method that the frontend called is not implemented</div><div class="ttdef"><b>Definition:</b> game.h:42</div></div>
<div class="ttc" id="agroup__cpp__kodi_html_ga999b45568e7ff08f0f448305828cd9f0"><div class="ttname"><a href="group__cpp__kodi.html#ga999b45568e7ff08f0f448305828cd9f0">kodi::GetRegion</a></div><div class="ttdeci">std::string ATTRIBUTE_HIDDEN GetRegion(const std::string &id)</div><div class="ttdoc">Returns your regions setting as a string for the specified id.</div><div class="ttdef"><b>Definition:</b> General.h:478</div></div>
</div><!-- fragment --> <table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="groups"></a>
Modules</h2></td></tr>
<tr class="memitem:group__cpp__kodi__addon__game___operation__header__addon__auto__check"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__game___operation__header__addon__auto__check.html">Group header include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__cpp__kodi__addon__game___operation__source__addon__auto__check"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__game___operation__source__addon__auto__check.html">Group source include</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:group__cpp__kodi__addon__game___operation___c_stream"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="group__cpp__kodi__addon__game___operation___c_stream.html">Class: CStream</a></td></tr>
<tr class="memdesc:group__cpp__kodi__addon__game___operation___c_stream"><td class="mdescLeft"> </td><td class="mdescRight"> <h4><code><span style="font-style: italic;">Class: </span><span style="font-style: bold;"><font color=31363b><big> kodi::addon::CInstanceGame::CStream </big></font></span></code></h4> <b>Game stream handler</b> <br /></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a id="gae57f40435a8996393b3b151586ca8d19"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gae57f40435a8996393b3b151586ca8d19">◆ </a></span>LoadGame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> LoadGame </td>
<td>(</td>
<td class="paramtype">const std::string & </td>
<td class="paramname"><em>url</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">url</td><td>The URL to load </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the game was loaded </dd></dl>
</div>
</div>
<a id="ga024f7ff502652263acdc28d5086e0ca6"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga024f7ff502652263acdc28d5086e0ca6">◆ </a></span>LoadGameSpecial()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> LoadGameSpecial </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpp__kodi__addon__game___defs___game_types.html#gae227c65af490275c3e3c9b885457ac38">SPECIAL_GAME_TYPE</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const std::vector< std::string > & </td>
<td class="paramname"><em>urls</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Load a game that requires multiple files. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">type</td><td>The game type </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">urls</td><td>An array of urls </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the game was loaded </dd></dl>
</div>
</div>
<a id="ga88b7876256d63c652dd8743c255380f9"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga88b7876256d63c652dd8743c255380f9">◆ </a></span>LoadStandalone()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> LoadStandalone </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Begin playing without a game file. </p>
<p>If the add-on supports standalone mode, it must add the <supports_standalone> tag to the extension point in addon.xml: </p><pre class="fragment"><supports_no_game>false</supports_no_game>
</pre> <dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the game add-on was loaded </dd></dl>
</div>
</div>
<a id="ga03d0df14967c92b5ae74ab7e322f74ba"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga03d0df14967c92b5ae74ab7e322f74ba">◆ </a></span>UnloadGame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> UnloadGame </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Unload the current game. </p>
<p>Unloads a currently loaded game</p>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the game was unloaded </dd></dl>
</div>
</div>
<a id="ga254a2c23c58b85b64f25fb6e44389555"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga254a2c23c58b85b64f25fb6e44389555">◆ </a></span>GetGameTiming()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> GetGameTiming </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group__cpp__kodi__addon__game___defs___environment_types.html#structgame__system__timing">game_system_timing</a> & </td>
<td class="paramname"><em>timing_info</em></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get timing information about the loaded game. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">timing_info</td><td>The info structure to fill</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if info was filled </dd></dl>
</div>
</div>
<a id="gafcb76519f7333ac37e190ad109cecd60"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gafcb76519f7333ac37e190ad109cecd60">◆ </a></span>GetRegion()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs___game_types.html#gac33f5cc9e9651c9cb1693afb1b884e60">GAME_REGION</a> GetRegion </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get region of the loaded game. </p>
<dl class="section return"><dt>Returns</dt><dd>the region, or <a class="el" href="group__cpp__kodi__addon__game___defs___game_types.html#ggac33f5cc9e9651c9cb1693afb1b884e60acdbaf601ad806397966ab91c3fe92906">GAME_REGION_UNKNOWN</a> if unknown or no game is loaded </dd></dl>
</div>
</div>
<a id="ga4c29e16c942758334004e577cdc3cb03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga4c29e16c942758334004e577cdc3cb03">◆ </a></span>RequiresGameLoop()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual bool RequiresGameLoop </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return true if the client requires the frontend to provide a game loop. </p>
<p>The game loop is a thread that calls <a class="el" href="group__cpp__kodi__addon__game___operation.html#ga3749c6dd93b1a869e80961f8a4377272" title="Run a single frame for add-ons that use a game loop.">RunFrame()</a> in a loop at a rate determined by the playback speed and the client's FPS.</p>
<dl class="section return"><dt>Returns</dt><dd>true if the frontend should provide a game loop, false otherwise </dd></dl>
</div>
</div>
<a id="ga3749c6dd93b1a869e80961f8a4377272"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga3749c6dd93b1a869e80961f8a4377272">◆ </a></span>RunFrame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> RunFrame </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Run a single frame for add-ons that use a game loop. </p>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if there was no error </dd></dl>
</div>
</div>
<a id="ga8452850b86c09572d0e6a08a2d0b4eeb"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga8452850b86c09572d0e6a08a2d0b4eeb">◆ </a></span>Reset()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="group__cpp__kodi__addon__game___defs.html#gad0fb9f502cf7b3a84f8edb0dc6cbd6ef">GAME_ERROR</a> Reset </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Reset the current game. </p>
<dl class="section return"><dt>Returns</dt><dd>the error, or <a class="el" href="group__cpp__kodi__addon__game___defs.html#ggad0fb9f502cf7b3a84f8edb0dc6cbd6efa51b865ee275ae8e392f3e9fd8594fa90">GAME_ERROR_NO_ERROR</a> if the game was reset </dd></dl>
</div>
</div>
<a id="gaae0ae25b20382135f1625dc0f41ecd03"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaae0ae25b20382135f1625dc0f41ecd03">◆ </a></span>CloseGame()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">void CloseGame </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p><b>Callback to Kodi Function</b><br />
Requests the frontend to stop the current game </p>
<dl class="section remark"><dt>Remarks</dt><dd>Only called from addon itself </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="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.1 </li>
</ul>
</div>
</body>
</html>