This contains the source code documentation of the class DialogicAutoSkip.
DialogicAutoSkip
Inherits: RefCounted
This class holds the settings for the Auto-Skip feature. Changing the variables will alter the behaviour of Auto-Skip.
Description
Auto-Skip must be implemented per event.
Properties
| Name | Type | Default |
|---|---|---|
| enabled | bool | false |
| disable_on_user_input | bool | true |
| disable_on_unread_text | bool | false |
| enable_on_visited | bool | false |
| skip_voice | bool | true |
| time_per_event | float | 0.1 |
Signals
signal toggled ( is_enabled: bool )
Emitted whenever the Auto-Skip state changes, from true to false or vice-versa.
Property Descriptions
Whether Auto-Skip is enabled or not. If Auto-Skip is referred to be disabled[/i], it refers to setting this this variable to false. This variable will automatically emit autoskip_changed when changed.
var disable_on_user_input = true
If true, Auto-Skip will be disabled when the user presses a recognised input action.
var disable_on_unread_text = false
If true, Auto-Skip will be disabled when the timeline advances to a unread Text event or an event requesting user input.
If true, Auto-Skip will be enabled when the timeline advances to a previously visited Text event. Useful if the player always wants to skip already-visited Text events.
If true, Auto-Skip will skip Voice events instead of playing them.
The amount of seconds each event may take. This is not enforced, each event must implement this behaviour.