Jumpvalley.IO.InfoFile Class Reference

Reads an Info file, a blob of text that's primarily for defining metadata for a specific object, such as an audio file or a level. The blob of text typically comes from a plain-text file named "info.txt".

The contents of such types of files should be formatted like this:
property name: property value
where each property is specified on its own line.
For the property name, spaces should be replaced with underscores. The property name and property value should be split with a ": ", including the space and not including the quotes.

This text formatting is inspired by the way that the content of .osu files are formatted in Osu (the rhythm game). More...

Inheritance diagram for Jumpvalley.IO.InfoFile:

Public Member Functions
	InfoFile (string text)
	Reads an info file from its raw text and stores such data in the Data field.

Public Attributes
Dictionary< string, string >	Data = new Dictionary<string, string>()
	The content of the info file. The keys of this dictionary are property names, and each key's value is the corresponding property value.

Static Public Attributes
static readonly string	FILE_NAME = "info.txt"
	The full file name of an info file stored somewhere on a filesystem, including the file extension.
static readonly string	PROPERTY_SEPARATOR = "\n"
	The string that separates two properties with the info file's text.
static readonly string	NAME_VALUE_SEPARATOR = ": "
	The string that separates a property's name from its value.

Detailed Description

Reads an Info file, a blob of text that's primarily for defining metadata for a specific object, such as an audio file or a level. The blob of text typically comes from a plain-text file named "info.txt".

The contents of such types of files should be formatted like this:
property name: property value
where each property is specified on its own line.
For the property name, spaces should be replaced with underscores. The property name and property value should be split with a ": ", including the space and not including the quotes.

This text formatting is inspired by the way that the content of .osu files are formatted in Osu (the rhythm game).

Constructor & Destructor Documentation

InfoFile()

Jumpvalley.IO.InfoFile.InfoFile ( string text )

inline

Reads an info file from its raw text and stores such data in the Data field.

Parameters

text

---

The documentation for this class was generated from the following file:

• InfoFile.cs