Added new methods.

neogeek · neogeek · commit 303b8e8d4993 · 2024-11-06T09:59:49.000-05:00
Updated documentation.
diff --git a/Documentation/API/Common/InverseLerp.md b/Documentation/API/Common/InverseLerp.md
@@ -32,7 +32,7 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
diff --git a/Documentation/API/Common/Lerp.md b/Documentation/API/Common/Lerp.md
@@ -32,7 +32,7 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
diff --git a/Documentation/API/Parsers/ParseBpmFromChartSection.md b/Documentation/API/Parsers/ParseBpmFromChartSection.md
@@ -1,6 +1,6 @@
 #### `Parsers.ParseBpmFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -39,3 +39,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content);
+
+	var bpm = rhythm_game_utilities.parse_bpm_from_chart_section(sections["SyncTrack"]);
+
+	print(bpm)
+```
diff --git a/Documentation/API/Parsers/ParseLyricsFromChartSection.md b/Documentation/API/Parsers/ParseLyricsFromChartSection.md
@@ -39,3 +39,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content);
+
+	var lyrics = rhythm_game_utilities.parse_lyrics_from_chart_section(sections["Events"]);
+
+	print(lyrics)
+```
diff --git a/Documentation/API/Parsers/ParseMetaDataFromChartSection.md b/Documentation/API/Parsers/ParseMetaDataFromChartSection.md
@@ -1,6 +1,6 @@
 #### `Parsers.ParseMetaDataFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -43,3 +43,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content);
+
+	var meta_data = rhythm_game_utilities.parse_meta_data_from_chart_section(sections["Song"]);
+
+	print(meta_data)
+```
diff --git a/Documentation/API/Parsers/ParseNotesFromChartSection.md b/Documentation/API/Parsers/ParseNotesFromChartSection.md
@@ -1,6 +1,6 @@
 #### `Parsers.ParseNotesFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -47,3 +47,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content);
+
+	var notes = rhythm_game_utilities.parse_notes_from_chart_section(sections["ExpertSingle"]);
+
+	print(notes)
+```
diff --git a/Documentation/API/Parsers/ParseSectionsFromChart.md b/Documentation/API/Parsers/ParseSectionsFromChart.md
@@ -35,7 +35,7 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
diff --git a/Documentation/API/Parsers/ParseTimeSignaturesFromChartSection.md b/Documentation/API/Parsers/ParseTimeSignaturesFromChartSection.md
@@ -1,6 +1,6 @@
 #### `Parsers.ParseTimeSignaturesFromChartSection`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -39,3 +39,19 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var file = FileAccess.open("res://song.txt", FileAccess.READ)
+	var content = file.get_as_text()
+
+	var sections = rhythm_game_utilities.parse_sections_from_chart(content);
+
+	var time_signatures = rhythm_game_utilities.parse_time_signatures_from_chart_section(sections["SyncTrack"]);
+
+	print(time_signatures)
+```
diff --git a/Documentation/API/Utilities/CalculateAccuracyRatio.md b/Documentation/API/Utilities/CalculateAccuracyRatio.md
@@ -1,6 +1,6 @@
 #### `Utilities.CalculateAccuracyRatio`
 
-> Languages: `C#` `C++`
+> Languages: `C#` `C++` `GDScript`
 
 ##### C#
 
@@ -51,3 +51,54 @@ int main()
     return 0;
 }
 ```
+
+##### GDScript
+
+```cpp
+#include <iostream>
+
+#include "RhythmGameUtilities/Utilities.hpp"
+
+using namespace RhythmGameUtilities;
+
+int main()
+{
+    const int seconds = 2;
+    const int resolution = 192;
+    const int positionDelta = 50;
+
+    std::map<int, int> bpmChanges = {{0, 120000}};
+
+    auto note = new Note{750};
+    auto currentPosition =
+        ConvertSecondsToTicks(seconds, resolution, bpmChanges);
+
+    auto value =
+        CalculateAccuracyRatio(note->Position, currentPosition, positionDelta);
+
+    std::cout << value << std::endl; // 0.64
+
+    return 0;
+}
+```
+
+```gdscript
+extends Node
+
+func _ready() -> void:
+	var seconds = 2;
+	var resolution = 192;
+	var position_delta = 50;
+
+	var bpm_changes = {
+		0: 88000, 3840: 112000, 9984: 89600,
+		22272: 112000, 33792: 111500, 34560: 112000,
+		42240: 111980
+	}
+
+	var current_position = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, bpm_changes);
+
+	var value = rhythm_game_utilities.calculate_accuracy_ratio(750, current_position, position_delta);
+
+	print(value) # 0.64
+```
diff --git a/Documentation/API/Utilities/CalculateBeatBars.md b/Documentation/API/Utilities/CalculateBeatBars.md
@@ -51,22 +51,22 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
 
 func _ready() -> void:
 	var resolution = 192;
-	var timeSignature = 4;
+	var time_signature = 4;
 
-	var bpmChanges = {
+	var bpm_changes = {
 		0: 88000, 3840: 112000, 9984: 89600,
 		22272: 112000, 33792: 111500, 34560: 112000,
 		42240: 111980
 	}
 
-	var beatBars = rhythm_game_utilities.calculate_beat_bars(bpmChanges, resolution, timeSignature, true);
+	var beat_bars = rhythm_game_utilities.calculate_beat_bars(bpm_changes, resolution, time_signature, true);
 
-	print(beatBars)
+	print(beat_bars)
 ```
diff --git a/Documentation/API/Utilities/ConvertSecondsToTicks.md b/Documentation/API/Utilities/ConvertSecondsToTicks.md
@@ -53,7 +53,7 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
@@ -62,13 +62,13 @@ func _ready() -> void:
 	var seconds = 5;
 	var resolution = 192;
 
-	var bpmChanges = {
+	var bpm_changes = {
 		0: 88000, 3840: 112000, 9984: 89600,
 		22272: 112000, 33792: 111500, 34560: 112000,
 		42240: 111980
 	}
 
-	var ticks = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, bpmChanges);
+	var ticks = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, bpm_changes);
 
 	print(ticks) # 1408
 ```
diff --git a/Documentation/API/Utilities/ConvertTickToPosition.md b/Documentation/API/Utilities/ConvertTickToPosition.md
@@ -38,7 +38,7 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
diff --git a/Documentation/API/Utilities/IsOnTheBeat.md b/Documentation/API/Utilities/IsOnTheBeat.md
@@ -42,16 +42,16 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
 
 func _ready() -> void:
 	var bpm = 120;
-	var currentTime = 10;
+	var current_time = 10;
 	var delta = 0.05;
 
-	if rhythm_game_utilities.is_on_the_beat(bpm, currentTime, delta):
+	if rhythm_game_utilities.is_on_the_beat(bpm, current_time, delta):
 		print("Is on the beat!")
 ```
diff --git a/Documentation/API/Utilities/RoundUpToTheNearestMultiplier.md b/Documentation/API/Utilities/RoundUpToTheNearestMultiplier.md
@@ -32,7 +32,7 @@ int main()
 }
 ```
 
-##### Godot
+##### GDScript
 
 ```gdscript
 extends Node
diff --git a/GodotPlugin/include/rhythm_game_utilities.cpp b/GodotPlugin/include/rhythm_game_utilities.cpp
diff --git a/GodotPlugin/include/rhythm_game_utilities.h b/GodotPlugin/include/rhythm_game_utilities.h
diff --git a/GodotPlugin/include/utilities.hpp b/GodotPlugin/include/utilities.hpp
diff --git a/README.md b/README.md
diff --git a/RhythmGameUtilities/README.md b/RhythmGameUtilities/README.md
diff --git a/UnityPackage/README.md b/UnityPackage/README.md

Original file line number	Diff line number	Diff line change
`@@ -32,7 +32,7 @@ int main()`
`32`	`32`	`}`
`33`	`33`	```
`34`	`34`
`35`		`-##### Godot`
	`35`	`+##### GDScript`
`36`	`36`
`37`	`37`	```gdscript
`38`	`38`	`extends Node`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ int main()`
`35`	`35`	`}`
`36`	`36`	```
`37`	`37`
`38`		`-##### Godot`
	`38`	`+##### GDScript`
`39`	`39`
`40`	`40`	```gdscript
`41`	`41`	`extends Node`