GlobalRuntimeSettings Class

public class GlobalRuntimeSettings : ScriptableObject

A Scriptable Object class used to store runtime global settings that are used by various SAM components.

Properties

Name Type Description
LoadPriority ThreadPriority

Returns a value indicating the value that Application.backgroundLoadingPriority should be set to when SetLoadPriority returns true.

SetLoadPriority bool

Returns a value indicating whether the first Chunk Streamer that runs in the scene should set the Application.backgroundLoadingPriority property (this controls how long it takes to load data asynchronously vs performance impact on the game while loading in the background).

SortScenesOnFirstLoad bool

Returns a value indicating whether Build Setting scenes should be sorted on first load (within the Awake method of the first Scene Chunk Streamer that runs).

If false, the scenes will be sorted the first time an Asset Chunk needs to be loaded by any Scene Chunk Streamer.

SortingMethod SortingMethod

Returns a value indicating the Sorting Method that should be used to sort Build Setting scenes (which is performed by Scene Chunk Streamers).

TimeSortSpeed bool

Returns a value indicating whether the sorting of Build Setting scenes should be timed. This can be useful for trying to determine which sorting method is fastest.

Methods

GetGlobalRuntimeSettings()

public static GlobalRuntimeSettings GetGlobalRuntimeSettings()

Can be used to retrieve the Global Runtime Settings asset. Using this method is preferred over manually retrieving the asset from Resources because the instance will be cached for future calls.

This method will also create an instance of the settings if no Settings asset could be retrieved from Resources.

Returns

GlobalRuntimeSettings
The Global Runtime Settings asset, if found, or a default instance if one was not found in Resources.