@@ -28,7 +28,7 @@ The `load_configuration` function loads customizable configuration settings from
28
28
29
29
#### Usage Pattern
30
30
31
- ``` cpp
31
+ ``` c
32
32
template<typename TConfig>
33
33
34
34
TConfig antara::gaming::config::load_configuration (std::filesystem::path &&config_path, std::string filename)
@@ -76,7 +76,7 @@ The `version` function returns the current version of the Antara Gaming SDK.
76
76
77
77
#### Usage Pattern
78
78
79
- ``` cpp
79
+ ``` c
80
80
#include < antara/gaming/core/version.hpp>
81
81
82
82
constexpr const char *antara::gaming::version ()
@@ -163,11 +163,9 @@ int main()
163
163
164
164
Public member functions.
165
165
166
- { /* The description in the documentation was unclear to me. Can you please provide more information about what "Public member functions" means here? Thx */ }
167
-
168
166
#### Usage Pattern
169
167
170
- ```cpp
168
+ ```c
171
169
void receive_add_base_system(const ecs::event::add_base_system &evt)
172
170
```
173
171
@@ -183,7 +181,9 @@ void receive_add_base_system(const ecs::event::add_base_system &evt)
183
181
| ------ | ---- | ----------- |
184
182
| (none) | void | |
185
183
184
+ <DevComment>
186
185
{ /* needs an example */ }
186
+ </DevComment>
187
187
188
188
### start
189
189
@@ -215,7 +215,9 @@ system_manager_instance.start();
215
215
| ------ | ---- | ----------- |
216
216
| (none) | void | |
217
217
218
+ <DevComment>
218
219
{ /* Does this return something such as a bool value, for successful execution, by chance? */ }
220
+ </DevComment>
219
221
220
222
#### 📌 Example
221
223
@@ -279,7 +281,7 @@ int main()
279
281
entt ::dispatcher & dispatcher {registry.set<entt::dispatcher > ()};
280
282
antara ::gaming ::ecs ::system_manager system_manager {entity_registry };
281
283
system_manager .start ();
282
- // ... add 5 differents systems here
284
+ // ... add 5 different systems here
283
285
std ::size_t nb_systems_updated = system_manager .update ();
284
286
if (nb_systems_updated != 5 ) {
285
287
std::cerr << " Expect 5 system updates from system_manager.update(), but received only " << nb_systems_updated << std ::endl ;
@@ -331,7 +333,7 @@ int main()
331
333
entt ::dispatcher & dispatcher {registry.set<entt::dispatcher > ()};
332
334
antara ::gaming ::ecs ::system_manager system_manager {entity_registry };
333
335
system_manager .start ();
334
- // ... add 5 differents systems here
336
+ // ... add 5 different systems here
335
337
std ::size_t nb_systems_updated = system_manager .update ();
336
338
if (nb_systems_updated != 5 ) {
337
339
std::cerr << " Expect 5 system updates from system_manager.update(), but received only " << nb_systems_updated << std ::endl ;
@@ -348,7 +350,7 @@ The `get_system` function uses a template parameter to return a reference to a s
348
350
349
351
#### Usage Pattern
350
352
351
- ```cpp
353
+ ```c
352
354
template<typename TSystem >
353
355
const TSystem &get_system() const
354
356
```
@@ -365,7 +367,9 @@ const TSystem &get_system() const
365
367
| ------- | --------- | --------------------------------------------------- |
366
368
| TSystem | \&TSystem | a reference to the template chosen by the developer |
367
369
370
+ <DevComment>
368
371
{/* Need an example here */}
372
+ </DevComment>
369
373
370
374
### get\_system | 2
371
375
@@ -377,7 +381,7 @@ This overloaded function accepts different parameters.
377
381
378
382
#### Usage Pattern
379
383
380
- ```cpp
384
+ ```c
381
385
template<typename TSystem>
382
386
383
387
TSystem &get_system()
@@ -426,7 +430,7 @@ This function recursively calls the [get\_system](/antara/api/gaming/#get-system
426
430
427
431
#### Usage Pattern
428
432
429
- ```cpp
433
+ ```c
430
434
template<typename ...TSystems>
431
435
std::tuple<std::add_lvalue_reference_t<TSystems>...> get_systems()
432
436
```
@@ -456,7 +460,7 @@ int main()
456
460
entt ::dispatcher & dispatcher {registry.set<entt::dispatcher > ()};
457
461
antara ::gaming ::ecs ::system_manager system_manager {entity_registry };
458
462
system_manager .start ();
459
- // ... added 2 differents systems here (render_system, and a log_system)
463
+ // ... added 2 different systems here (render_system, and a log_system)
460
464
auto & render_system = system_manager .get_system < game ::render_system > ();
461
465
462
466
const auto & log_system = system_manager .get_system < game ::log_system > ();
@@ -476,7 +480,7 @@ An overloaded version of the [get\_systems](/antara/api/gaming/#get-systems-1) f
476
480
477
481
#### Usage Pattern
478
482
479
- ```cpp
483
+ ```c
480
484
template<typename ...TSystems>
481
485
std::tuple<std::add_lvalue_reference_t<std::add_const_t<TSystems>>...> get_systems() const
482
486
```
@@ -505,7 +509,7 @@ int main()
505
509
entt ::registry entity_registry ;
506
510
entt ::dispatcher & dispatcher {registry.set<entt::dispatcher > ()};
507
511
antara ::gaming ::ecs ::system_manager system_manager {entity_registry };
508
- // ... added differents systems here
512
+ // ... added different systems here
509
513
// Called from a const context
510
514
auto && [system_foo , system_bar ] = system_manager .get_systems <system_foo , system_bar >();
511
515
@@ -526,7 +530,7 @@ The `has_system` function verifies whether or not a system is already registered
526
530
527
531
#### Usage Pattern
528
532
529
- ```cpp
533
+ ```c
530
534
template<typename TSystem >
531
535
bool has_system() const
532
536
```
@@ -625,7 +629,7 @@ The `has_systems` function verifies whether or not a list of systems is already
625
629
626
630
#### Usage Pattern
627
631
628
- ```cpp
632
+ ```c
629
633
template<typename ...TSystems>
630
634
bool has_systems() const
631
635
```
@@ -730,7 +734,7 @@ This function recursively calls the [has\_system](/antara/api/gaming/#has-system
730
734
731
735
#### Usage Pattern
732
736
733
- ```cpp
737
+ ```c
734
738
template<typename ...TSystems>
735
739
bool has\_systems() const
736
740
```
@@ -776,7 +780,7 @@ The`mark_system` function marks a system for destruction at the next tick of the
776
780
777
781
#### Usage Pattern
778
782
779
- ```cpp
783
+ ```c
780
784
template<typename TSystem >
781
785
bool mark_system()
782
786
```
@@ -823,7 +827,7 @@ The`mark_systems` function marks a system for destruction at the next tick of th
823
827
824
828
#### Usage Pattern
825
829
826
- ``` cpp
830
+ ``` c
827
831
template<typename TSystem>
828
832
bool mark_system ()
829
833
```
@@ -876,7 +880,7 @@ This function recursively calls the [mark\_system](/antara/api/gaming/#mark-syst
876
880
877
881
#### Usage Pattern
878
882
879
- ```cpp
883
+ ```c
880
884
template<typename ...TSystems>
881
885
bool mark_systems()
882
886
```
@@ -923,7 +927,7 @@ The `enable_system` function enables a system.
923
927
924
928
#### Usage Pattern
925
929
926
- ```cpp
930
+ ```c
927
931
template<typename TSystem >
928
932
bool enable_system()
929
933
```
@@ -972,7 +976,7 @@ This function recursively calls the [enable\_system](/antara/api/gaming/#enable-
972
976
973
977
#### Usage Pattern
974
978
975
- ``` cpp
979
+ ``` c
976
980
template<typename ...TSystems>
977
981
bool enable_systems ()
978
982
```
@@ -1020,7 +1024,7 @@ A disabled system is ignored during the game loop, but the system is not destroy
1020
1024
1021
1025
#### Usage Pattern
1022
1026
1023
- ```cpp
1027
+ ```c
1024
1028
template<typename TSystem >
1025
1029
bool disable_system()
1026
1030
```
@@ -1068,7 +1072,7 @@ This function recursively calls the [disable\_system](/antara/api/gaming/#disabl
1068
1072
1069
1073
#### Usage Pattern
1070
1074
1071
- ``` cpp
1075
+ ``` c
1072
1076
template<typename ...TSystems>
1073
1077
bool disable_systems ()
1074
1078
```
@@ -1206,7 +1210,7 @@ This function is a factory.
1206
1210
1207
1211
#### Usage Pattern
1208
1212
1209
- ```cpp
1213
+ ```c
1210
1214
template<typename TSystem, typename ...TSystemArgs>
1211
1215
TSystem &create_system(TSystemArgs&&... args)
1212
1216
```
@@ -1246,11 +1250,13 @@ int main()
1246
1250
1247
1251
#### Public Function
1248
1252
1253
+ <DevComment>
1249
1254
{ /* Requires documentation */ }
1255
+ </DevComment>
1250
1256
1251
1257
#### Usage Pattern
1252
1258
1253
- ```cpp
1259
+ ```c
1254
1260
template<typename TSystem, typename ...TSystemArgs>
1255
1261
void create_system_rt(TSystemArgs&&... args)
1256
1262
```
@@ -1261,13 +1267,11 @@ void create_system_rt(TSystemArgs&&... args)
1261
1267
1262
1268
The `load_systems` function loads many os systems.
1263
1269
1264
- { /* What does "os" mean above? Operating systems? That would make it operating systems systems */ }
1265
-
1266
1270
This function recursively calls the [create\_system](/antara/api/gaming/#create-system) function.
1267
1271
1268
1272
#### Usage Pattern
1269
1273
1270
- ```cpp
1274
+ ```c
1271
1275
template<typename ...TSystems, typename ...TArgs>
1272
1276
auto load_systems(TArgs&&... args)
1273
1277
```
@@ -1383,8 +1387,6 @@ using systems_queue = std::queue<system_ptr>
1383
1387
base*system &add_system*(system_ptr &&system, system_type sys_type)
1384
1388
```
1385
1389
1386
- { /* Not clear about any of this, just placing here for now in the format */ }
1387
-
1388
1390
### entity\_registry\_
1389
1391
1390
1392
#### Private Data Members
@@ -1414,9 +1416,7 @@ This is the principal constructor for key-press functions.
1414
1416
###### Usage Pattern
1415
1417
1416
1418
```cpp
1417
-
1418
1419
key_pressed(input::key key_, bool alt_, bool control_, bool shift_, bool system_)
1419
-
1420
1420
```
1421
1421
1422
1422
###### Template Type
@@ -1454,7 +1454,9 @@ int main()
1454
1454
1455
1455
The `key_pressed` function that takes no arguments is the default constructor, provided for scripting-system convenience.
1456
1456
1457
+ <DevComment>
1457
1458
{ /* Is there more information we can provide here? */ }
1459
+ </DevComment>
1458
1460
1459
1461
Please see the [key\_pressed | 1](/antara/api/gaming/#key-pressed-1) function for more information.
1460
1462
@@ -1662,7 +1664,9 @@ quit_game()
1662
1664
1663
1665
##### return\_value\_
1664
1666
1667
+ <DevComment>
1665
1668
{ /* need more information to edit this part */ }
1669
+ </DevComment>
1666
1670
1667
1671
###### Usage Pattern
1668
1672
@@ -1696,7 +1700,7 @@ The `antara::gaming::sfml::audio_system` class provides audio-related functions
1696
1700
1697
1701
###### Usage Pattern
1698
1702
1699
- ```cpp
1703
+ ```c
1700
1704
class audio_system : public antara::gaming::ecs::system<audio_system>
1701
1705
```
1702
1706
@@ -1708,7 +1712,7 @@ class audio_system : public antara::gaming::ecs::system<audio_system>
1708
1712
1709
1713
###### Usage Pattern
1710
1714
1711
- ``` cpp
1715
+ ``` c
1712
1716
audio_system (entt::registry ®istry)
1713
1717
```
1714
1718
@@ -1730,7 +1734,7 @@ The `update` function destroys and clears the sounds when they are finished.
1730
1734
1731
1735
###### Usage Pattern
1732
1736
1733
- ```cpp
1737
+ ```c
1734
1738
void update()
1735
1739
```
1736
1740
@@ -1756,4 +1760,6 @@ The `antara::gaming::sfml::component_sound` struct contains sound and the sound'
1756
1760
1757
1761
The ` sf::Sound sound ` object is the SFML Sound instance and contains the sound data.
1758
1762
1763
+ <DevComment >
1759
1764
{ /* Any other information here */ }
1765
+ </DevComment >
0 commit comments