began implementing changes in RA.
This commit is contained in:
Binary file not shown.
@@ -659,7 +659,7 @@
|
||||
The skin definition data.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.Data.SkinData.DefinitionData.#ctor(System.String,RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData)">
|
||||
<member name="M:RecrownedAthenaeum.Data.SkinData.DefinitionData.#ctor(System.String,RecrownedAthenaeum.UI.SkinSystem.Definitions.ISkinDefinitionData)">
|
||||
<summary>
|
||||
Sets values for data.
|
||||
</summary>
|
||||
@@ -1049,85 +1049,100 @@
|
||||
Destructor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Book.Book">
|
||||
<member name="T:RecrownedAthenaeum.UI.BookSystem.Book">
|
||||
<summary>
|
||||
Contains the pages.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.Initiate(RecrownedAthenaeum.Camera.Camera2D,Microsoft.Xna.Framework.Rectangle)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.#ctor(RecrownedAthenaeum.ContentSystem.ContentManagerController,RecrownedAthenaeum.UI.SkinSystem.ISkin)">
|
||||
<summary>
|
||||
Creates a book.
|
||||
</summary>
|
||||
<param name="assets"><see cref="T:RecrownedAthenaeum.ContentSystem.ContentManagerController"/> that holds the assets that are to be used in the pages for this book during initialization.</param>
|
||||
<param name="skin">The skin that will be passed to pages during their initialization.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.Initiate(RecrownedAthenaeum.Camera.Camera2D,Microsoft.Xna.Framework.Rectangle)">
|
||||
<summary>
|
||||
Should be called whenever a valid camera and dimensions for the book exist.
|
||||
Initializes book with given parameters.
|
||||
Generally used with a <see cref="T:RecrownedAthenaeum.ScreenSystem.Screen"/> and called in the <see cref="M:RecrownedAthenaeum.ScreenSystem.Screen.Initiate(Microsoft.Xna.Framework.Rectangle,RecrownedAthenaeum.Camera.Camera2D)"/> function.
|
||||
</summary>
|
||||
<param name="camera">Camera game is currently using.</param>
|
||||
<param name="dimensions">Dimensions of the book and the dimensions the pages will use.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.Draw(Microsoft.Xna.Framework.Graphics.SpriteBatch)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.Draw(Microsoft.Xna.Framework.Graphics.SpriteBatch)">
|
||||
<summary>
|
||||
Draws the pages.
|
||||
</summary>
|
||||
<param name="batch">Batch used to draw.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.Update(Microsoft.Xna.Framework.GameTime)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.Update(Microsoft.Xna.Framework.GameTime)">
|
||||
<summary>
|
||||
Updates the book.
|
||||
</summary>
|
||||
<param name="gameTime">Snapshot of information of the game time.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.AddPages(RecrownedAthenaeum.UI.Book.Page[])">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.AddPages(RecrownedAthenaeum.UI.BookSystem.Page[])">
|
||||
<summary>
|
||||
Adds the page(s).
|
||||
</summary>
|
||||
<param name="pages">The page(s) to add.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.RemovePage(RecrownedAthenaeum.UI.Book.Page)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.RemovePage(RecrownedAthenaeum.UI.BookSystem.Page)">
|
||||
<summary>
|
||||
Removes the page.
|
||||
</summary>
|
||||
<param name="page">Page to remove.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.RemovePage(System.String)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.RemovePage(System.String)">
|
||||
<summary>
|
||||
Removes the page.
|
||||
</summary>
|
||||
<param name="name">Name of page to remove.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.LerpToPage(RecrownedAthenaeum.UI.Book.Page)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.LerpToPage(RecrownedAthenaeum.UI.BookSystem.Page)">
|
||||
<summary>
|
||||
Perform a step of linear interpolation to the given page.
|
||||
</summary>
|
||||
<param name="page">The page to lerp to.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Book.GoToPage(RecrownedAthenaeum.UI.Book.Page)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Book.GoToPage(RecrownedAthenaeum.UI.BookSystem.Page)">
|
||||
<summary>
|
||||
Goes to page instantly.
|
||||
</summary>
|
||||
<param name="page">Page to go to.</param>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Book.Page">
|
||||
<member name="T:RecrownedAthenaeum.UI.BookSystem.Page">
|
||||
<summary>
|
||||
A page a part of a <see cref="T:RecrownedAthenaeum.UI.Book.Book"/>.
|
||||
A page a part of a <see cref="T:RecrownedAthenaeum.UI.BookSystem.Book"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Book.Page.requiresSizeUpdate">
|
||||
<member name="F:RecrownedAthenaeum.UI.BookSystem.Page.requiresSizeUpdate">
|
||||
<summary>
|
||||
Whether or not this book needs to be refreshed with new dimensions.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Page.#ctor(System.Int32,System.Int32)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Page.#ctor(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Constructs a page.
|
||||
</summary>
|
||||
<param name="pageX">The X position in the book.</param>
|
||||
<param name="pageY">The Y position in the book.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Book.Page.ApplySize(System.Int32,System.Int32)">
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Page.ApplySize(System.Int32,System.Int32)">
|
||||
<summary>
|
||||
Called when this page is flagged as needing a size update.
|
||||
</summary>
|
||||
<param name="width">New width.</param>
|
||||
<param name="height">New Height</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.BookSystem.Page.Initialize(RecrownedAthenaeum.ContentSystem.ContentManagerController,RecrownedAthenaeum.UI.SkinSystem.ISkin)">
|
||||
<summary>
|
||||
Called only once after a page is added to a <see cref="T:RecrownedAthenaeum.UI.BookSystem.Book"/>. Generally used to instantiate the modules of the page.
|
||||
</summary>
|
||||
<param name="assets">The assets to be used during initialization passed by the book this page belongs to.</param>
|
||||
<param name="skin">The skin the book containing this page is given that can be used by this page.</param>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Modular.Modules.Image">
|
||||
<summary>
|
||||
Represents a texture with more information.
|
||||
@@ -1184,6 +1199,7 @@
|
||||
<summary>
|
||||
Function to be called when button is clicked.
|
||||
</summary>
|
||||
<param name="button">The button that was clicked.</param>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Modular.Modules.Interactive.Button">
|
||||
<summary>
|
||||
@@ -1214,7 +1230,7 @@
|
||||
<param name="disabled">Disabled button.</param>
|
||||
<param name="selected">Button being highlighted.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Interactive.Button.#ctor(RecrownedAthenaeum.UI.Skin.Skin,System.String)">
|
||||
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Interactive.Button.#ctor(RecrownedAthenaeum.UI.SkinSystem.ISkin,System.String)">
|
||||
<summary>
|
||||
Constructs this button using the skin system.
|
||||
</summary>
|
||||
@@ -1246,6 +1262,11 @@
|
||||
Button that holds a string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Modular.Modules.Interactive.TextButton.text">
|
||||
<summary>
|
||||
The text that is used to display the string.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Modular.Modules.Interactive.TextButton.FontColor">
|
||||
<summary>
|
||||
The color the font should be rendered in.
|
||||
@@ -1262,7 +1283,7 @@
|
||||
<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,Microsoft.Xna.Framework.Graphics.SpriteFont,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.SkinSystem.ISkin,System.String)">
|
||||
<summary>
|
||||
Constructs a text button using a skin and definition.
|
||||
</summary>
|
||||
@@ -1320,12 +1341,12 @@
|
||||
<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,Microsoft.Xna.Framework.Graphics.SpriteFont,System.String,System.String)">
|
||||
<member name="M:RecrownedAthenaeum.UI.Modular.Modules.Text.#ctor(RecrownedAthenaeum.UI.SkinSystem.ISkin,Microsoft.Xna.Framework.Graphics.SpriteFont,System.String,System.String)">
|
||||
<summary>
|
||||
Creates a UI text object
|
||||
</summary>
|
||||
<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="skinDefinitionName">The name of the skin's definition to use of a <see cref="T:RecrownedAthenaeum.UI.SkinSystem.Definitions.TextSkinDefinition"/>.</param>
|
||||
<param name="font">The font to be used.</param>
|
||||
<param name="content">The string of text to be displayed.</param>
|
||||
</member>
|
||||
@@ -1435,6 +1456,11 @@
|
||||
<param name="state">The current state of the mouse.</param>
|
||||
<returns>Returning whether or not to continue to call the next listener.</returns>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Modular.UIModule.CenterOrigin">
|
||||
<summary>
|
||||
Sets the origin to be the center of the bounds.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Modular.UIModuleGroup">
|
||||
<summary>
|
||||
Contains a group of modules and has its own relative coordinate system.
|
||||
@@ -1490,84 +1516,84 @@
|
||||
<param name="state">The new state.</param>
|
||||
<returns>Whether or not to continue updating other listeners.</returns>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Skin.Definitions.ButtonSkinDefinition">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.Definitions.ButtonSkinDefinition">
|
||||
<summary>
|
||||
Definition for a button.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.Definitions.ButtonSkinDefinition.upRegion">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.Definitions.ButtonSkinDefinition.upRegion">
|
||||
<summary>
|
||||
Names for the regions in the texture atlas respectively.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.Definitions.ButtonSkinDefinition.downRegion">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.Definitions.ButtonSkinDefinition.downRegion">
|
||||
<summary>
|
||||
Names for the regions in the texture atlas respectively.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.Definitions.ButtonSkinDefinition.disabledRegion">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.Definitions.ButtonSkinDefinition.disabledRegion">
|
||||
<summary>
|
||||
Names for the regions in the texture atlas respectively.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.Definitions.ButtonSkinDefinition.selectedRegion">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.Definitions.ButtonSkinDefinition.selectedRegion">
|
||||
<summary>
|
||||
Names for the regions in the texture atlas respectively.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.Definitions.ButtonSkinDefinition.UIModuleType">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.Definitions.ButtonSkinDefinition.UIModuleType">
|
||||
<inheritDoc/>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.Definitions.ButtonSkinDefinition.#ctor(System.String,System.String)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Definitions.ButtonSkinDefinition.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Constructs the definition with minimum requirements.
|
||||
</summary>
|
||||
<param name="downRegion">Name of region specifying the texture shown for when the button is pressed down.</param>
|
||||
<param name="upRegion">Name of region specifying the texture shown for when the button is not pressed.</param>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.Definitions.ISkinDefinitionData">
|
||||
<summary>
|
||||
A definition containing the data for the skin system. Should be in data transfer object model.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData.UIModuleType">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.Definitions.ISkinDefinitionData.UIModuleType">
|
||||
<summary>
|
||||
The module type this definition is definining.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Skin.Definitions.TextButtonSkinDefinition">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.Definitions.TextButtonSkinDefinition">
|
||||
<summary>
|
||||
Definition for a text button for a skin theme.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.Definitions.TextButtonSkinDefinition.fontColor">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.Definitions.TextButtonSkinDefinition.fontColor">
|
||||
<summary>
|
||||
Name of color from the skin to use for the font.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.Definitions.TextButtonSkinDefinition.UIModuleType">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.Definitions.TextButtonSkinDefinition.UIModuleType">
|
||||
<summary>
|
||||
The type of module that will be using this definition.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.Definitions.TextButtonSkinDefinition.#ctor(System.String,System.String)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Definitions.TextButtonSkinDefinition.#ctor(System.String,System.String)">
|
||||
<summary>
|
||||
Creates this definition with the most minimal requirements.
|
||||
</summary>
|
||||
<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">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.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">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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>
|
||||
@@ -1578,36 +1604,36 @@
|
||||
<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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.ISkin.ObtainDefinition(System.String,System.Type)">
|
||||
<summary>
|
||||
Returns an <see cref="T:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData"/> of the given name and type.
|
||||
Returns an <see cref="T:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.ISkin.ObtainDefinition(System.Type)">
|
||||
<summary>
|
||||
Returns the default <see cref="T:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData"/> of the given parameters.
|
||||
Returns the default <see cref="T:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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>
|
||||
@@ -1616,7 +1642,7 @@
|
||||
<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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.ISkin.ObtainDefinition``1(System.Type)">
|
||||
<summary>
|
||||
Returns the default definition.
|
||||
</summary>
|
||||
@@ -1624,43 +1650,43 @@
|
||||
<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">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.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="P:RecrownedAthenaeum.UI.Skin.Skin.Laminated">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.Skin.Laminated">
|
||||
<summary>
|
||||
Whether or not this skin is completed being built and thus ready to use.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.Skin.CursorTexture">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.Skin.CursorTexture">
|
||||
<summary>
|
||||
The texture for the cursor.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.#ctor(RecrownedAthenaeum.SpecialTypes.TextureAtlas,Microsoft.Xna.Framework.Graphics.Texture2D)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.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>
|
||||
@@ -1671,22 +1697,22 @@
|
||||
<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.Skin.ObtainDefinition(System.String,System.Type)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.ObtainDefinition(System.String,System.Type)">
|
||||
<summary>
|
||||
Returns an <see cref="T:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData"/> of the given name and type.
|
||||
Returns an <see cref="T:RecrownedAthenaeum.UI.SkinSystem.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.Skin.ObtainDefinition(System.Type)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.ObtainDefinition(System.Type)">
|
||||
<summary>
|
||||
Returns the default <see cref="T:RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData"/> of the given parameters.
|
||||
Returns the default <see cref="T:RecrownedAthenaeum.UI.SkinSystem.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.Skin.ObtainDefinition``1(System.String,System.Type)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.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>
|
||||
@@ -1695,7 +1721,7 @@
|
||||
<param name="type">UIModule type the definition defines.</param>
|
||||
<returns>The definition cast to T.</returns>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.ObtainDefinition``1(System.Type)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.ObtainDefinition``1(System.Type)">
|
||||
<summary>
|
||||
Returns the default definition.
|
||||
</summary>
|
||||
@@ -1703,134 +1729,134 @@
|
||||
<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="M:RecrownedAthenaeum.UI.Skin.Skin.AddDefinition(System.String,RecrownedAthenaeum.UI.Skin.Definitions.ISkinDefinitionData)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.AddDefinition(System.String,RecrownedAthenaeum.UI.SkinSystem.Definitions.ISkinDefinitionData)">
|
||||
<summary>
|
||||
Adds the definition.
|
||||
</summary>
|
||||
<param name="definitionName">The name of the definition.</param>
|
||||
<param name="skinDefinition">The definition itself.</param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.AddColor(System.String,Microsoft.Xna.Framework.Color)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.AddColor(System.String,Microsoft.Xna.Framework.Color)">
|
||||
<summary>
|
||||
Adds color to skin.
|
||||
</summary>
|
||||
<param name="name"></param>
|
||||
<param name="color"></param>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.Skin.Laminate">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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.
|
||||
Disposes <see cref="F:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.Skin.Finalize">
|
||||
<summary>
|
||||
Destructor. Calls the dispose with false.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Skin.AsyncComplete">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.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">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.SkinManager">
|
||||
<summary>
|
||||
Manages reference to default and loading of custom skins.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.MergingSkins">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.SkinManager.MergingSkins">
|
||||
<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"/>.
|
||||
Whether or not the skin manager is set up with a <see cref="P:RecrownedAthenaeum.UI.SkinSystem.SkinManager.BaseSkin"/> and <see cref="P:RecrownedAthenaeum.UI.SkinSystem.SkinManager.loadedSkin"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.SkinUseable">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.SkinManager.SkinUseable">
|
||||
<summary>
|
||||
Whether or not this manager has been set up with at least a base skin.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.skinPaths">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.SkinManager.skinPaths">
|
||||
<summary>
|
||||
The list of paths for all found skins by <see cref="M:RecrownedAthenaeum.UI.Skin.SkinManager.SearchSkinDirectory"/>. May be null.
|
||||
The list of paths for all found skins by <see cref="M:RecrownedAthenaeum.UI.SkinSystem.SkinManager.SearchSkinDirectory"/>. May be null.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="E:RecrownedAthenaeum.UI.Skin.SkinManager.AsyncCompleteEvent">
|
||||
<member name="E:RecrownedAthenaeum.UI.SkinSystem.SkinManager.AsyncCompleteEvent">
|
||||
<summary>
|
||||
The event that is called when a state changes.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="T:RecrownedAthenaeum.UI.Skin.SkinManager.Action">
|
||||
<member name="T:RecrownedAthenaeum.UI.SkinSystem.SkinManager.Action">
|
||||
<summary>
|
||||
The various possible states a skin manager could be in.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.Action.SEARCH">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.SkinManager.Action.SEARCH">
|
||||
<summary>
|
||||
After a search has completed.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.Action.LOAD">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.SkinManager.Action.LOAD">
|
||||
<summary>
|
||||
Having the skin generated to be in a useable state.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.Skin">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.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">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.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)"/>.
|
||||
The user loaded skin. Set by the skin loaded by calling <see cref="M:RecrownedAthenaeum.UI.SkinSystem.SkinManager.LoadSkin(RecrownedAthenaeum.Data.SkinData,System.String,Microsoft.Xna.Framework.Graphics.GraphicsDevice)"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="P:RecrownedAthenaeum.UI.Skin.SkinManager.BaseSkin">
|
||||
<member name="P:RecrownedAthenaeum.UI.SkinSystem.SkinManager.BaseSkin">
|
||||
<summary>
|
||||
The default skin in case the selected skin doesn't cover a specific definition or color.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.SkinManager.skinsDirectory">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.SkinManager.skinsDirectory">
|
||||
<summary>
|
||||
The directory that contains the skins.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.SkinManager.SearchSkinDirectory">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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"/>.
|
||||
Performs a recursive asynchronous search of the directory given in a path set by <see cref="F:RecrownedAthenaeum.UI.SkinSystem.SkinManager.skinsDirectory"/>.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="M:RecrownedAthenaeum.UI.Skin.SkinManager.ReadSkinData(System.String)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.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)">
|
||||
<member name="M:RecrownedAthenaeum.UI.SkinSystem.SkinManager.LoadSkin(RecrownedAthenaeum.Data.SkinData,System.String,Microsoft.Xna.Framework.Graphics.GraphicsDevice)">
|
||||
<summary>
|
||||
loads a skin asynchronously to the <see cref="P:RecrownedAthenaeum.UI.Skin.SkinManager.loadedSkin"/>.
|
||||
loads a skin asynchronously to the <see cref="P:RecrownedAthenaeum.UI.SkinSystem.SkinManager.loadedSkin"/>.
|
||||
</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>
|
||||
<param name="path">The path pointing to the file with the extension "<see cref="F:RecrownedAthenaeum.UI.SkinSystem.SkinManager.EXTENSION"/>".</param>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.MergedSkin.mainSkin">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.MergedSkin.mainSkin">
|
||||
<summary>
|
||||
The skin to try to use first.
|
||||
</summary>
|
||||
</member>
|
||||
<member name="F:RecrownedAthenaeum.UI.Skin.MergedSkin.alternateSkin">
|
||||
<member name="F:RecrownedAthenaeum.UI.SkinSystem.MergedSkin.alternateSkin">
|
||||
<summary>
|
||||
The fallback skin.
|
||||
</summary>
|
||||
|
Reference in New Issue
Block a user