Add templated GameTicks strong type #21868
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Due to complexity of integrating the strong type, for now it is left unimplemented |
ZehMatt
requested changes
Apr 21, 2024
src/openrct2/Game.h
Outdated
Comment on lines
21
to
137
| { | ||
| GameTicks<T, Tag> result; | ||
| result.Value = seconds * TickConversion::kGameUpdateFPS; | ||
| return result; | ||
| } | ||
| static constexpr GameTicks FromMilliseconds(uint32_t milliseconds) | ||
| { | ||
| GameTicks<T, Tag> result; | ||
| result.Value = milliseconds * TickConversion::kGameUpdateFPMS; | ||
| return result; | ||
| } | ||
|
|
||
| constexpr void operator=(T rhs) | ||
| { | ||
| Value = rhs; | ||
| } | ||
|
|
||
| constexpr GameTicks& operator++() | ||
| { | ||
| ++Value; | ||
| return *this; | ||
| } | ||
| constexpr GameTicks operator++(int) | ||
| { | ||
| GameTicks<T, Tag> temp = *this; | ||
| Value++; | ||
| return temp; | ||
| } | ||
| constexpr GameTicks& operator--() | ||
| { | ||
| --Value; | ||
| return *this; | ||
| } | ||
| constexpr GameTicks operator--(int) | ||
| { | ||
| GameTicks<T, Tag> temp = *this; | ||
| Value--; | ||
| return temp; | ||
| } | ||
|
|
||
| constexpr GameTicks operator+(GameTicks rhs) const | ||
| { | ||
| return GameTicks(Value + rhs.Value); | ||
| } | ||
| constexpr GameTicks operator-(GameTicks rhs) const | ||
| { | ||
| return GameTicks(Value - rhs.Value); | ||
| } | ||
| constexpr GameTicks operator*(GameTicks rhs) const | ||
| { | ||
| return GameTicks(Value * rhs.Value); | ||
| } | ||
| constexpr GameTicks operator/(GameTicks rhs) const | ||
| { | ||
| return GameTicks(Value / rhs.GameTicks); | ||
| } | ||
|
|
||
| constexpr GameTicks& operator+=(GameTicks rhs) | ||
| { | ||
| Value += rhs.Value; | ||
| return *this; | ||
| } | ||
| constexpr GameTicks& operator-=(GameTicks rhs) | ||
| { | ||
| Value -= rhs.Value; | ||
| return *this; | ||
| } | ||
|
|
||
| constexpr bool operator==(const GameTicks& rhs) | ||
| { | ||
| return Value == rhs.Value; | ||
| } | ||
| constexpr bool operator<(const GameTicks& rhs) | ||
| { | ||
| return Value < rhs.Value; | ||
| } | ||
| constexpr bool operator>(const GameTicks& rhs) | ||
| { | ||
| return Value > rhs.Value; | ||
| } | ||
| constexpr bool operator<=(const GameTicks& rhs) | ||
| { | ||
| return Value <= rhs.Value; | ||
| } | ||
| constexpr bool operator>=(const GameTicks& rhs) | ||
| { | ||
| return Value >= rhs.Value; | ||
| } | ||
| constexpr bool operator!=(const GameTicks& rhs) | ||
| { | ||
| return Value != rhs.Value; | ||
| } | ||
|
|
||
| constexpr GameTicks& operator%(const GameTicks& rhs) | ||
| { | ||
| GameTicks result; | ||
| result.Value = Value % rhs.Value; | ||
| return result; | ||
| } | ||
| }; |
There was a problem hiding this comment.
Its better to move all of this into a new header file.
There was a problem hiding this comment.
I also would like to see some tests added for this new logic, before implementing it we should ensure it actually works the way we expect.
src/openrct2/Game.h
Outdated
Comment on lines
39
to
41
| GameTicks<T, Tag> result; | ||
| result.Value = seconds * TickConversion::kGameUpdateFPS; | ||
| return result; |
There was a problem hiding this comment.
Suggested change
| GameTicks<T, Tag> result; | |
| result.Value = seconds * TickConversion::kGameUpdateFPS; | |
| return result; | |
| return FromMilliseconds(seconds * 1000); |
We don't need to implement this twice.
src/openrct2/Game.h
Outdated
| namespace TickConversion | ||
| { | ||
| constexpr uint32_t kGameUpdateFPS = 40; | ||
| constexpr float kGameUpdateFPMS = kGameUpdateFPS / 1000.0f; |
There was a problem hiding this comment.
We don't need floats, the value should be milliseconds as integer, so this should result in 25, 1000 / 40 = 25
Suggested change
| constexpr float kGameUpdateFPMS = kGameUpdateFPS / 1000.0f; | |
| constexpr float kGameUpdateFPMS = kGameUpdateFPS / 1000.0f; |
src/openrct2/Game.h
Outdated
| static constexpr GameTicks FromMilliseconds(uint32_t milliseconds) | ||
| { | ||
| GameTicks<T, Tag> result; | ||
| result.Value = milliseconds * TickConversion::kGameUpdateFPMS; |
There was a problem hiding this comment.
We don't need to use floating point math here, see my remark on kGameUpdateFPMS. We should also round it because 1 millisecond would result to 0 otherwise, in this case we have to represent a single tick starting at 0 ms to 25 ms. The formula should be something like:
Suggested change
| result.Value = milliseconds * TickConversion::kGameUpdateFPMS; | |
| result.Value = (milliseconds + (TickConversion::kGameUpdateTimeMs - 1)) / TickConversion::kGameUpdateTimeMs /* 25 */; |
src/openrct2/Game.h
Outdated
Comment on lines
106
to
129
| constexpr bool operator==(const GameTicks& rhs) | ||
| { | ||
| return Value == rhs.Value; | ||
| } | ||
| constexpr bool operator<(const GameTicks& rhs) | ||
| { | ||
| return Value < rhs.Value; | ||
| } | ||
| constexpr bool operator>(const GameTicks& rhs) | ||
| { | ||
| return Value > rhs.Value; | ||
| } | ||
| constexpr bool operator<=(const GameTicks& rhs) | ||
| { | ||
| return Value <= rhs.Value; | ||
| } | ||
| constexpr bool operator>=(const GameTicks& rhs) | ||
| { | ||
| return Value >= rhs.Value; | ||
| } | ||
| constexpr bool operator!=(const GameTicks& rhs) | ||
| { | ||
| return Value != rhs.Value; | ||
| } |
There was a problem hiding this comment.
We use C++20 now so we can probably use the spaceship operator for all of this which is just a single function then.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
For #21395, Create a new strong type for game ticks