Difference between revisions of "API:PluginConfigNode"

From Kerbal Space Program Wiki
Jump to: navigation, search
(Created page with "{{Namespace:KSP.IO}} == PluginConfigNode == :''See PluginConfiguration for a full description. A node full of configuration values. {{PropertiesStart}} {{ThisProperty |t...")
 
 
(3 intermediate revisions by the same user not shown)
Line 4: Line 4:
  
 
A node full of configuration values.
 
A node full of configuration values.
 
 
{{PropertiesStart}}
 
{{PropertiesStart}}
{{ThisProperty
+
{{Property
|type=object
+
|type=Object
|key=string
+
|name=this[{{arg|string|key}}]
|getset=get; set;
+
|desc=Get or set the value of a configuration key
|desc=Get or set a named value within the node.
+
|hasget=1
 +
|hasset=1
 
}}
 
}}
 
{{PropertiesEnd}}
 
{{PropertiesEnd}}
 
{{MethodsStart}}
 
{{MethodsStart}}
 +
{{Method
 +
|returntype=void
 +
|returndesc=
 +
|name=SetValue
 +
|args={{arg|string|key}}, {{arg|object|value}}
 +
|desc=Set the value of a configuration key
 +
}}
 
{{Method
 
{{Method
 
|returntype=PluginConfigNode
 
|returntype=PluginConfigNode
Line 19: Line 26:
 
|name=GetParent
 
|name=GetParent
 
|args=
 
|args=
|desc=Get the parent of this configuration node, or a null (if it has none).
+
|desc=Gets the parent of this node.
 
}}
 
}}
 
{{Method
 
{{Method
Line 25: Line 32:
 
|returndesc=
 
|returndesc=
 
|name=GetValue<T>
 
|name=GetValue<T>
|args=string key
+
|args={{arg|string|key}}
|desc=Get the requested item from the node, or null if it isn't present
+
|desc=Get the value of a configuration key.
 
}}
 
}}
 
{{Method
 
{{Method
Line 32: Line 39:
 
|returndesc=
 
|returndesc=
 
|name=GetValue<T>
 
|name=GetValue<T>
|args=string key, T _default
+
|args={{arg|string|key}}, {{arg|T|_default}}
|desc=Get the requested item from the node, or the default if it isn't present
+
|desc=Get the value of a configuration key.
}}
 
{{Method
 
|returntype=void
 
|returndesc=
 
|name=SetValue
 
|args=string key, object value
 
|desc=Set the requested item in the node.
 
 
}}
 
}}
 
{{MethodsEnd}}
 
{{MethodsEnd}}

Latest revision as of 22:39, 12 October 2012

KSP.IO Namespace
BinaryReader · BinaryWriter · File · FileInfo · FileStream · IOException · IOTools · IOUtils · MemoryStream · PluginConfigNode · PluginConfiguration · TextReader · TextWriter

PluginConfigNode

See PluginConfiguration for a full description.

A node full of configuration values.

Properties

The following are public properties available in PluginConfigNode.

Signature Description
Object this[string key] { get; set; } Get or set the value of a configuration key

Methods

The following are methods included in PluginConfigNode.

Signature Description
void SetValue(string key, object value) Set the value of a configuration key
PluginConfigNode GetParent() Gets the parent of this node.
T GetValue<T>(string key) Get the value of a configuration key.
T GetValue<T>(string key, T _default) Get the value of a configuration key.