player_vars:
This is a config file reference. Click for instructions.
This page is reference material which explains every setting and option for this section of an MPF yaml config file. See the instructions for config files for formatting and other details. See our guide to config file examples for more examples of real configs in action.
| Valid in | |
|---|---|
| machine config files | YES  |
| mode config files | NO  |
The player_vars: section of your machine-wide config file lets you
specify the initial state of player variables that are set for a player
when the game starts.
Required settings
The following sections are required in the player_vars: section of
your config:
initial_value:
Single value, type: string. Defaults to empty.
The initial value of this player variable that you're setting. This is set when the player is created.
Optional settings
The following sections are optional in the player_vars: section of
your config. (If you don't include them, the default will be used).
value_type:
Single value, type: one of the following options: str, float, int.
Default: int
Select one of the options from this list: int (integer), float, or
str (string). The default is "int", and there is no intelligence to
try to detect which type of value you have, so if you have a floating
point number or a string, you also need to set the value_type.
Related How To guides
Something missing or wrong? You can fix it!
This website is edited by people like you! Is something wrong or missing? Is something out of date, or can you explain it better?
Please help us! You can fix it yourself and be an official "open source" contributor!
It's easy! See our Beginner's guide to editing the docs.
Page navigation via the keyboard: < >
You can navigate this site via the keyboard. There are two modes:
General navigation, when search is not focused:
- F , S , / : open search dialog
- P , , : go to previous page
- N , . : go to next page
While using the search function:
- Down , Up : select next / previous result
- Esc , Tab : close search
- Enter : go to highlighted page in the results