Skip to content

[hotfix] Renamed methods and variables. #98

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Feb 17, 2025
Merged

[hotfix] Renamed methods and variables. #98

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
419f4ba
Renamed methods and variables.
neogeek Feb 17, 2025
c77c8a0
Fixed invalid method call.
neogeek Feb 17, 2025
3028767
Fixed missed variable and method comment header.
neogeek Feb 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions ...n/API/Parsers/ParseBpmFromChartSection.md → ...sers/ParseTempoChangesFromChartSection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#### `Parsers.ParseBpmFromChartSection`
#### `Parsers.ParseTempoChangesFromChartSection`

> Languages: `C#` `C++` `GDScript`

Expand All @@ -10,9 +10,9 @@ using RhythmGameUtilities;

var sections = Parsers.ParseSectionsFromChart(contents);

var bpm = Parsers.ParseBpmFromChartSection(sections[NamedSection.SyncTrack]);
var tempoChanges = Parsers.ParseTempoChangesFromChartSection(sections[NamedSection.SyncTrack]);

Console.WriteLine(bpm.Length); // 7
Console.WriteLine(tempoChanges.Length); // 7
```

##### C++
Expand All @@ -31,10 +31,10 @@ int main()

auto sections = ParseSectionsFromChart(content.c_str());

auto bpm = ParseBpmFromChartSection(
auto tempoChanges = ParseTempoChangesFromChartSection(
sections.at(ToString(NamedSection::SyncTrack)));

std::cout << size(bpm) << std::endl; // 7
std::cout << size(tempoChanges) << std::endl; // 7

return 0;
}
Expand All @@ -51,7 +51,7 @@ func _ready() -> void:

var sections = rhythm_game_utilities.parse_sections_from_chart(content)

var bpm = rhythm_game_utilities.parse_bpm_from_chart_section(sections["SyncTrack"])
var tempo_changes = rhythm_game_utilities.parse_tempo_changes_from_chart_section(sections["SyncTrack"])

print(bpm)
print(tempo_changes)
```
14 changes: 7 additions & 7 deletions ...rs/ParseTimeSignaturesFromChartSection.md → ...eTimeSignaturesChangesFromChartSection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
#### `Parsers.ParseTimeSignaturesFromChartSection`
#### `Parsers.ParseTimeSignatureChangesFromChartSection`

> Languages: `C#` `C++` `GDScript`

Expand All @@ -10,9 +10,9 @@ using RhythmGameUtilities;

var sections = Parsers.ParseSectionsFromChart(contents);

var timeSignatures = Parsers.ParseTimeSignaturesFromChartSection(sections[NamedSection.SyncTrack]);
var timeSignatureChanges = Parsers.ParseTimeSignatureChangesFromChartSection(sections[NamedSection.SyncTrack]);

Console.WriteLine(timeSignatures.Length); // 4
Console.WriteLine(timeSignatureChanges.Length); // 4
```

##### C++
Expand All @@ -31,10 +31,10 @@ int main()

auto sections = ParseSectionsFromChart(content.c_str());

auto timeSignatures = ParseTimeSignaturesFromChartSection(
auto timeSignatureChanges = ParseTimeSignatureChangesFromChartSection(
sections.at(ToString(NamedSection::SyncTrack)));

std::cout << size(timeSignatures) << std::endl; // 4
std::cout << size(timeSignatureChanges) << std::endl; // 4

return 0;
}
Expand All @@ -51,7 +51,7 @@ func _ready() -> void:

var sections = rhythm_game_utilities.parse_sections_from_chart(content)

var time_signatures = rhythm_game_utilities.parse_time_signatures_from_chart_section(sections["SyncTrack"])
var time_signature_changes = rhythm_game_utilities.parse_time_signature_changes_from_chart_section(sections["SyncTrack"])

print(time_signatures)
print(time_signature_changes)
```
12 changes: 6 additions & 6 deletions Documentation/API/Utilities/CalculateAccuracyRatio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,14 @@ const int seconds = 2;
const int resolution = 192;
const int positionDelta = 50;

var bpmChanges = new Tempo[] { new() { Position = 0, BPM = 120000 } };
var tempoChanges = new Tempo[] { new() { Position = 0, BPM = 120000 } };

var timeSignatureChanges = new TimeSignature[] { new() { Position = 0, Numerator = 4, Denominator = 2 } };

var note = new Note { Position = 750 };

var currentPosition =
Utilities.ConvertSecondsToTicks(seconds, resolution, bpmChanges, timeSignatureChanges);
Utilities.ConvertSecondsToTicks(seconds, resolution, tempoChanges, timeSignatureChanges);

var value = Utilities.CalculateAccuracyRatio(note.Position, currentPosition, positionDelta);

Expand All @@ -41,12 +41,12 @@ int main()
const int resolution = 192;
const int positionDelta = 50;

std::vector<Tempo> bpmChanges = {{0, 120000}};
std::vector<Tempo> tempoChanges = {{0, 120000}};
std::vector<TimeSignature> timeSignatureChanges = {{0, 4}};

auto note = new Note{750};
auto currentPosition = ConvertSecondsToTicks(
seconds, resolution, bpmChanges, timeSignatureChanges);
seconds, resolution, tempoChanges, timeSignatureChanges);

auto value =
CalculateAccuracyRatio(note->Position, currentPosition, positionDelta);
Expand All @@ -67,15 +67,15 @@ func _ready() -> void:
var resolution = 192
var position_delta = 50

var bpm_changes = [
var tempo_changes = [
{"position": 0, "bpm": 120000 }
]

var time_signature_changes = [
{"position": 0, "numerator": 4, "denominator": 2 }
]

var current_position = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, bpm_changes, time_signature_changes)
var current_position = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, tempo_changes, time_signature_changes)

var value = rhythm_game_utilities.calculate_accuracy_ratio(750, current_position, position_delta)

Expand Down
12 changes: 6 additions & 6 deletions Documentation/API/Utilities/CalculateBeatBars.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
##### C#

```csharp
var bpmChanges = new Tempo[]
var tempoChanges = new Tempo[]
{
new() { Position = 0, BPM = 88000 }, new() { Position = 3840, BPM = 112000 },
new() { Position = 9984, BPM = 89600 }, new() { Position = 22272, BPM = 112000 },
new() { Position = 33792, BPM = 111500 }, new() { Position = 34560, BPM = 112000 },
new() { Position = 42240, BPM = 111980 }
};

var beatBars = Utilities.CalculateBeatBars(bpmChanges);
var beatBars = Utilities.CalculateBeatBars(tempoChanges);

Console.WriteLine(beatBars.Length); // 440
```
Expand All @@ -32,12 +32,12 @@ int main()
const int resolution = 192;
const int timeSignature = 4;

std::vector<Tempo> bpmChanges = {
std::vector<Tempo> tempoChanges = {
{0, 88000}, {3840, 112000}, {9984, 89600}, {22272, 112000},
{33792, 111500}, {34560, 112000}, {42240, 111980}};

auto beatBars =
CalculateBeatBars(bpmChanges, resolution, timeSignature, true);
CalculateBeatBars(tempoChanges, resolution, timeSignature, true);

std::cout << size(beatBars) << std::endl; // 440

Expand All @@ -54,7 +54,7 @@ func _ready() -> void:
var resolution = 192
var time_signature = 4

var bpm_changes = [
var tempo_changes = [
{"position": 0, "bpm": 8800 },
{"position": 3840, "bpm": 112000 },
{"position": 9984, "bpm": 89600 },
Expand All @@ -64,7 +64,7 @@ func _ready() -> void:
{"position": 42240, "bpm": 111980 }
]

var beat_bars = rhythm_game_utilities.calculate_beat_bars(bpm_changes, resolution, time_signature, true)
var beat_bars = rhythm_game_utilities.calculate_beat_bars(tempo_changes, resolution, time_signature, true)

print(beat_bars)
```
12 changes: 6 additions & 6 deletions Documentation/API/Utilities/ConvertSecondsToTicks.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ using RhythmGameUtilities;
const int seconds = 5;
const int resolution = 192;

var bpmChanges = new Tempo[]
var tempoChanges = new Tempo[]
{
new() { Position = 0, BPM = 88000 }, new() { Position = 3840, BPM = 112000 },
new() { Position = 9984, BPM = 89600 }, new() { Position = 22272, BPM = 112000 },
Expand All @@ -21,7 +21,7 @@ var bpmChanges = new Tempo[]

var timeSignatureChanges = new TimeSignature[] { new() { Position = 0, Numerator = 4, Denominator = 2 } };

var ticks = Utilities.ConvertSecondsToTicks(seconds, resolution, bpmChanges, timeSignatureChanges);
var ticks = Utilities.ConvertSecondsToTicks(seconds, resolution, tempoChanges, timeSignatureChanges);

Console.WriteLine(ticks); // 1408
```
Expand All @@ -40,13 +40,13 @@ int main()
const int seconds = 5;
const int resolution = 192;

std::vector<Tempo> bpmChanges = {
std::vector<Tempo> tempoChanges = {
{0, 88000}, {3840, 112000}, {9984, 89600}, {22272, 112000},
{33792, 111500}, {34560, 112000}, {42240, 111980}};

std::vector<TimeSignature> timeSignatureChanges = {{0, 4, 2}};

auto ticks = ConvertSecondsToTicks(seconds, resolution, bpmChanges,
auto ticks = ConvertSecondsToTicks(seconds, resolution, tempoChanges,
timeSignatureChanges);

std::cout << ticks << std::endl; // 1408
Expand All @@ -64,7 +64,7 @@ func _ready() -> void:
var seconds = 5
var resolution = 192

var bpm_changes = [
var tempo_changes = [
{"position": 0, "bpm": 88000 },
{"position": 3840, "bpm": 112000 },
{"position": 9984, "bpm": 89600 },
Expand All @@ -78,7 +78,7 @@ func _ready() -> void:
{"position": 0, "numerator": 4, "denominator": 2 }
]

var current_position = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, bpm_changes, time_signature_changes)
var current_position = rhythm_game_utilities.convert_seconds_to_ticks(seconds, resolution, tempo_changes, time_signature_changes)

print(current_position) # 1408
```
4 changes: 2 additions & 2 deletions Documentation/Architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,11 @@ graph LR;

subgraph parsersGraph ["Parsers"]
parseSectionsFromChart["ParseSectionsFromChart()"]
parseBpmFromChartSection["ParseBpmFromChartSection()"]
parseBpmFromChartSection["ParseTempoChangesFromChartSection()"]
parseLyricsFromChartSection["ParseLyricsFromChartSection()"]
parseMetaDataFromChartSection["ParseMetaDataFromChartSection()"]
parseNotesFromChartSection["ParseNotesFromChartSection()"]
parseTimeSignaturesFromChartSection["ParseTimeSignaturesFromChartSection()"]
parseTimeSignaturesFromChartSection["ParseTimeSignatureChangesFromChartSection()"]

parseSectionsFromChart-->parseBpmFromChartSection
parseSectionsFromChart-->parseLyricsFromChartSection
Expand Down
4 changes: 2 additions & 2 deletions Documentation/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,12 +40,12 @@ _Prototype game built using these utilities._
1. [InverseLerp](#commoninverselerp)
1. [Lerp](#commonlerp)
1. [Parsers](#parsers)
1. [ParseBpmFromChartSection](#parsersparsebpmfromchartsection)
1. [ParseTempoChangesFromChartSection](#parsersparsetempochangesfromchartsection)
1. [ParseLyricsFromChartSection](#parsersparselyricsfromchartsection)
1. [ParseMetaDataFromChartSection](#parsersparsemetadatafromchartsection)
1. [ParseNotesFromChartSection](#parsersparsenotesfromchartsection)
1. [ParseSectionsFromChart](#parsersparsesectionsfromchart)
1. [ParseTimeSignaturesFromChartSection](#parsersparsetimesignaturesfromchartsection)
1. [ParseTimeSignatureChangesFromChartSection](#parsersparsetimesignaturechangesfromchartsection)
1. [Utilities](#utilities)
1. [CalculateAccuracyRatio](#utilitiescalculateaccuracyratio)
1. [CalculateBeatBars](#utilitiescalculatebeatbars)
Expand Down
Loading