In addition to the previous component, this optional component acts as a manager for the WBP_CharacterEditor widget and enables the in-game character editor.
Its process is simple and consists only of Initialize. Though there are some helper functions.
¶ Replication [V6]
Since the Replication Update, in addition to the previous component there is minor replication in this component as well. It got the new Function: Initialize From Character Begin Play specific to BP_Character Begin Play and the new Event: Initialize (Replicable), which is called from within the function.
¶ Function: Initialize From Character Begin Play [V6]
This function binds to the new OnInitialized dispatcher of the BP_CharacterEditor component, which can be used in BP_Character. The function then calls Event: Initialize (Replicable).
¶ Event: Initialize (Replicable) [V6]
Depending on the calling character instance of Function: Initialize From Character Begin Play this event in turn has either a server-side or client-side path.
- On server it goes the server path, replicates to client, and initializes locally.
- On standalone it goes the server path but calls the seen event as a local event and initializes locally.
- On not-replicating clients it goes the client path and initializes locally.
The server is depending on IsPlayerControlled, while the client is depending on IsLocallyControlled. This is because joining clients have one or more frames during joining where IsPlayerControlled is not true for them, as the game still needs to replicate the character possession. Relying on IsLocallyControlled is fine for clients, as other local characters are controlled by the server, so only the player character is locally controlled.
Checking one of these properties is necessary to avoid spawning/initializing a Character Editor for uncontrolled characters. Passing these tests, we finally call Event: Initialize.
¶ Event: Initialize
This event takes the input ShowEditor, which is passed down to Event: Proceed With Loaded CDAs as you can see in the screenshot. Focusing on the current event itself, it first validates the Character Customization component of the owning character. Then:
- It spawns and initializes BP_CameraStudio (rather than [V1 removed] searching for it in the level) to enable camera controls for the editor.
- It spawns and initializes BP_LightStudio to enable a custom light scenario for the editor. The spawn is optional in case there is already a BP_LightStudio in the level, which can be used.
- It spawns WBP_CDA_Loader, binds Event: Proceed With Loaded CDAs to its OnCDAsLoaded event and loads all active available Customization Data Assets, whereafter the dispatcher is called and the bound event gets called. (See CDA Initialization at First Startup for details on WBP_CDA_Loader.)
¶ Event: Proceed With Loaded CDAs
Once all available Customization Data Assets are loaded, the initialization can proceed.
First, the [V2] WBP_Instructions is spawned to show minimalist in-game controls. After that, the Character Editor is spawned and initialized. All the editor logic happens in that widget itself.
Finally, the Character Editor will be either opened or closed by default, depending on ShowEditor that was passed through Event: Initialize.
- ShowEditor is false: it calls Event: Close Editor.
- ShowEditor is true: it first checks if we are a networking client:
- Networking server or standalone: it calls Event: Open Editor instantly.
- Networking client: Temporarily closes the editor and freezes input mode by setting it to UI. Then there is a delay of 1.5 seconds to compensate Unreal Engine handling general game replication for joining players and then call Event: Open Editor.
The delay is used like the delay in BP_CharacterCustomization > Event: Initialize (Replicable) > Server_Initialize.
¶ Event: Open Editor
This event shows the editor, changes the player’s input mode, show the mouse cursor, enables BP_CameraStudio and initializes the BP_LightStudio with a given profile. [V5] Afterwards, OnOpen is called if you desire binding on it.
¶ Event: Close Editor
This event reverts all the opening steps. [V5] Afterwards, OnClosed is called if you desire binding on it.