Merge pull request #126 from OpenVicProject/req-comments

Added requirement comments

7 files changed, 31 insertions, 9 deletions

diff --git a/extension/src/Checksum.hpp b/extension/src/Checksum.hpp
index dc86d5b..b12a9cd 100644
--- a/extension/src/Checksum.hpp
+++ b/extension/src/Checksum.hpp
@@ -27,6 +27,9 @@ namespace OpenVic {
 		}
 		// END BOILERPLATE
 
+		/* REQUIREMENTS:
+		 * DAT-8
+		 */
 		inline godot::String get_checksum_text() {
 			return godot::String("1234abcd");
 		}
diff --git a/game/art/economy/goods/README.md b/game/art/economy/goods/README.md
new file mode 100644
index 0000000..15015e3
--- /dev/null
+++ b/game/art/economy/goods/README.md
@@ -0,0 +1,11 @@
+
+# Goods Icons Completed Requirements
+
+## Icon Art
+- UI-137, UI-141, UI-154, UI-155, UI-156, UI-160, UI-179
+
+## File Loading
+- FS-39, FS-40, FS-41, FS-42, FS-43, FS-44, FS-45, FS-46, FS-47, FS-48, FS-49, FS-50,
+- FS-51, FS-52, FS-53, FS-54, FS-55, FS-56, FS-57, FS-58, FS-59, FS-60, FS-61, FS-62,
+- FS-63, FS-64, FS-65, FS-66, FS-67, FS-68, FS-69, FS-70, FS-71, FS-72, FS-73, FS-74,
+- FS-75, FS-76, FS-77, FS-78, FS-79, FS-80, FS-81, FS-82, FS-83, FS-84, FS-85, FS-86
diff --git a/game/src/GameSession/MapControlPanel/MapControlPanel.tscn b/game/src/GameSession/MapControlPanel/MapControlPanel.tscn
index 91e2e7e..bd4a010 100644
--- a/game/src/GameSession/MapControlPanel/MapControlPanel.tscn
+++ b/game/src/GameSession/MapControlPanel/MapControlPanel.tscn
@@ -16,7 +16,7 @@ action = &"ui_cancel"
 events = [SubResource("InputEventAction_5nck3")]
 
 [node name="MapControlPanel" type="PanelContainer" node_paths=PackedStringArray("_mapmodes_grid")]
-editor_description = "SS-103"
+editor_description = "SS-103, UI-548"
 mouse_filter = 1
 script = ExtResource("1_ign64")
 _mapmodes_grid = NodePath("MapPanelMargin/MapPanelList/MapDisplayList/MapmodesGrid")
diff --git a/game/src/MusicConductor/MusicConductor.gd b/game/src/MusicConductor/MusicConductor.gd
index 08fa86a..98dd0eb 100644
--- a/game/src/MusicConductor/MusicConductor.gd
+++ b/game/src/MusicConductor/MusicConductor.gd
@@ -1,6 +1,7 @@
 extends Node
 
-# SS-67
+# REQUIREMENTS
+# * SS-67
 @export_dir var music_directory : String
 @export var first_song_name : String
 
@@ -41,12 +42,14 @@ func start_current_song() -> void:
 	$AudioStreamPlayer.stream = _available_songs[_selected_track].song_stream
 	$AudioStreamPlayer.play()
 
-# SS-70
+# REQUIREMENTS
+# * SS-70
 func start_song_by_index(id: int) -> void:
 	_selected_track = id
 	start_current_song()
 
-# SS-69
+# REQUIREMENTS
+# * SS-69
 func select_next_song() -> void:
 	_selected_track = (_selected_track + 1) % len(_available_songs)
 	start_current_song()
@@ -55,6 +58,8 @@ func select_previous_song() -> void:
 	_selected_track = (len(_available_songs) - 1) if (_selected_track == 0) else (_selected_track - 1)
 	start_current_song()
 
+# REQUIREMENTS
+# * SND-2
 func _ready():
 	var dir = DirAccess.open(music_directory)
 	for fname in dir.get_files():
diff --git a/game/src/MusicConductor/MusicPlayer.gd b/game/src/MusicConductor/MusicPlayer.gd
index b775b84..47be158 100644
--- a/game/src/MusicConductor/MusicPlayer.gd
+++ b/game/src/MusicConductor/MusicPlayer.gd
@@ -41,8 +41,9 @@ func _on_previous_song_button_pressed():
 	_update_song_name_visual()
 	_update_play_pause_button()
 
+# REQUIREMENTS
+# * UIFUN-92
 func _on_option_button_item_selected(index):
-	# UIFUN-92
 	MusicConductor.start_song_by_index(index)
 	_update_song_name_visual()
 	_update_play_pause_button()
@@ -66,5 +67,7 @@ func _set_music_player_visible(is_player_visible : bool) -> void:
 	_play_pause_button.visible = is_player_visible
 	_next_song_button.visible = is_player_visible
 
+# REQUIREMENTS
+# * UIFUN-91
 func _on_music_ui_visibility_button_pressed():
 	_set_music_player_visible(not MusicConductor.is_music_player_visible)
diff --git a/game/src/OptionMenu/GeneralTab.tscn b/game/src/OptionMenu/GeneralTab.tscn
index 68415d4..4e9ff6a 100644
--- a/game/src/OptionMenu/GeneralTab.tscn
+++ b/game/src/OptionMenu/GeneralTab.tscn
@@ -6,7 +6,7 @@
 [ext_resource type="Script" path="res://src/OptionMenu/AutosaveIntervalSelector.gd" id="2_t06tb"]
 
 [node name="GeneralTab" type="HBoxContainer" node_paths=PackedStringArray("initial_focus")]
-editor_description = "UI-48"
+editor_description = "UI-48, UIFUN-45"
 alignment = 1
 script = ExtResource("1_gbutn")
 initial_focus = NodePath("VBoxContainer/GridContainer/SavegameFormatSelector")
@@ -48,7 +48,7 @@ layout_mode = 2
 text = "OPTIONS_GENERAL_AUTOSAVE"
 
 [node name="AutosaveIntervalSelector" type="OptionButton" parent="VBoxContainer/GridContainer"]
-editor_description = "UI-15"
+editor_description = "UI-15, UIFUN-19"
 layout_mode = 2
 focus_neighbor_top = NodePath("../SavegameFormatSelector")
 focus_neighbor_bottom = NodePath("../LocaleButton")
diff --git a/game/src/OptionMenu/VideoTab.tscn b/game/src/OptionMenu/VideoTab.tscn
index 89b71d7..244f481 100644
--- a/game/src/OptionMenu/VideoTab.tscn
+++ b/game/src/OptionMenu/VideoTab.tscn
@@ -104,7 +104,7 @@ layout_mode = 2
 text = "OPTIONS_VIDEO_REFRESH_RATE"
 
 [node name="RefreshRateSelector" type="OptionButton" parent="VideoSettingList/VideoSettingGrid"]
-editor_description = "UI-18"
+editor_description = "UI-18, UIFUN-20"
 layout_mode = 2
 tooltip_text = "OPTIONS_VIDEO_REFRESH_RATE_TOOLTIP"
 focus_neighbor_top = NodePath("../MonitorDisplaySelector")
@@ -137,7 +137,7 @@ layout_mode = 2
 text = "OPTIONS_VIDEO_QUALITY"
 
 [node name="QualityPresetSelector" type="OptionButton" parent="VideoSettingList/VideoSettingGrid"]
-editor_description = "UI-21"
+editor_description = "UI-21, UIFUN-22"
 layout_mode = 2
 focus_neighbor_top = NodePath("../RefreshRateSelector")
 item_count = 5