Skeleton classes for world-gen project #596

IsaiahBlanks · 2021-06-07T21:51:46Z

Description

This PR contains classes that represent the skeleton of the world-gen project

Testing

There should be a couple of print statements showing that the Generators are called. The Generator Implementation classes should have their build() method called

Outstanding Work

Several aspects of this PR may need to be changed in the future, including the data structure used to hold the Generators and the particular way those Generators are instantiated

NicholasBatesNZ · 2021-06-08T21:02:50Z

Congratulations on your first official PR for GSoC 🎉
You're off to a good start but I can see some problems. The way you've written this doesn't seem to allow for the generic feature generator classes we talked about a few weeks ago, unless I'm missing something and you can enlighten me?
As I see it, the WorldBuilder should only be pulling in two types of classes. 1) classes that extend SolSystemGenerator and 2) classes that extend, let's say, a FeatureGenerator.
You should be thinking in terms of "how modular can I be?" Having the engine explicitly look for a PlanetGenerator is not particularly modular.
Ping me on Discord for more clarity, or to tell me why I'm wrong :)
What is the purpose of the WorldGenerator annotation? It seems a bit superfluous to me.

IsaacLic

Most of my comments are minor. I have two main comments:

As @NicholasBatesNZ said, I'm not sure what purpose the WorldGenerator annotation is serving. A bit of Javadoc would go a long way, which brings me to my second point:
Your code could definitely benefit from some documentation. Imagine someone encountering your code two years down the line. A bit of documentation could make the difference between five minutes and five hours spent understanding what a class does. IIRC, the policy is to have class-level documentation for every class, and to use method-level documentation whenever necessary. I could be wrong about that, though.

engine/src/main/java/org/destinationsol/world/WorldBuilder.java

engine/src/main/java/org/destinationsol/world/generators/SolSystemGenerator.java

Added FeatureGenerator class, improved comments

IsaacLic

Looking much better :)

I have a bunch of minor comments about improving the Javadoc. In short: think about what it'd be like if you were encountering this code for the first time, and had no idea what it did or how it worked. The Javadoc should provide an overview, so that the code can be easily understood.

engine/src/main/java/org/destinationsol/world/WorldBuilder.java

engine/src/main/java/org/destinationsol/world/generators/FeatureGenerator.java

engine/src/main/java/org/destinationsol/world/generators/MazeGeneratorImpl.java

engine/src/main/java/org/destinationsol/world/generators/SolSystemGenerator.java

IsaacLic · 2021-06-11T14:28:10Z

engine/src/main/java/org/destinationsol/world/generators/SolSystemGenerator.java

+    }
+
+    /**
+     * This method is intended to first set up the SolSystem during world generation and then initialize all the


I'm not sure I understand. Does this build the actual SolSystem? If it does, wouldn't the FeatureGenerators have been initialized beforehand?

@IsaacLic The FeatureGenerators are the next step in the world-gen process. Meaning first the SolSystem's own features are generated (belts, position in the world, deciding which Features to use), then the FeatureGenerators themselves are built (i.e. Planets, Mazes, etc. have their own build() function, and SolSystemGenerator will finish up by calling those). I think the chart in the proposal clarifies a little bit here

That makes sense. How about "set up the broader SolSystem" and "use FeatureGenerators to do X" ? That might clarify the relationship between the two

IsaacLic · 2021-06-11T14:28:25Z

engine/src/main/java/org/destinationsol/world/generators/SolSystemGeneratorImpl.java

+package org.destinationsol.world.generators;
+
+/**
+ * This class is a concrete implementation of a SolSystem and handles its creation. This class has access to the


Improved Javadoc, added WorldBuilder tests, cleaned up WorldBuilder

IsaacLic

This looks pretty good! I have some minor comments, but nothing that'd be a big refactoring or anything

engine/src/main/java/org/destinationsol/world/WorldBuilder.java

IsaacLic · 2021-06-17T22:21:35Z

engine/src/main/java/org/destinationsol/world/WorldBuilder.java

+     * This method calls setFeatureGenerators() on each SolSystemGenerator to give each SolSystem access to other
+     * FeatureGenerators (Planets, Mazes, etc.) so they can be initialized and incorporated into the SolSystem.
+     */
+    private void initializeSolSystemGenerators() {


I think the discussion in Discord about random vs selected generators is worthwhile, but shouldn't hold back the basic worldgen structure from progressing. If you rename this something like initializeSolarSystemGeneratorsUsingRandomGenerators() and rename build() to buildUsingRandomGenerators(), that leaves open the possibility of using selected generators without needing to code a specific implementation of that idea. Lmk if that makes sense to you

@IsaacLic I think the change you are suggesting makes sense (though I might think initializeRandomSolarSystemGenerators() might by a little less wordy. What do you think?)

Sounds good to me :)

engine/src/main/java/org/destinationsol/world/WorldBuilder.java

IsaacLic · 2021-06-17T22:26:12Z

engine/src/main/java/org/destinationsol/world/generators/FeatureGenerator.java

+package org.destinationsol.world.generators;
+
+/**
+ * This class represents the abstract version of any feature which will populate the game's SolSystems, such as Planets,


Will the subclasses create the planets/mazes, or will they be the planets/mazes? It could be that I'm not understanding how you're using the word "feature", but it sounds like the subclasses will be instances of features, meaning that the subclasses would be Planet instances.

@IsaacLic Yeah I think the word 'be' is more correct. I had meant create as in place themselves into the world. Meaning each SolarSystemGenerator will pick whichever FeatureGenerators it wants to use, and then those FeatureGenerators will be capable of placing an instance of themselves into the game

Edit: After our discussion on Discord, the Generator classes will be responsible for building their respective Classes. Those will be represented in the game during runtime using the classes already in place.

engine/src/main/java/org/destinationsol/world/generators/SolSystemGeneratorImpl.java

engine/src/test/java/org/destinationsol/world/WorldBuilderTest.java

Updated comments, renamed SolSystem to SolarSystem, renamed build()

NicholasBatesNZ · 2021-06-19T22:58:36Z

engine/src/main/java/org/destinationsol/world/WorldBuilder.java

+import org.destinationsol.world.generators.SolarSystemGenerator;
+
+import java.lang.reflect.Modifier;
+import java.util.*;


No star imports please. https://stackoverflow.com/questions/3587071/disable-intellij-starred-package-imports

NicholasBatesNZ · 2021-06-19T23:05:54Z

engine/src/main/java/org/destinationsol/world/generators/SolarSystemGenerator.java

+    public abstract void build();
+
+    public void setFeatureGenerators(ArrayList<FeatureGenerator> generators) {
+        featureGenerators = (ArrayList<FeatureGenerator>) generators.clone();


Two questions:

Do we really need the cast here?

Is it necessary to take a deep copy or could we instead use the references with featureGenerators.addAll(generators)?

I believe arraylist.clone() actually makes a shallow copy, so either could work

NicholasBatesNZ · 2021-06-19T23:07:48Z

engine/src/main/java/org/destinationsol/world/generators/SolarSystemGeneratorImpl.java

+
+    @Override
+    public void build() {
+        for(FeatureGenerator generator : featureGenerators) {


for( -> for ( for consistency
(could also use a .forEach lambda but that's not important :P )

NicholasBatesNZ · 2021-06-19T23:08:06Z

engine/src/test/java/org/destinationsol/world/WorldBuilderTest.java

+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+
+import static org.junit.jupiter.api.Assertions.*;


star import

Shallow copy, removed star imports

IsaacLic · 2021-06-21T02:07:25Z

engine/src/main/java/org/destinationsol/world/generators/SolarSystemGeneratorImpl.java

+package org.destinationsol.world.generators;
+
+/**
+ * This class is a concrete implementation of a SolarSystem and handles creation of elements


SolarSystemGenerator ?

IsaacLic · 2021-06-21T02:08:54Z

engine/src/main/java/org/destinationsol/world/WorldBuilder.java

+/**
+ * This class is the starting point for world generation. When a new world is created, this class first retrieves
+ * all Generator classes and then initiates each SolarSystem's build process. Two types of world generation classes are
+ * retrieved: those that subclass SolarSystemGenerator and those at subclass FeatureGenerator.


those that subclass FeatureGenerator

Typos fixed

Skeleton classes for world gen project

ff04410

IsaacLic reviewed Jun 8, 2021

View reviewed changes

b3f756f

Added FeatureGenerator class, improved comments

IsaacLic reviewed Jun 11, 2021

View reviewed changes

9cbb23a

Improved Javadoc, added WorldBuilder tests, cleaned up WorldBuilder

IsaacLic reviewed Jun 17, 2021

View reviewed changes

63567f5

Updated comments, renamed SolSystem to SolarSystem, renamed build()

NicholasBatesNZ changed the base branch from develop to gsoc2021 June 19, 2021 22:56

NicholasBatesNZ requested changes Jun 19, 2021

View reviewed changes

4beacae

Shallow copy, removed star imports

IsaacLic reviewed Jun 21, 2021

View reviewed changes

33fb5d6

Typos fixed

NicholasBatesNZ merged commit 9bfdca7 into MovingBlocks:gsoc2021 Jun 22, 2021

Skeleton classes for world-gen project #596

Skeleton classes for world-gen project #596

Uh oh!

Conversation

IsaiahBlanks commented Jun 7, 2021

Description

Testing

Outstanding Work

Uh oh!

NicholasBatesNZ commented Jun 8, 2021

Uh oh!

IsaacLic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

IsaacLic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IsaacLic left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IsaiahBlanks Jun 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IsaiahBlanks Jun 18, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IsaacLic Jun 21, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

IsaiahBlanks Jun 18, 2021 •

edited

Loading

IsaiahBlanks Jun 18, 2021 •

edited

Loading

IsaacLic Jun 21, 2021 •

edited

Loading