Configuration Class
Represents a Carmenta Engine configuration that has been loaded into memory.
Namespace: Carmenta.Engine
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
NuGet/Assembly: Carmenta.Engine.5.16.2.nupkg (in the CECore assembly)
Thread safety: Members defined in this type are, in general, not thread-safe.
Syntax
public class Configuration : EngineObjectRemarks
A Configuration represents a Carmenta Engine configuration file that has been loaded into memory. It provides access to all objects in the configuration file that have been marked as Public in Carmenta Studio.
Inheritance Hierarchy
System.Object (not available in C#)
EngineObject
Configuration
Platforms
Windows, Linux, Android
Configuration Members
The Configuration type has the following members.
Constructors
| Name | Description |
|---|---|
| Configuration | Initializes a new instance of the Configuration class. |
Properties
| Name | Description |
|---|---|
| AdditionalLanguages | Gets the list of languages used in the configuration in addition to the default language. |
| DefaultLanguage | Gets the default language used in the configuration. |
| IsDisposed | Gets a value that tells whether the current Configuration has been disposed. Inherited from EngineObject |
| NativeHandle | Gets the native Carmenta Engine kernel object the current Configuration represents. Inherited from EngineObject |
| PublicNames | Gets the names of all objects in the Configuration that have been marked as Public in Carmenta Studio. |
Methods
| Name | Description |
|---|---|
| Clone | Creates a copy of an object. Inherited from EngineObject |
| Dispose | Releases the reference to the native Carmenta Engine kernel instance the EngineObject represents. Inherited from EngineObject |
| Equals | Determines whether this instance is equal to another. Inherited from EngineObject |
 FromString | Overloaded. Creates a Configuration instance from a String (not available in C#). |
| GetPublicObject | Gets the public object with the specified name from the configuration. |
| Save | Overloaded. Saves the specified object and all objects that it references to a new Carmenta Engine configuration file. |