ConfigAccessor Class |
A service class that simplifies accessing configuration files.
Inheritance HierarchySystemObject
KSPDev.ConfigUtilsConfigAccessor
KSPDev.ConfigUtilsConfigAccessor
Namespace: KSPDev.ConfigUtils
Assembly: KSPDev_Utils.2.0 (in KSPDev_Utils.2.0.dll) Version: 2.0 for KSP v1.8+
SyntaxThe ConfigAccessor type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | AddNodeByPath(ConfigNode, String, ConfigNode) | Adds a repeated node in the config by a path. |
| AddNodeByPath(ConfigNode, String, ConfigNode) | Adds a repeated node in the config by a path. |
| AddValueByPath(ConfigNode, String, String) | Adds a repeated value in config node by a path. |
| AddValueByPath(ConfigNode, String, String) | Adds a repeated value in config node by a path. |
 | CopyPartConfigFromPrefab | Copies the custom part fields from the prefab into the instance. |
| GetNodeByPath(ConfigNode, String, Boolean) | Reads a node from config node by a path. |
| GetNodeByPath(ConfigNode, String, Boolean) | Reads a node from config node by a path. |
| GetNodesByPath(ConfigNode, String) | Reads repeated nodes from config node by a path. |
| GetNodesByPath(ConfigNode, String) | Reads repeated nodes from config node by a path. |
| GetValueByPath(ConfigNode, String) | Reads a value from config node by a path. |
| GetValueByPath(ConfigNode, String) | Reads a value from config node by a path. |
| GetValueByPathT(ConfigNode, String, AbstractOrdinaryValueTypeProto) |
Reads a value of an arbitrary type T from the config node.
|
| GetValueByPathT(ConfigNode, String, AbstractOrdinaryValueTypeProto) |
Reads a value of an arbitrary type T from the config node.
|
| GetValueByPathT(ConfigNode, String, T, AbstractOrdinaryValueTypeProto) |
Reads a value of arbitrary type T from a config node.
|
| GetValueByPathT(ConfigNode, String, T, AbstractOrdinaryValueTypeProto) |
Reads a value of arbitrary type T from a config node.
|
| GetValuesByPath(ConfigNode, String) | Reads repeated values from config node by a path. |
| GetValuesByPath(ConfigNode, String) | Reads repeated values from config node by a path. |
| ReadFieldsFromDatabase | Reads values of the annotated persistent fields from a config file. |
| ReadFieldsFromFile | Reads values of the annotated persistent fields from a config file. |
| ReadFieldsFromNode | Reads the values of the annotated persistent fields from a config node. |
| ReadFieldsInType | Reads the persistent fields from the URI specified by the class annotation. |
| ReadPartConfig | Reads custom type fields from the part's config. |
| SetNodeByPath(ConfigNode, String, ConfigNode) | Sets a node in config node by a path. |
| SetNodeByPath(ConfigNode, String, ConfigNode) | Sets a node in config node by a path. |
| SetValueByPath(ConfigNode, String, String) | Sets a value in config node by a path. |
| SetValueByPath(ConfigNode, String, String) | Sets a value in config node by a path. |
| SetValueByPathT(ConfigNode, String, T, AbstractOrdinaryValueTypeProto) |
Stores a value of arbitrary type T into a config node.
|
| SetValueByPathT(ConfigNode, String, T, AbstractOrdinaryValueTypeProto) |
Stores a value of arbitrary type T into a config node.
|
| StrToPath | Transforms a URL-like string path into the nodes path. |
| WriteFieldsFromType |
Writes persistent fields into the config files specified by the class annotation.
|
| WriteFieldsIntoFile | Writes values of the annotated persistent fields into a file. |
| WriteFieldsIntoNode | Writes values of the annotated persistent fields into a config node. |
RemarksThis class provides a lot of useful methods to deal with values in game's configuration
files. There are low level methods that deal with nodes and values, and there are high level
methods that use metadata from the annotated fields.
See Also