<?xml version="1.0"?>
<doc>
    <assembly>
        <name>Syroot.Worms.Mgame</name>
    </assembly>
    <members>
        <member name="T:Syroot.Worms.Mgame.Encodings">
            <summary>
            Represents instances of common <see cref="T:System.Text.Encoding"/> pages.
            </summary>
        </member>
        <member name="T:Syroot.Worms.Mgame.Igd">
            <summary>
            Represents an IGD image container.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Igd.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Igd"/> class, loading data from the file with the given
            <paramref name="fileName"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Igd.#ctor(System.IO.Stream)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Igd"/> class, loading data from the given
            <paramref name="stream"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Igd.Load(System.String)">
            <summary>
            Loads the data from the file with the given <paramref name="fileName"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Igd.Load(System.IO.Stream)">
            <summary>
            Loads the data from the given <paramref name="stream"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
        </member>
        <member name="T:Syroot.Worms.Mgame.IgdImage">
            <summary>
            Represents an image and its metadata as stored in an <see cref="T:Syroot.Worms.Mgame.Igd"/> image container.
            </summary>
        </member>
        <member name="T:Syroot.Worms.Mgame.Ksf">
            <summary>
            Represents a KSF image container.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Ksf.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Ksf"/> class.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Ksf.#ctor(System.String,Syroot.Worms.Mgame.Palette)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Ksf"/> class, loading data from the file with the given
            <paramref name="fileName"/> and the colors in the provided <paramref name="palette"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
            <param name="palette">The color palette which is indexed by the image data.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Ksf.#ctor(System.IO.Stream,Syroot.Worms.Mgame.Palette)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Ksf"/> class, loading data from the given
            <paramref name="stream"/> and the colors in the provided <paramref name="palette"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
            <param name="palette">The color palette which is indexed by the image data.</param>
        </member>
        <member name="P:Syroot.Worms.Mgame.Ksf.Images">
            <summary>
            Gets or sets the list of converted <see cref="T:System.Drawing.Bitmap"/> instances stored in this KSF.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Ksf.Load(System.String,Syroot.Worms.Mgame.Palette)">
            <summary>
            Loads the data from the file with the given <paramref name="fileName"/> and the colors in the provided
            <paramref name="palette"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
            <param name="palette">The color palette which is indexed by the image data.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Ksf.Load(System.IO.Stream,Syroot.Worms.Mgame.Palette)">
            <summary>
            Loads the data from the given <paramref name="stream"/> and the colors in the provided
            <paramref name="palette"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
            <param name="palette">The color palette which is indexed by the image data.</param>
        </member>
        <member name="T:Syroot.Worms.Mgame.KsfImage">
            <summary>
            Represents an image and its metadata as stored in a <see cref="T:Syroot.Worms.Mgame.Ksf"/> image container.
            </summary>
        </member>
        <member name="T:Syroot.Worms.Mgame.LaunchConfig">
            <summary>
            Represents the memory mapped file passed to the game executable, configuring the server address.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LaunchConfig.Publisher">
            <summary>
            Gets or sets the name of the publisher providing the launch configuration. Must not exceed 15 characters.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LaunchConfig.Unknown">
            <summary>
            Gets or sets an unknown value. Must not exceed 19 characters.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LaunchConfig.ServerEndPoint">
            <summary>
            Gets or sets the address of the game server.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LaunchConfig.UserName">
            <summary>
            Gets or sets the initially entered user name. Must not exceed 250 characters.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.LaunchConfig.CreateMappedFile(System.String)">
            <summary>
            Creates a <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile"/> which is then read by the game client.
            </summary>
            <param name="mapName">The name under which the game client can access the mapping.</param>
            <returns>The <see cref="T:System.IO.MemoryMappedFiles.MemoryMappedFile"/>.</returns>
        </member>
        <member name="M:Syroot.Worms.Mgame.LaunchConfig.GetPassword">
            <summary>
            Decrypts the password stored in the configuration as previously set through
            <see cref="M:Syroot.Worms.Mgame.LaunchConfig.SetPassword(System.String,System.Int32)"/>.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.LaunchConfig.SetPassword(System.String,System.Int32)">
            <summary>
            Encrypts the given <paramref name="password"/> with the provided initial encryption <paramref name="key"/>
            and stores the result in the launch config.
            </summary>
            <param name="password">The password to store encrypted.</param>
            <param name="key">The key to encrypt with.</param>
        </member>
        <member name="T:Syroot.Worms.Mgame.Lpd">
            <summary>
            Represents an LPD layout description file used in Worms World Party Aqua.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Lpd.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Lpd"/> class, loading data from the file with the given
            <paramref name="fileName"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Lpd.#ctor(System.IO.Stream)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Lpd"/> class, loading data from the given
            <paramref name="stream"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
        </member>
        <member name="P:Syroot.Worms.Mgame.Lpd.Elements">
            <summary>
            Gets or sets the list of <see cref="T:Syroot.Worms.Mgame.LpdElement"/> instances stored by this class.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Lpd.Load(System.String)">
            <summary>
            Loads the data from the file with the given <paramref name="fileName"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Lpd.Load(System.IO.Stream)">
            <summary>
            Loads the data from the given <paramref name="stream"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
        </member>
        <member name="T:Syroot.Worms.Mgame.LpdElement">
            <summary>
            Represents a single UI element described in an <see cref="T:Syroot.Worms.Mgame.Lpd"/> file.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LpdElement.FileName">
            <summary>
            Gets or sets a the relative path to the IGD storing the image of this element.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LpdElement.Rectangle">
            <summary>
            Gets or sets a the area at which the UI element appears.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LpdElement.Properties">
            <summary>
            Gets or sets an unknown value.
            </summary>
        </member>
        <member name="P:Syroot.Worms.Mgame.LpdElement.Version">
            <summary>
            Gets or sets a value which must lie between 0-4 (inclusive) for the game to accept the element.
            </summary>
        </member>
        <member name="T:Syroot.Worms.Mgame.PacketCompression">
            <summary>
            Represents packet data encryption as used in WWPA. Note that most code is a direct translation from the original
            game assembly.
            </summary>
            <remarks>
            The original implementation has the following bugs caused by specific, but rare patterns (in 1000 random blobs
            of sizes between 1 and 1000 bytes, ~0.5% were decompressed badly):
            - Bad calculation of decompressed bytes. The same wrong bytes are calculated by this implementation.
            - Bad negative source buffer indices cause out-of-bounds memory to be written. Combatted in this implementation
              by ignoring such writes and keeping 0 bytes instead.
            The game discards decompression results of a length longer than specified in the packet header, but does not
            check the data itself if the length is still fine.
            </remarks>
        </member>
        <member name="M:Syroot.Worms.Mgame.PacketCompression.Compress(System.ReadOnlySpan{System.Byte})">
            <summary>
            Compresses the given <paramref name="decompressed"/> data.
            </summary>
            <param name="decompressed">The data to compress.</param>
            <returns>The compressed data.</returns>
        </member>
        <member name="T:Syroot.Worms.Mgame.Palette">
            <summary>
            Represents a PAL color palette.
            </summary>
        </member>
        <member name="F:Syroot.Worms.Mgame.Palette.ColorCount">
            <summary>
            The number of colors stored in a palette.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Palette.#ctor">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Palette"/> class.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Palette.#ctor(System.String)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Palette"/> class, loading data from the file with the given
            <paramref name="fileName"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Palette.#ctor(System.IO.Stream)">
            <summary>
            Initializes a new instance of the <see cref="T:Syroot.Worms.Mgame.Palette"/> class, loading data from the given
            <paramref name="stream"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
        </member>
        <member name="P:Syroot.Worms.Mgame.Palette.Colors">
            <summary>
            Gets the array of 256 colors stored in this palette.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.Palette.Load(System.String)">
            <summary>
            Loads the data from the file with the given <paramref name="fileName"/>.
            </summary>
            <param name="fileName">The name of the file to load the data from.</param>
        </member>
        <member name="M:Syroot.Worms.Mgame.Palette.Load(System.IO.Stream)">
            <summary>
            Loads the data from the given <paramref name="stream"/>.
            </summary>
            <param name="stream">The <see cref="T:System.IO.Stream"/> to load the data from.</param>
        </member>
        <member name="T:Syroot.Worms.Mgame.PasswordCrypto">
            <summary>
            Represents the two-way encryption and decryption used to obfuscate passwords passed to the client.
            </summary>
        </member>
        <member name="M:Syroot.Worms.Mgame.PasswordCrypto.Encrypt(System.String,System.UInt32)">
            <summary>
            Encrypts the given <paramref name="data"/> with the specified <paramref name="key"/>.
            </summary>
            <param name="data">The text (typically the password) to encrypt.</param>
            <param name="key">The value to apply to the transformation for modified outcome.</param>
            <returns>The encrypted text.</returns>
        </member>
        <member name="M:Syroot.Worms.Mgame.PasswordCrypto.Decrypt(System.String,System.UInt32)">
            <summary>
            Decrypts the given <paramref name="data"/> with the specified <paramref name="key"/>.
            </summary>
            <param name="data">The text (typically the password) to decrypt.</param>
            <param name="key">The value to apply to the transformation for modified outcome.</param>
            <returns>The decrypted text.</returns>
        </member>
    </members>
</doc>
