Allow player to pause and speed up time.

Author: telrikk

entities/time_component.gd

@@ -1,16 +1,36 @@
 extends Node2D
+class_name TimeComponent
 
 @onready var view_model = TimerViewModel.new()
 
-var time_since_last_update = 0
-var time = Time.get_unix_time_from_system()
+@export var day_update_interval_seconds: int = 1
+@export var default_speed: float = 1
+@export var fast_speed: float = 3
+
+var time_since_last_update: float = 0
+var time: float = Time.get_unix_time_from_system()
+var is_paused: bool = false
+var speed: float = default_speed
 
 func _ready():
+	view_model.initialize(self)
 	ViewModelRegistry.register(ViewModelRegistry.Keys.TIMER, view_model)
 
-func _process(delta: float): 
+func _process(delta: float):
+	if is_paused:
+		return
+	 
 	time_since_last_update += delta 
-	if time_since_last_update > 1:
+	if time_since_last_update > (day_update_interval_seconds / speed):
 		time_since_last_update = 0
 		time += 86400 # seconds in a day
 		view_model.set_time(time)
+
+func toggle_paused():
+	is_paused = !is_paused
+
+func toggle_speed_up():
+	if speed == default_speed: 
+		speed = fast_speed
+	else:
+		speed = default_speed 

scenes/common/player_controller.tscn

@@ -1,19 +1,11 @@
-[gd_scene load_steps=8 format=3 uid="uid://2hgdqurtbrxg"]
+[gd_scene load_steps=4 format=3 uid="uid://2hgdqurtbrxg"]
 
 [ext_resource type="Script" path="res://scripts/controllers/player_controller.gd" id="1_86wpr"]
 [ext_resource type="Texture2D" uid="uid://p0bi3bytr53n" path="res://vendor/kenney_cursor-pack/PNG/Outline/Default/hand_closed.png" id="2_tvrf7"]
 [ext_resource type="Texture2D" uid="uid://h7bopucdukak" path="res://vendor/kenney_cursor-pack/PNG/Outline/Default/pointer_b.png" id="3_h3cn0"]
-[ext_resource type="Texture2D" uid="uid://bjck8jhfqnq0b" path="res://vendor/kenney_cursor-pack/PNG/Outline/Double/arrow_e.png" id="4_sg2mc"]
-[ext_resource type="Texture2D" uid="uid://duld2c16y04fr" path="res://vendor/kenney_cursor-pack/PNG/Outline/Double/arrow_n.png" id="5_x6eqs"]
-[ext_resource type="Texture2D" uid="uid://ovblhumn68fu" path="res://vendor/kenney_cursor-pack/PNG/Outline/Double/arrow_s.png" id="6_c3rid"]
-[ext_resource type="Texture2D" uid="uid://bxw018pmva53p" path="res://vendor/kenney_cursor-pack/PNG/Outline/Double/arrow_w.png" id="7_gew4c"]
 
 [node name="PlayerController" type="Node2D"]
 script = ExtResource("1_86wpr")
 mouse_drag_scroll_speed = 0.7
 drag_icon = ExtResource("2_tvrf7")
 arrow_icon = ExtResource("3_h3cn0")
-scroll_east_icon = ExtResource("4_sg2mc")
-scroll_north_icon = ExtResource("5_x6eqs")
-scroll_south_icon = ExtResource("6_c3rid")
-scroll_west_icon = ExtResource("7_gew4c")

scripts/controllers/player_controller.gd

@@ -2,14 +2,9 @@ extends Node2D
 
 @export var keyboard_scroll_speed: float = 7
 @export var mouse_drag_scroll_speed: float = 1.5 
-@export var mouse_edge_scroll_speed: float = 6
 @export var mouse_scroll_threshold: float = 50 # how many pixels from the sides of the screen triggers a mouse scroll
 @export var drag_icon: Texture2D
 @export var arrow_icon: Texture2D
-@export var scroll_east_icon: Texture2D
-@export var scroll_north_icon: Texture2D
-@export var scroll_south_icon: Texture2D
-@export var scroll_west_icon: Texture2D
 @export var hud: Control
 @export var camera_component: CameraComponent
 var is_dragging: bool = false
@@ -18,7 +13,7 @@ func _ready():
 	Input.mouse_mode = Input.MOUSE_MODE_CONFINED
 	Input.set_custom_mouse_cursor(arrow_icon, Input.CURSOR_ARROW)
 
-func _input(event):
+func _unhandled_input(event: InputEvent) -> void:
 	if event.is_action_pressed("start_drag"):
 		Input.set_custom_mouse_cursor(drag_icon, Input.CURSOR_DRAG)
 		is_dragging = true
@@ -42,33 +37,5 @@ func _process(_delta: float) -> void:
 		camera_movement += Vector2.UP * keyboard_scroll_speed
 	elif Input.is_action_pressed("move_map_down"):
 		camera_movement += Vector2.DOWN * keyboard_scroll_speed
-	
-	var max_x = get_viewport_rect().size.x
-	var max_y = get_viewport_rect().size.y
-	var mouse_global_position = get_viewport().get_mouse_position()
-	if mouse_global_position.x <= mouse_scroll_threshold:
-		scroll_and_set_cursor(Vector2.LEFT)
-	elif mouse_global_position.y <= mouse_scroll_threshold:
-		scroll_and_set_cursor(Vector2.UP)
-	elif mouse_global_position.y >= max_y - mouse_scroll_threshold:
-		scroll_and_set_cursor(Vector2.DOWN)
-	elif mouse_global_position.x >= max_x - mouse_scroll_threshold:
-		scroll_and_set_cursor(Vector2.RIGHT)
-	elif !is_dragging:
-		hud.mouse_default_cursor_shape = Control.CURSOR_ARROW
 
 	camera_component.apply_camera_movement(camera_movement)
-
-func scroll_and_set_cursor(direction: Vector2):
-	match direction:
-		Vector2.LEFT:
-			Input.set_custom_mouse_cursor(scroll_west_icon, Input.CURSOR_MOVE)
-		Vector2.RIGHT:
-			Input.set_custom_mouse_cursor(scroll_east_icon, Input.CURSOR_MOVE)
-		Vector2.DOWN:
-			Input.set_custom_mouse_cursor(scroll_south_icon, Input.CURSOR_MOVE)
-		Vector2.UP:
-			Input.set_custom_mouse_cursor(scroll_north_icon, Input.CURSOR_MOVE)
-			
-	hud.mouse_default_cursor_shape = Control.CURSOR_MOVE
-	camera_component.apply_camera_movement(direction * mouse_edge_scroll_speed)

ui/viewmodels/vm_timer.gd

@@ -3,6 +3,17 @@ class_name TimerViewModel
 
 signal on_formatted_time_updated (new_time: String)
 
+var time_component: TimeComponent
+
+func initialize(new_time_component: TimeComponent):
+	time_component = new_time_component
+	
+func toggle_paused():
+	time_component.toggle_paused()
+	
+func toggle_speed_up():
+	time_component.toggle_speed_up()
+
 func set_time(new_timestamp: int):
 	var now_dict := Time.get_datetime_dict_from_unix_time(new_timestamp)
 	var formatted_datetime = _format_datetime(now_dict)

ui/widgets/GameTimeLabel.gd

@@ -11,6 +11,7 @@ grow_horizontal = 2
 grow_vertical = 2
 size_flags_horizontal = 3
 size_flags_vertical = 3
+mouse_filter = 1
 
 [node name="TopAppBar" parent="." instance=ExtResource("1_kowid")]
 layout_mode = 1

ui/widgets/hud.tscn

@@ -0,0 +1,22 @@
+extends Control
+
+var view_model: TimerViewModel
+
+@export var date_label: Label
+@export var pause_button: TextureButton
+@export var speed_up_button: TextureButton
+
+func _ready() -> void:
+	view_model = ViewModelRegistry.retrieve(ViewModelRegistry.Keys.TIMER) as TimerViewModel
+	view_model.on_formatted_time_updated.connect(_handle_formatted_datetime_changed)
+	pause_button.toggled.connect(_handle_pause_button_clicked)
+	speed_up_button.toggled.connect(_handle_speed_up_button_clicked)
+	
+func _handle_formatted_datetime_changed(new_datetime: String):
+	date_label.text = new_datetime
+	
+func _handle_pause_button_clicked(_is_toggled: bool):
+	view_model.toggle_paused()
+
+func _handle_speed_up_button_clicked(_is_toggled: bool):
+	view_model.toggle_speed_up()

ui/widgets/top_app_bar.gd

@@ -1,15 +1,23 @@
-[gd_scene load_steps=4 format=3 uid="uid://ci04dr1xobg8"]
+[gd_scene load_steps=8 format=3 uid="uid://ci04dr1xobg8"]
 
+[ext_resource type="Script" path="res://ui/widgets/top_app_bar.gd" id="1_7s546"]
 [ext_resource type="Theme" uid="uid://dxgsaua2q7y8i" path="res://ui/themes/hud.tres" id="2_7qrg5"]
-[ext_resource type="Script" path="res://ui/widgets/GameTimeLabel.gd" id="3_08rmb"]
 [ext_resource type="Texture2D" uid="uid://uwdw62p64s6" path="res://vendor/kenney_ui-pack-pixel-adventure/Tiles/Large tiles/Thick outline/tile_0028.png" id="3_rb1vo"]
+[ext_resource type="Texture2D" uid="uid://bef8hwvllnbmj" path="res://vendor/kenney_game-icons/PNG/White/1x/pause.png" id="4_vima0"]
+[ext_resource type="Texture2D" uid="uid://dxfxxwbmub6bx" path="res://vendor/kenney_game-icons/PNG/Black/1x/pause.png" id="5_cqa4u"]
+[ext_resource type="Texture2D" uid="uid://sjhcl4wxcwkn" path="res://vendor/kenney_game-icons/PNG/White/1x/fastForward.png" id="6_bwov5"]
+[ext_resource type="Texture2D" uid="uid://cqs1r264rxtpc" path="res://vendor/kenney_game-icons/PNG/Black/1x/fastForward.png" id="7_tcu34"]
 
-[node name="TopAppBar" type="Control"]
+[node name="TopAppBar" type="Control" node_paths=PackedStringArray("date_label", "pause_button", "speed_up_button")]
 layout_mode = 3
 anchors_preset = 10
 anchor_right = 1.0
-offset_bottom = 50.0
 grow_horizontal = 2
+mouse_filter = 2
+script = ExtResource("1_7s546")
+date_label = NodePath("HBoxContainer/GameTimeLabel")
+pause_button = NodePath("HBoxContainer/PauseButton")
+speed_up_button = NodePath("HBoxContainer/SpeedUpButton")
 
 [node name="Background" type="NinePatchRect" parent="."]
 layout_mode = 1
@@ -23,18 +31,32 @@ patch_margin_top = 11
 patch_margin_right = 11
 patch_margin_bottom = 11
 
-[node name="GameTimeLabel" type="Label" parent="Background"]
+[node name="HBoxContainer" type="HBoxContainer" parent="."]
 layout_mode = 1
-anchors_preset = 6
+anchors_preset = -1
 anchor_left = 1.0
-anchor_top = 0.5
 anchor_right = 1.0
-anchor_bottom = 0.5
-offset_left = -157.0
-offset_top = -12.0
-offset_bottom = 12.0
+offset_left = -189.0
+offset_right = -15.0
+offset_bottom = 50.0
 grow_horizontal = 0
-grow_vertical = 2
+mouse_filter = 2
+
+[node name="GameTimeLabel" type="Label" parent="HBoxContainer"]
+layout_mode = 2
 theme = ExtResource("2_7qrg5")
 text = "January 1st, 2022"
-script = ExtResource("3_08rmb")
+
+[node name="PauseButton" type="TextureButton" parent="HBoxContainer"]
+layout_mode = 2
+mouse_filter = 1
+toggle_mode = true
+texture_normal = ExtResource("4_vima0")
+texture_pressed = ExtResource("5_cqa4u")
+
+[node name="SpeedUpButton" type="TextureButton" parent="HBoxContainer"]
+layout_mode = 2
+mouse_filter = 1
+toggle_mode = true
+texture_normal = ExtResource("6_bwov5")
+texture_pressed = ExtResource("7_tcu34")

ui/widgets/top_app_bar.tscn

@@ -0,0 +1,34 @@
+[remap]
+
+importer="texture"
+type="CompressedTexture2D"
+uid="uid://df4eacllqsgpk"
+path="res://.godot/imported/arrowDown.png-1fd1fb734e065a0f923f7caf8e7aa1bd.ctex"
+metadata={
+"vram_texture": false
+}
+
+[deps]
+
+source_file="res://vendor/kenney_game-icons/PNG/Black/1x/arrowDown.png"
+dest_files=["res://.godot/imported/arrowDown.png-1fd1fb734e065a0f923f7caf8e7aa1bd.ctex"]
+
+[params]
+
+compress/mode=0
+compress/high_quality=false
+compress/lossy_quality=0.7
+compress/hdr_compression=1
+compress/normal_map=0
+compress/channel_pack=0
+mipmaps/generate=false
+mipmaps/limit=-1
+roughness/mode=0
+roughness/src_normal=""
+process/fix_alpha_border=true
+process/premult_alpha=false
+process/normal_map_invert_y=false
+process/hdr_as_srgb=false
+process/hdr_clamp_exposure=false
+process/size_limit=0
+detect_3d/compress_to=1