Namespace Requirement

Ensure the following directive is included in scripts using these utilities:

using UtilityCore;

Async Scene Loader

Configuration Parameters

Implementation

Attach this script to the root of the loading panel prefab. Instantiate the object before calling the load method.

public GameObject loadingScreenPrefab;

public void InitiateLevelTransition() {
    SceneManager.Reference.NextLevelName = "HubLevel";
    AsyncLoadScene manager = Instantiate(loadingScreenPrefab).GetComponent<AsyncLoadScene>();
}

Binary Data Storage

Available Operations

Usage Example

[System.Serializable]
public class UserProfile {
    public int playerScore = 100;
    public string playerName = "GuestUser";
}

string savePath = Application.persistentDataPath + "/savedata.bin";
BinaryDataSerializer.SaveBinary<UserProfile>(new UserProfile(), savePath);
var data = BinaryDataSerializer.LoadBinary<UserProfile>(savePath);
Debug.Log(data.playerName);

Camera Positioning Controller

Required Attributes

Attach the controller script to the Main Camera game object. Assign the desired target transform in the Inspector.

JSON File Handling

Supported Functions

Code Snippet

[System.Serializable]
public class ConfigSettings {
    public bool enableEffects = true;
    public int difficultyLevel = 1;
}

JsonFileHandler.WriteToFile(ConfigSettings settings, Application.streamingAssetsPath + "/config.json");
Console.WriteLine(JsonFileHandler.ReadFile<ConfigSettings>(Application.streamingAssetsPath + "/config.json").difficultyLevel);

Localization Manager

Configuration Keys

Setup Instructions

1. Create an empty GameObject and attach LocalLanguageManager. Set the file path.
2. Attach LocalLanguageListener to UI Text comopnents that require translation. Set translationKey to match entries in the language config.
3. Add a ToggleGroup component to the container holding multiple language selector toggles. Bind individual Toggles to the group to prevent conflict.

Global Instance Patterns

Mono-based Singleton

Inherit from the base singleton class directly within your MonoBehaviour.

public class GameManager : BaseMonoSingleton<GameManager> {
    public int currentLevelId = 1;
    void OnEnable() {
        Debug.Log("Game State:", BaseMonoSingleton<GameManager>.Instance.LevelId);
    }
}

Static Accessor Pattern

Utilize a static wrapper class for non-MonoBehavior singletons.

public class NetworkService : UnityEngine.MonoBehaviour {
    // Standard MonoBehaviour logic
    void Start() {
        var instance = StaticSingleInstance<NetworkService>.Get();
        Debug.Log(instance.ToString());
    }
}

Audio System Control

Array Dependencies

Ensure both arrays maintain identical ordering. Index i in soundLookup must correspond to Index i in clipSources.

XML Persistence Utility

Data Transfer Methods

Example Implementation

[System.Serializable]
public class PlayerStats {
    public int healthPoints = 100;
    public string characterClass = "Warrior";
}

void SaveGameSession() {
    XmlHelper.Save(new PlayerStats(), Application.persistentDataPath + "/profile.xml");
}

void LoadGameSession() {
    var stats = XmlHelper.Load<PlayerStats>(Application.persistentDataPath + "/profile.xml");
    Debug.Log(stats.healthPoints);
}