Satisfactory Modding Development

https://docs.ficsit.app/satisfactory-modding/latest/Development/
Admin
This documentation provides comprehensive guides and resources for developers to create, update, and...
Tokens:98,492
Snippets:1,362
Trust Score:8.1
Update:4 months ago
Show doc for...
Tokens:
Raw
### Satisfactory Launch Argument Examples

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/TestingResources.html

Examples of launch arguments for Satisfactory, including options for skipping onboarding, allowing possession of any pawn, loading specific save games, setting start locations, defining session names, and adjusting day/night cycles. Also includes session visibility and password settings.

```text
?skipOnboarding (skip landing animation)
?allowPossessAny (allow possessing any pawn on the map, even if player IDs don't match)
?loadgame=<SaveGame Name Here Without Path and extension>
?startloc<Start Location Tag Name> (see AFGGameMode::ChoosePlayerStart_Implementation)
?sessionName=<Session Name> (sets mSaveSessionName, so apparently it determines autosave file name and probably name visible to other players?)
?DayLength=<Day Length In Minutes>
?NightLength=<Night Length In Minutes>

Regarding Start Location Tag Name:
    - TRADING_POST is the hub APlayerStart actor tag
    - Any APlayerStart actor with matching PlayerStartTag is selected
Regarding Session Name:
    - Apparently there is a system of "bundled saves" that I know nothing about. Further investigation is required.

?Visibility=SV_Private/SV_Public (Session visibility)
?adminpassword=<Admin Password used in console command AdminLogin to gain host privileges>
```

--------------------------------

### Install Prerequisites on Fedora

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Linux/LinuxSetup.html

Installs essential packages for modding on Fedora-based Linux distributions using dnf.

```bash
dnf install git msitools tar zstd dos2unix wine
```

--------------------------------

### Example Visual Studio Project Files Generation Command

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/BeginnersGuide/project_setup.html

An example of a completed command for generating Visual Studio project files in PowerShell. This command requires modification to match your specific file paths.

```powershell
& "C:\Program Files\Unreal Engine - CSS\Engine\Build\BatchFiles\Build.bat" -projectfiles -project="D:\Git\SatisfactoryModLoader\FactoryGame.uproject" -game -rocket -progress
```

--------------------------------

### Register Unreal Engine

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Linux/LinuxSetup.html

Registers the installed Unreal Engine with the system. Replace <ue_dir> with the actual path to your engine installation.

```bash
<ue_dir>/Engine/Binaries/Linux/UnrealVersionSelector -register -unattended
```

--------------------------------

### Open Wwise Authoring Application on Linux

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Linux/LinuxSetup.html

Launches the Wwise Authoring application installed via wwise-cli. This is necessary for generating the Wwise project.

```bash
wine ~/.cache/wwise-cli/wwise/2023.1.14.8770/Authoring/x64/Release/bin/Wwise.exe
```

--------------------------------

### Clone msvc-wine and Download MSVC

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Linux/LinuxSetup.html

Clones the msvc-wine repository and uses its script to download and install a specific version of MSVC and its SDK. Replace <msvc_install_dir> with your desired installation path.

```bash
git clone --branch ue-patches https://github.com/mircearoata/msvc-wine.git

cd msvc-wine

./vsdownload.py --accept-license --dest "<msvc_install_dir>" --msvc-version "17.8" --sdk-version "10.0.22621" --channel "release.ltsc.17.8"

./install.sh "<msvc_install_dir>"
```

--------------------------------

### Accessor Usage Example

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/AccessTransformers.html

Demonstrates how to use the generated getter method for accessing a property, contrasting it with direct member access.

```ini
Accessor=(Class="AFGEquipment", Property="mCostToUse")
```

```cpp
// Instead of this ...
SuitCostToUse = Parent->EquipmentParent->mCostToUse;
// ... use this
SuitCostToUse = Parent->EquipmentParent.GetmCostToUse();
```

--------------------------------

### Example AccessTransformers.ini Configuration

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/AccessTransformers.html

Demonstrates the use of various Access Transformer types including Friend, Accessor, BlueprintReadWrite, BlueprintCallable, EditAnywhere, and BlueprintType in a single INI file.

```ini
[AccessTransformers]
Friend=(Class="AFGBuildableFactory", FriendClass="UAACopyBuildingsComponent")
Friend=(Class="AFGBuildableConveyorBase", FriendClass="UAACopyBuildingsComponent")
Friend=(Class="AFGBuildableConveyorBase", FriendClass="AAAClearInventories")
Friend=(Class="AFGHologram", FriendClass="UAACopyBuildingsComponent")
Accessor=(Class="AFGBuildableFactory", Property="mInventoryPotential")
BlueprintReadWrite=(Class="/Script/FactoryGame.FGSchematicManager", Property="mPurchasedSchematics")
BlueprintCallable=(Class="/Script/FactoryGame.FGDismantleInterface", Function="Dismantle")
EditAnywhere=(Class="/Script/FactoryGame.IconData", Property="ID")
; Note that even though WorldScannableData is a struct, BlueprintReadWrite still uses Class to select it
BlueprintType=(Struct="/Script/FactoryGame.WorldScannableData")
BlueprintReadWrite=(Class="/Script/FactoryGame.WorldScannableData", Property="Actor")
```

--------------------------------

### Example Blueprint Only Mod .uplugin

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/BeginnersGuide/ReleaseMod.html

This JSON configuration is for a Satisfactory mod that contains only Blueprint assets. It specifies basic mod information, localization targets, and the required SML plugin.

```json
{
	"FileVersion": 3,
	"Version": 6,
	"SemVersion": "6.2.1",
	"VersionName": "6.2.1",
	"FriendlyName": "Example Blueprint Only Mod",
	"Description": "An example of a .uplugin for a mod that contains only Blueprint content",
	"Category": "Modding",
	"CreatedBy": "Satisfactory Modding Team",
	"CreatedByURL": "https://github.com/satisfactorymodding/SatisfactoryModLoader",
	"DocsURL": "https://docs.ficsit.app",
	"MarketplaceURL": "",
	"SupportURL": "",
	"CanContainContent": true,
	"IsBetaVersion": false,
	"IsExperimentalVersion": false,
	"Installed": false,
	"LocalizationTargets": [
		{
			"Name": "ExampleMod",
			"LoadingPolicy": "Always"
		}
	],
	"Plugins": [
		{
			"Name": "SML",
			"Enabled": true,
			"SemVersion": "^3.9.0"
		}
	],
	"GameVersion": ">=365306"
}
```

--------------------------------

### Old C++ Configuration Struct Format

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/UpdatingFromSml35.html

Example of the previous format for auto-generated C++ configuration structs. This format is no longer compatible with recent Unreal Engine versions.

```cpp
// Includes left out

/* Struct generated from Mod Configuration Asset '/FasterManualCraftingRedux/FMC_FasterManualCraftingReduxConfig' */
USTRUCT(BlueprintType)
struct FFMC_FasterManualCraftingReduxConfigStruct {
    GENERATED_BODY()
public:
    UPROPERTY(BlueprintReadWrite)
    float DocsExample;

    /* Retrieves active configuration value and returns object of this struct containing it */
    static FFMC_FasterManualCraftingReduxConfigStruct GetActiveConfig() {
        FFMC_FasterManualCraftingReduxConfigStruct ConfigStruct{};
        FConfigId ConfigId{"FasterManualCraftingRedux", ""};
        UConfigManager* ConfigManager = GEngine->GetEngineSubsystem<UConfigManager>();
        ConfigManager->FillConfigurationStruct(ConfigId, FDynamicStructInfo{FFMC_FasterManualCraftingReduxConfigStruct::StaticStruct(), &ConfigStruct});
        return ConfigStruct;
    }
};

```

--------------------------------

### Get Gameplay Tag Container for Class (Blueprint)

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/ContentTagRegistry.html

In Blueprints, use the 'GetContentTagRegistry' node to get a reference to the registry, then use 'Get Gameplay Tag Container For' to retrieve the tag container for a specific class.

```blueprint
GetContentTagRegistry
Get Gameplay Tag Container For
```

--------------------------------

### Download Wwise SDK using wwise-cli

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Linux/LinuxSetup.html

Use this command to download the specified version of the Wwise SDK, including Authoring tools and necessary packages for Windows and Linux deployment platforms.

```bash
./wwise-cli download --sdk-version "2023.1.14.8770" --filter Packages=SDK --filter DeploymentPlatforms=Windows_vc160 --filter DeploymentPlatforms=Windows_vc170 --filter DeploymentPlatforms=Linux --filter DeploymentPlatforms= --filter Packages=Authoring
```

--------------------------------

### Create Abstract Instance at Runtime

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/AbstractInstance.html

This example demonstrates how to create a new abstract instance at runtime using a provided static mesh and transform. It prepares the InstanceData and adds the resulting handle to a management array.

```cpp
static void SetInstanceFromDataStatic( AActor* OwnerActor, const FTransform& ActorTransform, const FInstanceData& InstanceData, FInstanceHandle* &OutHandle, bool bInitializeHidden = false );

AMyModActor::CreateInstanceFromMesh(UStaticMesh* Mesh) {
    // Prepare the InstanceData with a given Mesh at the relative Transform 0.
    FInstanceData InstanceData;
    InstanceData.StaticMesh = Mesh;
    InstanceData.Mobility = EComponentMobility::Static;
    InstanceData.RelativeTransform = FTransform();
    InstanceData.NumCustomDataFloats= 20;

    FInstanceHandle* Handle;
    AAbstractInstanceManager::SetInstanceFromDataStatic(this, GetActorTransform(), InstanceData, Handle);

    // You should add this Handle to the array so we can destroy them if the actor is destroyed (for example, dismantled).
    mInstanceHandles.Add(Handle);
}
```

--------------------------------

### Create Makefile for Unreal Engine Project

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Linux/LinuxSetup.html

Creates a Makefile for building the Unreal Engine project. Replace `<ue_dir>` and `<project_dir>` with the respective paths.

```bash
<ue_dir>/Engine/Build/BatchFiles/Linux/Build.sh -projectfiles -project="<project_dir>/FactoryGame.uproject" -game -Makefile
```

--------------------------------

### Example Data Asset Name

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/AdaMessages.html

An example following the suggested naming convention for a custom ADA message data asset.

```text
MSG_ExampleMod_Tier1-ExampleMilestone
```

--------------------------------

### Example Mod-Specific Tag Name

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/ContentTagRegistry.html

An example of a mod-specific gameplay tag. This demonstrates prefixing a tag with a mod reference for custom functionality.

```text
MyCoolMod.Item.SpecialGeneratorFuel
```

--------------------------------

### Minimum Launch Arguments for Dedicated Server

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/TestingResources.html

Provides the minimum suggested launch arguments for running a dedicated Satisfactory server locally. This configuration is suitable for testing environments where internet connectivity is not required for authentication.

```bash
.\FactoryServer.exe -log -EpicPortal -NoSteamClient
```

--------------------------------

### Example General Tag Names

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/ContentTagRegistry.html

Examples of well-formatted general gameplay tags. These tags are defined by SML and applied to vanilla items and recipes.

```text
Item.Organic
Recipe.Package
```

--------------------------------

### Satisfactory Quick Launch Script

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/TestingResources.html

This PowerShell script allows for quick launching of Satisfactory, with options for Steam or Epic Games Store, client or server, stable or experimental branches, and multiplayer configurations. It requires manual configuration of game and save game paths.

```powershell
param (
	[Parameter(HelpMessage="Launcher to use (steam, epic). Level 1 of the script's GameDirs config option.")]
		[string]$launcher = "steam",
	[Parameter(HelpMessage="Side to use (client, server). Level 2 of the script's GameDirs config option.")]
		[string]$side = "client",
	[Parameter(HelpMessage="Branch to use (stable, experimental). Level 3 of the script's GameDirs config option. Not supported by Steam launcher.")]
		[string]$branch = "stable",
	[Parameter(HelpMessage="When present, launches 2 copies of the game instead of 1. Most other arguments only apply to the first copy, read the script implementation for specifics.")]
		[switch]$multiplayer = $false,
	[Parameter(HelpMessage="When using the -multiplayer flag, how long to wait before launching the second copy in milliseconds.")]
		[int]$multiplayerLaunchDelayMs = 5000,
	[Parameter(HelpMessage="When present, the game will automatically load into the last save file you played. If used with the -multiplayer flag, the save must be in the `common` subfolder of the SaveGames directory.")]
		[switch]$loadLatestSave = $false,
	[Parameter(HelpMessage="When present, the second copy of the game will automatically run the `open 127.0.0.1` console command to connect to the first copy. Must be used with -loadLatestSave flag.")]
		[switch]$clientAutoJoin = $false,
	[Parameter(HelpMessage="Launch the game with the -WaitForDebugger flag, telling SML to hold the game's loading process to allow attaching a C++ debugger.")]
		[switch]$waitForDebugger = $false,
	[Parameter(HelpMessage="Launch the game with the -NoExceptionHandler flag, enabling JIT debugging and disabling the UE crash reporter.")]
		[switch]$noExceptionHandler = $false,
	[Parameter(HelpMessage="When present, print info about what copy of the game is being launched.")]
		[switch]$info = $false,
	[Parameter(HelpMessage="When present, the game will not actually be launched, allowing testing this script. Required files still may be created based on other parameters.")]
		[switch]$test = $false
)

# ========================================================================================================================
# Configure this section to match your system and preferences
# ========================================================================================================================

# Arguments to launch the game with
$CommonArgs = "-EpicPortal", "-log", "-NewConsole", "-nosplash"

# Edit the below "path"s to contain your game paths for these possible install locations
$GameDirs = @{
	steam = @{
		# Note: Steam only allows installing either client or server at a time
		# The script doesn't know which branch you have selected in Steam's own UI
		client = @{
			steam = @{
				# Example: "C:\Steam\steamapps\common\Satisfactory"
				path = "UNSET"
				exeName = "FactoryGameSteam"
				appid = "526870"
				# Example: value 12345678910111213 from path %LOCALAPPDATA%\FactoryGame\Saved\SaveGames\12345678910111213`
			savegameSubfolderName = "UNSET"
			}
		}
		server = @{
			steam = @{
				# Example: "C:\Steam\steamapps\common\SatisfactoryDedicatedServer"
				path = "UNSET"
				exeName = "FactoryServer"
				savegameSubfolderName = "UNSET"
			}
		}
	}
	epic = @{
		client = @{
			stable = @{
				path = "UNSET"
				exeName = "FactoryGameEGS"
				# Example: value 1234letters0and0numbers0longer12 from path %LOCALAPPDATA%\FactoryGame\Saved\SaveGames\1234letters0and0numbers0longer12`
			savegameSubfolderName = "UNSET"
			}
			experimental = @{
				path = "UNSET"
				exeName = "FactoryGameEGS"
				savegameSubfolderName = "UNSET"
			}
		}
		server = @{
			stable = @{
				path = "UNSET"
				exeName = "FactoryServer"
				savegameSubfolderName = "UNSET"
			}
			experimental = @{
				path = "UNSET"
				exeName = "FactoryServer"
				savegameSubfolderName = "UNSET"
			}
		}
	}
	# Optionally define additional -launcher options here. Hierarchy is -launcher > -side > -branch
}

# Optionally configure the window size and position on the screen (2 sets for 2 copies when using -multiplayer)
$Game1 = "$CommonArgs" #, "-windowed", "-WinX=0", "-WinY=32", "ResX=960", "ResY=1040"
$Game2 = "$CommonArgs" #, "-windowed", "-WinX=960", "-WinY=32", "ResX=960", "ResY=1040"

# Location of your savegame root folder for usage with -loadLatestSave

```

--------------------------------

### Retrieve Master Volume Setting

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/Audio.html

Use 'Get FGGame User Settings' and 'Get Float Option Value' to retrieve the master volume setting.

```blueprint
Get FGGame User Settings
Get Float Option Value
```

--------------------------------

### Launch Satisfactory Game Instance

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/TestingResources.html

Launches a Satisfactory game instance with specified arguments. Handles test mode and multiplayer delays.

```powershell
$gameEXE = $gamePathInfo["exeName"]
$GameString = "$($gameDir)\\$($gameEXE).exe"

$Game1 = PrepareArgs $Game1 -applyFirstInstanceOnlyArguments
$Game2 = PrepareArgs $Game2

function BGProcess(){
	if ($test) {
		Write-Output "Test switch used, not actually launching the game"
		Write-Output "Arguments for this game instance: "
		Write-Output @args
		return
	} else {
		Start-Process -NoNewWindow @args
	}
}

BGProcess $GameString $Game1

if ($multiplayer) {
	if (-not $test) {
		sleep -m $multiplayerLaunchDelayMs
	}
} else {
	return
}

BGProcess $GameString $Game2
```

--------------------------------

### C++ Binding Input Actions using Game Instance Module

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/EnhancedInputSystem.html

Demonstrates how to retrieve a custom GameInstanceModule and bind an input action using its stored mappings. This code assumes the GameInstanceModuleManager and MyModGameInstanceModule are set up correctly.

```cpp
UGameInstance* GameInstance = GetWorld()->GetGameInstance(); // May vary depending on the class you're using this from
UGameInstanceModuleManager* GameInstanceModuleManager = GameInstance->GetSubsystem<UGameInstanceModuleManager>();
UMyModGameInstanceModule* MyModGameInstanceModule = Cast<UMyModGameInstanceModule>(GameInstanceModuleManager ->FindModule(TEXT("MyMod")));
EnhancedInputComponent->BindAction(MyModGameInstanceModule->InputActionTagBindings[FGameplayTag::RequestGameplayTag(TEXT("Tag.Name"))], ETriggerEvent::Triggered, this, &Class::Function);
```

--------------------------------

### C++ Retrieving Key Name for Action (Simple)

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/EnhancedInputSystem.html

Uses the 'Get Key Name For Action Simple' function to get a text representation of a player-mappable key action. This returns the default key if no custom binding is found.

```cpp
FGInputLibrary::GetKeyNameForActionSimple(PlayerController, ActionName);
```

--------------------------------

### Example C++ and Blueprint Mod .uplugin

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/BeginnersGuide/ReleaseMod.html

This JSON configuration is for a Satisfactory mod that includes both C++ code and Blueprint assets. It defines the mod's details, lists the C++ runtime module, and specifies required plugins like SML and DependencyMod.

```json
{
	"FileVersion": 3,
	"Version": 6,
	"VersionName": "6.2.1",
	"SemVersion": "6.2.1",
	"FriendlyName": "Example Hybrid Mod",
	"Description": "An example of a .uplugin for a mod that contains both Blueprint content and a C++ module",
	"Category": "Modding",
	"CreatedBy": "Satisfactory Modding Team",
	"CreatedByURL": "https://ficsit.app/",
	"DocsURL": "https://docs.ficsit.app/",
	"MarketplaceURL": "",
	"SupportURL": "",
	"CanContainContent": true,
	"IsBetaVersion": false,
	"IsExperimentalVersion": false,
	"Installed": false,
	"Modules": [
		{
			"Name": "ExampleHybridMod",
			"Type": "Runtime",
			"LoadingPhase": "PostDefault"
		}
	],
	"Plugins": [
		{
			"Name": "SML",
			"SemVersion": "^3.9.0",
			"Enabled": true
		},
		{
			"Name": "DependencyMod",
			"SemVersion": "^1.3.0",
			"Enabled": true
		}
	],
	"GameVersion": ">=365306"
}
```

--------------------------------

### Get Configuration Value Class

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/Configuration.html

Retrieves the class type of the configuration value associated with a property.

```cpp
SubclassOf<UConfigValue> GetValueClass()
```

--------------------------------

### Prepare Command-Line Arguments

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/TestingResources.html

Prepares command-line arguments for launching the game, including options for debugging, multiplayer, and loading the latest save file. This function is crucial for setting up specific game instances for development.

```powershell
function PrepareArgs([string]$baseArgs, [switch]$applyFirstInstanceOnlyArguments, [System.Collections.Hashtable]$pathInfo) {
	$buildArgs = "$baseArgs"
	if ($clientAutoJoin -and (-not $multiplayer -or -not $loadLatestSave)) {
		Write-Error "clientAutoJoin flag requires multiplayer flag and loadLatestSave flag so there is a running game for the client to join"
		exit 1
	}

	if ($applyFirstInstanceOnlyArguments) {
		if ($waitForDebugger) {
			$buildArgs = "$buildArgs", "-WaitForDebugger"
		}
		if ($noExceptionHandler) {
			$buildArgs = "$buildArgs", "-NoExceptionHandler"
		}
		if ($loadLatestSave) {
			if ($multiplayer) {
				# Multiplayer GUID consistency consequence: can't see platform save files. Must be in the `common` subfolder
				$saveFolderUserId = "common"
			} else {
				$saveFolderUserId = $gamePathInfo["savegameSubfolderName"]
			}

			if (($saveFolderUserId -eq $null) -or ($saveFolderUserId -eq "UNSET")) {
				Write-Error "Selected game install is missing 'savegameSubfolderName' data in your script config options. It should be the name of the subfolder within your save directory containing the save files you want to use with -loadLatestSave. Your same file directory was entered as: $SaveFolder"
				exit 1
			}

			$fullSaveFolder = "$SaveFolder\$saveFolderUserId"

			# https://stackoverflow.com/questions/9675658/powershell-get-childitem-most-recent-file-in-directory
			# Steam keeps a steam_autocloud.vdf file in here that isn't a savegame
			$latestSaveFile = (Get-ChildItem $fullSaveFolder -Attributes !Directory -Filter *.sav | sort LastWriteTime | select -last 1)
			$latestSaveFileName = $latestSaveFile.Basename

			# Use Satisfactory's -ini feature to avoid needing to create an ini file and use -EngineINI (Unreal) to pass this info along
			$buildArgs = "$buildArgs", "-ini:Engine:[/Script/EngineSettings.GameMapsSettings]:GameDefaultMap=/Game/FactoryGame/Map/GameLevel01/Persistent_Level.Persistent_Level,[/Script/EngineSettings.GameMapsSettings]:LocalMapOptions=?skipOnboarding?listen?loadgame=$latestSaveFileName"
		}
	} else {
		# Only the second copy should run the connect command for clientAutoJoin
		if ($clientAutoJoin) {
			# ExecCmds uses UE syntax: https://dev.epicgames.com/documentation/unreal-engine/unreal-engine-command-line-arguments-reference
			$buildArgs = "$buildArgs", '-ExecCmds="open 127.0.0.1"'
		}
	}
	if ($multiplayer) {
		# CustomConfig: Satisfactory specific. More consistent multiplayer GUIDs
		# Multiprocess: Make the game not write user settings and other .ini files (unsafe operation while multiple copies are open)
		$buildArgs = "$buildArgs", "-CustomConfig=", "-Multiprocess"
	}
	return $buildArgs
}

$gameDir = $gamePathInfo["path"]
```

--------------------------------

### Get Associated Configuration Property

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/Configuration.html

Retrieves the property object that defines the structure and constraints for this configuration value.

```cpp
UConfigProperty GetAssociatedProperty()
```

--------------------------------

### C++ GetUpgradedActor Implementation

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/BuildableHolograms.html

This C++ function should return the target actor that is being upgraded. In this example, it returns the `mUpgradedActor` member variable.

```cpp
/** Get the target upgraded Actor */
virtual AActor* GetUpgradedActor() const override;
```

--------------------------------

### Configure Game Window Position and Resolution

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/TestingResources.html

Use command-line arguments to set the game window position and resolution. This is useful for arranging multiple game instances on screen.

```powershell
$Args1 = "-EpicPortal", "-NoSteamClient", '-Username="'+$Username1+'"', "-WinX=0", "-WinY=32", "ResX=960", "ResY=1040"
```

```powershell
$Args2 = "-EpicPortal", "-NoSteamClient", '-Username="'+$Username2+'"', "-WinX=960", "-WinY=32", "ResX=960", "ResY=1040"
```

--------------------------------

### Redirect Logs with Full Path (Launch Argument)

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/Logging.html

Use the LogCategoryFiles launch argument with a full path to place the log file in the same directory as the default FactoryGame.log.

```bash
-LogCategoryFiles="C:\Users\YourUsernameHere\AppData\Local\FactoryGame\Saved\Logs\LogSlate.log=LogSlate"
```

--------------------------------

### Get Mod Content Registry Instance

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/Registry.html

Retrieves the global instance of the Mod Content Registry. This is essential for registering modded content.

```c++
UModContentRegistry* Get(UObject* WorldContext)
```

--------------------------------

### Dispatch Lifecycle Event Example

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/ModModules.html

Override DispatchLifecycleEvent to handle different phases of module lifecycle events using a switch statement.

```cpp
void AMyModule::DispatchLifecycleEvent(const ELifecyclePhase Phase) {
    Super::DispatchLifecycleEvent(Phase);

    switch (Phase) {
        case ELifecyclePhase::Construction:
            // Custom initialization logic for construction phase
            break;
        case ELifecyclePhase::Initialization:
            // Custom initialization logic for initialization phase
            break;
        case ELifecyclePhase::PostInitialization:
            // Custom initialization logic for post-initialization phase
            break;
        default:
            break;
    }
}
```

--------------------------------

### C++ Root Module Constructor Example

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/ModLoader/ModModules.html

To make a C++ defined module a root module, set 'bRootModule = true;' in its constructor.

```cpp
bool bRootModule = true;
// Constructor
MyRootModule::MyRootModule() {
    bRootModule = true;
}
```

--------------------------------

### Include for DOREPLIFETIME Macro

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/UpdatingFromSml35.html

To use the DOREPLIFETIME macro, you must now include the 'Net/UnrealNetwork.h' header file. Failure to do so will result in compilation errors.

```cpp
#include "Net/UnrealNetwork.h"

```

--------------------------------

### Register Cheat Manager Extension

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/CheatBoard.html

Register your custom cheat manager extension class when the game starts. This makes your cheats available.

```cpp
void FMyCoolModModule::StartupModule()
{
    UCheatManager::OnCheatManagerCreatedDelegate.AddLambda([](UCheatManager* CheatManager)
    {
      CheatManager->AddCheatManagerExtension(NewObject<UMyCoolCheatManagerExtension>(CheatManager));
    });
}
```

--------------------------------

### Spawn Lightweight Buildable from Script

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/UpdatingFromSml37.html

To spawn lightweight buildables from script, construct an `FGBuildableSpawnStrategy`, set its properties, and then call the 'Spawn Buildable from Class' method.

```csharp
local spawnStrategy = FGBuildableSpawnStrategy();
spawnStrategy.Set
(
	"Built with Recipe",
	true
);
spawnStrategy.Set
(
	"Play Build Effect",
	true
);
spawnStrategy.SpawnBuildableFromClass
(
	MyBuildableClass,
	MyTransform
);
```

--------------------------------

### Show Disqualifier on Invalid Placement

Source: https://docs.ficsit.app/satisfactory-modding/latest/Development/Satisfactory/BuildableHolograms.html

Add a disqualifier to signal invalid placement while keeping the hologram visible. This example requires snapping to a wall.

```cpp
void UMyModGlassWindowHologram::CheckValidPlacement() {
	if (!IsValid(Snapped) || !Snapped->IsA<AFGBuildableWall>()) {
		AddConstructDisqualifier(UFGCDMustSnapWall::StaticClass());
	}

	Super::CheckValidPlacement();
}
```
Tokens:
Raw