Class

Namespace

CoreFramework.Settings

A custom settings provider for managing version settings in the Project Settings. This provider allows users to configure versioning and backward compatibility.

public class VersionProjectSettingsProvider : SettingsProvider

Inheritance

object

SettingsProvider

Extension Methods

TaskExtensions.AsCompletedTask<T>(T)

Constructors

VersionProjectSettingsProvider(string, SettingsScope)

Creates a new instance of the VersionProjectSettingsProvider.

private VersionProjectSettingsProvider(string path, SettingsScope scopes = SettingsScope.Project)

Parameters

path string

The path of the settings provider, e.g., “Project/Core Framework/Version Settings”.

scopes SettingsScope

The scope of the settings provider (default is SettingsScope.Project).

Fields

HelpBoxText

private const string HelpBoxText = "Every Save File has a Version Number.\nWhen trying to load a save, only files with the current version (or the minimum legacy version) will be valid.\nChanging the version number here will overwrite the Project->Player->Version."

Field Value

string

SettingsPath

private const string SettingsPath = "Project/Core Framework/Version Settings"

Field Value

string

_legacySupport

private bool _legacySupport

Field Value

bool

Methods

CreateSaveSettingsProvider()

Creates an instance of the SaveProjectSettingsProvider and registers it with the [SettingsProvider] attribute.

[SettingsProvider]
public static SettingsProvider CreateSaveSettingsProvider()

Returns

SettingsProvider

The created SaveProjectSettingsProvider instance.

OnGUI(string)

Use this function to draw the UI based on IMGUI. This assumes you haven't added any children to the rootElement passed to the OnActivate function.

public override void OnGUI(string searchContext)

Parameters

searchContext string

Search context for the Settings window. Used to show or hide relevant properties.

ProjectSettingsMenuItem()

Opens the Project Settings window at the specified path when the menu item is selected.

[MenuItem("Core Framework/Version Settings")]
private static void ProjectSettingsMenuItem()