[Unreal] Refactor agones component to subsystem by GloryOfNight · Pull Request #4033 · agones-dev/agones

GloryOfNight · 2024-11-11T11:26:57Z

What type of PR is this?

/kind breaking

What this PR does / Why we need it:

Refactor agones from using ActorComponent to GameInstanceSubsystem:
- Subsystem seems to be more suitable for agones in general. Documentation on topic
- Subsystem will persist across all worlds.
- Subsystem easier to integrate, since it does not require being part of some actor which it should be attached to. You can see updated documentation to understand how much easier it to use.
- Subsystem would be created only for server builds, saving on resources.
- Subsystem could be easily obtained using Get() function from any UObject context
Removed final keyword, to allow basing of Subsystem and overriding it's behavior.
Added bDisableAutoHealthPing variable to disable auto call to HealthPing() during Initialization
Added blueprint readwrite flag support for HealthRateSeconds, bDisableAutoHealthPing, bDisableAutoConnect to improve blueprint support slightly.
Space&Tabs mix change to just Tabs

Special notes for your reviewer:

That is something we used internally for some time already and I think people can benefit from that change.
This change would break code that was previously dependent on AgonesComponent.

build.log

agones-bot · 2024-11-11T12:38:53Z

Build Succeeded 🥳

Build Id: 3ab0bc2c-9618-471a-af73-0f58076bc7d9

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.45.0-dev-0d0c4d4
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.45.0-dev-0d0c4d4
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.45.0-dev-0d0c4d4-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.45.0-dev-0d0c4d4
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.45.0-dev-0d0c4d4
Linux C++ SDK (build): agonessdk-1.45.0-dev-0d0c4d4-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.45.0-dev-0d0c4d4.zip

A preview of the website (the last 30 builds are retained):

https://0d0c4d4-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4033/head:pr_4033 && git checkout pr_4033
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.45.0-dev-0d0c4d4

agones-bot · 2024-11-11T16:10:03Z

Build Failed 😭

Build Id: 25d7e15e-cdf9-4b3c-a2b3-6d160f0177d3

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

gongmax · 2024-11-13T16:32:35Z

/gcbrun

agones-bot · 2024-11-13T17:39:22Z

Build Succeeded 🥳

Build Id: f3e2be54-b83b-4fda-ae32-fdb1375a3cc7

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.45.0-dev-b87eaef
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.45.0-dev-b87eaef
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.45.0-dev-b87eaef-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.45.0-dev-b87eaef
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.45.0-dev-b87eaef
Linux C++ SDK (build): agonessdk-1.45.0-dev-b87eaef-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.45.0-dev-b87eaef.zip

A preview of the website (the last 30 builds are retained):

https://b87eaef-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4033/head:pr_4033 && git checkout pr_4033
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.45.0-dev-b87eaef

igooch · 2025-01-29T05:14:06Z

@KAllan357 as an Unreal contributor, could you please review? This PR in particular is marked as breaking.

igooch · 2025-01-31T19:45:06Z

/gcbrun

agones-bot · 2025-01-31T20:42:15Z

Build Failed 😭

Build Id: c1fe56e2-bbf7-4971-a783-6e629d40a987

Status: FAILURE

To get permission to view the Cloud Build view, join the agones-discuss Google Group.

igooch · 2025-03-10T18:30:24Z

@KiaArmani @DevChagrins @oniku2929 as recent Unreal contributors, could you please take a look at this PR?

DevChagrins · 2025-03-10T19:37:06Z

@KiaArmani @DevChagrins @oniku2929 as recent Unreal contributors, could you please take a look at this PR?

Without pulling the code and building locally, the code looks good to me.

# Conflicts: # sdks/unreal/Agones/Source/Agones/Private/AgonesSubsystem.cpp

markmandel · 2025-11-10T15:21:40Z

/gcbrun

Copilot

Pull Request Overview

This PR refactors the Agones Unreal SDK from an ActorComponent-based architecture to a GameInstanceSubsystem-based architecture. The changes improve lifecycle management, reduce dependencies, and provide better integration with Unreal Engine's subsystem framework.

Migrates from UAgonesComponent to UAgonesSubsystem using Unreal's subsystem architecture
Introduces a custom FTimerManager to handle timer operations independently of World
Adds new configuration options for disabling auto-connect and auto-health ping features

Reviewed Changes

Copilot reviewed 5 out of 10 changed files in this pull request and generated no comments.

Show a summary per file

File	Description
sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h	Renamed and refactored header to use GameInstanceSubsystem base class, added subsystem lifecycle methods
sdks/unreal/Agones/Source/Agones/Private/AgonesSubsystem.cpp	Renamed and refactored implementation to use subsystem lifecycle and custom timer management
sdks/unreal/Agones/Agones.Build.cs	Removed unnecessary Slate dependencies
sdks/unreal/Agones/Agones.uplugin	Changed plugin loading phase from PreLoadingScreen to Default
site/static/images/unreal_bp_usage.png	Added new image asset for documentation

Comments suppressed due to low confidence (4)

sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:121

Corrected spelling of 'Retrive' to 'Retrieve'.
sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:140
Corrected spelling of 'HealhPing' to 'HealthPing'.
sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:163
Corrected spelling of 'initilization' to 'initialization'.
sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:111
The documentation still refers to this as 'Unreal Component' but it's now a subsystem. This should be updated to 'Unreal Subsystem' for accuracy.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

markmandel · 2025-11-10T15:30:28Z

Swinging about around on this - CoPilot did find some spelling errors that we should fix please:

Corrected spelling of 'Retrive' to 'Retrieve'.
sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:140

Corrected spelling of 'HealhPing' to 'HealthPing'.
sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:163

Corrected spelling of 'initilization' to 'initialization'.
sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:111

The documentation still refers to this as 'Unreal Component' but it's now a subsystem. This should be updated to 'Unreal Subsystem' for accuracy.

agones-bot · 2025-11-10T16:23:06Z

Build Succeeded 🥳

Build Id: 23824d24-3a84-4ee8-83ab-a093855cc5bd

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-5983142
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-5983142
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-5983142-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-5983142
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-5983142
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-5983142
Linux C++ SDK (build): agonessdk-1.54.0-dev-5983142-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-5983142.zip

A preview of the website (the last 30 builds are retained):

https://5983142-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4033/head:pr_4033 && git checkout pr_4033
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-5983142

Copilot

Pull Request Overview

Copilot reviewed 5 out of 10 changed files in this pull request and generated no new comments.

Comments suppressed due to low confidence (3)

sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h:121

The comment contains a typo: "Retrive" should be "Retrieve".
sdks/unreal/Agones/Source/Agones/Private/AgonesSubsystem.cpp:110
[nitpick] Consider adding a null check for GameInstance before dereferencing. While GetSubsystem may handle null internally, being explicit about the null case improves code clarity and prevents potential crashes if the implementation changes.
sdks/unreal/Agones/Source/Agones/Private/AgonesSubsystem.cpp:116
[nitpick] UE_SERVER is a compile-time preprocessor definition. Using it in a runtime function like ShouldCreateSubsystem means the subsystem will either always be created or never created depending on the build configuration. This is correct for the intended behavior (server-only subsystem), but the documentation comment should clarify that this only affects compilation, not runtime server detection.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

markmandel

/gcbrun

Seems legit to me. other than spelling errors.

Any objection to merging @igooch , @lacroixthomas ?

sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h

markmandel · 2025-11-10T19:24:32Z

/gcbrun

Co-authored-by: Mark Mandel <mark@compoundtheory.com>

site/content/en/docs/Guides/Client SDKs/unreal.md

keith-miller · 2025-11-10T19:49:00Z

lgtm and a welcome change!

markmandel · 2025-11-10T19:51:02Z

Part of me wants to merge this on the 24th, because then it's been a full year 🤦🏻‍♂️ (not really, let's get this in soon)

mumbles something about really needing some approvers with Unreal knowledge

agones-bot · 2025-11-10T20:51:30Z

Build Succeeded 🥳

Build Id: bdf91344-485b-47ed-9615-1cbb291475d7

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-a9d003f
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-a9d003f
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-a9d003f-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-a9d003f
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-a9d003f
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-a9d003f
Linux C++ SDK (build): agonessdk-1.54.0-dev-a9d003f-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-a9d003f.zip

A preview of the website (the last 30 builds are retained):

https://a9d003f-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4033/head:pr_4033 && git checkout pr_4033
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-a9d003f

markmandel · 2025-11-10T21:31:42Z

/gcbrun

agones-bot · 2025-11-10T22:34:25Z

Build Succeeded 🥳

Build Id: 67aa95be-fe38-4053-86e1-5303e1698a29

The following development artifacts have been built, and will exist for the next 30 days:

image: us-docker.pkg.dev/agones-images/ci/agones-controller:1.54.0-dev-e981303
image: us-docker.pkg.dev/agones-images/ci/agones-extensions:1.54.0-dev-e981303
image: us-docker.pkg.dev/agones-images/ci/agones-sdk:1.54.0-dev-e981303-linux
image: us-docker.pkg.dev/agones-images/ci/agones-ping:1.54.0-dev-e981303
image: us-docker.pkg.dev/agones-images/ci/agones-allocator:1.54.0-dev-e981303
image: us-docker.pkg.dev/agones-images/ci/agones-processor:1.54.0-dev-e981303
Linux C++ SDK (build): agonessdk-1.54.0-dev-e981303-linux-arch_64.tar.gz
SDK Server: agonessdk-server-1.54.0-dev-e981303.zip

A preview of the website (the last 30 builds are retained):

https://e981303-dot-preview-dot-agones-images.appspot.com/

To install this version:

git fetch https://github.com/googleforgames/agones.git pull/4033/head:pr_4033 && git checkout pr_4033
helm install agones ./install/helm/agones --namespace agones-system --set agones.image.registry=us-docker.pkg.dev/agones-images/ci --set agones.image.tag=1.54.0-dev-e981303

markmandel

Le'ts get this merged. Finally!

* refactor agones component to subsystem * - add blueprint read&write exposure * - remove unused module dependecies * - changed loading phase to default * removed depency on FTSTickerObjectBase * move tick bind from constructor to init * Update sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h

refactor agones component to subsystem

2ca6bc7

github-actions bot added kind/breaking Breaking change size/M labels Nov 11, 2024

fix typo

0d0c4d4

GloryOfNight marked this pull request as ready for review November 11, 2024 15:19

changes for site

b87eaef

GloryOfNight marked this pull request as draft November 12, 2024 12:03

GloryOfNight added 5 commits December 14, 2024 23:21

- add blueprint read&write exposure

729e6b0

- remove unused module dependecies

4664575

- changed loading phase to default

094dfa7

removed depency on FTSTickerObjectBase

db36aca

Merge branch 'main' into refactor-to-subsystem

f12bd30

GloryOfNight marked this pull request as ready for review December 14, 2024 22:49

GloryOfNight added 4 commits January 30, 2025 16:07

Merge branch 'main' into refactor-to-subsystem

582fb5f

fixes for latest ue

18844d8

move tick bind from constructor to init

e65f60c

fix missing version header

0a510a0

GloryOfNight added 2 commits June 12, 2025 19:50

Merge branch 'main' into refactor-to-subsystem

ccb99f3

Merge branch 'main' into refactor-to-subsystem

5983142

# Conflicts: # sdks/unreal/Agones/Source/Agones/Private/AgonesSubsystem.cpp

markmandel requested a review from Copilot November 10, 2025 15:21

Copilot AI reviewed Nov 10, 2025

View reviewed changes

fix spelling

a9d003f

markmandel requested a review from Copilot November 10, 2025 19:21

Copilot AI reviewed Nov 10, 2025

View reviewed changes

markmandel reviewed Nov 10, 2025

View reviewed changes

sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h Outdated Show resolved Hide resolved

Update sdks/unreal/Agones/Source/Agones/Public/AgonesSubsystem.h

a3541bd

Co-authored-by: Mark Mandel <mark@compoundtheory.com>

markmandel reviewed Nov 10, 2025

View reviewed changes

site/content/en/docs/Guides/Client SDKs/unreal.md Show resolved Hide resolved

re-add old unreal.md under feature flag

12b439b

Merge branch 'main' into refactor-to-subsystem

e981303

markmandel approved these changes Nov 12, 2025

View reviewed changes

markmandel merged commit a3b5712 into agones-dev:main Nov 12, 2025
4 checks passed

GloryOfNight deleted the refactor-to-subsystem branch November 12, 2025 08:46

Conversation

GloryOfNight commented Nov 11, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

agones-bot commented Nov 11, 2024

Uh oh!

agones-bot commented Nov 11, 2024

Uh oh!

gongmax commented Nov 13, 2024

Uh oh!

agones-bot commented Nov 13, 2024

Uh oh!

igooch commented Jan 29, 2025

Uh oh!

igooch commented Jan 31, 2025

Uh oh!

agones-bot commented Jan 31, 2025

Uh oh!

igooch commented Mar 10, 2025

Uh oh!

DevChagrins commented Mar 10, 2025

Uh oh!

markmandel commented Nov 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

markmandel commented Nov 10, 2025

Uh oh!

agones-bot commented Nov 10, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Uh oh!

markmandel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

markmandel commented Nov 10, 2025

Uh oh!

Uh oh!

keith-miller commented Nov 10, 2025

Uh oh!

markmandel commented Nov 10, 2025

Uh oh!

agones-bot commented Nov 10, 2025

Uh oh!

markmandel commented Nov 10, 2025

Uh oh!

agones-bot commented Nov 10, 2025

Uh oh!

markmandel left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

8 participants

GloryOfNight commented Nov 11, 2024 •

edited

Loading