Update Documentation/Mapping File authored by Marius Schmeling's avatar Marius Schmeling
## Description
This file is for easier mapping of symbols to directivities. This can for example be used to map phonemes to specific directivities.
## Usage
**Editor**
The mapping file can be set at the Receiver actors settings.
**Runtime**
* `FVAReceiverActor::ReadDirMappingFile(FString)`
* Reads in a new Mapping file, deleting the old one
* `FVASoundSourceComponent::SetDirectivityByMapping(FString)`
* Sets the Directivity the given Symbol is mapped to
## Formation and example file
**Rules for the file**
* The file has to start with `[DirectivityMapping]` for the Plugin to detect the data
* Comments can be created by using `#` followed by the comment
* e.g. `# This is a comment`
* The char declared for `ListSymbol` is the char which will be used to list all the symbols mapped on the Directivity
* e.g. `ListSymbol=,` to use `,` as dividing char for the list
* The char declared for `mapToSymbol` is the char which will be used to map the list of symbols to a specific Directivity
* e.g. `MapToSymbol=:` to use `:` as mapping Symbol
* ListSymbol and MapToSymbol have to be different Symbols and not "=" and are not allowed do be used in the symbol-list or in the Name of the Directivity
* To add a mapping use `mapping=` followed by the mapping
* e.g. `Mapping=d,e:Singer.v17.ms.daff`
* The Keyword `default`in the phonemes list declares that this Directivity is the Default Directivity, used whenever there is no mapping for a Symbol can be found or a Directivity is used which cannot be created.
* e.g. `mapping=default:$(HumanDir)`
**Example file**
```
[DirectivityMapping]
# Symbol the list is devided (default: ",")
ListSymbol=,
# Symbol the mapping is done (default ":")
MapToSymbol=:
# Mapping in form:
# Mapping=phoneme1,phoeneme2,phoneme3:file1
# Mapping=default,phoneme4:file2
# default = used when something cannot be found
Mapping=a,b,default:$(HumanDir)
Mapping=c,d:Singer.v17.ms.daff
```