TuxHunter/trunk/LevelEditor/bin/Release/Resources.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Icarus.Resources</name>
    </assembly>
    <members>
        <member name="T:Icarus.Resources.ConfigParser">
            <summary>
            The Config Parser will parse a config file of the following format:
            
            # This is a comment
            variable: value
            variable: value
            variable: value
            
            </summary>
        </member>
        <member name="M:Icarus.Resources.ConfigParser.#ctor(System.String)">
            <summary>
            Generate a new ConfigParser
            </summary>
            <param name="fileName">The configuration file to parse</param>
        </member>
        <member name="M:Icarus.Resources.ConfigParser.ParseConfigFile(System.String)">
            <summary>
            Parses the configuration file.
            </summary>
            <param name="filename"></param>
        </member>
        <member name="M:Icarus.Resources.ConfigParser.nextVcombo(System.IO.StreamReader)">
            <summary>
            Retrieve the next Vcombo object
            </summary>
            <returns>The next Vcombo, null if there is none</returns>
        </member>
        <member name="M:Icarus.Resources.ConfigParser.nextLine(System.IO.StreamReader)">
            <summary>
            Retrieve the next line, automagically skips the comments
            </summary>
            <returns>The next non-comment line, null if there is none</returns>
        </member>
        <member name="P:Icarus.Resources.ConfigParser.Item(System.String)">
            <summary>
            Gets or sets configuration properties.
            </summary>
        </member>
        <member name="T:Icarus.Resources.ConfigParser.Vcombo">
            <summary>
            This stores a variable/value combination as generated by
            the ConfigParser class.
            </summary>
        </member>
        <member name="M:Icarus.Resources.ConfigParser.Vcombo.#ctor(System.String,System.String)">
            <summary>
            Generate a new Vcombo with fields as defined
            in the parameter list
            </summary>
            <param name="name">The variable name</param>
            <param name="val">The variable value</param>
        </member>
        <member name="P:Icarus.Resources.ConfigParser.Vcombo.Name">
            <summary>
            This stores the variable name in string Representaton
            
            The variable name is everything before the first ":"
            
            Example:
            Stinkyness: -50
            
            Variable is the string "Strinkyness"
            
            </summary>
        </member>
        <member name="P:Icarus.Resources.ConfigParser.Vcombo.Value">
            <summary>
            The value of the variable in a string Representation
            
            This contains everything after the first ":" not including
            whitespace.
            
            Example:
            Stinkyness:-50
            Stinkyness:          -50
            Stinkyness: -50
            
            All have a value of the string "-50"
            
            Example:
            PATH: C:\My Stuff\Video Games\SuperCool
            
            Has a value of the string: "C:\My Stuff\Video Games\SuperCool"
            </summary>
        </member>
        <member name="T:Icarus.Resources.ResourceManager">
            <summary>
            The resource manager class gives us a central repository of paths that the application needs to access its assets, like graphics, sounds, etc.
            </summary>
        </member>
        <member name="F:Icarus.Resources.ResourceManager.mg_Instance">
            <summary>
            Singleton Implementation.
            </summary>
        </member>
        <member name="M:Icarus.Resources.ResourceManager.#ctor">
            <summary>
            Singleton Implementation.
            </summary>
        </member>
        <member name="F:Icarus.Resources.ResourceManager.m_BasePath">
            <summary>
            The base path of the application.
            </summary>
        </member>
        <member name="F:Icarus.Resources.ResourceManager.m_ImageDirName">
            <summary>
            The name of the directory, relative to the base path, where the images reside.
            </summary>
        </member>
        <member name="F:Icarus.Resources.ResourceManager.m_LevelDirName">
            <summary>
            The name of the directory, relative to the base path, where the levels reside.
            </summary>
        </member>
        <member name="F:Icarus.Resources.ResourceManager.m_MusicDirName">
            <summary>
            The name of the directory, relative to the base path, where the music resides.
            </summary>
        </member>
        <member name="F:Icarus.Resources.ResourceManager.m_TextDirName">
            <summary>
            The name of the directory, relative to the base path, where the text files reside.
            </summary>
        </member>
        <member name="F:Icarus.Resources.ResourceManager.m_SoundDirName">
            <summary>
            The name of the directory, relative to the base path, where the sound files reside.
            </summary>
        </member>
        <member name="M:Icarus.Resources.ResourceManager.GetRandomSoundFrom(System.String)">
            <summary>
            Gets a random sound from the directory whose id is passed in.
            </summary>
            <param name="dirId"></param>
            <returns></returns>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.Instance">
            <summary>
            Singleton Implementation.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.BasePath">
            <summary>
            Returns the base path for all the resources. By default, the base path is the directory from which the application is launched.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.ImageDirName">
            <summary>
            Gets or sets the name of the directory, relative to the base path, where the images reside.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.LevelDirName">
            <summary>
            Gets or sets the name of the directory, relative to the base path, where the levels reside.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.MusicDirName">
            <summary>
            Gets or sets the name of the directory, relative to the base path, where the music resides.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.TextDirName">
            <summary>
            Gets or sets the name of the directory, relative to the base path, where the text files reside.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.SoundDirName">
            <summary>
            Gets or sets the name of the directory, relative to the base path, where the sound files reside.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.ImagePath">
            <summary>
            Gets the full path to the image directory.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.LevelPath">
            <summary>
            Gets the full path to the levels directory.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.MusicPath">
            <summary>
            Gets the full path to the music directory.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.SoundPath">
            <summary>
            Gets the full path to the sound directory.
            </summary>
        </member>
        <member name="P:Icarus.Resources.ResourceManager.TextPath">
            <summary>
            Gets the full path to the text directory.
            </summary>
        </member>
    </members>
</doc>