From 957368230464139ba5356095aa6143d7bd10a308 Mon Sep 17 00:00:00 2001 From: Ellpeck Date: Thu, 21 May 2020 23:19:16 +0200 Subject: [PATCH] also use documentation metadata for cake builds --- Docs/api/.manifest | 4 - Docs/api/MLEM.Animations.AnimationFrame.yml | 8 +- ...M.Animations.SpriteAnimation.Completed.yml | 5 +- Docs/api/MLEM.Animations.SpriteAnimation.yml | 1 + ....SpriteAnimationGroup.AnimationChanged.yml | 12 +- .../MLEM.Animations.SpriteAnimationGroup.yml | 4 +- Docs/api/MLEM.Content.RawContentManager.yml | 11 +- Docs/api/MLEM.Content.RawContentReader-1.yml | 40 +- Docs/api/MLEM.Content.RawContentReader.yml | 32 +- Docs/api/MLEM.Content.SongReader.yml | 10 +- Docs/api/MLEM.Content.SoundEffectReader.yml | 10 +- Docs/api/MLEM.Content.Texture2DReader.yml | 10 +- Docs/api/MLEM.Content.XmlReader.yml | 13 +- .../MLEM.Data.Json.Direction2Converter.yml | 1 + Docs/api/MLEM.Data.Json.PointConverter.yml | 1 + Docs/api/MLEM.Data.Json.RawJsonReader.yml | 1 + .../api/MLEM.Data.Json.RectangleConverter.yml | 1 + .../MLEM.Data.Json.RectangleFConverter.yml | 1 + Docs/api/MLEM.Data.Json.Vector2Converter.yml | 1 + .../MLEM.Extended.Font.GenericBitmapFont.yml | 1 + ...ndividualTiledMapRenderer.TileDrawInfo.yml | 1 + ...d.TiledMapCollisions.TileCollisionInfo.yml | 1 + Docs/api/MLEM.Extensions.ColorExtensions.yml | 42 +- ...sions.GraphicsExtensions.TargetContext.yml | 44 +- .../MLEM.Extensions.GraphicsExtensions.yml | 64 +-- Docs/api/MLEM.Extensions.NumberExtensions.yml | 173 ++++---- Docs/api/MLEM.Extensions.RandomExtensions.yml | 28 +- Docs/api/MLEM.Extensions.SoundExtensions.yml | 35 +- .../MLEM.Extensions.SpriteBatchExtensions.yml | 40 +- Docs/api/MLEM.Font.GenericFont.yml | 2 - Docs/api/MLEM.Font.GenericSpriteFont.yml | 32 +- Docs/api/MLEM.Font.TextAlign.yml | 127 +++++- .../MLEM.Formatting.Codes.AnimatedCode.yml | 10 +- ...MLEM.Formatting.Codes.Code.Constructor.yml | 10 +- Docs/api/MLEM.Formatting.Codes.Code.yml | 94 +++- Docs/api/MLEM.Formatting.Codes.ColorCode.yml | 10 +- Docs/api/MLEM.Formatting.Codes.FontCode.yml | 13 +- Docs/api/MLEM.Formatting.Codes.ImageCode.yml | 19 +- ...M.Formatting.Codes.ImageCodeExtensions.yml | 80 +++- Docs/api/MLEM.Formatting.Codes.LinkCode.yml | 15 +- Docs/api/MLEM.Formatting.Codes.ShadowCode.yml | 10 +- .../MLEM.Formatting.Codes.UnderlineCode.yml | 10 +- Docs/api/MLEM.Formatting.Codes.WobblyCode.yml | 17 +- Docs/api/MLEM.Formatting.FormatSettings.yml | 1 + ...EM.Formatting.FormattingCodeCollection.yml | 2 + .../MLEM.Formatting.FormattingCodeData.yml | 1 + Docs/api/MLEM.Formatting.TextFormatter.yml | 58 ++- Docs/api/MLEM.Formatting.Token.yml | 149 ++++--- Docs/api/MLEM.Formatting.TokenizedString.yml | 411 +++++++++++++++--- Docs/api/MLEM.Input.InputHandler.yml | 337 +++++++++++--- Docs/api/MLEM.Input.KeysExtensions.yml | 70 ++- Docs/api/MLEM.Input.ModifierKey.yml | 23 +- Docs/api/MLEM.Input.MouseButton.yml | 52 ++- Docs/api/MLEM.Input.MouseExtensions.yml | 51 ++- Docs/api/MLEM.Misc.AutoTiling.ConnectsTo.yml | 6 +- Docs/api/MLEM.Misc.AutoTiling.yml | 21 +- Docs/api/MLEM.Misc.Direction2.yml | 40 +- Docs/api/MLEM.Misc.Direction2Helper.yml | 135 +++++- Docs/api/MLEM.Misc.EnumHelper.yml | 27 +- Docs/api/MLEM.Misc.GenericDataHolder.yml | 22 +- Docs/api/MLEM.Misc.Padding.yml | 75 +++- Docs/api/MLEM.Misc.RectangleF.yml | 199 +++++++-- ...MLEM.Misc.TextInputWrapper.DesktopGl-1.yml | 18 +- .../api/MLEM.Misc.TextInputWrapper.Mobile.yml | 11 +- Docs/api/MLEM.Misc.TextInputWrapper.None.yml | 11 +- .../MLEM.Misc.TextInputWrapper.Primitive.yml | 55 ++- ...isc.TextInputWrapper.TextInputCallback.yml | 66 ++- Docs/api/MLEM.Misc.TextInputWrapper.yml | 25 +- Docs/api/MLEM.Pathfinding.AStar-1.GetCost.yml | 20 +- Docs/api/MLEM.Pathfinding.AStar-1.yml | 279 +++++++++++- Docs/api/MLEM.Pathfinding.AStar2.yml | 112 ++--- Docs/api/MLEM.Pathfinding.AStar3.yml | 112 ++--- Docs/api/MLEM.Pathfinding.PathPoint-1.yml | 103 ++++- Docs/api/MLEM.Startup.MlemGame.yml | 2 + Docs/api/MLEM.Textures.NinePatch.yml | 289 ++---------- .../api/MLEM.Textures.NinePatchExtensions.yml | 41 +- Docs/api/MLEM.Textures.TextureRegion.yml | 64 ++- .../MLEM.Textures.TextureRegionExtensions.yml | 40 +- .../api/MLEM.Textures.UniformTextureAtlas.yml | 71 ++- Docs/api/MLEM.Ui.Elements.Button.yml | 1 + Docs/api/MLEM.Ui.Elements.Checkbox.yml | 1 + Docs/api/MLEM.Ui.Elements.CustomDrawGroup.yml | 1 + Docs/api/MLEM.Ui.Elements.Dropdown.yml | 1 + Docs/api/MLEM.Ui.Elements.Element.yml | 3 + Docs/api/MLEM.Ui.Elements.Group.yml | 1 + Docs/api/MLEM.Ui.Elements.Image.yml | 1 + Docs/api/MLEM.Ui.Elements.Panel.yml | 1 + Docs/api/MLEM.Ui.Elements.Paragraph.Link.yml | 1 + Docs/api/MLEM.Ui.Elements.Paragraph.yml | 1 + Docs/api/MLEM.Ui.Elements.ProgressBar.yml | 1 + Docs/api/MLEM.Ui.Elements.RadioButton.yml | 1 + Docs/api/MLEM.Ui.Elements.ScrollBar.yml | 1 + Docs/api/MLEM.Ui.Elements.Slider.yml | 1 + .../MLEM.Ui.Elements.SpriteAnimationImage.yml | 1 + Docs/api/MLEM.Ui.Elements.TextField.yml | 1 + Docs/api/MLEM.Ui.Elements.Tooltip.yml | 1 + Docs/api/MLEM.Ui.Elements.VerticalSpace.yml | 1 + Docs/api/MLEM.Ui.Style.UiStyle.yml | 1 + Docs/api/MLEM.Ui.Style.UntexturedStyle.yml | 1 + Docs/api/MLEM.Ui.UiSystem.yml | 2 + build.cake | 6 +- 101 files changed, 2935 insertions(+), 1138 deletions(-) diff --git a/Docs/api/.manifest b/Docs/api/.manifest index 370319b..931ae29 100644 --- a/Docs/api/.manifest +++ b/Docs/api/.manifest @@ -405,7 +405,6 @@ "MLEM.Formatting.TextStyle.Regular": "MLEM.Formatting.TextStyle.yml", "MLEM.Formatting.TextStyle.Shadow": "MLEM.Formatting.TextStyle.yml", "MLEM.Formatting.Token": "MLEM.Formatting.Token.yml", - "MLEM.Formatting.Token.#ctor(MLEM.Formatting.Codes.Code[],System.Int32,System.Int32,System.String,System.String)": "MLEM.Formatting.Token.yml", "MLEM.Formatting.Token.AppliedCodes": "MLEM.Formatting.Token.yml", "MLEM.Formatting.Token.DisplayString": "MLEM.Formatting.Token.yml", "MLEM.Formatting.Token.DrawCharacter(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,System.Char,System.String,System.Int32,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single)": "MLEM.Formatting.Token.yml", @@ -418,7 +417,6 @@ "MLEM.Formatting.Token.RawSubstring": "MLEM.Formatting.Token.yml", "MLEM.Formatting.Token.Substring": "MLEM.Formatting.Token.yml", "MLEM.Formatting.TokenizedString": "MLEM.Formatting.TokenizedString.yml", - "MLEM.Formatting.TokenizedString.#ctor(MLEM.Font.GenericFont,System.String,System.String,MLEM.Formatting.Token[])": "MLEM.Formatting.TokenizedString.yml", "MLEM.Formatting.TokenizedString.AllCodes": "MLEM.Formatting.TokenizedString.yml", "MLEM.Formatting.TokenizedString.DisplayString": "MLEM.Formatting.TokenizedString.yml", "MLEM.Formatting.TokenizedString.Draw(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single)": "MLEM.Formatting.TokenizedString.yml", @@ -668,8 +666,6 @@ "MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,MLEM.Misc.Padding)": "MLEM.Textures.NinePatch.yml", "MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32)": "MLEM.Textures.NinePatch.yml", "MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32,System.Int32,System.Int32,System.Int32)": "MLEM.Textures.NinePatch.yml", - "MLEM.Textures.NinePatch.CreateRectangles(Microsoft.Xna.Framework.Rectangle,System.Single)": "MLEM.Textures.NinePatch.yml", - "MLEM.Textures.NinePatch.CreateRectangles(MLEM.Misc.RectangleF,System.Single)": "MLEM.Textures.NinePatch.yml", "MLEM.Textures.NinePatch.Padding": "MLEM.Textures.NinePatch.yml", "MLEM.Textures.NinePatch.Region": "MLEM.Textures.NinePatch.yml", "MLEM.Textures.NinePatch.SourceRectangles": "MLEM.Textures.NinePatch.yml", diff --git a/Docs/api/MLEM.Animations.AnimationFrame.yml b/Docs/api/MLEM.Animations.AnimationFrame.yml index 2cb710f..76f9cf9 100644 --- a/Docs/api/MLEM.Animations.AnimationFrame.yml +++ b/Docs/api/MLEM.Animations.AnimationFrame.yml @@ -22,7 +22,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: AnimationFrame path: ../MLEM/Animations/SpriteAnimation.cs - startLine: 147 + startLine: 151 assemblies: - MLEM namespace: MLEM.Animations @@ -65,7 +65,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Region path: ../MLEM/Animations/SpriteAnimation.cs - startLine: 152 + startLine: 156 assemblies: - MLEM namespace: MLEM.Animations @@ -100,7 +100,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Seconds path: ../MLEM/Animations/SpriteAnimation.cs - startLine: 156 + startLine: 160 assemblies: - MLEM namespace: MLEM.Animations @@ -135,7 +135,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Animations/SpriteAnimation.cs - startLine: 163 + startLine: 167 assemblies: - MLEM namespace: MLEM.Animations diff --git a/Docs/api/MLEM.Animations.SpriteAnimation.Completed.yml b/Docs/api/MLEM.Animations.SpriteAnimation.Completed.yml index af2cd6a..f1bf615 100644 --- a/Docs/api/MLEM.Animations.SpriteAnimation.Completed.yml +++ b/Docs/api/MLEM.Animations.SpriteAnimation.Completed.yml @@ -19,15 +19,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: Completed path: ../MLEM/Animations/SpriteAnimation.cs - startLine: 140 + startLine: 144 assemblies: - MLEM namespace: MLEM.Animations + summary: "\nA callback for when a sprite animation is completed.\n" + example: [] syntax: content: public delegate void Completed(SpriteAnimation animation); parameters: - id: animation type: MLEM.Animations.SpriteAnimation + description: The animation that has completed content.vb: Public Delegate Sub Completed(animation As SpriteAnimation) modifiers.csharp: - public diff --git a/Docs/api/MLEM.Animations.SpriteAnimation.yml b/Docs/api/MLEM.Animations.SpriteAnimation.yml index 3cabbec..6a241e6 100644 --- a/Docs/api/MLEM.Animations.SpriteAnimation.yml +++ b/Docs/api/MLEM.Animations.SpriteAnimation.yml @@ -45,6 +45,7 @@ items: content: 'public class SpriteAnimation : GenericDataHolder' content.vb: >- Public Class SpriteAnimation + Inherits GenericDataHolder inheritance: - System.Object diff --git a/Docs/api/MLEM.Animations.SpriteAnimationGroup.AnimationChanged.yml b/Docs/api/MLEM.Animations.SpriteAnimationGroup.AnimationChanged.yml index 4707f84..f2c011d 100644 --- a/Docs/api/MLEM.Animations.SpriteAnimationGroup.AnimationChanged.yml +++ b/Docs/api/MLEM.Animations.SpriteAnimationGroup.AnimationChanged.yml @@ -19,17 +19,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: AnimationChanged path: ../MLEM/Animations/SpriteAnimationGroup.cs - startLine: 100 + startLine: 105 assemblies: - MLEM namespace: MLEM.Animations + summary: "\nA callback delegate for when a 's current animation changed.\n" + example: [] syntax: content: public delegate void AnimationChanged(SpriteAnimation oldAnim, SpriteAnimation newAnim); parameters: - id: oldAnim type: MLEM.Animations.SpriteAnimation + description: The previous animation - id: newAnim type: MLEM.Animations.SpriteAnimation + description: The new animation content.vb: Public Delegate Sub AnimationChanged(oldAnim As SpriteAnimation, newAnim As SpriteAnimation) modifiers.csharp: - public @@ -38,6 +42,12 @@ items: - Public - Delegate references: +- uid: MLEM.Animations.SpriteAnimationGroup + commentId: T:MLEM.Animations.SpriteAnimationGroup + parent: MLEM.Animations + name: SpriteAnimationGroup + nameWithType: SpriteAnimationGroup + fullName: MLEM.Animations.SpriteAnimationGroup - uid: MLEM.Animations commentId: N:MLEM.Animations name: MLEM.Animations diff --git a/Docs/api/MLEM.Animations.SpriteAnimationGroup.yml b/Docs/api/MLEM.Animations.SpriteAnimationGroup.yml index 15a8703..48adda2 100644 --- a/Docs/api/MLEM.Animations.SpriteAnimationGroup.yml +++ b/Docs/api/MLEM.Animations.SpriteAnimationGroup.yml @@ -37,6 +37,7 @@ items: content: 'public class SpriteAnimationGroup : GenericDataHolder' content.vb: >- Public Class SpriteAnimationGroup + Inherits GenericDataHolder inheritance: - System.Object @@ -224,7 +225,6 @@ items: assemblies: - MLEM namespace: MLEM.Animations - summary: "\nThe speed multiplier that this animation should run with.\nNumbers higher than 1 will increase the speed.\n" example: [] syntax: content: public float SpeedMultiplier { set; } @@ -309,14 +309,12 @@ items: assemblies: - MLEM namespace: MLEM.Animations - summary: "\nUpdates this animation, causing to be increased and the to be updated.\n" example: [] syntax: content: public void Update(GameTime time) parameters: - id: time type: Microsoft.Xna.Framework.GameTime - description: The game's time content.vb: Public Sub Update(time As GameTime) overload: MLEM.Animations.SpriteAnimationGroup.Update* modifiers.csharp: diff --git a/Docs/api/MLEM.Content.RawContentManager.yml b/Docs/api/MLEM.Content.RawContentManager.yml index eba3660..cc5b919 100644 --- a/Docs/api/MLEM.Content.RawContentManager.yml +++ b/Docs/api/MLEM.Content.RawContentManager.yml @@ -35,7 +35,9 @@ items: content: 'public class RawContentManager : ContentManager, IDisposable, IGameComponent' content.vb: >- Public Class RawContentManager + Inherits ContentManager + Implements IDisposable, IGameComponent inheritance: - System.Object @@ -211,10 +213,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: ReloadAsset path: ../MLEM/Content/RawContentManager.cs - startLine: 59 + startLine: 60 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: protected override void ReloadAsset(string originalAssetName, T currentAsset) parameters: @@ -254,10 +257,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Unload path: ../MLEM/Content/RawContentManager.cs - startLine: 82 + startLine: 84 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public override void Unload() content.vb: Public Overrides Sub Unload @@ -287,10 +291,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Initialize path: ../MLEM/Content/RawContentManager.cs - startLine: 89 + startLine: 92 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public void Initialize() content.vb: Public Sub Initialize diff --git a/Docs/api/MLEM.Content.RawContentReader-1.yml b/Docs/api/MLEM.Content.RawContentReader-1.yml index 3d42ab5..86b9193 100644 --- a/Docs/api/MLEM.Content.RawContentReader-1.yml +++ b/Docs/api/MLEM.Content.RawContentReader-1.yml @@ -22,11 +22,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: RawContentReader path: ../MLEM/Content/RawContentReader.cs - startLine: 36 + startLine: 37 assemblies: - MLEM namespace: MLEM.Content - summary: "\nRepresents a way for any kind of raw content file to be read using a \n" example: [] syntax: content: 'public abstract class RawContentReader : RawContentReader' @@ -34,6 +33,7 @@ items: - id: T content.vb: >- Public MustInherit Class RawContentReader(Of T) + Inherits RawContentReader inheritance: - System.Object @@ -80,21 +80,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: CanRead path: ../MLEM/Content/RawContentReader.cs - startLine: 39 + startLine: 40 assemblies: - MLEM namespace: MLEM.Content - summary: "\nReturns if the given type can be loaded by this content reader\n" example: [] syntax: content: public override bool CanRead(Type t) parameters: - id: t type: System.Type - description: The type of asset return: type: System.Boolean - description: If can be loaded by this content reader content.vb: Public Overrides Function CanRead(t As Type) As Boolean overridden: MLEM.Content.RawContentReader.CanRead(System.Type) overload: MLEM.Content.RawContentReader`1.CanRead* @@ -124,33 +121,26 @@ items: repo: https://github.com/Ellpeck/MLEM id: Read path: ../MLEM/Content/RawContentReader.cs - startLine: 44 + startLine: 45 assemblies: - MLEM namespace: MLEM.Content - summary: "\nReads the content file from disk and returns it.\n" example: [] syntax: content: public override object Read(RawContentManager manager, string assetPath, Stream stream, Type t, object existing) parameters: - id: manager type: MLEM.Content.RawContentManager - description: The that is loading the asset - id: assetPath type: System.String - description: The full path to the asset, starting from the - id: stream type: System.IO.Stream - description: A stream that leads to this asset - id: t type: System.Type - description: The type of asset to load - id: existing type: System.Object - description: If this asset is being reloaded, this value contains the previous version of the asset. return: type: System.Object - description: The loaded asset content.vb: Public Overrides Function Read(manager As RawContentManager, assetPath As String, stream As Stream, t As Type, existing As Object) As Object overridden: MLEM.Content.RawContentReader.Read(MLEM.Content.RawContentManager,System.String,System.IO.Stream,System.Type,System.Object) overload: MLEM.Content.RawContentReader`1.Read* @@ -194,7 +184,7 @@ items: description: The that is loading the asset - id: assetPath type: System.String - description: The full path to the asset, starting from the + description: The full path to the asset, starting from the - id: stream type: System.IO.Stream description: A stream that leads to this asset @@ -740,13 +730,33 @@ references: name: System.IO nameWithType: System.IO fullName: System.IO +- uid: Microsoft.Xna.Framework.Content.ContentManager.RootDirectory + commentId: P:Microsoft.Xna.Framework.Content.ContentManager.RootDirectory + parent: Microsoft.Xna.Framework.Content.ContentManager + isExternal: true + name: RootDirectory + nameWithType: ContentManager.RootDirectory + fullName: Microsoft.Xna.Framework.Content.ContentManager.RootDirectory - uid: '{T}' commentId: '!:T' definition: T name: T nameWithType: T fullName: T +- uid: Microsoft.Xna.Framework.Content.ContentManager + commentId: T:Microsoft.Xna.Framework.Content.ContentManager + parent: Microsoft.Xna.Framework.Content + isExternal: true + name: ContentManager + nameWithType: ContentManager + fullName: Microsoft.Xna.Framework.Content.ContentManager - uid: T name: T nameWithType: T fullName: T +- uid: Microsoft.Xna.Framework.Content + commentId: N:Microsoft.Xna.Framework.Content + isExternal: true + name: Microsoft.Xna.Framework.Content + nameWithType: Microsoft.Xna.Framework.Content + fullName: Microsoft.Xna.Framework.Content diff --git a/Docs/api/MLEM.Content.RawContentReader.yml b/Docs/api/MLEM.Content.RawContentReader.yml index cf4a146..38ce7c0 100644 --- a/Docs/api/MLEM.Content.RawContentReader.yml +++ b/Docs/api/MLEM.Content.RawContentReader.yml @@ -22,7 +22,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: RawContentReader path: ../MLEM/Content/RawContentReader.cs - startLine: 7 + startLine: 8 assemblies: - MLEM namespace: MLEM.Content @@ -71,7 +71,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: CanRead path: ../MLEM/Content/RawContentReader.cs - startLine: 14 + startLine: 15 assemblies: - MLEM namespace: MLEM.Content @@ -85,7 +85,7 @@ items: description: The type of asset return: type: System.Boolean - description: If can be loaded by this content reader + description: If the type can be loaded by this content reader content.vb: Public MustOverride Function CanRead(t As Type) As Boolean overload: MLEM.Content.RawContentReader.CanRead* modifiers.csharp: @@ -112,7 +112,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Read path: ../MLEM/Content/RawContentReader.cs - startLine: 25 + startLine: 26 assemblies: - MLEM namespace: MLEM.Content @@ -126,7 +126,7 @@ items: description: The that is loading the asset - id: assetPath type: System.String - description: The full path to the asset, starting from the + description: The full path to the asset, starting from the - id: stream type: System.IO.Stream description: A stream that leads to this asset @@ -165,7 +165,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFileExtensions path: ../MLEM/Content/RawContentReader.cs - startLine: 31 + startLine: 32 assemblies: - MLEM namespace: MLEM.Content @@ -507,6 +507,13 @@ references: name: Boolean nameWithType: Boolean fullName: System.Boolean +- uid: Microsoft.Xna.Framework.Content.ContentManager.RootDirectory + commentId: P:Microsoft.Xna.Framework.Content.ContentManager.RootDirectory + parent: Microsoft.Xna.Framework.Content.ContentManager + isExternal: true + name: RootDirectory + nameWithType: ContentManager.RootDirectory + fullName: Microsoft.Xna.Framework.Content.ContentManager.RootDirectory - uid: MLEM.Content.RawContentReader.Read* commentId: Overload:MLEM.Content.RawContentReader.Read name: Read @@ -526,12 +533,25 @@ references: name: Stream nameWithType: Stream fullName: System.IO.Stream +- uid: Microsoft.Xna.Framework.Content.ContentManager + commentId: T:Microsoft.Xna.Framework.Content.ContentManager + parent: Microsoft.Xna.Framework.Content + isExternal: true + name: ContentManager + nameWithType: ContentManager + fullName: Microsoft.Xna.Framework.Content.ContentManager - uid: System.IO commentId: N:System.IO isExternal: true name: System.IO nameWithType: System.IO fullName: System.IO +- uid: Microsoft.Xna.Framework.Content + commentId: N:Microsoft.Xna.Framework.Content + isExternal: true + name: Microsoft.Xna.Framework.Content + nameWithType: Microsoft.Xna.Framework.Content + fullName: Microsoft.Xna.Framework.Content - uid: MLEM.Content.RawContentReader.GetFileExtensions* commentId: Overload:MLEM.Content.RawContentReader.GetFileExtensions name: GetFileExtensions diff --git a/Docs/api/MLEM.Content.SongReader.yml b/Docs/api/MLEM.Content.SongReader.yml index 9420afe..e322409 100644 --- a/Docs/api/MLEM.Content.SongReader.yml +++ b/Docs/api/MLEM.Content.SongReader.yml @@ -21,14 +21,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: SongReader path: ../MLEM/Content/SongReader.cs - startLine: 5 + startLine: 6 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: 'public class SongReader : RawContentReader' content.vb: >- Public Class SongReader + Inherits RawContentReader(Of Song) inheritance: - System.Object @@ -68,10 +70,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Read path: ../MLEM/Content/SongReader.cs - startLine: 7 + startLine: 9 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: protected override Song Read(RawContentManager manager, string assetPath, Stream stream, Song existing) parameters: @@ -112,10 +115,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFileExtensions path: ../MLEM/Content/SongReader.cs - startLine: 11 + startLine: 14 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public override string[] GetFileExtensions() return: diff --git a/Docs/api/MLEM.Content.SoundEffectReader.yml b/Docs/api/MLEM.Content.SoundEffectReader.yml index ff6d8fc..31dde84 100644 --- a/Docs/api/MLEM.Content.SoundEffectReader.yml +++ b/Docs/api/MLEM.Content.SoundEffectReader.yml @@ -21,14 +21,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: SoundEffectReader path: ../MLEM/Content/SoundEffectReader.cs - startLine: 5 + startLine: 6 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: 'public class SoundEffectReader : RawContentReader' content.vb: >- Public Class SoundEffectReader + Inherits RawContentReader(Of SoundEffect) inheritance: - System.Object @@ -68,10 +70,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Read path: ../MLEM/Content/SoundEffectReader.cs - startLine: 7 + startLine: 9 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: protected override SoundEffect Read(RawContentManager manager, string assetPath, Stream stream, SoundEffect existing) parameters: @@ -112,10 +115,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFileExtensions path: ../MLEM/Content/SoundEffectReader.cs - startLine: 11 + startLine: 14 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public override string[] GetFileExtensions() return: diff --git a/Docs/api/MLEM.Content.Texture2DReader.yml b/Docs/api/MLEM.Content.Texture2DReader.yml index b9a1b4d..bb87fe2 100644 --- a/Docs/api/MLEM.Content.Texture2DReader.yml +++ b/Docs/api/MLEM.Content.Texture2DReader.yml @@ -21,14 +21,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: Texture2DReader path: ../MLEM/Content/Texture2DReader.cs - startLine: 4 + startLine: 5 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: 'public class Texture2DReader : RawContentReader' content.vb: >- Public Class Texture2DReader + Inherits RawContentReader(Of Texture2D) inheritance: - System.Object @@ -68,10 +70,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Read path: ../MLEM/Content/Texture2DReader.cs - startLine: 6 + startLine: 8 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: protected override Texture2D Read(RawContentManager manager, string assetPath, Stream stream, Texture2D existing) parameters: @@ -112,10 +115,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFileExtensions path: ../MLEM/Content/Texture2DReader.cs - startLine: 15 + startLine: 18 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public override string[] GetFileExtensions() return: diff --git a/Docs/api/MLEM.Content.XmlReader.yml b/Docs/api/MLEM.Content.XmlReader.yml index 32318c1..d8e1e34 100644 --- a/Docs/api/MLEM.Content.XmlReader.yml +++ b/Docs/api/MLEM.Content.XmlReader.yml @@ -22,14 +22,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: XmlReader path: ../MLEM/Content/XmlReader.cs - startLine: 5 + startLine: 6 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: 'public class XmlReader : RawContentReader' content.vb: >- Public Class XmlReader + Inherits RawContentReader inheritance: - System.Object @@ -66,10 +68,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: CanRead path: ../MLEM/Content/XmlReader.cs - startLine: 7 + startLine: 9 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public override bool CanRead(Type t) parameters: @@ -104,10 +107,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Read path: ../MLEM/Content/XmlReader.cs - startLine: 11 + startLine: 14 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public override object Read(RawContentManager manager, string assetPath, Stream stream, Type t, object existing) parameters: @@ -150,10 +154,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFileExtensions path: ../MLEM/Content/XmlReader.cs - startLine: 15 + startLine: 19 assemblies: - MLEM namespace: MLEM.Content + example: [] syntax: content: public override string[] GetFileExtensions() return: diff --git a/Docs/api/MLEM.Data.Json.Direction2Converter.yml b/Docs/api/MLEM.Data.Json.Direction2Converter.yml index 46fb624..329ccec 100644 --- a/Docs/api/MLEM.Data.Json.Direction2Converter.yml +++ b/Docs/api/MLEM.Data.Json.Direction2Converter.yml @@ -29,6 +29,7 @@ items: content: 'public class Direction2Converter : JsonConverter' content.vb: >- Public Class Direction2Converter + Inherits JsonConverter(Of Direction2) inheritance: - System.Object diff --git a/Docs/api/MLEM.Data.Json.PointConverter.yml b/Docs/api/MLEM.Data.Json.PointConverter.yml index 91432b7..8a34c9d 100644 --- a/Docs/api/MLEM.Data.Json.PointConverter.yml +++ b/Docs/api/MLEM.Data.Json.PointConverter.yml @@ -29,6 +29,7 @@ items: content: 'public class PointConverter : JsonConverter' content.vb: >- Public Class PointConverter + Inherits JsonConverter(Of Point) inheritance: - System.Object diff --git a/Docs/api/MLEM.Data.Json.RawJsonReader.yml b/Docs/api/MLEM.Data.Json.RawJsonReader.yml index 2d2260f..5a065cb 100644 --- a/Docs/api/MLEM.Data.Json.RawJsonReader.yml +++ b/Docs/api/MLEM.Data.Json.RawJsonReader.yml @@ -30,6 +30,7 @@ items: content: 'public class RawJsonReader : RawContentReader' content.vb: >- Public Class RawJsonReader + Inherits RawContentReader inheritance: - System.Object diff --git a/Docs/api/MLEM.Data.Json.RectangleConverter.yml b/Docs/api/MLEM.Data.Json.RectangleConverter.yml index dce63b0..cfd510d 100644 --- a/Docs/api/MLEM.Data.Json.RectangleConverter.yml +++ b/Docs/api/MLEM.Data.Json.RectangleConverter.yml @@ -29,6 +29,7 @@ items: content: 'public class RectangleConverter : JsonConverter' content.vb: >- Public Class RectangleConverter + Inherits JsonConverter(Of Rectangle) inheritance: - System.Object diff --git a/Docs/api/MLEM.Data.Json.RectangleFConverter.yml b/Docs/api/MLEM.Data.Json.RectangleFConverter.yml index 943d519..25e0bb1 100644 --- a/Docs/api/MLEM.Data.Json.RectangleFConverter.yml +++ b/Docs/api/MLEM.Data.Json.RectangleFConverter.yml @@ -29,6 +29,7 @@ items: content: 'public class RectangleFConverter : JsonConverter' content.vb: >- Public Class RectangleFConverter + Inherits JsonConverter(Of RectangleF) inheritance: - System.Object diff --git a/Docs/api/MLEM.Data.Json.Vector2Converter.yml b/Docs/api/MLEM.Data.Json.Vector2Converter.yml index 3829a90..1b449c7 100644 --- a/Docs/api/MLEM.Data.Json.Vector2Converter.yml +++ b/Docs/api/MLEM.Data.Json.Vector2Converter.yml @@ -29,6 +29,7 @@ items: content: 'public class Vector2Converter : JsonConverter' content.vb: >- Public Class Vector2Converter + Inherits JsonConverter(Of Vector2) inheritance: - System.Object diff --git a/Docs/api/MLEM.Extended.Font.GenericBitmapFont.yml b/Docs/api/MLEM.Extended.Font.GenericBitmapFont.yml index f745c3b..74db69d 100644 --- a/Docs/api/MLEM.Extended.Font.GenericBitmapFont.yml +++ b/Docs/api/MLEM.Extended.Font.GenericBitmapFont.yml @@ -40,6 +40,7 @@ items: content: 'public class GenericBitmapFont : GenericFont' content.vb: >- Public Class GenericBitmapFont + Inherits GenericFont inheritance: - System.Object diff --git a/Docs/api/MLEM.Extended.Tiled.IndividualTiledMapRenderer.TileDrawInfo.yml b/Docs/api/MLEM.Extended.Tiled.IndividualTiledMapRenderer.TileDrawInfo.yml index 8fe73cc..3dfe1ad 100644 --- a/Docs/api/MLEM.Extended.Tiled.IndividualTiledMapRenderer.TileDrawInfo.yml +++ b/Docs/api/MLEM.Extended.Tiled.IndividualTiledMapRenderer.TileDrawInfo.yml @@ -35,6 +35,7 @@ items: content: 'public class TileDrawInfo : GenericDataHolder' content.vb: >- Public Class TileDrawInfo + Inherits GenericDataHolder inheritance: - System.Object diff --git a/Docs/api/MLEM.Extended.Tiled.TiledMapCollisions.TileCollisionInfo.yml b/Docs/api/MLEM.Extended.Tiled.TiledMapCollisions.TileCollisionInfo.yml index 0c8f5b7..7acab44 100644 --- a/Docs/api/MLEM.Extended.Tiled.TiledMapCollisions.TileCollisionInfo.yml +++ b/Docs/api/MLEM.Extended.Tiled.TiledMapCollisions.TileCollisionInfo.yml @@ -34,6 +34,7 @@ items: content: 'public class TileCollisionInfo : GenericDataHolder' content.vb: >- Public Class TileCollisionInfo + Inherits GenericDataHolder inheritance: - System.Object diff --git a/Docs/api/MLEM.Extensions.ColorExtensions.yml b/Docs/api/MLEM.Extensions.ColorExtensions.yml index a7e1b7f..f8dc25b 100644 --- a/Docs/api/MLEM.Extensions.ColorExtensions.yml +++ b/Docs/api/MLEM.Extensions.ColorExtensions.yml @@ -23,10 +23,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: ColorExtensions path: ../MLEM/Extensions/ColorExtensions.cs - startLine: 5 + startLine: 8 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nA set of extensions for dealing with objects\n" + example: [] syntax: content: public static class ColorExtensions content.vb: Public Module ColorExtensions @@ -66,7 +68,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Invert path: ../MLEM/Extensions/ColorExtensions.cs - startLine: 12 + startLine: 15 assemblies: - MLEM namespace: MLEM.Extensions @@ -110,7 +112,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: FromHex path: ../MLEM/Extensions/ColorExtensions.cs - startLine: 22 + startLine: 25 assemblies: - MLEM namespace: MLEM.Extensions @@ -151,7 +153,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: FromHex path: ../MLEM/Extensions/ColorExtensions.cs - startLine: 32 + startLine: 35 assemblies: - MLEM namespace: MLEM.Extensions @@ -193,11 +195,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: CopyAlpha path: ../MLEM/Extensions/ColorExtensions.cs - startLine: 44 + startLine: 47 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nCopies the alpha value from into this color.\n" + summary: "\nCopies the alpha value from another color into this color.\n" example: [] syntax: content: public static Color CopyAlpha(this Color color, Color other) @@ -210,7 +212,7 @@ items: description: The color to copy the alpha from return: type: Microsoft.Xna.Framework.Color - description: The with 's alpha value + description: The first color with the second color's alpha value content.vb: >- @@ -223,6 +225,13 @@ items: - Public - Shared references: +- uid: Microsoft.Xna.Framework.Color + commentId: T:Microsoft.Xna.Framework.Color + parent: Microsoft.Xna.Framework + isExternal: true + name: Color + nameWithType: Color + fullName: Microsoft.Xna.Framework.Color - uid: MLEM.Extensions commentId: N:MLEM.Extensions name: MLEM.Extensions @@ -514,6 +523,12 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework + commentId: N:Microsoft.Xna.Framework + isExternal: true + name: Microsoft.Xna.Framework + nameWithType: Microsoft.Xna.Framework + fullName: Microsoft.Xna.Framework - uid: System commentId: N:System isExternal: true @@ -525,19 +540,6 @@ references: name: Invert nameWithType: ColorExtensions.Invert fullName: MLEM.Extensions.ColorExtensions.Invert -- uid: Microsoft.Xna.Framework.Color - commentId: T:Microsoft.Xna.Framework.Color - parent: Microsoft.Xna.Framework - isExternal: true - name: Color - nameWithType: Color - fullName: Microsoft.Xna.Framework.Color -- uid: Microsoft.Xna.Framework - commentId: N:Microsoft.Xna.Framework - isExternal: true - name: Microsoft.Xna.Framework - nameWithType: Microsoft.Xna.Framework - fullName: Microsoft.Xna.Framework - uid: MLEM.Extensions.ColorExtensions.FromHex* commentId: Overload:MLEM.Extensions.ColorExtensions.FromHex name: FromHex diff --git a/Docs/api/MLEM.Extensions.GraphicsExtensions.TargetContext.yml b/Docs/api/MLEM.Extensions.GraphicsExtensions.TargetContext.yml index 6071ec1..f42fdea 100644 --- a/Docs/api/MLEM.Extensions.GraphicsExtensions.TargetContext.yml +++ b/Docs/api/MLEM.Extensions.GraphicsExtensions.TargetContext.yml @@ -21,14 +21,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: TargetContext path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 74 + startLine: 81 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nRepresents a context in which a is applied.\nThis class should be used with .\n" + example: [] syntax: content: 'public struct TargetContext : IDisposable' content.vb: >- Public Structure TargetContext + Implements IDisposable implements: - System.IDisposable @@ -63,17 +66,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 79 + startLine: 91 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nCreates a new target context with the given settings.\n" + example: [] syntax: content: public TargetContext(GraphicsDevice device, RenderTarget2D target) parameters: - id: device type: Microsoft.Xna.Framework.Graphics.GraphicsDevice + description: The graphics device to apply the target on - id: target type: Microsoft.Xna.Framework.Graphics.RenderTarget2D + description: The target to apply content.vb: Public Sub New(device As GraphicsDevice, target As RenderTarget2D) overload: MLEM.Extensions.GraphicsExtensions.TargetContext.#ctor* modifiers.csharp: @@ -98,10 +105,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Dispose path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 85 + startLine: 100 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nDisposes this target context, which causes the graphics device's previous render targets to be re-applied.\n" + example: [] syntax: content: public void Dispose() content.vb: Public Sub Dispose @@ -113,6 +122,16 @@ items: modifiers.vb: - Public references: +- uid: Microsoft.Xna.Framework.Graphics.RenderTarget2D + commentId: T:Microsoft.Xna.Framework.Graphics.RenderTarget2D + parent: Microsoft.Xna.Framework.Graphics + isExternal: true + name: RenderTarget2D + nameWithType: RenderTarget2D + fullName: Microsoft.Xna.Framework.Graphics.RenderTarget2D +- uid: MLEM.Extensions.GraphicsExtensions.WithRenderTarget(Microsoft.Xna.Framework.Graphics.GraphicsDevice,Microsoft.Xna.Framework.Graphics.RenderTarget2D) + commentId: M:MLEM.Extensions.GraphicsExtensions.WithRenderTarget(Microsoft.Xna.Framework.Graphics.GraphicsDevice,Microsoft.Xna.Framework.Graphics.RenderTarget2D) + isExternal: true - uid: MLEM.Extensions commentId: N:MLEM.Extensions name: MLEM.Extensions @@ -373,6 +392,12 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework.Graphics + commentId: N:Microsoft.Xna.Framework.Graphics + isExternal: true + name: Microsoft.Xna.Framework.Graphics + nameWithType: Microsoft.Xna.Framework.Graphics + fullName: Microsoft.Xna.Framework.Graphics - uid: System commentId: N:System isExternal: true @@ -405,19 +430,6 @@ references: name: GraphicsDevice nameWithType: GraphicsDevice fullName: Microsoft.Xna.Framework.Graphics.GraphicsDevice -- uid: Microsoft.Xna.Framework.Graphics.RenderTarget2D - commentId: T:Microsoft.Xna.Framework.Graphics.RenderTarget2D - parent: Microsoft.Xna.Framework.Graphics - isExternal: true - name: RenderTarget2D - nameWithType: RenderTarget2D - fullName: Microsoft.Xna.Framework.Graphics.RenderTarget2D -- uid: Microsoft.Xna.Framework.Graphics - commentId: N:Microsoft.Xna.Framework.Graphics - isExternal: true - name: Microsoft.Xna.Framework.Graphics - nameWithType: Microsoft.Xna.Framework.Graphics - fullName: Microsoft.Xna.Framework.Graphics - uid: MLEM.Extensions.GraphicsExtensions.TargetContext.Dispose* commentId: Overload:MLEM.Extensions.GraphicsExtensions.TargetContext.Dispose name: Dispose diff --git a/Docs/api/MLEM.Extensions.GraphicsExtensions.yml b/Docs/api/MLEM.Extensions.GraphicsExtensions.yml index f484a1a..9078f2f 100644 --- a/Docs/api/MLEM.Extensions.GraphicsExtensions.yml +++ b/Docs/api/MLEM.Extensions.GraphicsExtensions.yml @@ -23,10 +23,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: GraphicsExtensions path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nA set of extensions for dealing with and \n" + example: [] syntax: content: public static class GraphicsExtensions content.vb: Public Module GraphicsExtensions @@ -66,7 +68,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: SetFullscreen path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 17 + startLine: 20 assemblies: - MLEM namespace: MLEM.Extensions @@ -115,7 +117,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: ApplyChangesSafely path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 41 + startLine: 44 assemblies: - MLEM namespace: MLEM.Extensions @@ -157,7 +159,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: ResetWidthAndHeight path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 56 + startLine: 59 assemblies: - MLEM namespace: MLEM.Extensions @@ -202,7 +204,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: WithRenderTarget path: ../MLEM/Extensions/GraphicsExtensions.cs - startLine: 70 + startLine: 73 assemblies: - MLEM namespace: MLEM.Extensions @@ -232,6 +234,20 @@ items: - Public - Shared references: +- uid: Microsoft.Xna.Framework.Graphics.GraphicsDevice + commentId: T:Microsoft.Xna.Framework.Graphics.GraphicsDevice + parent: Microsoft.Xna.Framework.Graphics + isExternal: true + name: GraphicsDevice + nameWithType: GraphicsDevice + fullName: Microsoft.Xna.Framework.Graphics.GraphicsDevice +- uid: Microsoft.Xna.Framework.GraphicsDeviceManager + commentId: T:Microsoft.Xna.Framework.GraphicsDeviceManager + parent: Microsoft.Xna.Framework + isExternal: true + name: GraphicsDeviceManager + nameWithType: GraphicsDeviceManager + fullName: Microsoft.Xna.Framework.GraphicsDeviceManager - uid: MLEM.Extensions commentId: N:MLEM.Extensions name: MLEM.Extensions @@ -523,6 +539,18 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework.Graphics + commentId: N:Microsoft.Xna.Framework.Graphics + isExternal: true + name: Microsoft.Xna.Framework.Graphics + nameWithType: Microsoft.Xna.Framework.Graphics + fullName: Microsoft.Xna.Framework.Graphics +- uid: Microsoft.Xna.Framework + commentId: N:Microsoft.Xna.Framework + isExternal: true + name: Microsoft.Xna.Framework + nameWithType: Microsoft.Xna.Framework + fullName: Microsoft.Xna.Framework - uid: System commentId: N:System isExternal: true @@ -537,13 +565,6 @@ references: name: SetFullscreen nameWithType: GraphicsExtensions.SetFullscreen fullName: MLEM.Extensions.GraphicsExtensions.SetFullscreen -- uid: Microsoft.Xna.Framework.GraphicsDeviceManager - commentId: T:Microsoft.Xna.Framework.GraphicsDeviceManager - parent: Microsoft.Xna.Framework - isExternal: true - name: GraphicsDeviceManager - nameWithType: GraphicsDeviceManager - fullName: Microsoft.Xna.Framework.GraphicsDeviceManager - uid: System.Boolean commentId: T:System.Boolean parent: System @@ -551,12 +572,6 @@ references: name: Boolean nameWithType: Boolean fullName: System.Boolean -- uid: Microsoft.Xna.Framework - commentId: N:Microsoft.Xna.Framework - isExternal: true - name: Microsoft.Xna.Framework - nameWithType: Microsoft.Xna.Framework - fullName: Microsoft.Xna.Framework - uid: Microsoft.Xna.Framework.GraphicsDeviceManager.ApplyChanges commentId: M:Microsoft.Xna.Framework.GraphicsDeviceManager.ApplyChanges isExternal: true @@ -588,13 +603,6 @@ references: name: WithRenderTarget nameWithType: GraphicsExtensions.WithRenderTarget fullName: MLEM.Extensions.GraphicsExtensions.WithRenderTarget -- uid: Microsoft.Xna.Framework.Graphics.GraphicsDevice - commentId: T:Microsoft.Xna.Framework.Graphics.GraphicsDevice - parent: Microsoft.Xna.Framework.Graphics - isExternal: true - name: GraphicsDevice - nameWithType: GraphicsDevice - fullName: Microsoft.Xna.Framework.Graphics.GraphicsDevice - uid: Microsoft.Xna.Framework.Graphics.RenderTarget2D commentId: T:Microsoft.Xna.Framework.Graphics.RenderTarget2D parent: Microsoft.Xna.Framework.Graphics @@ -602,9 +610,3 @@ references: name: RenderTarget2D nameWithType: RenderTarget2D fullName: Microsoft.Xna.Framework.Graphics.RenderTarget2D -- uid: Microsoft.Xna.Framework.Graphics - commentId: N:Microsoft.Xna.Framework.Graphics - isExternal: true - name: Microsoft.Xna.Framework.Graphics - nameWithType: Microsoft.Xna.Framework.Graphics - fullName: Microsoft.Xna.Framework.Graphics diff --git a/Docs/api/MLEM.Extensions.NumberExtensions.yml b/Docs/api/MLEM.Extensions.NumberExtensions.yml index 3d40ded..0a48ab2 100644 --- a/Docs/api/MLEM.Extensions.NumberExtensions.yml +++ b/Docs/api/MLEM.Extensions.NumberExtensions.yml @@ -36,10 +36,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: NumberExtensions path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 5 + startLine: 8 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nA set of extensions for dealing with , , , , , and \n" + example: [] syntax: content: public static class NumberExtensions content.vb: Public Module NumberExtensions @@ -79,7 +81,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Floor path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 8 + startLine: 11 assemblies: - MLEM namespace: MLEM.Extensions @@ -121,7 +123,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Ceil path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 13 + startLine: 16 assemblies: - MLEM namespace: MLEM.Extensions @@ -163,7 +165,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 24 + startLine: 27 assemblies: - MLEM namespace: MLEM.Extensions @@ -183,7 +185,7 @@ items: description: The equality tolerance return: type: System.Boolean - description: Whether or not and are different by at most + description: Whether or not the two values are different by at most tolerance content.vb: >- @@ -214,11 +216,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 29 + startLine: 32 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nChecks for decimal equality with a given tolerance.\n" example: [] syntax: content: public static bool Equals(this Vector2 first, Vector2 second, float tolerance) @@ -229,10 +230,8 @@ items: type: Microsoft.Xna.Framework.Vector2 - id: tolerance type: System.Single - description: The equality tolerance return: type: System.Boolean - description: Whether or not and are different by at most content.vb: >- @@ -263,11 +262,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 34 + startLine: 37 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nChecks for decimal equality with a given tolerance.\n" example: [] syntax: content: public static bool Equals(this Vector3 first, Vector3 second, float tolerance) @@ -278,10 +276,8 @@ items: type: Microsoft.Xna.Framework.Vector3 - id: tolerance type: System.Single - description: The equality tolerance return: type: System.Boolean - description: Whether or not and are different by at most content.vb: >- @@ -312,11 +308,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 39 + startLine: 42 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nChecks for decimal equality with a given tolerance.\n" example: [] syntax: content: public static bool Equals(this Vector4 first, Vector4 second, float tolerance) @@ -327,10 +322,8 @@ items: type: Microsoft.Xna.Framework.Vector4 - id: tolerance type: System.Single - description: The equality tolerance return: type: System.Boolean - description: Whether or not and are different by at most content.vb: >- @@ -361,7 +354,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Floor path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 44 + startLine: 47 assemblies: - MLEM namespace: MLEM.Extensions @@ -403,7 +396,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Floor path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 49 + startLine: 52 assemblies: - MLEM namespace: MLEM.Extensions @@ -445,7 +438,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Floor path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 54 + startLine: 57 assemblies: - MLEM namespace: MLEM.Extensions @@ -487,7 +480,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Multiply path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 64 + startLine: 67 assemblies: - MLEM namespace: MLEM.Extensions @@ -535,7 +528,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Divide path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 74 + startLine: 77 assemblies: - MLEM namespace: MLEM.Extensions @@ -583,7 +576,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Transform path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 84 + startLine: 87 assemblies: - MLEM namespace: MLEM.Extensions @@ -631,7 +624,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: OffsetCopy path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 97 + startLine: 100 assemblies: - MLEM namespace: MLEM.Extensions @@ -679,11 +672,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: OffsetCopy path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 104 + startLine: 107 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nReturns a copy of the given rectangle, moved by the given point.\nThe rectangle's size remains unchanged.\n" example: [] syntax: content: public static RectangleF OffsetCopy(this RectangleF rect, Vector2 offset) @@ -694,7 +686,6 @@ items: type: Microsoft.Xna.Framework.Vector2 return: type: MLEM.Misc.RectangleF - description: The moved rectangle content.vb: >- @@ -725,7 +716,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Shrink path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 116 + startLine: 119 assemblies: - MLEM namespace: MLEM.Extensions @@ -773,11 +764,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: Shrink path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 125 + startLine: 128 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nShrinks the rectangle by the given padding, causing its size to decrease by twice the amount and its position to be moved inwards by the amount.\n" example: [] syntax: content: public static RectangleF Shrink(this RectangleF rect, Vector2 padding) @@ -788,7 +778,6 @@ items: type: Microsoft.Xna.Framework.Vector2 return: type: MLEM.Misc.RectangleF - description: The shrunk rectangle content.vb: >- @@ -819,11 +808,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: Shrink path: ../MLEM/Extensions/NumberExtensions.cs - startLine: 134 + startLine: 137 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nShrinks the rectangle by the given padding, causing its size to decrease by twice the amount and its position to be moved inwards by the amount.\n" example: [] syntax: content: public static RectangleF Shrink(this RectangleF rect, Padding padding) @@ -834,7 +822,6 @@ items: type: MLEM.Misc.Padding return: type: MLEM.Misc.RectangleF - description: The shrunk rectangle content.vb: >- @@ -847,6 +834,54 @@ items: - Public - Shared references: +- uid: System.Single + commentId: T:System.Single + parent: System + isExternal: true + name: Single + nameWithType: Single + fullName: System.Single +- uid: Microsoft.Xna.Framework.Vector2 + commentId: T:Microsoft.Xna.Framework.Vector2 + parent: Microsoft.Xna.Framework + isExternal: true + name: Vector2 + nameWithType: Vector2 + fullName: Microsoft.Xna.Framework.Vector2 +- uid: Microsoft.Xna.Framework.Vector3 + commentId: T:Microsoft.Xna.Framework.Vector3 + parent: Microsoft.Xna.Framework + isExternal: true + name: Vector3 + nameWithType: Vector3 + fullName: Microsoft.Xna.Framework.Vector3 +- uid: Microsoft.Xna.Framework.Vector4 + commentId: T:Microsoft.Xna.Framework.Vector4 + parent: Microsoft.Xna.Framework + isExternal: true + name: Vector4 + nameWithType: Vector4 + fullName: Microsoft.Xna.Framework.Vector4 +- uid: Microsoft.Xna.Framework.Point + commentId: T:Microsoft.Xna.Framework.Point + parent: Microsoft.Xna.Framework + isExternal: true + name: Point + nameWithType: Point + fullName: Microsoft.Xna.Framework.Point +- uid: Microsoft.Xna.Framework.Rectangle + commentId: T:Microsoft.Xna.Framework.Rectangle + parent: Microsoft.Xna.Framework + isExternal: true + name: Rectangle + nameWithType: Rectangle + fullName: Microsoft.Xna.Framework.Rectangle +- uid: MLEM.Misc.RectangleF + commentId: T:MLEM.Misc.RectangleF + parent: MLEM.Misc + name: RectangleF + nameWithType: RectangleF + fullName: MLEM.Misc.RectangleF - uid: MLEM.Extensions commentId: N:MLEM.Extensions name: MLEM.Extensions @@ -1144,6 +1179,17 @@ references: name: System nameWithType: System fullName: System +- uid: Microsoft.Xna.Framework + commentId: N:Microsoft.Xna.Framework + isExternal: true + name: Microsoft.Xna.Framework + nameWithType: Microsoft.Xna.Framework + fullName: Microsoft.Xna.Framework +- uid: MLEM.Misc + commentId: N:MLEM.Misc + name: MLEM.Misc + nameWithType: MLEM.Misc + fullName: MLEM.Misc - uid: System.Math.Floor(System.Decimal) commentId: M:System.Math.Floor(System.Decimal) isExternal: true @@ -1152,13 +1198,6 @@ references: name: Floor nameWithType: NumberExtensions.Floor fullName: MLEM.Extensions.NumberExtensions.Floor -- uid: System.Single - commentId: T:System.Single - parent: System - isExternal: true - name: Single - nameWithType: Single - fullName: System.Single - uid: System.Int32 commentId: T:System.Int32 parent: System @@ -1189,45 +1228,11 @@ references: - uid: MLEM.Extensions.NumberExtensions.Equals(System.Single,System.Single,System.Single) commentId: M:MLEM.Extensions.NumberExtensions.Equals(System.Single,System.Single,System.Single) isExternal: true -- uid: Microsoft.Xna.Framework.Vector2 - commentId: T:Microsoft.Xna.Framework.Vector2 - parent: Microsoft.Xna.Framework - isExternal: true - name: Vector2 - nameWithType: Vector2 - fullName: Microsoft.Xna.Framework.Vector2 -- uid: Microsoft.Xna.Framework - commentId: N:Microsoft.Xna.Framework - isExternal: true - name: Microsoft.Xna.Framework - nameWithType: Microsoft.Xna.Framework - fullName: Microsoft.Xna.Framework -- uid: Microsoft.Xna.Framework.Vector3 - commentId: T:Microsoft.Xna.Framework.Vector3 - parent: Microsoft.Xna.Framework - isExternal: true - name: Vector3 - nameWithType: Vector3 - fullName: Microsoft.Xna.Framework.Vector3 -- uid: Microsoft.Xna.Framework.Vector4 - commentId: T:Microsoft.Xna.Framework.Vector4 - parent: Microsoft.Xna.Framework - isExternal: true - name: Vector4 - nameWithType: Vector4 - fullName: Microsoft.Xna.Framework.Vector4 - uid: MLEM.Extensions.NumberExtensions.Multiply* commentId: Overload:MLEM.Extensions.NumberExtensions.Multiply name: Multiply nameWithType: NumberExtensions.Multiply fullName: MLEM.Extensions.NumberExtensions.Multiply -- uid: Microsoft.Xna.Framework.Point - commentId: T:Microsoft.Xna.Framework.Point - parent: Microsoft.Xna.Framework - isExternal: true - name: Point - nameWithType: Point - fullName: Microsoft.Xna.Framework.Point - uid: MLEM.Extensions.NumberExtensions.Divide* commentId: Overload:MLEM.Extensions.NumberExtensions.Divide name: Divide @@ -1250,27 +1255,9 @@ references: name: OffsetCopy nameWithType: NumberExtensions.OffsetCopy fullName: MLEM.Extensions.NumberExtensions.OffsetCopy -- uid: Microsoft.Xna.Framework.Rectangle - commentId: T:Microsoft.Xna.Framework.Rectangle - parent: Microsoft.Xna.Framework - isExternal: true - name: Rectangle - nameWithType: Rectangle - fullName: Microsoft.Xna.Framework.Rectangle - uid: MLEM.Extensions.NumberExtensions.OffsetCopy(Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Point) commentId: M:MLEM.Extensions.NumberExtensions.OffsetCopy(Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Point) isExternal: true -- uid: MLEM.Misc.RectangleF - commentId: T:MLEM.Misc.RectangleF - parent: MLEM.Misc - name: RectangleF - nameWithType: RectangleF - fullName: MLEM.Misc.RectangleF -- uid: MLEM.Misc - commentId: N:MLEM.Misc - name: MLEM.Misc - nameWithType: MLEM.Misc - fullName: MLEM.Misc - uid: MLEM.Extensions.NumberExtensions.Shrink* commentId: Overload:MLEM.Extensions.NumberExtensions.Shrink name: Shrink diff --git a/Docs/api/MLEM.Extensions.RandomExtensions.yml b/Docs/api/MLEM.Extensions.RandomExtensions.yml index 0c03c33..a4ae323 100644 --- a/Docs/api/MLEM.Extensions.RandomExtensions.yml +++ b/Docs/api/MLEM.Extensions.RandomExtensions.yml @@ -22,10 +22,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RandomExtensions path: ../MLEM/Extensions/RandomExtensions.cs - startLine: 5 + startLine: 8 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nA set of extensions for dealing with \n" + example: [] syntax: content: public static class RandomExtensions content.vb: Public Module RandomExtensions @@ -65,7 +67,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetRandomEntry path: ../MLEM/Extensions/RandomExtensions.cs - startLine: 14 + startLine: 17 assemblies: - MLEM namespace: MLEM.Extensions @@ -119,26 +121,22 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetRandomEntry path: ../MLEM/Extensions/RandomExtensions.cs - startLine: 19 + startLine: 22 assemblies: - MLEM namespace: MLEM.Extensions - summary: "\nGets a random entry from the given list with uniform chance.\n" example: [] syntax: content: public static T GetRandomEntry(this Random random, IList entries) parameters: - id: random type: System.Random - description: The random - id: entries type: System.Collections.Generic.IList{{T}} typeParameters: - id: T - description: The entries' type return: type: '{T}' - description: A random entry content.vb: >- @@ -172,7 +170,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetRandomWeightedEntry path: ../MLEM/Extensions/RandomExtensions.cs - startLine: 33 + startLine: 36 assemblies: - MLEM namespace: MLEM.Extensions @@ -215,6 +213,13 @@ items: fullName.vb: MLEM.Extensions.RandomExtensions.GetRandomWeightedEntry(Of T)(System.Random, System.Collections.Generic.IList(Of T), System.Func(Of T, System.Int32)) name.vb: GetRandomWeightedEntry(Of T)(Random, IList(Of T), Func(Of T, Int32)) references: +- uid: System.Random + commentId: T:System.Random + parent: System + isExternal: true + name: Random + nameWithType: Random + fullName: System.Random - uid: MLEM.Extensions commentId: N:MLEM.Extensions name: MLEM.Extensions @@ -517,13 +522,6 @@ references: name: GetRandomEntry nameWithType: RandomExtensions.GetRandomEntry fullName: MLEM.Extensions.RandomExtensions.GetRandomEntry -- uid: System.Random - commentId: T:System.Random - parent: System - isExternal: true - name: Random - nameWithType: Random - fullName: System.Random - uid: '{T}[]' isExternal: true name: T[] diff --git a/Docs/api/MLEM.Extensions.SoundExtensions.yml b/Docs/api/MLEM.Extensions.SoundExtensions.yml index bc8064a..8305c10 100644 --- a/Docs/api/MLEM.Extensions.SoundExtensions.yml +++ b/Docs/api/MLEM.Extensions.SoundExtensions.yml @@ -20,10 +20,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: SoundExtensions path: ../MLEM/Extensions/SoundExtensions.cs - startLine: 4 + startLine: 7 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nA set of extensions for dealing wiht \n" + example: [] syntax: content: public static class SoundExtensions content.vb: Public Module SoundExtensions @@ -63,10 +65,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Replay path: ../MLEM/Extensions/SoundExtensions.cs - startLine: 6 + startLine: 13 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nStops and plays a sound effect instance in one call\n" + example: [] syntax: content: >- [Obsolete("When using the .NET Core version of MonoGame, the replay issue has been fixed. Just call Play() instead.")] @@ -75,6 +79,7 @@ items: parameters: - id: sound type: Microsoft.Xna.Framework.Audio.SoundEffectInstance + description: The sound to stop and play content.vb: >- @@ -95,6 +100,13 @@ items: - Public - Shared references: +- uid: Microsoft.Xna.Framework.Audio.SoundEffectInstance + commentId: T:Microsoft.Xna.Framework.Audio.SoundEffectInstance + parent: Microsoft.Xna.Framework.Audio + isExternal: true + name: SoundEffectInstance + nameWithType: SoundEffectInstance + fullName: Microsoft.Xna.Framework.Audio.SoundEffectInstance - uid: MLEM.Extensions commentId: N:MLEM.Extensions name: MLEM.Extensions @@ -386,6 +398,12 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework.Audio + commentId: N:Microsoft.Xna.Framework.Audio + isExternal: true + name: Microsoft.Xna.Framework.Audio + nameWithType: Microsoft.Xna.Framework.Audio + fullName: Microsoft.Xna.Framework.Audio - uid: System commentId: N:System isExternal: true @@ -397,16 +415,3 @@ references: name: Replay nameWithType: SoundExtensions.Replay fullName: MLEM.Extensions.SoundExtensions.Replay -- uid: Microsoft.Xna.Framework.Audio.SoundEffectInstance - commentId: T:Microsoft.Xna.Framework.Audio.SoundEffectInstance - parent: Microsoft.Xna.Framework.Audio - isExternal: true - name: SoundEffectInstance - nameWithType: SoundEffectInstance - fullName: Microsoft.Xna.Framework.Audio.SoundEffectInstance -- uid: Microsoft.Xna.Framework.Audio - commentId: N:Microsoft.Xna.Framework.Audio - isExternal: true - name: Microsoft.Xna.Framework.Audio - nameWithType: Microsoft.Xna.Framework.Audio - fullName: Microsoft.Xna.Framework.Audio diff --git a/Docs/api/MLEM.Extensions.SpriteBatchExtensions.yml b/Docs/api/MLEM.Extensions.SpriteBatchExtensions.yml index f66dd43..3bc88be 100644 --- a/Docs/api/MLEM.Extensions.SpriteBatchExtensions.yml +++ b/Docs/api/MLEM.Extensions.SpriteBatchExtensions.yml @@ -24,10 +24,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: SpriteBatchExtensions path: ../MLEM/Extensions/SpriteBatchExtensions.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Extensions + summary: "\nA set of extensions for dealing with \n" + example: [] syntax: content: public static class SpriteBatchExtensions content.vb: Public Module SpriteBatchExtensions @@ -67,7 +69,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetBlankTexture path: ../MLEM/Extensions/SpriteBatchExtensions.cs - startLine: 16 + startLine: 19 assemblies: - MLEM namespace: MLEM.Extensions @@ -112,7 +114,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: GenerateTexture path: ../MLEM/Extensions/SpriteBatchExtensions.cs - startLine: 37 + startLine: 40 assemblies: - MLEM namespace: MLEM.Extensions @@ -166,7 +168,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Extensions/SpriteBatchExtensions.cs - startLine: 55 + startLine: 58 assemblies: - MLEM namespace: MLEM.Extensions @@ -225,7 +227,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Extensions/SpriteBatchExtensions.cs - startLine: 62 + startLine: 65 assemblies: - MLEM namespace: MLEM.Extensions @@ -276,7 +278,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Extensions/SpriteBatchExtensions.cs - startLine: 67 + startLine: 70 assemblies: - MLEM namespace: MLEM.Extensions @@ -304,6 +306,13 @@ items: - Public - Shared references: +- uid: Microsoft.Xna.Framework.Graphics.SpriteBatch + commentId: T:Microsoft.Xna.Framework.Graphics.SpriteBatch + parent: Microsoft.Xna.Framework.Graphics + isExternal: true + name: SpriteBatch + nameWithType: SpriteBatch + fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch - uid: MLEM.Extensions commentId: N:MLEM.Extensions name: MLEM.Extensions @@ -595,6 +604,12 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework.Graphics + commentId: N:Microsoft.Xna.Framework.Graphics + isExternal: true + name: Microsoft.Xna.Framework.Graphics + nameWithType: Microsoft.Xna.Framework.Graphics + fullName: Microsoft.Xna.Framework.Graphics - uid: System commentId: N:System isExternal: true @@ -606,13 +621,6 @@ references: name: GetBlankTexture nameWithType: SpriteBatchExtensions.GetBlankTexture fullName: MLEM.Extensions.SpriteBatchExtensions.GetBlankTexture -- uid: Microsoft.Xna.Framework.Graphics.SpriteBatch - commentId: T:Microsoft.Xna.Framework.Graphics.SpriteBatch - parent: Microsoft.Xna.Framework.Graphics - isExternal: true - name: SpriteBatch - nameWithType: SpriteBatch - fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch - uid: Microsoft.Xna.Framework.Graphics.Texture2D commentId: T:Microsoft.Xna.Framework.Graphics.Texture2D parent: Microsoft.Xna.Framework.Graphics @@ -620,12 +628,6 @@ references: name: Texture2D nameWithType: Texture2D fullName: Microsoft.Xna.Framework.Graphics.Texture2D -- uid: Microsoft.Xna.Framework.Graphics - commentId: N:Microsoft.Xna.Framework.Graphics - isExternal: true - name: Microsoft.Xna.Framework.Graphics - nameWithType: Microsoft.Xna.Framework.Graphics - fullName: Microsoft.Xna.Framework.Graphics - uid: MLEM.Textures.NinePatch commentId: T:MLEM.Textures.NinePatch parent: MLEM.Textures diff --git a/Docs/api/MLEM.Font.GenericFont.yml b/Docs/api/MLEM.Font.GenericFont.yml index 42b55e6..b2364ac 100644 --- a/Docs/api/MLEM.Font.GenericFont.yml +++ b/Docs/api/MLEM.Font.GenericFont.yml @@ -622,7 +622,6 @@ items: assemblies: - MLEM namespace: MLEM.Font - summary: "\nDraws a string with the given text alignment.\n" example: [] syntax: content: public void DrawString(SpriteBatch batch, string text, Vector2 position, TextAlign align, Color color, float rotation, Vector2 origin, float scale, SpriteEffects effects, float layerDepth) @@ -675,7 +674,6 @@ items: assemblies: - MLEM namespace: MLEM.Font - summary: "\nDraws a string with the given text alignment.\n" example: [] syntax: content: public void DrawString(SpriteBatch batch, string text, Vector2 position, TextAlign align, Color color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth) diff --git a/Docs/api/MLEM.Font.GenericSpriteFont.yml b/Docs/api/MLEM.Font.GenericSpriteFont.yml index 5c6f199..4b342a3 100644 --- a/Docs/api/MLEM.Font.GenericSpriteFont.yml +++ b/Docs/api/MLEM.Font.GenericSpriteFont.yml @@ -36,12 +36,12 @@ items: assemblies: - MLEM namespace: MLEM.Font - summary: "\nRepresents a font with additional abilities.\n\n" example: [] syntax: content: 'public class GenericSpriteFont : GenericFont' content.vb: >- Public Class GenericSpriteFont + Inherits GenericFont inheritance: - System.Object @@ -86,10 +86,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Font path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 10 + startLine: 13 assemblies: - MLEM namespace: MLEM.Font + summary: "\nThe that is being wrapped by this generic font\n" + example: [] syntax: content: public readonly SpriteFont Font return: @@ -119,11 +121,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: Bold path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 12 + startLine: 15 assemblies: - MLEM namespace: MLEM.Font - summary: "\nThe bold version of this font.\n" example: [] syntax: content: public override GenericFont Bold { get; } @@ -159,11 +160,10 @@ items: repo: https://github.com/Ellpeck/MLEM id: Italic path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 14 + startLine: 17 assemblies: - MLEM namespace: MLEM.Font - summary: "\nThe italic version of this font.\n" example: [] syntax: content: public override GenericFont Italic { get; } @@ -199,7 +199,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: LineHeight path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 16 + startLine: 19 assemblies: - MLEM namespace: MLEM.Font @@ -238,7 +238,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 25 + startLine: 28 assemblies: - MLEM namespace: MLEM.Font @@ -280,7 +280,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: MeasureString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 32 + startLine: 35 assemblies: - MLEM namespace: MLEM.Font @@ -319,7 +319,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: MeasureString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 37 + startLine: 40 assemblies: - MLEM namespace: MLEM.Font @@ -358,7 +358,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 42 + startLine: 45 assemblies: - MLEM namespace: MLEM.Font @@ -401,7 +401,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 47 + startLine: 50 assemblies: - MLEM namespace: MLEM.Font @@ -454,7 +454,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 52 + startLine: 55 assemblies: - MLEM namespace: MLEM.Font @@ -507,7 +507,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 57 + startLine: 60 assemblies: - MLEM namespace: MLEM.Font @@ -550,7 +550,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 62 + startLine: 65 assemblies: - MLEM namespace: MLEM.Font @@ -603,7 +603,7 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawString path: ../MLEM/Font/GenericSpriteFont.cs - startLine: 67 + startLine: 70 assemblies: - MLEM namespace: MLEM.Font diff --git a/Docs/api/MLEM.Font.TextAlign.yml b/Docs/api/MLEM.Font.TextAlign.yml index 368cfd9..638b3d1 100644 --- a/Docs/api/MLEM.Font.TextAlign.yml +++ b/Docs/api/MLEM.Font.TextAlign.yml @@ -23,10 +23,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: TextAlign path: ../MLEM/Font/GenericFont.cs - startLine: 173 + startLine: 176 assemblies: - MLEM namespace: MLEM.Font + summary: "\nAn enum that represents the text alignment options for \n" + example: [] syntax: content: public enum TextAlign content.vb: Public Enum TextAlign @@ -54,10 +56,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Left path: ../MLEM/Font/GenericFont.cs - startLine: 175 + startLine: 181 assemblies: - MLEM namespace: MLEM.Font + summary: "\nThe text is aligned as normal\n" + example: [] syntax: content: Left = 0 return: @@ -86,10 +90,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Center path: ../MLEM/Font/GenericFont.cs - startLine: 176 + startLine: 185 assemblies: - MLEM namespace: MLEM.Font + summary: "\nThe position passed represents the center of the resulting string in the x axis\n" + example: [] syntax: content: Center = 1 return: @@ -118,10 +124,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Right path: ../MLEM/Font/GenericFont.cs - startLine: 177 + startLine: 189 assemblies: - MLEM namespace: MLEM.Font + summary: "\nThe position passed represents the right edge of the resulting string\n" + example: [] syntax: content: Right = 2 return: @@ -150,10 +158,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: CenterBothAxes path: ../MLEM/Font/GenericFont.cs - startLine: 178 + startLine: 193 assemblies: - MLEM namespace: MLEM.Font + summary: "\nThe position passed represents the center of the resulting string, both in the x and y axes\n" + example: [] syntax: content: CenterBothAxes = 3 return: @@ -165,11 +175,118 @@ items: - Public - Const references: +- uid: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,MLEM.Font.TextAlign,Microsoft.Xna.Framework.Color) + commentId: M:MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,MLEM.Font.TextAlign,Microsoft.Xna.Framework.Color) + parent: MLEM.Font.GenericFont + isExternal: true + name: DrawString(SpriteBatch, String, Vector2, TextAlign, Color) + nameWithType: GenericFont.DrawString(SpriteBatch, String, Vector2, TextAlign, Color) + fullName: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch, System.String, Microsoft.Xna.Framework.Vector2, MLEM.Font.TextAlign, Microsoft.Xna.Framework.Color) + spec.csharp: + - uid: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,MLEM.Font.TextAlign,Microsoft.Xna.Framework.Color) + name: DrawString + nameWithType: GenericFont.DrawString + fullName: MLEM.Font.GenericFont.DrawString + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.Graphics.SpriteBatch + name: SpriteBatch + nameWithType: SpriteBatch + fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Vector2 + name: Vector2 + nameWithType: Vector2 + fullName: Microsoft.Xna.Framework.Vector2 + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Font.TextAlign + name: TextAlign + nameWithType: TextAlign + fullName: MLEM.Font.TextAlign + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Color + name: Color + nameWithType: Color + fullName: Microsoft.Xna.Framework.Color + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,MLEM.Font.TextAlign,Microsoft.Xna.Framework.Color) + name: DrawString + nameWithType: GenericFont.DrawString + fullName: MLEM.Font.GenericFont.DrawString + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.Graphics.SpriteBatch + name: SpriteBatch + nameWithType: SpriteBatch + fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Vector2 + name: Vector2 + nameWithType: Vector2 + fullName: Microsoft.Xna.Framework.Vector2 + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Font.TextAlign + name: TextAlign + nameWithType: TextAlign + fullName: MLEM.Font.TextAlign + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Color + name: Color + nameWithType: Color + fullName: Microsoft.Xna.Framework.Color + isExternal: true + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Font commentId: N:MLEM.Font name: MLEM.Font nameWithType: MLEM.Font fullName: MLEM.Font +- uid: MLEM.Font.GenericFont + commentId: T:MLEM.Font.GenericFont + parent: MLEM.Font + name: GenericFont + nameWithType: GenericFont + fullName: MLEM.Font.GenericFont - uid: MLEM.Font.TextAlign commentId: T:MLEM.Font.TextAlign parent: MLEM.Font diff --git a/Docs/api/MLEM.Formatting.Codes.AnimatedCode.yml b/Docs/api/MLEM.Formatting.Codes.AnimatedCode.yml index 76ee446..730f492 100644 --- a/Docs/api/MLEM.Formatting.Codes.AnimatedCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.AnimatedCode.yml @@ -21,14 +21,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: AnimatedCode path: ../MLEM/Formatting/Codes/AnimatedCode.cs - startLine: 3 + startLine: 4 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class AnimatedCode : Code' content.vb: >- Public Class AnimatedCode + Inherits Code inheritance: - System.Object @@ -80,10 +82,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/AnimatedCode.cs - startLine: 5 + startLine: 7 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public AnimatedCode(Match match, Regex regex) parameters: @@ -115,10 +118,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: EndsHere path: ../MLEM/Formatting/Codes/AnimatedCode.cs - startLine: 8 + startLine: 11 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override bool EndsHere(Code other) parameters: diff --git a/Docs/api/MLEM.Formatting.Codes.Code.Constructor.yml b/Docs/api/MLEM.Formatting.Codes.Code.Constructor.yml index 8058a1f..024bc5c 100644 --- a/Docs/api/MLEM.Formatting.Codes.Code.Constructor.yml +++ b/Docs/api/MLEM.Formatting.Codes.Code.Constructor.yml @@ -19,19 +19,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: Constructor path: ../MLEM/Formatting/Codes/Code.cs - startLine: 44 + startLine: 89 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nCreates a new formatting code from the given regex and regex match.\n\n" + example: [] syntax: content: public delegate Code Constructor(TextFormatter formatter, Match match, Regex regex); parameters: - id: formatter type: MLEM.Formatting.TextFormatter + description: The text formatter that created this code - id: match type: System.Text.RegularExpressions.Match + description: The match for the code's regex - id: regex type: System.Text.RegularExpressions.Regex + description: The regex used to create this code return: type: MLEM.Formatting.Codes.Code content.vb: Public Delegate Function Constructor(formatter As TextFormatter, match As Match, regex As Regex) As Code @@ -42,6 +47,9 @@ items: - Public - Delegate references: +- uid: MLEM.Formatting.TextFormatter.Codes + commentId: F:MLEM.Formatting.TextFormatter.Codes + isExternal: true - uid: MLEM.Formatting.Codes commentId: N:MLEM.Formatting.Codes name: MLEM.Formatting.Codes diff --git a/Docs/api/MLEM.Formatting.Codes.Code.yml b/Docs/api/MLEM.Formatting.Codes.Code.yml index e8696ba..2b97345 100644 --- a/Docs/api/MLEM.Formatting.Codes.Code.yml +++ b/Docs/api/MLEM.Formatting.Codes.Code.yml @@ -30,14 +30,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: Code path: ../MLEM/Formatting/Codes/Code.cs - startLine: 7 + startLine: 11 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nAn instance of a formatting code that can be used for a .\nTo add a new formatting code, see \n" + example: [] syntax: content: 'public class Code : GenericDataHolder' content.vb: >- Public Class Code + Inherits GenericDataHolder inheritance: - System.Object @@ -82,10 +85,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Regex path: ../MLEM/Formatting/Codes/Code.cs - startLine: 9 + startLine: 16 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nThe regex that this code was created from\n" + example: [] syntax: content: public readonly Regex Regex return: @@ -115,10 +120,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Match path: ../MLEM/Formatting/Codes/Code.cs - startLine: 10 + startLine: 20 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nThe match that this code encompasses\n" + example: [] syntax: content: public readonly Match Match return: @@ -148,10 +155,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Token path: ../MLEM/Formatting/Codes/Code.cs - startLine: 11 + startLine: 24 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nThe token that this formatting code is a part of\n" + example: [] syntax: content: public Token Token { get; } parameters: [] @@ -183,17 +192,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/Code.cs - startLine: 13 + startLine: 31 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nCreates a new formatting code based on a formatting code regex and its match.\n" + example: [] syntax: content: protected Code(Match match, Regex regex) parameters: - id: match type: System.Text.RegularExpressions.Match + description: The match - id: regex type: System.Text.RegularExpressions.Regex + description: The regex content.vb: Protected Sub New(match As Match, regex As Regex) overload: MLEM.Formatting.Codes.Code.#ctor* modifiers.csharp: @@ -218,17 +231,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: EndsHere path: ../MLEM/Formatting/Codes/Code.cs - startLine: 18 + startLine: 42 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nReturns whether this formatting code should end when the passed formatting code starts.\nIf this method returns true, a new is started at its position.\n" + example: [] syntax: content: public virtual bool EndsHere(Code other) parameters: - id: other type: MLEM.Formatting.Codes.Code + description: The code that is started here return: type: System.Boolean + description: If this code should end content.vb: Public Overridable Function EndsHere(other As Code) As Boolean overload: MLEM.Formatting.Codes.Code.EndsHere* modifiers.csharp: @@ -255,10 +272,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetColor path: ../MLEM/Formatting/Codes/Code.cs - startLine: 22 + startLine: 47 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public virtual Color? GetColor(Color defaultPick) parameters: @@ -292,10 +310,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFont path: ../MLEM/Formatting/Codes/Code.cs - startLine: 26 + startLine: 52 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public virtual GenericFont GetFont(GenericFont defaultPick) parameters: @@ -329,15 +348,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: Update path: ../MLEM/Formatting/Codes/Code.cs - startLine: 30 + startLine: 60 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nUpdate this formatting code's animations etc.\n" + example: [] syntax: content: public virtual void Update(GameTime time) parameters: - id: time type: Microsoft.Xna.Framework.GameTime + description: The game's time content.vb: Public Overridable Sub Update(time As GameTime) overload: MLEM.Formatting.Codes.Code.Update* modifiers.csharp: @@ -364,17 +386,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetReplacementString path: ../MLEM/Formatting/Codes/Code.cs - startLine: 33 + startLine: 69 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nReturns the string that this formatting code should be replaced with.\nUsually, you'll just want an empty string here, but some formatting codes (like ) require their space to be filled by spaces.\n" + example: [] syntax: content: public virtual string GetReplacementString(GenericFont font) parameters: - id: font type: MLEM.Font.GenericFont + description: The font that is used return: type: System.String + description: The replacement string for this formatting code content.vb: Public Overridable Function GetReplacementString(font As GenericFont) As String overload: MLEM.Formatting.Codes.Code.GetReplacementString* modifiers.csharp: @@ -401,10 +427,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawCharacter path: ../MLEM/Formatting/Codes/Code.cs - startLine: 37 + startLine: 74 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public virtual bool DrawCharacter(GameTime time, SpriteBatch batch, char c, string cString, int indexInToken, ref Vector2 pos, GenericFont font, ref Color color, ref float scale, float depth) parameters: @@ -459,10 +486,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawSelf path: ../MLEM/Formatting/Codes/Code.cs - startLine: 41 + startLine: 79 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public virtual void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) parameters: @@ -489,6 +517,15 @@ items: - Public - Overridable references: +- uid: MLEM.Formatting.TextFormatter + commentId: T:MLEM.Formatting.TextFormatter + parent: MLEM.Formatting + name: TextFormatter + nameWithType: TextFormatter + fullName: MLEM.Formatting.TextFormatter +- uid: MLEM.Formatting.TextFormatter.Codes + commentId: F:MLEM.Formatting.TextFormatter.Codes + isExternal: true - uid: MLEM.Formatting.Codes commentId: N:MLEM.Formatting.Codes name: MLEM.Formatting.Codes @@ -911,6 +948,11 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: MLEM.Formatting + commentId: N:MLEM.Formatting + name: MLEM.Formatting + nameWithType: MLEM.Formatting + fullName: MLEM.Formatting - uid: System commentId: N:System isExternal: true @@ -953,16 +995,17 @@ references: name: Token nameWithType: Token fullName: MLEM.Formatting.Token -- uid: MLEM.Formatting - commentId: N:MLEM.Formatting - name: MLEM.Formatting - nameWithType: MLEM.Formatting - fullName: MLEM.Formatting - uid: MLEM.Formatting.Codes.Code.#ctor* commentId: Overload:MLEM.Formatting.Codes.Code.#ctor name: Code nameWithType: Code.Code fullName: MLEM.Formatting.Codes.Code.Code +- uid: MLEM.Formatting.Codes.Code.Token + commentId: P:MLEM.Formatting.Codes.Code.Token + parent: MLEM.Formatting.Codes.Code + name: Token + nameWithType: Code.Token + fullName: MLEM.Formatting.Codes.Code.Token - uid: MLEM.Formatting.Codes.Code.EndsHere* commentId: Overload:MLEM.Formatting.Codes.Code.EndsHere name: EndsHere @@ -981,6 +1024,9 @@ references: name: Boolean nameWithType: Boolean fullName: System.Boolean +- uid: MLEM.Formatting.Token.GetColor(Microsoft.Xna.Framework.Color) + commentId: M:MLEM.Formatting.Token.GetColor(Microsoft.Xna.Framework.Color) + isExternal: true - uid: MLEM.Formatting.Codes.Code.GetColor* commentId: Overload:MLEM.Formatting.Codes.Code.GetColor name: GetColor @@ -1082,6 +1128,9 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: MLEM.Formatting.Token.GetFont(MLEM.Font.GenericFont) + commentId: M:MLEM.Formatting.Token.GetFont(MLEM.Font.GenericFont) + isExternal: true - uid: MLEM.Formatting.Codes.Code.GetFont* commentId: Overload:MLEM.Formatting.Codes.Code.GetFont name: GetFont @@ -1110,6 +1159,11 @@ references: name: GameTime nameWithType: GameTime fullName: Microsoft.Xna.Framework.GameTime +- uid: MLEM.Formatting.Codes.ImageCode + commentId: T:MLEM.Formatting.Codes.ImageCode + name: ImageCode + nameWithType: ImageCode + fullName: MLEM.Formatting.Codes.ImageCode - uid: MLEM.Formatting.Codes.Code.GetReplacementString* commentId: Overload:MLEM.Formatting.Codes.Code.GetReplacementString name: GetReplacementString @@ -1122,6 +1176,9 @@ references: name: String nameWithType: String fullName: System.String +- uid: MLEM.Formatting.Token.DrawCharacter(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,System.Char,System.String,System.Int32,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) + commentId: M:MLEM.Formatting.Token.DrawCharacter(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,System.Char,System.String,System.Int32,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) + isExternal: true - uid: MLEM.Formatting.Codes.Code.DrawCharacter* commentId: Overload:MLEM.Formatting.Codes.Code.DrawCharacter name: DrawCharacter @@ -1168,6 +1225,9 @@ references: name: Microsoft.Xna.Framework.Graphics nameWithType: Microsoft.Xna.Framework.Graphics fullName: Microsoft.Xna.Framework.Graphics +- uid: MLEM.Formatting.Token.DrawSelf(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) + commentId: M:MLEM.Formatting.Token.DrawSelf(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) + isExternal: true - uid: MLEM.Formatting.Codes.Code.DrawSelf* commentId: Overload:MLEM.Formatting.Codes.Code.DrawSelf name: DrawSelf diff --git a/Docs/api/MLEM.Formatting.Codes.ColorCode.yml b/Docs/api/MLEM.Formatting.Codes.ColorCode.yml index f399c10..0eddc93 100644 --- a/Docs/api/MLEM.Formatting.Codes.ColorCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.ColorCode.yml @@ -21,14 +21,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: ColorCode path: ../MLEM/Formatting/Codes/ColorCode.cs - startLine: 4 + startLine: 5 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class ColorCode : Code' content.vb: >- Public Class ColorCode + Inherits Code inheritance: - System.Object @@ -78,10 +80,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/ColorCode.cs - startLine: 8 + startLine: 10 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public ColorCode(Match match, Regex regex, Color? color) parameters: @@ -118,10 +121,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetColor path: ../MLEM/Formatting/Codes/ColorCode.cs - startLine: 12 + startLine: 15 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override Color? GetColor(Color defaultPick) parameters: diff --git a/Docs/api/MLEM.Formatting.Codes.FontCode.yml b/Docs/api/MLEM.Formatting.Codes.FontCode.yml index 8efea90..e71e8b9 100644 --- a/Docs/api/MLEM.Formatting.Codes.FontCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.FontCode.yml @@ -22,14 +22,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: FontCode path: ../MLEM/Formatting/Codes/FontCode.cs - startLine: 5 + startLine: 6 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class FontCode : Code' content.vb: >- Public Class FontCode + Inherits Code inheritance: - System.Object @@ -81,10 +83,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/FontCode.cs - startLine: 9 + startLine: 11 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public FontCode(Match match, Regex regex, Func font) parameters: @@ -121,10 +124,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFont path: ../MLEM/Formatting/Codes/FontCode.cs - startLine: 13 + startLine: 16 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override GenericFont GetFont(GenericFont defaultPick) parameters: @@ -159,10 +163,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: EndsHere path: ../MLEM/Formatting/Codes/FontCode.cs - startLine: 17 + startLine: 21 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override bool EndsHere(Code other) parameters: diff --git a/Docs/api/MLEM.Formatting.Codes.ImageCode.yml b/Docs/api/MLEM.Formatting.Codes.ImageCode.yml index 860d12f..e8a5376 100644 --- a/Docs/api/MLEM.Formatting.Codes.ImageCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.ImageCode.yml @@ -24,14 +24,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: ImageCode path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 11 + startLine: 12 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class ImageCode : Code' content.vb: >- Public Class ImageCode + Inherits Code inheritance: - System.Object @@ -78,10 +80,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 17 + startLine: 19 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public ImageCode(Match match, Regex regex, SpriteAnimation image) parameters: @@ -115,10 +118,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: EndsHere path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 21 + startLine: 24 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override bool EndsHere(Code other) parameters: @@ -153,10 +157,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetReplacementString path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 25 + startLine: 29 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override string GetReplacementString(GenericFont font) parameters: @@ -191,10 +196,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Update path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 35 + startLine: 40 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override void Update(GameTime time) parameters: @@ -227,10 +233,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawSelf path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 39 + startLine: 45 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) parameters: diff --git a/Docs/api/MLEM.Formatting.Codes.ImageCodeExtensions.yml b/Docs/api/MLEM.Formatting.Codes.ImageCodeExtensions.yml index 0c07f7e..01fb3f2 100644 --- a/Docs/api/MLEM.Formatting.Codes.ImageCodeExtensions.yml +++ b/Docs/api/MLEM.Formatting.Codes.ImageCodeExtensions.yml @@ -21,10 +21,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: ImageCodeExtensions path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 46 + startLine: 55 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nA set of extensions that allow easily adding image formatting codes to a text formatter.\n" + example: [] syntax: content: public static class ImageCodeExtensions content.vb: Public Module ImageCodeExtensions @@ -64,19 +66,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddImage path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 48 + startLine: 63 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nAdds a new image formatting code to the given text formatter\n" + example: [] syntax: content: public static void AddImage(this TextFormatter formatter, string name, TextureRegion image) parameters: - id: formatter type: MLEM.Formatting.TextFormatter + description: The formatter to add the code to - id: name type: System.String + description: The name of the formatting code. The regex for this code will be between angle brackets. - id: image type: MLEM.Textures.TextureRegion + description: The image to render at the code's position content.vb: >- @@ -107,10 +114,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddImage path: ../MLEM/Formatting/Codes/ImageCode.cs - startLine: 52 + startLine: 68 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public static void AddImage(this TextFormatter formatter, string name, SpriteAnimation image) parameters: @@ -463,6 +471,72 @@ references: name: MLEM.Textures nameWithType: MLEM.Textures fullName: MLEM.Textures +- uid: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion) + commentId: M:MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion) + isExternal: true + name: AddImage(TextFormatter, String, TextureRegion) + nameWithType: ImageCodeExtensions.AddImage(TextFormatter, String, TextureRegion) + fullName: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter, System.String, MLEM.Textures.TextureRegion) + spec.csharp: + - uid: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion) + name: AddImage + nameWithType: ImageCodeExtensions.AddImage + fullName: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage + - name: ( + nameWithType: ( + fullName: ( + - uid: MLEM.Formatting.TextFormatter + name: TextFormatter + nameWithType: TextFormatter + fullName: MLEM.Formatting.TextFormatter + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Textures.TextureRegion + name: TextureRegion + nameWithType: TextureRegion + fullName: MLEM.Textures.TextureRegion + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion) + name: AddImage + nameWithType: ImageCodeExtensions.AddImage + fullName: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage + - name: ( + nameWithType: ( + fullName: ( + - uid: MLEM.Formatting.TextFormatter + name: TextFormatter + nameWithType: TextFormatter + fullName: MLEM.Formatting.TextFormatter + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Textures.TextureRegion + name: TextureRegion + nameWithType: TextureRegion + fullName: MLEM.Textures.TextureRegion + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Animations.SpriteAnimation commentId: T:MLEM.Animations.SpriteAnimation parent: MLEM.Animations diff --git a/Docs/api/MLEM.Formatting.Codes.LinkCode.yml b/Docs/api/MLEM.Formatting.Codes.LinkCode.yml index 5e24b28..16cabb5 100644 --- a/Docs/api/MLEM.Formatting.Codes.LinkCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.LinkCode.yml @@ -22,14 +22,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: LinkCode path: ../MLEM/Formatting/Codes/LinkCode.cs - startLine: 7 + startLine: 8 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class LinkCode : UnderlineCode' content.vb: >- Public Class LinkCode + Inherits UnderlineCode inheritance: - System.Object @@ -81,10 +83,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/LinkCode.cs - startLine: 11 + startLine: 13 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public LinkCode(Match match, Regex regex, float thickness, float yOffset, Func isSelected) parameters: @@ -125,14 +128,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsSelected path: ../MLEM/Formatting/Codes/LinkCode.cs - startLine: 15 + startLine: 21 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nReturns true if this link formatting code is currently selected or hovered over, based on the selection function.\n" + example: [] syntax: content: public virtual bool IsSelected() return: type: System.Boolean + description: True if this code is currently selected content.vb: Public Overridable Function IsSelected As Boolean overload: MLEM.Formatting.Codes.LinkCode.IsSelected* modifiers.csharp: @@ -159,10 +165,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawCharacter path: ../MLEM/Formatting/Codes/LinkCode.cs - startLine: 19 + startLine: 26 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override bool DrawCharacter(GameTime time, SpriteBatch batch, char c, string cString, int indexInToken, ref Vector2 pos, GenericFont font, ref Color color, ref float scale, float depth) parameters: diff --git a/Docs/api/MLEM.Formatting.Codes.ShadowCode.yml b/Docs/api/MLEM.Formatting.Codes.ShadowCode.yml index 2590d22..ef59f95 100644 --- a/Docs/api/MLEM.Formatting.Codes.ShadowCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.ShadowCode.yml @@ -21,14 +21,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: ShadowCode path: ../MLEM/Formatting/Codes/ShadowCode.cs - startLine: 7 + startLine: 8 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class ShadowCode : FontCode' content.vb: >- Public Class ShadowCode + Inherits FontCode inheritance: - System.Object @@ -79,10 +81,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/ShadowCode.cs - startLine: 12 + startLine: 14 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public ShadowCode(Match match, Regex regex, Color color, Vector2 offset) parameters: @@ -118,10 +121,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawCharacter path: ../MLEM/Formatting/Codes/ShadowCode.cs - startLine: 17 + startLine: 20 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override bool DrawCharacter(GameTime time, SpriteBatch batch, char c, string cString, int indexInToken, ref Vector2 pos, GenericFont font, ref Color color, ref float scale, float depth) parameters: diff --git a/Docs/api/MLEM.Formatting.Codes.UnderlineCode.yml b/Docs/api/MLEM.Formatting.Codes.UnderlineCode.yml index cab6548..142839a 100644 --- a/Docs/api/MLEM.Formatting.Codes.UnderlineCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.UnderlineCode.yml @@ -21,14 +21,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: UnderlineCode path: ../MLEM/Formatting/Codes/UnderlineCode.cs - startLine: 8 + startLine: 9 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class UnderlineCode : FontCode' content.vb: >- Public Class UnderlineCode + Inherits FontCode inheritance: - System.Object @@ -81,10 +83,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/UnderlineCode.cs - startLine: 13 + startLine: 15 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public UnderlineCode(Match match, Regex regex, float thickness, float yOffset) parameters: @@ -120,10 +123,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawCharacter path: ../MLEM/Formatting/Codes/UnderlineCode.cs - startLine: 18 + startLine: 21 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override bool DrawCharacter(GameTime time, SpriteBatch batch, char c, string cString, int indexInToken, ref Vector2 pos, GenericFont font, ref Color color, ref float scale, float depth) parameters: diff --git a/Docs/api/MLEM.Formatting.Codes.WobblyCode.yml b/Docs/api/MLEM.Formatting.Codes.WobblyCode.yml index 1e192a1..10f8089 100644 --- a/Docs/api/MLEM.Formatting.Codes.WobblyCode.yml +++ b/Docs/api/MLEM.Formatting.Codes.WobblyCode.yml @@ -23,14 +23,16 @@ items: repo: https://github.com/Ellpeck/MLEM id: WobblyCode path: ../MLEM/Formatting/Codes/WobblyCode.cs - startLine: 7 + startLine: 8 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: 'public class WobblyCode : AnimatedCode' content.vb: >- Public Class WobblyCode + Inherits AnimatedCode inheritance: - System.Object @@ -80,10 +82,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: TimeIntoAnimation path: ../MLEM/Formatting/Codes/WobblyCode.cs - startLine: 11 + startLine: 16 assemblies: - MLEM namespace: MLEM.Formatting.Codes + summary: "\nThe time that this wobbly animation has been running for.\nTo reset its animation progress, reset this value.\n" + example: [] syntax: content: public TimeSpan TimeIntoAnimation return: @@ -111,10 +115,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/Codes/WobblyCode.cs - startLine: 13 + startLine: 19 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public WobblyCode(Match match, Regex regex, float modifier, float heightModifier) parameters: @@ -150,10 +155,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Update path: ../MLEM/Formatting/Codes/WobblyCode.cs - startLine: 18 + startLine: 25 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override void Update(GameTime time) parameters: @@ -186,10 +192,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawCharacter path: ../MLEM/Formatting/Codes/WobblyCode.cs - startLine: 22 + startLine: 30 assemblies: - MLEM namespace: MLEM.Formatting.Codes + example: [] syntax: content: public override bool DrawCharacter(GameTime time, SpriteBatch batch, char c, string cString, int indexInToken, ref Vector2 pos, GenericFont font, ref Color color, ref float scale, float depth) parameters: diff --git a/Docs/api/MLEM.Formatting.FormatSettings.yml b/Docs/api/MLEM.Formatting.FormatSettings.yml index e336ce7..43bf229 100644 --- a/Docs/api/MLEM.Formatting.FormatSettings.yml +++ b/Docs/api/MLEM.Formatting.FormatSettings.yml @@ -38,6 +38,7 @@ items: Public Class FormatSettings + Inherits GenericDataHolder inheritance: - System.Object diff --git a/Docs/api/MLEM.Formatting.FormattingCodeCollection.yml b/Docs/api/MLEM.Formatting.FormattingCodeCollection.yml index 5662ad5..19e9198 100644 --- a/Docs/api/MLEM.Formatting.FormattingCodeCollection.yml +++ b/Docs/api/MLEM.Formatting.FormattingCodeCollection.yml @@ -32,7 +32,9 @@ items: Public Class FormattingCodeCollection + Inherits Dictionary(Of Integer, List(Of FormattingCodeData)) + Implements IDictionary(Of Integer, List(Of FormattingCodeData)), ICollection(Of KeyValuePair(Of Integer, List(Of FormattingCodeData))), IReadOnlyDictionary(Of Integer, List(Of FormattingCodeData)), IReadOnlyCollection(Of KeyValuePair(Of Integer, List(Of FormattingCodeData))), IEnumerable(Of KeyValuePair(Of Integer, List(Of FormattingCodeData))), IDictionary, ICollection, IEnumerable, IDeserializationCallback, ISerializable inheritance: - System.Object diff --git a/Docs/api/MLEM.Formatting.FormattingCodeData.yml b/Docs/api/MLEM.Formatting.FormattingCodeData.yml index 38a64a1..2793062 100644 --- a/Docs/api/MLEM.Formatting.FormattingCodeData.yml +++ b/Docs/api/MLEM.Formatting.FormattingCodeData.yml @@ -36,6 +36,7 @@ items: Public Class FormattingCodeData + Inherits GenericDataHolder inheritance: - System.Object diff --git a/Docs/api/MLEM.Formatting.TextFormatter.yml b/Docs/api/MLEM.Formatting.TextFormatter.yml index 213dd3a..abb4e50 100644 --- a/Docs/api/MLEM.Formatting.TextFormatter.yml +++ b/Docs/api/MLEM.Formatting.TextFormatter.yml @@ -22,14 +22,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: TextFormatter path: ../MLEM/Formatting/TextFormatter.cs - startLine: 12 + startLine: 16 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nA text formatter is used for drawing text using that contains different colors, bold/italic sections and animations.\nTo format a string of text, use the codes as specified in the constructor. To tokenize and render a formatted string, use .\n" + example: [] syntax: content: 'public class TextFormatter : GenericDataHolder' content.vb: >- Public Class TextFormatter + Inherits GenericDataHolder inheritance: - System.Object @@ -72,10 +75,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Codes path: ../MLEM/Formatting/TextFormatter.cs - startLine: 14 + startLine: 22 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe formatting codes that this text formatter uses.\nThe defines how the formatting code should be matched.\n" + example: [] syntax: content: public readonly Dictionary Codes return: @@ -105,10 +110,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Formatting/TextFormatter.cs - startLine: 16 + startLine: 27 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nCreates a new text formatter with a set of default formatting codes.\n" + example: [] syntax: content: public TextFormatter() content.vb: Public Sub New @@ -135,19 +142,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: Tokenize path: ../MLEM/Formatting/TextFormatter.cs - startLine: 39 + startLine: 56 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nTokenizes a string, returning a tokenized string that is ready for splitting, measuring and drawing.\n" + example: [] syntax: content: public TokenizedString Tokenize(GenericFont font, string s) parameters: - id: font type: MLEM.Font.GenericFont + description: The font to use for tokenization. Note that this font needs to be the same that will later be used for splitting, measuring and/or drawing. - id: s type: System.String + description: The string to tokenize return: type: MLEM.Formatting.TokenizedString + description: '' content.vb: Public Function Tokenize(font As GenericFont, s As String) As TokenizedString overload: MLEM.Formatting.TextFormatter.Tokenize* modifiers.csharp: @@ -155,6 +167,15 @@ items: modifiers.vb: - Public references: +- uid: MLEM.Font.GenericFont + commentId: T:MLEM.Font.GenericFont + parent: MLEM.Font + name: GenericFont + nameWithType: GenericFont + fullName: MLEM.Font.GenericFont +- uid: MLEM.Formatting.TextFormatter.Tokenize(MLEM.Font.GenericFont,System.String) + commentId: M:MLEM.Formatting.TextFormatter.Tokenize(MLEM.Font.GenericFont,System.String) + isExternal: true - uid: MLEM.Formatting commentId: N:MLEM.Formatting name: MLEM.Formatting @@ -683,6 +704,11 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: MLEM.Font + commentId: N:MLEM.Font + name: MLEM.Font + nameWithType: MLEM.Font + fullName: MLEM.Font - uid: System commentId: N:System isExternal: true @@ -837,6 +863,13 @@ references: name: MLEM.Formatting.Codes nameWithType: MLEM.Formatting.Codes fullName: MLEM.Formatting.Codes +- uid: System.Text.RegularExpressions.Regex + commentId: T:System.Text.RegularExpressions.Regex + parent: System.Text.RegularExpressions + isExternal: true + name: Regex + nameWithType: Regex + fullName: System.Text.RegularExpressions.Regex - uid: System.Collections.Generic.Dictionary{System.Text.RegularExpressions.Regex,MLEM.Formatting.Codes.Code.Constructor} commentId: T:System.Collections.Generic.Dictionary{System.Text.RegularExpressions.Regex,MLEM.Formatting.Codes.Code.Constructor} parent: System.Collections.Generic @@ -895,6 +928,12 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: System.Text.RegularExpressions + commentId: N:System.Text.RegularExpressions + isExternal: true + name: System.Text.RegularExpressions + nameWithType: System.Text.RegularExpressions + fullName: System.Text.RegularExpressions - uid: System.Collections.Generic.Dictionary`2 commentId: T:System.Collections.Generic.Dictionary`2 isExternal: true @@ -962,12 +1001,6 @@ references: name: Tokenize nameWithType: TextFormatter.Tokenize fullName: MLEM.Formatting.TextFormatter.Tokenize -- uid: MLEM.Font.GenericFont - commentId: T:MLEM.Font.GenericFont - parent: MLEM.Font - name: GenericFont - nameWithType: GenericFont - fullName: MLEM.Font.GenericFont - uid: System.String commentId: T:System.String parent: System @@ -981,8 +1014,3 @@ references: name: TokenizedString nameWithType: TokenizedString fullName: MLEM.Formatting.TokenizedString -- uid: MLEM.Font - commentId: N:MLEM.Font - name: MLEM.Font - nameWithType: MLEM.Font - fullName: MLEM.Font diff --git a/Docs/api/MLEM.Formatting.Token.yml b/Docs/api/MLEM.Formatting.Token.yml index 63215f8..6b37b38 100644 --- a/Docs/api/MLEM.Formatting.Token.yml +++ b/Docs/api/MLEM.Formatting.Token.yml @@ -5,7 +5,6 @@ items: id: Token parent: MLEM.Formatting children: - - MLEM.Formatting.Token.#ctor(MLEM.Formatting.Codes.Code[],System.Int32,System.Int32,System.String,System.String) - MLEM.Formatting.Token.AppliedCodes - MLEM.Formatting.Token.DisplayString - MLEM.Formatting.Token.DrawCharacter(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,System.Char,System.String,System.Int32,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) @@ -31,14 +30,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: Token path: ../MLEM/Formatting/Token.cs - startLine: 10 + startLine: 13 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nA part of a that has a certain list of formatting codes applied.\n" + example: [] syntax: content: 'public class Token : GenericDataHolder' content.vb: >- Public Class Token + Inherits GenericDataHolder inheritance: - System.Object @@ -78,10 +80,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: AppliedCodes path: ../MLEM/Formatting/Token.cs - startLine: 12 + startLine: 18 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe formatting codes that are applied on this token.\n" + example: [] syntax: content: public readonly Code[] AppliedCodes return: @@ -111,10 +115,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Index path: ../MLEM/Formatting/Token.cs - startLine: 13 + startLine: 22 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe index in the that this token starts at.\n" + example: [] syntax: content: public readonly int Index return: @@ -144,10 +150,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RawIndex path: ../MLEM/Formatting/Token.cs - startLine: 14 + startLine: 26 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe index in the that this token starts at.\n" + example: [] syntax: content: public readonly int RawIndex return: @@ -177,10 +185,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Substring path: ../MLEM/Formatting/Token.cs - startLine: 15 + startLine: 30 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe substring that this token contains.\n" + example: [] syntax: content: public readonly string Substring return: @@ -210,10 +220,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DisplayString path: ../MLEM/Formatting/Token.cs - startLine: 16 + startLine: 34 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe string that is displayed by this token. If the tokenized string has been split, this string will contain the newline characters.\n" + example: [] syntax: content: public string DisplayString { get; } parameters: [] @@ -245,10 +257,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RawSubstring path: ../MLEM/Formatting/Token.cs - startLine: 17 + startLine: 38 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe substring that this token contains, without the formatting codes removed.\n" + example: [] syntax: content: public readonly string RawSubstring return: @@ -260,50 +274,6 @@ items: modifiers.vb: - Public - ReadOnly -- uid: MLEM.Formatting.Token.#ctor(MLEM.Formatting.Codes.Code[],System.Int32,System.Int32,System.String,System.String) - commentId: M:MLEM.Formatting.Token.#ctor(MLEM.Formatting.Codes.Code[],System.Int32,System.Int32,System.String,System.String) - id: '#ctor(MLEM.Formatting.Codes.Code[],System.Int32,System.Int32,System.String,System.String)' - parent: MLEM.Formatting.Token - langs: - - csharp - - vb - name: Token(Code[], Int32, Int32, String, String) - nameWithType: Token.Token(Code[], Int32, Int32, String, String) - fullName: MLEM.Formatting.Token.Token(MLEM.Formatting.Codes.Code[], System.Int32, System.Int32, System.String, System.String) - type: Constructor - source: - remote: - path: MLEM/Formatting/Token.cs - branch: master - repo: https://github.com/Ellpeck/MLEM - id: .ctor - path: ../MLEM/Formatting/Token.cs - startLine: 21 - assemblies: - - MLEM - namespace: MLEM.Formatting - syntax: - content: public Token(Code[] appliedCodes, int index, int rawIndex, string substring, string rawSubstring) - parameters: - - id: appliedCodes - type: MLEM.Formatting.Codes.Code[] - - id: index - type: System.Int32 - - id: rawIndex - type: System.Int32 - - id: substring - type: System.String - - id: rawSubstring - type: System.String - content.vb: Public Sub New(appliedCodes As Code(), index As Integer, rawIndex As Integer, substring As String, rawSubstring As String) - overload: MLEM.Formatting.Token.#ctor* - nameWithType.vb: Token.Token(Code(), Int32, Int32, String, String) - modifiers.csharp: - - public - modifiers.vb: - - Public - fullName.vb: MLEM.Formatting.Token.Token(MLEM.Formatting.Codes.Code(), System.Int32, System.Int32, System.String, System.String) - name.vb: Token(Code(), Int32, Int32, String, String) - uid: MLEM.Formatting.Token.GetColor(Microsoft.Xna.Framework.Color) commentId: M:MLEM.Formatting.Token.GetColor(Microsoft.Xna.Framework.Color) id: GetColor(Microsoft.Xna.Framework.Color) @@ -322,17 +292,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetColor path: ../MLEM/Formatting/Token.cs - startLine: 32 + startLine: 58 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nGet the color that this token will be rendered with\n" + example: [] syntax: content: public Color? GetColor(Color defaultPick) parameters: - id: defaultPick type: Microsoft.Xna.Framework.Color + description: The default color, if none is specified return: type: System.Nullable{Microsoft.Xna.Framework.Color} + description: The color to render with content.vb: Public Function GetColor(defaultPick As Color) As Color? overload: MLEM.Formatting.Token.GetColor* modifiers.csharp: @@ -357,17 +331,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetFont path: ../MLEM/Formatting/Token.cs - startLine: 36 + startLine: 67 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nGet the font that this token will be rendered with\n" + example: [] syntax: content: public GenericFont GetFont(GenericFont defaultPick) parameters: - id: defaultPick type: MLEM.Font.GenericFont + description: The default font, if none is specified return: type: MLEM.Font.GenericFont + description: The font to render with content.vb: Public Function GetFont(defaultPick As GenericFont) As GenericFont overload: MLEM.Formatting.Token.GetFont* modifiers.csharp: @@ -392,27 +370,36 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawSelf path: ../MLEM/Formatting/Token.cs - startLine: 40 + startLine: 82 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nDraws the token itself, including all of the instances that this token contains.\nNote that, to draw the token's actual string, is used.\n" + example: [] syntax: content: public void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) parameters: - id: time type: Microsoft.Xna.Framework.GameTime + description: The time - id: batch type: Microsoft.Xna.Framework.Graphics.SpriteBatch + description: The sprite batch to use - id: pos type: Microsoft.Xna.Framework.Vector2 + description: The position to draw the token at - id: font type: MLEM.Font.GenericFont + description: The font to use to draw - id: color type: Microsoft.Xna.Framework.Color + description: The color to draw with - id: scale type: System.Single + description: The scale to draw at - id: depth type: System.Single + description: The depth to draw at content.vb: Public Sub DrawSelf(time As GameTime, batch As SpriteBatch, pos As Vector2, font As GenericFont, color As Color, scale As Single, depth As Single) overload: MLEM.Formatting.Token.DrawSelf* modifiers.csharp: @@ -437,33 +424,45 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawCharacter path: ../MLEM/Formatting/Token.cs - startLine: 45 + startLine: 100 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nDraws a given character using this token's formatting options.\n" + example: [] syntax: content: public void DrawCharacter(GameTime time, SpriteBatch batch, char c, string cString, int indexInToken, Vector2 pos, GenericFont font, Color color, float scale, float depth) parameters: - id: time type: Microsoft.Xna.Framework.GameTime + description: The time - id: batch type: Microsoft.Xna.Framework.Graphics.SpriteBatch + description: The sprite batch to use - id: c type: System.Char + description: The character to draw - id: cString type: System.String + description: A single-character string that contains the character to draw - id: indexInToken type: System.Int32 + description: The index within this token that the character is at - id: pos type: Microsoft.Xna.Framework.Vector2 + description: The position to draw the token at - id: font type: MLEM.Font.GenericFont + description: The font to use to draw - id: color type: Microsoft.Xna.Framework.Color + description: The color to draw with - id: scale type: System.Single + description: The scale to draw at - id: depth type: System.Single + description: The depth to draw at content.vb: Public Sub DrawCharacter(time As GameTime, batch As SpriteBatch, c As Char, cString As String, indexInToken As Integer, pos As Vector2, font As GenericFont, color As Color, scale As Single, depth As Single) overload: MLEM.Formatting.Token.DrawCharacter* modifiers.csharp: @@ -488,19 +487,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetArea path: ../MLEM/Formatting/Token.cs - startLine: 55 + startLine: 118 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nGets a list of rectangles that encompass this token's area.\nNote that more than one rectangle is only returned if the string has been split.\nThis can be used to invoke events when the mouse is hovered over the token, for example.\n" + example: [] syntax: content: public IEnumerable GetArea(Vector2 stringPos, float scale) parameters: - id: stringPos type: Microsoft.Xna.Framework.Vector2 + description: The position that the string is drawn at - id: scale type: System.Single + description: The scale that the string is drawn at return: type: System.Collections.Generic.IEnumerable{MLEM.Misc.RectangleF} + description: A set of rectangles that this token contains content.vb: Public Function GetArea(stringPos As Vector2, scale As Single) As IEnumerable(Of RectangleF) overload: MLEM.Formatting.Token.GetArea* modifiers.csharp: @@ -508,6 +512,12 @@ items: modifiers.vb: - Public references: +- uid: MLEM.Formatting.TokenizedString + commentId: T:MLEM.Formatting.TokenizedString + parent: MLEM.Formatting + name: TokenizedString + nameWithType: TokenizedString + fullName: MLEM.Formatting.TokenizedString - uid: MLEM.Formatting commentId: N:MLEM.Formatting name: MLEM.Formatting @@ -965,6 +975,9 @@ references: - name: () nameWithType: () fullName: () +- uid: MLEM.Formatting.Token.Substring + commentId: F:MLEM.Formatting.Token.Substring + isExternal: true - uid: System.Int32 commentId: T:System.Int32 parent: System @@ -972,6 +985,9 @@ references: name: Int32 nameWithType: Int32 fullName: System.Int32 +- uid: MLEM.Formatting.Token.RawSubstring + commentId: F:MLEM.Formatting.Token.RawSubstring + isExternal: true - uid: System.String commentId: T:System.String parent: System @@ -984,11 +1000,6 @@ references: name: DisplayString nameWithType: Token.DisplayString fullName: MLEM.Formatting.Token.DisplayString -- uid: MLEM.Formatting.Token.#ctor* - commentId: Overload:MLEM.Formatting.Token.#ctor - name: Token - nameWithType: Token.Token - fullName: MLEM.Formatting.Token.Token - uid: MLEM.Formatting.Token.GetColor* commentId: Overload:MLEM.Formatting.Token.GetColor name: GetColor @@ -1106,6 +1117,15 @@ references: name: MLEM.Font nameWithType: MLEM.Font fullName: MLEM.Font +- uid: MLEM.Formatting.Codes.Code + commentId: T:MLEM.Formatting.Codes.Code + parent: MLEM.Formatting.Codes + name: Code + nameWithType: Code + fullName: MLEM.Formatting.Codes.Code +- uid: MLEM.Formatting.Token.DrawCharacter(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,System.Char,System.String,System.Int32,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) + commentId: M:MLEM.Formatting.Token.DrawCharacter(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,System.Char,System.String,System.Int32,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) + isExternal: true - uid: MLEM.Formatting.Token.DrawSelf* commentId: Overload:MLEM.Formatting.Token.DrawSelf name: DrawSelf @@ -1139,6 +1159,11 @@ references: name: Single nameWithType: Single fullName: System.Single +- uid: MLEM.Formatting.Codes + commentId: N:MLEM.Formatting.Codes + name: MLEM.Formatting.Codes + nameWithType: MLEM.Formatting.Codes + fullName: MLEM.Formatting.Codes - uid: Microsoft.Xna.Framework.Graphics commentId: N:Microsoft.Xna.Framework.Graphics isExternal: true diff --git a/Docs/api/MLEM.Formatting.TokenizedString.yml b/Docs/api/MLEM.Formatting.TokenizedString.yml index ce64375..db066e6 100644 --- a/Docs/api/MLEM.Formatting.TokenizedString.yml +++ b/Docs/api/MLEM.Formatting.TokenizedString.yml @@ -5,7 +5,6 @@ items: id: TokenizedString parent: MLEM.Formatting children: - - MLEM.Formatting.TokenizedString.#ctor(MLEM.Font.GenericFont,System.String,System.String,MLEM.Formatting.Token[]) - MLEM.Formatting.TokenizedString.AllCodes - MLEM.Formatting.TokenizedString.DisplayString - MLEM.Formatting.TokenizedString.Draw(Microsoft.Xna.Framework.GameTime,Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Vector2,MLEM.Font.GenericFont,Microsoft.Xna.Framework.Color,System.Single,System.Single) @@ -30,14 +29,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: TokenizedString path: ../MLEM/Formatting/TokenizedString.cs - startLine: 11 + startLine: 14 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nA tokenized string that was created using a \n" + example: [] syntax: content: 'public class TokenizedString : GenericDataHolder' content.vb: >- Public Class TokenizedString + Inherits GenericDataHolder inheritance: - System.Object @@ -77,10 +79,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RawString path: ../MLEM/Formatting/TokenizedString.cs - startLine: 13 + startLine: 19 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe raw string that was used to create this tokenized string.\n" + example: [] syntax: content: public readonly string RawString return: @@ -110,10 +114,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: String path: ../MLEM/Formatting/TokenizedString.cs - startLine: 14 + startLine: 23 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe , but with formatting codes stripped out.\n" + example: [] syntax: content: public readonly string String return: @@ -143,10 +149,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DisplayString path: ../MLEM/Formatting/TokenizedString.cs - startLine: 15 + startLine: 28 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe string that is actually displayed by this tokenized string.\nIf this string has been , this string will contain the newline characters.\n" + example: [] syntax: content: public string DisplayString { get; } parameters: [] @@ -178,10 +186,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Tokens path: ../MLEM/Formatting/TokenizedString.cs - startLine: 16 + startLine: 32 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nThe tokens that this tokenized string contains.\n" + example: [] syntax: content: public readonly Token[] Tokens return: @@ -211,10 +221,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: AllCodes path: ../MLEM/Formatting/TokenizedString.cs - startLine: 17 + startLine: 37 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nAll of the formatting codes that are applied over this tokenized string.\nNote that, to get a formatting code for a certain token, use \n" + example: [] syntax: content: public readonly Code[] AllCodes return: @@ -226,48 +238,6 @@ items: modifiers.vb: - Public - ReadOnly -- uid: MLEM.Formatting.TokenizedString.#ctor(MLEM.Font.GenericFont,System.String,System.String,MLEM.Formatting.Token[]) - commentId: M:MLEM.Formatting.TokenizedString.#ctor(MLEM.Font.GenericFont,System.String,System.String,MLEM.Formatting.Token[]) - id: '#ctor(MLEM.Font.GenericFont,System.String,System.String,MLEM.Formatting.Token[])' - parent: MLEM.Formatting.TokenizedString - langs: - - csharp - - vb - name: TokenizedString(GenericFont, String, String, Token[]) - nameWithType: TokenizedString.TokenizedString(GenericFont, String, String, Token[]) - fullName: MLEM.Formatting.TokenizedString.TokenizedString(MLEM.Font.GenericFont, System.String, System.String, MLEM.Formatting.Token[]) - type: Constructor - source: - remote: - path: MLEM/Formatting/TokenizedString.cs - branch: master - repo: https://github.com/Ellpeck/MLEM - id: .ctor - path: ../MLEM/Formatting/TokenizedString.cs - startLine: 20 - assemblies: - - MLEM - namespace: MLEM.Formatting - syntax: - content: public TokenizedString(GenericFont font, string rawString, string strg, Token[] tokens) - parameters: - - id: font - type: MLEM.Font.GenericFont - - id: rawString - type: System.String - - id: strg - type: System.String - - id: tokens - type: MLEM.Formatting.Token[] - content.vb: Public Sub New(font As GenericFont, rawString As String, strg As String, tokens As Token()) - overload: MLEM.Formatting.TokenizedString.#ctor* - nameWithType.vb: TokenizedString.TokenizedString(GenericFont, String, String, Token()) - modifiers.csharp: - - public - modifiers.vb: - - Public - fullName.vb: MLEM.Formatting.TokenizedString.TokenizedString(MLEM.Font.GenericFont, System.String, System.String, MLEM.Formatting.Token()) - name.vb: TokenizedString(GenericFont, String, String, Token()) - uid: MLEM.Formatting.TokenizedString.Split(MLEM.Font.GenericFont,System.Single,System.Single) commentId: M:MLEM.Formatting.TokenizedString.Split(MLEM.Font.GenericFont,System.Single,System.Single) id: Split(MLEM.Font.GenericFont,System.Single,System.Single) @@ -286,19 +256,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: Split path: ../MLEM/Formatting/TokenizedString.cs - startLine: 29 + startLine: 56 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nSplits this tokenized string, inserting newline characters if the width of the string is bigger than the maximum width.\n\n" + example: [] syntax: content: public void Split(GenericFont font, float width, float scale) parameters: - id: font type: MLEM.Font.GenericFont + description: The font to use for width calculations - id: width type: System.Single + description: The maximum width - id: scale type: System.Single + description: The scale to use fr width calculations content.vb: Public Sub Split(font As GenericFont, width As Single, scale As Single) overload: MLEM.Formatting.TokenizedString.Split* modifiers.csharp: @@ -323,10 +298,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Measure path: ../MLEM/Formatting/TokenizedString.cs - startLine: 59 + startLine: 87 assemblies: - MLEM namespace: MLEM.Formatting + example: [] syntax: content: public Vector2 Measure(GenericFont font) parameters: @@ -358,15 +334,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: Update path: ../MLEM/Formatting/TokenizedString.cs - startLine: 63 + startLine: 95 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nUpdates the formatting codes in this formatted string, causing animations to animate etc.\n" + example: [] syntax: content: public void Update(GameTime time) parameters: - id: time type: Microsoft.Xna.Framework.GameTime + description: The game's time content.vb: Public Sub Update(time As GameTime) overload: MLEM.Formatting.TokenizedString.Update* modifiers.csharp: @@ -391,21 +370,27 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetTokenUnderPos path: ../MLEM/Formatting/TokenizedString.cs - startLine: 68 + startLine: 108 assemblies: - MLEM namespace: MLEM.Formatting + summary: "\nReturns the token under the given position.\nThis can be used for hovering effects when the mouse is over a token, etc.\n" + example: [] syntax: content: public Token GetTokenUnderPos(Vector2 stringPos, Vector2 target, float scale) parameters: - id: stringPos type: Microsoft.Xna.Framework.Vector2 + description: The position that the string is drawn at - id: target type: Microsoft.Xna.Framework.Vector2 + description: The position to use for checking the token - id: scale type: System.Single + description: The scale that the string is drawn at return: type: MLEM.Formatting.Token + description: The token under the target position content.vb: Public Function GetTokenUnderPos(stringPos As Vector2, target As Vector2, scale As Single) As Token overload: MLEM.Formatting.TokenizedString.GetTokenUnderPos* modifiers.csharp: @@ -430,10 +415,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Formatting/TokenizedString.cs - startLine: 72 + startLine: 113 assemblies: - MLEM namespace: MLEM.Formatting + example: [] syntax: content: public void Draw(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) parameters: @@ -458,6 +444,12 @@ items: modifiers.vb: - Public references: +- uid: MLEM.Formatting.TextFormatter + commentId: T:MLEM.Formatting.TextFormatter + parent: MLEM.Formatting + name: TextFormatter + nameWithType: TextFormatter + fullName: MLEM.Formatting.TextFormatter - uid: MLEM.Formatting commentId: N:MLEM.Formatting name: MLEM.Formatting @@ -898,6 +890,12 @@ references: name: String nameWithType: String fullName: System.String +- uid: MLEM.Formatting.TokenizedString.RawString + commentId: F:MLEM.Formatting.TokenizedString.RawString + isExternal: true +- uid: MLEM.Formatting.TokenizedString.Split(MLEM.Font.GenericFont,System.Single,System.Single) + commentId: M:MLEM.Formatting.TokenizedString.Split(MLEM.Font.GenericFont,System.Single,System.Single) + isExternal: true - uid: MLEM.Formatting.TokenizedString.DisplayString* commentId: Overload:MLEM.Formatting.TokenizedString.DisplayString name: DisplayString @@ -927,6 +925,9 @@ references: - name: () nameWithType: () fullName: () +- uid: MLEM.Formatting.Token.AppliedCodes + commentId: F:MLEM.Formatting.Token.AppliedCodes + isExternal: true - uid: MLEM.Formatting.Codes.Code[] isExternal: true name: Code[] @@ -951,27 +952,88 @@ references: - name: () nameWithType: () fullName: () -- uid: MLEM.Formatting.TokenizedString.#ctor* - commentId: Overload:MLEM.Formatting.TokenizedString.#ctor - name: TokenizedString - nameWithType: TokenizedString.TokenizedString - fullName: MLEM.Formatting.TokenizedString.TokenizedString +- uid: MLEM.Font.GenericFont.SplitString(System.String,System.Single,System.Single) + commentId: M:MLEM.Font.GenericFont.SplitString(System.String,System.Single,System.Single) + parent: MLEM.Font.GenericFont + isExternal: true + name: SplitString(String, Single, Single) + nameWithType: GenericFont.SplitString(String, Single, Single) + fullName: MLEM.Font.GenericFont.SplitString(System.String, System.Single, System.Single) + spec.csharp: + - uid: MLEM.Font.GenericFont.SplitString(System.String,System.Single,System.Single) + name: SplitString + nameWithType: GenericFont.SplitString + fullName: MLEM.Font.GenericFont.SplitString + - name: ( + nameWithType: ( + fullName: ( + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Font.GenericFont.SplitString(System.String,System.Single,System.Single) + name: SplitString + nameWithType: GenericFont.SplitString + fullName: MLEM.Font.GenericFont.SplitString + - name: ( + nameWithType: ( + fullName: ( + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ) + nameWithType: ) + fullName: ) +- uid: MLEM.Formatting.TokenizedString.Split* + commentId: Overload:MLEM.Formatting.TokenizedString.Split + name: Split + nameWithType: TokenizedString.Split + fullName: MLEM.Formatting.TokenizedString.Split - uid: MLEM.Font.GenericFont commentId: T:MLEM.Font.GenericFont parent: MLEM.Font name: GenericFont nameWithType: GenericFont fullName: MLEM.Font.GenericFont -- uid: MLEM.Font - commentId: N:MLEM.Font - name: MLEM.Font - nameWithType: MLEM.Font - fullName: MLEM.Font -- uid: MLEM.Formatting.TokenizedString.Split* - commentId: Overload:MLEM.Formatting.TokenizedString.Split - name: Split - nameWithType: TokenizedString.Split - fullName: MLEM.Formatting.TokenizedString.Split - uid: System.Single commentId: T:System.Single parent: System @@ -979,6 +1041,50 @@ references: name: Single nameWithType: Single fullName: System.Single +- uid: MLEM.Font + commentId: N:MLEM.Font + name: MLEM.Font + nameWithType: MLEM.Font + fullName: MLEM.Font +- uid: MLEM.Font.GenericFont.MeasureString(System.String) + commentId: M:MLEM.Font.GenericFont.MeasureString(System.String) + parent: MLEM.Font.GenericFont + isExternal: true + name: MeasureString(String) + nameWithType: GenericFont.MeasureString(String) + fullName: MLEM.Font.GenericFont.MeasureString(System.String) + spec.csharp: + - uid: MLEM.Font.GenericFont.MeasureString(System.String) + name: MeasureString + nameWithType: GenericFont.MeasureString + fullName: MLEM.Font.GenericFont.MeasureString + - name: ( + nameWithType: ( + fullName: ( + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Font.GenericFont.MeasureString(System.String) + name: MeasureString + nameWithType: GenericFont.MeasureString + fullName: MLEM.Font.GenericFont.MeasureString + - name: ( + nameWithType: ( + fullName: ( + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Formatting.TokenizedString.Measure* commentId: Overload:MLEM.Formatting.TokenizedString.Measure name: Measure @@ -1020,6 +1126,173 @@ references: name: Token nameWithType: Token fullName: MLEM.Formatting.Token +- uid: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,System.Single,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single) + commentId: M:MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,System.Single,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single) + parent: MLEM.Font.GenericFont + isExternal: true + name: DrawString(SpriteBatch, String, Vector2, Color, Single, Vector2, Single, SpriteEffects, Single) + nameWithType: GenericFont.DrawString(SpriteBatch, String, Vector2, Color, Single, Vector2, Single, SpriteEffects, Single) + fullName: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch, System.String, Microsoft.Xna.Framework.Vector2, Microsoft.Xna.Framework.Color, System.Single, Microsoft.Xna.Framework.Vector2, System.Single, Microsoft.Xna.Framework.Graphics.SpriteEffects, System.Single) + spec.csharp: + - uid: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,System.Single,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single) + name: DrawString + nameWithType: GenericFont.DrawString + fullName: MLEM.Font.GenericFont.DrawString + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.Graphics.SpriteBatch + name: SpriteBatch + nameWithType: SpriteBatch + fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Vector2 + name: Vector2 + nameWithType: Vector2 + fullName: Microsoft.Xna.Framework.Vector2 + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Color + name: Color + nameWithType: Color + fullName: Microsoft.Xna.Framework.Color + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Vector2 + name: Vector2 + nameWithType: Vector2 + fullName: Microsoft.Xna.Framework.Vector2 + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Graphics.SpriteEffects + name: SpriteEffects + nameWithType: SpriteEffects + fullName: Microsoft.Xna.Framework.Graphics.SpriteEffects + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch,System.String,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,System.Single,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single) + name: DrawString + nameWithType: GenericFont.DrawString + fullName: MLEM.Font.GenericFont.DrawString + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.Graphics.SpriteBatch + name: SpriteBatch + nameWithType: SpriteBatch + fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.String + name: String + nameWithType: String + fullName: System.String + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Vector2 + name: Vector2 + nameWithType: Vector2 + fullName: Microsoft.Xna.Framework.Vector2 + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Color + name: Color + nameWithType: Color + fullName: Microsoft.Xna.Framework.Color + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Vector2 + name: Vector2 + nameWithType: Vector2 + fullName: Microsoft.Xna.Framework.Vector2 + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: Microsoft.Xna.Framework.Graphics.SpriteEffects + name: SpriteEffects + nameWithType: SpriteEffects + fullName: Microsoft.Xna.Framework.Graphics.SpriteEffects + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Formatting.TokenizedString.Draw* commentId: Overload:MLEM.Formatting.TokenizedString.Draw name: Draw diff --git a/Docs/api/MLEM.Input.InputHandler.yml b/Docs/api/MLEM.Input.InputHandler.yml index 6a05bd8..9b98312 100644 --- a/Docs/api/MLEM.Input.InputHandler.yml +++ b/Docs/api/MLEM.Input.InputHandler.yml @@ -69,15 +69,19 @@ items: repo: https://github.com/Ellpeck/MLEM id: InputHandler path: ../MLEM/Input/InputHandler.cs - startLine: 11 + startLine: 15 assemblies: - MLEM namespace: MLEM.Input + summary: "\nAn input handler is a more advanced wrapper around MonoGame's default input system.\nIt includes keyboard, mouse, gamepad and touch states, as well as a new "pressed" state for keys and the ability for keyboard and gamepad repeat events.\n" + example: [] syntax: content: 'public class InputHandler : GameComponent, IGameComponent, IUpdateable, IComparable, IDisposable' content.vb: >- Public Class InputHandler + Inherits GameComponent + Implements IGameComponent, IUpdateable, IComparable(Of GameComponent), IDisposable inheritance: - System.Object @@ -130,10 +134,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: LastKeyboardState path: ../MLEM/Input/InputHandler.cs - startLine: 13 + startLine: 20 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the keyboard state from the last update call\n" + example: [] syntax: content: public KeyboardState LastKeyboardState { get; } parameters: [] @@ -165,10 +171,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: KeyboardState path: ../MLEM/Input/InputHandler.cs - startLine: 14 + startLine: 24 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the current keyboard state\n" + example: [] syntax: content: public KeyboardState KeyboardState { get; } parameters: [] @@ -200,10 +208,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: PressedKeys path: ../MLEM/Input/InputHandler.cs - startLine: 15 + startLine: 28 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the keyboard keys that are currently being pressed\n" + example: [] syntax: content: public Keys[] PressedKeys { get; } parameters: [] @@ -235,10 +245,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: HandleKeyboard path: ../MLEM/Input/InputHandler.cs - startLine: 16 + startLine: 32 assemblies: - MLEM namespace: MLEM.Input + summary: "\nSet this property to false to disable keyboard handling for this input handler.\n" + example: [] syntax: content: public bool HandleKeyboard return: @@ -266,10 +278,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: LastMouseState path: ../MLEM/Input/InputHandler.cs - startLine: 18 + startLine: 37 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the mouse state from the last update call\n" + example: [] syntax: content: public MouseState LastMouseState { get; } parameters: [] @@ -301,10 +315,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: MouseState path: ../MLEM/Input/InputHandler.cs - startLine: 19 + startLine: 41 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the current mouse state\n" + example: [] syntax: content: public MouseState MouseState { get; } parameters: [] @@ -336,10 +352,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: MousePosition path: ../MLEM/Input/InputHandler.cs - startLine: 20 + startLine: 45 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the current position of the mouse, extracted from \n" + example: [] syntax: content: public Point MousePosition { get; } parameters: [] @@ -371,10 +389,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: LastMousePosition path: ../MLEM/Input/InputHandler.cs - startLine: 21 + startLine: 49 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the position of the mouse from the last update call, extracted from \n" + example: [] syntax: content: public Point LastMousePosition { get; } parameters: [] @@ -406,10 +426,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: ScrollWheel path: ../MLEM/Input/InputHandler.cs - startLine: 22 + startLine: 53 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the current scroll wheel value, in increments of 120\n" + example: [] syntax: content: public int ScrollWheel { get; } parameters: [] @@ -441,10 +463,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: LastScrollWheel path: ../MLEM/Input/InputHandler.cs - startLine: 23 + startLine: 57 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the scroll wheel value from the last update call, in increments of 120\n" + example: [] syntax: content: public int LastScrollWheel { get; } parameters: [] @@ -476,10 +500,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: HandleMouse path: ../MLEM/Input/InputHandler.cs - startLine: 24 + startLine: 61 assemblies: - MLEM namespace: MLEM.Input + summary: "\nSet this property to false to disable mouse handling for this input handler.\n" + example: [] syntax: content: public bool HandleMouse return: @@ -507,10 +533,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: ConnectedGamepads path: ../MLEM/Input/InputHandler.cs - startLine: 28 + startLine: 69 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the amount of gamepads that are currently connected.\nThis property is automatically updated in \n" + example: [] syntax: content: public int ConnectedGamepads { get; } parameters: [] @@ -542,10 +570,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: HandleGamepads path: ../MLEM/Input/InputHandler.cs - startLine: 29 + startLine: 73 assemblies: - MLEM namespace: MLEM.Input + summary: "\nSet this property to false to disable keyboard handling for this input handler.\n" + example: [] syntax: content: public bool HandleGamepads return: @@ -573,10 +603,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: LastTouchState path: ../MLEM/Input/InputHandler.cs - startLine: 31 + startLine: 78 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the touch state from the last update call\n" + example: [] syntax: content: public TouchCollection LastTouchState { get; } parameters: [] @@ -608,10 +640,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: TouchState path: ../MLEM/Input/InputHandler.cs - startLine: 32 + startLine: 82 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains the current touch state\n" + example: [] syntax: content: public TouchCollection TouchState { get; } parameters: [] @@ -643,10 +677,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Gestures path: ../MLEM/Input/InputHandler.cs - startLine: 33 + startLine: 87 assemblies: - MLEM namespace: MLEM.Input + summary: "\nContains all of the gestures that have finished during the last update call.\nTo easily query these gestures, use \n" + example: [] syntax: content: public readonly ReadOnlyCollection Gestures return: @@ -676,10 +712,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: HandleTouch path: ../MLEM/Input/InputHandler.cs - startLine: 35 + startLine: 92 assemblies: - MLEM namespace: MLEM.Input + summary: "\nSet this property to false to disable touch handling for this input handler.\n" + example: [] syntax: content: public bool HandleTouch return: @@ -707,10 +745,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: KeyRepeatDelay path: ../MLEM/Input/InputHandler.cs - startLine: 37 + startLine: 98 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThis is the amount of time that has to pass before the first keyboard repeat event is triggered.\n\n" + example: [] syntax: content: public TimeSpan KeyRepeatDelay return: @@ -738,10 +778,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: KeyRepeatRate path: ../MLEM/Input/InputHandler.cs - startLine: 38 + startLine: 103 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThis is the amount of time that has to pass between keyboard repeat events.\n\n" + example: [] syntax: content: public TimeSpan KeyRepeatRate return: @@ -769,10 +811,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: HandleKeyboardRepeats path: ../MLEM/Input/InputHandler.cs - startLine: 40 + startLine: 108 assemblies: - MLEM namespace: MLEM.Input + summary: "\nSet this property to false to disable keyboard repeat event handling.\n" + example: [] syntax: content: public bool HandleKeyboardRepeats return: @@ -800,10 +844,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: HandleGamepadRepeats path: ../MLEM/Input/InputHandler.cs - startLine: 46 + startLine: 117 assemblies: - MLEM namespace: MLEM.Input + summary: "\nSet this property to false to disable gamepad repeat event handling.\n" + example: [] syntax: content: public bool HandleGamepadRepeats return: @@ -831,21 +877,27 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Input/InputHandler.cs - startLine: 52 + startLine: 130 assemblies: - MLEM namespace: MLEM.Input + summary: "\nCreates a new input handler with optional initial values.\n" + example: [] syntax: content: public InputHandler(bool handleKeyboard = true, bool handleMouse = true, bool handleGamepads = true, bool handleTouch = true) parameters: - id: handleKeyboard type: System.Boolean + description: If keyboard input should be handled - id: handleMouse type: System.Boolean + description: If mouse input should be handled - id: handleGamepads type: System.Boolean + description: If gamepad input should be handled - id: handleTouch type: System.Boolean + description: If touch input should be handled content.vb: Public Sub New(handleKeyboard As Boolean = True, handleMouse As Boolean = True, handleGamepads As Boolean = True, handleTouch As Boolean = True) overload: MLEM.Input.InputHandler.#ctor* modifiers.csharp: @@ -870,10 +922,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Update path: ../MLEM/Input/InputHandler.cs - startLine: 60 + startLine: 142 assemblies: - MLEM namespace: MLEM.Input + summary: "\nUpdates this input handler, querying pressed and released keys and calculating repeat events.\nCall this in your method.\n" + example: [] syntax: content: public void Update() content.vb: Public Sub Update @@ -900,10 +954,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Update path: ../MLEM/Input/InputHandler.cs - startLine: 153 + startLine: 236 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public override void Update(GameTime gameTime) parameters: @@ -936,17 +991,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetLastGamepadState path: ../MLEM/Input/InputHandler.cs - startLine: 157 + startLine: 245 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns the state of the indexth gamepad from the last update call\n" + example: [] syntax: content: public GamePadState GetLastGamepadState(int index) parameters: - id: index type: System.Int32 + description: The zero-based gamepad index return: type: Microsoft.Xna.Framework.Input.GamePadState + description: The state of the gamepad last update content.vb: Public Function GetLastGamepadState(index As Integer) As GamePadState overload: MLEM.Input.InputHandler.GetLastGamepadState* modifiers.csharp: @@ -971,17 +1030,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetGamepadState path: ../MLEM/Input/InputHandler.cs - startLine: 161 + startLine: 254 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns the current state of the indexth gamepad\n" + example: [] syntax: content: public GamePadState GetGamepadState(int index) parameters: - id: index type: System.Int32 + description: The zero-based gamepad index return: type: Microsoft.Xna.Framework.Input.GamePadState + description: The current state of the gamepad content.vb: Public Function GetGamepadState(index As Integer) As GamePadState overload: MLEM.Input.InputHandler.GetGamepadState* modifiers.csharp: @@ -1006,10 +1069,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsKeyDown path: ../MLEM/Input/InputHandler.cs - startLine: 165 + startLine: 259 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool IsKeyDown(Keys key) parameters: @@ -1041,10 +1105,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsKeyUp path: ../MLEM/Input/InputHandler.cs - startLine: 169 + startLine: 264 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool IsKeyUp(Keys key) parameters: @@ -1076,10 +1141,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: WasKeyDown path: ../MLEM/Input/InputHandler.cs - startLine: 173 + startLine: 269 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool WasKeyDown(Keys key) parameters: @@ -1111,10 +1177,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: WasKeyUp path: ../MLEM/Input/InputHandler.cs - startLine: 177 + startLine: 274 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool WasKeyUp(Keys key) parameters: @@ -1146,17 +1213,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsKeyPressed path: ../MLEM/Input/InputHandler.cs - startLine: 181 + startLine: 284 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given key is considered pressed.\nA key is considered pressed if it was not down the last update call, but is down the current update call.\n" + example: [] syntax: content: public bool IsKeyPressed(Keys key) parameters: - id: key type: Microsoft.Xna.Framework.Input.Keys + description: The key to query return: type: System.Boolean + description: If the key is pressed content.vb: Public Function IsKeyPressed(key As Keys) As Boolean overload: MLEM.Input.InputHandler.IsKeyPressed* modifiers.csharp: @@ -1181,17 +1252,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsModifierKeyDown path: ../MLEM/Input/InputHandler.cs - startLine: 188 + startLine: 296 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given modifier key is down.\n" + example: [] syntax: content: public bool IsModifierKeyDown(ModifierKey modifier) parameters: - id: modifier type: MLEM.Input.ModifierKey + description: The modifier key return: type: System.Boolean + description: If the modifier key is down content.vb: Public Function IsModifierKeyDown(modifier As ModifierKey) As Boolean overload: MLEM.Input.InputHandler.IsModifierKeyDown* modifiers.csharp: @@ -1216,17 +1291,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsMouseButtonDown path: ../MLEM/Input/InputHandler.cs - startLine: 192 + startLine: 305 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given mouse button is currently down.\n" + example: [] syntax: content: public bool IsMouseButtonDown(MouseButton button) parameters: - id: button type: MLEM.Input.MouseButton + description: The button to query return: type: System.Boolean + description: Whether or not the queried button is down content.vb: Public Function IsMouseButtonDown(button As MouseButton) As Boolean overload: MLEM.Input.InputHandler.IsMouseButtonDown* modifiers.csharp: @@ -1251,17 +1330,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsMouseButtonUp path: ../MLEM/Input/InputHandler.cs - startLine: 196 + startLine: 314 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given mouse button is currently up.\n" + example: [] syntax: content: public bool IsMouseButtonUp(MouseButton button) parameters: - id: button type: MLEM.Input.MouseButton + description: The button to query return: type: System.Boolean + description: Whether or not the queried button is up content.vb: Public Function IsMouseButtonUp(button As MouseButton) As Boolean overload: MLEM.Input.InputHandler.IsMouseButtonUp* modifiers.csharp: @@ -1286,17 +1369,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: WasMouseButtonDown path: ../MLEM/Input/InputHandler.cs - startLine: 200 + startLine: 323 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given mouse button was down the last update call.\n" + example: [] syntax: content: public bool WasMouseButtonDown(MouseButton button) parameters: - id: button type: MLEM.Input.MouseButton + description: The button to query return: type: System.Boolean + description: Whether or not the queried button was down content.vb: Public Function WasMouseButtonDown(button As MouseButton) As Boolean overload: MLEM.Input.InputHandler.WasMouseButtonDown* modifiers.csharp: @@ -1321,17 +1408,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: WasMouseButtonUp path: ../MLEM/Input/InputHandler.cs - startLine: 204 + startLine: 332 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given mouse button was up the last update call.\n" + example: [] syntax: content: public bool WasMouseButtonUp(MouseButton button) parameters: - id: button type: MLEM.Input.MouseButton + description: The button to query return: type: System.Boolean + description: Whether or not the queried button was up content.vb: Public Function WasMouseButtonUp(button As MouseButton) As Boolean overload: MLEM.Input.InputHandler.WasMouseButtonUp* modifiers.csharp: @@ -1356,17 +1447,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsMouseButtonPressed path: ../MLEM/Input/InputHandler.cs - startLine: 208 + startLine: 342 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given mouse button is considered pressed.\nA mouse button is considered pressed if it was up the last update call, and is down the current update call.\n" + example: [] syntax: content: public bool IsMouseButtonPressed(MouseButton button) parameters: - id: button type: MLEM.Input.MouseButton + description: The button to query return: type: System.Boolean + description: Whether the button is pressed content.vb: Public Function IsMouseButtonPressed(button As MouseButton) As Boolean overload: MLEM.Input.InputHandler.IsMouseButtonPressed* modifiers.csharp: @@ -1391,10 +1486,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsGamepadButtonDown path: ../MLEM/Input/InputHandler.cs - startLine: 212 + startLine: 347 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool IsGamepadButtonDown(Buttons button, int index = -1) parameters: @@ -1428,10 +1524,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsGamepadButtonUp path: ../MLEM/Input/InputHandler.cs - startLine: 222 + startLine: 358 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool IsGamepadButtonUp(Buttons button, int index = -1) parameters: @@ -1465,10 +1562,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: WasGamepadButtonDown path: ../MLEM/Input/InputHandler.cs - startLine: 232 + startLine: 369 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool WasGamepadButtonDown(Buttons button, int index = -1) parameters: @@ -1502,10 +1600,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: WasGamepadButtonUp path: ../MLEM/Input/InputHandler.cs - startLine: 242 + startLine: 380 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool WasGamepadButtonUp(Buttons button, int index = -1) parameters: @@ -1539,19 +1638,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsGamepadButtonPressed path: ../MLEM/Input/InputHandler.cs - startLine: 252 + startLine: 397 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given gamepad button on the given index is considered pressed.\nA gamepad button is considered pressed if it was down the last update call, and is up the current update call.\n" + example: [] syntax: content: public bool IsGamepadButtonPressed(Buttons button, int index = -1) parameters: - id: button type: Microsoft.Xna.Framework.Input.Buttons + description: The button to query - id: index type: System.Int32 + description: The zero-based index of the gamepad, or -1 for any gamepad return: type: System.Boolean + description: Whether the given button is pressed content.vb: Public Function IsGamepadButtonPressed(button As Buttons, index As Integer = -1) As Boolean overload: MLEM.Input.InputHandler.IsGamepadButtonPressed* modifiers.csharp: @@ -1576,19 +1680,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetGesture path: ../MLEM/Input/InputHandler.cs - startLine: 265 + startLine: 416 assemblies: - MLEM namespace: MLEM.Input + summary: "\nQueries for a gesture of a given type that finished during the current update call.\n" + example: [] syntax: content: public bool GetGesture(GestureType type, out GestureSample sample) parameters: - id: type type: Microsoft.Xna.Framework.Input.Touch.GestureType + description: The type of gesture to query for - id: sample type: Microsoft.Xna.Framework.Input.Touch.GestureSample + description: The resulting gesture sample, or default if there isn't one return: type: System.Boolean + description: True if a gesture of the type was found, otherwise false content.vb: Public Function GetGesture(type As GestureType, ByRef sample As GestureSample) As Boolean overload: MLEM.Input.InputHandler.GetGesture* nameWithType.vb: InputHandler.GetGesture(GestureType, ByRef GestureSample) @@ -1616,21 +1725,30 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsDown path: ../MLEM/Input/InputHandler.cs - startLine: 275 + startLine: 434 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns if a given control of any kind is down.\nThis is a helper function that can be passed a , or .\n" + example: [] syntax: content: public bool IsDown(object control, int index = -1) parameters: - id: control type: System.Object + description: The control whose down state to query - id: index type: System.Int32 + description: The index of the gamepad to query (if applicable), or -1 for any gamepad return: type: System.Boolean + description: Whether the given control is down content.vb: Public Function IsDown(control As Object, index As Integer = -1) As Boolean overload: MLEM.Input.InputHandler.IsDown* + exceptions: + - type: System.ArgumentException + commentId: T:System.ArgumentException + description: If the passed control isn't of a supported type modifiers.csharp: - public modifiers.vb: @@ -1653,21 +1771,30 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsUp path: ../MLEM/Input/InputHandler.cs - startLine: 285 + startLine: 452 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns if a given control of any kind is up.\nThis is a helper function that can be passed a , or .\n" + example: [] syntax: content: public bool IsUp(object control, int index = -1) parameters: - id: control type: System.Object + description: The control whose up state to query - id: index type: System.Int32 + description: The index of the gamepad to query (if applicable), or -1 for any gamepad return: type: System.Boolean + description: Whether the given control is down content.vb: Public Function IsUp(control As Object, index As Integer = -1) As Boolean overload: MLEM.Input.InputHandler.IsUp* + exceptions: + - type: System.ArgumentException + commentId: T:System.ArgumentException + description: If the passed control isn't of a supported type modifiers.csharp: - public modifiers.vb: @@ -1690,21 +1817,30 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsPressed path: ../MLEM/Input/InputHandler.cs - startLine: 295 + startLine: 470 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns if a given control of any kind is pressed.\nThis is a helper function that can be passed a , or .\n" + example: [] syntax: content: public bool IsPressed(object control, int index = -1) parameters: - id: control type: System.Object + description: The control whose pressed state to query - id: index type: System.Int32 + description: The index of the gamepad to query (if applicable), or -1 for any gamepad return: type: System.Boolean + description: Whether the given control is down content.vb: Public Function IsPressed(control As Object, index As Integer = -1) As Boolean overload: MLEM.Input.InputHandler.IsPressed* + exceptions: + - type: System.ArgumentException + commentId: T:System.ArgumentException + description: If the passed control isn't of a supported type modifiers.csharp: - public modifiers.vb: @@ -1727,10 +1863,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsAnyDown path: ../MLEM/Input/InputHandler.cs - startLine: 305 + startLine: 481 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool IsAnyDown(params object[] control) parameters: @@ -1765,10 +1902,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsAnyUp path: ../MLEM/Input/InputHandler.cs - startLine: 309 + startLine: 486 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool IsAnyUp(params object[] control) parameters: @@ -1803,10 +1941,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsAnyPressed path: ../MLEM/Input/InputHandler.cs - startLine: 313 + startLine: 491 assemblies: - MLEM namespace: MLEM.Input + example: [] syntax: content: public bool IsAnyPressed(params object[] control) parameters: @@ -1841,15 +1980,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: EnableGestures path: ../MLEM/Input/InputHandler.cs - startLine: 317 + startLine: 500 assemblies: - MLEM namespace: MLEM.Input + summary: "\nHelper function to enable gestures for a easily.\nNote that, if other gestures were previously enabled, they will not get overridden.\n" + example: [] syntax: content: public static void EnableGestures(params GestureType[] gestures) parameters: - id: gestures type: Microsoft.Xna.Framework.Input.Touch.GestureType[] + description: The gestures to enable content.vb: Public Shared Sub EnableGestures(ParamArray gestures As GestureType()) overload: MLEM.Input.InputHandler.EnableGestures* nameWithType.vb: InputHandler.EnableGestures(GestureType()) @@ -2647,6 +2789,9 @@ references: name: MouseState nameWithType: InputHandler.MouseState fullName: MLEM.Input.InputHandler.MouseState +- uid: MLEM.Input.InputHandler.MouseState + commentId: P:MLEM.Input.InputHandler.MouseState + isExternal: true - uid: MLEM.Input.InputHandler.MousePosition* commentId: Overload:MLEM.Input.InputHandler.MousePosition name: MousePosition @@ -2659,6 +2804,9 @@ references: name: Point nameWithType: Point fullName: Microsoft.Xna.Framework.Point +- uid: MLEM.Input.InputHandler.LastMouseState + commentId: P:MLEM.Input.InputHandler.LastMouseState + isExternal: true - uid: MLEM.Input.InputHandler.LastMousePosition* commentId: Overload:MLEM.Input.InputHandler.LastMousePosition name: LastMousePosition @@ -2681,6 +2829,9 @@ references: name: LastScrollWheel nameWithType: InputHandler.LastScrollWheel fullName: MLEM.Input.InputHandler.LastScrollWheel +- uid: MLEM.Input.InputHandler.Update + commentId: M:MLEM.Input.InputHandler.Update + isExternal: true - uid: MLEM.Input.InputHandler.ConnectedGamepads* commentId: Overload:MLEM.Input.InputHandler.ConnectedGamepads name: ConnectedGamepads @@ -2709,6 +2860,9 @@ references: name: TouchState nameWithType: InputHandler.TouchState fullName: MLEM.Input.InputHandler.TouchState +- uid: MLEM.Input.InputHandler.GetGesture(Microsoft.Xna.Framework.Input.Touch.GestureType,Microsoft.Xna.Framework.Input.Touch.GestureSample@) + commentId: M:MLEM.Input.InputHandler.GetGesture(Microsoft.Xna.Framework.Input.Touch.GestureType,Microsoft.Xna.Framework.Input.Touch.GestureSample@) + isExternal: true - uid: System.Collections.ObjectModel.ReadOnlyCollection{Microsoft.Xna.Framework.Input.Touch.GestureSample} commentId: T:System.Collections.ObjectModel.ReadOnlyCollection{Microsoft.Xna.Framework.Input.Touch.GestureSample} parent: System.Collections.ObjectModel @@ -2798,6 +2952,9 @@ references: name: System.Collections.ObjectModel nameWithType: System.Collections.ObjectModel fullName: System.Collections.ObjectModel +- uid: MLEM.Input.InputHandler.KeyRepeatRate + commentId: F:MLEM.Input.InputHandler.KeyRepeatRate + isExternal: true - uid: System.TimeSpan commentId: T:System.TimeSpan parent: System @@ -2805,16 +2962,67 @@ references: name: TimeSpan nameWithType: TimeSpan fullName: System.TimeSpan +- uid: MLEM.Input.InputHandler.KeyRepeatDelay + commentId: F:MLEM.Input.InputHandler.KeyRepeatDelay + isExternal: true - uid: MLEM.Input.InputHandler.#ctor* commentId: Overload:MLEM.Input.InputHandler.#ctor name: InputHandler nameWithType: InputHandler.InputHandler fullName: MLEM.Input.InputHandler.InputHandler +- uid: Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime) + commentId: M:Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime) + parent: Microsoft.Xna.Framework.Game + isExternal: true + name: Update(GameTime) + nameWithType: Game.Update(GameTime) + fullName: Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime) + spec.csharp: + - uid: Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime) + name: Update + nameWithType: Game.Update + fullName: Microsoft.Xna.Framework.Game.Update + isExternal: true + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.GameTime + name: GameTime + nameWithType: GameTime + fullName: Microsoft.Xna.Framework.GameTime + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: Microsoft.Xna.Framework.Game.Update(Microsoft.Xna.Framework.GameTime) + name: Update + nameWithType: Game.Update + fullName: Microsoft.Xna.Framework.Game.Update + isExternal: true + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.GameTime + name: GameTime + nameWithType: GameTime + fullName: Microsoft.Xna.Framework.GameTime + isExternal: true + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Input.InputHandler.Update* commentId: Overload:MLEM.Input.InputHandler.Update name: Update nameWithType: InputHandler.Update fullName: MLEM.Input.InputHandler.Update +- uid: Microsoft.Xna.Framework.Game + commentId: T:Microsoft.Xna.Framework.Game + parent: Microsoft.Xna.Framework + isExternal: true + name: Game + nameWithType: Game + fullName: Microsoft.Xna.Framework.Game - uid: Microsoft.Xna.Framework.GameComponent.Update(Microsoft.Xna.Framework.GameTime) commentId: M:Microsoft.Xna.Framework.GameComponent.Update(Microsoft.Xna.Framework.GameTime) parent: Microsoft.Xna.Framework.GameComponent @@ -2880,6 +3088,9 @@ references: name: GetGamepadState nameWithType: InputHandler.GetGamepadState fullName: MLEM.Input.InputHandler.GetGamepadState +- uid: Microsoft.Xna.Framework.Input.KeyboardState.IsKeyDown(Microsoft.Xna.Framework.Input.Keys) + commentId: M:Microsoft.Xna.Framework.Input.KeyboardState.IsKeyDown(Microsoft.Xna.Framework.Input.Keys) + isExternal: true - uid: MLEM.Input.InputHandler.IsKeyDown* commentId: Overload:MLEM.Input.InputHandler.IsKeyDown name: IsKeyDown @@ -2892,6 +3103,9 @@ references: name: Keys nameWithType: Keys fullName: Microsoft.Xna.Framework.Input.Keys +- uid: Microsoft.Xna.Framework.Input.KeyboardState.IsKeyUp(Microsoft.Xna.Framework.Input.Keys) + commentId: M:Microsoft.Xna.Framework.Input.KeyboardState.IsKeyUp(Microsoft.Xna.Framework.Input.Keys) + isExternal: true - uid: MLEM.Input.InputHandler.IsKeyUp* commentId: Overload:MLEM.Input.InputHandler.IsKeyUp name: IsKeyUp @@ -2954,6 +3168,9 @@ references: name: IsMouseButtonPressed nameWithType: InputHandler.IsMouseButtonPressed fullName: MLEM.Input.InputHandler.IsMouseButtonPressed +- uid: Microsoft.Xna.Framework.Input.GamePadState.IsButtonDown(Microsoft.Xna.Framework.Input.Buttons) + commentId: M:Microsoft.Xna.Framework.Input.GamePadState.IsButtonDown(Microsoft.Xna.Framework.Input.Buttons) + isExternal: true - uid: MLEM.Input.InputHandler.IsGamepadButtonDown* commentId: Overload:MLEM.Input.InputHandler.IsGamepadButtonDown name: IsGamepadButtonDown @@ -2966,6 +3183,9 @@ references: name: Buttons nameWithType: Buttons fullName: Microsoft.Xna.Framework.Input.Buttons +- uid: Microsoft.Xna.Framework.Input.GamePadState.IsButtonUp(Microsoft.Xna.Framework.Input.Buttons) + commentId: M:Microsoft.Xna.Framework.Input.GamePadState.IsButtonUp(Microsoft.Xna.Framework.Input.Buttons) + isExternal: true - uid: MLEM.Input.InputHandler.IsGamepadButtonUp* commentId: Overload:MLEM.Input.InputHandler.IsGamepadButtonUp name: IsGamepadButtonUp @@ -3005,6 +3225,9 @@ references: name: GestureSample nameWithType: GestureSample fullName: Microsoft.Xna.Framework.Input.Touch.GestureSample +- uid: System.ArgumentException + commentId: T:System.ArgumentException + isExternal: true - uid: MLEM.Input.InputHandler.IsDown* commentId: Overload:MLEM.Input.InputHandler.IsDown name: IsDown @@ -3020,6 +3243,9 @@ references: name: IsPressed nameWithType: InputHandler.IsPressed fullName: MLEM.Input.InputHandler.IsPressed +- uid: MLEM.Input.InputHandler.IsDown(System.Object,System.Int32) + commentId: M:MLEM.Input.InputHandler.IsDown(System.Object,System.Int32) + isExternal: true - uid: MLEM.Input.InputHandler.IsAnyDown* commentId: Overload:MLEM.Input.InputHandler.IsAnyDown name: IsAnyDown @@ -3051,16 +3277,25 @@ references: - name: () nameWithType: () fullName: () +- uid: MLEM.Input.InputHandler.IsUp(System.Object,System.Int32) + commentId: M:MLEM.Input.InputHandler.IsUp(System.Object,System.Int32) + isExternal: true - uid: MLEM.Input.InputHandler.IsAnyUp* commentId: Overload:MLEM.Input.InputHandler.IsAnyUp name: IsAnyUp nameWithType: InputHandler.IsAnyUp fullName: MLEM.Input.InputHandler.IsAnyUp +- uid: MLEM.Input.InputHandler.IsPressed(System.Object,System.Int32) + commentId: M:MLEM.Input.InputHandler.IsPressed(System.Object,System.Int32) + isExternal: true - uid: MLEM.Input.InputHandler.IsAnyPressed* commentId: Overload:MLEM.Input.InputHandler.IsAnyPressed name: IsAnyPressed nameWithType: InputHandler.IsAnyPressed fullName: MLEM.Input.InputHandler.IsAnyPressed +- uid: Microsoft.Xna.Framework.Input.Touch.TouchPanel + commentId: T:Microsoft.Xna.Framework.Input.Touch.TouchPanel + isExternal: true - uid: MLEM.Input.InputHandler.EnableGestures* commentId: Overload:MLEM.Input.InputHandler.EnableGestures name: EnableGestures diff --git a/Docs/api/MLEM.Input.KeysExtensions.yml b/Docs/api/MLEM.Input.KeysExtensions.yml index 4e293bf..0bba860 100644 --- a/Docs/api/MLEM.Input.KeysExtensions.yml +++ b/Docs/api/MLEM.Input.KeysExtensions.yml @@ -23,10 +23,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: KeysExtensions path: ../MLEM/Input/KeysExtensions.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Input + summary: "\nA set of extension methods for dealing with and \n" + example: [] syntax: content: public static class KeysExtensions content.vb: Public Module KeysExtensions @@ -65,10 +67,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: ModifierKeys path: ../MLEM/Input/KeysExtensions.cs - startLine: 8 + startLine: 14 assemblies: - MLEM namespace: MLEM.Input + summary: "\nAll enum values of \n" + example: [] syntax: content: public static readonly ModifierKey[] ModifierKeys return: @@ -101,17 +105,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetKeys path: ../MLEM/Input/KeysExtensions.cs - startLine: 10 + startLine: 21 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns all of the keys that the given modifier key represents\n" + example: [] syntax: content: public static IEnumerable GetKeys(this ModifierKey modifier) parameters: - id: modifier type: MLEM.Input.ModifierKey + description: The modifier key return: type: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys} + description: All of the keys the modifier key represents content.vb: >- @@ -142,17 +150,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetModifier path: ../MLEM/Input/KeysExtensions.cs - startLine: 27 + startLine: 44 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns the modifier key that the given key represents.\nIf there is no matching modifier key, is returned.\n" + example: [] syntax: content: public static ModifierKey GetModifier(this Keys key) parameters: - id: key type: Microsoft.Xna.Framework.Input.Keys + description: The key to convert to a modifier key return: type: MLEM.Input.ModifierKey + description: The modifier key, or content.vb: >- @@ -183,17 +195,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsModifier path: ../MLEM/Input/KeysExtensions.cs - startLine: 35 + startLine: 57 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns whether the given key is a modifier key or not.\n" + example: [] syntax: content: public static bool IsModifier(this Keys key) parameters: - id: key type: Microsoft.Xna.Framework.Input.Keys + description: The key return: type: System.Boolean + description: If the key is a modifier key content.vb: >- @@ -206,6 +222,16 @@ items: - Public - Shared references: +- uid: Microsoft.Xna.Framework.Input.Keys + commentId: T:Microsoft.Xna.Framework.Input.Keys + parent: Microsoft.Xna.Framework.Input + isExternal: true + name: Keys + nameWithType: Keys + fullName: Microsoft.Xna.Framework.Input.Keys +- uid: Microsoft.Xna.Framework.Input.Keyboard + commentId: T:Microsoft.Xna.Framework.Input.Keyboard + isExternal: true - uid: MLEM.Input commentId: N:MLEM.Input name: MLEM.Input @@ -497,12 +523,24 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework.Input + commentId: N:Microsoft.Xna.Framework.Input + isExternal: true + name: Microsoft.Xna.Framework.Input + nameWithType: Microsoft.Xna.Framework.Input + fullName: Microsoft.Xna.Framework.Input - uid: System commentId: N:System isExternal: true name: System nameWithType: System fullName: System +- uid: MLEM.Input.ModifierKey + commentId: T:MLEM.Input.ModifierKey + parent: MLEM.Input + name: ModifierKey + nameWithType: ModifierKey + fullName: MLEM.Input.ModifierKey - uid: MLEM.Input.ModifierKey[] isExternal: true name: ModifierKey[] @@ -532,12 +570,6 @@ references: name: GetKeys nameWithType: KeysExtensions.GetKeys fullName: MLEM.Input.KeysExtensions.GetKeys -- uid: MLEM.Input.ModifierKey - commentId: T:MLEM.Input.ModifierKey - parent: MLEM.Input - name: ModifierKey - nameWithType: ModifierKey - fullName: MLEM.Input.ModifierKey - uid: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys} commentId: T:System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys} parent: System.Collections.Generic @@ -627,24 +659,14 @@ references: name: System.Collections.Generic nameWithType: System.Collections.Generic fullName: System.Collections.Generic +- uid: MLEM.Input.ModifierKey.None + commentId: F:MLEM.Input.ModifierKey.None + isExternal: true - uid: MLEM.Input.KeysExtensions.GetModifier* commentId: Overload:MLEM.Input.KeysExtensions.GetModifier name: GetModifier nameWithType: KeysExtensions.GetModifier fullName: MLEM.Input.KeysExtensions.GetModifier -- uid: Microsoft.Xna.Framework.Input.Keys - commentId: T:Microsoft.Xna.Framework.Input.Keys - parent: Microsoft.Xna.Framework.Input - isExternal: true - name: Keys - nameWithType: Keys - fullName: Microsoft.Xna.Framework.Input.Keys -- uid: Microsoft.Xna.Framework.Input - commentId: N:Microsoft.Xna.Framework.Input - isExternal: true - name: Microsoft.Xna.Framework.Input - nameWithType: Microsoft.Xna.Framework.Input - fullName: Microsoft.Xna.Framework.Input - uid: MLEM.Input.KeysExtensions.IsModifier* commentId: Overload:MLEM.Input.KeysExtensions.IsModifier name: IsModifier diff --git a/Docs/api/MLEM.Input.ModifierKey.yml b/Docs/api/MLEM.Input.ModifierKey.yml index 78a99c8..1087aa4 100644 --- a/Docs/api/MLEM.Input.ModifierKey.yml +++ b/Docs/api/MLEM.Input.ModifierKey.yml @@ -23,10 +23,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: ModifierKey path: ../MLEM/Input/KeysExtensions.cs - startLine: 41 + startLine: 67 assemblies: - MLEM namespace: MLEM.Input + summary: "\nAn enum representing modifier keys.\nA modifier key is a key that is usually pressed as part of key combination to change the function of a regular key.\n" + example: [] syntax: content: public enum ModifierKey content.vb: Public Enum ModifierKey @@ -56,10 +58,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: None path: ../MLEM/Input/KeysExtensions.cs - startLine: 43 + startLine: 72 assemblies: - MLEM namespace: MLEM.Input + summary: "\nNo modifier key. Only used for \n" + example: [] syntax: content: None = 0 return: @@ -88,10 +92,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Shift path: ../MLEM/Input/KeysExtensions.cs - startLine: 44 + startLine: 76 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe shift modifier key. This represents Left Shift and Right Shift keys.\n" + example: [] syntax: content: Shift = 1 return: @@ -120,10 +126,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Control path: ../MLEM/Input/KeysExtensions.cs - startLine: 45 + startLine: 80 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe control modifier key. This represents Left Control and Right Control.\n" + example: [] syntax: content: Control = 2 return: @@ -152,10 +160,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Alt path: ../MLEM/Input/KeysExtensions.cs - startLine: 46 + startLine: 84 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe alt modifier key. This represents Alt and Alt Graph.\n" + example: [] syntax: content: Alt = 3 return: @@ -242,6 +252,9 @@ references: name: KeysExtensions nameWithType: KeysExtensions fullName: MLEM.Input.KeysExtensions +- uid: MLEM.Input.KeysExtensions.GetModifier(Microsoft.Xna.Framework.Input.Keys) + commentId: M:MLEM.Input.KeysExtensions.GetModifier(Microsoft.Xna.Framework.Input.Keys) + isExternal: true - uid: MLEM.Input.ModifierKey commentId: T:MLEM.Input.ModifierKey parent: MLEM.Input diff --git a/Docs/api/MLEM.Input.MouseButton.yml b/Docs/api/MLEM.Input.MouseButton.yml index 2f5a95b..81feea3 100644 --- a/Docs/api/MLEM.Input.MouseButton.yml +++ b/Docs/api/MLEM.Input.MouseButton.yml @@ -24,10 +24,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: MouseButton path: ../MLEM/Input/MouseExtensions.cs - startLine: 29 + startLine: 46 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThis enum is a list of possible mouse buttons.\nIt serves as a wrapper around 's button properties.\n" + example: [] syntax: content: public enum MouseButton content.vb: Public Enum MouseButton @@ -55,10 +57,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Left path: ../MLEM/Input/MouseExtensions.cs - startLine: 31 + startLine: 51 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe left mouse button, or \n" + example: [] syntax: content: Left = 0 return: @@ -87,10 +91,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Middle path: ../MLEM/Input/MouseExtensions.cs - startLine: 32 + startLine: 55 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe middle mouse button, or \n" + example: [] syntax: content: Middle = 1 return: @@ -119,10 +125,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Right path: ../MLEM/Input/MouseExtensions.cs - startLine: 33 + startLine: 59 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe right mouse button, or \n" + example: [] syntax: content: Right = 2 return: @@ -151,10 +159,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Extra1 path: ../MLEM/Input/MouseExtensions.cs - startLine: 34 + startLine: 63 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe first extra mouse button, or \n" + example: [] syntax: content: Extra1 = 3 return: @@ -183,10 +193,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Extra2 path: ../MLEM/Input/MouseExtensions.cs - startLine: 35 + startLine: 67 assemblies: - MLEM namespace: MLEM.Input + summary: "\nThe second extra mouse button, or \n" + example: [] syntax: content: Extra2 = 4 return: @@ -198,14 +210,42 @@ items: - Public - Const references: +- uid: Microsoft.Xna.Framework.Input.MouseState + commentId: T:Microsoft.Xna.Framework.Input.MouseState + parent: Microsoft.Xna.Framework.Input + isExternal: true + name: MouseState + nameWithType: MouseState + fullName: Microsoft.Xna.Framework.Input.MouseState - uid: MLEM.Input commentId: N:MLEM.Input name: MLEM.Input nameWithType: MLEM.Input fullName: MLEM.Input +- uid: Microsoft.Xna.Framework.Input + commentId: N:Microsoft.Xna.Framework.Input + isExternal: true + name: Microsoft.Xna.Framework.Input + nameWithType: Microsoft.Xna.Framework.Input + fullName: Microsoft.Xna.Framework.Input +- uid: Microsoft.Xna.Framework.Input.MouseState.LeftButton + commentId: P:Microsoft.Xna.Framework.Input.MouseState.LeftButton + isExternal: true - uid: MLEM.Input.MouseButton commentId: T:MLEM.Input.MouseButton parent: MLEM.Input name: MouseButton nameWithType: MouseButton fullName: MLEM.Input.MouseButton +- uid: Microsoft.Xna.Framework.Input.MouseState.MiddleButton + commentId: P:Microsoft.Xna.Framework.Input.MouseState.MiddleButton + isExternal: true +- uid: Microsoft.Xna.Framework.Input.MouseState.RightButton + commentId: P:Microsoft.Xna.Framework.Input.MouseState.RightButton + isExternal: true +- uid: Microsoft.Xna.Framework.Input.MouseState.XButton1 + commentId: P:Microsoft.Xna.Framework.Input.MouseState.XButton1 + isExternal: true +- uid: Microsoft.Xna.Framework.Input.MouseState.XButton2 + commentId: P:Microsoft.Xna.Framework.Input.MouseState.XButton2 + isExternal: true diff --git a/Docs/api/MLEM.Input.MouseExtensions.yml b/Docs/api/MLEM.Input.MouseExtensions.yml index ecce978..a6598ed 100644 --- a/Docs/api/MLEM.Input.MouseExtensions.yml +++ b/Docs/api/MLEM.Input.MouseExtensions.yml @@ -21,10 +21,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: MouseExtensions path: ../MLEM/Input/MouseExtensions.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Input + summary: "\nA set of extension methods for dealing with and \n" + example: [] syntax: content: public static class MouseExtensions content.vb: Public Module MouseExtensions @@ -63,10 +65,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: MouseButtons path: ../MLEM/Input/MouseExtensions.cs - startLine: 8 + startLine: 14 assemblies: - MLEM namespace: MLEM.Input + summary: "\nAll enum values of \n" + example: [] syntax: content: public static readonly MouseButton[] MouseButtons return: @@ -99,24 +103,33 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetState path: ../MLEM/Input/MouseExtensions.cs - startLine: 10 + startLine: 23 assemblies: - MLEM namespace: MLEM.Input + summary: "\nReturns the of the given mouse button.\n" + example: [] syntax: content: public static ButtonState GetState(this MouseState state, MouseButton button) parameters: - id: state type: Microsoft.Xna.Framework.Input.MouseState + description: The mouse's current state - id: button type: MLEM.Input.MouseButton + description: The button whose state to query return: type: Microsoft.Xna.Framework.Input.ButtonState + description: The state of the button content.vb: >- Public Shared Function GetState(state As MouseState, button As MouseButton) As ButtonState overload: MLEM.Input.MouseExtensions.GetState* + exceptions: + - type: System.ArgumentException + commentId: T:System.ArgumentException + description: If a mouse button out of range is passed modifiers.csharp: - public - static @@ -124,6 +137,15 @@ items: - Public - Shared references: +- uid: MLEM.Input.MouseButton + commentId: T:MLEM.Input.MouseButton + parent: MLEM.Input + name: MouseButton + nameWithType: MouseButton + fullName: MLEM.Input.MouseButton +- uid: Microsoft.Xna.Framework.Input.Mouse + commentId: T:Microsoft.Xna.Framework.Input.Mouse + isExternal: true - uid: MLEM.Input commentId: N:MLEM.Input name: MLEM.Input @@ -445,6 +467,16 @@ references: - name: () nameWithType: () fullName: () +- uid: Microsoft.Xna.Framework.Input.ButtonState + commentId: T:Microsoft.Xna.Framework.Input.ButtonState + parent: Microsoft.Xna.Framework.Input + isExternal: true + name: ButtonState + nameWithType: ButtonState + fullName: Microsoft.Xna.Framework.Input.ButtonState +- uid: System.ArgumentException + commentId: T:System.ArgumentException + isExternal: true - uid: MLEM.Input.MouseExtensions.GetState* commentId: Overload:MLEM.Input.MouseExtensions.GetState name: GetState @@ -457,19 +489,6 @@ references: name: MouseState nameWithType: MouseState fullName: Microsoft.Xna.Framework.Input.MouseState -- uid: MLEM.Input.MouseButton - commentId: T:MLEM.Input.MouseButton - parent: MLEM.Input - name: MouseButton - nameWithType: MouseButton - fullName: MLEM.Input.MouseButton -- uid: Microsoft.Xna.Framework.Input.ButtonState - commentId: T:Microsoft.Xna.Framework.Input.ButtonState - parent: Microsoft.Xna.Framework.Input - isExternal: true - name: ButtonState - nameWithType: ButtonState - fullName: Microsoft.Xna.Framework.Input.ButtonState - uid: Microsoft.Xna.Framework.Input commentId: N:Microsoft.Xna.Framework.Input isExternal: true diff --git a/Docs/api/MLEM.Misc.AutoTiling.ConnectsTo.yml b/Docs/api/MLEM.Misc.AutoTiling.ConnectsTo.yml index 47bb364..6181dbd 100644 --- a/Docs/api/MLEM.Misc.AutoTiling.ConnectsTo.yml +++ b/Docs/api/MLEM.Misc.AutoTiling.ConnectsTo.yml @@ -19,17 +19,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: ConnectsTo path: ../MLEM/Misc/AutoTiling.cs - startLine: 28 + startLine: 54 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA delegate function that determines if a given offset position connects to an auto-tile location.\n" + example: [] syntax: content: public delegate bool ConnectsTo(int xOff, int yOff); parameters: - id: xOff type: System.Int32 + description: The x offset - id: yOff type: System.Int32 + description: The y offset return: type: System.Boolean content.vb: Public Delegate Function ConnectsTo(xOff As Integer, yOff As Integer) As Boolean diff --git a/Docs/api/MLEM.Misc.AutoTiling.yml b/Docs/api/MLEM.Misc.AutoTiling.yml index 9dbf127..5839d7b 100644 --- a/Docs/api/MLEM.Misc.AutoTiling.yml +++ b/Docs/api/MLEM.Misc.AutoTiling.yml @@ -20,10 +20,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: AutoTiling path: ../MLEM/Misc/AutoTiling.cs - startLine: 4 + startLine: 8 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThis class contains a method that allows users to easily draw a tile with automatic connections.\nFor auto-tiling in this manner to work, auto-tiled textures have to be laid out in a format described in .\n" + example: [] syntax: content: public class AutoTiling content.vb: Public Class AutoTiling @@ -61,33 +63,45 @@ items: repo: https://github.com/Ellpeck/MLEM id: DrawAutoTile path: ../MLEM/Misc/AutoTiling.cs - startLine: 6 + startLine: 27 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThis method allows for a tiled texture to be drawn in an auto-tiling mode.\nThis allows, for example, a grass patch on a tilemap to have nice looking edges that transfer over into a path without any hard edges between tiles.\n\nFor auto-tiling in this way to work, the tiles have to be laid out in a specific order. This order is shown in the auto-tiling demo's textures.\nFor more information and an example, see https://github.com/Ellpeck/MLEM/blob/master/Demos/AutoTilingDemo.cs#L20-L28\n" + example: [] syntax: content: public static void DrawAutoTile(SpriteBatch batch, Vector2 pos, Texture2D texture, Rectangle textureRegion, AutoTiling.ConnectsTo connectsTo, Color color, float rotation = 0F, Vector2? origin = default(Vector2? ), Vector2? scale = default(Vector2? ), float layerDepth = 0F) parameters: - id: batch type: Microsoft.Xna.Framework.Graphics.SpriteBatch + description: '' - id: pos type: Microsoft.Xna.Framework.Vector2 + description: '' - id: texture type: Microsoft.Xna.Framework.Graphics.Texture2D + description: '' - id: textureRegion type: Microsoft.Xna.Framework.Rectangle + description: '' - id: connectsTo type: MLEM.Misc.AutoTiling.ConnectsTo + description: '' - id: color type: Microsoft.Xna.Framework.Color + description: '' - id: rotation type: System.Single + description: '' - id: origin type: System.Nullable{Microsoft.Xna.Framework.Vector2} + description: '' - id: scale type: System.Nullable{Microsoft.Xna.Framework.Vector2} + description: '' - id: layerDepth type: System.Single + description: '' content.vb: Public Shared Sub DrawAutoTile(batch As SpriteBatch, pos As Vector2, texture As Texture2D, textureRegion As Rectangle, connectsTo As AutoTiling.ConnectsTo, color As Color, rotation As Single = 0F, origin As Vector2? = Nothing, scale As Vector2? = Nothing, layerDepth As Single = 0F) overload: MLEM.Misc.AutoTiling.DrawAutoTile* nameWithType.vb: AutoTiling.DrawAutoTile(SpriteBatch, Vector2, Texture2D, Rectangle, AutoTiling.ConnectsTo, Color, Single, Nullable(Of Vector2), Nullable(Of Vector2), Single) @@ -100,6 +114,9 @@ items: fullName.vb: MLEM.Misc.AutoTiling.DrawAutoTile(Microsoft.Xna.Framework.Graphics.SpriteBatch, Microsoft.Xna.Framework.Vector2, Microsoft.Xna.Framework.Graphics.Texture2D, Microsoft.Xna.Framework.Rectangle, MLEM.Misc.AutoTiling.ConnectsTo, Microsoft.Xna.Framework.Color, System.Single, System.Nullable(Of Microsoft.Xna.Framework.Vector2), System.Nullable(Of Microsoft.Xna.Framework.Vector2), System.Single) name.vb: DrawAutoTile(SpriteBatch, Vector2, Texture2D, Rectangle, AutoTiling.ConnectsTo, Color, Single, Nullable(Of Vector2), Nullable(Of Vector2), Single) references: +- uid: MLEM.Misc.AutoTiling.DrawAutoTile(Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Graphics.Texture2D,Microsoft.Xna.Framework.Rectangle,MLEM.Misc.AutoTiling.ConnectsTo,Microsoft.Xna.Framework.Color,System.Single,System.Nullable{Microsoft.Xna.Framework.Vector2},System.Nullable{Microsoft.Xna.Framework.Vector2},System.Single) + commentId: M:MLEM.Misc.AutoTiling.DrawAutoTile(Microsoft.Xna.Framework.Graphics.SpriteBatch,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Graphics.Texture2D,Microsoft.Xna.Framework.Rectangle,MLEM.Misc.AutoTiling.ConnectsTo,Microsoft.Xna.Framework.Color,System.Single,System.Nullable{Microsoft.Xna.Framework.Vector2},System.Nullable{Microsoft.Xna.Framework.Vector2},System.Single) + isExternal: true - uid: MLEM.Misc commentId: N:MLEM.Misc name: MLEM.Misc diff --git a/Docs/api/MLEM.Misc.Direction2.yml b/Docs/api/MLEM.Misc.Direction2.yml index 29ad4cc..c649eb4 100644 --- a/Docs/api/MLEM.Misc.Direction2.yml +++ b/Docs/api/MLEM.Misc.Direction2.yml @@ -28,10 +28,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Direction2 path: ../MLEM/Misc/Direction2.cs - startLine: 7 + startLine: 11 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nAn enum that represents two-dimensional directions.\nBoth straight and diagonal directions are supported.\n" + example: [] syntax: content: public enum Direction2 content.vb: Public Enum Direction2 @@ -67,10 +69,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Up path: ../MLEM/Misc/Direction2.cs - startLine: 9 + startLine: 16 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe up direction, or -y.\n" + example: [] syntax: content: Up = 0 return: @@ -99,10 +103,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Right path: ../MLEM/Misc/Direction2.cs - startLine: 10 + startLine: 20 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe right direction, or +x.\n" + example: [] syntax: content: Right = 1 return: @@ -131,10 +137,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Down path: ../MLEM/Misc/Direction2.cs - startLine: 11 + startLine: 24 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe down direction, or +y.\n" + example: [] syntax: content: Down = 2 return: @@ -163,10 +171,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Left path: ../MLEM/Misc/Direction2.cs - startLine: 12 + startLine: 28 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe left direction, or -x.\n" + example: [] syntax: content: Left = 3 return: @@ -195,10 +205,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: UpRight path: ../MLEM/Misc/Direction2.cs - startLine: 14 + startLine: 33 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe up and right direction, or +x, -y.\n" + example: [] syntax: content: UpRight = 4 return: @@ -227,10 +239,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DownRight path: ../MLEM/Misc/Direction2.cs - startLine: 15 + startLine: 37 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe down and right direction, or +x, +y.\n" + example: [] syntax: content: DownRight = 5 return: @@ -259,10 +273,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DownLeft path: ../MLEM/Misc/Direction2.cs - startLine: 16 + startLine: 41 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe down and left direction, or -x, +y.\n" + example: [] syntax: content: DownLeft = 6 return: @@ -291,10 +307,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: UpLeft path: ../MLEM/Misc/Direction2.cs - startLine: 17 + startLine: 45 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe up and left direction, or -x, -y.\n" + example: [] syntax: content: UpLeft = 7 return: @@ -323,10 +341,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: None path: ../MLEM/Misc/Direction2.cs - startLine: 19 + startLine: 50 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nNo direction.\n" + example: [] syntax: content: None = 8 return: diff --git a/Docs/api/MLEM.Misc.Direction2Helper.yml b/Docs/api/MLEM.Misc.Direction2Helper.yml index fd07883..f9cdb59 100644 --- a/Docs/api/MLEM.Misc.Direction2Helper.yml +++ b/Docs/api/MLEM.Misc.Direction2Helper.yml @@ -31,10 +31,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Direction2Helper path: ../MLEM/Misc/Direction2.cs - startLine: 23 + startLine: 57 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA set of helper and extension methods for dealing with \n" + example: [] syntax: content: public static class Direction2Helper content.vb: Public Module Direction2Helper @@ -73,10 +75,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: All path: ../MLEM/Misc/Direction2.cs - startLine: 25 + startLine: 62 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nAll enum values\n" + example: [] syntax: content: public static readonly Direction2[] All return: @@ -108,10 +112,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Adjacent path: ../MLEM/Misc/Direction2.cs - startLine: 26 + startLine: 66 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe through directions\n" + example: [] syntax: content: public static readonly Direction2[] Adjacent return: @@ -143,10 +149,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Diagonals path: ../MLEM/Misc/Direction2.cs - startLine: 27 + startLine: 70 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe through directions\n" + example: [] syntax: content: public static readonly Direction2[] Diagonals return: @@ -178,10 +186,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: AllExceptNone path: ../MLEM/Misc/Direction2.cs - startLine: 28 + startLine: 74 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nAll directions except \n" + example: [] syntax: content: public static readonly Direction2[] AllExceptNone return: @@ -214,17 +224,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsAdjacent path: ../MLEM/Misc/Direction2.cs - startLine: 30 + startLine: 82 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns if the given direction is considered an "adjacent" direction.\nAn adjacent direction is one that is not a diagonal.\n" + example: [] syntax: content: public static bool IsAdjacent(this Direction2 dir) parameters: - id: dir type: MLEM.Misc.Direction2 + description: The direction to query return: type: System.Boolean + description: Whether the direction is adjacent content.vb: >- @@ -255,17 +269,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsDiagonal path: ../MLEM/Misc/Direction2.cs - startLine: 34 + startLine: 91 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns if the given direction is considered a diagonal direction.\n" + example: [] syntax: content: public static bool IsDiagonal(this Direction2 dir) parameters: - id: dir type: MLEM.Misc.Direction2 + description: The direction to query return: type: System.Boolean + description: Whether the direction is diagonal content.vb: >- @@ -296,17 +314,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: Offset path: ../MLEM/Misc/Direction2.cs - startLine: 38 + startLine: 101 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns the directional offset of a given direction.\nThe offset direction will be exactly one unit in each axis that the direction represents.\n" + example: [] syntax: content: public static Point Offset(this Direction2 dir) parameters: - id: dir type: MLEM.Misc.Direction2 + description: The direction whose offset to query return: type: Microsoft.Xna.Framework.Point + description: The direction's offset content.vb: >- @@ -337,17 +359,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: Offsets path: ../MLEM/Misc/Direction2.cs - startLine: 61 + startLine: 129 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nMaps each direction in the given enumerable of directions to its .\n" + example: [] syntax: content: public static IEnumerable Offsets(this IEnumerable directions) parameters: - id: directions type: System.Collections.Generic.IEnumerable{MLEM.Misc.Direction2} + description: The direction enumerable return: type: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Point} + description: The directions' offsets, in the same order as the input directions. content.vb: >- @@ -381,17 +407,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: Opposite path: ../MLEM/Misc/Direction2.cs - startLine: 66 + startLine: 141 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns the opposite of the given direction.\nFor "adjacent" directions, this is the direction that points into the same axis, but the opposite sign.\nFor diagonal directions, this is the direction that points into the opposite of both the x and y axis.\n" + example: [] syntax: content: public static Direction2 Opposite(this Direction2 dir) parameters: - id: dir type: MLEM.Misc.Direction2 + description: The direction whose opposite to get return: type: MLEM.Misc.Direction2 + description: The opposite of the direction content.vb: >- @@ -422,17 +452,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: Angle path: ../MLEM/Misc/Direction2.cs - startLine: 89 + startLine: 169 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns the angle of the direction in radians, where has an angle of 0.\n" + example: [] syntax: content: public static float Angle(this Direction2 dir) parameters: - id: dir type: MLEM.Misc.Direction2 + description: The direction whose angle to get return: type: System.Single + description: The direction's angle content.vb: >- @@ -463,19 +497,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: RotateCw path: ../MLEM/Misc/Direction2.cs - startLine: 94 + startLine: 180 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nRotates the given direction clockwise and returns the resulting direction.\n" + example: [] syntax: content: public static Direction2 RotateCw(this Direction2 dir, bool fortyFiveDegrees = false) parameters: - id: dir type: MLEM.Misc.Direction2 + description: The direction to rotate - id: fortyFiveDegrees type: System.Boolean + description: Whether to rotate by 45 degrees. If this is false, the rotation is 90 degrees instead. return: type: MLEM.Misc.Direction2 + description: The rotated direction content.vb: >- @@ -506,19 +545,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: RotateCcw path: ../MLEM/Misc/Direction2.cs - startLine: 117 + startLine: 209 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nRotates the given direction counter-clockwise and returns the resulting direction.\n" + example: [] syntax: content: public static Direction2 RotateCcw(this Direction2 dir, bool fortyFiveDegrees = false) parameters: - id: dir type: MLEM.Misc.Direction2 + description: The direction to rotate counter-clockwise - id: fortyFiveDegrees type: System.Boolean + description: Whether to rotate by 45 degrees. If this is false, the rotation is 90 degrees instead. return: type: MLEM.Misc.Direction2 + description: The rotated direction content.vb: >- @@ -531,6 +575,12 @@ items: - Public - Shared references: +- uid: MLEM.Misc.Direction2 + commentId: T:MLEM.Misc.Direction2 + parent: MLEM.Misc + name: Direction2 + nameWithType: Direction2 + fullName: MLEM.Misc.Direction2 - uid: MLEM.Misc commentId: N:MLEM.Misc name: MLEM.Misc @@ -852,17 +902,26 @@ references: - name: () nameWithType: () fullName: () +- uid: MLEM.Misc.Direction2.Up + commentId: F:MLEM.Misc.Direction2.Up + isExternal: true +- uid: MLEM.Misc.Direction2.Left + commentId: F:MLEM.Misc.Direction2.Left + isExternal: true +- uid: MLEM.Misc.Direction2.UpRight + commentId: F:MLEM.Misc.Direction2.UpRight + isExternal: true +- uid: MLEM.Misc.Direction2.UpLeft + commentId: F:MLEM.Misc.Direction2.UpLeft + isExternal: true +- uid: MLEM.Misc.Direction2.None + commentId: F:MLEM.Misc.Direction2.None + isExternal: true - uid: MLEM.Misc.Direction2Helper.IsAdjacent* commentId: Overload:MLEM.Misc.Direction2Helper.IsAdjacent name: IsAdjacent nameWithType: Direction2Helper.IsAdjacent fullName: MLEM.Misc.Direction2Helper.IsAdjacent -- uid: MLEM.Misc.Direction2 - commentId: T:MLEM.Misc.Direction2 - parent: MLEM.Misc - name: Direction2 - nameWithType: Direction2 - fullName: MLEM.Misc.Direction2 - uid: System.Boolean commentId: T:System.Boolean parent: System @@ -893,6 +952,41 @@ references: name: Microsoft.Xna.Framework nameWithType: Microsoft.Xna.Framework fullName: Microsoft.Xna.Framework +- uid: MLEM.Misc.Direction2Helper.Offset(MLEM.Misc.Direction2) + commentId: M:MLEM.Misc.Direction2Helper.Offset(MLEM.Misc.Direction2) + name: Offset(Direction2) + nameWithType: Direction2Helper.Offset(Direction2) + fullName: MLEM.Misc.Direction2Helper.Offset(MLEM.Misc.Direction2) + spec.csharp: + - uid: MLEM.Misc.Direction2Helper.Offset(MLEM.Misc.Direction2) + name: Offset + nameWithType: Direction2Helper.Offset + fullName: MLEM.Misc.Direction2Helper.Offset + - name: ( + nameWithType: ( + fullName: ( + - uid: MLEM.Misc.Direction2 + name: Direction2 + nameWithType: Direction2 + fullName: MLEM.Misc.Direction2 + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Misc.Direction2Helper.Offset(MLEM.Misc.Direction2) + name: Offset + nameWithType: Direction2Helper.Offset + fullName: MLEM.Misc.Direction2Helper.Offset + - name: ( + nameWithType: ( + fullName: ( + - uid: MLEM.Misc.Direction2 + name: Direction2 + nameWithType: Direction2 + fullName: MLEM.Misc.Direction2 + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Misc.Direction2Helper.Offsets* commentId: Overload:MLEM.Misc.Direction2Helper.Offsets name: Offsets @@ -1034,6 +1128,9 @@ references: name: Opposite nameWithType: Direction2Helper.Opposite fullName: MLEM.Misc.Direction2Helper.Opposite +- uid: MLEM.Misc.Direction2.Right + commentId: F:MLEM.Misc.Direction2.Right + isExternal: true - uid: MLEM.Misc.Direction2Helper.Angle* commentId: Overload:MLEM.Misc.Direction2Helper.Angle name: Angle diff --git a/Docs/api/MLEM.Misc.EnumHelper.yml b/Docs/api/MLEM.Misc.EnumHelper.yml index 4a7d452..a30620f 100644 --- a/Docs/api/MLEM.Misc.EnumHelper.yml +++ b/Docs/api/MLEM.Misc.EnumHelper.yml @@ -22,10 +22,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: EnumHelper path: ../MLEM/Misc/EnumHelper.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA helper class that allows easier usage of values.\n" + example: [] syntax: content: public static class EnumHelper content.vb: Public Module EnumHelper @@ -64,10 +66,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Buttons path: ../MLEM/Misc/EnumHelper.cs - startLine: 8 + startLine: 14 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nAll values of the enum.\n" + example: [] syntax: content: public static readonly Buttons[] Buttons return: @@ -99,10 +103,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Keys path: ../MLEM/Misc/EnumHelper.cs - startLine: 9 + startLine: 18 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nAll values of the enum.\n" + example: [] syntax: content: public static readonly Keys[] Keys return: @@ -134,16 +140,20 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetValues path: ../MLEM/Misc/EnumHelper.cs - startLine: 11 + startLine: 25 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns all of the values of the given enum type.\n" + example: [] syntax: content: public static IEnumerable GetValues() typeParameters: - id: T + description: The type whose enum to get return: type: System.Collections.Generic.IEnumerable{{T}} + description: An enumerable of the values of the enum, in declaration order. content.vb: Public Shared Function GetValues(Of T) As IEnumerable(Of T) overload: MLEM.Misc.EnumHelper.GetValues* nameWithType.vb: EnumHelper.GetValues(Of T)() @@ -156,6 +166,9 @@ items: fullName.vb: MLEM.Misc.EnumHelper.GetValues(Of T)() name.vb: GetValues(Of T)() references: +- uid: System.Enum + commentId: T:System.Enum + isExternal: true - uid: MLEM.Misc commentId: N:MLEM.Misc name: MLEM.Misc @@ -453,6 +466,9 @@ references: name: System nameWithType: System fullName: System +- uid: MLEM.Misc.EnumHelper.Buttons + commentId: F:MLEM.Misc.EnumHelper.Buttons + isExternal: true - uid: Microsoft.Xna.Framework.Input.Buttons[] isExternal: true name: Buttons[] @@ -479,6 +495,9 @@ references: - name: () nameWithType: () fullName: () +- uid: MLEM.Misc.EnumHelper.Keys + commentId: F:MLEM.Misc.EnumHelper.Keys + isExternal: true - uid: Microsoft.Xna.Framework.Input.Keys[] isExternal: true name: Keys[] diff --git a/Docs/api/MLEM.Misc.GenericDataHolder.yml b/Docs/api/MLEM.Misc.GenericDataHolder.yml index 62edb30..a571b50 100644 --- a/Docs/api/MLEM.Misc.GenericDataHolder.yml +++ b/Docs/api/MLEM.Misc.GenericDataHolder.yml @@ -22,10 +22,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: GenericDataHolder path: ../MLEM/Misc/GenericDataHolder.cs - startLine: 4 + startLine: 8 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nRepresents an object that can hold generic key-value based data.\nA lot of MLEM components extend this class to allow for users to add additional data to them easily.\n" + example: [] syntax: content: public class GenericDataHolder content.vb: Public Class GenericDataHolder @@ -79,17 +81,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: SetData path: ../MLEM/Misc/GenericDataHolder.cs - startLine: 8 + startLine: 17 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nStore a piece of generic data on this object.\n" + example: [] syntax: content: public void SetData(string key, object data) parameters: - id: key type: System.String + description: The key to store the data by - id: data type: System.Object + description: The data to store in the object content.vb: Public Sub SetData(key As String, data As Object) overload: MLEM.Misc.GenericDataHolder.SetData* modifiers.csharp: @@ -114,19 +120,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetData path: ../MLEM/Misc/GenericDataHolder.cs - startLine: 19 + startLine: 34 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns a piece of generic data of the given type on this object.\n" + example: [] syntax: content: public T GetData(string key) parameters: - id: key type: System.String + description: The key that the data is stored by typeParameters: - id: T + description: The type of the data stored return: type: '{T}' + description: The data, or default if it doesn't exist content.vb: Public Function GetData(Of T)(key As String) As T overload: MLEM.Misc.GenericDataHolder.GetData* nameWithType.vb: GenericDataHolder.GetData(Of T)(String) @@ -154,14 +165,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetDataKeys path: ../MLEM/Misc/GenericDataHolder.cs - startLine: 25 + startLine: 44 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nReturns all of the generic data that this object stores.\n" + example: [] syntax: content: public IReadOnlyCollection GetDataKeys() return: type: System.Collections.Generic.IReadOnlyCollection{System.String} + description: The generic data on this object content.vb: Public Function GetDataKeys As IReadOnlyCollection(Of String) overload: MLEM.Misc.GenericDataHolder.GetDataKeys* modifiers.csharp: diff --git a/Docs/api/MLEM.Misc.Padding.yml b/Docs/api/MLEM.Misc.Padding.yml index 6f687a0..9114d71 100644 --- a/Docs/api/MLEM.Misc.Padding.yml +++ b/Docs/api/MLEM.Misc.Padding.yml @@ -35,10 +35,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Padding path: ../MLEM/Misc/Padding.cs - startLine: 3 + startLine: 7 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nRepresents a generic padding.\nA padding is an object of data that stores an offset from each side of a rectangle or square.\n" + example: [] syntax: content: public struct Padding content.vb: Public Structure Padding @@ -71,10 +73,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Left path: ../MLEM/Misc/Padding.cs - startLine: 5 + startLine: 12 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe amount of padding on the left side\n" + example: [] syntax: content: public float Left return: @@ -102,10 +106,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Right path: ../MLEM/Misc/Padding.cs - startLine: 6 + startLine: 16 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe amount of padding on the right side\n" + example: [] syntax: content: public float Right return: @@ -133,10 +139,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Top path: ../MLEM/Misc/Padding.cs - startLine: 7 + startLine: 20 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe amount of padding on the top side\n" + example: [] syntax: content: public float Top return: @@ -164,10 +172,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Bottom path: ../MLEM/Misc/Padding.cs - startLine: 8 + startLine: 24 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe amount of padding on the bottom side\n" + example: [] syntax: content: public float Bottom return: @@ -195,10 +205,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Width path: ../MLEM/Misc/Padding.cs - startLine: 9 + startLine: 28 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe total width of this padding, a sum of the left and right padding.\n" + example: [] syntax: content: public float Width { get; } parameters: [] @@ -230,10 +242,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Height path: ../MLEM/Misc/Padding.cs - startLine: 10 + startLine: 32 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe total height of this padding, a sum of the top and bottom padding.\n" + example: [] syntax: content: public float Height { get; } parameters: [] @@ -265,21 +279,27 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Misc/Padding.cs - startLine: 12 + startLine: 41 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nCreate a new padding with the specified borders.\n" + example: [] syntax: content: public Padding(float left, float right, float top, float bottom) parameters: - id: left type: System.Single + description: The amount of padding on the left side - id: right type: System.Single + description: The amount of padding on the right side - id: top type: System.Single + description: The amount of padding on the top side - id: bottom type: System.Single + description: The amount of padding on the bottom side content.vb: Public Sub New(left As Single, right As Single, top As Single, bottom As Single) overload: MLEM.Misc.Padding.#ctor* modifiers.csharp: @@ -304,17 +324,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Implicit path: ../MLEM/Misc/Padding.cs - startLine: 19 + startLine: 54 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nImplicitly creates a padding from the given two-dimensional vector.\nThe left and right padding will both be the vector's x value, and the top and bottom padding will both be the vector's y value.\n" + example: [] syntax: content: public static implicit operator Padding(Vector2 vec) parameters: - id: vec type: Microsoft.Xna.Framework.Vector2 + description: The vector to convert return: type: MLEM.Misc.Padding + description: A padding based on the vector's values content.vb: Public Shared Widening Operator CType(vec As Vector2) As Padding overload: MLEM.Misc.Padding.op_Implicit* nameWithType.vb: Padding.Widening(Vector2 to Padding) @@ -344,10 +368,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Multiply path: ../MLEM/Misc/Padding.cs - startLine: 23 + startLine: 61 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nScales a padding by a scalar.\n" + example: [] syntax: content: public static Padding operator *(Padding p, float scale) parameters: @@ -383,10 +409,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Addition path: ../MLEM/Misc/Padding.cs - startLine: 27 + startLine: 68 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nAdds two paddings together in a memberwise fashion.\n" + example: [] syntax: content: public static Padding operator +(Padding left, Padding right) parameters: @@ -422,10 +450,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Subtraction path: ../MLEM/Misc/Padding.cs - startLine: 31 + startLine: 75 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nSubtracts two paddings in a memberwise fashion.\n" + example: [] syntax: content: public static Padding operator -(Padding left, Padding right) parameters: @@ -461,10 +491,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Equality path: ../MLEM/Misc/Padding.cs - startLine: 35 + startLine: 80 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public static bool operator ==(Padding left, Padding right) parameters: @@ -500,10 +531,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Inequality path: ../MLEM/Misc/Padding.cs - startLine: 39 + startLine: 85 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public static bool operator !=(Padding left, Padding right) parameters: @@ -539,10 +571,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Misc/Padding.cs - startLine: 43 + startLine: 90 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public bool Equals(Padding other) parameters: @@ -574,10 +607,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Misc/Padding.cs - startLine: 47 + startLine: 95 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override bool Equals(object obj) parameters: @@ -612,10 +646,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetHashCode path: ../MLEM/Misc/Padding.cs - startLine: 51 + startLine: 100 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override int GetHashCode() return: @@ -895,6 +930,9 @@ references: name: Subtraction nameWithType: Padding.Subtraction fullName: MLEM.Misc.Padding.Subtraction +- uid: MLEM.Misc.Padding.Equals(MLEM.Misc.Padding) + commentId: M:MLEM.Misc.Padding.Equals(MLEM.Misc.Padding) + isExternal: true - uid: MLEM.Misc.Padding.op_Equality* commentId: Overload:MLEM.Misc.Padding.op_Equality name: Equality @@ -912,6 +950,9 @@ references: name: Inequality nameWithType: Padding.Inequality fullName: MLEM.Misc.Padding.Inequality +- uid: MLEM.Misc.Padding.Equals(System.Object) + commentId: M:MLEM.Misc.Padding.Equals(System.Object) + isExternal: true - uid: MLEM.Misc.Padding.Equals* commentId: Overload:MLEM.Misc.Padding.Equals name: Equals diff --git a/Docs/api/MLEM.Misc.RectangleF.yml b/Docs/api/MLEM.Misc.RectangleF.yml index 34637dc..185b067 100644 --- a/Docs/api/MLEM.Misc.RectangleF.yml +++ b/Docs/api/MLEM.Misc.RectangleF.yml @@ -53,10 +53,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RectangleF path: ../MLEM/Misc/RectangleF.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nRepresents a float-based version of \n" + example: [] syntax: content: >- [DataContract] @@ -66,6 +68,7 @@ items: Public Structure RectangleF + Implements IEquatable(Of RectangleF) implements: - System.IEquatable{MLEM.Misc.RectangleF} @@ -106,10 +109,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Empty path: ../MLEM/Misc/RectangleF.cs - startLine: 9 + startLine: 15 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe empty rectangle, with an x, y, width and height of 0.\n" + example: [] syntax: content: public static RectangleF Empty { get; } parameters: [] @@ -143,10 +148,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: X path: ../MLEM/Misc/RectangleF.cs - startLine: 12 + startLine: 21 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe x position of the top left corner of this rectangle.\n" + example: [] syntax: content: >- [DataMember] @@ -184,10 +191,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Y path: ../MLEM/Misc/RectangleF.cs - startLine: 14 + startLine: 26 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe y position of the top left corner of this rectangle.\n" + example: [] syntax: content: >- [DataMember] @@ -225,10 +234,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Width path: ../MLEM/Misc/RectangleF.cs - startLine: 16 + startLine: 31 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe width of this rectangle.\n" + example: [] syntax: content: >- [DataMember] @@ -266,10 +277,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Height path: ../MLEM/Misc/RectangleF.cs - startLine: 18 + startLine: 36 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe height of this rectangle.\n" + example: [] syntax: content: >- [DataMember] @@ -307,10 +320,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Left path: ../MLEM/Misc/RectangleF.cs - startLine: 20 + startLine: 39 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public float Left { get; } parameters: [] @@ -342,10 +356,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Right path: ../MLEM/Misc/RectangleF.cs - startLine: 21 + startLine: 43 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe x position of the bottom right corner of this rectangle.\n" + example: [] syntax: content: public float Right { get; } parameters: [] @@ -377,10 +393,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Top path: ../MLEM/Misc/RectangleF.cs - startLine: 22 + startLine: 45 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public float Top { get; } parameters: [] @@ -412,10 +429,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Bottom path: ../MLEM/Misc/RectangleF.cs - startLine: 23 + startLine: 49 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe y position of the bottom right corner of this rectangle.\n" + example: [] syntax: content: public float Bottom { get; } parameters: [] @@ -447,10 +466,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: IsEmpty path: ../MLEM/Misc/RectangleF.cs - startLine: 24 + startLine: 54 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA boolean that is true if this rectangle is empty.\nA rectangle is considered empty if the width or height is 0.\n" + example: [] syntax: content: public bool IsEmpty { get; } parameters: [] @@ -482,10 +503,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Location path: ../MLEM/Misc/RectangleF.cs - startLine: 26 + startLine: 59 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe top left corner of this rectangle\n" + example: [] syntax: content: public Vector2 Location { get; set; } parameters: [] @@ -517,10 +540,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Size path: ../MLEM/Misc/RectangleF.cs - startLine: 33 + startLine: 69 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe size, that is, the width and height of this rectangle.\n" + example: [] syntax: content: public Vector2 Size { get; set; } parameters: [] @@ -552,10 +577,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Center path: ../MLEM/Misc/RectangleF.cs - startLine: 40 + startLine: 79 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe center of this rectangle, based on the top left corner and the size.\n" + example: [] syntax: content: public Vector2 Center { get; } parameters: [] @@ -587,21 +614,27 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Misc/RectangleF.cs - startLine: 42 + startLine: 88 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nCreates a new rectangle with the specified location and size\n" + example: [] syntax: content: public RectangleF(float x, float y, float width, float height) parameters: - id: x type: System.Single + description: The x coordinate of the top left corner of the rectangle - id: y type: System.Single + description: The y coordinate of the top left corner of the rectangle - id: width type: System.Single + description: The width of the rectangle - id: height type: System.Single + description: The height of the rectangle content.vb: Public Sub New(x As Single, y As Single, width As Single, height As Single) overload: MLEM.Misc.RectangleF.#ctor* modifiers.csharp: @@ -626,17 +659,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Misc/RectangleF.cs - startLine: 49 + startLine: 100 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nCreates a new rectangle with the specified location and size vectors\n" + example: [] syntax: content: public RectangleF(Vector2 location, Vector2 size) parameters: - id: location type: Microsoft.Xna.Framework.Vector2 + description: The top left corner of the rectangle - id: size type: Microsoft.Xna.Framework.Vector2 + description: The size of the rectangle, where x represents width and the y represents height content.vb: Public Sub New(location As Vector2, size As Vector2) overload: MLEM.Misc.RectangleF.#ctor* modifiers.csharp: @@ -661,19 +698,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: FromCorners path: ../MLEM/Misc/RectangleF.cs - startLine: 56 + startLine: 114 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nCreates a new rectangle based on two corners that form a bounding box.\nThe resulting rectangle will encompass both corners as well as all of the space between them.\n" + example: [] syntax: content: public static RectangleF FromCorners(Vector2 corner1, Vector2 corner2) parameters: - id: corner1 type: Microsoft.Xna.Framework.Vector2 + description: The first corner to use - id: corner2 type: Microsoft.Xna.Framework.Vector2 + description: The second corner to use return: type: MLEM.Misc.RectangleF + description: '' content.vb: Public Shared Function FromCorners(corner1 As Vector2, corner2 As Vector2) As RectangleF overload: MLEM.Misc.RectangleF.FromCorners* modifiers.csharp: @@ -700,17 +742,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Explicit path: ../MLEM/Misc/RectangleF.cs - startLine: 64 + startLine: 127 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nConverts a float-based rectangle to an int-based rectangle, flooring each value in the process.\n" + example: [] syntax: content: public static explicit operator Rectangle(RectangleF rect) parameters: - id: rect type: MLEM.Misc.RectangleF + description: The rectangle to convert return: type: Microsoft.Xna.Framework.Rectangle + description: The resulting rectangle content.vb: Public Shared Narrowing Operator CType(rect As RectangleF) As Rectangle overload: MLEM.Misc.RectangleF.op_Explicit* nameWithType.vb: RectangleF.Narrowing(RectangleF to Rectangle) @@ -740,17 +786,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Explicit path: ../MLEM/Misc/RectangleF.cs - startLine: 68 + startLine: 136 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nConverts an int-based rectangle to a float-based rectangle.\n" + example: [] syntax: content: public static explicit operator RectangleF(Rectangle rect) parameters: - id: rect type: Microsoft.Xna.Framework.Rectangle + description: The rectangle to convert return: type: MLEM.Misc.RectangleF + description: The resulting rectangle content.vb: Public Shared Narrowing Operator CType(rect As Rectangle) As RectangleF overload: MLEM.Misc.RectangleF.op_Explicit* nameWithType.vb: RectangleF.Narrowing(Rectangle to RectangleF) @@ -780,10 +830,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Equality path: ../MLEM/Misc/RectangleF.cs - startLine: 72 + startLine: 141 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public static bool operator ==(RectangleF a, RectangleF b) parameters: @@ -819,10 +870,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: op_Inequality path: ../MLEM/Misc/RectangleF.cs - startLine: 76 + startLine: 146 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public static bool operator !=(RectangleF a, RectangleF b) parameters: @@ -858,10 +910,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Contains path: ../MLEM/Misc/RectangleF.cs - startLine: 80 + startLine: 151 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public bool Contains(float x, float y) parameters: @@ -895,10 +948,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Contains path: ../MLEM/Misc/RectangleF.cs - startLine: 84 + startLine: 156 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public bool Contains(Vector2 value) parameters: @@ -930,10 +984,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Contains path: ../MLEM/Misc/RectangleF.cs - startLine: 88 + startLine: 161 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public bool Contains(RectangleF value) parameters: @@ -965,10 +1020,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Misc/RectangleF.cs - startLine: 92 + startLine: 166 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override bool Equals(object obj) parameters: @@ -1003,10 +1059,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Misc/RectangleF.cs - startLine: 96 + startLine: 171 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public bool Equals(RectangleF other) parameters: @@ -1040,10 +1097,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetHashCode path: ../MLEM/Misc/RectangleF.cs - startLine: 100 + startLine: 176 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override int GetHashCode() return: @@ -1075,10 +1133,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Inflate path: ../MLEM/Misc/RectangleF.cs - startLine: 104 + startLine: 181 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public void Inflate(float horizontalAmount, float verticalAmount) parameters: @@ -1110,10 +1169,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Intersects path: ../MLEM/Misc/RectangleF.cs - startLine: 111 + startLine: 189 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public bool Intersects(RectangleF value) parameters: @@ -1145,10 +1205,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Intersect path: ../MLEM/Misc/RectangleF.cs - startLine: 115 + startLine: 194 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public static RectangleF Intersect(RectangleF value1, RectangleF value2) parameters: @@ -1184,10 +1245,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Offset path: ../MLEM/Misc/RectangleF.cs - startLine: 127 + startLine: 207 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public void Offset(float offsetX, float offsetY) parameters: @@ -1219,10 +1281,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Offset path: ../MLEM/Misc/RectangleF.cs - startLine: 132 + startLine: 213 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public void Offset(Vector2 amount) parameters: @@ -1252,10 +1315,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: ToString path: ../MLEM/Misc/RectangleF.cs - startLine: 137 + startLine: 219 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override string ToString() return: @@ -1287,10 +1351,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Union path: ../MLEM/Misc/RectangleF.cs - startLine: 141 + startLine: 224 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public static RectangleF Union(RectangleF value1, RectangleF value2) parameters: @@ -1326,10 +1391,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Deconstruct path: ../MLEM/Misc/RectangleF.cs - startLine: 147 + startLine: 231 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public void Deconstruct(out float x, out float y, out float width, out float height) parameters: @@ -1351,6 +1417,13 @@ items: fullName.vb: MLEM.Misc.RectangleF.Deconstruct(ByRef System.Single, ByRef System.Single, ByRef System.Single, ByRef System.Single) name.vb: Deconstruct(ByRef Single, ByRef Single, ByRef Single, ByRef Single) references: +- uid: Microsoft.Xna.Framework.Rectangle + commentId: T:Microsoft.Xna.Framework.Rectangle + parent: Microsoft.Xna.Framework + isExternal: true + name: Rectangle + nameWithType: Rectangle + fullName: Microsoft.Xna.Framework.Rectangle - uid: MLEM.Misc commentId: N:MLEM.Misc name: MLEM.Misc @@ -1687,6 +1760,12 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework + commentId: N:Microsoft.Xna.Framework + isExternal: true + name: Microsoft.Xna.Framework + nameWithType: Microsoft.Xna.Framework + fullName: Microsoft.Xna.Framework - uid: System.IEquatable`1 commentId: T:System.IEquatable`1 isExternal: true @@ -1967,6 +2046,9 @@ references: name: Single nameWithType: Single fullName: System.Single +- uid: MLEM.Misc.RectangleF.X + commentId: F:MLEM.Misc.RectangleF.X + isExternal: true - uid: MLEM.Misc.RectangleF.Left* commentId: Overload:MLEM.Misc.RectangleF.Left name: Left @@ -1977,6 +2059,9 @@ references: name: Right nameWithType: RectangleF.Right fullName: MLEM.Misc.RectangleF.Right +- uid: MLEM.Misc.RectangleF.Y + commentId: F:MLEM.Misc.RectangleF.Y + isExternal: true - uid: MLEM.Misc.RectangleF.Top* commentId: Overload:MLEM.Misc.RectangleF.Top name: Top @@ -2011,12 +2096,6 @@ references: name: Vector2 nameWithType: Vector2 fullName: Microsoft.Xna.Framework.Vector2 -- uid: Microsoft.Xna.Framework - commentId: N:Microsoft.Xna.Framework - isExternal: true - name: Microsoft.Xna.Framework - nameWithType: Microsoft.Xna.Framework - fullName: Microsoft.Xna.Framework - uid: MLEM.Misc.RectangleF.Size* commentId: Overload:MLEM.Misc.RectangleF.Size name: Size @@ -2045,13 +2124,9 @@ references: nameWithType.vb: RectangleF.Narrowing fullName.vb: MLEM.Misc.RectangleF.Narrowing name.vb: Narrowing -- uid: Microsoft.Xna.Framework.Rectangle - commentId: T:Microsoft.Xna.Framework.Rectangle - parent: Microsoft.Xna.Framework +- uid: MLEM.Misc.RectangleF.Equals(MLEM.Misc.RectangleF) + commentId: M:MLEM.Misc.RectangleF.Equals(MLEM.Misc.RectangleF) isExternal: true - name: Rectangle - nameWithType: Rectangle - fullName: Microsoft.Xna.Framework.Rectangle - uid: MLEM.Misc.RectangleF.op_Equality* commentId: Overload:MLEM.Misc.RectangleF.op_Equality name: Equality @@ -2062,11 +2137,20 @@ references: name: Inequality nameWithType: RectangleF.Inequality fullName: MLEM.Misc.RectangleF.Inequality +- uid: Microsoft.Xna.Framework.Rectangle.Contains(System.Single,System.Single) + commentId: M:Microsoft.Xna.Framework.Rectangle.Contains(System.Single,System.Single) + isExternal: true - uid: MLEM.Misc.RectangleF.Contains* commentId: Overload:MLEM.Misc.RectangleF.Contains name: Contains nameWithType: RectangleF.Contains fullName: MLEM.Misc.RectangleF.Contains +- uid: Microsoft.Xna.Framework.Rectangle.Contains(Microsoft.Xna.Framework.Vector2) + commentId: M:Microsoft.Xna.Framework.Rectangle.Contains(Microsoft.Xna.Framework.Vector2) + isExternal: true +- uid: Microsoft.Xna.Framework.Rectangle.Contains(Microsoft.Xna.Framework.Rectangle) + commentId: M:Microsoft.Xna.Framework.Rectangle.Contains(Microsoft.Xna.Framework.Rectangle) + isExternal: true - uid: System.ValueType.Equals(System.Object) commentId: M:System.ValueType.Equals(System.Object) parent: System.ValueType @@ -2242,26 +2326,41 @@ references: name: Int32 nameWithType: Int32 fullName: System.Int32 +- uid: Microsoft.Xna.Framework.Rectangle.Inflate(System.Single,System.Single) + commentId: M:Microsoft.Xna.Framework.Rectangle.Inflate(System.Single,System.Single) + isExternal: true - uid: MLEM.Misc.RectangleF.Inflate* commentId: Overload:MLEM.Misc.RectangleF.Inflate name: Inflate nameWithType: RectangleF.Inflate fullName: MLEM.Misc.RectangleF.Inflate +- uid: Microsoft.Xna.Framework.Rectangle.Intersects(Microsoft.Xna.Framework.Rectangle) + commentId: M:Microsoft.Xna.Framework.Rectangle.Intersects(Microsoft.Xna.Framework.Rectangle) + isExternal: true - uid: MLEM.Misc.RectangleF.Intersects* commentId: Overload:MLEM.Misc.RectangleF.Intersects name: Intersects nameWithType: RectangleF.Intersects fullName: MLEM.Misc.RectangleF.Intersects +- uid: Microsoft.Xna.Framework.Rectangle.Intersect(Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Rectangle) + commentId: M:Microsoft.Xna.Framework.Rectangle.Intersect(Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Rectangle) + isExternal: true - uid: MLEM.Misc.RectangleF.Intersect* commentId: Overload:MLEM.Misc.RectangleF.Intersect name: Intersect nameWithType: RectangleF.Intersect fullName: MLEM.Misc.RectangleF.Intersect +- uid: Microsoft.Xna.Framework.Rectangle.Offset(System.Single,System.Single) + commentId: M:Microsoft.Xna.Framework.Rectangle.Offset(System.Single,System.Single) + isExternal: true - uid: MLEM.Misc.RectangleF.Offset* commentId: Overload:MLEM.Misc.RectangleF.Offset name: Offset nameWithType: RectangleF.Offset fullName: MLEM.Misc.RectangleF.Offset +- uid: Microsoft.Xna.Framework.Rectangle.Offset(Microsoft.Xna.Framework.Vector2) + commentId: M:Microsoft.Xna.Framework.Rectangle.Offset(Microsoft.Xna.Framework.Vector2) + isExternal: true - uid: System.ValueType.ToString commentId: M:System.ValueType.ToString parent: System.ValueType @@ -2305,11 +2404,17 @@ references: name: String nameWithType: String fullName: System.String +- uid: Microsoft.Xna.Framework.Rectangle.Union(Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Rectangle) + commentId: M:Microsoft.Xna.Framework.Rectangle.Union(Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Rectangle) + isExternal: true - uid: MLEM.Misc.RectangleF.Union* commentId: Overload:MLEM.Misc.RectangleF.Union name: Union nameWithType: RectangleF.Union fullName: MLEM.Misc.RectangleF.Union +- uid: Microsoft.Xna.Framework.Rectangle.Deconstruct(System.Int32@,System.Int32@,System.Int32@,System.Int32@) + commentId: M:Microsoft.Xna.Framework.Rectangle.Deconstruct(System.Int32@,System.Int32@,System.Int32@,System.Int32@) + isExternal: true - uid: MLEM.Misc.RectangleF.Deconstruct* commentId: Overload:MLEM.Misc.RectangleF.Deconstruct name: Deconstruct diff --git a/Docs/api/MLEM.Misc.TextInputWrapper.DesktopGl-1.yml b/Docs/api/MLEM.Misc.TextInputWrapper.DesktopGl-1.yml index 219deaf..8905f2c 100644 --- a/Docs/api/MLEM.Misc.TextInputWrapper.DesktopGl-1.yml +++ b/Docs/api/MLEM.Misc.TextInputWrapper.DesktopGl-1.yml @@ -22,16 +22,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: DesktopGl path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 26 + startLine: 63 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA text input wrapper for DesktopGL devices.\nThis wrapper uses the built-in MonoGame TextInput event, which makes this listener work with any keyboard localization natively.\n" + example: + - "\nThis listener is initialized as follows:\n
new TextInputWrapper.DesktopGl{TextInputEventArgs}((w, c) => w.TextInput += c);
\n" syntax: content: 'public class DesktopGl : TextInputWrapper' typeParameters: - id: T + description: '' content.vb: >- Public Class DesktopGl(Of T) + Inherits TextInputWrapper inheritance: - System.Object @@ -72,15 +77,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 32 + startLine: 73 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nCreates a new DesktopGL-based text input wrapper\n" + example: [] syntax: content: public DesktopGl(Action> addListener) parameters: - id: addListener type: System.Action{Microsoft.Xna.Framework.GameWindow,System.EventHandler{{T}}} + description: The function that is used to add a text input listener content.vb: Public Sub New(addListener As Action(Of GameWindow, EventHandler(Of T))) overload: MLEM.Misc.TextInputWrapper.DesktopGl`1.#ctor* nameWithType.vb: TextInputWrapper.DesktopGl(Of T).DesktopGl(Action(Of GameWindow, EventHandler(Of T))) @@ -108,10 +116,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: RequiresOnScreenKeyboard path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 36 + startLine: 78 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override bool RequiresOnScreenKeyboard() return: @@ -145,10 +154,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddListener path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 40 + startLine: 83 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) parameters: diff --git a/Docs/api/MLEM.Misc.TextInputWrapper.Mobile.yml b/Docs/api/MLEM.Misc.TextInputWrapper.Mobile.yml index 9cce32d..163c32c 100644 --- a/Docs/api/MLEM.Misc.TextInputWrapper.Mobile.yml +++ b/Docs/api/MLEM.Misc.TextInputWrapper.Mobile.yml @@ -21,14 +21,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: Mobile path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 71 + startLine: 118 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA text input wrapper for mobile platforms as well as consoles.\nThis text input wrapper performs no actions itself, as it signals that an on-screen keyboard is required.\n" + example: [] syntax: content: 'public class Mobile : TextInputWrapper' content.vb: >- Public Class Mobile + Inherits TextInputWrapper inheritance: - System.Object @@ -66,10 +69,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: RequiresOnScreenKeyboard path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 73 + startLine: 121 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override bool RequiresOnScreenKeyboard() return: @@ -101,10 +105,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddListener path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 77 + startLine: 126 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) parameters: diff --git a/Docs/api/MLEM.Misc.TextInputWrapper.None.yml b/Docs/api/MLEM.Misc.TextInputWrapper.None.yml index dd05d50..686bf57 100644 --- a/Docs/api/MLEM.Misc.TextInputWrapper.None.yml +++ b/Docs/api/MLEM.Misc.TextInputWrapper.None.yml @@ -21,14 +21,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: None path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 82 + startLine: 135 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA text input wrapper that does nothing.\nThis can be used if no text input is required for the game.\n" + example: [] syntax: content: 'public class None : TextInputWrapper' content.vb: >- Public Class None + Inherits TextInputWrapper inheritance: - System.Object @@ -66,10 +69,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: RequiresOnScreenKeyboard path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 84 + startLine: 138 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override bool RequiresOnScreenKeyboard() return: @@ -101,10 +105,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddListener path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 88 + startLine: 143 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) parameters: diff --git a/Docs/api/MLEM.Misc.TextInputWrapper.Primitive.yml b/Docs/api/MLEM.Misc.TextInputWrapper.Primitive.yml index 0b8223d..40ab021 100644 --- a/Docs/api/MLEM.Misc.TextInputWrapper.Primitive.yml +++ b/Docs/api/MLEM.Misc.TextInputWrapper.Primitive.yml @@ -22,14 +22,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: Primitive path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 93 + startLine: 154 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA primitive text input wrapper that is locked to the American keyboard localization.\nOnly use this text input wrapper if is unavailable for some reason.\n\nNote that, when using this text input wrapper, its method has to be called periodically.\n" + example: [] syntax: content: 'public class Primitive : TextInputWrapper' content.vb: >- Public Class Primitive + Inherits TextInputWrapper inheritance: - System.Object @@ -67,15 +70,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: Update path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 97 + startLine: 162 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nUpdates this text input wrapper by querying pressed keys and sending corresponding input events.\n" + example: [] syntax: content: public void Update(InputHandler handler) parameters: - id: handler type: MLEM.Input.InputHandler + description: The input handler to use for text input querying content.vb: Public Sub Update(handler As InputHandler) overload: MLEM.Misc.TextInputWrapper.Primitive.Update* modifiers.csharp: @@ -100,10 +106,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: RequiresOnScreenKeyboard path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 107 + startLine: 173 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override bool RequiresOnScreenKeyboard() return: @@ -135,10 +142,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddListener path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 111 + startLine: 178 assemblies: - MLEM namespace: MLEM.Misc + example: [] syntax: content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) parameters: @@ -156,6 +164,45 @@ items: - Public - Overrides references: +- uid: MLEM.Misc.TextInputWrapper.DesktopGl`1 + commentId: T:MLEM.Misc.TextInputWrapper.DesktopGl`1 + name: TextInputWrapper.DesktopGl + nameWithType: TextInputWrapper.DesktopGl + fullName: MLEM.Misc.TextInputWrapper.DesktopGl + nameWithType.vb: TextInputWrapper.DesktopGl(Of T) + fullName.vb: MLEM.Misc.TextInputWrapper.DesktopGl(Of T) + name.vb: TextInputWrapper.DesktopGl(Of T) + spec.csharp: + - uid: MLEM.Misc.TextInputWrapper.DesktopGl`1 + name: TextInputWrapper.DesktopGl + nameWithType: TextInputWrapper.DesktopGl + fullName: MLEM.Misc.TextInputWrapper.DesktopGl + - name: < + nameWithType: < + fullName: < + - name: T + nameWithType: T + fullName: T + - name: '>' + nameWithType: '>' + fullName: '>' + spec.vb: + - uid: MLEM.Misc.TextInputWrapper.DesktopGl`1 + name: TextInputWrapper.DesktopGl + nameWithType: TextInputWrapper.DesktopGl + fullName: MLEM.Misc.TextInputWrapper.DesktopGl + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - name: T + nameWithType: T + fullName: T + - name: ) + nameWithType: ) + fullName: ) +- uid: MLEM.Misc.TextInputWrapper.Primitive.Update(MLEM.Input.InputHandler) + commentId: M:MLEM.Misc.TextInputWrapper.Primitive.Update(MLEM.Input.InputHandler) + isExternal: true - uid: MLEM.Misc commentId: N:MLEM.Misc name: MLEM.Misc diff --git a/Docs/api/MLEM.Misc.TextInputWrapper.TextInputCallback.yml b/Docs/api/MLEM.Misc.TextInputWrapper.TextInputCallback.yml index 3187468..ced4b30 100644 --- a/Docs/api/MLEM.Misc.TextInputWrapper.TextInputCallback.yml +++ b/Docs/api/MLEM.Misc.TextInputWrapper.TextInputCallback.yml @@ -19,19 +19,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: TextInputCallback path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 24 + startLine: 50 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA delegate method that can be used for \n" + example: [] syntax: content: public delegate void TextInputCallback(object sender, Keys key, char character); parameters: - id: sender type: System.Object + description: The object that sent the event. The used in most cases. - id: key type: Microsoft.Xna.Framework.Input.Keys + description: The key that was pressed - id: character type: System.Char + description: The character that corresponds to that key content.vb: Public Delegate Sub TextInputCallback(sender As Object, key As Keys, character As Char) modifiers.csharp: - public @@ -40,6 +45,65 @@ items: - Public - Delegate references: +- uid: MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback) + commentId: M:MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback) + parent: MLEM.Misc.TextInputWrapper + isExternal: true + name: AddListener(GameWindow, TextInputWrapper.TextInputCallback) + nameWithType: TextInputWrapper.AddListener(GameWindow, TextInputWrapper.TextInputCallback) + fullName: MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow, MLEM.Misc.TextInputWrapper.TextInputCallback) + spec.csharp: + - uid: MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback) + name: AddListener + nameWithType: TextInputWrapper.AddListener + fullName: MLEM.Misc.TextInputWrapper.AddListener + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.GameWindow + name: GameWindow + nameWithType: GameWindow + fullName: Microsoft.Xna.Framework.GameWindow + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Misc.TextInputWrapper.TextInputCallback + name: TextInputWrapper.TextInputCallback + nameWithType: TextInputWrapper.TextInputCallback + fullName: MLEM.Misc.TextInputWrapper.TextInputCallback + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow,MLEM.Misc.TextInputWrapper.TextInputCallback) + name: AddListener + nameWithType: TextInputWrapper.AddListener + fullName: MLEM.Misc.TextInputWrapper.AddListener + - name: ( + nameWithType: ( + fullName: ( + - uid: Microsoft.Xna.Framework.GameWindow + name: GameWindow + nameWithType: GameWindow + fullName: Microsoft.Xna.Framework.GameWindow + isExternal: true + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Misc.TextInputWrapper.TextInputCallback + name: TextInputWrapper.TextInputCallback + nameWithType: TextInputWrapper.TextInputCallback + fullName: MLEM.Misc.TextInputWrapper.TextInputCallback + - name: ) + nameWithType: ) + fullName: ) +- uid: MLEM.Misc.TextInputWrapper + commentId: T:MLEM.Misc.TextInputWrapper + parent: MLEM.Misc + name: TextInputWrapper + nameWithType: TextInputWrapper + fullName: MLEM.Misc.TextInputWrapper - uid: MLEM.Misc commentId: N:MLEM.Misc name: MLEM.Misc diff --git a/Docs/api/MLEM.Misc.TextInputWrapper.yml b/Docs/api/MLEM.Misc.TextInputWrapper.yml index c926980..08f5f49 100644 --- a/Docs/api/MLEM.Misc.TextInputWrapper.yml +++ b/Docs/api/MLEM.Misc.TextInputWrapper.yml @@ -22,10 +22,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: TextInputWrapper path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 8 + startLine: 13 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nA text input wrapper is a wrapper around MonoGame's built-in text input event.\nSince said text input event does not exist on non-Desktop devices, we want to wrap it in a wrapper that is platform-independent for MLEM.\nSee subclasses of this wrapper or https://mlem.ellpeck.de/articles/ui.html#text-input for more info.\n" + example: [] syntax: content: public abstract class TextInputWrapper content.vb: Public MustInherit Class TextInputWrapper @@ -70,10 +72,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Current path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 11 + startLine: 21 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nThe current text input wrapper.\nSet this value before starting your game if you want to use text input wrapping.\n" + example: [] syntax: content: public static TextInputWrapper Current { get; set; } parameters: [] @@ -81,6 +85,9 @@ items: type: MLEM.Misc.TextInputWrapper content.vb: Public Shared Property Current As TextInputWrapper overload: MLEM.Misc.TextInputWrapper.Current* + exceptions: + - type: System.InvalidOperationException + commentId: T:System.InvalidOperationException modifiers.csharp: - public - static @@ -107,14 +114,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: RequiresOnScreenKeyboard path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 20 + startLine: 34 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nDetermines if this text input wrapper requires an on-screen keyboard.\n" + example: [] syntax: content: public abstract bool RequiresOnScreenKeyboard() return: type: System.Boolean + description: If this text input wrapper requires an on-screen keyboard content.vb: Public MustOverride Function RequiresOnScreenKeyboard As Boolean overload: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard* modifiers.csharp: @@ -141,17 +151,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddListener path: ../MLEM/Misc/TextInputWrapper.cs - startLine: 22 + startLine: 42 assemblies: - MLEM namespace: MLEM.Misc + summary: "\nAdds a text input listener to this text input wrapper.\nThe supplied listener will be called whenever a character is input.\n" + example: [] syntax: content: public abstract void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) parameters: - id: window type: Microsoft.Xna.Framework.GameWindow + description: The game's window - id: callback type: MLEM.Misc.TextInputWrapper.TextInputCallback + description: The callback that should be called whenever a character is pressed content.vb: Public MustOverride Sub AddListener(window As GameWindow, callback As TextInputWrapper.TextInputCallback) overload: MLEM.Misc.TextInputWrapper.AddListener* modifiers.csharp: @@ -458,6 +472,9 @@ references: name: System nameWithType: System fullName: System +- uid: System.InvalidOperationException + commentId: T:System.InvalidOperationException + isExternal: true - uid: MLEM.Misc.TextInputWrapper.Current* commentId: Overload:MLEM.Misc.TextInputWrapper.Current name: Current diff --git a/Docs/api/MLEM.Pathfinding.AStar-1.GetCost.yml b/Docs/api/MLEM.Pathfinding.AStar-1.GetCost.yml index 5ad4c76..31baea8 100644 --- a/Docs/api/MLEM.Pathfinding.AStar-1.GetCost.yml +++ b/Docs/api/MLEM.Pathfinding.AStar-1.GetCost.yml @@ -19,17 +19,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetCost path: ../MLEM/Pathfinding/AStar.cs - startLine: 109 + startLine: 176 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nA cost function for a given path finding position.\nIf a path point should have the default cost, should be returned.\nIf a path point should be unreachable, should be returned.\n" + example: [] syntax: content: public delegate float GetCost(T currPos, T nextPos); parameters: - id: currPos type: '{T}' + description: The current position in the path - id: nextPos type: '{T}' + description: The position we're trying to reach from the current position return: type: System.Single content.vb: Public Delegate Function GetCost(currPos As T, nextPos As T) As Single @@ -43,6 +47,20 @@ items: fullName.vb: MLEM.Pathfinding.AStar(Of T).GetCost name.vb: AStar(Of T).GetCost references: +- uid: MLEM.Pathfinding.AStar`1.DefaultCost + commentId: F:MLEM.Pathfinding.AStar`1.DefaultCost + name: DefaultCost + nameWithType: AStar.DefaultCost + fullName: MLEM.Pathfinding.AStar.DefaultCost + nameWithType.vb: AStar(Of T).DefaultCost + fullName.vb: MLEM.Pathfinding.AStar(Of T).DefaultCost +- uid: MLEM.Pathfinding.AStar`1.InfiniteCost + commentId: F:MLEM.Pathfinding.AStar`1.InfiniteCost + name: InfiniteCost + nameWithType: AStar.InfiniteCost + fullName: MLEM.Pathfinding.AStar.InfiniteCost + nameWithType.vb: AStar(Of T).InfiniteCost + fullName.vb: MLEM.Pathfinding.AStar(Of T).InfiniteCost - uid: MLEM.Pathfinding commentId: N:MLEM.Pathfinding name: MLEM.Pathfinding diff --git a/Docs/api/MLEM.Pathfinding.AStar-1.yml b/Docs/api/MLEM.Pathfinding.AStar-1.yml index cf8d628..5d40e7a 100644 --- a/Docs/api/MLEM.Pathfinding.AStar-1.yml +++ b/Docs/api/MLEM.Pathfinding.AStar-1.yml @@ -33,14 +33,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: AStar path: ../MLEM/Pathfinding/AStar.cs - startLine: 6 + startLine: 11 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThis is an abstract implementation of the A* path finding algorithm.\nThis implementation is used by , a 2-dimensional A* path finding algorithm, and , a 3-dimensional A* path finding algorithm.\n" + example: [] syntax: content: public abstract class AStar typeParameters: - id: T + description: The type of points used for this path content.vb: Public MustInherit Class AStar(Of T) inheritance: - System.Object @@ -84,10 +87,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: InfiniteCost path: ../MLEM/Pathfinding/AStar.cs - startLine: 8 + startLine: 16 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nA value that represents an infinite path cost, or a cost for a location that cannot possibly be reached.\n" + example: [] syntax: content: public static readonly float InfiniteCost return: @@ -121,10 +126,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: AllDirections path: ../MLEM/Pathfinding/AStar.cs - startLine: 9 + startLine: 21 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe array of all directions that will be checked for path finding.\nNote that this array is only used if is true.\n" + example: [] syntax: content: public readonly T[] AllDirections return: @@ -156,10 +163,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: AdjacentDirections path: ../MLEM/Pathfinding/AStar.cs - startLine: 10 + startLine: 26 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe array of all adjacent directions that will be checked for path finding.\nNote that this array is only used if is false.\n" + example: [] syntax: content: public readonly T[] AdjacentDirections return: @@ -191,10 +200,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DefaultCostFunction path: ../MLEM/Pathfinding/AStar.cs - startLine: 11 + startLine: 30 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe default cost function that determines the cost for each path finding position.\n" + example: [] syntax: content: public AStar.GetCost DefaultCostFunction return: @@ -224,10 +235,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DefaultCost path: ../MLEM/Pathfinding/AStar.cs - startLine: 12 + startLine: 34 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe default cost for a path point.\n" + example: [] syntax: content: public float DefaultCost return: @@ -257,10 +270,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DefaultMaxTries path: ../MLEM/Pathfinding/AStar.cs - startLine: 13 + startLine: 38 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe default amount of maximum tries that will be used before path finding is aborted.\n" + example: [] syntax: content: public int DefaultMaxTries return: @@ -290,10 +305,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: DefaultAllowDiagonals path: ../MLEM/Pathfinding/AStar.cs - startLine: 14 + startLine: 42 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nWhether or not diagonal directions are considered while finding a path.\n" + example: [] syntax: content: public bool DefaultAllowDiagonals return: @@ -323,10 +340,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: LastTriesNeeded path: ../MLEM/Pathfinding/AStar.cs - startLine: 15 + startLine: 46 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe amount of tries required for finding the last queried path\n" + example: [] syntax: content: public int LastTriesNeeded { get; } parameters: [] @@ -360,10 +379,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: LastTimeNeeded path: ../MLEM/Pathfinding/AStar.cs - startLine: 16 + startLine: 50 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe amount of time required for finding the last queried path\n" + example: [] syntax: content: public TimeSpan LastTimeNeeded { get; } parameters: [] @@ -397,25 +418,33 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Pathfinding/AStar.cs - startLine: 18 + startLine: 61 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nCreates a new A* pathfinder with the supplied default settings.\n" + example: [] syntax: content: protected AStar(T[] allDirections, T[] adjacentDirections, AStar.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000) parameters: - id: allDirections type: '{T}[]' + description: All directions that should be checked - id: adjacentDirections type: '{T}[]' + description: All adjacent directions that should be checked - id: defaultCostFunction type: MLEM.Pathfinding.AStar`1.GetCost + description: The default function for cost determination of a path point - id: defaultAllowDiagonals type: System.Boolean + description: Whether or not diagonals should be allowed by default - id: defaultCost type: System.Single + description: The default cost for a path point - id: defaultMaxTries type: System.Int32 + description: The default amount of tries before path finding is aborted content.vb: Protected Sub New(allDirections As T(), adjacentDirections As T(), defaultCostFunction As AStar(Of T).GetCost, defaultAllowDiagonals As Boolean, defaultCost As Single = 1F, defaultMaxTries As Integer = 10000) overload: MLEM.Pathfinding.AStar`1.#ctor* nameWithType.vb: AStar(Of T).AStar(T(), T(), AStar(Of T).GetCost, Boolean, Single, Int32) @@ -443,10 +472,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: FindPathAsync path: ../MLEM/Pathfinding/AStar.cs - startLine: 27 + startLine: 71 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: public Task> FindPathAsync(T start, T goal, AStar.GetCost costFunction = null, float? defaultCost = default(float? ), int? maxTries = default(int? ), bool? allowDiagonals = default(bool? )) parameters: @@ -491,27 +521,36 @@ items: repo: https://github.com/Ellpeck/MLEM id: FindPath path: ../MLEM/Pathfinding/AStar.cs - startLine: 31 + startLine: 85 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nFinds a path between two points using this pathfinder's default settings or, alternatively, the supplied override settings.\n" + example: [] syntax: content: public Stack FindPath(T start, T goal, AStar.GetCost costFunction = null, float? defaultCost = default(float? ), int? maxTries = default(int? ), bool? allowDiagonals = default(bool? )) parameters: - id: start type: '{T}' + description: The point to start path finding at - id: goal type: '{T}' + description: The point to find a path to - id: costFunction type: MLEM.Pathfinding.AStar`1.GetCost + description: The function that determines the cost for each path point - id: defaultCost type: System.Nullable{System.Single} + description: The default cost for each path point - id: maxTries type: System.Nullable{System.Int32} + description: The maximum amount of tries before path finding is aborted - id: allowDiagonals type: System.Nullable{System.Boolean} + description: If diagonals should be looked at for path finding return: type: System.Collections.Generic.Stack{{T}} + description: A stack of path points, where the top item is the first point to go to. content.vb: Public Function FindPath(start As T, goal As T, costFunction As AStar(Of T).GetCost = Nothing, defaultCost As Single? = Nothing, maxTries As Integer? = Nothing, allowDiagonals As Boolean? = Nothing) As Stack(Of T) overload: MLEM.Pathfinding.AStar`1.FindPath* nameWithType.vb: AStar(Of T).FindPath(T, T, AStar(Of T).GetCost, Nullable(Of Single), Nullable(Of Int32), Nullable(Of Boolean)) @@ -539,10 +578,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddPositions path: ../MLEM/Pathfinding/AStar.cs - startLine: 96 + startLine: 153 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nA helper method to add two positions together.\n" + example: [] syntax: content: protected abstract T AddPositions(T first, T second) parameters: @@ -580,10 +621,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetManhattanDistance path: ../MLEM/Pathfinding/AStar.cs - startLine: 98 + startLine: 158 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nA helper method to get the Manhattan Distance between two points.\n" + example: [] syntax: content: protected abstract float GetManhattanDistance(T first, T second) parameters: @@ -604,6 +647,16 @@ items: - MustOverride fullName.vb: MLEM.Pathfinding.AStar(Of T).GetManhattanDistance(T, T) references: +- uid: MLEM.Pathfinding.AStar2 + commentId: T:MLEM.Pathfinding.AStar2 + name: AStar2 + nameWithType: AStar2 + fullName: MLEM.Pathfinding.AStar2 +- uid: MLEM.Pathfinding.AStar3 + commentId: T:MLEM.Pathfinding.AStar3 + name: AStar3 + nameWithType: AStar3 + fullName: MLEM.Pathfinding.AStar3 - uid: MLEM.Pathfinding commentId: N:MLEM.Pathfinding name: MLEM.Pathfinding @@ -908,6 +961,13 @@ references: name: Single nameWithType: Single fullName: System.Single +- uid: MLEM.Pathfinding.AStar`1.DefaultAllowDiagonals + commentId: F:MLEM.Pathfinding.AStar`1.DefaultAllowDiagonals + name: DefaultAllowDiagonals + nameWithType: AStar.DefaultAllowDiagonals + fullName: MLEM.Pathfinding.AStar.DefaultAllowDiagonals + nameWithType.vb: AStar(Of T).DefaultAllowDiagonals + fullName.vb: MLEM.Pathfinding.AStar(Of T).DefaultAllowDiagonals - uid: '{T}[]' isExternal: true name: T[] @@ -1003,6 +1063,195 @@ references: fullName: MLEM.Pathfinding.AStar.AStar nameWithType.vb: AStar(Of T).AStar fullName.vb: MLEM.Pathfinding.AStar(Of T).AStar +- uid: MLEM.Pathfinding.AStar`1.FindPath(`0,`0,MLEM.Pathfinding.AStar{`0}.GetCost,System.Nullable{System.Single},System.Nullable{System.Int32},System.Nullable{System.Boolean}) + commentId: M:MLEM.Pathfinding.AStar`1.FindPath(`0,`0,MLEM.Pathfinding.AStar{`0}.GetCost,System.Nullable{System.Single},System.Nullable{System.Int32},System.Nullable{System.Boolean}) + isExternal: true + name: FindPath(T, T, AStar.GetCost<>, Nullable, Nullable, Nullable) + nameWithType: AStar.FindPath(T, T, AStar.GetCost<>, Nullable, Nullable, Nullable) + fullName: MLEM.Pathfinding.AStar.FindPath(T, T, MLEM.Pathfinding.AStar.GetCost<>, System.Nullable, System.Nullable, System.Nullable) + nameWithType.vb: AStar(Of T).FindPath(T, T, AStar.GetCost(Of ), Nullable(Of Single), Nullable(Of Int32), Nullable(Of Boolean)) + fullName.vb: MLEM.Pathfinding.AStar(Of T).FindPath(T, T, MLEM.Pathfinding.AStar.GetCost(Of ), System.Nullable(Of System.Single), System.Nullable(Of System.Int32), System.Nullable(Of System.Boolean)) + name.vb: FindPath(T, T, AStar.GetCost(Of ), Nullable(Of Single), Nullable(Of Int32), Nullable(Of Boolean)) + spec.csharp: + - uid: MLEM.Pathfinding.AStar`1.FindPath(`0,`0,MLEM.Pathfinding.AStar{`0}.GetCost,System.Nullable{System.Single},System.Nullable{System.Int32},System.Nullable{System.Boolean}) + name: FindPath + nameWithType: AStar.FindPath + fullName: MLEM.Pathfinding.AStar.FindPath + - name: ( + nameWithType: ( + fullName: ( + - name: T + nameWithType: T + fullName: T + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - name: T + nameWithType: T + fullName: T + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Pathfinding.AStar`1.GetCost + name: AStar.GetCost + nameWithType: AStar.GetCost + fullName: MLEM.Pathfinding.AStar.GetCost + - name: < + nameWithType: < + fullName: < + - name: '>' + nameWithType: '>' + fullName: '>' + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: < + nameWithType: < + fullName: < + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: '>' + nameWithType: '>' + fullName: '>' + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: < + nameWithType: < + fullName: < + - uid: System.Int32 + name: Int32 + nameWithType: Int32 + fullName: System.Int32 + isExternal: true + - name: '>' + nameWithType: '>' + fullName: '>' + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: < + nameWithType: < + fullName: < + - uid: System.Boolean + name: Boolean + nameWithType: Boolean + fullName: System.Boolean + isExternal: true + - name: '>' + nameWithType: '>' + fullName: '>' + - name: ) + nameWithType: ) + fullName: ) + spec.vb: + - uid: MLEM.Pathfinding.AStar`1.FindPath(`0,`0,MLEM.Pathfinding.AStar{`0}.GetCost,System.Nullable{System.Single},System.Nullable{System.Int32},System.Nullable{System.Boolean}) + name: FindPath + nameWithType: AStar(Of T).FindPath + fullName: MLEM.Pathfinding.AStar(Of T).FindPath + - name: ( + nameWithType: ( + fullName: ( + - name: T + nameWithType: T + fullName: T + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - name: T + nameWithType: T + fullName: T + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: MLEM.Pathfinding.AStar`1.GetCost + name: AStar.GetCost + nameWithType: AStar.GetCost + fullName: MLEM.Pathfinding.AStar.GetCost + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - name: ) + nameWithType: ) + fullName: ) + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - uid: System.Single + name: Single + nameWithType: Single + fullName: System.Single + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - uid: System.Int32 + name: Int32 + nameWithType: Int32 + fullName: System.Int32 + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + - name: ', ' + nameWithType: ', ' + fullName: ', ' + - uid: System.Nullable`1 + name: Nullable + nameWithType: Nullable + fullName: System.Nullable + isExternal: true + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - uid: System.Boolean + name: Boolean + nameWithType: Boolean + fullName: System.Boolean + isExternal: true + - name: ) + nameWithType: ) + fullName: ) + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Pathfinding.AStar`1.FindPathAsync* commentId: Overload:MLEM.Pathfinding.AStar`1.FindPathAsync name: FindPathAsync diff --git a/Docs/api/MLEM.Pathfinding.AStar2.yml b/Docs/api/MLEM.Pathfinding.AStar2.yml index f08a868..c230168 100644 --- a/Docs/api/MLEM.Pathfinding.AStar2.yml +++ b/Docs/api/MLEM.Pathfinding.AStar2.yml @@ -22,14 +22,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: AStar2 path: ../MLEM/Pathfinding/AStar2.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nA 2-dimensional implementation of that uses for positions.\n" + example: [] syntax: content: 'public class AStar2 : AStar' content.vb: >- Public Class AStar2 + Inherits AStar(Of Point) inheritance: - System.Object @@ -77,10 +80,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Pathfinding/AStar2.cs - startLine: 11 + startLine: 15 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: public AStar2(AStar.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000) parameters: @@ -119,10 +123,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddPositions path: ../MLEM/Pathfinding/AStar2.cs - startLine: 15 + startLine: 20 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: protected override Point AddPositions(Point first, Point second) parameters: @@ -159,10 +164,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetManhattanDistance path: ../MLEM/Pathfinding/AStar2.cs - startLine: 19 + startLine: 25 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: protected override float GetManhattanDistance(Point first, Point second) parameters: @@ -182,6 +188,49 @@ items: - Protected - Overrides references: +- uid: MLEM.Pathfinding.AStar`1 + commentId: T:MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + nameWithType.vb: AStar(Of T) + fullName.vb: MLEM.Pathfinding.AStar(Of T) + name.vb: AStar(Of T) + spec.csharp: + - uid: MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + - name: < + nameWithType: < + fullName: < + - name: T + nameWithType: T + fullName: T + - name: '>' + nameWithType: '>' + fullName: '>' + spec.vb: + - uid: MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - name: T + nameWithType: T + fullName: T + - name: ) + nameWithType: ) + fullName: ) +- uid: Microsoft.Xna.Framework.Point + commentId: T:Microsoft.Xna.Framework.Point + parent: Microsoft.Xna.Framework + isExternal: true + name: Point + nameWithType: Point + fullName: Microsoft.Xna.Framework.Point - uid: MLEM.Pathfinding commentId: N:MLEM.Pathfinding name: MLEM.Pathfinding @@ -992,48 +1041,18 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework + commentId: N:Microsoft.Xna.Framework + isExternal: true + name: Microsoft.Xna.Framework + nameWithType: Microsoft.Xna.Framework + fullName: Microsoft.Xna.Framework - uid: System commentId: N:System isExternal: true name: System nameWithType: System fullName: System -- uid: MLEM.Pathfinding.AStar`1 - commentId: T:MLEM.Pathfinding.AStar`1 - name: AStar - nameWithType: AStar - fullName: MLEM.Pathfinding.AStar - nameWithType.vb: AStar(Of T) - fullName.vb: MLEM.Pathfinding.AStar(Of T) - name.vb: AStar(Of T) - spec.csharp: - - uid: MLEM.Pathfinding.AStar`1 - name: AStar - nameWithType: AStar - fullName: MLEM.Pathfinding.AStar - - name: < - nameWithType: < - fullName: < - - name: T - nameWithType: T - fullName: T - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: MLEM.Pathfinding.AStar`1 - name: AStar - nameWithType: AStar - fullName: MLEM.Pathfinding.AStar - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - name: T - nameWithType: T - fullName: T - - name: ) - nameWithType: ) - fullName: ) - uid: MLEM.Pathfinding.AStar`1.InfiniteCost commentId: F:MLEM.Pathfinding.AStar`1.InfiniteCost name: InfiniteCost @@ -1626,13 +1645,6 @@ references: name: AddPositions nameWithType: AStar2.AddPositions fullName: MLEM.Pathfinding.AStar2.AddPositions -- uid: Microsoft.Xna.Framework.Point - commentId: T:Microsoft.Xna.Framework.Point - parent: Microsoft.Xna.Framework - isExternal: true - name: Point - nameWithType: Point - fullName: Microsoft.Xna.Framework.Point - uid: MLEM.Pathfinding.AStar`1.AddPositions(`0,`0) commentId: M:MLEM.Pathfinding.AStar`1.AddPositions(`0,`0) name: AddPositions(T, T) @@ -1680,12 +1692,6 @@ references: - name: ) nameWithType: ) fullName: ) -- uid: Microsoft.Xna.Framework - commentId: N:Microsoft.Xna.Framework - isExternal: true - name: Microsoft.Xna.Framework - nameWithType: Microsoft.Xna.Framework - fullName: Microsoft.Xna.Framework - uid: MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Point}.GetManhattanDistance(Microsoft.Xna.Framework.Point,Microsoft.Xna.Framework.Point) commentId: M:MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Point}.GetManhattanDistance(Microsoft.Xna.Framework.Point,Microsoft.Xna.Framework.Point) parent: MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Point} diff --git a/Docs/api/MLEM.Pathfinding.AStar3.yml b/Docs/api/MLEM.Pathfinding.AStar3.yml index 6a83db1..7bb775f 100644 --- a/Docs/api/MLEM.Pathfinding.AStar3.yml +++ b/Docs/api/MLEM.Pathfinding.AStar3.yml @@ -22,14 +22,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: AStar3 path: ../MLEM/Pathfinding/AStar3.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nA 3-dimensional implementation of that uses for positions.\n" + example: [] syntax: content: 'public class AStar3 : AStar' content.vb: >- Public Class AStar3 + Inherits AStar(Of Vector3) inheritance: - System.Object @@ -77,10 +80,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Pathfinding/AStar3.cs - startLine: 33 + startLine: 37 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: public AStar3(AStar.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000) parameters: @@ -119,10 +123,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: AddPositions path: ../MLEM/Pathfinding/AStar3.cs - startLine: 37 + startLine: 42 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: protected override Vector3 AddPositions(Vector3 first, Vector3 second) parameters: @@ -159,10 +164,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetManhattanDistance path: ../MLEM/Pathfinding/AStar3.cs - startLine: 41 + startLine: 47 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: protected override float GetManhattanDistance(Vector3 first, Vector3 second) parameters: @@ -182,6 +188,49 @@ items: - Protected - Overrides references: +- uid: MLEM.Pathfinding.AStar`1 + commentId: T:MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + nameWithType.vb: AStar(Of T) + fullName.vb: MLEM.Pathfinding.AStar(Of T) + name.vb: AStar(Of T) + spec.csharp: + - uid: MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + - name: < + nameWithType: < + fullName: < + - name: T + nameWithType: T + fullName: T + - name: '>' + nameWithType: '>' + fullName: '>' + spec.vb: + - uid: MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - name: T + nameWithType: T + fullName: T + - name: ) + nameWithType: ) + fullName: ) +- uid: Microsoft.Xna.Framework.Vector3 + commentId: T:Microsoft.Xna.Framework.Vector3 + parent: Microsoft.Xna.Framework + isExternal: true + name: Vector3 + nameWithType: Vector3 + fullName: Microsoft.Xna.Framework.Vector3 - uid: MLEM.Pathfinding commentId: N:MLEM.Pathfinding name: MLEM.Pathfinding @@ -992,48 +1041,18 @@ references: - name: ) nameWithType: ) fullName: ) +- uid: Microsoft.Xna.Framework + commentId: N:Microsoft.Xna.Framework + isExternal: true + name: Microsoft.Xna.Framework + nameWithType: Microsoft.Xna.Framework + fullName: Microsoft.Xna.Framework - uid: System commentId: N:System isExternal: true name: System nameWithType: System fullName: System -- uid: MLEM.Pathfinding.AStar`1 - commentId: T:MLEM.Pathfinding.AStar`1 - name: AStar - nameWithType: AStar - fullName: MLEM.Pathfinding.AStar - nameWithType.vb: AStar(Of T) - fullName.vb: MLEM.Pathfinding.AStar(Of T) - name.vb: AStar(Of T) - spec.csharp: - - uid: MLEM.Pathfinding.AStar`1 - name: AStar - nameWithType: AStar - fullName: MLEM.Pathfinding.AStar - - name: < - nameWithType: < - fullName: < - - name: T - nameWithType: T - fullName: T - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: MLEM.Pathfinding.AStar`1 - name: AStar - nameWithType: AStar - fullName: MLEM.Pathfinding.AStar - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - name: T - nameWithType: T - fullName: T - - name: ) - nameWithType: ) - fullName: ) - uid: MLEM.Pathfinding.AStar`1.InfiniteCost commentId: F:MLEM.Pathfinding.AStar`1.InfiniteCost name: InfiniteCost @@ -1626,13 +1645,6 @@ references: name: AddPositions nameWithType: AStar3.AddPositions fullName: MLEM.Pathfinding.AStar3.AddPositions -- uid: Microsoft.Xna.Framework.Vector3 - commentId: T:Microsoft.Xna.Framework.Vector3 - parent: Microsoft.Xna.Framework - isExternal: true - name: Vector3 - nameWithType: Vector3 - fullName: Microsoft.Xna.Framework.Vector3 - uid: MLEM.Pathfinding.AStar`1.AddPositions(`0,`0) commentId: M:MLEM.Pathfinding.AStar`1.AddPositions(`0,`0) name: AddPositions(T, T) @@ -1680,12 +1692,6 @@ references: - name: ) nameWithType: ) fullName: ) -- uid: Microsoft.Xna.Framework - commentId: N:Microsoft.Xna.Framework - isExternal: true - name: Microsoft.Xna.Framework - nameWithType: Microsoft.Xna.Framework - fullName: Microsoft.Xna.Framework - uid: MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Vector3}.GetManhattanDistance(Microsoft.Xna.Framework.Vector3,Microsoft.Xna.Framework.Vector3) commentId: M:MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Vector3}.GetManhattanDistance(Microsoft.Xna.Framework.Vector3,Microsoft.Xna.Framework.Vector3) parent: MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Vector3} diff --git a/Docs/api/MLEM.Pathfinding.PathPoint-1.yml b/Docs/api/MLEM.Pathfinding.PathPoint-1.yml index 5d8feea..a9c9b66 100644 --- a/Docs/api/MLEM.Pathfinding.PathPoint-1.yml +++ b/Docs/api/MLEM.Pathfinding.PathPoint-1.yml @@ -26,14 +26,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: PathPoint path: ../MLEM/Pathfinding/AStar.cs - startLine: 113 + startLine: 184 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nA point in a path\n" + example: [] syntax: content: public class PathPoint typeParameters: - id: T + description: The type of point used for this path content.vb: Public Class PathPoint(Of T) inheritance: - System.Object @@ -70,10 +73,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Parent path: ../MLEM/Pathfinding/AStar.cs - startLine: 115 + startLine: 189 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe path point that this point originated from\n" + example: [] syntax: content: public readonly PathPoint Parent return: @@ -105,10 +110,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Pos path: ../MLEM/Pathfinding/AStar.cs - startLine: 116 + startLine: 193 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe position of this path point\n" + example: [] syntax: content: public readonly T Pos return: @@ -140,10 +147,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: F path: ../MLEM/Pathfinding/AStar.cs - startLine: 117 + startLine: 197 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe F cost of this path point\n" + example: [] syntax: content: public readonly float F return: @@ -175,10 +184,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: G path: ../MLEM/Pathfinding/AStar.cs - startLine: 118 + startLine: 201 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nThe G cost of this path point\n" + example: [] syntax: content: public readonly float G return: @@ -210,23 +221,30 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Pathfinding/AStar.cs - startLine: 120 + startLine: 211 assemblies: - MLEM namespace: MLEM.Pathfinding + summary: "\nCreates a new path point with the supplied settings.\n" + example: [] syntax: content: public PathPoint(T pos, float distance, PathPoint parent, float terrainCostForThisPos, float defaultCost) parameters: - id: pos type: '{T}' + description: The point's position - id: distance type: System.Single + description: The point's manhattan distance from the start point - id: parent type: MLEM.Pathfinding.PathPoint`1 + description: The point's parent - id: terrainCostForThisPos type: System.Single + description: The point's terrain cost, based on - id: defaultCost type: System.Single + description: The default cost for a path point content.vb: Public Sub New(pos As T, distance As Single, parent As PathPoint(Of T), terrainCostForThisPos As Single, defaultCost As Single) overload: MLEM.Pathfinding.PathPoint`1.#ctor* nameWithType.vb: PathPoint(Of T).PathPoint(T, Single, PathPoint(Of T), Single, Single) @@ -254,10 +272,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Equals path: ../MLEM/Pathfinding/AStar.cs - startLine: 128 + startLine: 220 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: public override bool Equals(object obj) parameters: @@ -294,10 +313,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: GetHashCode path: ../MLEM/Pathfinding/AStar.cs - startLine: 134 + startLine: 227 assemblies: - MLEM namespace: MLEM.Pathfinding + example: [] syntax: content: public override int GetHashCode() return: @@ -314,6 +334,42 @@ items: - Overrides fullName.vb: MLEM.Pathfinding.PathPoint(Of T).GetHashCode() references: +- uid: MLEM.Pathfinding.AStar`1 + commentId: T:MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + nameWithType.vb: AStar(Of T) + fullName.vb: MLEM.Pathfinding.AStar(Of T) + name.vb: AStar(Of T) + spec.csharp: + - uid: MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + - name: < + nameWithType: < + fullName: < + - name: T + nameWithType: T + fullName: T + - name: '>' + nameWithType: '>' + fullName: '>' + spec.vb: + - uid: MLEM.Pathfinding.AStar`1 + name: AStar + nameWithType: AStar + fullName: MLEM.Pathfinding.AStar + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - name: T + nameWithType: T + fullName: T + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Pathfinding commentId: N:MLEM.Pathfinding name: MLEM.Pathfinding @@ -593,6 +649,37 @@ references: name: Single nameWithType: Single fullName: System.Single +- uid: MLEM.Pathfinding.AStar`1.GetCost + commentId: T:MLEM.Pathfinding.AStar`1.GetCost + parent: MLEM.Pathfinding + name: AStar.GetCost<> + nameWithType: AStar.GetCost<> + fullName: MLEM.Pathfinding.AStar.GetCost<> + nameWithType.vb: AStar.GetCost(Of ) + fullName.vb: MLEM.Pathfinding.AStar.GetCost(Of ) + name.vb: AStar.GetCost(Of ) + spec.csharp: + - uid: MLEM.Pathfinding.AStar`1.GetCost + name: AStar.GetCost + nameWithType: AStar.GetCost + fullName: MLEM.Pathfinding.AStar.GetCost + - name: < + nameWithType: < + fullName: < + - name: '>' + nameWithType: '>' + fullName: '>' + spec.vb: + - uid: MLEM.Pathfinding.AStar`1.GetCost + name: AStar.GetCost + nameWithType: AStar.GetCost + fullName: MLEM.Pathfinding.AStar.GetCost + - name: '(Of ' + nameWithType: '(Of ' + fullName: '(Of ' + - name: ) + nameWithType: ) + fullName: ) - uid: MLEM.Pathfinding.PathPoint`1.#ctor* commentId: Overload:MLEM.Pathfinding.PathPoint`1.#ctor name: PathPoint diff --git a/Docs/api/MLEM.Startup.MlemGame.yml b/Docs/api/MLEM.Startup.MlemGame.yml index d061d84..ea7b316 100644 --- a/Docs/api/MLEM.Startup.MlemGame.yml +++ b/Docs/api/MLEM.Startup.MlemGame.yml @@ -42,7 +42,9 @@ items: content: 'public class MlemGame : Game, IDisposable' content.vb: >- Public Class MlemGame + Inherits Game + Implements IDisposable inheritance: - System.Object diff --git a/Docs/api/MLEM.Textures.NinePatch.yml b/Docs/api/MLEM.Textures.NinePatch.yml index edbc42f..db1889d 100644 --- a/Docs/api/MLEM.Textures.NinePatch.yml +++ b/Docs/api/MLEM.Textures.NinePatch.yml @@ -10,8 +10,6 @@ items: - MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,MLEM.Misc.Padding) - MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32) - MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32,System.Int32,System.Int32,System.Int32) - - MLEM.Textures.NinePatch.CreateRectangles(Microsoft.Xna.Framework.Rectangle,System.Single) - - MLEM.Textures.NinePatch.CreateRectangles(MLEM.Misc.RectangleF,System.Single) - MLEM.Textures.NinePatch.Padding - MLEM.Textures.NinePatch.Region - MLEM.Textures.NinePatch.SourceRectangles @@ -29,14 +27,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: NinePatch path: ../MLEM/Textures/NinePatch.cs - startLine: 8 + startLine: 12 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThis class represents a texture with nine areas.\nA nine patch texture is useful if a big area should be covered by a small texture that has a specific outline, like a gui panel texture. The center of the texture will be stretched, while the outline of the texture will remain at its original size, keeping aspect ratios alive.\n" + example: [] syntax: content: 'public class NinePatch : GenericDataHolder' content.vb: >- Public Class NinePatch + Inherits GenericDataHolder inheritance: - System.Object @@ -78,10 +79,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Region path: ../MLEM/Textures/NinePatch.cs - startLine: 10 + startLine: 17 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe texture region of this nine patch\n" + example: [] syntax: content: public readonly TextureRegion Region return: @@ -111,10 +114,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Padding path: ../MLEM/Textures/NinePatch.cs - startLine: 11 + startLine: 21 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe padding in each direction that marks where the outline area stops\n" + example: [] syntax: content: public readonly Padding Padding return: @@ -144,10 +149,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: SourceRectangles path: ../MLEM/Textures/NinePatch.cs - startLine: 12 + startLine: 25 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe nine patches that result from the \n" + example: [] syntax: content: public readonly Rectangle[] SourceRectangles return: @@ -177,17 +184,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/NinePatch.cs - startLine: 14 + startLine: 32 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new nine patch from a texture and a padding\n" + example: [] syntax: content: public NinePatch(TextureRegion texture, Padding padding) parameters: - id: texture type: MLEM.Textures.TextureRegion + description: The texture to use - id: padding type: MLEM.Misc.Padding + description: The padding that marks where the outline area stops content.vb: Public Sub New(texture As TextureRegion, padding As Padding) overload: MLEM.Textures.NinePatch.#ctor* modifiers.csharp: @@ -212,23 +223,30 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/NinePatch.cs - startLine: 20 + startLine: 46 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new nine patch from a texture and a padding\n" + example: [] syntax: content: public NinePatch(TextureRegion texture, int paddingLeft, int paddingRight, int paddingTop, int paddingBottom) parameters: - id: texture type: MLEM.Textures.TextureRegion + description: The texture to use - id: paddingLeft type: System.Int32 + description: The padding on the left edge - id: paddingRight type: System.Int32 + description: The padding on the right edge - id: paddingTop type: System.Int32 + description: The padding on the top edge - id: paddingBottom type: System.Int32 + description: The padding on the bottom edge content.vb: Public Sub New(texture As TextureRegion, paddingLeft As Integer, paddingRight As Integer, paddingTop As Integer, paddingBottom As Integer) overload: MLEM.Textures.NinePatch.#ctor* modifiers.csharp: @@ -253,10 +271,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/NinePatch.cs - startLine: 24 + startLine: 51 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public NinePatch(Texture2D texture, int paddingLeft, int paddingRight, int paddingTop, int paddingBottom) parameters: @@ -294,17 +313,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/NinePatch.cs - startLine: 28 + startLine: 60 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new nine patch from a texture and a uniform padding\n" + example: [] syntax: content: public NinePatch(Texture2D texture, int padding) parameters: - id: texture type: Microsoft.Xna.Framework.Graphics.Texture2D + description: The texture to use - id: padding type: System.Int32 + description: The padding that each edge should have content.vb: Public Sub New(texture As Texture2D, padding As Integer) overload: MLEM.Textures.NinePatch.#ctor* modifiers.csharp: @@ -329,10 +352,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/NinePatch.cs - startLine: 31 + startLine: 64 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public NinePatch(TextureRegion texture, int padding) parameters: @@ -346,80 +370,6 @@ items: - public modifiers.vb: - Public -- uid: MLEM.Textures.NinePatch.CreateRectangles(Microsoft.Xna.Framework.Rectangle,System.Single) - commentId: M:MLEM.Textures.NinePatch.CreateRectangles(Microsoft.Xna.Framework.Rectangle,System.Single) - id: CreateRectangles(Microsoft.Xna.Framework.Rectangle,System.Single) - parent: MLEM.Textures.NinePatch - langs: - - csharp - - vb - name: CreateRectangles(Rectangle, Single) - nameWithType: NinePatch.CreateRectangles(Rectangle, Single) - fullName: MLEM.Textures.NinePatch.CreateRectangles(Microsoft.Xna.Framework.Rectangle, System.Single) - type: Method - source: - remote: - path: MLEM/Textures/NinePatch.cs - branch: master - repo: https://github.com/Ellpeck/MLEM - id: CreateRectangles - path: ../MLEM/Textures/NinePatch.cs - startLine: 34 - assemblies: - - MLEM - namespace: MLEM.Textures - syntax: - content: public IEnumerable CreateRectangles(Rectangle area, float patchScale = 1F) - parameters: - - id: area - type: Microsoft.Xna.Framework.Rectangle - - id: patchScale - type: System.Single - return: - type: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Rectangle} - content.vb: Public Function CreateRectangles(area As Rectangle, patchScale As Single = 1F) As IEnumerable(Of Rectangle) - overload: MLEM.Textures.NinePatch.CreateRectangles* - modifiers.csharp: - - public - modifiers.vb: - - Public -- uid: MLEM.Textures.NinePatch.CreateRectangles(MLEM.Misc.RectangleF,System.Single) - commentId: M:MLEM.Textures.NinePatch.CreateRectangles(MLEM.Misc.RectangleF,System.Single) - id: CreateRectangles(MLEM.Misc.RectangleF,System.Single) - parent: MLEM.Textures.NinePatch - langs: - - csharp - - vb - name: CreateRectangles(RectangleF, Single) - nameWithType: NinePatch.CreateRectangles(RectangleF, Single) - fullName: MLEM.Textures.NinePatch.CreateRectangles(MLEM.Misc.RectangleF, System.Single) - type: Method - source: - remote: - path: MLEM/Textures/NinePatch.cs - branch: master - repo: https://github.com/Ellpeck/MLEM - id: CreateRectangles - path: ../MLEM/Textures/NinePatch.cs - startLine: 38 - assemblies: - - MLEM - namespace: MLEM.Textures - syntax: - content: public IEnumerable CreateRectangles(RectangleF area, float patchScale = 1F) - parameters: - - id: area - type: MLEM.Misc.RectangleF - - id: patchScale - type: System.Single - return: - type: System.Collections.Generic.IEnumerable{MLEM.Misc.RectangleF} - content.vb: Public Function CreateRectangles(area As RectangleF, patchScale As Single = 1F) As IEnumerable(Of RectangleF) - overload: MLEM.Textures.NinePatch.CreateRectangles* - modifiers.csharp: - - public - modifiers.vb: - - Public references: - uid: MLEM.Textures commentId: N:MLEM.Textures @@ -941,6 +891,9 @@ references: name: Padding nameWithType: Padding fullName: MLEM.Misc.Padding +- uid: MLEM.Textures.NinePatch.Padding + commentId: F:MLEM.Textures.NinePatch.Padding + isExternal: true - uid: Microsoft.Xna.Framework.Rectangle[] isExternal: true name: Rectangle[] @@ -979,6 +932,9 @@ references: name: Int32 nameWithType: Int32 fullName: System.Int32 +- uid: MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32,System.Int32,System.Int32,System.Int32) + commentId: M:MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32,System.Int32,System.Int32,System.Int32) + isExternal: true - uid: Microsoft.Xna.Framework.Graphics.Texture2D commentId: T:Microsoft.Xna.Framework.Graphics.Texture2D parent: Microsoft.Xna.Framework.Graphics @@ -992,165 +948,6 @@ references: name: Microsoft.Xna.Framework.Graphics nameWithType: Microsoft.Xna.Framework.Graphics fullName: Microsoft.Xna.Framework.Graphics -- uid: MLEM.Textures.NinePatch.CreateRectangles* - commentId: Overload:MLEM.Textures.NinePatch.CreateRectangles - name: CreateRectangles - nameWithType: NinePatch.CreateRectangles - fullName: MLEM.Textures.NinePatch.CreateRectangles -- uid: Microsoft.Xna.Framework.Rectangle - commentId: T:Microsoft.Xna.Framework.Rectangle - parent: Microsoft.Xna.Framework +- uid: MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32) + commentId: M:MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32) isExternal: true - name: Rectangle - nameWithType: Rectangle - fullName: Microsoft.Xna.Framework.Rectangle -- uid: System.Single - commentId: T:System.Single - parent: System - isExternal: true - name: Single - nameWithType: Single - fullName: System.Single -- uid: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Rectangle} - commentId: T:System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Rectangle} - parent: System.Collections.Generic - definition: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - nameWithType.vb: IEnumerable(Of Rectangle) - fullName.vb: System.Collections.Generic.IEnumerable(Of Microsoft.Xna.Framework.Rectangle) - name.vb: IEnumerable(Of Rectangle) - spec.csharp: - - uid: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - isExternal: true - - name: < - nameWithType: < - fullName: < - - uid: Microsoft.Xna.Framework.Rectangle - name: Rectangle - nameWithType: Rectangle - fullName: Microsoft.Xna.Framework.Rectangle - isExternal: true - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - isExternal: true - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - uid: Microsoft.Xna.Framework.Rectangle - name: Rectangle - nameWithType: Rectangle - fullName: Microsoft.Xna.Framework.Rectangle - isExternal: true - - name: ) - nameWithType: ) - fullName: ) -- uid: Microsoft.Xna.Framework - commentId: N:Microsoft.Xna.Framework - isExternal: true - name: Microsoft.Xna.Framework - nameWithType: Microsoft.Xna.Framework - fullName: Microsoft.Xna.Framework -- uid: System.Collections.Generic.IEnumerable`1 - commentId: T:System.Collections.Generic.IEnumerable`1 - isExternal: true - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - nameWithType.vb: IEnumerable(Of T) - fullName.vb: System.Collections.Generic.IEnumerable(Of T) - name.vb: IEnumerable(Of T) - spec.csharp: - - uid: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - isExternal: true - - name: < - nameWithType: < - fullName: < - - name: T - nameWithType: T - fullName: T - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - isExternal: true - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - name: T - nameWithType: T - fullName: T - - name: ) - nameWithType: ) - fullName: ) -- uid: System.Collections.Generic - commentId: N:System.Collections.Generic - isExternal: true - name: System.Collections.Generic - nameWithType: System.Collections.Generic - fullName: System.Collections.Generic -- uid: MLEM.Misc.RectangleF - commentId: T:MLEM.Misc.RectangleF - parent: MLEM.Misc - name: RectangleF - nameWithType: RectangleF - fullName: MLEM.Misc.RectangleF -- uid: System.Collections.Generic.IEnumerable{MLEM.Misc.RectangleF} - commentId: T:System.Collections.Generic.IEnumerable{MLEM.Misc.RectangleF} - parent: System.Collections.Generic - definition: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - nameWithType.vb: IEnumerable(Of RectangleF) - fullName.vb: System.Collections.Generic.IEnumerable(Of MLEM.Misc.RectangleF) - name.vb: IEnumerable(Of RectangleF) - spec.csharp: - - uid: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - isExternal: true - - name: < - nameWithType: < - fullName: < - - uid: MLEM.Misc.RectangleF - name: RectangleF - nameWithType: RectangleF - fullName: MLEM.Misc.RectangleF - - name: '>' - nameWithType: '>' - fullName: '>' - spec.vb: - - uid: System.Collections.Generic.IEnumerable`1 - name: IEnumerable - nameWithType: IEnumerable - fullName: System.Collections.Generic.IEnumerable - isExternal: true - - name: '(Of ' - nameWithType: '(Of ' - fullName: '(Of ' - - uid: MLEM.Misc.RectangleF - name: RectangleF - nameWithType: RectangleF - fullName: MLEM.Misc.RectangleF - - name: ) - nameWithType: ) - fullName: ) diff --git a/Docs/api/MLEM.Textures.NinePatchExtensions.yml b/Docs/api/MLEM.Textures.NinePatchExtensions.yml index 4b8f632..2ca82f5 100644 --- a/Docs/api/MLEM.Textures.NinePatchExtensions.yml +++ b/Docs/api/MLEM.Textures.NinePatchExtensions.yml @@ -23,10 +23,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: NinePatchExtensions path: ../MLEM/Textures/NinePatch.cs - startLine: 64 + startLine: 100 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nA set of extensions that allow for rendering\n" + example: [] syntax: content: public static class NinePatchExtensions content.vb: Public Module NinePatchExtensions @@ -66,31 +68,42 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/NinePatch.cs - startLine: 66 + startLine: 114 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nDraws a nine patch area using the given sprite batch\n" + example: [] syntax: content: public static void Draw(this SpriteBatch batch, NinePatch texture, RectangleF destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth, float patchScale = 1F) parameters: - id: batch type: Microsoft.Xna.Framework.Graphics.SpriteBatch + description: The batch to draw with - id: texture type: MLEM.Textures.NinePatch + description: The nine patch to draw - id: destinationRectangle type: MLEM.Misc.RectangleF + description: The area that should be covered by this nine patch - id: color type: Microsoft.Xna.Framework.Color + description: The color to use - id: rotation type: System.Single + description: The rotation - id: origin type: Microsoft.Xna.Framework.Vector2 + description: The origin position - id: effects type: Microsoft.Xna.Framework.Graphics.SpriteEffects + description: The effects that the sprite should have - id: layerDepth type: System.Single + description: The depth - id: patchScale type: System.Single + description: The scale of each area of the nine patch content.vb: >- @@ -121,10 +134,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/NinePatch.cs - startLine: 76 + startLine: 125 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, NinePatch texture, Rectangle destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth, float patchScale = 1F) parameters: @@ -176,10 +190,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/NinePatch.cs - startLine: 80 + startLine: 130 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, NinePatch texture, RectangleF destinationRectangle, Color color, float patchScale = 1F) parameters: @@ -223,10 +238,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/NinePatch.cs - startLine: 84 + startLine: 135 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, NinePatch texture, Rectangle destinationRectangle, Color color, float patchScale = 1F) parameters: @@ -252,6 +268,12 @@ items: - Public - Shared references: +- uid: MLEM.Textures.NinePatch + commentId: T:MLEM.Textures.NinePatch + parent: MLEM.Textures + name: NinePatch + nameWithType: NinePatch + fullName: MLEM.Textures.NinePatch - uid: MLEM.Textures commentId: N:MLEM.Textures name: MLEM.Textures @@ -561,12 +583,6 @@ references: name: SpriteBatch nameWithType: SpriteBatch fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch -- uid: MLEM.Textures.NinePatch - commentId: T:MLEM.Textures.NinePatch - parent: MLEM.Textures - name: NinePatch - nameWithType: NinePatch - fullName: MLEM.Textures.NinePatch - uid: MLEM.Misc.RectangleF commentId: T:MLEM.Misc.RectangleF parent: MLEM.Misc @@ -618,6 +634,9 @@ references: name: Microsoft.Xna.Framework nameWithType: Microsoft.Xna.Framework fullName: Microsoft.Xna.Framework +- uid: MLEM.Textures.NinePatchExtensions.Draw(Microsoft.Xna.Framework.Graphics.SpriteBatch,MLEM.Textures.NinePatch,MLEM.Misc.RectangleF,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single,System.Single) + commentId: M:MLEM.Textures.NinePatchExtensions.Draw(Microsoft.Xna.Framework.Graphics.SpriteBatch,MLEM.Textures.NinePatch,MLEM.Misc.RectangleF,Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single,System.Single) + isExternal: true - uid: Microsoft.Xna.Framework.Rectangle commentId: T:Microsoft.Xna.Framework.Rectangle parent: Microsoft.Xna.Framework diff --git a/Docs/api/MLEM.Textures.TextureRegion.yml b/Docs/api/MLEM.Textures.TextureRegion.yml index 679e2ca..9c5ae4f 100644 --- a/Docs/api/MLEM.Textures.TextureRegion.yml +++ b/Docs/api/MLEM.Textures.TextureRegion.yml @@ -31,14 +31,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: TextureRegion path: ../MLEM/Textures/TextureRegion.cs - startLine: 6 + startLine: 9 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThis class represents a part of a texture.\n" + example: [] syntax: content: 'public class TextureRegion : GenericDataHolder' content.vb: >- Public Class TextureRegion + Inherits GenericDataHolder inheritance: - System.Object @@ -80,10 +83,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Texture path: ../MLEM/Textures/TextureRegion.cs - startLine: 8 + startLine: 14 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe texture that this region is a part of\n" + example: [] syntax: content: public readonly Texture2D Texture return: @@ -113,10 +118,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Area path: ../MLEM/Textures/TextureRegion.cs - startLine: 9 + startLine: 18 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe area that is covered by this texture region\n" + example: [] syntax: content: public readonly Rectangle Area return: @@ -146,10 +153,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Position path: ../MLEM/Textures/TextureRegion.cs - startLine: 10 + startLine: 22 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe top left corner of this texture region\n" + example: [] syntax: content: public Point Position { get; } parameters: [] @@ -181,10 +190,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: U path: ../MLEM/Textures/TextureRegion.cs - startLine: 11 + startLine: 26 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe x coordinate of the top left corner of this texture region\n" + example: [] syntax: content: public int U { get; } parameters: [] @@ -216,10 +227,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: V path: ../MLEM/Textures/TextureRegion.cs - startLine: 12 + startLine: 30 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe y coordinate of the top left corner of this texture region\n" + example: [] syntax: content: public int V { get; } parameters: [] @@ -251,10 +264,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Size path: ../MLEM/Textures/TextureRegion.cs - startLine: 13 + startLine: 34 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe size of this texture region\n" + example: [] syntax: content: public Point Size { get; } parameters: [] @@ -286,10 +301,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Width path: ../MLEM/Textures/TextureRegion.cs - startLine: 14 + startLine: 38 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe width of this texture region\n" + example: [] syntax: content: public int Width { get; } parameters: [] @@ -321,10 +338,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Height path: ../MLEM/Textures/TextureRegion.cs - startLine: 15 + startLine: 42 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe height of this texture region\n" + example: [] syntax: content: public int Height { get; } parameters: [] @@ -356,17 +375,21 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/TextureRegion.cs - startLine: 17 + startLine: 49 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new texture region from a texture and a rectangle which defines the region's area\n" + example: [] syntax: content: public TextureRegion(Texture2D texture, Rectangle area) parameters: - id: texture type: Microsoft.Xna.Framework.Graphics.Texture2D + description: The texture to use - id: area type: Microsoft.Xna.Framework.Rectangle + description: The area that this texture region should cover content.vb: Public Sub New(texture As Texture2D, area As Rectangle) overload: MLEM.Textures.TextureRegion.#ctor* modifiers.csharp: @@ -391,15 +414,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/TextureRegion.cs - startLine: 22 + startLine: 58 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new texture region that spans the entire texture\n" + example: [] syntax: content: public TextureRegion(Texture2D texture) parameters: - id: texture type: Microsoft.Xna.Framework.Graphics.Texture2D + description: The texture to use content.vb: Public Sub New(texture As Texture2D) overload: MLEM.Textures.TextureRegion.#ctor* modifiers.csharp: @@ -424,23 +450,30 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/TextureRegion.cs - startLine: 25 + startLine: 69 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new texture region based on a texture and area coordinates\n" + example: [] syntax: content: public TextureRegion(Texture2D texture, int u, int v, int width, int height) parameters: - id: texture type: Microsoft.Xna.Framework.Graphics.Texture2D + description: The texture to use - id: u type: System.Int32 + description: The x coordinate of the top left corner of this area - id: v type: System.Int32 + description: The y coordinate of the top left corner of this area - id: width type: System.Int32 + description: The width of this area - id: height type: System.Int32 + description: The height of this area content.vb: Public Sub New(texture As Texture2D, u As Integer, v As Integer, width As Integer, height As Integer) overload: MLEM.Textures.TextureRegion.#ctor* modifiers.csharp: @@ -465,19 +498,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/TextureRegion.cs - startLine: 28 + startLine: 78 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new texture region based on a texture, a position and a size\n" + example: [] syntax: content: public TextureRegion(Texture2D texture, Point uv, Point size) parameters: - id: texture type: Microsoft.Xna.Framework.Graphics.Texture2D + description: The texture to use - id: uv type: Microsoft.Xna.Framework.Point + description: The top left corner of this area - id: size type: Microsoft.Xna.Framework.Point + description: The size of this area content.vb: Public Sub New(texture As Texture2D, uv As Point, size As Point) overload: MLEM.Textures.TextureRegion.#ctor* modifiers.csharp: diff --git a/Docs/api/MLEM.Textures.TextureRegionExtensions.yml b/Docs/api/MLEM.Textures.TextureRegionExtensions.yml index e20ac12..3989b21 100644 --- a/Docs/api/MLEM.Textures.TextureRegionExtensions.yml +++ b/Docs/api/MLEM.Textures.TextureRegionExtensions.yml @@ -26,10 +26,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: TextureRegionExtensions path: ../MLEM/Textures/TextureRegion.cs - startLine: 33 + startLine: 86 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThis class provides a set of extension methods for dealing with \n" + example: [] syntax: content: public static class TextureRegionExtensions content.vb: Public Module TextureRegionExtensions @@ -69,10 +71,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/TextureRegion.cs - startLine: 35 + startLine: 89 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Vector2 position, Color color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth) parameters: @@ -124,10 +127,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/TextureRegion.cs - startLine: 39 + startLine: 94 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Vector2 position, Color color, float rotation, Vector2 origin, float scale, SpriteEffects effects, float layerDepth) parameters: @@ -179,10 +183,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/TextureRegion.cs - startLine: 43 + startLine: 99 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Rectangle destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth) parameters: @@ -232,10 +237,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/TextureRegion.cs - startLine: 47 + startLine: 104 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, TextureRegion texture, RectangleF destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth) parameters: @@ -285,10 +291,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/TextureRegion.cs - startLine: 51 + startLine: 109 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Vector2 position, Color color) parameters: @@ -330,10 +337,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/TextureRegion.cs - startLine: 55 + startLine: 114 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Rectangle destinationRectangle, Color color) parameters: @@ -375,10 +383,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: Draw path: ../MLEM/Textures/TextureRegion.cs - startLine: 59 + startLine: 119 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public static void Draw(this SpriteBatch batch, TextureRegion texture, RectangleF destinationRectangle, Color color) parameters: @@ -402,6 +411,12 @@ items: - Public - Shared references: +- uid: MLEM.Textures.TextureRegion + commentId: T:MLEM.Textures.TextureRegion + parent: MLEM.Textures + name: TextureRegion + nameWithType: TextureRegion + fullName: MLEM.Textures.TextureRegion - uid: MLEM.Textures commentId: N:MLEM.Textures name: MLEM.Textures @@ -699,6 +714,9 @@ references: name: System nameWithType: System fullName: System +- uid: Microsoft.Xna.Framework.Graphics.SpriteBatch.Draw(Microsoft.Xna.Framework.Graphics.Texture2D,Microsoft.Xna.Framework.Vector2,System.Nullable{Microsoft.Xna.Framework.Rectangle},Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single) + commentId: M:Microsoft.Xna.Framework.Graphics.SpriteBatch.Draw(Microsoft.Xna.Framework.Graphics.Texture2D,Microsoft.Xna.Framework.Vector2,System.Nullable{Microsoft.Xna.Framework.Rectangle},Microsoft.Xna.Framework.Color,System.Single,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Vector2,Microsoft.Xna.Framework.Graphics.SpriteEffects,System.Single) + isExternal: true - uid: MLEM.Textures.TextureRegionExtensions.Draw* commentId: Overload:MLEM.Textures.TextureRegionExtensions.Draw name: Draw @@ -711,12 +729,6 @@ references: name: SpriteBatch nameWithType: SpriteBatch fullName: Microsoft.Xna.Framework.Graphics.SpriteBatch -- uid: MLEM.Textures.TextureRegion - commentId: T:MLEM.Textures.TextureRegion - parent: MLEM.Textures - name: TextureRegion - nameWithType: TextureRegion - fullName: MLEM.Textures.TextureRegion - uid: Microsoft.Xna.Framework.Vector2 commentId: T:Microsoft.Xna.Framework.Vector2 parent: Microsoft.Xna.Framework diff --git a/Docs/api/MLEM.Textures.UniformTextureAtlas.yml b/Docs/api/MLEM.Textures.UniformTextureAtlas.yml index 9b63367..5506c5b 100644 --- a/Docs/api/MLEM.Textures.UniformTextureAtlas.yml +++ b/Docs/api/MLEM.Textures.UniformTextureAtlas.yml @@ -30,14 +30,17 @@ items: repo: https://github.com/Ellpeck/MLEM id: UniformTextureAtlas path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 7 + startLine: 12 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThis class represents an atlas of objects that is uniform.\nUniform, in this case, means that the texture atlas' size is not determined by the width and height of the texture, but instead by the amount of sub-regions that the atlas has in the x and y direction.\nUsing a uniform texture atlas over a regular texture as an atlas allows for texture artists to create higher resolution textures without coordinates becoming off.\n" + example: [] syntax: content: 'public class UniformTextureAtlas : GenericDataHolder' content.vb: >- Public Class UniformTextureAtlas + Inherits GenericDataHolder inheritance: - System.Object @@ -77,10 +80,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: Texture path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 9 + startLine: 17 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe texture to use for this atlas\n" + example: [] syntax: content: public readonly Texture2D Texture return: @@ -110,10 +115,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RegionAmountX path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 10 + startLine: 21 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe amount of sub-regions this atlas has in the x direction\n" + example: [] syntax: content: public readonly int RegionAmountX return: @@ -143,10 +150,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RegionAmountY path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 11 + startLine: 25 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe amount of sub-regions this atlas has in the y direction\n" + example: [] syntax: content: public readonly int RegionAmountY return: @@ -176,10 +185,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RegionWidth path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 12 + startLine: 29 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe width of each region, based on the texture's width and the amount of regions\n" + example: [] syntax: content: public readonly int RegionWidth return: @@ -209,10 +220,12 @@ items: repo: https://github.com/Ellpeck/MLEM id: RegionHeight path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 13 + startLine: 33 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nThe height of reach region, based on the texture's height and the amount of regions\n" + example: [] syntax: content: public readonly int RegionHeight return: @@ -242,15 +255,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: this[] path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 14 + startLine: 39 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nReturns the at this texture atlas's given index.\nThe index is zero-based, where rows come first and columns come second.\n" + example: [] syntax: content: public TextureRegion this[int index] { get; } parameters: - id: index type: System.Int32 + description: The zero-based texture index return: type: MLEM.Textures.TextureRegion content.vb: Public ReadOnly Property Item(index As Integer) As TextureRegion @@ -282,15 +298,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: this[] path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 15 + startLine: 44 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nReturns the at this texture atlas' given region position\n" + example: [] syntax: content: public TextureRegion this[Point point] { get; } parameters: - id: point type: Microsoft.Xna.Framework.Point + description: The region's x and y location return: type: MLEM.Textures.TextureRegion content.vb: Public ReadOnly Property Item(point As Point) As TextureRegion @@ -322,10 +341,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: this[] path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 16 + startLine: 46 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public TextureRegion this[int x, int y] { get; } parameters: @@ -364,15 +384,18 @@ items: repo: https://github.com/Ellpeck/MLEM id: this[] path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 17 + startLine: 52 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nReturns the at this texture atlas' given region position and size.\nNote that the region size is not in pixels, but in region units.\n" + example: [] syntax: content: public TextureRegion this[Rectangle rect] { get; } parameters: - id: rect type: Microsoft.Xna.Framework.Rectangle + description: The region's area return: type: MLEM.Textures.TextureRegion content.vb: Public ReadOnly Property Item(rect As Rectangle) As TextureRegion @@ -404,10 +427,11 @@ items: repo: https://github.com/Ellpeck/MLEM id: this[] path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 18 + startLine: 54 assemblies: - MLEM namespace: MLEM.Textures + example: [] syntax: content: public TextureRegion this[int x, int y, int width, int height] { get; } parameters: @@ -450,19 +474,24 @@ items: repo: https://github.com/Ellpeck/MLEM id: .ctor path: ../MLEM/Textures/UniformTextureAtlas.cs - startLine: 22 + startLine: 64 assemblies: - MLEM namespace: MLEM.Textures + summary: "\nCreates a new uniform texture atlas with the given texture and region amount.\n" + example: [] syntax: content: public UniformTextureAtlas(Texture2D texture, int regionAmountX, int regionAmountY) parameters: - id: texture type: Microsoft.Xna.Framework.Graphics.Texture2D + description: The texture to use for this atlas - id: regionAmountX type: System.Int32 + description: The amount of texture regions in the x direction - id: regionAmountY type: System.Int32 + description: The amount of texture regions in the y direction content.vb: Public Sub New(texture As Texture2D, regionAmountX As Integer, regionAmountY As Integer) overload: MLEM.Textures.UniformTextureAtlas.#ctor* modifiers.csharp: @@ -470,6 +499,12 @@ items: modifiers.vb: - Public references: +- uid: MLEM.Textures.TextureRegion + commentId: T:MLEM.Textures.TextureRegion + parent: MLEM.Textures + name: TextureRegion + nameWithType: TextureRegion + fullName: MLEM.Textures.TextureRegion - uid: MLEM.Textures commentId: N:MLEM.Textures name: MLEM.Textures @@ -928,12 +963,6 @@ references: name: Item nameWithType: UniformTextureAtlas.Item fullName: MLEM.Textures.UniformTextureAtlas.Item -- uid: MLEM.Textures.TextureRegion - commentId: T:MLEM.Textures.TextureRegion - parent: MLEM.Textures - name: TextureRegion - nameWithType: TextureRegion - fullName: MLEM.Textures.TextureRegion - uid: Microsoft.Xna.Framework.Point commentId: T:Microsoft.Xna.Framework.Point parent: Microsoft.Xna.Framework @@ -947,6 +976,9 @@ references: name: Microsoft.Xna.Framework nameWithType: Microsoft.Xna.Framework fullName: Microsoft.Xna.Framework +- uid: MLEM.Textures.UniformTextureAtlas.Item(Microsoft.Xna.Framework.Point) + commentId: P:MLEM.Textures.UniformTextureAtlas.Item(Microsoft.Xna.Framework.Point) + isExternal: true - uid: Microsoft.Xna.Framework.Rectangle commentId: T:Microsoft.Xna.Framework.Rectangle parent: Microsoft.Xna.Framework @@ -954,6 +986,9 @@ references: name: Rectangle nameWithType: Rectangle fullName: Microsoft.Xna.Framework.Rectangle +- uid: MLEM.Textures.UniformTextureAtlas.Item(Microsoft.Xna.Framework.Rectangle) + commentId: P:MLEM.Textures.UniformTextureAtlas.Item(Microsoft.Xna.Framework.Rectangle) + isExternal: true - uid: MLEM.Textures.UniformTextureAtlas.#ctor* commentId: Overload:MLEM.Textures.UniformTextureAtlas.#ctor name: UniformTextureAtlas diff --git a/Docs/api/MLEM.Ui.Elements.Button.yml b/Docs/api/MLEM.Ui.Elements.Button.yml index df08b3c..cf0c33a 100644 --- a/Docs/api/MLEM.Ui.Elements.Button.yml +++ b/Docs/api/MLEM.Ui.Elements.Button.yml @@ -39,6 +39,7 @@ items: content: 'public class Button : Element' content.vb: >- Public Class Button + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Checkbox.yml b/Docs/api/MLEM.Ui.Elements.Checkbox.yml index f493477..a7c0e94 100644 --- a/Docs/api/MLEM.Ui.Elements.Checkbox.yml +++ b/Docs/api/MLEM.Ui.Elements.Checkbox.yml @@ -39,6 +39,7 @@ items: content: 'public class Checkbox : Element' content.vb: >- Public Class Checkbox + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.CustomDrawGroup.yml b/Docs/api/MLEM.Ui.Elements.CustomDrawGroup.yml index 2751cec..1452f31 100644 --- a/Docs/api/MLEM.Ui.Elements.CustomDrawGroup.yml +++ b/Docs/api/MLEM.Ui.Elements.CustomDrawGroup.yml @@ -33,6 +33,7 @@ items: content: 'public class CustomDrawGroup : Group' content.vb: >- Public Class CustomDrawGroup + Inherits Group inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Dropdown.yml b/Docs/api/MLEM.Ui.Elements.Dropdown.yml index 12603d1..b087cf5 100644 --- a/Docs/api/MLEM.Ui.Elements.Dropdown.yml +++ b/Docs/api/MLEM.Ui.Elements.Dropdown.yml @@ -34,6 +34,7 @@ items: content: 'public class Dropdown : Button' content.vb: >- Public Class Dropdown + Inherits Button inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Element.yml b/Docs/api/MLEM.Ui.Elements.Element.yml index eaa9aa9..79a175a 100644 --- a/Docs/api/MLEM.Ui.Elements.Element.yml +++ b/Docs/api/MLEM.Ui.Elements.Element.yml @@ -109,6 +109,7 @@ items: content: 'public abstract class Element : GenericDataHolder' content.vb: >- Public MustInherit Class Element + Inherits GenericDataHolder inheritance: - System.Object @@ -1941,6 +1942,7 @@ items: syntax: content: >- public T AddChild(T element, int index = -1) + where T : Element parameters: - id: element @@ -2499,6 +2501,7 @@ items: syntax: content: >- public IEnumerable GetChildren(Func condition = null, bool regardGrandchildren = false, bool ignoreFalseGrandchildren = false) + where T : Element parameters: - id: condition diff --git a/Docs/api/MLEM.Ui.Elements.Group.yml b/Docs/api/MLEM.Ui.Elements.Group.yml index 882aa6f..226e4e3 100644 --- a/Docs/api/MLEM.Ui.Elements.Group.yml +++ b/Docs/api/MLEM.Ui.Elements.Group.yml @@ -29,6 +29,7 @@ items: content: 'public class Group : Element' content.vb: >- Public Class Group + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Image.yml b/Docs/api/MLEM.Ui.Elements.Image.yml index 0923995..7b9f2b6 100644 --- a/Docs/api/MLEM.Ui.Elements.Image.yml +++ b/Docs/api/MLEM.Ui.Elements.Image.yml @@ -39,6 +39,7 @@ items: content: 'public class Image : Element' content.vb: >- Public Class Image + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Panel.yml b/Docs/api/MLEM.Ui.Elements.Panel.yml index 987cd8a..716055f 100644 --- a/Docs/api/MLEM.Ui.Elements.Panel.yml +++ b/Docs/api/MLEM.Ui.Elements.Panel.yml @@ -38,6 +38,7 @@ items: content: 'public class Panel : Element' content.vb: >- Public Class Panel + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Paragraph.Link.yml b/Docs/api/MLEM.Ui.Elements.Paragraph.Link.yml index 2da0906..418f586 100644 --- a/Docs/api/MLEM.Ui.Elements.Paragraph.Link.yml +++ b/Docs/api/MLEM.Ui.Elements.Paragraph.Link.yml @@ -31,6 +31,7 @@ items: content: 'public class Link : Element' content.vb: >- Public Class Link + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Paragraph.yml b/Docs/api/MLEM.Ui.Elements.Paragraph.yml index 1a012df..70edc3c 100644 --- a/Docs/api/MLEM.Ui.Elements.Paragraph.yml +++ b/Docs/api/MLEM.Ui.Elements.Paragraph.yml @@ -47,6 +47,7 @@ items: content: 'public class Paragraph : Element' content.vb: >- Public Class Paragraph + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.ProgressBar.yml b/Docs/api/MLEM.Ui.Elements.ProgressBar.yml index 8907054..61966ff 100644 --- a/Docs/api/MLEM.Ui.Elements.ProgressBar.yml +++ b/Docs/api/MLEM.Ui.Elements.ProgressBar.yml @@ -38,6 +38,7 @@ items: content: 'public class ProgressBar : Element' content.vb: >- Public Class ProgressBar + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.RadioButton.yml b/Docs/api/MLEM.Ui.Elements.RadioButton.yml index aa1bd6c..2fc8690 100644 --- a/Docs/api/MLEM.Ui.Elements.RadioButton.yml +++ b/Docs/api/MLEM.Ui.Elements.RadioButton.yml @@ -30,6 +30,7 @@ items: content: 'public class RadioButton : Checkbox' content.vb: >- Public Class RadioButton + Inherits Checkbox inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.ScrollBar.yml b/Docs/api/MLEM.Ui.Elements.ScrollBar.yml index adcdec9..cedb1fe 100644 --- a/Docs/api/MLEM.Ui.Elements.ScrollBar.yml +++ b/Docs/api/MLEM.Ui.Elements.ScrollBar.yml @@ -44,6 +44,7 @@ items: content: 'public class ScrollBar : Element' content.vb: >- Public Class ScrollBar + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Slider.yml b/Docs/api/MLEM.Ui.Elements.Slider.yml index a3018f7..ea4b2a6 100644 --- a/Docs/api/MLEM.Ui.Elements.Slider.yml +++ b/Docs/api/MLEM.Ui.Elements.Slider.yml @@ -29,6 +29,7 @@ items: content: 'public class Slider : ScrollBar' content.vb: >- Public Class Slider + Inherits ScrollBar inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.SpriteAnimationImage.yml b/Docs/api/MLEM.Ui.Elements.SpriteAnimationImage.yml index fd0efc2..a4aac3a 100644 --- a/Docs/api/MLEM.Ui.Elements.SpriteAnimationImage.yml +++ b/Docs/api/MLEM.Ui.Elements.SpriteAnimationImage.yml @@ -31,6 +31,7 @@ items: content: 'public class SpriteAnimationImage : Image' content.vb: >- Public Class SpriteAnimationImage + Inherits Image inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.TextField.yml b/Docs/api/MLEM.Ui.Elements.TextField.yml index 1cdd673..e8e5159 100644 --- a/Docs/api/MLEM.Ui.Elements.TextField.yml +++ b/Docs/api/MLEM.Ui.Elements.TextField.yml @@ -54,6 +54,7 @@ items: content: 'public class TextField : Element' content.vb: >- Public Class TextField + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.Tooltip.yml b/Docs/api/MLEM.Ui.Elements.Tooltip.yml index a16346a..2b347ae 100644 --- a/Docs/api/MLEM.Ui.Elements.Tooltip.yml +++ b/Docs/api/MLEM.Ui.Elements.Tooltip.yml @@ -34,6 +34,7 @@ items: content: 'public class Tooltip : Panel' content.vb: >- Public Class Tooltip + Inherits Panel inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Elements.VerticalSpace.yml b/Docs/api/MLEM.Ui.Elements.VerticalSpace.yml index 22da07d..0e87f8f 100644 --- a/Docs/api/MLEM.Ui.Elements.VerticalSpace.yml +++ b/Docs/api/MLEM.Ui.Elements.VerticalSpace.yml @@ -28,6 +28,7 @@ items: content: 'public class VerticalSpace : Element' content.vb: >- Public Class VerticalSpace + Inherits Element inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Style.UiStyle.yml b/Docs/api/MLEM.Ui.Style.UiStyle.yml index 5bf58e6..efd5023 100644 --- a/Docs/api/MLEM.Ui.Style.UiStyle.yml +++ b/Docs/api/MLEM.Ui.Style.UiStyle.yml @@ -60,6 +60,7 @@ items: content: 'public class UiStyle : GenericDataHolder' content.vb: >- Public Class UiStyle + Inherits GenericDataHolder inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.Style.UntexturedStyle.yml b/Docs/api/MLEM.Ui.Style.UntexturedStyle.yml index 2e4bb04..0ffeb61 100644 --- a/Docs/api/MLEM.Ui.Style.UntexturedStyle.yml +++ b/Docs/api/MLEM.Ui.Style.UntexturedStyle.yml @@ -28,6 +28,7 @@ items: content: 'public class UntexturedStyle : UiStyle' content.vb: >- Public Class UntexturedStyle + Inherits UiStyle inheritance: - System.Object diff --git a/Docs/api/MLEM.Ui.UiSystem.yml b/Docs/api/MLEM.Ui.UiSystem.yml index dffe11b..42735c2 100644 --- a/Docs/api/MLEM.Ui.UiSystem.yml +++ b/Docs/api/MLEM.Ui.UiSystem.yml @@ -62,7 +62,9 @@ items: content: 'public class UiSystem : GameComponent, IGameComponent, IUpdateable, IComparable, IDisposable' content.vb: >- Public Class UiSystem + Inherits GameComponent + Implements IGameComponent, IUpdateable, IComparable(Of GameComponent), IDisposable inheritance: - System.Object diff --git a/build.cake b/build.cake index 68b2a3a..4c37e30 100644 --- a/build.cake +++ b/build.cake @@ -53,7 +53,11 @@ Task("Push").IsDependentOn("Pack").Does(() => { NuGetPush(GetFiles("**/*.nupkg"), settings); }); -Task("Document").Does(() => DocFxBuild("Docs/docfx.json")); +Task("Document").Does(() => { + var path = "Docs/docfx.json"; + DocFxMetadata(path); + DocFxBuild(path); +}); Task("Default").IsDependentOn("Pack");