KSPDev.ConfigUtils Namespace |
A set of the utility methods and classes to make accessing config files easier. You may choose to work with each field indepengly (as you usually do in KSP), and only use the convinience methods. Or you may make use of the meta programming approach and only add the attributes to the fields that require persistence.
If you like dealing with the settings on yourselves, then you may find useful the ConfigAccessor helper class that simplifies the routine operations with the configuration nodes and files.
If you'd like to start using the new attributes system that allows annotation of the settings fields, then you may start from the PersistentFieldAttribute class. This topic has good code examples that will help you to start.
Classes| Class | Description | |
|---|---|---|
  | AbstractCollectionTypeProto | Base class for a type proto handler that can deal with collections. |
| AbstractOrdinaryValueTypeProto | A base class for a proto of a single value. |
| AbstractPersistentFieldsFileAttribute | A base for any persistent fields file annotation. |
| BasePersistentFieldAttribute | A base for any persitent field annotation. |
| ConfigAccessor | A service class that simplifies accessing configuration files. |
| ConfigNodePatch | Class that describes how to modify a part's config node. |
| ConfigNodePatchTestSection |
Config class that specifies how to check if the part qualifies for patching.
|
| ConfigNodePatchUpgradeSection | Config class that specifies how pacth the qualifying part. |
| ConfigNodePatchUpgradeSectionRules | Config class that defines patching rules. |
| GenericCollectionTypeProto | A proto handler for a simple generic collection. |
| KspTypesProto | A proto for handling all KSP specific types. |
| PartNodePatcher | A set of methods to deal with the part config compatibility. |
| PartNodeUtils | Various methods to deal with the config nodes of the parts. |
| PersistentCustomFieldAttribute | Attribute for the persistent fields that can use custom type protos. |
| PersistentFieldAttribute | A simple attribute for the fields that need (de)serialization. |
| PersistentFieldsDatabaseAttribute |
A simple annotation to associate a persistent group with a game's database key.
|
| PersistentFieldsFileAttribute |
A simple annotation to associate a persistent group with a configuration file.
|
| PrimitiveTypesProto | A proto for handling C# primitive types. |
| StandardOrdinaryTypesProto | Proto to handle all primitive C# types and common Unity/KSP types. |
| StdPersistentGroups | Group names that have special meaning. |
Interfaces| Interface | Description | |
|---|---|---|
 | IPersistentField | Interface for the simple types that need custom (de)serialization logic. |
Enumerations| Enumeration | Description | |
|---|---|---|
 | ConfigNodePatchPatchAction | Action to perform on the part or module. |