Skip to content

Commit f3836aa

Browse files
committed
add info to readme
Signed-off-by: Wojciech Czerski <[email protected]>
1 parent a2a1d5f commit f3836aa

File tree

1 file changed

+12
-2
lines changed

1 file changed

+12
-2
lines changed

readme.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,18 @@ Useful for robots' movement smoothing.
8181
Component that spawns prefabs using coordinates stored in CSV file. It supports XYZ format as well as WGS84 coordinate system.
8282
![](doc/CsvSpawner.png)
8383

84+
## API
85+
This Gem has defined notification bus - `CsvSpawnerNotificationBus`.
86+
87+
Available functions:
88+
89+
| Name | Parameters | Description |
90+
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|
91+
| `OnEntitiesSpawnBegin` | `SpawnInfo` - Struct holding information about entities to be spawned | Called when entity spawning begins. |
92+
| `OnEntitiesSpawnFinished` | `SpawnInfo` - Struct holding information about entities to be spawned</br>`SpawnStatus` - Status code of the spawn (success, warnings, fail). | Called when entity spawning finishes. |
93+
94+
> *Supports **Lua** and **Script Canvas***
95+
8496
## Load object from CSV file
8597

8698
CSV file format for coordinates in XYZ system:
@@ -93,7 +105,6 @@ x y z name
93105
5.1 65 0 object_name
94106
5.1 72 0 object_name
95107
5.1 79 0 object_name
96-
97108
```
98109

99110
CSV file format for coordinates in WGS84 system:
@@ -106,7 +117,6 @@ alt lat lon name
106117
0 12.5897180240288 30.1932813604207 ball
107118
0 12.5897414039641 30.1933370085065 ball
108119
0 12.5897646831551 30.1933927129084 ball
109-
110120
```
111121

112122
# ExposeConsoleToRos

0 commit comments

Comments
 (0)