Merge branch 'feat/scoreboard' into 'develop'

Scoring and Scoreboard implemented

See merge request open-fpsz/open-fpsz!59

components/explosive_damage_component.gd

@@ -16,6 +16,7 @@ class_name ExplosiveDamageComponent extends Area3D
 
 @export var damage : int = 100
 @export var impulse_force : int = 1000
+var damage_dealer : Player
 
 func _physics_process(_delta : float) -> void:
 	for body in get_overlapping_bodies():
@@ -26,6 +27,6 @@ func _physics_process(_delta : float) -> void:
 
 	for area in get_overlapping_areas():
 		if area is HealthComponent and is_multiplayer_authority():
-			area.damage.rpc(damage)
+			area.damage.rpc(damage, damage_dealer.player_id)
 
 	set_physics_process(false)

components/health_component.gd

@@ -20,17 +20,17 @@ class_name HealthComponent extends Area3D
 		health = value
 		health_changed.emit(value)
 
-signal health_zeroed
+signal health_zeroed(killer_id : int)
 signal health_changed(value : float)
 
 func _ready() -> void:
 	heal_full()
 
 @rpc("call_local")
-func damage(amount : float) -> void:
+func damage(amount : float, damage_dealer_id : int) -> void:
 	health = clampf(health - amount, 0.0, max_health)
 	if health == 0.0:
-		health_zeroed.emit()
+		health_zeroed.emit(damage_dealer_id)
 
 @rpc("call_local")
 func _heal(amount : float) -> void:

entities/player/player.gd

@@ -55,7 +55,7 @@ enum PlayerState { PLAYER_ALIVE, PLAYER_DEAD }
 @onready var flag_carry_attachment : Node3D = $Smoothing/SpringArm3D/FlagCarryAttachment
 @onready var _game_settings : Settings = get_node("/root/GlobalSettings")
 
-signal died(player : Player)
+signal died(player : Player, killer_id : int)
 signal energy_changed(energy : float)
 
 var g : float = ProjectSettings.get_setting("physics/3d/default_gravity") # in m/s²
@@ -230,7 +230,7 @@ func _update_third_person_animations() -> void:
 func _is_player_dead() -> bool:
 	return player_state == PlayerState.PLAYER_DEAD
 
-func die() -> void:
+func die(killer_id : int) -> void:
 	player_state = PlayerState.PLAYER_DEAD
 	if _is_pawn():
 		animation_player.stop()
@@ -238,7 +238,7 @@ func die() -> void:
 	var tween : Tween = create_tween()
 	tween.tween_interval(4)
 	tween.tween_callback(func() -> void:
-		died.emit(self)
+		died.emit(self, killer_id)
 		if _is_pawn():
 			animation_player.stop()
 	)

entities/player/player.tscn

@@ -275,8 +275,9 @@ near = 0.1
 
 [node name="Inventory" type="Node3D" parent="Smoothing/SpringArm3D"]
 
-[node name="SpaceGun" parent="Smoothing/SpringArm3D/Inventory" instance=ExtResource("4_6jh57")]
+[node name="SpaceGun" parent="Smoothing/SpringArm3D/Inventory" node_paths=PackedStringArray("holder") instance=ExtResource("4_6jh57")]
 transform = Transform3D(-1, 0, 2.53518e-06, 0, 1, 0, -2.53518e-06, 0, -1, 0.15, -0.3, -0.2)
+holder = NodePath("../../../..")
 
 [node name="SpineIKTarget" type="Node3D" parent="Smoothing/SpringArm3D"]
 transform = Transform3D(-1, 0, -8.74228e-08, 0, 1, 0, 8.74228e-08, 0, -1, 0, 0, 0)

entities/target_dummy/target_dummy.gd

@@ -26,7 +26,7 @@ func _ready() -> void:
 	start_pos = global_position
 	$TargetMesh/AnimationPlayer.play("gunTwoHanded")
 
-func spawn() -> void:
+func spawn(_killer_id : int) -> void:
 	hide()
 	collision_shape_3d.disabled = true
 	await get_tree().create_timer(respawn_time).timeout

entities/weapons/space_gun/projectile.gd

@@ -23,6 +23,7 @@ class_name Projectile extends Node3D
 @onready var game : Node3D = get_tree().get_current_scene()
 
 var velocity : Vector3 = Vector3.ZERO
+var shooter : Player
 
 func _ready() -> void:
 	var lifespan_timer : Timer = Timer.new()
@@ -38,6 +39,7 @@ func self_destruct() -> void:
 func explode(spawn_location : Vector3) -> void:
 	var spawned_explosion : Node = EXPLOSION.instantiate()
 	spawned_explosion.position = spawn_location
+	spawned_explosion.shooter = shooter
 	game.add_child(spawned_explosion)
 	queue_free()
 

entities/weapons/space_gun/projectile_explosion.gd

@@ -14,10 +14,13 @@
 # along with this program.  If not, see <https://www.gnu.org/licenses/>.
 extends Node3D
 
+var shooter : Player
+
 @onready var fire : GPUParticles3D = $Fire
 @onready var explosive_damage : ExplosiveDamageComponent = $ExplosiveDamageComponent
 var explosion_effect_pending : bool = false
 
 func _ready() -> void:
+	explosive_damage.damage_dealer = shooter
 	fire.emitting = true
 	fire.finished.connect(func() -> void: queue_free())

entities/weapons/space_gun/space_gun.gd

@@ -16,6 +16,7 @@ extends Node3D
 class_name SpaceGun
 
 @export var PROJECTILE : PackedScene
+@export var holder : Player
 
 @onready var nozzle : Node3D = $Nozzle
 @onready var inventory : Node3D = get_parent()
@@ -37,6 +38,7 @@ func fire_primary() -> void:
 	var projectile : Node = PROJECTILE.instantiate()
 	projectile.transform = nozzle.global_transform
 	projectile.velocity = nozzle.global_basis.z.normalized() * projectile.speed
+	projectile.shooter = holder
 	var inheritance_factor : float = clamp(inheritance, 0., 1.)
 	projectile.velocity += (inventory.owner.linear_velocity * inheritance_factor)
 	inventory.owner.add_sibling(projectile)

environments/default.tres

@@ -1,6 +1,6 @@
 [gd_resource type="Environment" load_steps=4 format=3 uid="uid://d2ahijqqspw5f"]
 
-[ext_resource type="Texture2D" uid="uid://odwhjbebqfcn" path="res://environments/skyboxes/kloppenheim_06_puresky_2k.exr" id="1_k44rf"]
+[ext_resource type="Texture2D" uid="uid://btdbu0qbe1646" path="res://environments/skyboxes/kloppenheim_06_puresky_2k.exr" id="1_k44rf"]
 
 [sub_resource type="PanoramaSkyMaterial" id="PanoramaSkyMaterial_7tawh"]
 panorama = ExtResource("1_k44rf")

modes/multiplayer.tscn

@@ -1,8 +1,9 @@
-[gd_scene load_steps=5 format=3 uid="uid://bvwxfgygm2xb8"]
+[gd_scene load_steps=6 format=3 uid="uid://bvwxfgygm2xb8"]
 
 [ext_resource type="PackedScene" uid="uid://chbno00ugl6te" path="res://maps/genesis/genesis.tscn" id="1_nulvv"]
 [ext_resource type="PackedScene" uid="uid://cbhx1xme0sb7k" path="res://entities/player/player.tscn" id="2_og1vb"]
 [ext_resource type="PackedScene" uid="uid://c88l3h0ph00c7" path="res://entities/flag/flag.tscn" id="3_h0rie"]
+[ext_resource type="Script" path="res://modes/scoreboard.gd" id="4_n0mhp"]
 
 [sub_resource type="GDScript" id="GDScript_1qrbp"]
 script/source = "class_name Multiplayer extends Node
@@ -16,6 +17,8 @@ script/source = "class_name Multiplayer extends Node
 @onready var players : Node = $Players
 @onready var objectives : Node = $Objectives
 @onready var map : Node = $Map
+@onready var scoreboard : Scoreboard = $Scoreboard
+@onready var scoreboard_ui : Node = $ScoreboardUI
 
 var _map_manager : Map
 
@@ -41,12 +44,20 @@ func join_server(host : String, port : int, nickname : String) -> void:
 
 func _on_connected_to_server(nickname : String) -> void:
 	connected_to_server.emit()
+	scoreboard.request_scoreboard_from_authority.rpc()
 	_join_match.rpc(nickname)
 
 func _on_connection_failed() -> void:
 	connection_failed.emit()
 
-func respawn_player(player : Player) -> void:
+func respawn_player(player : Player, killer_id : int) -> void:
+	if player.player_id != killer_id:
+		var node_name : String = str(killer_id)
+		if players.has_node(node_name):
+			var killer : Player = players.get_node(node_name)
+			scoreboard.increment_kill_count(killer)
+			scoreboard.add_score_to_player(killer, 10)
+			scoreboard.broadcast_player_score_update(killer)
 	var spawn_location : Vector3 = _map_manager.get_player_spawn().position
 	player.respawn(spawn_location)
 
@@ -58,13 +69,15 @@ func add_player(peer_id : int, nickname : String) -> void:
 	player.global_position = _map_manager.get_player_spawn().position
 	players.add_child(player)
 	player.died.connect(respawn_player)
+	scoreboard.add_entry(player)
 	print(\"Peer `%s` connected\" % player.name)
 
 func remove_player(peer_id : int) -> void:
 	var node_name : String = str(peer_id)
 	if players.has_node(node_name):
 		var player : Player = players.get_node(node_name)
-		player.die()
+		scoreboard.remove_entry(player)
+		player.die(-1)
 		player.queue_free()
 		print(\"Peer `%s` disconnected\" % node_name)
 
@@ -81,6 +94,19 @@ func _add_flag() -> void:
 	flag.global_position = _map_manager.get_flagstand().global_position
 	objectives.add_child(flag)
 
+func _unhandled_input(event : InputEvent) -> void:
+	if event.is_action_pressed(\"scoreboard\"):
+		var entries : Array = scoreboard.get_entries()
+		for entry : Scoreboard.ScoreboardEntry in entries:
+			var entry_label : Label = Label.new()
+			entry_label.text = \"%s | kills: %s | score: %s\" % [entry.nickname, entry.kills, entry.score]
+			%Scores.add_child(entry_label)
+		scoreboard_ui.show()
+	elif event.is_action_released(\"scoreboard\"):
+		scoreboard_ui.hide()
+		for score_label in %Scores.get_children():
+			score_label.queue_free()
+
 @rpc(\"any_peer\")
 func _join_match(nickname : String) -> void:
 	if is_multiplayer_authority():
@@ -115,3 +141,36 @@ spawn_path = NodePath("../Players")
 [node name="ObjectivesSpawner" type="MultiplayerSpawner" parent="."]
 _spawnable_scenes = PackedStringArray("res://entities/flag/flag.tscn")
 spawn_path = NodePath("../Objectives")
+
+[node name="Scoreboard" type="Node" parent="."]
+script = ExtResource("4_n0mhp")
+
+[node name="ScoreboardUI" type="Control" parent="."]
+visible = false
+layout_mode = 3
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+
+[node name="PanelContainer" type="PanelContainer" parent="ScoreboardUI"]
+layout_mode = 1
+anchors_preset = 15
+anchor_right = 1.0
+anchor_bottom = 1.0
+grow_horizontal = 2
+grow_vertical = 2
+
+[node name="VBoxContainer" type="VBoxContainer" parent="ScoreboardUI/PanelContainer"]
+layout_mode = 2
+size_flags_horizontal = 4
+size_flags_vertical = 0
+
+[node name="Label" type="Label" parent="ScoreboardUI/PanelContainer/VBoxContainer"]
+layout_mode = 2
+text = "Scoreboard"
+
+[node name="Scores" type="VBoxContainer" parent="ScoreboardUI/PanelContainer/VBoxContainer"]
+unique_name_in_owner = true
+layout_mode = 2

modes/scoreboard.gd

@@ -0,0 +1,77 @@
+# This file is part of open-fpsz.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+class_name Scoreboard extends Node
+
+@export var _entries : Dictionary = {}
+
+class ScoreboardEntry:
+	var nickname : String
+	var kills : int
+	var score : int
+
+func add_entry(player : Player) -> void:
+	var new_entry : ScoreboardEntry = ScoreboardEntry.new()
+	new_entry.nickname = player.nickname
+	new_entry.kills = 0
+	new_entry.score = 0
+	_entries[player.player_id] = new_entry
+	_send_scoreboard_entry.rpc(player.player_id, new_entry.nickname, new_entry.kills, new_entry.score)
+
+func remove_entry(player : Player) -> void:
+	_entries.erase(player.player_id)
+	_broadcast_player_removed(player)
+
+func add_score_to_player(player : Player, amount : int) -> void:
+	_entries[player.player_id].score += amount
+
+func increment_kill_count(player : Player) -> void:
+	_entries[player.player_id].kills += 1
+
+func get_entries() -> Array:
+	return _entries.values()
+
+@rpc("any_peer", "call_remote", "reliable")
+func request_scoreboard_from_authority() -> void:
+	if is_multiplayer_authority():
+		var recipient_id : int = multiplayer.get_remote_sender_id()
+		_clear_scoreboard.rpc_id(recipient_id)
+		for entry_key : int in _entries:
+			var entry : ScoreboardEntry = _entries[entry_key]
+			_send_scoreboard_entry.rpc_id(recipient_id, entry_key, entry.nickname, entry.kills, entry.score)
+
+@rpc("authority", "reliable")
+func _clear_scoreboard() -> void:
+	_entries.clear()
+
+@rpc("authority", "reliable")
+func _send_scoreboard_entry(player_id : int, nickname : String, kills : int, score : int) -> void:
+	var new_entry : ScoreboardEntry = ScoreboardEntry.new()
+	new_entry.nickname = nickname
+	new_entry.kills = kills
+	new_entry.score = score
+	_entries[player_id] = new_entry
+
+@rpc("authority", "reliable")
+func _remove_scoreboard_entry(player_id : int) -> void:
+	_entries.erase(player_id)
+
+func broadcast_player_score_update(player : Player) -> void:
+	var player_id : int = player.player_id
+	var player_score_entry : ScoreboardEntry = _entries[player_id]
+	_send_scoreboard_entry.rpc(player_id, player_score_entry.nickname, player_score_entry.kills, player_score_entry.score)
+
+func _broadcast_player_removed(player : Player) -> void:
+	var player_id : int = player.player_id
+	_remove_scoreboard_entry.rpc(player_id)

project.godot

@@ -115,6 +115,11 @@ toggle_mouse_capture={
 "events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":-1,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194332,"key_label":0,"unicode":0,"echo":false,"script":null)
 ]
 }
+scoreboard={
+"deadzone": 0.5,
+"events": [Object(InputEventKey,"resource_local_to_scene":false,"resource_name":"","device":0,"window_id":0,"alt_pressed":false,"shift_pressed":false,"ctrl_pressed":false,"meta_pressed":false,"pressed":false,"keycode":0,"physical_keycode":4194306,"key_label":0,"unicode":0,"echo":false,"script":null)
+]
+}
 
 [layer_names]
 

tests/test_health_component.gd

@@ -21,7 +21,6 @@ func before_each() -> void:
 	_subject = HealthComponent.new()
 	watch_signals(_subject)
 	_subject.max_health = TEST_MAX_HEALTH
-	set_multiplayer_authority(multiplayer.get_unique_id())
 	add_child(_subject)
 
 func after_each() -> void:
@@ -32,16 +31,16 @@ func test_that_it_has_max_health_when_ready() -> void:
 
 func test_that_it_takes_damage() -> void:
 	var damage_amount : float = 10
-	_subject.damage(damage_amount)
+	_subject.damage(damage_amount, -1)
 	assert_eq(_subject.health, TEST_MAX_HEALTH - damage_amount)
 
 func test_that_it_emits_health_changed_after_damage() -> void:
-	_subject.damage(1)
+	_subject.damage(1, -1)
 	assert_signal_emitted(_subject, 'health_changed')
 
 func test_that_it_emits_health_zeroed() -> void:
-	_subject.damage(TEST_MAX_HEALTH)
-	assert_signal_emitted(_subject, 'health_zeroed')
+	_subject.damage(TEST_MAX_HEALTH, -1)
+	assert_signal_emitted_with_parameters(_subject, 'health_zeroed', [-1])
 
 func test_that_it_heals_fully() -> void:
 	_subject.health = 10

tests/test_scoreboard.gd

@@ -0,0 +1,57 @@
+# This file is part of open-fpsz.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <https://www.gnu.org/licenses/>.
+extends GutTest
+
+var PLAYER : PackedScene = preload("res://entities/player/player.tscn")
+
+var _subject : Scoreboard
+
+func before_each() -> void:
+	_subject = Scoreboard.new()
+	add_child(_subject)
+
+func after_each() -> void:
+	_subject.free()
+
+func test_that_new_scoreboard_is_empty() -> void:
+	assert_eq(_subject.get_entries(), [])
+
+func test_that_added_entry_is_added_correctly() -> void:
+	var player : Player = PLAYER.instantiate()
+	player.nickname = "test_nickname"
+	_subject.add_entry(player)
+	var entries : Array = _subject.get_entries()
+	assert_eq(1, entries.size())
+	var tested_entry : Scoreboard.ScoreboardEntry = entries[0]
+	assert_eq("test_nickname", tested_entry.nickname)
+	assert_eq(0, tested_entry.kills)
+	assert_eq(0, tested_entry.score)
+	player.free()
+
+func test_that_scores_are_added_correctly() -> void:
+	var player : Player = PLAYER.instantiate()
+	_subject.add_entry(player)
+	_subject.add_score_to_player(player, 10)
+	var tested_entry : Scoreboard.ScoreboardEntry = _subject.get_entries()[0]
+	assert_eq(10, tested_entry.score)
+	player.free()
+
+func test_that_kill_counts_are_incremented_correctly() -> void:
+	var player : Player = PLAYER.instantiate()
+	_subject.add_entry(player)
+	_subject.increment_kill_count(player)
+	var tested_entry : Scoreboard.ScoreboardEntry = _subject.get_entries()[0]
+	assert_eq(1, tested_entry.kills)
+	player.free()