[Ready] Garages continuation #490

ghost · 2018-05-31T20:49:09Z

ghost · 2018-06-01T12:13:37Z

rwengine/src/engine/Garage.cpp

+
+void Garage::updateDoor() {
+    if (swingType) {
+        doorObject->setRotation(glm::angleAxis(fraction * 1.57079632679f,


Originally hardcoded value?

yes, 90 degrees

Maybe it would be clearer to put it as either "pi / 2", "2 * pi * 90 / 360" or "pi * 90 / 180"?

You can use glm::half_pi. ;)

ghost · 2018-06-07T15:31:07Z

Code looks good, but in my opinion you should add some (dump) unit tests. Without them it's hard to check if code is working or not.

ghost · 2018-06-08T19:22:05Z

I'll do tests in separate PR as well as extend functionality that can be actually tested.

ghost · 2018-06-17T15:01:29Z

rwengine/src/engine/Garage.cpp

+        case Type::Respray: {
+            // Find out real value
+            garageTimer = engine->getGameTime() + 2.f;
+            playerVehicle->setHealth(1000.f);


Shouldn't we somehow assert/check there's playerVehicle?

debug assert will do

There doesn't seem to be one? Only RW_UNUSED. I think we should get rid of playerIsInVehicle in this function, and explicitly check if playerVehicle is valid here.

Probably it would be used in the future for other garage types.

ghost · 2018-06-17T15:19:06Z

rwengine/src/engine/Garage.cpp

+
+void Garage::updateDoor() {
+    if (swingType) {
+        doorObject->setRotation(glm::angleAxis(fraction * glm::radians(90.f),


Maybe here also?

Already checked at runtime

It would be better to replace runtime check with debug assert in constructor when it tries to find door object

Don't know what error handling pattern we should use, maybe it even better to use std::optional

JayFoxRox · 2018-06-19T15:48:40Z

.gitignore

@@ -5,3 +5,4 @@ documentation/
 *swp
 *.user*
 .DS_Store
+.vscode/


Such things don't belong in a project gitignore, but your private git configuration.
As vscode is a popular editor, I'd be willing to allow this here. But ideally it wasn't here.

JayFoxRox · 2018-06-19T15:51:44Z

rwengine/src/engine/Garage.hpp

+    void updateDoor();
+
+public:
+    enum class Type {


nit: if these are constants the real game uses there could be a comment about this here.

JayFoxRox · 2018-06-19T15:54:15Z

rwengine/src/engine/Garage.cpp

+    if (p.z < min.z) return false;
+    if (p.x > max.x) return false;
+    if (p.y > max.y) return false;
+    if (p.z > max.z) return false;


nit: this sort of check is a recurring pattern and I wonder if we should have a function for it (if there isn't one already somewhere)

JayFoxRox · 2018-06-19T15:59:31Z

rwengine/src/engine/Garage.cpp

+    auto playerVehicle = plyChar->getCurrentVehicle();
+    bool playerIsInVehicle = playerVehicle != nullptr;
+    RW_UNUSED(playerPosition);
+    RW_UNUSED(playerIsInVehicle);


See other comment about playerIsInVehicle. Not sure how useful creating all those variables is when there is no user (and it's unlikely there'll be one).
It's probably more important to make it obvious that we check for the valitity of playerVehicle when it's being used.

(Other instances too, whenever playerIsInVehicle is not actually used - but even if it's used, I'd consider moving it closer to where it's used: Keep playerVehicle as variable intended for use and playerIsInVehicle as a helper)

Probably it would be used in the future for other garage types.

JayFoxRox · 2018-06-19T16:05:23Z

rwengine/src/engine/GarageController.cpp

@@ -1,702 +0,0 @@
-#include "GarageController.hpp"


For future changes: When renaming files manually git does not automatically keep track of previous history. If you had used git mv GarageController.cpp Garage.cpp, then git should have created a much much nicer history / diff.
That would also potentially have helped in review.

Fixing this retroactively is a bit harder, but theoretically possible (essentially manually changing it back, and then using git mv, then force push - do at your own risk)

Nevermind, GitHub might just handle this poorly - in the "Big Refactor" commit this is displayed properly.

JayFoxRox · 2018-06-19T16:20:13Z

I'll do tests in separate PR as well as extend functionality that can be actually tested.

Ideally, this should have been in the PR description, so everyone knows your intentions and can focus review on what's important.

The git history is not ideal (looking at the commit names alone, it's very hard to tell what's going on).
Unfortunately the move of the source file in particular makes review a lot harder than it should be.

However, skimming over the code it looks mostly fine. I have not tried to run this yet.
If it doesn't break the game, I'd like to merge this soon, as it's better-than-master, and @husho promised unit tests, so we don't want to delay those.

So if someone could test this PR, that would be nice. In order to help with testing, it would be nice if @husho could add more information how to test this to the first post / PR description too (and I'd expect that for future PRs to speed up review): which missions, which garages, ...

I suggest creating an issue about missing garage features or unit tests after merge, so that this is not forgotten in case @husho disappears for whatever reasons.

I'd also appreciate if someone could create replacement issues for #107 which reflects the changes in this code. I'd like to close #107 as it's a meta issue which is hard to maintain.

(Ideally these requests for updated issues should also have been mentioned in the first post / PR description, so it's easier for maintainers to keep track of what to do / look for after a merge)

ghost · 2018-06-21T22:32:08Z

rwengine/CMakeLists.txt

    src/engine/Payphone.cpp
    src/engine/Payphone.hpp
+    src/engine/Garage.cpp


Looks like it breaks alphabetical order.

ghost · 2018-06-21T22:38:07Z

rwengine/src/script/modules/GTA3ModuleImpl.inl

    RW_UNUSED(args);
+   	garage->makeDoorSwing();


Unneeded tab?

ghost · 2018-06-21T22:49:15Z

rwengine/src/engine/Garage.cpp

+    }
+}
+
+float Garage::getDistanceToGarage(glm::vec3 point) {


Arg can be const.

ghost · 2018-06-22T22:14:30Z

rwengine/src/engine/GameWorld.cpp

-    return info;
+Garage* GameWorld::createGarage(const glm::vec3 coord0, const glm::vec3 coord1,
+                                Garage::Type type) {
+    int id = garages.size();


ghost · 2018-06-22T22:14:41Z

rwengine/src/engine/GameWorld.hpp

 #include <engine/Payphone.hpp>
+#include <engine/Garage.hpp>


ghost · 2018-06-22T22:14:56Z

rwengine/src/engine/GameWorld.hpp

 class Payphone;
+class Garage;


Also order.

ghost · 2018-06-22T22:22:48Z

rwengine/src/engine/Garage.cpp

+    max.y = std::max(coord0.y, coord1.y);
+    max.z = std::max(coord0.z, coord1.z);
+
+    glm::vec2 midpoint;


It can also be const glm::vec2 midpoint{(min.x + max.x) / 2, (min.y + max.y) / 2};

ghost · 2018-06-22T22:29:45Z

rwengine/src/engine/Garage.cpp

+    midpoint.y = (min.y + max.y) / 2;
+
+    // Find door objects for this garage
+    for (auto p : engine->instancePool.objects) {


ghost · 2018-06-22T22:30:07Z

rwengine/src/engine/Garage.cpp

+            continue;
+        }
+
+        auto instPos = inst->getPosition();


And here and below?

ghost · 2018-06-23T19:58:27Z

rwengine/src/engine/Garage.hpp

+
+    Garage(GameWorld* engine_, const int id_, const glm::vec3 coord0,
+               const glm::vec3 coord1, const Type type_);
+    ~Garage();


= default;?

ghost · 2018-06-23T19:59:12Z

rwengine/src/engine/Garage.hpp

+
+    void makeDoorSwing();
+
+    bool isObjectInsideGarage(GameObject* object);


Can this and below be const?

ghost

LGTM, been testing mission Don't Spank My Bitch Up. Now garage (place where we leave Stallion) works as should.
(Door for respraying room doesn't work yet, I assume it'll be done in future pull?)

danhedron · 2018-06-25T23:23:30Z

LGTM;

I ran into a few issues with the behaviour so I'll log those. They can be fixed in (smaller) followups.

ghost mentioned this pull request Jun 1, 2018

[Ready] Refactor: moved getPlayer to World class #488

Merged

ghost changed the title ~~[WIP] Garages continuation~~ [Ready] Garages continuation Jun 1, 2018

ghost reviewed Jun 1, 2018

View reviewed changes

ghost mentioned this pull request Jun 1, 2018

Fix ffmpeg deprecated warning: ‘void av_free_packet(AVPacket*)’ #497

Closed

ghost reviewed Jun 17, 2018

View reviewed changes

JayFoxRox reviewed Jun 19, 2018

View reviewed changes

ghost reviewed Jun 21, 2018

View reviewed changes

rwengine/src/script/modules/GTA3ModuleImpl.inl Outdated

RW_UNUSED(args);

garage->makeDoorSwing();

Copy link

ghost Jun 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Unneeded tab?

ghost reviewed Jun 21, 2018

View reviewed changes

rwengine/src/engine/Garage.cpp Outdated

}

}

float Garage::getDistanceToGarage(glm::vec3 point) {

Copy link

ghost Jun 21, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arg can be const.

ghost reviewed Jun 22, 2018

View reviewed changes

rwengine/src/engine/GameWorld.hpp Outdated

#include <engine/Payphone.hpp>

#include <engine/Garage.hpp>

Copy link

ghost Jun 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

order

ghost reviewed Jun 22, 2018

View reviewed changes

rwengine/src/engine/GameWorld.hpp Outdated

class Payphone;

class Garage;

Copy link

ghost Jun 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also order.

ghost reviewed Jun 22, 2018

View reviewed changes

rwengine/src/engine/Garage.cpp Outdated

continue;

}

auto instPos = inst->getPosition();

Copy link

ghost Jun 22, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And here and below?

ghost reviewed Jun 23, 2018

View reviewed changes

rwengine/src/engine/Garage.hpp Outdated

void makeDoorSwing();

bool isObjectInsideGarage(GameObject* object);

Copy link

ghost Jun 23, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can this and below be const?

Garages continuation

92d2a61

ghost approved these changes Jun 24, 2018

View reviewed changes

danhedron merged commit 7d74003 into rwengine:master Jun 25, 2018

ghost deleted the garages_continuation branch June 25, 2018 23:27


		void makeDoorSwing();

		bool isObjectInsideGarage(GameObject* object);

[Ready] Garages continuation #490

[Ready] Garages continuation #490

Conversation

ghost commented May 31, 2018 • edited by ghost Loading

ghost Jun 1, 2018 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost commented Jun 7, 2018

ghost commented Jun 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost Jun 17, 2018 • edited by ghost Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JayFoxRox Jun 19, 2018 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

JayFoxRox commented Jun 19, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ghost left a comment • edited by ghost Loading

Choose a reason for hiding this comment

danhedron commented Jun 25, 2018

ghost commented May 31, 2018 •

edited by ghost

Loading

ghost Jun 1, 2018 •

edited by ghost

Loading

ghost Jun 17, 2018 •

edited by ghost

Loading

JayFoxRox Jun 19, 2018 •

edited

Loading

ghost left a comment •

edited by ghost

Loading