| Class | Description |
|---|---|
| KeyValues |
| Enum | Description |
|---|---|
| KvDataTypes | KeyValue data value types |
| Function | Description |
|---|---|
| CreateKeyValues | Creates a new KeyValues structure. The Handle must always be closed. |
| FileToKeyValues | Converts a file to a KeyValues tree. The file is read into the current position of the tree. |
| KeyValuesToFile | Converts a KeyValues tree to a file. The tree is dumped from the current position. |
| KvCopySubkeys | Makes a new copy of all subkeys in the origin KeyValues to the destination KeyValues. NOTE: All KeyValues are processed from the current location not the root one. |
| KvDeleteKey | Removes the given key from the current position. |
| KvDeleteThis | Removes the current sub-key and attempts to set the position to the sub-key after the removed one. If no such sub-key exists, the position will be the parent key in the traversal stack. Given the sub-key having position "N" in the traversal stack, the removal will always take place from position "N-1." |
| KvFindKeyById | Finds a KeyValues name by id. |
| KvGetColor | Retrieves a set of color values from a KeyValues key. |
| KvGetDataType | Returns the data type at a key. |
| KvGetFloat | Retrieves a floating point value from a KeyValues key. |
| KvGetNameSymbol | Finds a KeyValues id inside a KeyValues tree. |
| KvGetNum | Retrieves an integer value from a KeyValues key. |
| KvGetSectionName | Retrieves the current section name. |
| KvGetSectionSymbol | Retrieves the current section id. |
| KvGetString | Retrieves a string value from a KeyValues key. |
| KvGetUInt64 | Retrieves a large integer value from a KeyValues key. |
| KvGetVector | Retrieves a vector value from a KeyValues key. |
| KvGoBack | Jumps back to the previous position. Returns false if there are no previous positions (i.e., at the root node with an empty traversal stack). This should be called once for each successful Jump call, in order to return to the top node. This function pops one node off the internal traversal stack. |
| KvGotoFirstSubKey | Sets the current position in the KeyValues tree to the first sub key. This native adds to the internal traversal stack. |
| KvGotoNextKey | Sets the current position in the KeyValues tree to the next sub key. This native does NOT add to the internal traversal stack, and thus KvGoBack() is not needed for each successive call to this function. |
| KvJumpToKey | Sets the current position in the KeyValues tree to the given key. |
| KvJumpToKeySymbol | Sets the current position in the KeyValues tree to the given key. |
| KvNodesInStack | Returns the position in the jump stack; I.e. the number of calls required for KvGoBack to return to the root node. If at the root node, 0 is returned. |
| KvRewind | Sets the position back to the top node, emptying the entire node traversal history. This can be used instead of looping KvGoBack() if recursive iteration is not important. |
| KvSavePosition | Saves the current position in the traversal stack onto the traversal stack. This can be useful if you wish to use KvGotoNextKey() and have the previous key saved for backwards traversal. |
| KvSetColor | Sets a set of color values of a KeyValues key. |
| KvSetEscapeSequences | Sets whether or not the KeyValues parser will read escape sequences. For example, \n would be read as a literal newline. This defaults to false for new KeyValues structures. |
| KvSetFloat | Sets a floating point value of a KeyValues key. |
| KvSetNum | Sets an integer value of a KeyValues key. |
| KvSetSectionName | Sets the current section name. |
| KvSetString | Sets a string value of a KeyValues key. |
| KvSetUInt64 | Sets a large integer value of a KeyValues key. |
| KvSetVector | Sets a vector value of a KeyValues key. |
| StringToKeyValues | Converts a given string to a KeyValues tree. The string is read into the current postion of the tree. |