Kraut.World/server
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

FIX: removed incorrect documentation

Browse source
This commit is contained in:
kharhamel 2021-07-15 18:23:40 +02:00
parent f2ca7b2b16
commit c5587600ba
2 changed files with 0 additions and 37 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/maps/api-room.md
View file

@ -79,26 +79,6 @@ Example :
WA.room.setProperty('wikiLayer', 'openWebsite', 'https://www.wikipedia.org/');
```
### Getting information on the current room
```
WA.room.getCurrentRoom(): Promise<Room>
```
Return a promise that resolves to a `Room` object with the following attributes :
* **id (string) :** ID of the current room
* **map (ITiledMap) :** contains the JSON map file with the properties that were set by the script if `setProperty` was called.
* **mapUrl (string) :** Url of the JSON map file
* **startLayer (string | null) :** Name of the layer where the current user started, only if different from `start` layer
Example :
```javascript
WA.room.getCurrentRoom((room) => {
if (room.id === '42') {
console.log(room.map);
window.open(room.mapUrl, '_blank');
}
})
```
### Changing tiles
```
WA.room.setTiles(tiles: TileDescriptor[]): void