workadventure/docs/maps/api-camera.md

25 lines
866 B
Markdown
Raw Normal View History

2021-11-23 17:39:45 +01:00
{.section-title.accent.text-primary}
# API Camera functions Reference
### Listen to camera updates
2021-11-23 17:39:45 +01:00
```
2022-01-03 10:36:23 +01:00
WA.camera.onCameraUpdate: Subscription
2021-11-23 17:39:45 +01:00
```
Listens to updates of the camera viewport. It will trigger for every update of the camera's properties (position or scale for instance). An event will be sent.
2021-11-23 17:39:45 +01:00
The event has the following attributes :
* **x (number):** coordinate X of the camera's world view (the area looked at by the camera).
* **y (number):** coordinate Y of the camera's world view.
* **width (number):** the width of the camera's world view.
* **height (number):** the height of the camera's world view.
**callback:** the function that will be called when the camera is updated.
Example :
```javascript
2022-01-03 10:36:23 +01:00
WA.camera.onCameraUpdate.subscribe((worldView) => console.log(worldView));
//later...
WA.camera.onCameraUpdate().unsubscribe();
2021-11-23 17:39:45 +01:00
```