Change cursor when the map is being scrolled.

Author: telrikk

scenes/common/player_controller.tscn

@@ -1,7 +1,19 @@
-[gd_scene load_steps=2 format=3 uid="uid://2hgdqurtbrxg"]
+[gd_scene load_steps=8 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")

scenes/main/main.tscn

@@ -1,7 +1,25 @@
-[gd_scene load_steps=2 format=3 uid="uid://d3nj6rt0cm53e"]
+[gd_scene load_steps=5 format=3 uid="uid://d3nj6rt0cm53e"]
 
 [ext_resource type="PackedScene" uid="uid://xlfbl7fowoic" path="res://scenes/worldmap/world_map.tscn" id="1_cjno1"]
+[ext_resource type="PackedScene" uid="uid://bnqxch8qylr8l" path="res://ui/widgets/hud.tscn" id="2_jggq6"]
+[ext_resource type="PackedScene" uid="uid://2hgdqurtbrxg" path="res://scenes/common/player_controller.tscn" id="3_jr0xa"]
+[ext_resource type="PackedScene" uid="uid://dcnty7qxod06" path="res://scenes/components/camera_component.tscn" id="4_xha1d"]
 
 [node name="World" type="Node2D"]
 
 [node name="WorldMap" parent="." instance=ExtResource("1_cjno1")]
+position = Vector2(0, 1)
+
+[node name="CanvasLayer" type="CanvasLayer" parent="."]
+
+[node name="HUD" parent="CanvasLayer" instance=ExtResource("2_jggq6")]
+
+[node name="Controllers" type="Node" parent="."]
+
+[node name="PlayerController" parent="Controllers" node_paths=PackedStringArray("hud", "camera_component") instance=ExtResource("3_jr0xa")]
+hud = NodePath("../../CanvasLayer/HUD")
+camera_component = NodePath("../../Components/CameraComponent")
+
+[node name="Components" type="Node" parent="."]
+
+[node name="CameraComponent" parent="Components" instance=ExtResource("4_xha1d")]

scenes/worldmap/world_map.tscn

@@ -1,21 +1,10 @@
-[gd_scene load_steps=4 format=3 uid="uid://xlfbl7fowoic"]
+[gd_scene load_steps=2 format=3 uid="uid://xlfbl7fowoic"]
 
 [ext_resource type="Texture2D" uid="uid://dy5vfc6jr3l4i" path="res://vendor/Double C's Pixel World Map/3x Size/All_3x/PixelWorldMap_All_Countries_3x.png" id="1_kd50k"]
-[ext_resource type="PackedScene" uid="uid://2hgdqurtbrxg" path="res://scenes/common/player_controller.tscn" id="2_bjhnr"]
-[ext_resource type="PackedScene" uid="uid://dcnty7qxod06" path="res://scenes/components/camera_component.tscn" id="3_f33gq"]
 
 [node name="WorldMap" type="Node2D"]
 
 [node name="WorldMapImage" type="TextureRect" parent="."]
 offset_right = 40.0
 offset_bottom = 40.0
 texture = ExtResource("1_kd50k")
-
-[node name="Controllers" type="Node" parent="."]
-
-[node name="PlayerController" parent="Controllers" node_paths=PackedStringArray("camera_component") instance=ExtResource("2_bjhnr")]
-camera_component = NodePath("../../Components/CameraComponent")
-
-[node name="Components" type="Node" parent="."]
-
-[node name="CameraComponent" parent="Components" instance=ExtResource("3_f33gq")]

scripts/controllers/player_controller.gd

@@ -4,23 +4,33 @@ extends Node2D
 @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
 
 func _ready():
 	Input.mouse_mode = Input.MOUSE_MODE_CONFINED
+	Input.set_custom_mouse_cursor(arrow_icon, Input.CURSOR_ARROW)
 
 func _input(event):
 	if event.is_action_pressed("start_drag"):
+		Input.set_custom_mouse_cursor(drag_icon, Input.CURSOR_DRAG)
 		is_dragging = true
+		hud.mouse_default_cursor_shape = Control.CURSOR_DRAG
 	elif event.is_action_released("start_drag"):
 		is_dragging = false
+		hud.mouse_default_cursor_shape = Control.CURSOR_ARROW
 
 	if event is InputEventMouseMotion and is_dragging:
 		camera_component.apply_camera_movement(event.relative * mouse_drag_scroll_speed)
-			
 
-func _process(delta: float) -> void:
+func _process(_delta: float) -> void:
 	var camera_movement := Vector2.ZERO
 
 	if Input.is_action_pressed("move_map_left"):
@@ -37,12 +47,28 @@ func _process(delta: float) -> void:
 	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:
-		camera_component.apply_camera_movement(Vector2.LEFT * mouse_edge_scroll_speed)
+		scroll_and_set_cursor(Vector2.LEFT)
 	elif mouse_global_position.y <= mouse_scroll_threshold:
-		camera_component.apply_camera_movement(Vector2.UP * mouse_edge_scroll_speed)
+		scroll_and_set_cursor(Vector2.UP)
 	elif mouse_global_position.y >= max_y - mouse_scroll_threshold:
-		camera_component.apply_camera_movement(Vector2.DOWN * mouse_edge_scroll_speed)
+		scroll_and_set_cursor(Vector2.DOWN)
 	elif mouse_global_position.x >= max_x - mouse_scroll_threshold:
-		camera_component.apply_camera_movement(Vector2.RIGHT * mouse_edge_scroll_speed)
+		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/fonts/lora/Lora-Italic-VariableFont_wght.ttf

@@ -0,0 +1,33 @@
+[remap]
+
+importer="font_data_dynamic"
+type="FontFile"
+uid="uid://bpwuvjqnnu722"
+path="res://.godot/imported/Lora-Italic-VariableFont_wght.ttf-5eea12e4558fc9ab5487d8bc45524162.fontdata"
+
+[deps]
+
+source_file="res://ui/fonts/lora/Lora-Italic-VariableFont_wght.ttf"
+dest_files=["res://.godot/imported/Lora-Italic-VariableFont_wght.ttf-5eea12e4558fc9ab5487d8bc45524162.fontdata"]
+
+[params]
+
+Rendering=null
+antialiasing=1
+generate_mipmaps=false
+multichannel_signed_distance_field=false
+msdf_pixel_range=8
+msdf_size=48
+allow_system_fallback=true
+force_autohinter=false
+hinting=1
+subpixel_positioning=1
+oversampling=0.0
+Fallbacks=null
+fallbacks=[]
+Compress=null
+compress=true
+preload=[]
+language_support={}
+script_support={}
+opentype_features={}

ui/fonts/lora/Lora-Italic-VariableFont_wght.ttf.import

@@ -0,0 +1,33 @@
+[remap]
+
+importer="font_data_dynamic"
+type="FontFile"
+uid="uid://8v41ay8s1ap5"
+path="res://.godot/imported/Lora-VariableFont_wght.ttf-796cb679087b03af2f2f172e699536d2.fontdata"
+
+[deps]
+
+source_file="res://ui/fonts/lora/Lora-VariableFont_wght.ttf"
+dest_files=["res://.godot/imported/Lora-VariableFont_wght.ttf-796cb679087b03af2f2f172e699536d2.fontdata"]
+
+[params]
+
+Rendering=null
+antialiasing=1
+generate_mipmaps=false
+multichannel_signed_distance_field=false
+msdf_pixel_range=8
+msdf_size=48
+allow_system_fallback=true
+force_autohinter=false
+hinting=1
+subpixel_positioning=1
+oversampling=0.0
+Fallbacks=null
+fallbacks=[]
+Compress=null
+compress=true
+preload=[]
+language_support={}
+script_support={}
+opentype_features={}

ui/fonts/lora/Lora-VariableFont_wght.ttf

@@ -0,0 +1,93 @@
+Copyright 2011 The Lora Project Authors (https://github.com/cyrealtype/Lora-Cyrillic), with Reserved Font Name "Lora".
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.

ui/fonts/lora/Lora-VariableFont_wght.ttf.import

@@ -0,0 +1,71 @@
+Lora Variable Font
+==================
+
+This download contains Lora as both variable fonts and static fonts.
+
+Lora is a variable font with this axis:
+  wght
+
+This means all the styles are contained in these files:
+  Lora/Lora-VariableFont_wght.ttf
+  Lora/Lora-Italic-VariableFont_wght.ttf
+
+If your app fully supports variable fonts, you can now pick intermediate styles
+that aren’t available as static fonts. Not all apps support variable fonts, and
+in those cases you can use the static font files for Lora:
+  Lora/static/Lora-Regular.ttf
+  Lora/static/Lora-Medium.ttf
+  Lora/static/Lora-SemiBold.ttf
+  Lora/static/Lora-Bold.ttf
+  Lora/static/Lora-Italic.ttf
+  Lora/static/Lora-MediumItalic.ttf
+  Lora/static/Lora-SemiBoldItalic.ttf
+  Lora/static/Lora-BoldItalic.ttf
+
+Get started
+-----------
+
+1. Install the font files you want to use
+
+2. Use your app's font picker to view the font family and all the
+available styles
+
+Learn more about variable fonts
+-------------------------------
+
+  https://developers.google.com/web/fundamentals/design-and-ux/typography/variable-fonts
+  https://variablefonts.typenetwork.com
+  https://medium.com/variable-fonts
+
+In desktop apps
+
+  https://theblog.adobe.com/can-variable-fonts-illustrator-cc
+  https://helpx.adobe.com/nz/photoshop/using/fonts.html#variable_fonts
+
+Online
+
+  https://developers.google.com/fonts/docs/getting_started
+  https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Fonts/Variable_Fonts_Guide
+  https://developer.microsoft.com/en-us/microsoft-edge/testdrive/demos/variable-fonts
+
+Installing fonts
+
+  MacOS: https://support.apple.com/en-us/HT201749
+  Linux: https://www.google.com/search?q=how+to+install+a+font+on+gnu%2Blinux
+  Windows: https://support.microsoft.com/en-us/help/314960/how-to-install-or-remove-a-font-in-windows
+
+Android Apps
+
+  https://developers.google.com/fonts/docs/android
+  https://developer.android.com/guide/topics/ui/look-and-feel/downloadable-fonts
+
+License
+-------
+Please read the full license text (OFL.txt) to understand the permissions,
+restrictions and requirements for usage, redistribution, and modification.
+
+You can use them in your products & projects – print or digital,
+commercial or otherwise.
+
+This isn't legal advice, please consider consulting a lawyer and see the full
+license for all details.