Project Utils

Introduction

A Blueprint Function Library class used to extract project values

API Reference

Functions

Name	Description	Params	Return
GetProjectId	Get the project ID from the game config file		FString The project ID
GetProjectName	Get the project name from the game config file		FString The project name
GetProjectDescription	Get the project description from the game config file		FString The project description
GetProjectVersion	Get the project version from the game config file		FString The project version
GetProjectCompanyName	Get the project company name from the game config file		FString The project company name
GetProjectCopyrightNotice	Get the project copyright notice from the game config file		FString The project copyright notice
GetProjectLicensingTerms	Get the project licensing terms from the game config file		FString The project licensing terms
GetProjectHomepage	Get the project homepage from the game config file		FString The project homepage

Blueprint Usage

You can use the ProjectUtils using Blueprints by adding one of the following nodes:

• Ultimate Starter Kit > Utils > Project > Get Project Id
• Ultimate Starter Kit > Utils > Project > Get Project Name
• Ultimate Starter Kit > Utils > Project > Get Project Description
• Ultimate Starter Kit > Utils > Project > Get Project Version
• Ultimate Starter Kit > Utils > Project > Get Project Company Name
• Ultimate Starter Kit > Utils > Project > Get Project Copyright Notice
• Ultimate Starter Kit > Utils > Project > Get Project Licensing Terms
• Ultimate Starter Kit > Utils > Project > Get Project Homepage

C++ Usage

Before you can use the plugin, you first need to enable the plugin in your Build.cs file:

PublicDependencyModuleNames.Add("USK");

The ProjectUtils can now be used in any of your C++ files:

#include "USK/Utils/ProjectUtils.h"

void ATestActor::Test()
{
    FString ProjectId = UProjectUtils::GetProjectId();
    FString ProjectName = UProjectUtils::GetProjectName();
    FString ProjectDescription = UProjectUtils::GetProjectDescription();
    FString ProjectVersion = UProjectUtils::GetProjectVersion();
    FString ProjectCompanyName = UProjectUtils::GetProjectCompanyName();
    FString ProjectCopyrightNotice = UProjectUtils::GetProjectCopyrightNotice();
    FString ProjectLicensingTerms = UProjectUtils::GetProjectLicensingTerms();
    FString ProjectHomepage = UProjectUtils::GetProjectHomepage();
}