Skip to content

Game.UI.InGame.PhotoModeUIPreset

Assembly:
Assembly-CSharp

Namespace:
Game.UI.InGame

Type:
class

Base:
System.Object

Summary:
Simple data container used by the Photo Mode UI system. Holds a descriptor describing the preset, a string identifier, and a PhotoModeProperty used for injection/configuration. This class is a plain-old-data holder with public fields that are intended to be populated by code that registers or configures photo-mode presets (e.g., mods, content packs, or UI initialization code).

Fields

  • public PresetDescriptor descriptor
    Descriptor object that contains the data describing the preset (camera parameters, post-processing settings, etc.). The exact contents and structure are defined by the PresetDescriptor type (likely declared in the cinematic camera / rendering area). This field is public and can be assigned directly.

  • public string id
    String identifier for the preset. Used to reference, save, or select the preset within UI lists or persistent storage. No internal validation is performed by this class.

  • public PhotoModeProperty injectionProperty
    Holds a PhotoModeProperty instance used for injection/configuration into the UI or camera system. The PhotoModeProperty type encapsulates a single configurable property for photo mode; this field links that property to the preset.

Properties

This type defines no C# properties — only public fields.

Constructors

  • public PhotoModeUIPreset()
    The default (compiler-provided) constructor initializes reference fields to null. Instances are typically created and then populated by assigning the public fields.

Methods

This type declares no methods.

Usage Example

using Game.Rendering.CinematicCamera;
using Game.UI.InGame;

// Create and populate a preset instance
var preset = new PhotoModeUIPreset
{
    id = "sunset_preset",
    descriptor = new PresetDescriptor()
    {
        // populate descriptor fields as appropriate (camera transform, FOV, tone mapping, etc.)
    },
    injectionProperty = new PhotoModeProperty()
    {
        // set property values relevant for this preset
    }
};

// Register or apply the preset using the surrounding photo-mode UI system
// (registration/apply API is outside this class and depends on the game's UI code).

Notes: - All members are public fields — there is no encapsulation or validation inside this type. Consumers are expected to manage lifecycle and correctness. - The concrete structure and available fields of PresetDescriptor and PhotoModeProperty are defined elsewhere (likely in the Game.Rendering.CinematicCamera namespace). Use those types' documentation to know what to set.