string Description { get; set; }

book_4_sparkGenerated
code_blocksInput

Description

The Description property of the MapClass class provides a human-readable name for the entity class used in the map editor. This name is intended to be easily understood by users, offering a clear and concise description of the entity's purpose or function within the map.

Usage

Use the Description property to retrieve or set a descriptive name for a map entity class. This can be useful for displaying information in user interfaces or documentation where a more user-friendly name is preferred over technical identifiers.

Example

// Example of setting the Description property
MapClass mapEntity = new MapClass();
mapEntity.Description = "Physics Prop";

// Example of getting the Description property
string entityDescription = mapEntity.Description;
// entityDescription now holds the value "Physics Prop"