Skip to content

Commit 61fc9aa

Browse files
committed
add info to readme
Signed-off-by: Wojciech Czerski <[email protected]>
1 parent 75e3739 commit 61fc9aa

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
@@ -86,6 +86,18 @@ Useful for robots' movement smoothing.
8686
Component that spawns prefabs using coordinates stored in CSV file. It supports XYZ format as well as WGS84 coordinate system.
8787
![](doc/CsvSpawner.png)
8888

89+
## API
90+
This Gem has defined notification bus - `CsvSpawnerNotificationBus`.
91+
92+
Available functions:
93+
94+
| Name | Parameters | Description |
95+
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------|
96+
| `OnEntitiesSpawnBegin` | `SpawnInfo` - Struct holding information about entities to be spawned | Called when entity spawning begins. |
97+
| `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. |
98+
99+
> *Supports **Lua** and **Script Canvas***
100+
89101
## Load object from CSV file
90102

91103
CSV file format for coordinates in XYZ system:
@@ -98,7 +110,6 @@ x y z name
98110
5.1 65 0 object_name
99111
5.1 72 0 object_name
100112
5.1 79 0 object_name
101-
102113
```
103114

104115
CSV file format for coordinates in WGS84 system:
@@ -111,7 +122,6 @@ alt lat lon name
111122
0 12.5897180240288 30.1932813604207 ball
112123
0 12.5897414039641 30.1933370085065 ball
113124
0 12.5897646831551 30.1933927129084 ball
114-
115125
```
116126

117127
# ExposeConsoleToRos

0 commit comments

Comments
 (0)