added references.

This commit is contained in:
Harrison Deng 2019-01-22 19:31:31 -06:00
parent 242d6013c0
commit 9b674304f3
10 changed files with 347 additions and 29309 deletions

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

View File

@ -28,7 +28,7 @@
<summary>
Constructs 2D camera.
</summary>
<param name="graphicsDevice">The graphics device to use.</param>
<param name="graphicsDevice">The graphics device to use. Will use graphics device from <see cref="T:RecrownedAthenaeum.Configuration"/>'s graphics device manager if this is null which it is by default.</param>
</member>
<member name="M:RecrownedAthenaeum.Camera.Camera2D.Update">
<summary>
@ -53,6 +53,11 @@
Path modifiers to change the path in which the content manager looks to load a file. Used for better organizing things while not needing to type entire path.
</summary>
</member>
<member name="F:RecrownedAthenaeum.ContentSystem.ContentManagerController.normalPathModifier">
<summary>
Used when no path modifier is defined for that specific type.
</summary>
</member>
<member name="P:RecrownedAthenaeum.ContentSystem.ContentManagerController.Done">
<summary>
Whether or not the queue is empty and all content is loaded.
@ -107,18 +112,40 @@
Unloads everything from both queue and loaded list while properly disposing of the assets loaded.
</summary>
</member>
<member name="T:RecrownedAthenaeum.ContentSystem.IContentPathModifier">
<member name="T:RecrownedAthenaeum.ContentSystem.IContentPathResolver">
<summary>
Modifies the given path based on a name. Used to simplify long paths for the <see cref="T:RecrownedAthenaeum.ContentSystem.ContentManagerController"/>
</summary>
</member>
<member name="M:RecrownedAthenaeum.ContentSystem.IContentPathModifier.Modify(System.String)">
<member name="M:RecrownedAthenaeum.ContentSystem.IContentPathResolver.Modify(System.String)">
<summary>
Returns the complete path with the content folder as root.
</summary>
<param name="assetName">Is the asset's name</param>
<param name="contentPath">Is the asset's name</param>
<returns></returns>
</member>
<member name="T:RecrownedAthenaeum.ContentSystem.NormalContentResolver">
<summary>
A resolver that does nothing. Used for looking in the root by default.
</summary>
</member>
<member name="M:RecrownedAthenaeum.ContentSystem.NormalContentResolver.Modify(System.String)">
<summary>
Passes the path through without modification as this is the normal content resolver and is meant to just pass things on.
</summary>
<param name="contentPath">The path to modify.</param>
<returns></returns>
</member>
<member name="T:RecrownedAthenaeum.Configuration">
<summary>
All variables here should be for RecrownedAthenaeum to use when needed and thus eliminates unessecary passing.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Configuration.graphicsDeviceManager">
<summary>
The graphics device that will be used by default.
</summary>
</member>
<member name="T:RecrownedAthenaeum.SpecialTypes.ISpecialDrawable">
<summary>
A wrapper that makes sure anything implementing can be drawn with options.
@ -149,7 +176,7 @@
Dimensions in ninepatch. May also represent position in texture atlas.
</summary>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.NinePatch.#ctor(Microsoft.Xna.Framework.Graphics.Texture2D,System.Int32,System.Int32,System.Int32,System.Int32)">
<member name="M:RecrownedAthenaeum.SpecialTypes.NinePatch.#ctor(Microsoft.Xna.Framework.Graphics.Texture2D,System.Int32,System.Int32,System.Int32,System.Int32,System.Nullable{Microsoft.Xna.Framework.Rectangle})">
<summary>
A nine patch object.
</summary>
@ -158,6 +185,7 @@
<param name="right">Right side.</param>
<param name="bottom">Bottom side.</param>
<param name="top">Top side.</param>
<param name="textureBounds">The dimensions and potentially the coordinates of the rectangle on an atlas. If left to default of null, will only be set to texture bounds.</param>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.NinePatch.Draw(Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Rectangle)">
<summary>
@ -224,19 +252,19 @@
</member>
<member name="P:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Item(System.String)">
<summary>
Given a name, can return a <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion"/>.
Given a name, can return a <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region"/>.
</summary>
<param name="name">Name of <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion"/> to obtain.</param>
<returns><see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion"/> based off name.</returns>
<param name="name">Name of <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region"/> to obtain.</param>
<returns><see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region"/> based off name.</returns>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.#ctor(Microsoft.Xna.Framework.Graphics.Texture2D,RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion[])">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.#ctor(Microsoft.Xna.Framework.Graphics.Texture2D,RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region[])">
<summary>
Creates a texture atlas with given main texture as well as an array of <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion"/> to represent locations of which textures reside within the atlas. Region names will be used to refer to the regions within the dictionary.
Creates a texture atlas with given main texture as well as an array of <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region"/> to represent locations of which textures reside within the atlas. Region names will be used to refer to the regions within the dictionary.
</summary>
<param name="texture">The texture representing the overall atlas.</param>
<param name="regions">The sub regions that represent the individual textures.</param>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.#ctor(Microsoft.Xna.Framework.Graphics.Texture2D,System.Collections.Generic.Dictionary{System.String,RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion})">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.#ctor(Microsoft.Xna.Framework.Graphics.Texture2D,System.Collections.Generic.Dictionary{System.String,RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region})">
<summary>
Creates a texture region given a dictionary of regions keyed to strings that can be used to refer to them.
</summary>
@ -259,7 +287,7 @@
Creates or obtains a previously created texture of a region.
</summary>
<param name="name">Name of region.</param>
<param name="graphicsDevice">graphics device to be used.</param>
<param name="graphicsDevice">graphics device to be used. Default is null and will resort to using graphics device from <see cref="T:RecrownedAthenaeum.Configuration"/>'s graphics device manager.</param>
<returns>The texture from the region.</returns>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Dispose">
@ -278,22 +306,27 @@
Destructor.
</summary>
</member>
<member name="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion">
<member name="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region">
<summary>
A region of a <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas"/>.
</summary>
</member>
<member name="F:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.name">
<member name="F:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.name">
<summary>
The name of the region. Mostly used to be refered to within the context of a <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas"/>.
</summary>
</member>
<member name="F:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.sourceRectangle">
<member name="F:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.sourceRectangle">
<summary>
The location and dimensions of where the original texture resides on the texture representing the atlas.
</summary>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.#ctor(System.String,Microsoft.Xna.Framework.Rectangle,RecrownedAthenaeum.SpecialTypes.NinePatch,Microsoft.Xna.Framework.Graphics.Texture2D)">
<member name="P:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.Disposed">
<summary>
If region has already been disposed.
</summary>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.#ctor(System.String,Microsoft.Xna.Framework.Rectangle,RecrownedAthenaeum.SpecialTypes.NinePatch,Microsoft.Xna.Framework.Graphics.Texture2D)">
<summary>
A specified region in a texture atlas.
</summary>
@ -302,7 +335,7 @@
<param name="ninePatch">A <see cref="T:RecrownedAthenaeum.SpecialTypes.NinePatch"/> definition for the region.</param>
<param name="atlasTexture">The texture that holds the image data for the atlas.</param>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.Draw(Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2)">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.Draw(Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2)">
<summary>
Draws the region. If ninepatch, rotation and origin are ignored.
</summary>
@ -312,32 +345,32 @@
<param name="rotation">Rotation of the final drawing. Ignored if is a 9patch.</param>
<param name="origin">The origin of the drawing. Ignored if is a 9patch.</param>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.AsTexture2D(Microsoft.Xna.Framework.Graphics.GraphicsDevice)">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.AsTexture2D(Microsoft.Xna.Framework.Graphics.GraphicsDevice)">
<summary>
Create or obtains a previously created texture of this region.
</summary>
<param name="graphicsDevice">The graphics device to use to create the texture.</param>
<param name="graphicsDevice">The graphics device to use to create the texture. Will use graphics device from <see cref="T:RecrownedAthenaeum.Configuration"/>'s graphics device manager if left to null.</param>
<returns>The texture of the region.</returns>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.CompareTo(RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion)">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.CompareTo(RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region)">
<summary>
Compares this region to another in terms of name.
</summary>
<param name="other">The other region to compare to in terms of name.</param>
<returns>Less than one if precedes, greater than one if after, 0 if same.</returns>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.Dispose">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.Dispose">
<summary>
Call this to dispose.
</summary>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.Dispose(System.Boolean)">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.Dispose(System.Boolean)">
<summary>
Overridable dispose.
</summary>
<param name="disposing">Whether or not this was a user made call.</param>
</member>
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.TextureAtlasRegion.Finalize">
<member name="M:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region.Finalize">
<summary>
Destructor.
</summary>
@ -419,37 +452,37 @@
Saves preferences.
</summary>
</member>
<member name="T:RecrownedAthenaeum.Serializable.NinePatchData">
<member name="T:RecrownedAthenaeum.Data.NinePatchData">
<summary>
Represents a data structure for 9patches.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.NinePatchData.textureName">
<member name="F:RecrownedAthenaeum.Data.NinePatchData.textureName">
<summary>
Name of texture associated with patch. May be null in the case of being apart of a <see cref="T:RecrownedAthenaeum.Serializable.TextureAtlasData"/>
Name of texture associated with patch. May be null in the case of being apart of a <see cref="T:RecrownedAthenaeum.Data.TextureAtlasData"/>
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.NinePatchData.left">
<member name="F:RecrownedAthenaeum.Data.NinePatchData.left">
<summary>
the boundaries of the patch.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.NinePatchData.right">
<member name="F:RecrownedAthenaeum.Data.NinePatchData.right">
<summary>
the boundaries of the patch.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.NinePatchData.bottom">
<member name="F:RecrownedAthenaeum.Data.NinePatchData.bottom">
<summary>
the boundaries of the patch.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.NinePatchData.top">
<member name="F:RecrownedAthenaeum.Data.NinePatchData.top">
<summary>
the boundaries of the patch.
</summary>
</member>
<member name="M:RecrownedAthenaeum.Serializable.NinePatchData.#ctor(System.String,System.Int32,System.Int32,System.Int32,System.Int32)">
<member name="M:RecrownedAthenaeum.Data.NinePatchData.#ctor(System.String,System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Constructs patch.
</summary>
@ -459,63 +492,63 @@
<param name="bottom">Bottom bound.</param>
<param name="Top">Top bound.</param>
</member>
<member name="T:RecrownedAthenaeum.Serializable.TextureAtlasData">
<member name="T:RecrownedAthenaeum.Data.TextureAtlasData">
<summary>
Data transfer object for a texture atlas.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.TextureAtlasData.regions">
<member name="F:RecrownedAthenaeum.Data.TextureAtlasData.regions">
<summary>
Contains the regions of the texture atlas.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.TextureAtlasData.textureName">
<member name="F:RecrownedAthenaeum.Data.TextureAtlasData.textureName">
<summary>
The name of the file.
</summary>
</member>
<member name="M:RecrownedAthenaeum.Serializable.TextureAtlasData.#ctor(System.String,RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData[])">
<member name="M:RecrownedAthenaeum.Data.TextureAtlasData.#ctor(System.String,RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData[])">
<summary>
Creates the atlas given the regions and the file name of the texture file to be used.
</summary>
<param name="textureName"></param>
<param name="regions"></param>
</member>
<member name="T:RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData">
<member name="T:RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData">
<summary>
Data object that contains information about the region ninepatch situation of a given region in an atlas.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData.name">
<member name="F:RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData.name">
<summary>
Name of the region for referencial purposes.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData.location">
<member name="F:RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData.bounds">
<summary>
The location of the patch is designated by this rectangle.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData.ninePatchData">
<member name="F:RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData.ninePatchData">
<summary>
The ninepatch information.
</summary>
</member>
<member name="M:RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData.SetPosition(System.Int32,System.Int32)">
<member name="M:RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData.SetPosition(System.Int32,System.Int32)">
<summary>
Sets position in atlas for convenience.
</summary>
<param name="x">X coordinate of the position in the patch.</param>
<param name="y">Y coordinate of the position in the patch.</param>
</member>
<member name="M:RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData.SetSize(System.Int32,System.Int32)">
<member name="M:RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData.SetSize(System.Int32,System.Int32)">
<summary>
Sets the dimensions of the region on the atlas for convenience.
</summary>
<param name="width">Width of the region.</param>
<param name="height">Height of the region.</param>
</member>
<member name="M:RecrownedAthenaeum.Serializable.TextureAtlasData.AtlasRegionData.SetBounds(System.Int32,System.Int32,System.Int32,System.Int32)">
<member name="M:RecrownedAthenaeum.Data.TextureAtlasData.AtlasRegionData.SetBounds(System.Int32,System.Int32,System.Int32,System.Int32)">
<summary>
Sets both the coordinates and dimensions of the region on the atlas for convenience.
</summary>
@ -524,86 +557,109 @@
<param name="width">Width of the region.</param>
<param name="height">Height of the region.</param>
</member>
<member name="T:RecrownedAthenaeum.Serializable.SkinData">
<member name="T:RecrownedAthenaeum.Data.SkinData">
<summary>
Data transfer object for game skins.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.nameOfTextureAtlas">
<member name="T:RecrownedAthenaeum.Data.SkinData.Metadata">
<summary>
The name of the atlas with solution of ".tatlas".
Holds metadata.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.colors">
<member name="F:RecrownedAthenaeum.Data.SkinData.Metadata.author">
<summary>
Author name.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Data.SkinData.Metadata.description">
<summary>
Description of skin.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Data.SkinData.Metadata.skinName">
<summary>
Name of skin.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Data.SkinData.metadata">
<summary>
The metadata for the skin file.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Data.SkinData.nameOfTextureAtlas">
<summary>
The name of the atlas with extension.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Data.SkinData.cursorTextureName">
<summary>
Name of the region or file designating the cursor. If there is an extension, will check for file first then texture atlas. Otherwise, will just check region.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Data.SkinData.colors">
<summary>
The color data containing the name of the color, and red, green, and blue values for the color.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.fonts">
<summary>
The font data containing the name of the font and name of the file for the font.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.definitions">
<member name="F:RecrownedAthenaeum.Data.SkinData.definitions">
<summary>
The skin definitions containing a name for the definition, and the definition itself.
</summary>
</member>
<member name="T:RecrownedAthenaeum.Serializable.SkinData.ColorData">
<member name="T:RecrownedAthenaeum.Data.SkinData.ColorData">
<summary>
Color data for data transfer.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.ColorData.name">
<member name="F:RecrownedAthenaeum.Data.SkinData.ColorData.name">
<summary>
Name of color to be referenced by.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.ColorData.r">
<member name="F:RecrownedAthenaeum.Data.SkinData.ColorData.r">
<summary>
RGB data of this color.
RGBA data of this color.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.ColorData.g">
<member name="F:RecrownedAthenaeum.Data.SkinData.ColorData.g">
<summary>
RGB data of this color.
RGBA data of this color.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.ColorData.b">
<member name="F:RecrownedAthenaeum.Data.SkinData.ColorData.b">
<summary>
RGB data of this color.
RGBA data of this color.
</summary>
</member>
<member name="T:RecrownedAthenaeum.Serializable.SkinData.FontData">
<member name="F:RecrownedAthenaeum.Data.SkinData.ColorData.a">
<summary>
Font data for data transfer.
RGBA data of this color.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.FontData.name">
<summary>
Name of font to be referenced by.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.FontData.font">
<summary>
Name of the file that contains the font. Shouldn't have extension.
</summary>
</member>
<member name="T:RecrownedAthenaeum.Serializable.SkinData.DefinitionData">
<member name="T:RecrownedAthenaeum.Data.SkinData.DefinitionData">
<summary>
Definition data for data transfer.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.DefinitionData.name">
<member name="F:RecrownedAthenaeum.Data.SkinData.DefinitionData.name">
<summary>
Name of definition to be referenced by.
</summary>
</member>
<member name="F:RecrownedAthenaeum.Serializable.SkinData.DefinitionData.skin">
<member name="F:RecrownedAthenaeum.Data.SkinData.DefinitionData.skin">
<summary>
The skin definition data.
</summary>
</member>
<member name="M:RecrownedAthenaeum.ContentReaders.TextureAtlasDataReader.GenerateAtlasRegionsFromData(RecrownedAthenaeum.Data.TextureAtlasData,Microsoft.Xna.Framework.Graphics.Texture2D)">
<summary>
Generates region given <see cref="T:RecrownedAthenaeum.Data.TextureAtlasData"/>.
</summary>
<param name="textureAtlasData">The data to generate the regions from.</param>
<param name="atlasTexture">The texture containing the atlas.</param>
<returns>An array of regions.</returns>
</member>
<member name="T:RecrownedAthenaeum.Render.RectangleRenderer">
<summary>
Renders rectangles using the <see cref="T:RecrownedAthenaeum.Render.PrimitiveBatch"/>.
@ -611,7 +667,7 @@
</member>
<member name="F:RecrownedAthenaeum.Render.RectangleRenderer.primitiveBatch">
<summary>
The <see cref="T:RecrownedAthenaeum.Render.PrimitiveBatch"/> used.
The <see cref="T:RecrownedAthenaeum.Render.PrimitiveBatch"/> used. Needs to be disposed.
</summary>
</member>
<member name="M:RecrownedAthenaeum.Render.RectangleRenderer.#ctor(RecrownedAthenaeum.Render.PrimitiveBatch)">
@ -620,13 +676,6 @@
</summary>
<param name="primitiveBatch"></param>
</member>
<member name="M:RecrownedAthenaeum.Render.RectangleRenderer.#ctor(Microsoft.Xna.Framework.Graphics.GraphicsDevice,RecrownedAthenaeum.Camera.Camera2D)">
<summary>
Creates a rectangle renderer.
</summary>
<param name="graphicsDevice">The graphics device used to create the <see cref="T:RecrownedAthenaeum.Render.PrimitiveBatch"/></param>
<param name="camera">The camera containing the matrix to be used for the transformations.</param>
</member>
<member name="M:RecrownedAthenaeum.Render.RectangleRenderer.Begin(System.Boolean)">
<summary>
Begins the render batch.
@ -649,22 +698,6 @@
<param name="color">Color of all vertices of this rectangle.</param>
<param name="rotation">Rotation of rectangle. Default is 0 radians.</param>
</member>
<member name="M:RecrownedAthenaeum.Render.RectangleRenderer.Dispose">
<summary>
Attempts to dispose of this object.
</summary>
</member>
<member name="M:RecrownedAthenaeum.Render.RectangleRenderer.Dispose(System.Boolean)">
<summary>
An overridable of disposable.
</summary>
<param name="disposing">Only true when called by user code dispose. Destructor calling this results in false.</param>
</member>
<member name="M:RecrownedAthenaeum.Render.RectangleRenderer.Finalize">
<summary>
Destructor.
</summary>
</member>
<member name="T:RecrownedAthenaeum.Render.PrimitiveBatch">
<summary>
A batch used to draw primitive shapes by batching together vertices.
@ -675,12 +708,12 @@
The maximum vertices expected. The further off this expectancy is from the true value, the less efficient.
</summary>
</member>
<member name="M:RecrownedAthenaeum.Render.PrimitiveBatch.#ctor(Microsoft.Xna.Framework.Graphics.GraphicsDevice,RecrownedAthenaeum.Camera.Camera2D,System.Int32)">
<member name="M:RecrownedAthenaeum.Render.PrimitiveBatch.#ctor(RecrownedAthenaeum.Camera.Camera2D,Microsoft.Xna.Framework.Graphics.GraphicsDevice,System.Int32)">
<summary>
Creates a batch used to draw primitives.
</summary>
<param name="graphicsDevice">The current graphics device being used.</param>
<param name="camera">The current camera being used.</param>
<param name="graphicsDevice">The graphics device used to draw the primitives. Will be using <see cref="T:RecrownedAthenaeum.Configuration"/>'s graphics device from graphics device manager if null. Default is null.</param>
<param name="verticesPerBatch">The amount of vertices every batch can hold before flushing. Default is 450. Should be changed to be the most optimal number if possible to prevent unnecessary resizing. Especially if using strip primitive types.</param>
</member>
<member name="M:RecrownedAthenaeum.Render.PrimitiveBatch.Begin(Microsoft.Xna.Framework.Graphics.PrimitiveType)">
@ -954,12 +987,12 @@
Currently displayed screen.
</summary>
</member>
<member name="M:RecrownedAthenaeum.ScreenSystem.ScreenManager.#ctor(Microsoft.Xna.Framework.GraphicsDeviceManager,RecrownedAthenaeum.Camera.Camera2D)">
<member name="M:RecrownedAthenaeum.ScreenSystem.ScreenManager.#ctor(RecrownedAthenaeum.Camera.Camera2D,Microsoft.Xna.Framework.GraphicsDeviceManager)">
<summary>
Creates a screen manager that helps manage multiple screens and their transitions.
</summary>
<param name="graphicsDeviceManager">The graphics device manager to be used.</param>
<param name="camera">The camera to be used to perform the correct translations and transformations.</param>
<param name="graphicsDeviceManager">The graphics device manager to be used.</param>
</member>
<member name="M:RecrownedAthenaeum.ScreenSystem.ScreenManager.UpdateCurrentScreen(Microsoft.Xna.Framework.GameTime,System.Boolean)">
<summary>
@ -1215,11 +1248,12 @@
<param name="disabled">What to draw as button is disabled.</param>
<param name="selected">What to draw as button is selected.</param>
</member>
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Interactive.TextButton.#ctor(System.String,RecrownedAthenaeum.UI.Skin.Skin,System.String)">
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Interactive.TextButton.#ctor(System.String,Microsoft.Xna.Framework.Graphics.SpriteFont,RecrownedAthenaeum.UI.Skin.Skin,System.String)">
<summary>
Constructs a text button using a skin and definition.
</summary>
<param name="text">The text to display.</param>
<param name="font">The font to be used.</param>
<param name="skin">The skin to use.</param>
<param name="definitionName">Name of the definition for this type in the skin given.</param>
</member>
@ -1272,13 +1306,14 @@
<param name="font">The font to use.</param>
<param name="content">The string for the text.</param>
</member>
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Text.#ctor(RecrownedAthenaeum.UI.Skin.Skin,System.String,System.String)">
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Text.#ctor(RecrownedAthenaeum.UI.Skin.Skin,Microsoft.Xna.Framework.Graphics.SpriteFont,System.String,System.String)">
<summary>
Creates a UI text object
</summary>
<param name="skin"></param>
<param name="skinDefinitionName"></param>
<param name="content"></param>
<param name="skin">The skin to be used.</param>
<param name="skinDefinitionName">The name of the skin's definition to use of a <see cref="T:RecrownedAthenaeum.UI.Skin.Definitions.TextSkinDefinition"/>.</param>
<param name="font">The font to be used.</param>
<param name="content">The string of text to be displayed.</param>
</member>
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Text.Update(Microsoft.Xna.Framework.GameTime)">
<summary>
@ -1491,11 +1526,6 @@
Definition for a text button for a skin theme.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.Definitions.TextButtonSkinDefinition.fontName">
<summary>
Name of font from the skin to use.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.Definitions.TextButtonSkinDefinition.fontColor">
<summary>
Name of color from the skin to use for the font.
@ -1513,31 +1543,108 @@
<param name="downRegion">Texture region from skin that represents when the button is pressed down.</param>
<param name="upRegion">The texture region that represents when the button is not pressed.</param>
</member>
<member name="T:RecrownedAthenaeum.UI.Skin.ISkin">
<summary>
The output requirements of a skin. This allows for very customized skin systems if needed.
</summary>
</member>
<member name="P:RecrownedAthenaeum.UI.Skin.ISkin.CursorTexture">
<summary>
The texture for the cursor.
</summary>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.ISkin.Draw(System.String,System.String,Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Rectangle,System.Single,Microsoft.Xna.Framework.Vector2)">
<summary>
Draws a region from the texture atlas.
</summary>
<param name="regionName">Region to draw.</param>
<param name="color">The color to tint the region.</param>
<param name="batch">The batch to use.</param>
<param name="destination">The destination to draw to.</param>
<param name="rotation">The rotation to use in radians.</param>
<param name="origin">The origin for the rotation.</param>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.ISkin.GetColor(System.String)">
<summary>
Returns a <see cref="T:Microsoft.Xna.Framework.Color"/> with given name of defined color;
</summary>
<param name="name">Name of defined color.</param>
<returns>The defined color based on the name given.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.ISkin.GetTextureAtlasRegion(System.String)">
<summary>
Returns a <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region"/> with given name of region.
</summary>
<param name="name">Name of region.</param>
<returns>The region corresponding to the name.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.ISkin.ObtainDefinition(System.String,System.Type)">
<summary>
Returns an <see cref="T:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData"/> of the given name and type.
</summary>
<param name="definitionName">Name of definition of the <paramref name="type"/></param>
<param name="type">The UIModule the definition defines.</param>
<returns>The interface for the definition.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.ISkin.ObtainDefinition(System.Type)">
<summary>
Returns the default <see cref="T:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData"/> of the given parameters.
</summary>
<param name="type">The type of definition the default should be coming from.</param>
<returns>The default definition for the given type.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.ISkin.ObtainDefinition``1(System.String,System.Type)">
<summary>
Returns the proper definition for the given parameters or throws exception in the case the requested definition does not exist.
</summary>
<typeparam name="T">Convenience to cast to the needed definition type.</typeparam>
<param name="definitionName">The name of the definition.</param>
<param name="type">UIModule type the definition defines.</param>
<returns>The definition cast to T.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.ISkin.ObtainDefinition``1(System.Type)">
<summary>
Returns the default definition.
</summary>
<typeparam name="T">Convenience to cast to T.</typeparam>
<param name="type">The type of the UIModule to retrieve the default from.</param>
<returns>The default definition for the given type.</returns>
</member>
<member name="T:RecrownedAthenaeum.UI.Skin.Skin">
<summary>
A skin is used to group a theme which can then be applied to the UI via the use of modules.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.Skin.textureAtlas">
<member name="P:RecrownedAthenaeum.UI.Skin.Skin.Laminated">
<summary>
Texture atlas containing the skins textures.
Whether or not this skin is completed being built and thus ready to use.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.Skin.colors">
<member name="P:RecrownedAthenaeum.UI.Skin.Skin.CursorTexture">
<summary>
Colors stored in this skin.
The texture for the cursor.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.Skin.fonts">
<summary>
Fonts stored in this skin.
</summary>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.#ctor(RecrownedAthenaeum.SpecialTypes.TextureAtlas)">
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.#ctor(RecrownedAthenaeum.SpecialTypes.TextureAtlas,Microsoft.Xna.Framework.Graphics.Texture2D)">
<summary>
Creates a basic unfilled skin.
</summary>
<param name="textureAtlas">The texture atlas to use for this skin.</param>
<param name="cursorTexture">The texture the cursor will be.</param>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.GetTextureAtlasRegion(System.String)">
<summary>
Returns a <see cref="T:RecrownedAthenaeum.SpecialTypes.TextureAtlas.Region"/> with given name of region.
</summary>
<param name="name">Name of region.</param>
<returns>The region corresponding to the name.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.GetColor(System.String)">
<summary>
Returns a <see cref="T:Microsoft.Xna.Framework.Color"/> with given name of defined color;
</summary>
<param name="name">Name of defined color.</param>
<returns>The defined color based on the name given.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.Draw(System.String,System.String,Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Rectangle,System.Single,Microsoft.Xna.Framework.Vector2)">
<summary>
@ -1589,12 +1696,125 @@
<param name="definitionName">The name of the definition.</param>
<param name="skinDefinition">The definition itself.</param>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.RemoveDefinition(System.String,System.Type)">
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.AddColor(System.String,Microsoft.Xna.Framework.Color)">
<summary>
Removes the definition.
Adds color to skin.
</summary>
<param name="name"></param>
<param name="color"></param>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.Laminate">
<summary>
Laminates the skin. Making sure no more additions are done and sets the skin to be ready for use.
Needs to be called before any use of skin. Building skin needs to be done before lamination.
</summary>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.Dispose">
<summary>
Disposes <see cref="F:RecrownedAthenaeum.UI.Skin.Skin.textureAtlas"/> and the <see cref="T:Microsoft.Xna.Framework.Graphics.Texture2D"/> holding the cursor texture.
</summary>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.Dispose(System.Boolean)">
<summary>
Overridable dispose function.
</summary>
<param name="disposing">true when it's a user call to dispose.</param>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.Finalize">
<summary>
Destructor. Calls the dispose with false.
</summary>
</member>
<member name="T:RecrownedAthenaeum.UI.Skin.AsyncComplete">
<summary>
Called when the skin manager has completed a async action.
</summary>
<param name="actionCompleted">The completed action.</param>
</member>
<member name="T:RecrownedAthenaeum.UI.Skin.SkinManager">
<summary>
Manages reference to default and loading of custom skins.
</summary>
</member>
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.ReadyForUse">
<summary>
Whether or not the skin manager is set up with a <see cref="P:RecrownedAthenaeum.UI.Skin.SkinManager.BaseSkin"/> and <see cref="P:RecrownedAthenaeum.UI.Skin.SkinManager.loadedSkin"/>.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.skinPaths">
<summary>
The list of paths for all found skins by <see cref="M:RecrownedAthenaeum.UI.Skin.SkinManager.SearchSkinDirectory"/>. May be null.
</summary>
</member>
<member name="E:RecrownedAthenaeum.UI.Skin.SkinManager.AsyncCompleteEvent">
<summary>
The event that is called when a state changes.
</summary>
</member>
<member name="T:RecrownedAthenaeum.UI.Skin.SkinManager.Action">
<summary>
The various possible states a skin manager could be in.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.Action.SEARCH">
<summary>
After a search has completed.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.Action.LOAD">
<summary>
Having the skin generated to be in a useable state.
</summary>
</member>
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.Skin">
<summary>
the skin that favors the selected skin, but still has a fallback to the default skin in case anything is missing.
</summary>
</member>
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.loadedSkin">
<summary>
The user loaded skin. Set by the skin loaded by calling <see cref="M:RecrownedAthenaeum.UI.Skin.SkinManager.LoadSkin(RecrownedAthenaeum.Data.SkinData,System.String,Microsoft.Xna.Framework.Graphics.GraphicsDevice)"/>.
</summary>
</member>
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.BaseSkin">
<summary>
The fallback skin in case the selected skin doesn't cover a specific definition or color.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.skinsDirectory">
<summary>
The directory that contains the skins.
</summary>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.SkinManager.SearchSkinDirectory">
<summary>
Performs a recursive asynchronous search of the directory given in a path set by <see cref="F:RecrownedAthenaeum.UI.Skin.SkinManager.skinsDirectory"/>.
</summary>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.SkinManager.ReadSkinData(System.String)">
<summary>
Reads skin data if extension is valid.
</summary>
<param name="path">the path to load from.</param>
<returns>A <see cref="T:RecrownedAthenaeum.Data.SkinData"/> that holds all the information and some metadata for the loaded skin.</returns>
</member>
<member name="M:RecrownedAthenaeum.UI.Skin.SkinManager.LoadSkin(RecrownedAthenaeum.Data.SkinData,System.String,Microsoft.Xna.Framework.Graphics.GraphicsDevice)">
<summary>
loads a skin asynchronously.
</summary>
<param name="graphicsDevice">Graphics device to use for texture creation. Uses graphics device from <see cref="T:RecrownedAthenaeum.Configuration"/>by default.</param>
<param name="skinData">The data to generate from.</param>
<param name="path">The path pointing to the file with the extension "<see cref="F:RecrownedAthenaeum.UI.Skin.SkinManager.EXTENSION"/>".</param>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.MergedSkin.mainSkin">
<summary>
The skin to try to use first.
</summary>
</member>
<member name="F:RecrownedAthenaeum.UI.Skin.MergedSkin.alternateSkin">
<summary>
The fallback skin.
</summary>
<param name="definitionName">The name of the definition.</param>
<param name="definitionType">The type of the definition.</param>
</member>
</members>
</doc>

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff