refactor(GameState): extract common code from MainMenu and HeadlessSetup #4809
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| // Copyright 2021 The Terasology Foundation | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
|
|
||
| package org.terasology.engine.core.modes; | ||
|
|
||
| import org.terasology.engine.context.Context; | ||
| import org.terasology.engine.core.ComponentSystemManager; | ||
| import org.terasology.engine.core.bootstrap.EntitySystemSetupUtil; | ||
| import org.terasology.engine.entitySystem.entity.EntityRef; | ||
| import org.terasology.engine.entitySystem.entity.internal.EngineEntityManager; | ||
| import org.terasology.engine.entitySystem.event.internal.EventSystem; | ||
| import org.terasology.engine.logic.console.Console; | ||
| import org.terasology.engine.logic.console.ConsoleImpl; | ||
| import org.terasology.engine.logic.console.ConsoleSystem; | ||
| import org.terasology.engine.logic.console.commands.CoreCommands; | ||
| import org.terasology.engine.logic.players.LocalPlayer; | ||
| import org.terasology.engine.network.ClientComponent; | ||
| import org.terasology.engine.recording.DirectionAndOriginPosRecorderList; | ||
| import org.terasology.engine.recording.RecordAndReplayCurrentStatus; | ||
| import org.terasology.engine.registry.CoreRegistry; | ||
| import org.terasology.engine.rendering.nui.NUIManager; | ||
| import org.terasology.engine.rendering.nui.internal.NUIManagerInternal; | ||
| import org.terasology.engine.rendering.nui.internal.TerasologyCanvasRenderer; | ||
| import org.terasology.nui.canvas.CanvasRenderer; | ||
|
|
||
| import static com.google.common.base.Verify.verifyNotNull; | ||
|
|
||
| public abstract class AbstractState implements GameState { | ||
| protected Context context; | ||
| protected EngineEntityManager entityManager; | ||
| protected EventSystem eventSystem; | ||
| protected ComponentSystemManager componentSystemManager; | ||
|
|
||
| protected void initEntityAndComponentManagers() { | ||
| verifyNotNull(context); | ||
| CoreRegistry.setContext(context); | ||
|
|
||
| // let's get the entity event system running | ||
| EntitySystemSetupUtil.addEntityManagementRelatedClasses(context); | ||
| entityManager = context.get(EngineEntityManager.class); | ||
|
|
||
| eventSystem = context.get(EventSystem.class); | ||
| context.put(Console.class, new ConsoleImpl(context)); | ||
|
|
||
| NUIManager nuiManager = new NUIManagerInternal((TerasologyCanvasRenderer) context.get(CanvasRenderer.class), context); | ||
| context.put(NUIManager.class, nuiManager); | ||
|
|
||
| componentSystemManager = new ComponentSystemManager(context); | ||
| context.put(ComponentSystemManager.class, componentSystemManager); | ||
|
|
||
| componentSystemManager.register(new ConsoleSystem(), "engine:ConsoleSystem"); | ||
| componentSystemManager.register(new CoreCommands(), "engine:CoreCommands"); | ||
| } | ||
|
|
||
| protected static void createLocalPlayer(Context context) { | ||
| EngineEntityManager entityManager = context.get(EngineEntityManager.class); | ||
| EntityRef localPlayerEntity = entityManager.create(new ClientComponent()); | ||
| LocalPlayer localPlayer = new LocalPlayer(); | ||
| localPlayer.setRecordAndReplayClasses(context.get(DirectionAndOriginPosRecorderList.class), | ||
| context.get(RecordAndReplayCurrentStatus.class)); | ||
| context.put(LocalPlayer.class, localPlayer); | ||
| localPlayer.setClientEntity(localPlayerEntity); | ||
| } | ||
|
|
||
| @Override | ||
| public void dispose(boolean shuttingDown) { | ||
| // Apparently this can be disposed of before it is completely initialized? Probably only during | ||
| // crashes, but crashing again during shutdown complicates the diagnosis. | ||
| if (eventSystem != null) { | ||
| eventSystem.process(); | ||
| } | ||
| if (componentSystemManager != null) { | ||
| componentSystemManager.shutdown(); | ||
| } | ||
| if (entityManager != null) { | ||
| entityManager.clear(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public Context getContext() { | ||
| return context; | ||
| } | ||
| } | ||
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
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
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
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This does a lot with the
contextand strictly requires it. Would it make sense to make thecontextand argument of this method, similar to how we pass it tocreateLocalPlayerexplcitly?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
createLocalPlayeris the method I extracted first. Passingcontextlet me make itstatic, which I figured would make it easier to move the method later if there were more copies of it.Then I realized if I shuffled some things around I could also extract all this stuff that went in to
initEntityAndComponentManagers, but because it assigns things to multiple instance fields, it wouldn't work as static.Upon review, I see that all these fields are direct references to a thing in the context, so it probably could be split in to a "populate
contextwith this stuff" static method and then a "pull some references out of context and cache them in fields" non-static method, but I worried that would make it more difficult to review if I included it in the same PR.