|
5 | 5 | # Currently loaded worlds will be unloaded before attempting to load a new one.
|
6 | 6 | # Any previously spawned entities will be removed. Once a world is loaded, simulation will be left in a Stopped state.
|
7 | 7 |
|
8 |
| -# Resource such as SDF, USD, MJCF, or other simulator-native format world file. |
9 |
| -string uri |
| 8 | +string uri # Resource such as SDF, USD, MJCF, or other simulator-native format world file. |
10 | 9 |
|
11 |
| -# Simulation world passed as a string. This field is used if the uri field is empty. |
12 |
| -string resource_string |
| 10 | +string resource_string # Simulation world passed as a string. This field is used if the uri field is empty. |
13 | 11 |
|
14 |
| -# Fail on unsupported elements (such as SDFormat sub-tags). By default, such elements are ignored. |
15 |
| -bool fail_on_unsupported_element |
| 12 | +bool fail_on_unsupported_element # Fail on unsupported elements (such as SDFormat sub-tags). By default, such elements are ignored. |
16 | 13 |
|
17 |
| -# Ignore missing or unsupported assets. By default, missing or unsupported assets result in failure. |
18 |
| -bool ignore_missing_or_unsupported_assets |
| 14 | + |
| 15 | +bool ignore_missing_or_unsupported_assets # Ignore missing or unsupported assets. By default, missing or unsupported assets result in failure. |
19 | 16 |
|
20 | 17 | ---
|
21 | 18 |
|
22 |
| -uint8 UNSUPPORTED_FORMAT = 101 # Format for uri or resource string is unsupported. |
23 |
| -uint8 NO_RESOURCE = 102 # Both uri and resource string are empty. |
24 |
| -uint8 RESOURCE_PARSE_ERROR = 103 # Resource file or string failed to parse. |
25 |
| -uint8 MISSING_ASSETS = 104 # At least one of resource assets (such as meshes) was not found. |
26 |
| -uint8 UNSUPPORTED_ASSETS = 105 # At least one of resource assets (such as meshes) is not supported. |
27 |
| -uint8 UNSUPPORTED_ELEMENTS = 106 # At least one of world definition elements such as format tags is unsupported. |
| 19 | +uint8 UNSUPPORTED_FORMAT = 101 # Format for uri or resource string is unsupported. |
| 20 | +uint8 NO_RESOURCE = 102 # Both uri and resource string are empty. |
| 21 | +uint8 RESOURCE_PARSE_ERROR = 103 # Resource file or string failed to parse. |
| 22 | +uint8 MISSING_ASSETS = 104 # At least one of resource assets (such as meshes) was not found. |
| 23 | +uint8 UNSUPPORTED_ASSETS = 105 # At least one of resource assets (such as meshes) is not supported. |
| 24 | +uint8 UNSUPPORTED_ELEMENTS = 106 # At least one of world definition elements such as format tags is unsupported. |
| 25 | + |
28 | 26 |
|
29 |
| -# Standard result message |
30 |
| -Result result |
| 27 | +Result result # Standard result message |
31 | 28 |
|
32 |
| -# Information about the loaded world. Only valid if result is RESULT_OK. |
33 |
| -WorldResource world |
| 29 | +WorldResource world # Information about the loaded world. Only valid if result is RESULT_OK. |
0 commit comments