Skip to content

Commit

Permalink
Improved segment_display_player reference
Browse files Browse the repository at this point in the history
  • Loading branch information
worldpeace-germany committed Aug 16, 2024
1 parent e39c35b commit 47358f1
Showing 1 changed file with 31 additions and 8 deletions.
39 changes: 31 additions & 8 deletions docs/config/segment_display_player.md
Original file line number Diff line number Diff line change
Expand Up @@ -96,35 +96,35 @@ Only used with the `add` action.
Single value, type: `string`. Defaults to empty.

Key to use with `action` `add` and `remove` to reference a text on the
segment display.
segment display. Only relevant if [segment_displays](segment_displays.md) `update_method` is `stack`, not being
used if `replace` is used.

### priority:

Single value, type: int_or_token. Default: `0`

Priority of this text. The segment display will maintain a stack and
show the text on top (highest priority).
show the text on top (highest priority). Only relevant if [segment_displays](segment_displays.md) `update_method` is `stack`, not being
used if `replace` is used.

### text:

Single value, type: `string`. Defaults to empty.

Text to show. You can use
[Text Templates](instructions/text_templates.md).
Text to show. You can use [Text Templates](instructions/text_templates.md).
To erase the text on a display simply send an empty string "".

### transition:

Unknown type. See description below.
Note, that if you have set a duration in a show, that this duration **in**cludes the time for the incoming transition.

!!! note

Be sure the `segment_display` `size` parameter has been properly set for
the segment display or the transition effects may not be calculated and
displayed properly.

### transition_out:

Unknown type. See description below.
Example:

``` mpf-config
#! segment_displays:
Expand All @@ -146,6 +146,29 @@ segment_display_player:
text: " *** "
```

#### type

The type of animation to be used.

* push
* cover
* uncover
* split
* wipe

#### direction

The direction of the animation, for type `push`, `cover`, `uncover` and `wipe` value can be either `left` or `right` (default). For split the value can be `in` or `out` (default).

#### text

_Additonal_ text used in animation, if not set only the show text will be used.


### transition_out:

Note, that if you have set a duration in a show, that this duration **ex**cludes the time for the outgoing transition. For anything else see above on the `transition` section.

There can only be one transition between text entries, so if outgoing
text has a `transition_out` set, and an incoming text entry has a
`transition` set, then the incoming transition will take precedence.
Expand Down

0 comments on commit 47358f1

Please sign in to comment.