string Description { get; set; }

book_4_sparkGenerated
code_blocksInput

Description

The Description property of the SceneFile class provides a textual description of the scene. This property is marked as obsolete, and it is recommended to use the GetMetadata method instead to retrieve metadata information about the scene.

Usage

To access the description of a scene, it is advised to use the GetMetadata method with the appropriate parameters to retrieve the desired metadata. The Description property is still accessible but should be avoided in favor of the recommended method.

Example

// Example of using GetMetadata to retrieve the description
SceneFile sceneFile = new SceneFile();
string description = sceneFile.GetMetadata("Description", "Default Description");

// Accessing the obsolete Description property (not recommended)
string obsoleteDescription = sceneFile.Description;