update docs

This commit is contained in:
Piotr 'pwh' Hanusiak
2022-04-12 15:02:01 +02:00
parent 480277df60
commit 35964cdb5b
4 changed files with 28 additions and 24 deletions
+6 -4
View File
@@ -9,8 +9,9 @@ On your map, you can define special silent zones where nobody is allowed to talk
In order to create a silent zone:
* You must create a specific layer.
* In layer properties, you MUST add a boolean "`silent`" property. If the silent property is checked, the users are entering the silent zone when they walk on any tile of the layer.
* You must create a specific object.
* Object must be of type "`area`"
* In object properties, you MUST add a boolean "`silent`" property. If the silent property is checked, the users are entering the silent zone when they walk on the area.
## Playing sounds or background music
@@ -18,8 +19,9 @@ Your map can define special zones where a sound or background music will automat
In order to create a zone that triggers sounds/music:
* You must create a specific layer.
* In layer properties, you MUST add a "`playAudio`" property. The value of the property is a URL to an MP3 file that will be played. The URL can be relative to the URL of the map.
* You must create a specific object.
* Object must be of type "`area`"
* In object properties, you MUST add a "`playAudio`" property. The value of the property is a URL to an MP3 file that will be played. The URL can be relative to the URL of the map.
* You may use the boolean property "`audioLoop`" to make the sound loop (thanks captain obvious).
* If the "`audioVolume`" property is set, the audio player uses either the value of the property or the last volume set by the user - whichever is smaller. This property is a float from 0 to 1.0