You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
72 lines
2.3 KiB
72 lines
2.3 KiB
6 months ago
|
extends RefCounted
|
||
|
|
class_name DialogicAutoSkip
|
||
|
|
## This class holds the settings for the Auto-Skip feature.
|
||
|
|
## Changing the variables will alter the behaviour of Auto-Skip.
|
||
|
|
##
|
||
|
|
## Auto-Skip must be implemented per event.
|
||
|
|
|
||
|
|
## Emitted whenever the Auto-Skip state changes, from `true` to `false` or
|
||
|
|
## vice-versa.
|
||
|
|
signal toggled(is_enabled: bool)
|
||
|
|
|
||
|
|
## Whether Auto-Skip is enabled or not.
|
||
|
|
## If Auto-Skip is referred to be [i]disabled[/i], it refers to setting this
|
||
|
|
## this variable to `false`.
|
||
|
|
## This variable will automatically emit [signal autoskip_changed] when changed.
|
||
|
|
var enabled: bool = false : set = _set_enabled
|
||
|
|
|
||
|
|
## If `true`, Auto-Skip will be disabled when the user presses a recognised
|
||
|
|
## input action.
|
||
|
|
var disable_on_user_input: bool = true
|
||
|
|
|
||
|
|
## If `true`, Auto-Skip will be disabled when the timeline advances to a
|
||
|
|
## unread Text event or an event requesting user input.
|
||
|
|
var disable_on_unread_text: bool = true
|
||
|
|
|
||
|
|
## 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.
|
||
|
|
var enable_on_visited: bool = true
|
||
|
|
|
||
|
|
## If `true`, Auto-Skip will skip Voice events instead of playing them.
|
||
|
|
var skip_voice: bool = true
|
||
|
|
|
||
|
|
## The amount of seconds each event may take.
|
||
|
|
## This is not enforced, each event must implement this behaviour.
|
||
|
|
var time_per_event: float = 0.1
|
||
|
|
|
||
|
|
|
||
|
|
## Setting up Auto-Skip.
|
||
|
|
func _init() -> void:
|
||
|
|
enable_on_visited = ProjectSettings.get_setting('dialogic/text/autoskip_enabled', enable_on_visited)
|
||
|
|
time_per_event = ProjectSettings.get_setting('dialogic/text/autoskip_time_per_event', time_per_event)
|
||
|
|
|
||
|
|
if DialogicUtil.autoload().has_subsystem('History'):
|
||
|
|
DialogicUtil.autoload().History.visited_event.connect(_handle_seen_event)
|
||
|
|
DialogicUtil.autoload().History.unvisited_event.connect(_handle_unseen_event)
|
||
|
|
|
||
|
|
|
||
|
|
## Called when Auto-Skip is enabled or disabled.
|
||
|
|
## Emits [signal autoskip_changed] if the state changed.
|
||
|
|
func _set_enabled(is_enabled: bool) -> void:
|
||
|
|
var previous_enabled := enabled
|
||
|
|
enabled = is_enabled
|
||
|
|
|
||
|
|
if enabled != previous_enabled:
|
||
|
|
toggled.emit(enabled)
|
||
|
|
|
||
|
|
|
||
|
|
func _handle_seen_event() -> void:
|
||
|
|
# If Auto-Skip is disabled but reacts to seen events, we
|
||
|
|
# enable Auto-Skip.
|
||
|
|
if not enabled and enable_on_visited:
|
||
|
|
enabled = true
|
||
|
|
|
||
|
|
|
||
|
|
func _handle_unseen_event() -> void:
|
||
|
|
if not enabled:
|
||
|
|
return
|
||
|
|
|
||
|
|
if disable_on_unread_text:
|
||
|
|
enabled = false
|