feat: AttachableBehaviour and ComponentController #3518
+2,789
−139
Conversation
This file contains hidden or 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
…d-object-controller
…d-object-controller
Minor XML API fixes.
Simplified the nameof AttachableBehaviour.Detach to just Detach.
…d-object-controller
Refactoring the ComponentController to provide more flexibility as well as being able to have component entries that will apply the inverse of the current ComponentController's current state....which allows for switching between different sets of components depending upon the controller's state.
switching to a Light component as opposed to BoxCollider as BoxCollider requires the physics package and we are just testing the functionality of ComponentController and not specifically any one other type of component.
…d-object-controller
…d-object-controller
…d-object-controller
Using RPCs and synchronizing the property being set using NetworkBehaviour.OnSynchronize in order to assure order of operations when it comes to messages. Updated the ComponentController to be able to stagger state updates in the event this occurs (wip and I might remove this part and not allow changes to state until any pending state is finished).
Minor adjustment to the range for delays allow it to be zero. Fixing spelling issues.
Had to make some minor adjustments in order to assure that users could handle sending any last micro-second tasks on any spawned instances prior to them despawning. Added NetworkBehaviour.OnNetworkPreDespawn. Did a slight order of operations on NetworkManager.Shutdown internal in order to assure sending RPCs during despawn would still work. Minor adjustments to the new helper components associated with this PR.
…d-object-controller
…d-object-controller
Fixing some PVP related issues.
Several improvements on the attach and detach processing. Added the ability to tie ComponentControllers to AttachableBehaviours in order to auto-notify when something is attaching and detaching. Several adjustments to fix the issue with ungraceful disconnects and re-synchronizing attachables. Added forced change based on flags applied, things like when an AttachableNode is despawning, changing ownership, or being destroyed then local instances, whether authority or not, will all force the attach or detach state. Added an internal virtual destroy method on NetworkBehaviour to allow for helper components to assure on destroy script is invoked.
Adding documentation to an undocumented enum value.
Updating the core components based on some bugs discovered during testing. Updated the AttachableBehaviourTests to validate the different types of auto-detach flag combinations. Fixed some spelling issues with "detatch" (not sure why I got into that habit)...corrected to "detach".
…d-object-controller
Adjusting the component section from a file and folder context. Adjusting the component section for the table of contents. Adding foundational components and helpers sub-sections to network components section. Moved foundational components into the foundational (components) folder and updated links and image paths. Adding AttachableBehaviour document along with images. Added some place holders for AttachableNode and ComponentController. Fixing some invalid image paths.
Removing white space at the end of lines.
Removing trickier white spaces...
Adding `AttachableNode` and `ComponentController` sections. Added "Synchronized RPC driven fields" section to networkbehaviour-synchronize.md. Updated various areas based on the additions.
Resolving more white space issues.
…d-object-controller
Removing a single sneaky white space.
EmandM
reviewed
Jul 30, 2025
| @@ -218,7 +218,7 @@ private static void CheckPrefabStage(PrefabStage prefabStage) | |||
| s_PrefabAsset = AssetDatabase.LoadAssetAtPath<NetworkObject>(s_PrefabStage.assetPath); | |||
| } | |||
|
|
|||
| if (s_PrefabInstance.GlobalObjectIdHash != s_PrefabAsset.GlobalObjectIdHash) | |||
| if (s_PrefabAsset && s_PrefabInstance && s_PrefabInstance.GlobalObjectIdHash != s_PrefabAsset.GlobalObjectIdHash) | |||
There was a problem hiding this comment.
This code is inside a block of if (s_PrefabInstance) {} (line 200)
Suggested change
| if (s_PrefabAsset && s_PrefabInstance && s_PrefabInstance.GlobalObjectIdHash != s_PrefabAsset.GlobalObjectIdHash) | |
| if (s_PrefabAsset && s_PrefabInstance.GlobalObjectIdHash != s_PrefabAsset.GlobalObjectIdHash) |
| /// Used for naming each element entry. | ||
| /// </summary> | ||
| [HideInInspector] | ||
| public string name; |
There was a problem hiding this comment.
Do you mind explaining what this does?
| /// as the <see cref="NetworkObject"/>, this will automatically create a child and add an | ||
| /// <see cref="AttachableBehaviour"/> to that. | ||
| /// </remarks> | ||
| protected virtual void OnValidate() |
There was a problem hiding this comment.
To my untrained eye, it looks like there's two OnValidate functions and only one will run? What's the difference between this OnValidate and the function on line 45?
Comment on lines
+99
to
+103
| if (componentController == null) | ||
| { | ||
| continue; | ||
| } | ||
| componentController.OnValidate(); |
There was a problem hiding this comment.
Definitely a nitpick: null propagation can simplify this block.
Using the null conditional allows you to change
foreach (var componentController in ComponentControllers)
{
if (componentController == null)
{
continue;
}
componentController.OnValidate();
}to
foreach (var componentController in ComponentControllers)
{
componentController?.OnValidate();
}
Comment on lines
+195
to
+205
| protected AttachState m_AttachState { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// The original parent of this <see cref="AttachableBehaviour"/> instance. | ||
| /// </summary> | ||
| protected GameObject m_DefaultParent { get; private set; } | ||
|
|
||
| /// <summary> | ||
| /// If attached, attaching, or detaching this will be the <see cref="AttachableNode"/> this <see cref="AttachableBehaviour"/> instance is attached to. | ||
| /// </summary> | ||
| protected AttachableNode m_AttachableNode { get; private set; } |
There was a problem hiding this comment.
Out of interest, why do these need to be protected rather than internal?
| } | ||
|
|
||
| var propertyInfo = Components[i].Component.GetType().GetProperty("enabled", BindingFlags.Instance | BindingFlags.Public); | ||
| if (propertyInfo == null && propertyInfo.PropertyType != typeof(bool)) |
There was a problem hiding this comment.
I'm guessing we don't want to check for is null && has property?
| // Scan the GameObject and all of its children and add all valid components to the list. | ||
| foreach (var entry in gameObjectsToScan) | ||
| { | ||
| var asGameObject = entry.Component as GameObject; |
There was a problem hiding this comment.
Does it make sense to change gameObjectsToScan from List<ComponentEntry> to List<GameObject>?
| gameObjectsToScan.Clear(); | ||
|
|
||
| // Final (third) pass is to name each list element item as the component is normally viewed in the inspector view. | ||
| for (int i = 0; i < Components.Count; i++) |
There was a problem hiding this comment.
very nit: This might be simpler to read as a foreach loop. I do not have strong feelings about this.
Comment on lines
+308
to
+309
| // Example of how to synchronize late joining clients when using an RPC to update | ||
| // a local property's state. |
There was a problem hiding this comment.
Is this comment valid here?
| /// to have the owner be the authority of this <see cref="ComponentController"/> instance. | ||
| /// </remarks> | ||
| /// <returns>true = has authoriy | false = does not have authority</returns> | ||
| protected virtual bool OnHasAuthority() |
There was a problem hiding this comment.
Same comment as for AttachableBehaviour here
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.
AttachableBehaviour and Support Components
The purpose of this PR (feat) is to address the complexity of "picking up" or "dropping" an item in the world which can become complex when using the traditional
NetworkObjectparenting pattern. In this PR there are three primary components added to help reduce this complexity:AttachableBehaviour: Provides "out of the box" support for attaching (i.e. parenting) a nested childGameObjectthat includes anAttachableBehaviourcomponent to another nested childGameObjectwith anAttachableNodecomponent that is associated with a differentNetworkObject.AttachableNode: This component is required by theAttachableBehaviourcomponent in order to be able to attach (i.e. parent) to another GameObject without having to parent the entireNetworkObjectcomponent theAttachableBehaviourcomponent is associated with.ComponentController: This component provides users the ability to synchronize the enabling or disabling of anyObjectderived component that has anenabledproperty.This PR also incorporates a new "Helpers" subfolder under the NGO components folder where additional helper components will live.
Documentation Update
New Documentation
AttachableBehaviour
Network Components Section Update
New Foundational Components Section
New Helper Components Section
NetworkBehaviour.OnNetworkPreDespawn
Added another virtual method to
NetworkBehaviour,OnNetworkPreDespawn, that is invoked before running through the despawn sequence for theNetworkObjectand allNetworkBehaviourchildren of theNetworkObjectbeing despawned. This provides an opportunity to do any kind of cleanup up or last micro-second state updates prior to despawning.Changelog
AttachableBehaviourhelper component to provide an alternate approach to parenting items without using theNetworkObjectparenting.AttachableNodehelper component that is used byAttachableBehaviouras the target node for parenting.ComponentControllerhelper component that can be used to synchronize the enabling and disabling of components and can be used in conjunction withAttachableBehaviour.NetworkBehaviour.OnNetworkPreDespawnthat is invoked before running through the despawn sequence for theNetworkObjectand allNetworkBehaviourchildren of theNetworkObjectbeing despawned.Testing and Documentation
AttachableBehaviourTestsComponentControllerTestsBackport
This is a v2.x only feature.