1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-06-29 23:56:35 +02:00

also use documentation metadata for cake builds

This commit is contained in:
Ellpeck 2020-05-21 23:19:16 +02:00
parent 508d3cf077
commit 9573682304
101 changed files with 2935 additions and 1138 deletions

View file

@ -405,7 +405,6 @@
"MLEM.Formatting.TextStyle.Regular": "MLEM.Formatting.TextStyle.yml", "MLEM.Formatting.TextStyle.Regular": "MLEM.Formatting.TextStyle.yml",
"MLEM.Formatting.TextStyle.Shadow": "MLEM.Formatting.TextStyle.yml", "MLEM.Formatting.TextStyle.Shadow": "MLEM.Formatting.TextStyle.yml",
"MLEM.Formatting.Token": "MLEM.Formatting.Token.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.AppliedCodes": "MLEM.Formatting.Token.yml",
"MLEM.Formatting.Token.DisplayString": "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", "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.RawSubstring": "MLEM.Formatting.Token.yml",
"MLEM.Formatting.Token.Substring": "MLEM.Formatting.Token.yml", "MLEM.Formatting.Token.Substring": "MLEM.Formatting.Token.yml",
"MLEM.Formatting.TokenizedString": "MLEM.Formatting.TokenizedString.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.AllCodes": "MLEM.Formatting.TokenizedString.yml",
"MLEM.Formatting.TokenizedString.DisplayString": "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", "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,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)": "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.#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.Padding": "MLEM.Textures.NinePatch.yml",
"MLEM.Textures.NinePatch.Region": "MLEM.Textures.NinePatch.yml", "MLEM.Textures.NinePatch.Region": "MLEM.Textures.NinePatch.yml",
"MLEM.Textures.NinePatch.SourceRectangles": "MLEM.Textures.NinePatch.yml", "MLEM.Textures.NinePatch.SourceRectangles": "MLEM.Textures.NinePatch.yml",

View file

@ -22,7 +22,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AnimationFrame id: AnimationFrame
path: ../MLEM/Animations/SpriteAnimation.cs path: ../MLEM/Animations/SpriteAnimation.cs
startLine: 147 startLine: 151
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations
@ -65,7 +65,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Region id: Region
path: ../MLEM/Animations/SpriteAnimation.cs path: ../MLEM/Animations/SpriteAnimation.cs
startLine: 152 startLine: 156
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations
@ -100,7 +100,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Seconds id: Seconds
path: ../MLEM/Animations/SpriteAnimation.cs path: ../MLEM/Animations/SpriteAnimation.cs
startLine: 156 startLine: 160
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations
@ -135,7 +135,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Animations/SpriteAnimation.cs path: ../MLEM/Animations/SpriteAnimation.cs
startLine: 163 startLine: 167
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations

View file

@ -19,15 +19,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Completed id: Completed
path: ../MLEM/Animations/SpriteAnimation.cs path: ../MLEM/Animations/SpriteAnimation.cs
startLine: 140 startLine: 144
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations
summary: "\nA callback for when a sprite animation is completed.\n"
example: []
syntax: syntax:
content: public delegate void Completed(SpriteAnimation animation); content: public delegate void Completed(SpriteAnimation animation);
parameters: parameters:
- id: animation - id: animation
type: MLEM.Animations.SpriteAnimation type: MLEM.Animations.SpriteAnimation
description: The animation that has completed
content.vb: Public Delegate Sub Completed(animation As SpriteAnimation) content.vb: Public Delegate Sub Completed(animation As SpriteAnimation)
modifiers.csharp: modifiers.csharp:
- public - public

View file

@ -45,6 +45,7 @@ items:
content: 'public class SpriteAnimation : GenericDataHolder' content: 'public class SpriteAnimation : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class SpriteAnimation Public Class SpriteAnimation
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object

View file

@ -19,17 +19,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AnimationChanged id: AnimationChanged
path: ../MLEM/Animations/SpriteAnimationGroup.cs path: ../MLEM/Animations/SpriteAnimationGroup.cs
startLine: 100 startLine: 105
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations
summary: "\nA callback delegate for when a <xref href=\"MLEM.Animations.SpriteAnimationGroup\" data-throw-if-not-resolved=\"false\"></xref>&apos;s current animation changed.\n"
example: []
syntax: syntax:
content: public delegate void AnimationChanged(SpriteAnimation oldAnim, SpriteAnimation newAnim); content: public delegate void AnimationChanged(SpriteAnimation oldAnim, SpriteAnimation newAnim);
parameters: parameters:
- id: oldAnim - id: oldAnim
type: MLEM.Animations.SpriteAnimation type: MLEM.Animations.SpriteAnimation
description: The previous animation
- id: newAnim - id: newAnim
type: MLEM.Animations.SpriteAnimation type: MLEM.Animations.SpriteAnimation
description: The new animation
content.vb: Public Delegate Sub AnimationChanged(oldAnim As SpriteAnimation, newAnim As SpriteAnimation) content.vb: Public Delegate Sub AnimationChanged(oldAnim As SpriteAnimation, newAnim As SpriteAnimation)
modifiers.csharp: modifiers.csharp:
- public - public
@ -38,6 +42,12 @@ items:
- Public - Public
- Delegate - Delegate
references: references:
- uid: MLEM.Animations.SpriteAnimationGroup
commentId: T:MLEM.Animations.SpriteAnimationGroup
parent: MLEM.Animations
name: SpriteAnimationGroup
nameWithType: SpriteAnimationGroup
fullName: MLEM.Animations.SpriteAnimationGroup
- uid: MLEM.Animations - uid: MLEM.Animations
commentId: N:MLEM.Animations commentId: N:MLEM.Animations
name: MLEM.Animations name: MLEM.Animations

View file

@ -37,6 +37,7 @@ items:
content: 'public class SpriteAnimationGroup : GenericDataHolder' content: 'public class SpriteAnimationGroup : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class SpriteAnimationGroup Public Class SpriteAnimationGroup
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -224,7 +225,6 @@ items:
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations
summary: "\nThe speed multiplier that this animation should run with.\nNumbers higher than 1 will increase the speed.\n"
example: [] example: []
syntax: syntax:
content: public float SpeedMultiplier { set; } content: public float SpeedMultiplier { set; }
@ -309,14 +309,12 @@ items:
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Animations namespace: MLEM.Animations
summary: "\nUpdates this animation, causing <xref href=\"MLEM.Animations.SpriteAnimation.TimeIntoAnimation\" data-throw-if-not-resolved=\"false\"></xref> to be increased and the <xref href=\"MLEM.Animations.SpriteAnimation.CurrentFrame\" data-throw-if-not-resolved=\"false\"></xref> to be updated.\n"
example: [] example: []
syntax: syntax:
content: public void Update(GameTime time) content: public void Update(GameTime time)
parameters: parameters:
- id: time - id: time
type: Microsoft.Xna.Framework.GameTime type: Microsoft.Xna.Framework.GameTime
description: The game&apos;s time
content.vb: Public Sub Update(time As GameTime) content.vb: Public Sub Update(time As GameTime)
overload: MLEM.Animations.SpriteAnimationGroup.Update* overload: MLEM.Animations.SpriteAnimationGroup.Update*
modifiers.csharp: modifiers.csharp:

View file

@ -35,7 +35,9 @@ items:
content: 'public class RawContentManager : ContentManager, IDisposable, IGameComponent' content: 'public class RawContentManager : ContentManager, IDisposable, IGameComponent'
content.vb: >- content.vb: >-
Public Class RawContentManager Public Class RawContentManager
Inherits ContentManager Inherits ContentManager
Implements IDisposable, IGameComponent Implements IDisposable, IGameComponent
inheritance: inheritance:
- System.Object - System.Object
@ -211,10 +213,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ReloadAsset id: ReloadAsset
path: ../MLEM/Content/RawContentManager.cs path: ../MLEM/Content/RawContentManager.cs
startLine: 59 startLine: 60
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: protected override void ReloadAsset<T>(string originalAssetName, T currentAsset) content: protected override void ReloadAsset<T>(string originalAssetName, T currentAsset)
parameters: parameters:
@ -254,10 +257,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Unload id: Unload
path: ../MLEM/Content/RawContentManager.cs path: ../MLEM/Content/RawContentManager.cs
startLine: 82 startLine: 84
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public override void Unload() content: public override void Unload()
content.vb: Public Overrides Sub Unload content.vb: Public Overrides Sub Unload
@ -287,10 +291,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Initialize id: Initialize
path: ../MLEM/Content/RawContentManager.cs path: ../MLEM/Content/RawContentManager.cs
startLine: 89 startLine: 92
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public void Initialize() content: public void Initialize()
content.vb: Public Sub Initialize content.vb: Public Sub Initialize

View file

@ -22,11 +22,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RawContentReader id: RawContentReader
path: ../MLEM/Content/RawContentReader.cs path: ../MLEM/Content/RawContentReader.cs
startLine: 36 startLine: 37
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
summary: "\nRepresents a way for any kind of raw content file to be read using a <xref href=\"MLEM.Content.RawContentManager\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: [] example: []
syntax: syntax:
content: 'public abstract class RawContentReader<T> : RawContentReader' content: 'public abstract class RawContentReader<T> : RawContentReader'
@ -34,6 +33,7 @@ items:
- id: T - id: T
content.vb: >- content.vb: >-
Public MustInherit Class RawContentReader(Of T) Public MustInherit Class RawContentReader(Of T)
Inherits RawContentReader Inherits RawContentReader
inheritance: inheritance:
- System.Object - System.Object
@ -80,21 +80,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: CanRead id: CanRead
path: ../MLEM/Content/RawContentReader.cs path: ../MLEM/Content/RawContentReader.cs
startLine: 39 startLine: 40
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
summary: "\nReturns if the given type can be loaded by this content reader\n"
example: [] example: []
syntax: syntax:
content: public override bool CanRead(Type t) content: public override bool CanRead(Type t)
parameters: parameters:
- id: t - id: t
type: System.Type type: System.Type
description: The type of asset
return: return:
type: System.Boolean type: System.Boolean
description: If <see cref="!:t"></see> can be loaded by this content reader
content.vb: Public Overrides Function CanRead(t As Type) As Boolean content.vb: Public Overrides Function CanRead(t As Type) As Boolean
overridden: MLEM.Content.RawContentReader.CanRead(System.Type) overridden: MLEM.Content.RawContentReader.CanRead(System.Type)
overload: MLEM.Content.RawContentReader`1.CanRead* overload: MLEM.Content.RawContentReader`1.CanRead*
@ -124,33 +121,26 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Read id: Read
path: ../MLEM/Content/RawContentReader.cs path: ../MLEM/Content/RawContentReader.cs
startLine: 44 startLine: 45
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
summary: "\nReads the content file from disk and returns it.\n"
example: [] example: []
syntax: syntax:
content: public override object Read(RawContentManager manager, string assetPath, Stream stream, Type t, object existing) content: public override object Read(RawContentManager manager, string assetPath, Stream stream, Type t, object existing)
parameters: parameters:
- id: manager - id: manager
type: MLEM.Content.RawContentManager type: MLEM.Content.RawContentManager
description: The <xref href="MLEM.Content.RawContentManager" data-throw-if-not-resolved="false"></xref> that is loading the asset
- id: assetPath - id: assetPath
type: System.String type: System.String
description: The full path to the asset, starting from the <see cref="!:RawContentManager.RootDirectory"></see>
- id: stream - id: stream
type: System.IO.Stream type: System.IO.Stream
description: A stream that leads to this asset
- id: t - id: t
type: System.Type type: System.Type
description: The type of asset to load
- id: existing - id: existing
type: System.Object type: System.Object
description: If this asset is being reloaded, this value contains the previous version of the asset.
return: return:
type: System.Object 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 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) overridden: MLEM.Content.RawContentReader.Read(MLEM.Content.RawContentManager,System.String,System.IO.Stream,System.Type,System.Object)
overload: MLEM.Content.RawContentReader`1.Read* overload: MLEM.Content.RawContentReader`1.Read*
@ -194,7 +184,7 @@ items:
description: The <xref href="MLEM.Content.RawContentManager" data-throw-if-not-resolved="false"></xref> that is loading the asset description: The <xref href="MLEM.Content.RawContentManager" data-throw-if-not-resolved="false"></xref> that is loading the asset
- id: assetPath - id: assetPath
type: System.String type: System.String
description: The full path to the asset, starting from the <see cref="!:RawContentManager.RootDirectory"></see> description: The full path to the asset, starting from the <xref href="Microsoft.Xna.Framework.Content.ContentManager.RootDirectory" data-throw-if-not-resolved="false"></xref>
- id: stream - id: stream
type: System.IO.Stream type: System.IO.Stream
description: A stream that leads to this asset description: A stream that leads to this asset
@ -740,13 +730,33 @@ references:
name: System.IO name: System.IO
nameWithType: System.IO nameWithType: System.IO
fullName: 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}' - uid: '{T}'
commentId: '!:T' commentId: '!:T'
definition: T definition: T
name: T name: T
nameWithType: T nameWithType: T
fullName: 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 - uid: T
name: T name: T
nameWithType: T nameWithType: T
fullName: 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

View file

@ -22,7 +22,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RawContentReader id: RawContentReader
path: ../MLEM/Content/RawContentReader.cs path: ../MLEM/Content/RawContentReader.cs
startLine: 7 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
@ -71,7 +71,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: CanRead id: CanRead
path: ../MLEM/Content/RawContentReader.cs path: ../MLEM/Content/RawContentReader.cs
startLine: 14 startLine: 15
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
@ -85,7 +85,7 @@ items:
description: The type of asset description: The type of asset
return: return:
type: System.Boolean type: System.Boolean
description: If <see cref="!:t"></see> 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 content.vb: Public MustOverride Function CanRead(t As Type) As Boolean
overload: MLEM.Content.RawContentReader.CanRead* overload: MLEM.Content.RawContentReader.CanRead*
modifiers.csharp: modifiers.csharp:
@ -112,7 +112,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Read id: Read
path: ../MLEM/Content/RawContentReader.cs path: ../MLEM/Content/RawContentReader.cs
startLine: 25 startLine: 26
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
@ -126,7 +126,7 @@ items:
description: The <xref href="MLEM.Content.RawContentManager" data-throw-if-not-resolved="false"></xref> that is loading the asset description: The <xref href="MLEM.Content.RawContentManager" data-throw-if-not-resolved="false"></xref> that is loading the asset
- id: assetPath - id: assetPath
type: System.String type: System.String
description: The full path to the asset, starting from the <see cref="!:RawContentManager.RootDirectory"></see> description: The full path to the asset, starting from the <xref href="Microsoft.Xna.Framework.Content.ContentManager.RootDirectory" data-throw-if-not-resolved="false"></xref>
- id: stream - id: stream
type: System.IO.Stream type: System.IO.Stream
description: A stream that leads to this asset description: A stream that leads to this asset
@ -165,7 +165,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFileExtensions id: GetFileExtensions
path: ../MLEM/Content/RawContentReader.cs path: ../MLEM/Content/RawContentReader.cs
startLine: 31 startLine: 32
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
@ -507,6 +507,13 @@ references:
name: Boolean name: Boolean
nameWithType: Boolean nameWithType: Boolean
fullName: System.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* - uid: MLEM.Content.RawContentReader.Read*
commentId: Overload:MLEM.Content.RawContentReader.Read commentId: Overload:MLEM.Content.RawContentReader.Read
name: Read name: Read
@ -526,12 +533,25 @@ references:
name: Stream name: Stream
nameWithType: Stream nameWithType: Stream
fullName: System.IO.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 - uid: System.IO
commentId: N:System.IO commentId: N:System.IO
isExternal: true isExternal: true
name: System.IO name: System.IO
nameWithType: System.IO nameWithType: System.IO
fullName: 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* - uid: MLEM.Content.RawContentReader.GetFileExtensions*
commentId: Overload:MLEM.Content.RawContentReader.GetFileExtensions commentId: Overload:MLEM.Content.RawContentReader.GetFileExtensions
name: GetFileExtensions name: GetFileExtensions

View file

@ -21,14 +21,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: SongReader id: SongReader
path: ../MLEM/Content/SongReader.cs path: ../MLEM/Content/SongReader.cs
startLine: 5 startLine: 6
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: 'public class SongReader : RawContentReader<Song>' content: 'public class SongReader : RawContentReader<Song>'
content.vb: >- content.vb: >-
Public Class SongReader Public Class SongReader
Inherits RawContentReader(Of Song) Inherits RawContentReader(Of Song)
inheritance: inheritance:
- System.Object - System.Object
@ -68,10 +70,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Read id: Read
path: ../MLEM/Content/SongReader.cs path: ../MLEM/Content/SongReader.cs
startLine: 7 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: protected override Song Read(RawContentManager manager, string assetPath, Stream stream, Song existing) content: protected override Song Read(RawContentManager manager, string assetPath, Stream stream, Song existing)
parameters: parameters:
@ -112,10 +115,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFileExtensions id: GetFileExtensions
path: ../MLEM/Content/SongReader.cs path: ../MLEM/Content/SongReader.cs
startLine: 11 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public override string[] GetFileExtensions() content: public override string[] GetFileExtensions()
return: return:

View file

@ -21,14 +21,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: SoundEffectReader id: SoundEffectReader
path: ../MLEM/Content/SoundEffectReader.cs path: ../MLEM/Content/SoundEffectReader.cs
startLine: 5 startLine: 6
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: 'public class SoundEffectReader : RawContentReader<SoundEffect>' content: 'public class SoundEffectReader : RawContentReader<SoundEffect>'
content.vb: >- content.vb: >-
Public Class SoundEffectReader Public Class SoundEffectReader
Inherits RawContentReader(Of SoundEffect) Inherits RawContentReader(Of SoundEffect)
inheritance: inheritance:
- System.Object - System.Object
@ -68,10 +70,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Read id: Read
path: ../MLEM/Content/SoundEffectReader.cs path: ../MLEM/Content/SoundEffectReader.cs
startLine: 7 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: protected override SoundEffect Read(RawContentManager manager, string assetPath, Stream stream, SoundEffect existing) content: protected override SoundEffect Read(RawContentManager manager, string assetPath, Stream stream, SoundEffect existing)
parameters: parameters:
@ -112,10 +115,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFileExtensions id: GetFileExtensions
path: ../MLEM/Content/SoundEffectReader.cs path: ../MLEM/Content/SoundEffectReader.cs
startLine: 11 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public override string[] GetFileExtensions() content: public override string[] GetFileExtensions()
return: return:

View file

@ -21,14 +21,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Texture2DReader id: Texture2DReader
path: ../MLEM/Content/Texture2DReader.cs path: ../MLEM/Content/Texture2DReader.cs
startLine: 4 startLine: 5
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: 'public class Texture2DReader : RawContentReader<Texture2D>' content: 'public class Texture2DReader : RawContentReader<Texture2D>'
content.vb: >- content.vb: >-
Public Class Texture2DReader Public Class Texture2DReader
Inherits RawContentReader(Of Texture2D) Inherits RawContentReader(Of Texture2D)
inheritance: inheritance:
- System.Object - System.Object
@ -68,10 +70,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Read id: Read
path: ../MLEM/Content/Texture2DReader.cs path: ../MLEM/Content/Texture2DReader.cs
startLine: 6 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: protected override Texture2D Read(RawContentManager manager, string assetPath, Stream stream, Texture2D existing) content: protected override Texture2D Read(RawContentManager manager, string assetPath, Stream stream, Texture2D existing)
parameters: parameters:
@ -112,10 +115,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFileExtensions id: GetFileExtensions
path: ../MLEM/Content/Texture2DReader.cs path: ../MLEM/Content/Texture2DReader.cs
startLine: 15 startLine: 18
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public override string[] GetFileExtensions() content: public override string[] GetFileExtensions()
return: return:

View file

@ -22,14 +22,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: XmlReader id: XmlReader
path: ../MLEM/Content/XmlReader.cs path: ../MLEM/Content/XmlReader.cs
startLine: 5 startLine: 6
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: 'public class XmlReader : RawContentReader' content: 'public class XmlReader : RawContentReader'
content.vb: >- content.vb: >-
Public Class XmlReader Public Class XmlReader
Inherits RawContentReader Inherits RawContentReader
inheritance: inheritance:
- System.Object - System.Object
@ -66,10 +68,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: CanRead id: CanRead
path: ../MLEM/Content/XmlReader.cs path: ../MLEM/Content/XmlReader.cs
startLine: 7 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public override bool CanRead(Type t) content: public override bool CanRead(Type t)
parameters: parameters:
@ -104,10 +107,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Read id: Read
path: ../MLEM/Content/XmlReader.cs path: ../MLEM/Content/XmlReader.cs
startLine: 11 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public override object Read(RawContentManager manager, string assetPath, Stream stream, Type t, object existing) content: public override object Read(RawContentManager manager, string assetPath, Stream stream, Type t, object existing)
parameters: parameters:
@ -150,10 +154,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFileExtensions id: GetFileExtensions
path: ../MLEM/Content/XmlReader.cs path: ../MLEM/Content/XmlReader.cs
startLine: 15 startLine: 19
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Content namespace: MLEM.Content
example: []
syntax: syntax:
content: public override string[] GetFileExtensions() content: public override string[] GetFileExtensions()
return: return:

View file

@ -29,6 +29,7 @@ items:
content: 'public class Direction2Converter : JsonConverter<Direction2>' content: 'public class Direction2Converter : JsonConverter<Direction2>'
content.vb: >- content.vb: >-
Public Class Direction2Converter Public Class Direction2Converter
Inherits JsonConverter(Of Direction2) Inherits JsonConverter(Of Direction2)
inheritance: inheritance:
- System.Object - System.Object

View file

@ -29,6 +29,7 @@ items:
content: 'public class PointConverter : JsonConverter<Point>' content: 'public class PointConverter : JsonConverter<Point>'
content.vb: >- content.vb: >-
Public Class PointConverter Public Class PointConverter
Inherits JsonConverter(Of Point) Inherits JsonConverter(Of Point)
inheritance: inheritance:
- System.Object - System.Object

View file

@ -30,6 +30,7 @@ items:
content: 'public class RawJsonReader : RawContentReader' content: 'public class RawJsonReader : RawContentReader'
content.vb: >- content.vb: >-
Public Class RawJsonReader Public Class RawJsonReader
Inherits RawContentReader Inherits RawContentReader
inheritance: inheritance:
- System.Object - System.Object

View file

@ -29,6 +29,7 @@ items:
content: 'public class RectangleConverter : JsonConverter<Rectangle>' content: 'public class RectangleConverter : JsonConverter<Rectangle>'
content.vb: >- content.vb: >-
Public Class RectangleConverter Public Class RectangleConverter
Inherits JsonConverter(Of Rectangle) Inherits JsonConverter(Of Rectangle)
inheritance: inheritance:
- System.Object - System.Object

View file

@ -29,6 +29,7 @@ items:
content: 'public class RectangleFConverter : JsonConverter<RectangleF>' content: 'public class RectangleFConverter : JsonConverter<RectangleF>'
content.vb: >- content.vb: >-
Public Class RectangleFConverter Public Class RectangleFConverter
Inherits JsonConverter(Of RectangleF) Inherits JsonConverter(Of RectangleF)
inheritance: inheritance:
- System.Object - System.Object

View file

@ -29,6 +29,7 @@ items:
content: 'public class Vector2Converter : JsonConverter<Vector2>' content: 'public class Vector2Converter : JsonConverter<Vector2>'
content.vb: >- content.vb: >-
Public Class Vector2Converter Public Class Vector2Converter
Inherits JsonConverter(Of Vector2) Inherits JsonConverter(Of Vector2)
inheritance: inheritance:
- System.Object - System.Object

View file

@ -40,6 +40,7 @@ items:
content: 'public class GenericBitmapFont : GenericFont' content: 'public class GenericBitmapFont : GenericFont'
content.vb: >- content.vb: >-
Public Class GenericBitmapFont Public Class GenericBitmapFont
Inherits GenericFont Inherits GenericFont
inheritance: inheritance:
- System.Object - System.Object

View file

@ -35,6 +35,7 @@ items:
content: 'public class TileDrawInfo : GenericDataHolder' content: 'public class TileDrawInfo : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class TileDrawInfo Public Class TileDrawInfo
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object

View file

@ -34,6 +34,7 @@ items:
content: 'public class TileCollisionInfo : GenericDataHolder' content: 'public class TileCollisionInfo : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class TileCollisionInfo Public Class TileCollisionInfo
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object

View file

@ -23,10 +23,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ColorExtensions id: ColorExtensions
path: ../MLEM/Extensions/ColorExtensions.cs path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 5 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nA set of extensions for dealing with <xref href=\"Microsoft.Xna.Framework.Color\" data-throw-if-not-resolved=\"false\"></xref> objects\n"
example: []
syntax: syntax:
content: public static class ColorExtensions content: public static class ColorExtensions
content.vb: Public Module ColorExtensions content.vb: Public Module ColorExtensions
@ -66,7 +68,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Invert id: Invert
path: ../MLEM/Extensions/ColorExtensions.cs path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 12 startLine: 15
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -110,7 +112,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: FromHex id: FromHex
path: ../MLEM/Extensions/ColorExtensions.cs path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 22 startLine: 25
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -151,7 +153,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: FromHex id: FromHex
path: ../MLEM/Extensions/ColorExtensions.cs path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 32 startLine: 35
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -193,11 +195,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: CopyAlpha id: CopyAlpha
path: ../MLEM/Extensions/ColorExtensions.cs path: ../MLEM/Extensions/ColorExtensions.cs
startLine: 44 startLine: 47
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nCopies the alpha value from <see cref=\"!:other\"></see> into this color.\n" summary: "\nCopies the alpha value from another color into this color.\n"
example: [] example: []
syntax: syntax:
content: public static Color CopyAlpha(this Color color, Color other) content: public static Color CopyAlpha(this Color color, Color other)
@ -210,7 +212,7 @@ items:
description: The color to copy the alpha from description: The color to copy the alpha from
return: return:
type: Microsoft.Xna.Framework.Color type: Microsoft.Xna.Framework.Color
description: The <see cref="!:color"></see> with <see cref="!:other"></see>&apos;s alpha value description: The first color with the second color&apos;s alpha value
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -223,6 +225,13 @@ items:
- Public - Public
- Shared - Shared
references: 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 - uid: MLEM.Extensions
commentId: N:MLEM.Extensions commentId: N:MLEM.Extensions
name: MLEM.Extensions name: MLEM.Extensions
@ -514,6 +523,12 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
@ -525,19 +540,6 @@ references:
name: Invert name: Invert
nameWithType: ColorExtensions.Invert nameWithType: ColorExtensions.Invert
fullName: MLEM.Extensions.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* - uid: MLEM.Extensions.ColorExtensions.FromHex*
commentId: Overload:MLEM.Extensions.ColorExtensions.FromHex commentId: Overload:MLEM.Extensions.ColorExtensions.FromHex
name: FromHex name: FromHex

View file

@ -21,14 +21,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TargetContext id: TargetContext
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 74 startLine: 81
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nRepresents a context in which a <xref href=\"Microsoft.Xna.Framework.Graphics.RenderTarget2D\" data-throw-if-not-resolved=\"false\"></xref> is applied.\nThis class should be used with <xref href=\"MLEM.Extensions.GraphicsExtensions.WithRenderTarget(Microsoft.Xna.Framework.Graphics.GraphicsDevice%2cMicrosoft.Xna.Framework.Graphics.RenderTarget2D)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax: syntax:
content: 'public struct TargetContext : IDisposable' content: 'public struct TargetContext : IDisposable'
content.vb: >- content.vb: >-
Public Structure TargetContext Public Structure TargetContext
Implements IDisposable Implements IDisposable
implements: implements:
- System.IDisposable - System.IDisposable
@ -63,17 +66,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 79 startLine: 91
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nCreates a new target context with the given settings.\n"
example: []
syntax: syntax:
content: public TargetContext(GraphicsDevice device, RenderTarget2D target) content: public TargetContext(GraphicsDevice device, RenderTarget2D target)
parameters: parameters:
- id: device - id: device
type: Microsoft.Xna.Framework.Graphics.GraphicsDevice type: Microsoft.Xna.Framework.Graphics.GraphicsDevice
description: The graphics device to apply the target on
- id: target - id: target
type: Microsoft.Xna.Framework.Graphics.RenderTarget2D type: Microsoft.Xna.Framework.Graphics.RenderTarget2D
description: The target to apply
content.vb: Public Sub New(device As GraphicsDevice, target As RenderTarget2D) content.vb: Public Sub New(device As GraphicsDevice, target As RenderTarget2D)
overload: MLEM.Extensions.GraphicsExtensions.TargetContext.#ctor* overload: MLEM.Extensions.GraphicsExtensions.TargetContext.#ctor*
modifiers.csharp: modifiers.csharp:
@ -98,10 +105,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Dispose id: Dispose
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 85 startLine: 100
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nDisposes this target context, which causes the graphics device&apos;s previous render targets to be re-applied.\n"
example: []
syntax: syntax:
content: public void Dispose() content: public void Dispose()
content.vb: Public Sub Dispose content.vb: Public Sub Dispose
@ -113,6 +122,16 @@ items:
modifiers.vb: modifiers.vb:
- Public - Public
references: 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 - uid: MLEM.Extensions
commentId: N:MLEM.Extensions commentId: N:MLEM.Extensions
name: MLEM.Extensions name: MLEM.Extensions
@ -373,6 +392,12 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
@ -405,19 +430,6 @@ references:
name: GraphicsDevice name: GraphicsDevice
nameWithType: GraphicsDevice nameWithType: GraphicsDevice
fullName: Microsoft.Xna.Framework.Graphics.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* - uid: MLEM.Extensions.GraphicsExtensions.TargetContext.Dispose*
commentId: Overload:MLEM.Extensions.GraphicsExtensions.TargetContext.Dispose commentId: Overload:MLEM.Extensions.GraphicsExtensions.TargetContext.Dispose
name: Dispose name: Dispose

View file

@ -23,10 +23,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GraphicsExtensions id: GraphicsExtensions
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nA set of extensions for dealing with <xref href=\"Microsoft.Xna.Framework.Graphics.GraphicsDevice\" data-throw-if-not-resolved=\"false\"></xref> and <xref href=\"Microsoft.Xna.Framework.GraphicsDeviceManager\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class GraphicsExtensions content: public static class GraphicsExtensions
content.vb: Public Module GraphicsExtensions content.vb: Public Module GraphicsExtensions
@ -66,7 +68,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: SetFullscreen id: SetFullscreen
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 17 startLine: 20
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -115,7 +117,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ApplyChangesSafely id: ApplyChangesSafely
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 41 startLine: 44
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -157,7 +159,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ResetWidthAndHeight id: ResetWidthAndHeight
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 56 startLine: 59
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -202,7 +204,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: WithRenderTarget id: WithRenderTarget
path: ../MLEM/Extensions/GraphicsExtensions.cs path: ../MLEM/Extensions/GraphicsExtensions.cs
startLine: 70 startLine: 73
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -232,6 +234,20 @@ items:
- Public - Public
- Shared - Shared
references: 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 - uid: MLEM.Extensions
commentId: N:MLEM.Extensions commentId: N:MLEM.Extensions
name: MLEM.Extensions name: MLEM.Extensions
@ -523,6 +539,18 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
@ -537,13 +565,6 @@ references:
name: SetFullscreen name: SetFullscreen
nameWithType: GraphicsExtensions.SetFullscreen nameWithType: GraphicsExtensions.SetFullscreen
fullName: MLEM.Extensions.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 - uid: System.Boolean
commentId: T:System.Boolean commentId: T:System.Boolean
parent: System parent: System
@ -551,12 +572,6 @@ references:
name: Boolean name: Boolean
nameWithType: Boolean nameWithType: Boolean
fullName: System.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 - uid: Microsoft.Xna.Framework.GraphicsDeviceManager.ApplyChanges
commentId: M:Microsoft.Xna.Framework.GraphicsDeviceManager.ApplyChanges commentId: M:Microsoft.Xna.Framework.GraphicsDeviceManager.ApplyChanges
isExternal: true isExternal: true
@ -588,13 +603,6 @@ references:
name: WithRenderTarget name: WithRenderTarget
nameWithType: GraphicsExtensions.WithRenderTarget nameWithType: GraphicsExtensions.WithRenderTarget
fullName: MLEM.Extensions.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 - uid: Microsoft.Xna.Framework.Graphics.RenderTarget2D
commentId: T:Microsoft.Xna.Framework.Graphics.RenderTarget2D commentId: T:Microsoft.Xna.Framework.Graphics.RenderTarget2D
parent: Microsoft.Xna.Framework.Graphics parent: Microsoft.Xna.Framework.Graphics
@ -602,9 +610,3 @@ references:
name: RenderTarget2D name: RenderTarget2D
nameWithType: RenderTarget2D nameWithType: RenderTarget2D
fullName: Microsoft.Xna.Framework.Graphics.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

View file

@ -36,10 +36,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: NumberExtensions id: NumberExtensions
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 5 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nA set of extensions for dealing with <xref href=\"System.Single\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Microsoft.Xna.Framework.Vector2\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Microsoft.Xna.Framework.Vector3\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Microsoft.Xna.Framework.Vector4\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Microsoft.Xna.Framework.Point\" data-throw-if-not-resolved=\"false\"></xref>, <xref href=\"Microsoft.Xna.Framework.Rectangle\" data-throw-if-not-resolved=\"false\"></xref> and <xref href=\"MLEM.Misc.RectangleF\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class NumberExtensions content: public static class NumberExtensions
content.vb: Public Module NumberExtensions content.vb: Public Module NumberExtensions
@ -79,7 +81,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Floor id: Floor
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 8 startLine: 11
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -121,7 +123,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Ceil id: Ceil
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 13 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -163,7 +165,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 24 startLine: 27
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -183,7 +185,7 @@ items:
description: The equality tolerance description: The equality tolerance
return: return:
type: System.Boolean type: System.Boolean
description: Whether or not <see cref="!:first"></see> and <see cref="!:second"></see> are different by at most <see cref="!:tolerance"></see> description: Whether or not the two values are different by at most <code>tolerance</code>
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -214,11 +216,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 29 startLine: 32
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nChecks for decimal equality with a given tolerance.\n"
example: [] example: []
syntax: syntax:
content: public static bool Equals(this Vector2 first, Vector2 second, float tolerance) content: public static bool Equals(this Vector2 first, Vector2 second, float tolerance)
@ -229,10 +230,8 @@ items:
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
- id: tolerance - id: tolerance
type: System.Single type: System.Single
description: The equality tolerance
return: return:
type: System.Boolean type: System.Boolean
description: Whether or not <see cref="!:first"></see> and <see cref="!:second"></see> are different by at most <see cref="!:tolerance"></see>
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -263,11 +262,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 34 startLine: 37
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nChecks for decimal equality with a given tolerance.\n"
example: [] example: []
syntax: syntax:
content: public static bool Equals(this Vector3 first, Vector3 second, float tolerance) content: public static bool Equals(this Vector3 first, Vector3 second, float tolerance)
@ -278,10 +276,8 @@ items:
type: Microsoft.Xna.Framework.Vector3 type: Microsoft.Xna.Framework.Vector3
- id: tolerance - id: tolerance
type: System.Single type: System.Single
description: The equality tolerance
return: return:
type: System.Boolean type: System.Boolean
description: Whether or not <see cref="!:first"></see> and <see cref="!:second"></see> are different by at most <see cref="!:tolerance"></see>
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -312,11 +308,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 39 startLine: 42
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nChecks for decimal equality with a given tolerance.\n"
example: [] example: []
syntax: syntax:
content: public static bool Equals(this Vector4 first, Vector4 second, float tolerance) content: public static bool Equals(this Vector4 first, Vector4 second, float tolerance)
@ -327,10 +322,8 @@ items:
type: Microsoft.Xna.Framework.Vector4 type: Microsoft.Xna.Framework.Vector4
- id: tolerance - id: tolerance
type: System.Single type: System.Single
description: The equality tolerance
return: return:
type: System.Boolean type: System.Boolean
description: Whether or not <see cref="!:first"></see> and <see cref="!:second"></see> are different by at most <see cref="!:tolerance"></see>
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -361,7 +354,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Floor id: Floor
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 44 startLine: 47
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -403,7 +396,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Floor id: Floor
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 49 startLine: 52
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -445,7 +438,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Floor id: Floor
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 54 startLine: 57
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -487,7 +480,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Multiply id: Multiply
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 64 startLine: 67
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -535,7 +528,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Divide id: Divide
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 74 startLine: 77
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -583,7 +576,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Transform id: Transform
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 84 startLine: 87
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -631,7 +624,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: OffsetCopy id: OffsetCopy
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 97 startLine: 100
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -679,11 +672,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: OffsetCopy id: OffsetCopy
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 104 startLine: 107
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nReturns a copy of the given rectangle, moved by the given point.\nThe rectangle&apos;s size remains unchanged.\n"
example: [] example: []
syntax: syntax:
content: public static RectangleF OffsetCopy(this RectangleF rect, Vector2 offset) content: public static RectangleF OffsetCopy(this RectangleF rect, Vector2 offset)
@ -694,7 +686,6 @@ items:
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
return: return:
type: MLEM.Misc.RectangleF type: MLEM.Misc.RectangleF
description: The moved rectangle
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -725,7 +716,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Shrink id: Shrink
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 116 startLine: 119
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -773,11 +764,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Shrink id: Shrink
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 125 startLine: 128
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions 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: [] example: []
syntax: syntax:
content: public static RectangleF Shrink(this RectangleF rect, Vector2 padding) content: public static RectangleF Shrink(this RectangleF rect, Vector2 padding)
@ -788,7 +778,6 @@ items:
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
return: return:
type: MLEM.Misc.RectangleF type: MLEM.Misc.RectangleF
description: The shrunk rectangle
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -819,11 +808,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Shrink id: Shrink
path: ../MLEM/Extensions/NumberExtensions.cs path: ../MLEM/Extensions/NumberExtensions.cs
startLine: 134 startLine: 137
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions 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: [] example: []
syntax: syntax:
content: public static RectangleF Shrink(this RectangleF rect, Padding padding) content: public static RectangleF Shrink(this RectangleF rect, Padding padding)
@ -834,7 +822,6 @@ items:
type: MLEM.Misc.Padding type: MLEM.Misc.Padding
return: return:
type: MLEM.Misc.RectangleF type: MLEM.Misc.RectangleF
description: The shrunk rectangle
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -847,6 +834,54 @@ items:
- Public - Public
- Shared - Shared
references: 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 - uid: MLEM.Extensions
commentId: N:MLEM.Extensions commentId: N:MLEM.Extensions
name: MLEM.Extensions name: MLEM.Extensions
@ -1144,6 +1179,17 @@ references:
name: System name: System
nameWithType: System nameWithType: System
fullName: 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) - uid: System.Math.Floor(System.Decimal)
commentId: M:System.Math.Floor(System.Decimal) commentId: M:System.Math.Floor(System.Decimal)
isExternal: true isExternal: true
@ -1152,13 +1198,6 @@ references:
name: Floor name: Floor
nameWithType: NumberExtensions.Floor nameWithType: NumberExtensions.Floor
fullName: MLEM.Extensions.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 - uid: System.Int32
commentId: T:System.Int32 commentId: T:System.Int32
parent: System parent: System
@ -1189,45 +1228,11 @@ references:
- uid: MLEM.Extensions.NumberExtensions.Equals(System.Single,System.Single,System.Single) - uid: MLEM.Extensions.NumberExtensions.Equals(System.Single,System.Single,System.Single)
commentId: M:MLEM.Extensions.NumberExtensions.Equals(System.Single,System.Single,System.Single) commentId: M:MLEM.Extensions.NumberExtensions.Equals(System.Single,System.Single,System.Single)
isExternal: true 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* - uid: MLEM.Extensions.NumberExtensions.Multiply*
commentId: Overload:MLEM.Extensions.NumberExtensions.Multiply commentId: Overload:MLEM.Extensions.NumberExtensions.Multiply
name: Multiply name: Multiply
nameWithType: NumberExtensions.Multiply nameWithType: NumberExtensions.Multiply
fullName: MLEM.Extensions.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* - uid: MLEM.Extensions.NumberExtensions.Divide*
commentId: Overload:MLEM.Extensions.NumberExtensions.Divide commentId: Overload:MLEM.Extensions.NumberExtensions.Divide
name: Divide name: Divide
@ -1250,27 +1255,9 @@ references:
name: OffsetCopy name: OffsetCopy
nameWithType: NumberExtensions.OffsetCopy nameWithType: NumberExtensions.OffsetCopy
fullName: MLEM.Extensions.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) - 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) commentId: M:MLEM.Extensions.NumberExtensions.OffsetCopy(Microsoft.Xna.Framework.Rectangle,Microsoft.Xna.Framework.Point)
isExternal: true 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* - uid: MLEM.Extensions.NumberExtensions.Shrink*
commentId: Overload:MLEM.Extensions.NumberExtensions.Shrink commentId: Overload:MLEM.Extensions.NumberExtensions.Shrink
name: Shrink name: Shrink

View file

@ -22,10 +22,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RandomExtensions id: RandomExtensions
path: ../MLEM/Extensions/RandomExtensions.cs path: ../MLEM/Extensions/RandomExtensions.cs
startLine: 5 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nA set of extensions for dealing with <xref href=\"System.Random\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class RandomExtensions content: public static class RandomExtensions
content.vb: Public Module RandomExtensions content.vb: Public Module RandomExtensions
@ -65,7 +67,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetRandomEntry id: GetRandomEntry
path: ../MLEM/Extensions/RandomExtensions.cs path: ../MLEM/Extensions/RandomExtensions.cs
startLine: 14 startLine: 17
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -119,26 +121,22 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetRandomEntry id: GetRandomEntry
path: ../MLEM/Extensions/RandomExtensions.cs path: ../MLEM/Extensions/RandomExtensions.cs
startLine: 19 startLine: 22
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nGets a random entry from the given list with uniform chance.\n"
example: [] example: []
syntax: syntax:
content: public static T GetRandomEntry<T>(this Random random, IList<T> entries) content: public static T GetRandomEntry<T>(this Random random, IList<T> entries)
parameters: parameters:
- id: random - id: random
type: System.Random type: System.Random
description: The random
- id: entries - id: entries
type: System.Collections.Generic.IList{{T}} type: System.Collections.Generic.IList{{T}}
typeParameters: typeParameters:
- id: T - id: T
description: The entries&apos; type
return: return:
type: '{T}' type: '{T}'
description: A random entry
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -172,7 +170,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetRandomWeightedEntry id: GetRandomWeightedEntry
path: ../MLEM/Extensions/RandomExtensions.cs path: ../MLEM/Extensions/RandomExtensions.cs
startLine: 33 startLine: 36
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions 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)) 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)) name.vb: GetRandomWeightedEntry(Of T)(Random, IList(Of T), Func(Of T, Int32))
references: references:
- uid: System.Random
commentId: T:System.Random
parent: System
isExternal: true
name: Random
nameWithType: Random
fullName: System.Random
- uid: MLEM.Extensions - uid: MLEM.Extensions
commentId: N:MLEM.Extensions commentId: N:MLEM.Extensions
name: MLEM.Extensions name: MLEM.Extensions
@ -517,13 +522,6 @@ references:
name: GetRandomEntry name: GetRandomEntry
nameWithType: RandomExtensions.GetRandomEntry nameWithType: RandomExtensions.GetRandomEntry
fullName: MLEM.Extensions.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}[]' - uid: '{T}[]'
isExternal: true isExternal: true
name: T[] name: T[]

View file

@ -20,10 +20,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: SoundExtensions id: SoundExtensions
path: ../MLEM/Extensions/SoundExtensions.cs path: ../MLEM/Extensions/SoundExtensions.cs
startLine: 4 startLine: 7
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nA set of extensions for dealing wiht <xref href=\"Microsoft.Xna.Framework.Audio.SoundEffectInstance\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class SoundExtensions content: public static class SoundExtensions
content.vb: Public Module SoundExtensions content.vb: Public Module SoundExtensions
@ -63,10 +65,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Replay id: Replay
path: ../MLEM/Extensions/SoundExtensions.cs path: ../MLEM/Extensions/SoundExtensions.cs
startLine: 6 startLine: 13
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nStops and plays a sound effect instance in one call\n"
example: []
syntax: syntax:
content: >- content: >-
[Obsolete("When using the .NET Core version of MonoGame, the replay issue has been fixed. Just call Play() instead.")] [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: parameters:
- id: sound - id: sound
type: Microsoft.Xna.Framework.Audio.SoundEffectInstance type: Microsoft.Xna.Framework.Audio.SoundEffectInstance
description: The sound to stop and play
content.vb: >- content.vb: >-
<Obsolete("When using the .NET Core version of MonoGame, the replay issue has been fixed. Just call Play() instead.")> <Obsolete("When using the .NET Core version of MonoGame, the replay issue has been fixed. Just call Play() instead.")>
@ -95,6 +100,13 @@ items:
- Public - Public
- Shared - Shared
references: 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 - uid: MLEM.Extensions
commentId: N:MLEM.Extensions commentId: N:MLEM.Extensions
name: MLEM.Extensions name: MLEM.Extensions
@ -386,6 +398,12 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
@ -397,16 +415,3 @@ references:
name: Replay name: Replay
nameWithType: SoundExtensions.Replay nameWithType: SoundExtensions.Replay
fullName: MLEM.Extensions.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

View file

@ -24,10 +24,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: SpriteBatchExtensions id: SpriteBatchExtensions
path: ../MLEM/Extensions/SpriteBatchExtensions.cs path: ../MLEM/Extensions/SpriteBatchExtensions.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
summary: "\nA set of extensions for dealing with <xref href=\"Microsoft.Xna.Framework.Graphics.SpriteBatch\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class SpriteBatchExtensions content: public static class SpriteBatchExtensions
content.vb: Public Module SpriteBatchExtensions content.vb: Public Module SpriteBatchExtensions
@ -67,7 +69,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetBlankTexture id: GetBlankTexture
path: ../MLEM/Extensions/SpriteBatchExtensions.cs path: ../MLEM/Extensions/SpriteBatchExtensions.cs
startLine: 16 startLine: 19
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -112,7 +114,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GenerateTexture id: GenerateTexture
path: ../MLEM/Extensions/SpriteBatchExtensions.cs path: ../MLEM/Extensions/SpriteBatchExtensions.cs
startLine: 37 startLine: 40
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -166,7 +168,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Extensions/SpriteBatchExtensions.cs path: ../MLEM/Extensions/SpriteBatchExtensions.cs
startLine: 55 startLine: 58
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -225,7 +227,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Extensions/SpriteBatchExtensions.cs path: ../MLEM/Extensions/SpriteBatchExtensions.cs
startLine: 62 startLine: 65
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -276,7 +278,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Extensions/SpriteBatchExtensions.cs path: ../MLEM/Extensions/SpriteBatchExtensions.cs
startLine: 67 startLine: 70
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Extensions namespace: MLEM.Extensions
@ -304,6 +306,13 @@ items:
- Public - Public
- Shared - Shared
references: 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 - uid: MLEM.Extensions
commentId: N:MLEM.Extensions commentId: N:MLEM.Extensions
name: MLEM.Extensions name: MLEM.Extensions
@ -595,6 +604,12 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
@ -606,13 +621,6 @@ references:
name: GetBlankTexture name: GetBlankTexture
nameWithType: SpriteBatchExtensions.GetBlankTexture nameWithType: SpriteBatchExtensions.GetBlankTexture
fullName: MLEM.Extensions.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 - uid: Microsoft.Xna.Framework.Graphics.Texture2D
commentId: T:Microsoft.Xna.Framework.Graphics.Texture2D commentId: T:Microsoft.Xna.Framework.Graphics.Texture2D
parent: Microsoft.Xna.Framework.Graphics parent: Microsoft.Xna.Framework.Graphics
@ -620,12 +628,6 @@ references:
name: Texture2D name: Texture2D
nameWithType: Texture2D nameWithType: Texture2D
fullName: Microsoft.Xna.Framework.Graphics.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 - uid: MLEM.Textures.NinePatch
commentId: T:MLEM.Textures.NinePatch commentId: T:MLEM.Textures.NinePatch
parent: MLEM.Textures parent: MLEM.Textures

View file

@ -622,7 +622,6 @@ items:
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nDraws a string with the given text alignment.\n"
example: [] example: []
syntax: 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) 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: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nDraws a string with the given text alignment.\n"
example: [] example: []
syntax: 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) content: public void DrawString(SpriteBatch batch, string text, Vector2 position, TextAlign align, Color color, float rotation, Vector2 origin, Vector2 scale, SpriteEffects effects, float layerDepth)

View file

@ -36,12 +36,12 @@ items:
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nRepresents a font with additional abilities.\n<xref href=\"MLEM.Font.GenericSpriteFont\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: [] example: []
syntax: syntax:
content: 'public class GenericSpriteFont : GenericFont' content: 'public class GenericSpriteFont : GenericFont'
content.vb: >- content.vb: >-
Public Class GenericSpriteFont Public Class GenericSpriteFont
Inherits GenericFont Inherits GenericFont
inheritance: inheritance:
- System.Object - System.Object
@ -86,10 +86,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Font id: Font
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 10 startLine: 13
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nThe <xref href=\"Microsoft.Xna.Framework.Graphics.SpriteFont\" data-throw-if-not-resolved=\"false\"></xref> that is being wrapped by this generic font\n"
example: []
syntax: syntax:
content: public readonly SpriteFont Font content: public readonly SpriteFont Font
return: return:
@ -119,11 +121,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Bold id: Bold
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 12 startLine: 15
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nThe bold version of this font.\n"
example: [] example: []
syntax: syntax:
content: public override GenericFont Bold { get; } content: public override GenericFont Bold { get; }
@ -159,11 +160,10 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Italic id: Italic
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 14 startLine: 17
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nThe italic version of this font.\n"
example: [] example: []
syntax: syntax:
content: public override GenericFont Italic { get; } content: public override GenericFont Italic { get; }
@ -199,7 +199,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: LineHeight id: LineHeight
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 16 startLine: 19
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -238,7 +238,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 25 startLine: 28
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -280,7 +280,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: MeasureString id: MeasureString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 32 startLine: 35
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -319,7 +319,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: MeasureString id: MeasureString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 37 startLine: 40
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -358,7 +358,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawString id: DrawString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 42 startLine: 45
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -401,7 +401,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawString id: DrawString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 47 startLine: 50
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -454,7 +454,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawString id: DrawString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 52 startLine: 55
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -507,7 +507,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawString id: DrawString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 57 startLine: 60
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -550,7 +550,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawString id: DrawString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 62 startLine: 65
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
@ -603,7 +603,7 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawString id: DrawString
path: ../MLEM/Font/GenericSpriteFont.cs path: ../MLEM/Font/GenericSpriteFont.cs
startLine: 67 startLine: 70
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font

View file

@ -23,10 +23,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TextAlign id: TextAlign
path: ../MLEM/Font/GenericFont.cs path: ../MLEM/Font/GenericFont.cs
startLine: 173 startLine: 176
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nAn enum that represents the text alignment options for <xref href=\"MLEM.Font.GenericFont.DrawString(Microsoft.Xna.Framework.Graphics.SpriteBatch%2cSystem.String%2cMicrosoft.Xna.Framework.Vector2%2cMLEM.Font.TextAlign%2cMicrosoft.Xna.Framework.Color)\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public enum TextAlign content: public enum TextAlign
content.vb: Public Enum TextAlign content.vb: Public Enum TextAlign
@ -54,10 +56,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Left id: Left
path: ../MLEM/Font/GenericFont.cs path: ../MLEM/Font/GenericFont.cs
startLine: 175 startLine: 181
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nThe text is aligned as normal\n"
example: []
syntax: syntax:
content: Left = 0 content: Left = 0
return: return:
@ -86,10 +90,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Center id: Center
path: ../MLEM/Font/GenericFont.cs path: ../MLEM/Font/GenericFont.cs
startLine: 176 startLine: 185
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nThe position passed represents the center of the resulting string in the x axis\n"
example: []
syntax: syntax:
content: Center = 1 content: Center = 1
return: return:
@ -118,10 +124,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Right id: Right
path: ../MLEM/Font/GenericFont.cs path: ../MLEM/Font/GenericFont.cs
startLine: 177 startLine: 189
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nThe position passed represents the right edge of the resulting string\n"
example: []
syntax: syntax:
content: Right = 2 content: Right = 2
return: return:
@ -150,10 +158,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: CenterBothAxes id: CenterBothAxes
path: ../MLEM/Font/GenericFont.cs path: ../MLEM/Font/GenericFont.cs
startLine: 178 startLine: 193
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Font namespace: MLEM.Font
summary: "\nThe position passed represents the center of the resulting string, both in the x and y axes\n"
example: []
syntax: syntax:
content: CenterBothAxes = 3 content: CenterBothAxes = 3
return: return:
@ -165,11 +175,118 @@ items:
- Public - Public
- Const - Const
references: 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 - uid: MLEM.Font
commentId: N:MLEM.Font commentId: N:MLEM.Font
name: MLEM.Font name: MLEM.Font
nameWithType: MLEM.Font nameWithType: MLEM.Font
fullName: 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 - uid: MLEM.Font.TextAlign
commentId: T:MLEM.Font.TextAlign commentId: T:MLEM.Font.TextAlign
parent: MLEM.Font parent: MLEM.Font

View file

@ -21,14 +21,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AnimatedCode id: AnimatedCode
path: ../MLEM/Formatting/Codes/AnimatedCode.cs path: ../MLEM/Formatting/Codes/AnimatedCode.cs
startLine: 3 startLine: 4
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class AnimatedCode : Code' content: 'public class AnimatedCode : Code'
content.vb: >- content.vb: >-
Public Class AnimatedCode Public Class AnimatedCode
Inherits Code Inherits Code
inheritance: inheritance:
- System.Object - System.Object
@ -80,10 +82,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/AnimatedCode.cs path: ../MLEM/Formatting/Codes/AnimatedCode.cs
startLine: 5 startLine: 7
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public AnimatedCode(Match match, Regex regex) content: public AnimatedCode(Match match, Regex regex)
parameters: parameters:
@ -115,10 +118,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: EndsHere id: EndsHere
path: ../MLEM/Formatting/Codes/AnimatedCode.cs path: ../MLEM/Formatting/Codes/AnimatedCode.cs
startLine: 8 startLine: 11
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override bool EndsHere(Code other) content: public override bool EndsHere(Code other)
parameters: parameters:

View file

@ -19,19 +19,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Constructor id: Constructor
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 44 startLine: 89
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nCreates a new formatting code from the given regex and regex match.\n<xref href=\"MLEM.Formatting.TextFormatter.Codes\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public delegate Code Constructor(TextFormatter formatter, Match match, Regex regex); content: public delegate Code Constructor(TextFormatter formatter, Match match, Regex regex);
parameters: parameters:
- id: formatter - id: formatter
type: MLEM.Formatting.TextFormatter type: MLEM.Formatting.TextFormatter
description: The text formatter that created this code
- id: match - id: match
type: System.Text.RegularExpressions.Match type: System.Text.RegularExpressions.Match
description: The match for the code&apos;s regex
- id: regex - id: regex
type: System.Text.RegularExpressions.Regex type: System.Text.RegularExpressions.Regex
description: The regex used to create this code
return: return:
type: MLEM.Formatting.Codes.Code type: MLEM.Formatting.Codes.Code
content.vb: Public Delegate Function Constructor(formatter As TextFormatter, match As Match, regex As Regex) As Code content.vb: Public Delegate Function Constructor(formatter As TextFormatter, match As Match, regex As Regex) As Code
@ -42,6 +47,9 @@ items:
- Public - Public
- Delegate - Delegate
references: references:
- uid: MLEM.Formatting.TextFormatter.Codes
commentId: F:MLEM.Formatting.TextFormatter.Codes
isExternal: true
- uid: MLEM.Formatting.Codes - uid: MLEM.Formatting.Codes
commentId: N:MLEM.Formatting.Codes commentId: N:MLEM.Formatting.Codes
name: MLEM.Formatting.Codes name: MLEM.Formatting.Codes

View file

@ -30,14 +30,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Code id: Code
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 7 startLine: 11
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nAn instance of a formatting code that can be used for a <xref href=\"MLEM.Formatting.TextFormatter\" data-throw-if-not-resolved=\"false\"></xref>.\nTo add a new formatting code, see <xref href=\"MLEM.Formatting.TextFormatter.Codes\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: 'public class Code : GenericDataHolder' content: 'public class Code : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class Code Public Class Code
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -82,10 +85,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Regex id: Regex
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 9 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nThe regex that this code was created from\n"
example: []
syntax: syntax:
content: public readonly Regex Regex content: public readonly Regex Regex
return: return:
@ -115,10 +120,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Match id: Match
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 10 startLine: 20
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nThe match that this code encompasses\n"
example: []
syntax: syntax:
content: public readonly Match Match content: public readonly Match Match
return: return:
@ -148,10 +155,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Token id: Token
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 11 startLine: 24
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nThe token that this formatting code is a part of\n"
example: []
syntax: syntax:
content: public Token Token { get; } content: public Token Token { get; }
parameters: [] parameters: []
@ -183,17 +192,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 13 startLine: 31
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nCreates a new formatting code based on a formatting code regex and its match.\n"
example: []
syntax: syntax:
content: protected Code(Match match, Regex regex) content: protected Code(Match match, Regex regex)
parameters: parameters:
- id: match - id: match
type: System.Text.RegularExpressions.Match type: System.Text.RegularExpressions.Match
description: The match
- id: regex - id: regex
type: System.Text.RegularExpressions.Regex type: System.Text.RegularExpressions.Regex
description: The regex
content.vb: Protected Sub New(match As Match, regex As Regex) content.vb: Protected Sub New(match As Match, regex As Regex)
overload: MLEM.Formatting.Codes.Code.#ctor* overload: MLEM.Formatting.Codes.Code.#ctor*
modifiers.csharp: modifiers.csharp:
@ -218,17 +231,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: EndsHere id: EndsHere
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 18 startLine: 42
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes 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 <xref href=\"MLEM.Formatting.Codes.Code.Token\" data-throw-if-not-resolved=\"false\"></xref> is started at its position.\n"
example: []
syntax: syntax:
content: public virtual bool EndsHere(Code other) content: public virtual bool EndsHere(Code other)
parameters: parameters:
- id: other - id: other
type: MLEM.Formatting.Codes.Code type: MLEM.Formatting.Codes.Code
description: The code that is started here
return: return:
type: System.Boolean type: System.Boolean
description: If this code should end
content.vb: Public Overridable Function EndsHere(other As Code) As Boolean content.vb: Public Overridable Function EndsHere(other As Code) As Boolean
overload: MLEM.Formatting.Codes.Code.EndsHere* overload: MLEM.Formatting.Codes.Code.EndsHere*
modifiers.csharp: modifiers.csharp:
@ -255,10 +272,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetColor id: GetColor
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 22 startLine: 47
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public virtual Color? GetColor(Color defaultPick) content: public virtual Color? GetColor(Color defaultPick)
parameters: parameters:
@ -292,10 +310,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFont id: GetFont
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 26 startLine: 52
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public virtual GenericFont GetFont(GenericFont defaultPick) content: public virtual GenericFont GetFont(GenericFont defaultPick)
parameters: parameters:
@ -329,15 +348,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Update id: Update
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 30 startLine: 60
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nUpdate this formatting code&apos;s animations etc.\n"
example: []
syntax: syntax:
content: public virtual void Update(GameTime time) content: public virtual void Update(GameTime time)
parameters: parameters:
- id: time - id: time
type: Microsoft.Xna.Framework.GameTime type: Microsoft.Xna.Framework.GameTime
description: The game&apos;s time
content.vb: Public Overridable Sub Update(time As GameTime) content.vb: Public Overridable Sub Update(time As GameTime)
overload: MLEM.Formatting.Codes.Code.Update* overload: MLEM.Formatting.Codes.Code.Update*
modifiers.csharp: modifiers.csharp:
@ -364,17 +386,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetReplacementString id: GetReplacementString
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 33 startLine: 69
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nReturns the string that this formatting code should be replaced with.\nUsually, you&apos;ll just want an empty string here, but some formatting codes (like <xref href=\"MLEM.Formatting.Codes.ImageCode\" data-throw-if-not-resolved=\"false\"></xref>) require their space to be filled by spaces.\n"
example: []
syntax: syntax:
content: public virtual string GetReplacementString(GenericFont font) content: public virtual string GetReplacementString(GenericFont font)
parameters: parameters:
- id: font - id: font
type: MLEM.Font.GenericFont type: MLEM.Font.GenericFont
description: The font that is used
return: return:
type: System.String type: System.String
description: The replacement string for this formatting code
content.vb: Public Overridable Function GetReplacementString(font As GenericFont) As String content.vb: Public Overridable Function GetReplacementString(font As GenericFont) As String
overload: MLEM.Formatting.Codes.Code.GetReplacementString* overload: MLEM.Formatting.Codes.Code.GetReplacementString*
modifiers.csharp: modifiers.csharp:
@ -401,10 +427,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawCharacter id: DrawCharacter
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 37 startLine: 74
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: 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) 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: parameters:
@ -459,10 +486,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawSelf id: DrawSelf
path: ../MLEM/Formatting/Codes/Code.cs path: ../MLEM/Formatting/Codes/Code.cs
startLine: 41 startLine: 79
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public virtual void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) content: public virtual void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth)
parameters: parameters:
@ -489,6 +517,15 @@ items:
- Public - Public
- Overridable - Overridable
references: 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 - uid: MLEM.Formatting.Codes
commentId: N:MLEM.Formatting.Codes commentId: N:MLEM.Formatting.Codes
name: MLEM.Formatting.Codes name: MLEM.Formatting.Codes
@ -911,6 +948,11 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) fullName: )
- uid: MLEM.Formatting
commentId: N:MLEM.Formatting
name: MLEM.Formatting
nameWithType: MLEM.Formatting
fullName: MLEM.Formatting
- uid: System - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
@ -953,16 +995,17 @@ references:
name: Token name: Token
nameWithType: Token nameWithType: Token
fullName: MLEM.Formatting.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* - uid: MLEM.Formatting.Codes.Code.#ctor*
commentId: Overload:MLEM.Formatting.Codes.Code.#ctor commentId: Overload:MLEM.Formatting.Codes.Code.#ctor
name: Code name: Code
nameWithType: Code.Code nameWithType: Code.Code
fullName: MLEM.Formatting.Codes.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* - uid: MLEM.Formatting.Codes.Code.EndsHere*
commentId: Overload:MLEM.Formatting.Codes.Code.EndsHere commentId: Overload:MLEM.Formatting.Codes.Code.EndsHere
name: EndsHere name: EndsHere
@ -981,6 +1024,9 @@ references:
name: Boolean name: Boolean
nameWithType: Boolean nameWithType: Boolean
fullName: System.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* - uid: MLEM.Formatting.Codes.Code.GetColor*
commentId: Overload:MLEM.Formatting.Codes.Code.GetColor commentId: Overload:MLEM.Formatting.Codes.Code.GetColor
name: GetColor name: GetColor
@ -1082,6 +1128,9 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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* - uid: MLEM.Formatting.Codes.Code.GetFont*
commentId: Overload:MLEM.Formatting.Codes.Code.GetFont commentId: Overload:MLEM.Formatting.Codes.Code.GetFont
name: GetFont name: GetFont
@ -1110,6 +1159,11 @@ references:
name: GameTime name: GameTime
nameWithType: GameTime nameWithType: GameTime
fullName: Microsoft.Xna.Framework.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* - uid: MLEM.Formatting.Codes.Code.GetReplacementString*
commentId: Overload:MLEM.Formatting.Codes.Code.GetReplacementString commentId: Overload:MLEM.Formatting.Codes.Code.GetReplacementString
name: GetReplacementString name: GetReplacementString
@ -1122,6 +1176,9 @@ references:
name: String name: String
nameWithType: String nameWithType: String
fullName: System.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* - uid: MLEM.Formatting.Codes.Code.DrawCharacter*
commentId: Overload:MLEM.Formatting.Codes.Code.DrawCharacter commentId: Overload:MLEM.Formatting.Codes.Code.DrawCharacter
name: DrawCharacter name: DrawCharacter
@ -1168,6 +1225,9 @@ references:
name: Microsoft.Xna.Framework.Graphics name: Microsoft.Xna.Framework.Graphics
nameWithType: Microsoft.Xna.Framework.Graphics nameWithType: Microsoft.Xna.Framework.Graphics
fullName: 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* - uid: MLEM.Formatting.Codes.Code.DrawSelf*
commentId: Overload:MLEM.Formatting.Codes.Code.DrawSelf commentId: Overload:MLEM.Formatting.Codes.Code.DrawSelf
name: DrawSelf name: DrawSelf

View file

@ -21,14 +21,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ColorCode id: ColorCode
path: ../MLEM/Formatting/Codes/ColorCode.cs path: ../MLEM/Formatting/Codes/ColorCode.cs
startLine: 4 startLine: 5
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class ColorCode : Code' content: 'public class ColorCode : Code'
content.vb: >- content.vb: >-
Public Class ColorCode Public Class ColorCode
Inherits Code Inherits Code
inheritance: inheritance:
- System.Object - System.Object
@ -78,10 +80,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/ColorCode.cs path: ../MLEM/Formatting/Codes/ColorCode.cs
startLine: 8 startLine: 10
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public ColorCode(Match match, Regex regex, Color? color) content: public ColorCode(Match match, Regex regex, Color? color)
parameters: parameters:
@ -118,10 +121,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetColor id: GetColor
path: ../MLEM/Formatting/Codes/ColorCode.cs path: ../MLEM/Formatting/Codes/ColorCode.cs
startLine: 12 startLine: 15
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override Color? GetColor(Color defaultPick) content: public override Color? GetColor(Color defaultPick)
parameters: parameters:

View file

@ -22,14 +22,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: FontCode id: FontCode
path: ../MLEM/Formatting/Codes/FontCode.cs path: ../MLEM/Formatting/Codes/FontCode.cs
startLine: 5 startLine: 6
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class FontCode : Code' content: 'public class FontCode : Code'
content.vb: >- content.vb: >-
Public Class FontCode Public Class FontCode
Inherits Code Inherits Code
inheritance: inheritance:
- System.Object - System.Object
@ -81,10 +83,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/FontCode.cs path: ../MLEM/Formatting/Codes/FontCode.cs
startLine: 9 startLine: 11
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public FontCode(Match match, Regex regex, Func<GenericFont, GenericFont> font) content: public FontCode(Match match, Regex regex, Func<GenericFont, GenericFont> font)
parameters: parameters:
@ -121,10 +124,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFont id: GetFont
path: ../MLEM/Formatting/Codes/FontCode.cs path: ../MLEM/Formatting/Codes/FontCode.cs
startLine: 13 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override GenericFont GetFont(GenericFont defaultPick) content: public override GenericFont GetFont(GenericFont defaultPick)
parameters: parameters:
@ -159,10 +163,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: EndsHere id: EndsHere
path: ../MLEM/Formatting/Codes/FontCode.cs path: ../MLEM/Formatting/Codes/FontCode.cs
startLine: 17 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override bool EndsHere(Code other) content: public override bool EndsHere(Code other)
parameters: parameters:

View file

@ -24,14 +24,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ImageCode id: ImageCode
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 11 startLine: 12
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class ImageCode : Code' content: 'public class ImageCode : Code'
content.vb: >- content.vb: >-
Public Class ImageCode Public Class ImageCode
Inherits Code Inherits Code
inheritance: inheritance:
- System.Object - System.Object
@ -78,10 +80,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 17 startLine: 19
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public ImageCode(Match match, Regex regex, SpriteAnimation image) content: public ImageCode(Match match, Regex regex, SpriteAnimation image)
parameters: parameters:
@ -115,10 +118,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: EndsHere id: EndsHere
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 21 startLine: 24
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override bool EndsHere(Code other) content: public override bool EndsHere(Code other)
parameters: parameters:
@ -153,10 +157,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetReplacementString id: GetReplacementString
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 25 startLine: 29
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override string GetReplacementString(GenericFont font) content: public override string GetReplacementString(GenericFont font)
parameters: parameters:
@ -191,10 +196,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Update id: Update
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 35 startLine: 40
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override void Update(GameTime time) content: public override void Update(GameTime time)
parameters: parameters:
@ -227,10 +233,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawSelf id: DrawSelf
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 39 startLine: 45
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) content: public override void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth)
parameters: parameters:

View file

@ -21,10 +21,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ImageCodeExtensions id: ImageCodeExtensions
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 46 startLine: 55
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nA set of extensions that allow easily adding image formatting codes to a text formatter.\n"
example: []
syntax: syntax:
content: public static class ImageCodeExtensions content: public static class ImageCodeExtensions
content.vb: Public Module ImageCodeExtensions content.vb: Public Module ImageCodeExtensions
@ -64,19 +66,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddImage id: AddImage
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 48 startLine: 63
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
summary: "\nAdds a new image formatting code to the given text formatter\n"
example: []
syntax: syntax:
content: public static void AddImage(this TextFormatter formatter, string name, TextureRegion image) content: public static void AddImage(this TextFormatter formatter, string name, TextureRegion image)
parameters: parameters:
- id: formatter - id: formatter
type: MLEM.Formatting.TextFormatter type: MLEM.Formatting.TextFormatter
description: The formatter to add the code to
- id: name - id: name
type: System.String type: System.String
description: The name of the formatting code. The regex for this code will be between angle brackets.
- id: image - id: image
type: MLEM.Textures.TextureRegion type: MLEM.Textures.TextureRegion
description: The image to render at the code&apos;s position
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -107,10 +114,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddImage id: AddImage
path: ../MLEM/Formatting/Codes/ImageCode.cs path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 52 startLine: 68
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public static void AddImage(this TextFormatter formatter, string name, SpriteAnimation image) content: public static void AddImage(this TextFormatter formatter, string name, SpriteAnimation image)
parameters: parameters:
@ -463,6 +471,72 @@ references:
name: MLEM.Textures name: MLEM.Textures
nameWithType: MLEM.Textures nameWithType: MLEM.Textures
fullName: 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 - uid: MLEM.Animations.SpriteAnimation
commentId: T:MLEM.Animations.SpriteAnimation commentId: T:MLEM.Animations.SpriteAnimation
parent: MLEM.Animations parent: MLEM.Animations

View file

@ -22,14 +22,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: LinkCode id: LinkCode
path: ../MLEM/Formatting/Codes/LinkCode.cs path: ../MLEM/Formatting/Codes/LinkCode.cs
startLine: 7 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class LinkCode : UnderlineCode' content: 'public class LinkCode : UnderlineCode'
content.vb: >- content.vb: >-
Public Class LinkCode Public Class LinkCode
Inherits UnderlineCode Inherits UnderlineCode
inheritance: inheritance:
- System.Object - System.Object
@ -81,10 +83,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/LinkCode.cs path: ../MLEM/Formatting/Codes/LinkCode.cs
startLine: 11 startLine: 13
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public LinkCode(Match match, Regex regex, float thickness, float yOffset, Func<Token, bool> isSelected) content: public LinkCode(Match match, Regex regex, float thickness, float yOffset, Func<Token, bool> isSelected)
parameters: parameters:
@ -125,14 +128,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: IsSelected id: IsSelected
path: ../MLEM/Formatting/Codes/LinkCode.cs path: ../MLEM/Formatting/Codes/LinkCode.cs
startLine: 15 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes 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: syntax:
content: public virtual bool IsSelected() content: public virtual bool IsSelected()
return: return:
type: System.Boolean type: System.Boolean
description: True if this code is currently selected
content.vb: Public Overridable Function IsSelected As Boolean content.vb: Public Overridable Function IsSelected As Boolean
overload: MLEM.Formatting.Codes.LinkCode.IsSelected* overload: MLEM.Formatting.Codes.LinkCode.IsSelected*
modifiers.csharp: modifiers.csharp:
@ -159,10 +165,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawCharacter id: DrawCharacter
path: ../MLEM/Formatting/Codes/LinkCode.cs path: ../MLEM/Formatting/Codes/LinkCode.cs
startLine: 19 startLine: 26
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: 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) 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: parameters:

View file

@ -21,14 +21,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ShadowCode id: ShadowCode
path: ../MLEM/Formatting/Codes/ShadowCode.cs path: ../MLEM/Formatting/Codes/ShadowCode.cs
startLine: 7 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class ShadowCode : FontCode' content: 'public class ShadowCode : FontCode'
content.vb: >- content.vb: >-
Public Class ShadowCode Public Class ShadowCode
Inherits FontCode Inherits FontCode
inheritance: inheritance:
- System.Object - System.Object
@ -79,10 +81,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/ShadowCode.cs path: ../MLEM/Formatting/Codes/ShadowCode.cs
startLine: 12 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public ShadowCode(Match match, Regex regex, Color color, Vector2 offset) content: public ShadowCode(Match match, Regex regex, Color color, Vector2 offset)
parameters: parameters:
@ -118,10 +121,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawCharacter id: DrawCharacter
path: ../MLEM/Formatting/Codes/ShadowCode.cs path: ../MLEM/Formatting/Codes/ShadowCode.cs
startLine: 17 startLine: 20
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: 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) 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: parameters:

View file

@ -21,14 +21,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: UnderlineCode id: UnderlineCode
path: ../MLEM/Formatting/Codes/UnderlineCode.cs path: ../MLEM/Formatting/Codes/UnderlineCode.cs
startLine: 8 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class UnderlineCode : FontCode' content: 'public class UnderlineCode : FontCode'
content.vb: >- content.vb: >-
Public Class UnderlineCode Public Class UnderlineCode
Inherits FontCode Inherits FontCode
inheritance: inheritance:
- System.Object - System.Object
@ -81,10 +83,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/UnderlineCode.cs path: ../MLEM/Formatting/Codes/UnderlineCode.cs
startLine: 13 startLine: 15
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public UnderlineCode(Match match, Regex regex, float thickness, float yOffset) content: public UnderlineCode(Match match, Regex regex, float thickness, float yOffset)
parameters: parameters:
@ -120,10 +123,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawCharacter id: DrawCharacter
path: ../MLEM/Formatting/Codes/UnderlineCode.cs path: ../MLEM/Formatting/Codes/UnderlineCode.cs
startLine: 18 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: 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) 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: parameters:

View file

@ -23,14 +23,16 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: WobblyCode id: WobblyCode
path: ../MLEM/Formatting/Codes/WobblyCode.cs path: ../MLEM/Formatting/Codes/WobblyCode.cs
startLine: 7 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: 'public class WobblyCode : AnimatedCode' content: 'public class WobblyCode : AnimatedCode'
content.vb: >- content.vb: >-
Public Class WobblyCode Public Class WobblyCode
Inherits AnimatedCode Inherits AnimatedCode
inheritance: inheritance:
- System.Object - System.Object
@ -80,10 +82,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TimeIntoAnimation id: TimeIntoAnimation
path: ../MLEM/Formatting/Codes/WobblyCode.cs path: ../MLEM/Formatting/Codes/WobblyCode.cs
startLine: 11 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes 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: syntax:
content: public TimeSpan TimeIntoAnimation content: public TimeSpan TimeIntoAnimation
return: return:
@ -111,10 +115,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/Codes/WobblyCode.cs path: ../MLEM/Formatting/Codes/WobblyCode.cs
startLine: 13 startLine: 19
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public WobblyCode(Match match, Regex regex, float modifier, float heightModifier) content: public WobblyCode(Match match, Regex regex, float modifier, float heightModifier)
parameters: parameters:
@ -150,10 +155,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Update id: Update
path: ../MLEM/Formatting/Codes/WobblyCode.cs path: ../MLEM/Formatting/Codes/WobblyCode.cs
startLine: 18 startLine: 25
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: syntax:
content: public override void Update(GameTime time) content: public override void Update(GameTime time)
parameters: parameters:
@ -186,10 +192,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawCharacter id: DrawCharacter
path: ../MLEM/Formatting/Codes/WobblyCode.cs path: ../MLEM/Formatting/Codes/WobblyCode.cs
startLine: 22 startLine: 30
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting.Codes namespace: MLEM.Formatting.Codes
example: []
syntax: 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) 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: parameters:

View file

@ -38,6 +38,7 @@ items:
<Obsolete("Use the new text formatting system in MLEM.Formatting instead")> <Obsolete("Use the new text formatting system in MLEM.Formatting instead")>
Public Class FormatSettings Public Class FormatSettings
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object

View file

@ -32,7 +32,9 @@ items:
<Obsolete("Use the new text formatting system in MLEM.Formatting instead")> <Obsolete("Use the new text formatting system in MLEM.Formatting instead")>
Public Class FormattingCodeCollection Public Class FormattingCodeCollection
Inherits Dictionary(Of Integer, List(Of FormattingCodeData)) 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 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: inheritance:
- System.Object - System.Object

View file

@ -36,6 +36,7 @@ items:
<Obsolete("Use the new text formatting system in MLEM.Formatting instead")> <Obsolete("Use the new text formatting system in MLEM.Formatting instead")>
Public Class FormattingCodeData Public Class FormattingCodeData
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object

View file

@ -22,14 +22,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TextFormatter id: TextFormatter
path: ../MLEM/Formatting/TextFormatter.cs path: ../MLEM/Formatting/TextFormatter.cs
startLine: 12 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nA text formatter is used for drawing text using <xref href=\"MLEM.Font.GenericFont\" data-throw-if-not-resolved=\"false\"></xref> 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 <xref href=\"MLEM.Formatting.TextFormatter.Tokenize(MLEM.Font.GenericFont%2cSystem.String)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax: syntax:
content: 'public class TextFormatter : GenericDataHolder' content: 'public class TextFormatter : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class TextFormatter Public Class TextFormatter
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -72,10 +75,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Codes id: Codes
path: ../MLEM/Formatting/TextFormatter.cs path: ../MLEM/Formatting/TextFormatter.cs
startLine: 14 startLine: 22
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe formatting codes that this text formatter uses.\nThe <xref href=\"System.Text.RegularExpressions.Regex\" data-throw-if-not-resolved=\"false\"></xref> defines how the formatting code should be matched.\n"
example: []
syntax: syntax:
content: public readonly Dictionary<Regex, Code.Constructor> Codes content: public readonly Dictionary<Regex, Code.Constructor> Codes
return: return:
@ -105,10 +110,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Formatting/TextFormatter.cs path: ../MLEM/Formatting/TextFormatter.cs
startLine: 16 startLine: 27
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nCreates a new text formatter with a set of default formatting codes.\n"
example: []
syntax: syntax:
content: public TextFormatter() content: public TextFormatter()
content.vb: Public Sub New content.vb: Public Sub New
@ -135,19 +142,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Tokenize id: Tokenize
path: ../MLEM/Formatting/TextFormatter.cs path: ../MLEM/Formatting/TextFormatter.cs
startLine: 39 startLine: 56
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nTokenizes a string, returning a tokenized string that is ready for splitting, measuring and drawing.\n"
example: []
syntax: syntax:
content: public TokenizedString Tokenize(GenericFont font, string s) content: public TokenizedString Tokenize(GenericFont font, string s)
parameters: parameters:
- id: font - id: font
type: MLEM.Font.GenericFont 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 - id: s
type: System.String type: System.String
description: The string to tokenize
return: return:
type: MLEM.Formatting.TokenizedString type: MLEM.Formatting.TokenizedString
description: ''
content.vb: Public Function Tokenize(font As GenericFont, s As String) As TokenizedString content.vb: Public Function Tokenize(font As GenericFont, s As String) As TokenizedString
overload: MLEM.Formatting.TextFormatter.Tokenize* overload: MLEM.Formatting.TextFormatter.Tokenize*
modifiers.csharp: modifiers.csharp:
@ -155,6 +167,15 @@ items:
modifiers.vb: modifiers.vb:
- Public - Public
references: 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 - uid: MLEM.Formatting
commentId: N:MLEM.Formatting commentId: N:MLEM.Formatting
name: MLEM.Formatting name: MLEM.Formatting
@ -683,6 +704,11 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) fullName: )
- uid: MLEM.Font
commentId: N:MLEM.Font
name: MLEM.Font
nameWithType: MLEM.Font
fullName: MLEM.Font
- uid: System - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
@ -837,6 +863,13 @@ references:
name: MLEM.Formatting.Codes name: MLEM.Formatting.Codes
nameWithType: MLEM.Formatting.Codes nameWithType: MLEM.Formatting.Codes
fullName: 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} - 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} commentId: T:System.Collections.Generic.Dictionary{System.Text.RegularExpressions.Regex,MLEM.Formatting.Codes.Code.Constructor}
parent: System.Collections.Generic parent: System.Collections.Generic
@ -895,6 +928,12 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System.Collections.Generic.Dictionary`2
commentId: T:System.Collections.Generic.Dictionary`2 commentId: T:System.Collections.Generic.Dictionary`2
isExternal: true isExternal: true
@ -962,12 +1001,6 @@ references:
name: Tokenize name: Tokenize
nameWithType: TextFormatter.Tokenize nameWithType: TextFormatter.Tokenize
fullName: MLEM.Formatting.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 - uid: System.String
commentId: T:System.String commentId: T:System.String
parent: System parent: System
@ -981,8 +1014,3 @@ references:
name: TokenizedString name: TokenizedString
nameWithType: TokenizedString nameWithType: TokenizedString
fullName: MLEM.Formatting.TokenizedString fullName: MLEM.Formatting.TokenizedString
- uid: MLEM.Font
commentId: N:MLEM.Font
name: MLEM.Font
nameWithType: MLEM.Font
fullName: MLEM.Font

View file

@ -5,7 +5,6 @@ items:
id: Token id: Token
parent: MLEM.Formatting parent: MLEM.Formatting
children: children:
- MLEM.Formatting.Token.#ctor(MLEM.Formatting.Codes.Code[],System.Int32,System.Int32,System.String,System.String)
- MLEM.Formatting.Token.AppliedCodes - MLEM.Formatting.Token.AppliedCodes
- MLEM.Formatting.Token.DisplayString - 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) - 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 repo: https://github.com/Ellpeck/MLEM
id: Token id: Token
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 10 startLine: 13
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nA part of a <xref href=\"MLEM.Formatting.TokenizedString\" data-throw-if-not-resolved=\"false\"></xref> that has a certain list of formatting codes applied.\n"
example: []
syntax: syntax:
content: 'public class Token : GenericDataHolder' content: 'public class Token : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class Token Public Class Token
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -78,10 +80,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AppliedCodes id: AppliedCodes
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 12 startLine: 18
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe formatting codes that are applied on this token.\n"
example: []
syntax: syntax:
content: public readonly Code[] AppliedCodes content: public readonly Code[] AppliedCodes
return: return:
@ -111,10 +115,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Index id: Index
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 13 startLine: 22
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe index in the <xref href=\"MLEM.Formatting.Token.Substring\" data-throw-if-not-resolved=\"false\"></xref> that this token starts at.\n"
example: []
syntax: syntax:
content: public readonly int Index content: public readonly int Index
return: return:
@ -144,10 +150,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RawIndex id: RawIndex
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 14 startLine: 26
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe index in the <xref href=\"MLEM.Formatting.Token.RawSubstring\" data-throw-if-not-resolved=\"false\"></xref> that this token starts at.\n"
example: []
syntax: syntax:
content: public readonly int RawIndex content: public readonly int RawIndex
return: return:
@ -177,10 +185,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Substring id: Substring
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 15 startLine: 30
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe substring that this token contains.\n"
example: []
syntax: syntax:
content: public readonly string Substring content: public readonly string Substring
return: return:
@ -210,10 +220,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DisplayString id: DisplayString
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 16 startLine: 34
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting 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: syntax:
content: public string DisplayString { get; } content: public string DisplayString { get; }
parameters: [] parameters: []
@ -245,10 +257,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RawSubstring id: RawSubstring
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 17 startLine: 38
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe substring that this token contains, without the formatting codes removed.\n"
example: []
syntax: syntax:
content: public readonly string RawSubstring content: public readonly string RawSubstring
return: return:
@ -260,50 +274,6 @@ items:
modifiers.vb: modifiers.vb:
- Public - Public
- ReadOnly - 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) - uid: MLEM.Formatting.Token.GetColor(Microsoft.Xna.Framework.Color)
commentId: M:MLEM.Formatting.Token.GetColor(Microsoft.Xna.Framework.Color) commentId: M:MLEM.Formatting.Token.GetColor(Microsoft.Xna.Framework.Color)
id: GetColor(Microsoft.Xna.Framework.Color) id: GetColor(Microsoft.Xna.Framework.Color)
@ -322,17 +292,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetColor id: GetColor
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 32 startLine: 58
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nGet the color that this token will be rendered with\n"
example: []
syntax: syntax:
content: public Color? GetColor(Color defaultPick) content: public Color? GetColor(Color defaultPick)
parameters: parameters:
- id: defaultPick - id: defaultPick
type: Microsoft.Xna.Framework.Color type: Microsoft.Xna.Framework.Color
description: The default color, if none is specified
return: return:
type: System.Nullable{Microsoft.Xna.Framework.Color} type: System.Nullable{Microsoft.Xna.Framework.Color}
description: The color to render with
content.vb: Public Function GetColor(defaultPick As Color) As Color? content.vb: Public Function GetColor(defaultPick As Color) As Color?
overload: MLEM.Formatting.Token.GetColor* overload: MLEM.Formatting.Token.GetColor*
modifiers.csharp: modifiers.csharp:
@ -357,17 +331,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetFont id: GetFont
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 36 startLine: 67
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nGet the font that this token will be rendered with\n"
example: []
syntax: syntax:
content: public GenericFont GetFont(GenericFont defaultPick) content: public GenericFont GetFont(GenericFont defaultPick)
parameters: parameters:
- id: defaultPick - id: defaultPick
type: MLEM.Font.GenericFont type: MLEM.Font.GenericFont
description: The default font, if none is specified
return: return:
type: MLEM.Font.GenericFont type: MLEM.Font.GenericFont
description: The font to render with
content.vb: Public Function GetFont(defaultPick As GenericFont) As GenericFont content.vb: Public Function GetFont(defaultPick As GenericFont) As GenericFont
overload: MLEM.Formatting.Token.GetFont* overload: MLEM.Formatting.Token.GetFont*
modifiers.csharp: modifiers.csharp:
@ -392,27 +370,36 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawSelf id: DrawSelf
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 40 startLine: 82
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nDraws the token itself, including all of the <xref href=\"MLEM.Formatting.Codes.Code\" data-throw-if-not-resolved=\"false\"></xref> instances that this token contains.\nNote that, to draw the token&apos;s actual string, <xref href=\"MLEM.Formatting.Token.DrawCharacter(Microsoft.Xna.Framework.GameTime%2cMicrosoft.Xna.Framework.Graphics.SpriteBatch%2cSystem.Char%2cSystem.String%2cSystem.Int32%2cMicrosoft.Xna.Framework.Vector2%2cMLEM.Font.GenericFont%2cMicrosoft.Xna.Framework.Color%2cSystem.Single%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref> is used.\n"
example: []
syntax: syntax:
content: public void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) content: public void DrawSelf(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth)
parameters: parameters:
- id: time - id: time
type: Microsoft.Xna.Framework.GameTime type: Microsoft.Xna.Framework.GameTime
description: The time
- id: batch - id: batch
type: Microsoft.Xna.Framework.Graphics.SpriteBatch type: Microsoft.Xna.Framework.Graphics.SpriteBatch
description: The sprite batch to use
- id: pos - id: pos
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The position to draw the token at
- id: font - id: font
type: MLEM.Font.GenericFont type: MLEM.Font.GenericFont
description: The font to use to draw
- id: color - id: color
type: Microsoft.Xna.Framework.Color type: Microsoft.Xna.Framework.Color
description: The color to draw with
- id: scale - id: scale
type: System.Single type: System.Single
description: The scale to draw at
- id: depth - id: depth
type: System.Single 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) 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* overload: MLEM.Formatting.Token.DrawSelf*
modifiers.csharp: modifiers.csharp:
@ -437,33 +424,45 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawCharacter id: DrawCharacter
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 45 startLine: 100
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nDraws a given character using this token&apos;s formatting options.\n"
example: []
syntax: 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) 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: parameters:
- id: time - id: time
type: Microsoft.Xna.Framework.GameTime type: Microsoft.Xna.Framework.GameTime
description: The time
- id: batch - id: batch
type: Microsoft.Xna.Framework.Graphics.SpriteBatch type: Microsoft.Xna.Framework.Graphics.SpriteBatch
description: The sprite batch to use
- id: c - id: c
type: System.Char type: System.Char
description: The character to draw
- id: cString - id: cString
type: System.String type: System.String
description: A single-character string that contains the character to draw
- id: indexInToken - id: indexInToken
type: System.Int32 type: System.Int32
description: The index within this token that the character is at
- id: pos - id: pos
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The position to draw the token at
- id: font - id: font
type: MLEM.Font.GenericFont type: MLEM.Font.GenericFont
description: The font to use to draw
- id: color - id: color
type: Microsoft.Xna.Framework.Color type: Microsoft.Xna.Framework.Color
description: The color to draw with
- id: scale - id: scale
type: System.Single type: System.Single
description: The scale to draw at
- id: depth - id: depth
type: System.Single 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) 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* overload: MLEM.Formatting.Token.DrawCharacter*
modifiers.csharp: modifiers.csharp:
@ -488,19 +487,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetArea id: GetArea
path: ../MLEM/Formatting/Token.cs path: ../MLEM/Formatting/Token.cs
startLine: 55 startLine: 118
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nGets a list of rectangles that encompass this token&apos;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: syntax:
content: public IEnumerable<RectangleF> GetArea(Vector2 stringPos, float scale) content: public IEnumerable<RectangleF> GetArea(Vector2 stringPos, float scale)
parameters: parameters:
- id: stringPos - id: stringPos
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The position that the string is drawn at
- id: scale - id: scale
type: System.Single type: System.Single
description: The scale that the string is drawn at
return: return:
type: System.Collections.Generic.IEnumerable{MLEM.Misc.RectangleF} 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) content.vb: Public Function GetArea(stringPos As Vector2, scale As Single) As IEnumerable(Of RectangleF)
overload: MLEM.Formatting.Token.GetArea* overload: MLEM.Formatting.Token.GetArea*
modifiers.csharp: modifiers.csharp:
@ -508,6 +512,12 @@ items:
modifiers.vb: modifiers.vb:
- Public - Public
references: references:
- uid: MLEM.Formatting.TokenizedString
commentId: T:MLEM.Formatting.TokenizedString
parent: MLEM.Formatting
name: TokenizedString
nameWithType: TokenizedString
fullName: MLEM.Formatting.TokenizedString
- uid: MLEM.Formatting - uid: MLEM.Formatting
commentId: N:MLEM.Formatting commentId: N:MLEM.Formatting
name: MLEM.Formatting name: MLEM.Formatting
@ -965,6 +975,9 @@ references:
- name: () - name: ()
nameWithType: () nameWithType: ()
fullName: () fullName: ()
- uid: MLEM.Formatting.Token.Substring
commentId: F:MLEM.Formatting.Token.Substring
isExternal: true
- uid: System.Int32 - uid: System.Int32
commentId: T:System.Int32 commentId: T:System.Int32
parent: System parent: System
@ -972,6 +985,9 @@ references:
name: Int32 name: Int32
nameWithType: Int32 nameWithType: Int32
fullName: System.Int32 fullName: System.Int32
- uid: MLEM.Formatting.Token.RawSubstring
commentId: F:MLEM.Formatting.Token.RawSubstring
isExternal: true
- uid: System.String - uid: System.String
commentId: T:System.String commentId: T:System.String
parent: System parent: System
@ -984,11 +1000,6 @@ references:
name: DisplayString name: DisplayString
nameWithType: Token.DisplayString nameWithType: Token.DisplayString
fullName: MLEM.Formatting.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* - uid: MLEM.Formatting.Token.GetColor*
commentId: Overload:MLEM.Formatting.Token.GetColor commentId: Overload:MLEM.Formatting.Token.GetColor
name: GetColor name: GetColor
@ -1106,6 +1117,15 @@ references:
name: MLEM.Font name: MLEM.Font
nameWithType: MLEM.Font nameWithType: MLEM.Font
fullName: 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* - uid: MLEM.Formatting.Token.DrawSelf*
commentId: Overload:MLEM.Formatting.Token.DrawSelf commentId: Overload:MLEM.Formatting.Token.DrawSelf
name: DrawSelf name: DrawSelf
@ -1139,6 +1159,11 @@ references:
name: Single name: Single
nameWithType: Single nameWithType: Single
fullName: System.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 - uid: Microsoft.Xna.Framework.Graphics
commentId: N:Microsoft.Xna.Framework.Graphics commentId: N:Microsoft.Xna.Framework.Graphics
isExternal: true isExternal: true

View file

@ -5,7 +5,6 @@ items:
id: TokenizedString id: TokenizedString
parent: MLEM.Formatting parent: MLEM.Formatting
children: children:
- MLEM.Formatting.TokenizedString.#ctor(MLEM.Font.GenericFont,System.String,System.String,MLEM.Formatting.Token[])
- MLEM.Formatting.TokenizedString.AllCodes - MLEM.Formatting.TokenizedString.AllCodes
- MLEM.Formatting.TokenizedString.DisplayString - 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) - 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 repo: https://github.com/Ellpeck/MLEM
id: TokenizedString id: TokenizedString
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 11 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nA tokenized string that was created using a <xref href=\"MLEM.Formatting.TextFormatter\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: 'public class TokenizedString : GenericDataHolder' content: 'public class TokenizedString : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class TokenizedString Public Class TokenizedString
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -77,10 +79,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RawString id: RawString
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 13 startLine: 19
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe raw string that was used to create this tokenized string.\n"
example: []
syntax: syntax:
content: public readonly string RawString content: public readonly string RawString
return: return:
@ -110,10 +114,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: String id: String
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 14 startLine: 23
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe <xref href=\"MLEM.Formatting.TokenizedString.RawString\" data-throw-if-not-resolved=\"false\"></xref>, but with formatting codes stripped out.\n"
example: []
syntax: syntax:
content: public readonly string String content: public readonly string String
return: return:
@ -143,10 +149,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DisplayString id: DisplayString
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 15 startLine: 28
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe string that is actually displayed by this tokenized string.\nIf this string has been <xref href=\"MLEM.Formatting.TokenizedString.Split(MLEM.Font.GenericFont%2cSystem.Single%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref>, this string will contain the newline characters.\n"
example: []
syntax: syntax:
content: public string DisplayString { get; } content: public string DisplayString { get; }
parameters: [] parameters: []
@ -178,10 +186,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Tokens id: Tokens
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 16 startLine: 32
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nThe tokens that this tokenized string contains.\n"
example: []
syntax: syntax:
content: public readonly Token[] Tokens content: public readonly Token[] Tokens
return: return:
@ -211,10 +221,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AllCodes id: AllCodes
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 17 startLine: 37
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting 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 <xref href=\"MLEM.Formatting.Token.AppliedCodes\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public readonly Code[] AllCodes content: public readonly Code[] AllCodes
return: return:
@ -226,48 +238,6 @@ items:
modifiers.vb: modifiers.vb:
- Public - Public
- ReadOnly - 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) - 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) commentId: M:MLEM.Formatting.TokenizedString.Split(MLEM.Font.GenericFont,System.Single,System.Single)
id: 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 repo: https://github.com/Ellpeck/MLEM
id: Split id: Split
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 29 startLine: 56
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nSplits this tokenized string, inserting newline characters if the width of the string is bigger than the maximum width.\n<xref href=\"MLEM.Font.GenericFont.SplitString(System.String%2cSystem.Single%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public void Split(GenericFont font, float width, float scale) content: public void Split(GenericFont font, float width, float scale)
parameters: parameters:
- id: font - id: font
type: MLEM.Font.GenericFont type: MLEM.Font.GenericFont
description: The font to use for width calculations
- id: width - id: width
type: System.Single type: System.Single
description: The maximum width
- id: scale - id: scale
type: System.Single 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) content.vb: Public Sub Split(font As GenericFont, width As Single, scale As Single)
overload: MLEM.Formatting.TokenizedString.Split* overload: MLEM.Formatting.TokenizedString.Split*
modifiers.csharp: modifiers.csharp:
@ -323,10 +298,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Measure id: Measure
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 59 startLine: 87
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
example: []
syntax: syntax:
content: public Vector2 Measure(GenericFont font) content: public Vector2 Measure(GenericFont font)
parameters: parameters:
@ -358,15 +334,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Update id: Update
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 63 startLine: 95
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
summary: "\nUpdates the formatting codes in this formatted string, causing animations to animate etc.\n"
example: []
syntax: syntax:
content: public void Update(GameTime time) content: public void Update(GameTime time)
parameters: parameters:
- id: time - id: time
type: Microsoft.Xna.Framework.GameTime type: Microsoft.Xna.Framework.GameTime
description: The game&apos;s time
content.vb: Public Sub Update(time As GameTime) content.vb: Public Sub Update(time As GameTime)
overload: MLEM.Formatting.TokenizedString.Update* overload: MLEM.Formatting.TokenizedString.Update*
modifiers.csharp: modifiers.csharp:
@ -391,21 +370,27 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetTokenUnderPos id: GetTokenUnderPos
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 68 startLine: 108
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting 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: syntax:
content: public Token GetTokenUnderPos(Vector2 stringPos, Vector2 target, float scale) content: public Token GetTokenUnderPos(Vector2 stringPos, Vector2 target, float scale)
parameters: parameters:
- id: stringPos - id: stringPos
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The position that the string is drawn at
- id: target - id: target
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The position to use for checking the token
- id: scale - id: scale
type: System.Single type: System.Single
description: The scale that the string is drawn at
return: return:
type: MLEM.Formatting.Token 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 content.vb: Public Function GetTokenUnderPos(stringPos As Vector2, target As Vector2, scale As Single) As Token
overload: MLEM.Formatting.TokenizedString.GetTokenUnderPos* overload: MLEM.Formatting.TokenizedString.GetTokenUnderPos*
modifiers.csharp: modifiers.csharp:
@ -430,10 +415,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Formatting/TokenizedString.cs path: ../MLEM/Formatting/TokenizedString.cs
startLine: 72 startLine: 113
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Formatting namespace: MLEM.Formatting
example: []
syntax: syntax:
content: public void Draw(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth) content: public void Draw(GameTime time, SpriteBatch batch, Vector2 pos, GenericFont font, Color color, float scale, float depth)
parameters: parameters:
@ -458,6 +444,12 @@ items:
modifiers.vb: modifiers.vb:
- Public - Public
references: references:
- uid: MLEM.Formatting.TextFormatter
commentId: T:MLEM.Formatting.TextFormatter
parent: MLEM.Formatting
name: TextFormatter
nameWithType: TextFormatter
fullName: MLEM.Formatting.TextFormatter
- uid: MLEM.Formatting - uid: MLEM.Formatting
commentId: N:MLEM.Formatting commentId: N:MLEM.Formatting
name: MLEM.Formatting name: MLEM.Formatting
@ -898,6 +890,12 @@ references:
name: String name: String
nameWithType: String nameWithType: String
fullName: System.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* - uid: MLEM.Formatting.TokenizedString.DisplayString*
commentId: Overload:MLEM.Formatting.TokenizedString.DisplayString commentId: Overload:MLEM.Formatting.TokenizedString.DisplayString
name: DisplayString name: DisplayString
@ -927,6 +925,9 @@ references:
- name: () - name: ()
nameWithType: () nameWithType: ()
fullName: () fullName: ()
- uid: MLEM.Formatting.Token.AppliedCodes
commentId: F:MLEM.Formatting.Token.AppliedCodes
isExternal: true
- uid: MLEM.Formatting.Codes.Code[] - uid: MLEM.Formatting.Codes.Code[]
isExternal: true isExternal: true
name: Code[] name: Code[]
@ -951,27 +952,88 @@ references:
- name: () - name: ()
nameWithType: () nameWithType: ()
fullName: () fullName: ()
- uid: MLEM.Formatting.TokenizedString.#ctor* - uid: MLEM.Font.GenericFont.SplitString(System.String,System.Single,System.Single)
commentId: Overload:MLEM.Formatting.TokenizedString.#ctor commentId: M:MLEM.Font.GenericFont.SplitString(System.String,System.Single,System.Single)
name: TokenizedString parent: MLEM.Font.GenericFont
nameWithType: TokenizedString.TokenizedString isExternal: true
fullName: MLEM.Formatting.TokenizedString.TokenizedString 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 - uid: MLEM.Font.GenericFont
commentId: T:MLEM.Font.GenericFont commentId: T:MLEM.Font.GenericFont
parent: MLEM.Font parent: MLEM.Font
name: GenericFont name: GenericFont
nameWithType: GenericFont nameWithType: GenericFont
fullName: MLEM.Font.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 - uid: System.Single
commentId: T:System.Single commentId: T:System.Single
parent: System parent: System
@ -979,6 +1041,50 @@ references:
name: Single name: Single
nameWithType: Single nameWithType: Single
fullName: System.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* - uid: MLEM.Formatting.TokenizedString.Measure*
commentId: Overload:MLEM.Formatting.TokenizedString.Measure commentId: Overload:MLEM.Formatting.TokenizedString.Measure
name: Measure name: Measure
@ -1020,6 +1126,173 @@ references:
name: Token name: Token
nameWithType: Token nameWithType: Token
fullName: MLEM.Formatting.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* - uid: MLEM.Formatting.TokenizedString.Draw*
commentId: Overload:MLEM.Formatting.TokenizedString.Draw commentId: Overload:MLEM.Formatting.TokenizedString.Draw
name: Draw name: Draw

File diff suppressed because it is too large Load diff

View file

@ -23,10 +23,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: KeysExtensions id: KeysExtensions
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nA set of extension methods for dealing with <xref href=\"Microsoft.Xna.Framework.Input.Keys\" data-throw-if-not-resolved=\"false\"></xref> and <xref href=\"Microsoft.Xna.Framework.Input.Keyboard\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class KeysExtensions content: public static class KeysExtensions
content.vb: Public Module KeysExtensions content.vb: Public Module KeysExtensions
@ -65,10 +67,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ModifierKeys id: ModifierKeys
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 8 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nAll enum values of <xref href=\"MLEM.Input.ModifierKey\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static readonly ModifierKey[] ModifierKeys content: public static readonly ModifierKey[] ModifierKeys
return: return:
@ -101,17 +105,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetKeys id: GetKeys
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 10 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nReturns all of the keys that the given modifier key represents\n"
example: []
syntax: syntax:
content: public static IEnumerable<Keys> GetKeys(this ModifierKey modifier) content: public static IEnumerable<Keys> GetKeys(this ModifierKey modifier)
parameters: parameters:
- id: modifier - id: modifier
type: MLEM.Input.ModifierKey type: MLEM.Input.ModifierKey
description: The modifier key
return: return:
type: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys} type: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys}
description: All of the keys the modifier key represents
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -142,17 +150,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetModifier id: GetModifier
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 27 startLine: 44
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nReturns the modifier key that the given key represents.\nIf there is no matching modifier key, <xref href=\"MLEM.Input.ModifierKey.None\" data-throw-if-not-resolved=\"false\"></xref> is returned.\n"
example: []
syntax: syntax:
content: public static ModifierKey GetModifier(this Keys key) content: public static ModifierKey GetModifier(this Keys key)
parameters: parameters:
- id: key - id: key
type: Microsoft.Xna.Framework.Input.Keys type: Microsoft.Xna.Framework.Input.Keys
description: The key to convert to a modifier key
return: return:
type: MLEM.Input.ModifierKey type: MLEM.Input.ModifierKey
description: The modifier key, or <xref href="MLEM.Input.ModifierKey.None" data-throw-if-not-resolved="false"></xref>
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -183,17 +195,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: IsModifier id: IsModifier
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 35 startLine: 57
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nReturns whether the given key is a modifier key or not.\n"
example: []
syntax: syntax:
content: public static bool IsModifier(this Keys key) content: public static bool IsModifier(this Keys key)
parameters: parameters:
- id: key - id: key
type: Microsoft.Xna.Framework.Input.Keys type: Microsoft.Xna.Framework.Input.Keys
description: The key
return: return:
type: System.Boolean type: System.Boolean
description: If the key is a modifier key
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -206,6 +222,16 @@ items:
- Public - Public
- Shared - Shared
references: 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 - uid: MLEM.Input
commentId: N:MLEM.Input commentId: N:MLEM.Input
name: MLEM.Input name: MLEM.Input
@ -497,12 +523,24 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
name: System name: System
nameWithType: System nameWithType: System
fullName: 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[] - uid: MLEM.Input.ModifierKey[]
isExternal: true isExternal: true
name: ModifierKey[] name: ModifierKey[]
@ -532,12 +570,6 @@ references:
name: GetKeys name: GetKeys
nameWithType: KeysExtensions.GetKeys nameWithType: KeysExtensions.GetKeys
fullName: MLEM.Input.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} - uid: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys}
commentId: T:System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys} commentId: T:System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Input.Keys}
parent: System.Collections.Generic parent: System.Collections.Generic
@ -627,24 +659,14 @@ references:
name: System.Collections.Generic name: System.Collections.Generic
nameWithType: System.Collections.Generic nameWithType: System.Collections.Generic
fullName: 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* - uid: MLEM.Input.KeysExtensions.GetModifier*
commentId: Overload:MLEM.Input.KeysExtensions.GetModifier commentId: Overload:MLEM.Input.KeysExtensions.GetModifier
name: GetModifier name: GetModifier
nameWithType: KeysExtensions.GetModifier nameWithType: KeysExtensions.GetModifier
fullName: MLEM.Input.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* - uid: MLEM.Input.KeysExtensions.IsModifier*
commentId: Overload:MLEM.Input.KeysExtensions.IsModifier commentId: Overload:MLEM.Input.KeysExtensions.IsModifier
name: IsModifier name: IsModifier

View file

@ -23,10 +23,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ModifierKey id: ModifierKey
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 41 startLine: 67
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input 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: syntax:
content: public enum ModifierKey content: public enum ModifierKey
content.vb: Public Enum ModifierKey content.vb: Public Enum ModifierKey
@ -56,10 +58,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: None id: None
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 43 startLine: 72
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nNo modifier key. Only used for <xref href=\"MLEM.Input.KeysExtensions.GetModifier(Microsoft.Xna.Framework.Input.Keys)\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: None = 0 content: None = 0
return: return:
@ -88,10 +92,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Shift id: Shift
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 44 startLine: 76
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe shift modifier key. This represents Left Shift and Right Shift keys.\n"
example: []
syntax: syntax:
content: Shift = 1 content: Shift = 1
return: return:
@ -120,10 +126,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Control id: Control
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 45 startLine: 80
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe control modifier key. This represents Left Control and Right Control.\n"
example: []
syntax: syntax:
content: Control = 2 content: Control = 2
return: return:
@ -152,10 +160,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Alt id: Alt
path: ../MLEM/Input/KeysExtensions.cs path: ../MLEM/Input/KeysExtensions.cs
startLine: 46 startLine: 84
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe alt modifier key. This represents Alt and Alt Graph.\n"
example: []
syntax: syntax:
content: Alt = 3 content: Alt = 3
return: return:
@ -242,6 +252,9 @@ references:
name: KeysExtensions name: KeysExtensions
nameWithType: KeysExtensions nameWithType: KeysExtensions
fullName: MLEM.Input.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 - uid: MLEM.Input.ModifierKey
commentId: T:MLEM.Input.ModifierKey commentId: T:MLEM.Input.ModifierKey
parent: MLEM.Input parent: MLEM.Input

View file

@ -24,10 +24,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: MouseButton id: MouseButton
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 29 startLine: 46
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThis enum is a list of possible mouse buttons.\nIt serves as a wrapper around <xref href=\"Microsoft.Xna.Framework.Input.MouseState\" data-throw-if-not-resolved=\"false\"></xref>&apos;s button properties.\n"
example: []
syntax: syntax:
content: public enum MouseButton content: public enum MouseButton
content.vb: Public Enum MouseButton content.vb: Public Enum MouseButton
@ -55,10 +57,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Left id: Left
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 31 startLine: 51
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe left mouse button, or <xref href=\"Microsoft.Xna.Framework.Input.MouseState.LeftButton\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: Left = 0 content: Left = 0
return: return:
@ -87,10 +91,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Middle id: Middle
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 32 startLine: 55
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe middle mouse button, or <xref href=\"Microsoft.Xna.Framework.Input.MouseState.MiddleButton\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: Middle = 1 content: Middle = 1
return: return:
@ -119,10 +125,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Right id: Right
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 33 startLine: 59
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe right mouse button, or <xref href=\"Microsoft.Xna.Framework.Input.MouseState.RightButton\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: Right = 2 content: Right = 2
return: return:
@ -151,10 +159,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Extra1 id: Extra1
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 34 startLine: 63
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe first extra mouse button, or <xref href=\"Microsoft.Xna.Framework.Input.MouseState.XButton1\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: Extra1 = 3 content: Extra1 = 3
return: return:
@ -183,10 +193,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Extra2 id: Extra2
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 35 startLine: 67
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nThe second extra mouse button, or <xref href=\"Microsoft.Xna.Framework.Input.MouseState.XButton2\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: Extra2 = 4 content: Extra2 = 4
return: return:
@ -198,14 +210,42 @@ items:
- Public - Public
- Const - Const
references: 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 - uid: MLEM.Input
commentId: N:MLEM.Input commentId: N:MLEM.Input
name: MLEM.Input name: MLEM.Input
nameWithType: MLEM.Input nameWithType: MLEM.Input
fullName: 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 - uid: MLEM.Input.MouseButton
commentId: T:MLEM.Input.MouseButton commentId: T:MLEM.Input.MouseButton
parent: MLEM.Input parent: MLEM.Input
name: MouseButton name: MouseButton
nameWithType: MouseButton nameWithType: MouseButton
fullName: MLEM.Input.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

View file

@ -21,10 +21,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: MouseExtensions id: MouseExtensions
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nA set of extension methods for dealing with <xref href=\"MLEM.Input.MouseButton\" data-throw-if-not-resolved=\"false\"></xref> and <xref href=\"Microsoft.Xna.Framework.Input.Mouse\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class MouseExtensions content: public static class MouseExtensions
content.vb: Public Module MouseExtensions content.vb: Public Module MouseExtensions
@ -63,10 +65,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: MouseButtons id: MouseButtons
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 8 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nAll enum values of <xref href=\"MLEM.Input.MouseButton\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static readonly MouseButton[] MouseButtons content: public static readonly MouseButton[] MouseButtons
return: return:
@ -99,24 +103,33 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetState id: GetState
path: ../MLEM/Input/MouseExtensions.cs path: ../MLEM/Input/MouseExtensions.cs
startLine: 10 startLine: 23
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Input namespace: MLEM.Input
summary: "\nReturns the <xref href=\"Microsoft.Xna.Framework.Input.ButtonState\" data-throw-if-not-resolved=\"false\"></xref> of the given mouse button.\n"
example: []
syntax: syntax:
content: public static ButtonState GetState(this MouseState state, MouseButton button) content: public static ButtonState GetState(this MouseState state, MouseButton button)
parameters: parameters:
- id: state - id: state
type: Microsoft.Xna.Framework.Input.MouseState type: Microsoft.Xna.Framework.Input.MouseState
description: The mouse&apos;s current state
- id: button - id: button
type: MLEM.Input.MouseButton type: MLEM.Input.MouseButton
description: The button whose state to query
return: return:
type: Microsoft.Xna.Framework.Input.ButtonState type: Microsoft.Xna.Framework.Input.ButtonState
description: The state of the button
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
Public Shared Function GetState(state As MouseState, button As MouseButton) As ButtonState Public Shared Function GetState(state As MouseState, button As MouseButton) As ButtonState
overload: MLEM.Input.MouseExtensions.GetState* 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: modifiers.csharp:
- public - public
- static - static
@ -124,6 +137,15 @@ items:
- Public - Public
- Shared - Shared
references: 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 - uid: MLEM.Input
commentId: N:MLEM.Input commentId: N:MLEM.Input
name: MLEM.Input name: MLEM.Input
@ -445,6 +467,16 @@ references:
- name: () - name: ()
nameWithType: () nameWithType: ()
fullName: () 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* - uid: MLEM.Input.MouseExtensions.GetState*
commentId: Overload:MLEM.Input.MouseExtensions.GetState commentId: Overload:MLEM.Input.MouseExtensions.GetState
name: GetState name: GetState
@ -457,19 +489,6 @@ references:
name: MouseState name: MouseState
nameWithType: MouseState nameWithType: MouseState
fullName: Microsoft.Xna.Framework.Input.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 - uid: Microsoft.Xna.Framework.Input
commentId: N:Microsoft.Xna.Framework.Input commentId: N:Microsoft.Xna.Framework.Input
isExternal: true isExternal: true

View file

@ -19,17 +19,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ConnectsTo id: ConnectsTo
path: ../MLEM/Misc/AutoTiling.cs path: ../MLEM/Misc/AutoTiling.cs
startLine: 28 startLine: 54
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nA delegate function that determines if a given offset position connects to an auto-tile location.\n"
example: []
syntax: syntax:
content: public delegate bool ConnectsTo(int xOff, int yOff); content: public delegate bool ConnectsTo(int xOff, int yOff);
parameters: parameters:
- id: xOff - id: xOff
type: System.Int32 type: System.Int32
description: The x offset
- id: yOff - id: yOff
type: System.Int32 type: System.Int32
description: The y offset
return: return:
type: System.Boolean type: System.Boolean
content.vb: Public Delegate Function ConnectsTo(xOff As Integer, yOff As Integer) As Boolean content.vb: Public Delegate Function ConnectsTo(xOff As Integer, yOff As Integer) As Boolean

View file

@ -20,10 +20,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AutoTiling id: AutoTiling
path: ../MLEM/Misc/AutoTiling.cs path: ../MLEM/Misc/AutoTiling.cs
startLine: 4 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThis class contains a <xref href=\"MLEM.Misc.AutoTiling.DrawAutoTile(Microsoft.Xna.Framework.Graphics.SpriteBatch%2cMicrosoft.Xna.Framework.Vector2%2cMicrosoft.Xna.Framework.Graphics.Texture2D%2cMicrosoft.Xna.Framework.Rectangle%2cMLEM.Misc.AutoTiling.ConnectsTo%2cMicrosoft.Xna.Framework.Color%2cSystem.Single%2cSystem.Nullable%7bMicrosoft.Xna.Framework.Vector2%7d%2cSystem.Nullable%7bMicrosoft.Xna.Framework.Vector2%7d%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref> 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 <xref href=\"MLEM.Misc.AutoTiling.DrawAutoTile(Microsoft.Xna.Framework.Graphics.SpriteBatch%2cMicrosoft.Xna.Framework.Vector2%2cMicrosoft.Xna.Framework.Graphics.Texture2D%2cMicrosoft.Xna.Framework.Rectangle%2cMLEM.Misc.AutoTiling.ConnectsTo%2cMicrosoft.Xna.Framework.Color%2cSystem.Single%2cSystem.Nullable%7bMicrosoft.Xna.Framework.Vector2%7d%2cSystem.Nullable%7bMicrosoft.Xna.Framework.Vector2%7d%2cSystem.Single)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax: syntax:
content: public class AutoTiling content: public class AutoTiling
content.vb: Public Class AutoTiling content.vb: Public Class AutoTiling
@ -61,33 +63,45 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DrawAutoTile id: DrawAutoTile
path: ../MLEM/Misc/AutoTiling.cs path: ../MLEM/Misc/AutoTiling.cs
startLine: 6 startLine: 27
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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&apos;s textures.\nFor more information and an example, see <a href=\"https://github.com/Ellpeck/MLEM/blob/master/Demos/AutoTilingDemo.cs#L20-L28\">https://github.com/Ellpeck/MLEM/blob/master/Demos/AutoTilingDemo.cs#L20-L28</a>\n"
example: []
syntax: 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) 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: parameters:
- id: batch - id: batch
type: Microsoft.Xna.Framework.Graphics.SpriteBatch type: Microsoft.Xna.Framework.Graphics.SpriteBatch
description: ''
- id: pos - id: pos
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: ''
- id: texture - id: texture
type: Microsoft.Xna.Framework.Graphics.Texture2D type: Microsoft.Xna.Framework.Graphics.Texture2D
description: ''
- id: textureRegion - id: textureRegion
type: Microsoft.Xna.Framework.Rectangle type: Microsoft.Xna.Framework.Rectangle
description: ''
- id: connectsTo - id: connectsTo
type: MLEM.Misc.AutoTiling.ConnectsTo type: MLEM.Misc.AutoTiling.ConnectsTo
description: ''
- id: color - id: color
type: Microsoft.Xna.Framework.Color type: Microsoft.Xna.Framework.Color
description: ''
- id: rotation - id: rotation
type: System.Single type: System.Single
description: ''
- id: origin - id: origin
type: System.Nullable{Microsoft.Xna.Framework.Vector2} type: System.Nullable{Microsoft.Xna.Framework.Vector2}
description: ''
- id: scale - id: scale
type: System.Nullable{Microsoft.Xna.Framework.Vector2} type: System.Nullable{Microsoft.Xna.Framework.Vector2}
description: ''
- id: layerDepth - id: layerDepth
type: System.Single 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) 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* overload: MLEM.Misc.AutoTiling.DrawAutoTile*
nameWithType.vb: AutoTiling.DrawAutoTile(SpriteBatch, Vector2, Texture2D, Rectangle, AutoTiling.ConnectsTo, Color, Single, Nullable(Of Vector2), Nullable(Of Vector2), Single) 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) 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) name.vb: DrawAutoTile(SpriteBatch, Vector2, Texture2D, Rectangle, AutoTiling.ConnectsTo, Color, Single, Nullable(Of Vector2), Nullable(Of Vector2), Single)
references: 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 - uid: MLEM.Misc
commentId: N:MLEM.Misc commentId: N:MLEM.Misc
name: MLEM.Misc name: MLEM.Misc

View file

@ -28,10 +28,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Direction2 id: Direction2
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 7 startLine: 11
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nAn enum that represents two-dimensional directions.\nBoth straight and diagonal directions are supported.\n"
example: []
syntax: syntax:
content: public enum Direction2 content: public enum Direction2
content.vb: Public Enum Direction2 content.vb: Public Enum Direction2
@ -67,10 +69,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Up id: Up
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 9 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe up direction, or -y.\n"
example: []
syntax: syntax:
content: Up = 0 content: Up = 0
return: return:
@ -99,10 +103,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Right id: Right
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 10 startLine: 20
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe right direction, or +x.\n"
example: []
syntax: syntax:
content: Right = 1 content: Right = 1
return: return:
@ -131,10 +137,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Down id: Down
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 11 startLine: 24
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe down direction, or +y.\n"
example: []
syntax: syntax:
content: Down = 2 content: Down = 2
return: return:
@ -163,10 +171,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Left id: Left
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 12 startLine: 28
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe left direction, or -x.\n"
example: []
syntax: syntax:
content: Left = 3 content: Left = 3
return: return:
@ -195,10 +205,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: UpRight id: UpRight
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 14 startLine: 33
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe up and right direction, or +x, -y.\n"
example: []
syntax: syntax:
content: UpRight = 4 content: UpRight = 4
return: return:
@ -227,10 +239,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DownRight id: DownRight
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 15 startLine: 37
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe down and right direction, or +x, +y.\n"
example: []
syntax: syntax:
content: DownRight = 5 content: DownRight = 5
return: return:
@ -259,10 +273,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DownLeft id: DownLeft
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 16 startLine: 41
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe down and left direction, or -x, +y.\n"
example: []
syntax: syntax:
content: DownLeft = 6 content: DownLeft = 6
return: return:
@ -291,10 +307,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: UpLeft id: UpLeft
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 17 startLine: 45
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe up and left direction, or -x, -y.\n"
example: []
syntax: syntax:
content: UpLeft = 7 content: UpLeft = 7
return: return:
@ -323,10 +341,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: None id: None
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 19 startLine: 50
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nNo direction.\n"
example: []
syntax: syntax:
content: None = 8 content: None = 8
return: return:

View file

@ -31,10 +31,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Direction2Helper id: Direction2Helper
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 23 startLine: 57
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nA set of helper and extension methods for dealing with <xref href=\"MLEM.Misc.Direction2\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class Direction2Helper content: public static class Direction2Helper
content.vb: Public Module Direction2Helper content.vb: Public Module Direction2Helper
@ -73,10 +75,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: All id: All
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 25 startLine: 62
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nAll <xref href=\"MLEM.Misc.Direction2\" data-throw-if-not-resolved=\"false\"></xref> enum values\n"
example: []
syntax: syntax:
content: public static readonly Direction2[] All content: public static readonly Direction2[] All
return: return:
@ -108,10 +112,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Adjacent id: Adjacent
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 26 startLine: 66
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe <xref href=\"MLEM.Misc.Direction2.Up\" data-throw-if-not-resolved=\"false\"></xref> through <xref href=\"MLEM.Misc.Direction2.Left\" data-throw-if-not-resolved=\"false\"></xref> directions\n"
example: []
syntax: syntax:
content: public static readonly Direction2[] Adjacent content: public static readonly Direction2[] Adjacent
return: return:
@ -143,10 +149,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Diagonals id: Diagonals
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 27 startLine: 70
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe <xref href=\"MLEM.Misc.Direction2.UpRight\" data-throw-if-not-resolved=\"false\"></xref> through <xref href=\"MLEM.Misc.Direction2.UpLeft\" data-throw-if-not-resolved=\"false\"></xref> directions\n"
example: []
syntax: syntax:
content: public static readonly Direction2[] Diagonals content: public static readonly Direction2[] Diagonals
return: return:
@ -178,10 +186,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AllExceptNone id: AllExceptNone
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 28 startLine: 74
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nAll directions except <xref href=\"MLEM.Misc.Direction2.None\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static readonly Direction2[] AllExceptNone content: public static readonly Direction2[] AllExceptNone
return: return:
@ -214,17 +224,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: IsAdjacent id: IsAdjacent
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 30 startLine: 82
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nReturns if the given direction is considered an &quot;adjacent&quot; direction.\nAn adjacent direction is one that is not a diagonal.\n"
example: []
syntax: syntax:
content: public static bool IsAdjacent(this Direction2 dir) content: public static bool IsAdjacent(this Direction2 dir)
parameters: parameters:
- id: dir - id: dir
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The direction to query
return: return:
type: System.Boolean type: System.Boolean
description: Whether the direction is adjacent
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -255,17 +269,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: IsDiagonal id: IsDiagonal
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 34 startLine: 91
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nReturns if the given direction is considered a diagonal direction.\n"
example: []
syntax: syntax:
content: public static bool IsDiagonal(this Direction2 dir) content: public static bool IsDiagonal(this Direction2 dir)
parameters: parameters:
- id: dir - id: dir
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The direction to query
return: return:
type: System.Boolean type: System.Boolean
description: Whether the direction is diagonal
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -296,17 +314,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Offset id: Offset
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 38 startLine: 101
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: public static Point Offset(this Direction2 dir) content: public static Point Offset(this Direction2 dir)
parameters: parameters:
- id: dir - id: dir
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The direction whose offset to query
return: return:
type: Microsoft.Xna.Framework.Point type: Microsoft.Xna.Framework.Point
description: The direction&apos;s offset
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -337,17 +359,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Offsets id: Offsets
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 61 startLine: 129
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nMaps each direction in the given enumerable of directions to its <xref href=\"MLEM.Misc.Direction2Helper.Offset(MLEM.Misc.Direction2)\" data-throw-if-not-resolved=\"false\"></xref>.\n"
example: []
syntax: syntax:
content: public static IEnumerable<Point> Offsets(this IEnumerable<Direction2> directions) content: public static IEnumerable<Point> Offsets(this IEnumerable<Direction2> directions)
parameters: parameters:
- id: directions - id: directions
type: System.Collections.Generic.IEnumerable{MLEM.Misc.Direction2} type: System.Collections.Generic.IEnumerable{MLEM.Misc.Direction2}
description: The direction enumerable
return: return:
type: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Point} type: System.Collections.Generic.IEnumerable{Microsoft.Xna.Framework.Point}
description: The directions&apos; offsets, in the same order as the input directions.
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -381,17 +407,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Opposite id: Opposite
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 66 startLine: 141
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nReturns the opposite of the given direction.\nFor &quot;adjacent&quot; 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: syntax:
content: public static Direction2 Opposite(this Direction2 dir) content: public static Direction2 Opposite(this Direction2 dir)
parameters: parameters:
- id: dir - id: dir
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The direction whose opposite to get
return: return:
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The opposite of the direction
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -422,17 +452,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Angle id: Angle
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 89 startLine: 169
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nReturns the angle of the direction in radians, where <xref href=\"MLEM.Misc.Direction2.Right\" data-throw-if-not-resolved=\"false\"></xref> has an angle of 0.\n"
example: []
syntax: syntax:
content: public static float Angle(this Direction2 dir) content: public static float Angle(this Direction2 dir)
parameters: parameters:
- id: dir - id: dir
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The direction whose angle to get
return: return:
type: System.Single type: System.Single
description: The direction&apos;s angle
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -463,19 +497,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RotateCw id: RotateCw
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 94 startLine: 180
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nRotates the given direction clockwise and returns the resulting direction.\n"
example: []
syntax: syntax:
content: public static Direction2 RotateCw(this Direction2 dir, bool fortyFiveDegrees = false) content: public static Direction2 RotateCw(this Direction2 dir, bool fortyFiveDegrees = false)
parameters: parameters:
- id: dir - id: dir
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The direction to rotate
- id: fortyFiveDegrees - id: fortyFiveDegrees
type: System.Boolean type: System.Boolean
description: Whether to rotate by 45 degrees. If this is false, the rotation is 90 degrees instead.
return: return:
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The rotated direction
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -506,19 +545,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RotateCcw id: RotateCcw
path: ../MLEM/Misc/Direction2.cs path: ../MLEM/Misc/Direction2.cs
startLine: 117 startLine: 209
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nRotates the given direction counter-clockwise and returns the resulting direction.\n"
example: []
syntax: syntax:
content: public static Direction2 RotateCcw(this Direction2 dir, bool fortyFiveDegrees = false) content: public static Direction2 RotateCcw(this Direction2 dir, bool fortyFiveDegrees = false)
parameters: parameters:
- id: dir - id: dir
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The direction to rotate counter-clockwise
- id: fortyFiveDegrees - id: fortyFiveDegrees
type: System.Boolean type: System.Boolean
description: Whether to rotate by 45 degrees. If this is false, the rotation is 90 degrees instead.
return: return:
type: MLEM.Misc.Direction2 type: MLEM.Misc.Direction2
description: The rotated direction
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -531,6 +575,12 @@ items:
- Public - Public
- Shared - Shared
references: references:
- uid: MLEM.Misc.Direction2
commentId: T:MLEM.Misc.Direction2
parent: MLEM.Misc
name: Direction2
nameWithType: Direction2
fullName: MLEM.Misc.Direction2
- uid: MLEM.Misc - uid: MLEM.Misc
commentId: N:MLEM.Misc commentId: N:MLEM.Misc
name: MLEM.Misc name: MLEM.Misc
@ -852,17 +902,26 @@ references:
- name: () - name: ()
nameWithType: () nameWithType: ()
fullName: () 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* - uid: MLEM.Misc.Direction2Helper.IsAdjacent*
commentId: Overload:MLEM.Misc.Direction2Helper.IsAdjacent commentId: Overload:MLEM.Misc.Direction2Helper.IsAdjacent
name: IsAdjacent name: IsAdjacent
nameWithType: Direction2Helper.IsAdjacent nameWithType: Direction2Helper.IsAdjacent
fullName: MLEM.Misc.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 - uid: System.Boolean
commentId: T:System.Boolean commentId: T:System.Boolean
parent: System parent: System
@ -893,6 +952,41 @@ references:
name: Microsoft.Xna.Framework name: Microsoft.Xna.Framework
nameWithType: Microsoft.Xna.Framework nameWithType: Microsoft.Xna.Framework
fullName: 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* - uid: MLEM.Misc.Direction2Helper.Offsets*
commentId: Overload:MLEM.Misc.Direction2Helper.Offsets commentId: Overload:MLEM.Misc.Direction2Helper.Offsets
name: Offsets name: Offsets
@ -1034,6 +1128,9 @@ references:
name: Opposite name: Opposite
nameWithType: Direction2Helper.Opposite nameWithType: Direction2Helper.Opposite
fullName: MLEM.Misc.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* - uid: MLEM.Misc.Direction2Helper.Angle*
commentId: Overload:MLEM.Misc.Direction2Helper.Angle commentId: Overload:MLEM.Misc.Direction2Helper.Angle
name: Angle name: Angle

View file

@ -22,10 +22,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: EnumHelper id: EnumHelper
path: ../MLEM/Misc/EnumHelper.cs path: ../MLEM/Misc/EnumHelper.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nA helper class that allows easier usage of <xref href=\"System.Enum\" data-throw-if-not-resolved=\"false\"></xref> values.\n"
example: []
syntax: syntax:
content: public static class EnumHelper content: public static class EnumHelper
content.vb: Public Module EnumHelper content.vb: Public Module EnumHelper
@ -64,10 +66,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Buttons id: Buttons
path: ../MLEM/Misc/EnumHelper.cs path: ../MLEM/Misc/EnumHelper.cs
startLine: 8 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nAll values of the <xref href=\"MLEM.Misc.EnumHelper.Buttons\" data-throw-if-not-resolved=\"false\"></xref> enum.\n"
example: []
syntax: syntax:
content: public static readonly Buttons[] Buttons content: public static readonly Buttons[] Buttons
return: return:
@ -99,10 +103,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Keys id: Keys
path: ../MLEM/Misc/EnumHelper.cs path: ../MLEM/Misc/EnumHelper.cs
startLine: 9 startLine: 18
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nAll values of the <xref href=\"MLEM.Misc.EnumHelper.Keys\" data-throw-if-not-resolved=\"false\"></xref> enum.\n"
example: []
syntax: syntax:
content: public static readonly Keys[] Keys content: public static readonly Keys[] Keys
return: return:
@ -134,16 +140,20 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetValues id: GetValues
path: ../MLEM/Misc/EnumHelper.cs path: ../MLEM/Misc/EnumHelper.cs
startLine: 11 startLine: 25
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nReturns all of the values of the given enum type.\n"
example: []
syntax: syntax:
content: public static IEnumerable<T> GetValues<T>() content: public static IEnumerable<T> GetValues<T>()
typeParameters: typeParameters:
- id: T - id: T
description: The type whose enum to get
return: return:
type: System.Collections.Generic.IEnumerable{{T}} 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) content.vb: Public Shared Function GetValues(Of T) As IEnumerable(Of T)
overload: MLEM.Misc.EnumHelper.GetValues* overload: MLEM.Misc.EnumHelper.GetValues*
nameWithType.vb: EnumHelper.GetValues(Of T)() nameWithType.vb: EnumHelper.GetValues(Of T)()
@ -156,6 +166,9 @@ items:
fullName.vb: MLEM.Misc.EnumHelper.GetValues(Of T)() fullName.vb: MLEM.Misc.EnumHelper.GetValues(Of T)()
name.vb: GetValues(Of T)() name.vb: GetValues(Of T)()
references: references:
- uid: System.Enum
commentId: T:System.Enum
isExternal: true
- uid: MLEM.Misc - uid: MLEM.Misc
commentId: N:MLEM.Misc commentId: N:MLEM.Misc
name: MLEM.Misc name: MLEM.Misc
@ -453,6 +466,9 @@ references:
name: System name: System
nameWithType: System nameWithType: System
fullName: System fullName: System
- uid: MLEM.Misc.EnumHelper.Buttons
commentId: F:MLEM.Misc.EnumHelper.Buttons
isExternal: true
- uid: Microsoft.Xna.Framework.Input.Buttons[] - uid: Microsoft.Xna.Framework.Input.Buttons[]
isExternal: true isExternal: true
name: Buttons[] name: Buttons[]
@ -479,6 +495,9 @@ references:
- name: () - name: ()
nameWithType: () nameWithType: ()
fullName: () fullName: ()
- uid: MLEM.Misc.EnumHelper.Keys
commentId: F:MLEM.Misc.EnumHelper.Keys
isExternal: true
- uid: Microsoft.Xna.Framework.Input.Keys[] - uid: Microsoft.Xna.Framework.Input.Keys[]
isExternal: true isExternal: true
name: Keys[] name: Keys[]

View file

@ -22,10 +22,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GenericDataHolder id: GenericDataHolder
path: ../MLEM/Misc/GenericDataHolder.cs path: ../MLEM/Misc/GenericDataHolder.cs
startLine: 4 startLine: 8
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: public class GenericDataHolder content: public class GenericDataHolder
content.vb: Public Class GenericDataHolder content.vb: Public Class GenericDataHolder
@ -79,17 +81,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: SetData id: SetData
path: ../MLEM/Misc/GenericDataHolder.cs path: ../MLEM/Misc/GenericDataHolder.cs
startLine: 8 startLine: 17
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nStore a piece of generic data on this object.\n"
example: []
syntax: syntax:
content: public void SetData(string key, object data) content: public void SetData(string key, object data)
parameters: parameters:
- id: key - id: key
type: System.String type: System.String
description: The key to store the data by
- id: data - id: data
type: System.Object type: System.Object
description: The data to store in the object
content.vb: Public Sub SetData(key As String, data As Object) content.vb: Public Sub SetData(key As String, data As Object)
overload: MLEM.Misc.GenericDataHolder.SetData* overload: MLEM.Misc.GenericDataHolder.SetData*
modifiers.csharp: modifiers.csharp:
@ -114,19 +120,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetData id: GetData
path: ../MLEM/Misc/GenericDataHolder.cs path: ../MLEM/Misc/GenericDataHolder.cs
startLine: 19 startLine: 34
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nReturns a piece of generic data of the given type on this object.\n"
example: []
syntax: syntax:
content: public T GetData<T>(string key) content: public T GetData<T>(string key)
parameters: parameters:
- id: key - id: key
type: System.String type: System.String
description: The key that the data is stored by
typeParameters: typeParameters:
- id: T - id: T
description: The type of the data stored
return: return:
type: '{T}' type: '{T}'
description: The data, or default if it doesn&apos;t exist
content.vb: Public Function GetData(Of T)(key As String) As T content.vb: Public Function GetData(Of T)(key As String) As T
overload: MLEM.Misc.GenericDataHolder.GetData* overload: MLEM.Misc.GenericDataHolder.GetData*
nameWithType.vb: GenericDataHolder.GetData(Of T)(String) nameWithType.vb: GenericDataHolder.GetData(Of T)(String)
@ -154,14 +165,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetDataKeys id: GetDataKeys
path: ../MLEM/Misc/GenericDataHolder.cs path: ../MLEM/Misc/GenericDataHolder.cs
startLine: 25 startLine: 44
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nReturns all of the generic data that this object stores.\n"
example: []
syntax: syntax:
content: public IReadOnlyCollection<string> GetDataKeys() content: public IReadOnlyCollection<string> GetDataKeys()
return: return:
type: System.Collections.Generic.IReadOnlyCollection{System.String} type: System.Collections.Generic.IReadOnlyCollection{System.String}
description: The generic data on this object
content.vb: Public Function GetDataKeys As IReadOnlyCollection(Of String) content.vb: Public Function GetDataKeys As IReadOnlyCollection(Of String)
overload: MLEM.Misc.GenericDataHolder.GetDataKeys* overload: MLEM.Misc.GenericDataHolder.GetDataKeys*
modifiers.csharp: modifiers.csharp:

View file

@ -35,10 +35,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Padding id: Padding
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 3 startLine: 7
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: public struct Padding content: public struct Padding
content.vb: Public Structure Padding content.vb: Public Structure Padding
@ -71,10 +73,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Left id: Left
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 5 startLine: 12
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe amount of padding on the left side\n"
example: []
syntax: syntax:
content: public float Left content: public float Left
return: return:
@ -102,10 +106,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Right id: Right
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 6 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe amount of padding on the right side\n"
example: []
syntax: syntax:
content: public float Right content: public float Right
return: return:
@ -133,10 +139,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Top id: Top
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 7 startLine: 20
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe amount of padding on the top side\n"
example: []
syntax: syntax:
content: public float Top content: public float Top
return: return:
@ -164,10 +172,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Bottom id: Bottom
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 8 startLine: 24
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe amount of padding on the bottom side\n"
example: []
syntax: syntax:
content: public float Bottom content: public float Bottom
return: return:
@ -195,10 +205,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Width id: Width
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 9 startLine: 28
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe total width of this padding, a sum of the left and right padding.\n"
example: []
syntax: syntax:
content: public float Width { get; } content: public float Width { get; }
parameters: [] parameters: []
@ -230,10 +242,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Height id: Height
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 10 startLine: 32
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe total height of this padding, a sum of the top and bottom padding.\n"
example: []
syntax: syntax:
content: public float Height { get; } content: public float Height { get; }
parameters: [] parameters: []
@ -265,21 +279,27 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 12 startLine: 41
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nCreate a new padding with the specified borders.\n"
example: []
syntax: syntax:
content: public Padding(float left, float right, float top, float bottom) content: public Padding(float left, float right, float top, float bottom)
parameters: parameters:
- id: left - id: left
type: System.Single type: System.Single
description: The amount of padding on the left side
- id: right - id: right
type: System.Single type: System.Single
description: The amount of padding on the right side
- id: top - id: top
type: System.Single type: System.Single
description: The amount of padding on the top side
- id: bottom - id: bottom
type: System.Single 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) content.vb: Public Sub New(left As Single, right As Single, top As Single, bottom As Single)
overload: MLEM.Misc.Padding.#ctor* overload: MLEM.Misc.Padding.#ctor*
modifiers.csharp: modifiers.csharp:
@ -304,17 +324,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Implicit id: op_Implicit
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 19 startLine: 54
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nImplicitly creates a padding from the given two-dimensional vector.\nThe left and right padding will both be the vector&apos;s x value, and the top and bottom padding will both be the vector&apos;s y value.\n"
example: []
syntax: syntax:
content: public static implicit operator Padding(Vector2 vec) content: public static implicit operator Padding(Vector2 vec)
parameters: parameters:
- id: vec - id: vec
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The vector to convert
return: return:
type: MLEM.Misc.Padding type: MLEM.Misc.Padding
description: A padding based on the vector&apos;s values
content.vb: Public Shared Widening Operator CType(vec As Vector2) As Padding content.vb: Public Shared Widening Operator CType(vec As Vector2) As Padding
overload: MLEM.Misc.Padding.op_Implicit* overload: MLEM.Misc.Padding.op_Implicit*
nameWithType.vb: Padding.Widening(Vector2 to Padding) nameWithType.vb: Padding.Widening(Vector2 to Padding)
@ -344,10 +368,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Multiply id: op_Multiply
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 23 startLine: 61
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nScales a padding by a scalar.\n"
example: []
syntax: syntax:
content: public static Padding operator *(Padding p, float scale) content: public static Padding operator *(Padding p, float scale)
parameters: parameters:
@ -383,10 +409,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Addition id: op_Addition
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 27 startLine: 68
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nAdds two paddings together in a memberwise fashion.\n"
example: []
syntax: syntax:
content: public static Padding operator +(Padding left, Padding right) content: public static Padding operator +(Padding left, Padding right)
parameters: parameters:
@ -422,10 +450,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Subtraction id: op_Subtraction
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 31 startLine: 75
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nSubtracts two paddings in a memberwise fashion.\n"
example: []
syntax: syntax:
content: public static Padding operator -(Padding left, Padding right) content: public static Padding operator -(Padding left, Padding right)
parameters: parameters:
@ -461,10 +491,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Equality id: op_Equality
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 35 startLine: 80
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public static bool operator ==(Padding left, Padding right) content: public static bool operator ==(Padding left, Padding right)
parameters: parameters:
@ -500,10 +531,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Inequality id: op_Inequality
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 39 startLine: 85
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public static bool operator !=(Padding left, Padding right) content: public static bool operator !=(Padding left, Padding right)
parameters: parameters:
@ -539,10 +571,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 43 startLine: 90
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public bool Equals(Padding other) content: public bool Equals(Padding other)
parameters: parameters:
@ -574,10 +607,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 47 startLine: 95
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override bool Equals(object obj) content: public override bool Equals(object obj)
parameters: parameters:
@ -612,10 +646,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetHashCode id: GetHashCode
path: ../MLEM/Misc/Padding.cs path: ../MLEM/Misc/Padding.cs
startLine: 51 startLine: 100
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override int GetHashCode() content: public override int GetHashCode()
return: return:
@ -895,6 +930,9 @@ references:
name: Subtraction name: Subtraction
nameWithType: Padding.Subtraction nameWithType: Padding.Subtraction
fullName: MLEM.Misc.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* - uid: MLEM.Misc.Padding.op_Equality*
commentId: Overload:MLEM.Misc.Padding.op_Equality commentId: Overload:MLEM.Misc.Padding.op_Equality
name: Equality name: Equality
@ -912,6 +950,9 @@ references:
name: Inequality name: Inequality
nameWithType: Padding.Inequality nameWithType: Padding.Inequality
fullName: MLEM.Misc.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* - uid: MLEM.Misc.Padding.Equals*
commentId: Overload:MLEM.Misc.Padding.Equals commentId: Overload:MLEM.Misc.Padding.Equals
name: Equals name: Equals

View file

@ -53,10 +53,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RectangleF id: RectangleF
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nRepresents a float-based version of <xref href=\"Microsoft.Xna.Framework.Rectangle\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: >- content: >-
[DataContract] [DataContract]
@ -66,6 +68,7 @@ items:
<DataContract> <DataContract>
Public Structure RectangleF Public Structure RectangleF
Implements IEquatable(Of RectangleF) Implements IEquatable(Of RectangleF)
implements: implements:
- System.IEquatable{MLEM.Misc.RectangleF} - System.IEquatable{MLEM.Misc.RectangleF}
@ -106,10 +109,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Empty id: Empty
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 9 startLine: 15
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe empty rectangle, with an x, y, width and height of 0.\n"
example: []
syntax: syntax:
content: public static RectangleF Empty { get; } content: public static RectangleF Empty { get; }
parameters: [] parameters: []
@ -143,10 +148,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: X id: X
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 12 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe x position of the top left corner of this rectangle.\n"
example: []
syntax: syntax:
content: >- content: >-
[DataMember] [DataMember]
@ -184,10 +191,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Y id: Y
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 14 startLine: 26
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe y position of the top left corner of this rectangle.\n"
example: []
syntax: syntax:
content: >- content: >-
[DataMember] [DataMember]
@ -225,10 +234,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Width id: Width
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 16 startLine: 31
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe width of this rectangle.\n"
example: []
syntax: syntax:
content: >- content: >-
[DataMember] [DataMember]
@ -266,10 +277,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Height id: Height
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 18 startLine: 36
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe height of this rectangle.\n"
example: []
syntax: syntax:
content: >- content: >-
[DataMember] [DataMember]
@ -307,10 +320,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Left id: Left
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 20 startLine: 39
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public float Left { get; } content: public float Left { get; }
parameters: [] parameters: []
@ -342,10 +356,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Right id: Right
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 21 startLine: 43
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe x position of the bottom right corner of this rectangle.\n"
example: []
syntax: syntax:
content: public float Right { get; } content: public float Right { get; }
parameters: [] parameters: []
@ -377,10 +393,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Top id: Top
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 22 startLine: 45
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public float Top { get; } content: public float Top { get; }
parameters: [] parameters: []
@ -412,10 +429,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Bottom id: Bottom
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 23 startLine: 49
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe y position of the bottom right corner of this rectangle.\n"
example: []
syntax: syntax:
content: public float Bottom { get; } content: public float Bottom { get; }
parameters: [] parameters: []
@ -447,10 +466,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: IsEmpty id: IsEmpty
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 24 startLine: 54
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: public bool IsEmpty { get; } content: public bool IsEmpty { get; }
parameters: [] parameters: []
@ -482,10 +503,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Location id: Location
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 26 startLine: 59
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe top left corner of this rectangle\n"
example: []
syntax: syntax:
content: public Vector2 Location { get; set; } content: public Vector2 Location { get; set; }
parameters: [] parameters: []
@ -517,10 +540,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Size id: Size
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 33 startLine: 69
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe size, that is, the width and height of this rectangle.\n"
example: []
syntax: syntax:
content: public Vector2 Size { get; set; } content: public Vector2 Size { get; set; }
parameters: [] parameters: []
@ -552,10 +577,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Center id: Center
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 40 startLine: 79
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nThe center of this rectangle, based on the top left corner and the size.\n"
example: []
syntax: syntax:
content: public Vector2 Center { get; } content: public Vector2 Center { get; }
parameters: [] parameters: []
@ -587,21 +614,27 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 42 startLine: 88
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nCreates a new rectangle with the specified location and size\n"
example: []
syntax: syntax:
content: public RectangleF(float x, float y, float width, float height) content: public RectangleF(float x, float y, float width, float height)
parameters: parameters:
- id: x - id: x
type: System.Single type: System.Single
description: The x coordinate of the top left corner of the rectangle
- id: y - id: y
type: System.Single type: System.Single
description: The y coordinate of the top left corner of the rectangle
- id: width - id: width
type: System.Single type: System.Single
description: The width of the rectangle
- id: height - id: height
type: System.Single 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) content.vb: Public Sub New(x As Single, y As Single, width As Single, height As Single)
overload: MLEM.Misc.RectangleF.#ctor* overload: MLEM.Misc.RectangleF.#ctor*
modifiers.csharp: modifiers.csharp:
@ -626,17 +659,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 49 startLine: 100
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nCreates a new rectangle with the specified location and size vectors\n"
example: []
syntax: syntax:
content: public RectangleF(Vector2 location, Vector2 size) content: public RectangleF(Vector2 location, Vector2 size)
parameters: parameters:
- id: location - id: location
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The top left corner of the rectangle
- id: size - id: size
type: Microsoft.Xna.Framework.Vector2 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) content.vb: Public Sub New(location As Vector2, size As Vector2)
overload: MLEM.Misc.RectangleF.#ctor* overload: MLEM.Misc.RectangleF.#ctor*
modifiers.csharp: modifiers.csharp:
@ -661,19 +698,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: FromCorners id: FromCorners
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 56 startLine: 114
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: public static RectangleF FromCorners(Vector2 corner1, Vector2 corner2) content: public static RectangleF FromCorners(Vector2 corner1, Vector2 corner2)
parameters: parameters:
- id: corner1 - id: corner1
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The first corner to use
- id: corner2 - id: corner2
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The second corner to use
return: return:
type: MLEM.Misc.RectangleF type: MLEM.Misc.RectangleF
description: ''
content.vb: Public Shared Function FromCorners(corner1 As Vector2, corner2 As Vector2) As RectangleF content.vb: Public Shared Function FromCorners(corner1 As Vector2, corner2 As Vector2) As RectangleF
overload: MLEM.Misc.RectangleF.FromCorners* overload: MLEM.Misc.RectangleF.FromCorners*
modifiers.csharp: modifiers.csharp:
@ -700,17 +742,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Explicit id: op_Explicit
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 64 startLine: 127
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nConverts a float-based rectangle to an int-based rectangle, flooring each value in the process.\n"
example: []
syntax: syntax:
content: public static explicit operator Rectangle(RectangleF rect) content: public static explicit operator Rectangle(RectangleF rect)
parameters: parameters:
- id: rect - id: rect
type: MLEM.Misc.RectangleF type: MLEM.Misc.RectangleF
description: The rectangle to convert
return: return:
type: Microsoft.Xna.Framework.Rectangle type: Microsoft.Xna.Framework.Rectangle
description: The resulting rectangle
content.vb: Public Shared Narrowing Operator CType(rect As RectangleF) As Rectangle content.vb: Public Shared Narrowing Operator CType(rect As RectangleF) As Rectangle
overload: MLEM.Misc.RectangleF.op_Explicit* overload: MLEM.Misc.RectangleF.op_Explicit*
nameWithType.vb: RectangleF.Narrowing(RectangleF to Rectangle) nameWithType.vb: RectangleF.Narrowing(RectangleF to Rectangle)
@ -740,17 +786,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Explicit id: op_Explicit
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 68 startLine: 136
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nConverts an int-based rectangle to a float-based rectangle.\n"
example: []
syntax: syntax:
content: public static explicit operator RectangleF(Rectangle rect) content: public static explicit operator RectangleF(Rectangle rect)
parameters: parameters:
- id: rect - id: rect
type: Microsoft.Xna.Framework.Rectangle type: Microsoft.Xna.Framework.Rectangle
description: The rectangle to convert
return: return:
type: MLEM.Misc.RectangleF type: MLEM.Misc.RectangleF
description: The resulting rectangle
content.vb: Public Shared Narrowing Operator CType(rect As Rectangle) As RectangleF content.vb: Public Shared Narrowing Operator CType(rect As Rectangle) As RectangleF
overload: MLEM.Misc.RectangleF.op_Explicit* overload: MLEM.Misc.RectangleF.op_Explicit*
nameWithType.vb: RectangleF.Narrowing(Rectangle to RectangleF) nameWithType.vb: RectangleF.Narrowing(Rectangle to RectangleF)
@ -780,10 +830,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Equality id: op_Equality
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 72 startLine: 141
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public static bool operator ==(RectangleF a, RectangleF b) content: public static bool operator ==(RectangleF a, RectangleF b)
parameters: parameters:
@ -819,10 +870,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: op_Inequality id: op_Inequality
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 76 startLine: 146
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public static bool operator !=(RectangleF a, RectangleF b) content: public static bool operator !=(RectangleF a, RectangleF b)
parameters: parameters:
@ -858,10 +910,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Contains id: Contains
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 80 startLine: 151
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public bool Contains(float x, float y) content: public bool Contains(float x, float y)
parameters: parameters:
@ -895,10 +948,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Contains id: Contains
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 84 startLine: 156
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public bool Contains(Vector2 value) content: public bool Contains(Vector2 value)
parameters: parameters:
@ -930,10 +984,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Contains id: Contains
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 88 startLine: 161
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public bool Contains(RectangleF value) content: public bool Contains(RectangleF value)
parameters: parameters:
@ -965,10 +1020,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 92 startLine: 166
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override bool Equals(object obj) content: public override bool Equals(object obj)
parameters: parameters:
@ -1003,10 +1059,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 96 startLine: 171
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public bool Equals(RectangleF other) content: public bool Equals(RectangleF other)
parameters: parameters:
@ -1040,10 +1097,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetHashCode id: GetHashCode
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 100 startLine: 176
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override int GetHashCode() content: public override int GetHashCode()
return: return:
@ -1075,10 +1133,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Inflate id: Inflate
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 104 startLine: 181
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public void Inflate(float horizontalAmount, float verticalAmount) content: public void Inflate(float horizontalAmount, float verticalAmount)
parameters: parameters:
@ -1110,10 +1169,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Intersects id: Intersects
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 111 startLine: 189
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public bool Intersects(RectangleF value) content: public bool Intersects(RectangleF value)
parameters: parameters:
@ -1145,10 +1205,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Intersect id: Intersect
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 115 startLine: 194
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public static RectangleF Intersect(RectangleF value1, RectangleF value2) content: public static RectangleF Intersect(RectangleF value1, RectangleF value2)
parameters: parameters:
@ -1184,10 +1245,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Offset id: Offset
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 127 startLine: 207
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public void Offset(float offsetX, float offsetY) content: public void Offset(float offsetX, float offsetY)
parameters: parameters:
@ -1219,10 +1281,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Offset id: Offset
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 132 startLine: 213
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public void Offset(Vector2 amount) content: public void Offset(Vector2 amount)
parameters: parameters:
@ -1252,10 +1315,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: ToString id: ToString
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 137 startLine: 219
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override string ToString() content: public override string ToString()
return: return:
@ -1287,10 +1351,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Union id: Union
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 141 startLine: 224
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public static RectangleF Union(RectangleF value1, RectangleF value2) content: public static RectangleF Union(RectangleF value1, RectangleF value2)
parameters: parameters:
@ -1326,10 +1391,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Deconstruct id: Deconstruct
path: ../MLEM/Misc/RectangleF.cs path: ../MLEM/Misc/RectangleF.cs
startLine: 147 startLine: 231
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public void Deconstruct(out float x, out float y, out float width, out float height) content: public void Deconstruct(out float x, out float y, out float width, out float height)
parameters: parameters:
@ -1351,6 +1417,13 @@ items:
fullName.vb: MLEM.Misc.RectangleF.Deconstruct(ByRef System.Single, ByRef System.Single, ByRef System.Single, ByRef System.Single) 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) name.vb: Deconstruct(ByRef Single, ByRef Single, ByRef Single, ByRef Single)
references: 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 - uid: MLEM.Misc
commentId: N:MLEM.Misc commentId: N:MLEM.Misc
name: MLEM.Misc name: MLEM.Misc
@ -1687,6 +1760,12 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System.IEquatable`1
commentId: T:System.IEquatable`1 commentId: T:System.IEquatable`1
isExternal: true isExternal: true
@ -1967,6 +2046,9 @@ references:
name: Single name: Single
nameWithType: Single nameWithType: Single
fullName: System.Single fullName: System.Single
- uid: MLEM.Misc.RectangleF.X
commentId: F:MLEM.Misc.RectangleF.X
isExternal: true
- uid: MLEM.Misc.RectangleF.Left* - uid: MLEM.Misc.RectangleF.Left*
commentId: Overload:MLEM.Misc.RectangleF.Left commentId: Overload:MLEM.Misc.RectangleF.Left
name: Left name: Left
@ -1977,6 +2059,9 @@ references:
name: Right name: Right
nameWithType: RectangleF.Right nameWithType: RectangleF.Right
fullName: MLEM.Misc.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* - uid: MLEM.Misc.RectangleF.Top*
commentId: Overload:MLEM.Misc.RectangleF.Top commentId: Overload:MLEM.Misc.RectangleF.Top
name: Top name: Top
@ -2011,12 +2096,6 @@ references:
name: Vector2 name: Vector2
nameWithType: Vector2 nameWithType: Vector2
fullName: Microsoft.Xna.Framework.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* - uid: MLEM.Misc.RectangleF.Size*
commentId: Overload:MLEM.Misc.RectangleF.Size commentId: Overload:MLEM.Misc.RectangleF.Size
name: Size name: Size
@ -2045,13 +2124,9 @@ references:
nameWithType.vb: RectangleF.Narrowing nameWithType.vb: RectangleF.Narrowing
fullName.vb: MLEM.Misc.RectangleF.Narrowing fullName.vb: MLEM.Misc.RectangleF.Narrowing
name.vb: Narrowing name.vb: Narrowing
- uid: Microsoft.Xna.Framework.Rectangle - uid: MLEM.Misc.RectangleF.Equals(MLEM.Misc.RectangleF)
commentId: T:Microsoft.Xna.Framework.Rectangle commentId: M:MLEM.Misc.RectangleF.Equals(MLEM.Misc.RectangleF)
parent: Microsoft.Xna.Framework
isExternal: true isExternal: true
name: Rectangle
nameWithType: Rectangle
fullName: Microsoft.Xna.Framework.Rectangle
- uid: MLEM.Misc.RectangleF.op_Equality* - uid: MLEM.Misc.RectangleF.op_Equality*
commentId: Overload:MLEM.Misc.RectangleF.op_Equality commentId: Overload:MLEM.Misc.RectangleF.op_Equality
name: Equality name: Equality
@ -2062,11 +2137,20 @@ references:
name: Inequality name: Inequality
nameWithType: RectangleF.Inequality nameWithType: RectangleF.Inequality
fullName: MLEM.Misc.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* - uid: MLEM.Misc.RectangleF.Contains*
commentId: Overload:MLEM.Misc.RectangleF.Contains commentId: Overload:MLEM.Misc.RectangleF.Contains
name: Contains name: Contains
nameWithType: RectangleF.Contains nameWithType: RectangleF.Contains
fullName: MLEM.Misc.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) - uid: System.ValueType.Equals(System.Object)
commentId: M:System.ValueType.Equals(System.Object) commentId: M:System.ValueType.Equals(System.Object)
parent: System.ValueType parent: System.ValueType
@ -2242,26 +2326,41 @@ references:
name: Int32 name: Int32
nameWithType: Int32 nameWithType: Int32
fullName: System.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* - uid: MLEM.Misc.RectangleF.Inflate*
commentId: Overload:MLEM.Misc.RectangleF.Inflate commentId: Overload:MLEM.Misc.RectangleF.Inflate
name: Inflate name: Inflate
nameWithType: RectangleF.Inflate nameWithType: RectangleF.Inflate
fullName: MLEM.Misc.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* - uid: MLEM.Misc.RectangleF.Intersects*
commentId: Overload:MLEM.Misc.RectangleF.Intersects commentId: Overload:MLEM.Misc.RectangleF.Intersects
name: Intersects name: Intersects
nameWithType: RectangleF.Intersects nameWithType: RectangleF.Intersects
fullName: MLEM.Misc.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* - uid: MLEM.Misc.RectangleF.Intersect*
commentId: Overload:MLEM.Misc.RectangleF.Intersect commentId: Overload:MLEM.Misc.RectangleF.Intersect
name: Intersect name: Intersect
nameWithType: RectangleF.Intersect nameWithType: RectangleF.Intersect
fullName: MLEM.Misc.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* - uid: MLEM.Misc.RectangleF.Offset*
commentId: Overload:MLEM.Misc.RectangleF.Offset commentId: Overload:MLEM.Misc.RectangleF.Offset
name: Offset name: Offset
nameWithType: RectangleF.Offset nameWithType: RectangleF.Offset
fullName: MLEM.Misc.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 - uid: System.ValueType.ToString
commentId: M:System.ValueType.ToString commentId: M:System.ValueType.ToString
parent: System.ValueType parent: System.ValueType
@ -2305,11 +2404,17 @@ references:
name: String name: String
nameWithType: String nameWithType: String
fullName: System.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* - uid: MLEM.Misc.RectangleF.Union*
commentId: Overload:MLEM.Misc.RectangleF.Union commentId: Overload:MLEM.Misc.RectangleF.Union
name: Union name: Union
nameWithType: RectangleF.Union nameWithType: RectangleF.Union
fullName: MLEM.Misc.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* - uid: MLEM.Misc.RectangleF.Deconstruct*
commentId: Overload:MLEM.Misc.RectangleF.Deconstruct commentId: Overload:MLEM.Misc.RectangleF.Deconstruct
name: Deconstruct name: Deconstruct

View file

@ -22,16 +22,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DesktopGl id: DesktopGl
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 26 startLine: 63
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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<pre><code>new TextInputWrapper.DesktopGl{TextInputEventArgs}((w, c) => w.TextInput += c);</code></pre>\n"
syntax: syntax:
content: 'public class DesktopGl<T> : TextInputWrapper' content: 'public class DesktopGl<T> : TextInputWrapper'
typeParameters: typeParameters:
- id: T - id: T
description: ''
content.vb: >- content.vb: >-
Public Class DesktopGl(Of T) Public Class DesktopGl(Of T)
Inherits TextInputWrapper Inherits TextInputWrapper
inheritance: inheritance:
- System.Object - System.Object
@ -72,15 +77,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 32 startLine: 73
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nCreates a new DesktopGL-based text input wrapper\n"
example: []
syntax: syntax:
content: public DesktopGl(Action<GameWindow, EventHandler<T>> addListener) content: public DesktopGl(Action<GameWindow, EventHandler<T>> addListener)
parameters: parameters:
- id: addListener - id: addListener
type: System.Action{Microsoft.Xna.Framework.GameWindow,System.EventHandler{{T}}} 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))) content.vb: Public Sub New(addListener As Action(Of GameWindow, EventHandler(Of T)))
overload: MLEM.Misc.TextInputWrapper.DesktopGl`1.#ctor* overload: MLEM.Misc.TextInputWrapper.DesktopGl`1.#ctor*
nameWithType.vb: TextInputWrapper.DesktopGl(Of T).DesktopGl(Action(Of GameWindow, EventHandler(Of T))) nameWithType.vb: TextInputWrapper.DesktopGl(Of T).DesktopGl(Action(Of GameWindow, EventHandler(Of T)))
@ -108,10 +116,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RequiresOnScreenKeyboard id: RequiresOnScreenKeyboard
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 36 startLine: 78
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override bool RequiresOnScreenKeyboard() content: public override bool RequiresOnScreenKeyboard()
return: return:
@ -145,10 +154,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddListener id: AddListener
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 40 startLine: 83
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback)
parameters: parameters:

View file

@ -21,14 +21,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Mobile id: Mobile
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 71 startLine: 118
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: 'public class Mobile : TextInputWrapper' content: 'public class Mobile : TextInputWrapper'
content.vb: >- content.vb: >-
Public Class Mobile Public Class Mobile
Inherits TextInputWrapper Inherits TextInputWrapper
inheritance: inheritance:
- System.Object - System.Object
@ -66,10 +69,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RequiresOnScreenKeyboard id: RequiresOnScreenKeyboard
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 73 startLine: 121
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override bool RequiresOnScreenKeyboard() content: public override bool RequiresOnScreenKeyboard()
return: return:
@ -101,10 +105,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddListener id: AddListener
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 77 startLine: 126
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback)
parameters: parameters:

View file

@ -21,14 +21,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: None id: None
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 82 startLine: 135
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: 'public class None : TextInputWrapper' content: 'public class None : TextInputWrapper'
content.vb: >- content.vb: >-
Public Class None Public Class None
Inherits TextInputWrapper Inherits TextInputWrapper
inheritance: inheritance:
- System.Object - System.Object
@ -66,10 +69,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RequiresOnScreenKeyboard id: RequiresOnScreenKeyboard
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 84 startLine: 138
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override bool RequiresOnScreenKeyboard() content: public override bool RequiresOnScreenKeyboard()
return: return:
@ -101,10 +105,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddListener id: AddListener
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 88 startLine: 143
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback)
parameters: parameters:

View file

@ -22,14 +22,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Primitive id: Primitive
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 93 startLine: 154
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nA primitive text input wrapper that is locked to the American keyboard localization.\nOnly use this text input wrapper if <xref href=\"MLEM.Misc.TextInputWrapper.DesktopGl%601\" data-throw-if-not-resolved=\"false\"></xref> is unavailable for some reason.\n\nNote that, when using this text input wrapper, its <xref href=\"MLEM.Misc.TextInputWrapper.Primitive.Update(MLEM.Input.InputHandler)\" data-throw-if-not-resolved=\"false\"></xref> method has to be called periodically.\n"
example: []
syntax: syntax:
content: 'public class Primitive : TextInputWrapper' content: 'public class Primitive : TextInputWrapper'
content.vb: >- content.vb: >-
Public Class Primitive Public Class Primitive
Inherits TextInputWrapper Inherits TextInputWrapper
inheritance: inheritance:
- System.Object - System.Object
@ -67,15 +70,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Update id: Update
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 97 startLine: 162
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nUpdates this text input wrapper by querying pressed keys and sending corresponding input events.\n"
example: []
syntax: syntax:
content: public void Update(InputHandler handler) content: public void Update(InputHandler handler)
parameters: parameters:
- id: handler - id: handler
type: MLEM.Input.InputHandler type: MLEM.Input.InputHandler
description: The input handler to use for text input querying
content.vb: Public Sub Update(handler As InputHandler) content.vb: Public Sub Update(handler As InputHandler)
overload: MLEM.Misc.TextInputWrapper.Primitive.Update* overload: MLEM.Misc.TextInputWrapper.Primitive.Update*
modifiers.csharp: modifiers.csharp:
@ -100,10 +106,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RequiresOnScreenKeyboard id: RequiresOnScreenKeyboard
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 107 startLine: 173
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override bool RequiresOnScreenKeyboard() content: public override bool RequiresOnScreenKeyboard()
return: return:
@ -135,10 +142,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddListener id: AddListener
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 111 startLine: 178
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
example: []
syntax: syntax:
content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) content: public override void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback)
parameters: parameters:
@ -156,6 +164,45 @@ items:
- Public - Public
- Overrides - Overrides
references: references:
- uid: MLEM.Misc.TextInputWrapper.DesktopGl`1
commentId: T:MLEM.Misc.TextInputWrapper.DesktopGl`1
name: TextInputWrapper.DesktopGl<T>
nameWithType: TextInputWrapper.DesktopGl<T>
fullName: MLEM.Misc.TextInputWrapper.DesktopGl<T>
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 - uid: MLEM.Misc
commentId: N:MLEM.Misc commentId: N:MLEM.Misc
name: MLEM.Misc name: MLEM.Misc

View file

@ -19,19 +19,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TextInputCallback id: TextInputCallback
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 24 startLine: 50
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nA delegate method that can be used for <xref href=\"MLEM.Misc.TextInputWrapper.AddListener(Microsoft.Xna.Framework.GameWindow%2cMLEM.Misc.TextInputWrapper.TextInputCallback)\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public delegate void TextInputCallback(object sender, Keys key, char character); content: public delegate void TextInputCallback(object sender, Keys key, char character);
parameters: parameters:
- id: sender - id: sender
type: System.Object type: System.Object
description: The object that sent the event. The <xref href="MLEM.Misc.TextInputWrapper" data-throw-if-not-resolved="false"></xref> used in most cases.
- id: key - id: key
type: Microsoft.Xna.Framework.Input.Keys type: Microsoft.Xna.Framework.Input.Keys
description: The key that was pressed
- id: character - id: character
type: System.Char 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) content.vb: Public Delegate Sub TextInputCallback(sender As Object, key As Keys, character As Char)
modifiers.csharp: modifiers.csharp:
- public - public
@ -40,6 +45,65 @@ items:
- Public - Public
- Delegate - Delegate
references: 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 - uid: MLEM.Misc
commentId: N:MLEM.Misc commentId: N:MLEM.Misc
name: MLEM.Misc name: MLEM.Misc

View file

@ -22,10 +22,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TextInputWrapper id: TextInputWrapper
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 8 startLine: 13
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nA text input wrapper is a wrapper around MonoGame&apos;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 <a href=\"https://mlem.ellpeck.de/articles/ui.html#text-input\">https://mlem.ellpeck.de/articles/ui.html#text-input</a> for more info.\n"
example: []
syntax: syntax:
content: public abstract class TextInputWrapper content: public abstract class TextInputWrapper
content.vb: Public MustInherit Class TextInputWrapper content.vb: Public MustInherit Class TextInputWrapper
@ -70,10 +72,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Current id: Current
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 11 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: public static TextInputWrapper Current { get; set; } content: public static TextInputWrapper Current { get; set; }
parameters: [] parameters: []
@ -81,6 +85,9 @@ items:
type: MLEM.Misc.TextInputWrapper type: MLEM.Misc.TextInputWrapper
content.vb: Public Shared Property Current As TextInputWrapper content.vb: Public Shared Property Current As TextInputWrapper
overload: MLEM.Misc.TextInputWrapper.Current* overload: MLEM.Misc.TextInputWrapper.Current*
exceptions:
- type: System.InvalidOperationException
commentId: T:System.InvalidOperationException
modifiers.csharp: modifiers.csharp:
- public - public
- static - static
@ -107,14 +114,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RequiresOnScreenKeyboard id: RequiresOnScreenKeyboard
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 20 startLine: 34
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc namespace: MLEM.Misc
summary: "\nDetermines if this text input wrapper requires an on-screen keyboard.\n"
example: []
syntax: syntax:
content: public abstract bool RequiresOnScreenKeyboard() content: public abstract bool RequiresOnScreenKeyboard()
return: return:
type: System.Boolean type: System.Boolean
description: If this text input wrapper requires an on-screen keyboard
content.vb: Public MustOverride Function RequiresOnScreenKeyboard As Boolean content.vb: Public MustOverride Function RequiresOnScreenKeyboard As Boolean
overload: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard* overload: MLEM.Misc.TextInputWrapper.RequiresOnScreenKeyboard*
modifiers.csharp: modifiers.csharp:
@ -141,17 +151,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddListener id: AddListener
path: ../MLEM/Misc/TextInputWrapper.cs path: ../MLEM/Misc/TextInputWrapper.cs
startLine: 22 startLine: 42
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Misc 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: syntax:
content: public abstract void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback) content: public abstract void AddListener(GameWindow window, TextInputWrapper.TextInputCallback callback)
parameters: parameters:
- id: window - id: window
type: Microsoft.Xna.Framework.GameWindow type: Microsoft.Xna.Framework.GameWindow
description: The game&apos;s window
- id: callback - id: callback
type: MLEM.Misc.TextInputWrapper.TextInputCallback 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) content.vb: Public MustOverride Sub AddListener(window As GameWindow, callback As TextInputWrapper.TextInputCallback)
overload: MLEM.Misc.TextInputWrapper.AddListener* overload: MLEM.Misc.TextInputWrapper.AddListener*
modifiers.csharp: modifiers.csharp:
@ -458,6 +472,9 @@ references:
name: System name: System
nameWithType: System nameWithType: System
fullName: System fullName: System
- uid: System.InvalidOperationException
commentId: T:System.InvalidOperationException
isExternal: true
- uid: MLEM.Misc.TextInputWrapper.Current* - uid: MLEM.Misc.TextInputWrapper.Current*
commentId: Overload:MLEM.Misc.TextInputWrapper.Current commentId: Overload:MLEM.Misc.TextInputWrapper.Current
name: Current name: Current

View file

@ -19,17 +19,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetCost id: GetCost
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 109 startLine: 176
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nA cost function for a given path finding position.\nIf a path point should have the default cost, <xref href=\"MLEM.Pathfinding.AStar%601.DefaultCost\" data-throw-if-not-resolved=\"false\"></xref> should be returned.\nIf a path point should be unreachable, <xref href=\"MLEM.Pathfinding.AStar%601.InfiniteCost\" data-throw-if-not-resolved=\"false\"></xref> should be returned.\n"
example: []
syntax: syntax:
content: public delegate float GetCost(T currPos, T nextPos); content: public delegate float GetCost(T currPos, T nextPos);
parameters: parameters:
- id: currPos - id: currPos
type: '{T}' type: '{T}'
description: The current position in the path
- id: nextPos - id: nextPos
type: '{T}' type: '{T}'
description: The position we&apos;re trying to reach from the current position
return: return:
type: System.Single type: System.Single
content.vb: Public Delegate Function GetCost(currPos As T, nextPos As T) As 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 fullName.vb: MLEM.Pathfinding.AStar(Of T).GetCost
name.vb: AStar(Of T).GetCost name.vb: AStar(Of T).GetCost
references: references:
- uid: MLEM.Pathfinding.AStar`1.DefaultCost
commentId: F:MLEM.Pathfinding.AStar`1.DefaultCost
name: DefaultCost
nameWithType: AStar<T>.DefaultCost
fullName: MLEM.Pathfinding.AStar<T>.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<T>.InfiniteCost
fullName: MLEM.Pathfinding.AStar<T>.InfiniteCost
nameWithType.vb: AStar(Of T).InfiniteCost
fullName.vb: MLEM.Pathfinding.AStar(Of T).InfiniteCost
- uid: MLEM.Pathfinding - uid: MLEM.Pathfinding
commentId: N:MLEM.Pathfinding commentId: N:MLEM.Pathfinding
name: MLEM.Pathfinding name: MLEM.Pathfinding

View file

@ -33,14 +33,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AStar id: AStar
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 6 startLine: 11
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThis is an abstract implementation of the A* path finding algorithm.\nThis implementation is used by <xref href=\"MLEM.Pathfinding.AStar2\" data-throw-if-not-resolved=\"false\"></xref>, a 2-dimensional A* path finding algorithm, and <xref href=\"MLEM.Pathfinding.AStar3\" data-throw-if-not-resolved=\"false\"></xref>, a 3-dimensional A* path finding algorithm.\n"
example: []
syntax: syntax:
content: public abstract class AStar<T> content: public abstract class AStar<T>
typeParameters: typeParameters:
- id: T - id: T
description: The type of points used for this path
content.vb: Public MustInherit Class AStar(Of T) content.vb: Public MustInherit Class AStar(Of T)
inheritance: inheritance:
- System.Object - System.Object
@ -84,10 +87,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: InfiniteCost id: InfiniteCost
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 8 startLine: 16
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding 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: syntax:
content: public static readonly float InfiniteCost content: public static readonly float InfiniteCost
return: return:
@ -121,10 +126,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AllDirections id: AllDirections
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 9 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe array of all directions that will be checked for path finding.\nNote that this array is only used if <xref href=\"MLEM.Pathfinding.AStar%601.DefaultAllowDiagonals\" data-throw-if-not-resolved=\"false\"></xref> is true.\n"
example: []
syntax: syntax:
content: public readonly T[] AllDirections content: public readonly T[] AllDirections
return: return:
@ -156,10 +163,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AdjacentDirections id: AdjacentDirections
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 10 startLine: 26
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding 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 <xref href=\"MLEM.Pathfinding.AStar%601.DefaultAllowDiagonals\" data-throw-if-not-resolved=\"false\"></xref> is false.\n"
example: []
syntax: syntax:
content: public readonly T[] AdjacentDirections content: public readonly T[] AdjacentDirections
return: return:
@ -191,10 +200,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DefaultCostFunction id: DefaultCostFunction
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 11 startLine: 30
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe default cost function that determines the cost for each path finding position.\n"
example: []
syntax: syntax:
content: public AStar<T>.GetCost DefaultCostFunction content: public AStar<T>.GetCost DefaultCostFunction
return: return:
@ -224,10 +235,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DefaultCost id: DefaultCost
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 12 startLine: 34
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe default cost for a path point.\n"
example: []
syntax: syntax:
content: public float DefaultCost content: public float DefaultCost
return: return:
@ -257,10 +270,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DefaultMaxTries id: DefaultMaxTries
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 13 startLine: 38
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe default amount of maximum tries that will be used before path finding is aborted.\n"
example: []
syntax: syntax:
content: public int DefaultMaxTries content: public int DefaultMaxTries
return: return:
@ -290,10 +305,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: DefaultAllowDiagonals id: DefaultAllowDiagonals
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 14 startLine: 42
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nWhether or not diagonal directions are considered while finding a path.\n"
example: []
syntax: syntax:
content: public bool DefaultAllowDiagonals content: public bool DefaultAllowDiagonals
return: return:
@ -323,10 +340,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: LastTriesNeeded id: LastTriesNeeded
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 15 startLine: 46
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe amount of tries required for finding the last queried path\n"
example: []
syntax: syntax:
content: public int LastTriesNeeded { get; } content: public int LastTriesNeeded { get; }
parameters: [] parameters: []
@ -360,10 +379,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: LastTimeNeeded id: LastTimeNeeded
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 16 startLine: 50
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe amount of time required for finding the last queried path\n"
example: []
syntax: syntax:
content: public TimeSpan LastTimeNeeded { get; } content: public TimeSpan LastTimeNeeded { get; }
parameters: [] parameters: []
@ -397,25 +418,33 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 18 startLine: 61
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nCreates a new A* pathfinder with the supplied default settings.\n"
example: []
syntax: syntax:
content: protected AStar(T[] allDirections, T[] adjacentDirections, AStar<T>.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000) content: protected AStar(T[] allDirections, T[] adjacentDirections, AStar<T>.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000)
parameters: parameters:
- id: allDirections - id: allDirections
type: '{T}[]' type: '{T}[]'
description: All directions that should be checked
- id: adjacentDirections - id: adjacentDirections
type: '{T}[]' type: '{T}[]'
description: All adjacent directions that should be checked
- id: defaultCostFunction - id: defaultCostFunction
type: MLEM.Pathfinding.AStar`1.GetCost type: MLEM.Pathfinding.AStar`1.GetCost
description: The default function for cost determination of a path point
- id: defaultAllowDiagonals - id: defaultAllowDiagonals
type: System.Boolean type: System.Boolean
description: Whether or not diagonals should be allowed by default
- id: defaultCost - id: defaultCost
type: System.Single type: System.Single
description: The default cost for a path point
- id: defaultMaxTries - id: defaultMaxTries
type: System.Int32 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) 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* overload: MLEM.Pathfinding.AStar`1.#ctor*
nameWithType.vb: AStar(Of T).AStar(T(), T(), AStar(Of T).GetCost, Boolean, Single, Int32) 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 repo: https://github.com/Ellpeck/MLEM
id: FindPathAsync id: FindPathAsync
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 27 startLine: 71
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: public Task<Stack<T>> FindPathAsync(T start, T goal, AStar<T>.GetCost costFunction = null, float? defaultCost = default(float? ), int? maxTries = default(int? ), bool? allowDiagonals = default(bool? )) content: public Task<Stack<T>> FindPathAsync(T start, T goal, AStar<T>.GetCost costFunction = null, float? defaultCost = default(float? ), int? maxTries = default(int? ), bool? allowDiagonals = default(bool? ))
parameters: parameters:
@ -491,27 +521,36 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: FindPath id: FindPath
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 31 startLine: 85
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nFinds a path between two points using this pathfinder&apos;s default settings or, alternatively, the supplied override settings.\n"
example: []
syntax: syntax:
content: public Stack<T> FindPath(T start, T goal, AStar<T>.GetCost costFunction = null, float? defaultCost = default(float? ), int? maxTries = default(int? ), bool? allowDiagonals = default(bool? )) content: public Stack<T> FindPath(T start, T goal, AStar<T>.GetCost costFunction = null, float? defaultCost = default(float? ), int? maxTries = default(int? ), bool? allowDiagonals = default(bool? ))
parameters: parameters:
- id: start - id: start
type: '{T}' type: '{T}'
description: The point to start path finding at
- id: goal - id: goal
type: '{T}' type: '{T}'
description: The point to find a path to
- id: costFunction - id: costFunction
type: MLEM.Pathfinding.AStar`1.GetCost type: MLEM.Pathfinding.AStar`1.GetCost
description: The function that determines the cost for each path point
- id: defaultCost - id: defaultCost
type: System.Nullable{System.Single} type: System.Nullable{System.Single}
description: The default cost for each path point
- id: maxTries - id: maxTries
type: System.Nullable{System.Int32} type: System.Nullable{System.Int32}
description: The maximum amount of tries before path finding is aborted
- id: allowDiagonals - id: allowDiagonals
type: System.Nullable{System.Boolean} type: System.Nullable{System.Boolean}
description: If diagonals should be looked at for path finding
return: return:
type: System.Collections.Generic.Stack{{T}} 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) 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* 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)) 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 repo: https://github.com/Ellpeck/MLEM
id: AddPositions id: AddPositions
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 96 startLine: 153
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nA helper method to add two positions together.\n"
example: []
syntax: syntax:
content: protected abstract T AddPositions(T first, T second) content: protected abstract T AddPositions(T first, T second)
parameters: parameters:
@ -580,10 +621,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetManhattanDistance id: GetManhattanDistance
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 98 startLine: 158
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nA helper method to get the Manhattan Distance between two points.\n"
example: []
syntax: syntax:
content: protected abstract float GetManhattanDistance(T first, T second) content: protected abstract float GetManhattanDistance(T first, T second)
parameters: parameters:
@ -604,6 +647,16 @@ items:
- MustOverride - MustOverride
fullName.vb: MLEM.Pathfinding.AStar(Of T).GetManhattanDistance(T, T) fullName.vb: MLEM.Pathfinding.AStar(Of T).GetManhattanDistance(T, T)
references: 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 - uid: MLEM.Pathfinding
commentId: N:MLEM.Pathfinding commentId: N:MLEM.Pathfinding
name: MLEM.Pathfinding name: MLEM.Pathfinding
@ -908,6 +961,13 @@ references:
name: Single name: Single
nameWithType: Single nameWithType: Single
fullName: System.Single fullName: System.Single
- uid: MLEM.Pathfinding.AStar`1.DefaultAllowDiagonals
commentId: F:MLEM.Pathfinding.AStar`1.DefaultAllowDiagonals
name: DefaultAllowDiagonals
nameWithType: AStar<T>.DefaultAllowDiagonals
fullName: MLEM.Pathfinding.AStar<T>.DefaultAllowDiagonals
nameWithType.vb: AStar(Of T).DefaultAllowDiagonals
fullName.vb: MLEM.Pathfinding.AStar(Of T).DefaultAllowDiagonals
- uid: '{T}[]' - uid: '{T}[]'
isExternal: true isExternal: true
name: T[] name: T[]
@ -1003,6 +1063,195 @@ references:
fullName: MLEM.Pathfinding.AStar<T>.AStar fullName: MLEM.Pathfinding.AStar<T>.AStar
nameWithType.vb: AStar(Of T).AStar nameWithType.vb: AStar(Of T).AStar
fullName.vb: MLEM.Pathfinding.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<Single>, Nullable<Int32>, Nullable<Boolean>)
nameWithType: AStar<T>.FindPath(T, T, AStar.GetCost<>, Nullable<Single>, Nullable<Int32>, Nullable<Boolean>)
fullName: MLEM.Pathfinding.AStar<T>.FindPath(T, T, MLEM.Pathfinding.AStar.GetCost<>, System.Nullable<System.Single>, System.Nullable<System.Int32>, System.Nullable<System.Boolean>)
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<T>.FindPath
fullName: MLEM.Pathfinding.AStar<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: <
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* - uid: MLEM.Pathfinding.AStar`1.FindPathAsync*
commentId: Overload:MLEM.Pathfinding.AStar`1.FindPathAsync commentId: Overload:MLEM.Pathfinding.AStar`1.FindPathAsync
name: FindPathAsync name: FindPathAsync

View file

@ -22,14 +22,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AStar2 id: AStar2
path: ../MLEM/Pathfinding/AStar2.cs path: ../MLEM/Pathfinding/AStar2.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nA 2-dimensional implementation of <xref href=\"MLEM.Pathfinding.AStar%601\" data-throw-if-not-resolved=\"false\"></xref> that uses <xref href=\"Microsoft.Xna.Framework.Point\" data-throw-if-not-resolved=\"false\"></xref> for positions.\n"
example: []
syntax: syntax:
content: 'public class AStar2 : AStar<Point>' content: 'public class AStar2 : AStar<Point>'
content.vb: >- content.vb: >-
Public Class AStar2 Public Class AStar2
Inherits AStar(Of Point) Inherits AStar(Of Point)
inheritance: inheritance:
- System.Object - System.Object
@ -77,10 +80,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Pathfinding/AStar2.cs path: ../MLEM/Pathfinding/AStar2.cs
startLine: 11 startLine: 15
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: public AStar2(AStar<Point>.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000) content: public AStar2(AStar<Point>.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000)
parameters: parameters:
@ -119,10 +123,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddPositions id: AddPositions
path: ../MLEM/Pathfinding/AStar2.cs path: ../MLEM/Pathfinding/AStar2.cs
startLine: 15 startLine: 20
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: protected override Point AddPositions(Point first, Point second) content: protected override Point AddPositions(Point first, Point second)
parameters: parameters:
@ -159,10 +164,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetManhattanDistance id: GetManhattanDistance
path: ../MLEM/Pathfinding/AStar2.cs path: ../MLEM/Pathfinding/AStar2.cs
startLine: 19 startLine: 25
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: protected override float GetManhattanDistance(Point first, Point second) content: protected override float GetManhattanDistance(Point first, Point second)
parameters: parameters:
@ -182,6 +188,49 @@ items:
- Protected - Protected
- Overrides - Overrides
references: references:
- uid: MLEM.Pathfinding.AStar`1
commentId: T:MLEM.Pathfinding.AStar`1
name: AStar<T>
nameWithType: AStar<T>
fullName: MLEM.Pathfinding.AStar<T>
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 - uid: MLEM.Pathfinding
commentId: N:MLEM.Pathfinding commentId: N:MLEM.Pathfinding
name: MLEM.Pathfinding name: MLEM.Pathfinding
@ -992,48 +1041,18 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
name: System name: System
nameWithType: System nameWithType: System
fullName: System fullName: System
- uid: MLEM.Pathfinding.AStar`1
commentId: T:MLEM.Pathfinding.AStar`1
name: AStar<T>
nameWithType: AStar<T>
fullName: MLEM.Pathfinding.AStar<T>
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 - uid: MLEM.Pathfinding.AStar`1.InfiniteCost
commentId: F:MLEM.Pathfinding.AStar`1.InfiniteCost commentId: F:MLEM.Pathfinding.AStar`1.InfiniteCost
name: InfiniteCost name: InfiniteCost
@ -1626,13 +1645,6 @@ references:
name: AddPositions name: AddPositions
nameWithType: AStar2.AddPositions nameWithType: AStar2.AddPositions
fullName: MLEM.Pathfinding.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) - uid: MLEM.Pathfinding.AStar`1.AddPositions(`0,`0)
commentId: M:MLEM.Pathfinding.AStar`1.AddPositions(`0,`0) commentId: M:MLEM.Pathfinding.AStar`1.AddPositions(`0,`0)
name: AddPositions(T, T) name: AddPositions(T, T)
@ -1680,12 +1692,6 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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) - 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) 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} parent: MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Point}

View file

@ -22,14 +22,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AStar3 id: AStar3
path: ../MLEM/Pathfinding/AStar3.cs path: ../MLEM/Pathfinding/AStar3.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nA 3-dimensional implementation of <xref href=\"MLEM.Pathfinding.AStar%601\" data-throw-if-not-resolved=\"false\"></xref> that uses <xref href=\"Microsoft.Xna.Framework.Vector3\" data-throw-if-not-resolved=\"false\"></xref> for positions.\n"
example: []
syntax: syntax:
content: 'public class AStar3 : AStar<Vector3>' content: 'public class AStar3 : AStar<Vector3>'
content.vb: >- content.vb: >-
Public Class AStar3 Public Class AStar3
Inherits AStar(Of Vector3) Inherits AStar(Of Vector3)
inheritance: inheritance:
- System.Object - System.Object
@ -77,10 +80,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Pathfinding/AStar3.cs path: ../MLEM/Pathfinding/AStar3.cs
startLine: 33 startLine: 37
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: public AStar3(AStar<Vector3>.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000) content: public AStar3(AStar<Vector3>.GetCost defaultCostFunction, bool defaultAllowDiagonals, float defaultCost = 1F, int defaultMaxTries = 10000)
parameters: parameters:
@ -119,10 +123,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: AddPositions id: AddPositions
path: ../MLEM/Pathfinding/AStar3.cs path: ../MLEM/Pathfinding/AStar3.cs
startLine: 37 startLine: 42
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: protected override Vector3 AddPositions(Vector3 first, Vector3 second) content: protected override Vector3 AddPositions(Vector3 first, Vector3 second)
parameters: parameters:
@ -159,10 +164,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetManhattanDistance id: GetManhattanDistance
path: ../MLEM/Pathfinding/AStar3.cs path: ../MLEM/Pathfinding/AStar3.cs
startLine: 41 startLine: 47
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: protected override float GetManhattanDistance(Vector3 first, Vector3 second) content: protected override float GetManhattanDistance(Vector3 first, Vector3 second)
parameters: parameters:
@ -182,6 +188,49 @@ items:
- Protected - Protected
- Overrides - Overrides
references: references:
- uid: MLEM.Pathfinding.AStar`1
commentId: T:MLEM.Pathfinding.AStar`1
name: AStar<T>
nameWithType: AStar<T>
fullName: MLEM.Pathfinding.AStar<T>
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 - uid: MLEM.Pathfinding
commentId: N:MLEM.Pathfinding commentId: N:MLEM.Pathfinding
name: MLEM.Pathfinding name: MLEM.Pathfinding
@ -992,48 +1041,18 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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 - uid: System
commentId: N:System commentId: N:System
isExternal: true isExternal: true
name: System name: System
nameWithType: System nameWithType: System
fullName: System fullName: System
- uid: MLEM.Pathfinding.AStar`1
commentId: T:MLEM.Pathfinding.AStar`1
name: AStar<T>
nameWithType: AStar<T>
fullName: MLEM.Pathfinding.AStar<T>
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 - uid: MLEM.Pathfinding.AStar`1.InfiniteCost
commentId: F:MLEM.Pathfinding.AStar`1.InfiniteCost commentId: F:MLEM.Pathfinding.AStar`1.InfiniteCost
name: InfiniteCost name: InfiniteCost
@ -1626,13 +1645,6 @@ references:
name: AddPositions name: AddPositions
nameWithType: AStar3.AddPositions nameWithType: AStar3.AddPositions
fullName: MLEM.Pathfinding.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) - uid: MLEM.Pathfinding.AStar`1.AddPositions(`0,`0)
commentId: M:MLEM.Pathfinding.AStar`1.AddPositions(`0,`0) commentId: M:MLEM.Pathfinding.AStar`1.AddPositions(`0,`0)
name: AddPositions(T, T) name: AddPositions(T, T)
@ -1680,12 +1692,6 @@ references:
- name: ) - name: )
nameWithType: ) nameWithType: )
fullName: ) 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) - 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) 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} parent: MLEM.Pathfinding.AStar{Microsoft.Xna.Framework.Vector3}

View file

@ -26,14 +26,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: PathPoint id: PathPoint
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 113 startLine: 184
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nA point in a <xref href=\"MLEM.Pathfinding.AStar%601\" data-throw-if-not-resolved=\"false\"></xref> path\n"
example: []
syntax: syntax:
content: public class PathPoint<T> content: public class PathPoint<T>
typeParameters: typeParameters:
- id: T - id: T
description: The type of point used for this path
content.vb: Public Class PathPoint(Of T) content.vb: Public Class PathPoint(Of T)
inheritance: inheritance:
- System.Object - System.Object
@ -70,10 +73,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Parent id: Parent
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 115 startLine: 189
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe path point that this point originated from\n"
example: []
syntax: syntax:
content: public readonly PathPoint<T> Parent content: public readonly PathPoint<T> Parent
return: return:
@ -105,10 +110,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Pos id: Pos
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 116 startLine: 193
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe position of this path point\n"
example: []
syntax: syntax:
content: public readonly T Pos content: public readonly T Pos
return: return:
@ -140,10 +147,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: F id: F
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 117 startLine: 197
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe F cost of this path point\n"
example: []
syntax: syntax:
content: public readonly float F content: public readonly float F
return: return:
@ -175,10 +184,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: G id: G
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 118 startLine: 201
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nThe G cost of this path point\n"
example: []
syntax: syntax:
content: public readonly float G content: public readonly float G
return: return:
@ -210,23 +221,30 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 120 startLine: 211
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
summary: "\nCreates a new path point with the supplied settings.\n"
example: []
syntax: syntax:
content: public PathPoint(T pos, float distance, PathPoint<T> parent, float terrainCostForThisPos, float defaultCost) content: public PathPoint(T pos, float distance, PathPoint<T> parent, float terrainCostForThisPos, float defaultCost)
parameters: parameters:
- id: pos - id: pos
type: '{T}' type: '{T}'
description: The point&apos;s position
- id: distance - id: distance
type: System.Single type: System.Single
description: The point&apos;s manhattan distance from the start point
- id: parent - id: parent
type: MLEM.Pathfinding.PathPoint`1 type: MLEM.Pathfinding.PathPoint`1
description: The point&apos;s parent
- id: terrainCostForThisPos - id: terrainCostForThisPos
type: System.Single type: System.Single
description: The point&apos;s terrain cost, based on <xref href="MLEM.Pathfinding.AStar%601.GetCost" data-throw-if-not-resolved="false"></xref>
- id: defaultCost - id: defaultCost
type: System.Single 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) 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* overload: MLEM.Pathfinding.PathPoint`1.#ctor*
nameWithType.vb: PathPoint(Of T).PathPoint(T, Single, PathPoint(Of T), Single, Single) nameWithType.vb: PathPoint(Of T).PathPoint(T, Single, PathPoint(Of T), Single, Single)
@ -254,10 +272,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Equals id: Equals
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 128 startLine: 220
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: public override bool Equals(object obj) content: public override bool Equals(object obj)
parameters: parameters:
@ -294,10 +313,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: GetHashCode id: GetHashCode
path: ../MLEM/Pathfinding/AStar.cs path: ../MLEM/Pathfinding/AStar.cs
startLine: 134 startLine: 227
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Pathfinding namespace: MLEM.Pathfinding
example: []
syntax: syntax:
content: public override int GetHashCode() content: public override int GetHashCode()
return: return:
@ -314,6 +334,42 @@ items:
- Overrides - Overrides
fullName.vb: MLEM.Pathfinding.PathPoint(Of T).GetHashCode() fullName.vb: MLEM.Pathfinding.PathPoint(Of T).GetHashCode()
references: references:
- uid: MLEM.Pathfinding.AStar`1
commentId: T:MLEM.Pathfinding.AStar`1
name: AStar<T>
nameWithType: AStar<T>
fullName: MLEM.Pathfinding.AStar<T>
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 - uid: MLEM.Pathfinding
commentId: N:MLEM.Pathfinding commentId: N:MLEM.Pathfinding
name: MLEM.Pathfinding name: MLEM.Pathfinding
@ -593,6 +649,37 @@ references:
name: Single name: Single
nameWithType: Single nameWithType: Single
fullName: System.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* - uid: MLEM.Pathfinding.PathPoint`1.#ctor*
commentId: Overload:MLEM.Pathfinding.PathPoint`1.#ctor commentId: Overload:MLEM.Pathfinding.PathPoint`1.#ctor
name: PathPoint name: PathPoint

View file

@ -42,7 +42,9 @@ items:
content: 'public class MlemGame : Game, IDisposable' content: 'public class MlemGame : Game, IDisposable'
content.vb: >- content.vb: >-
Public Class MlemGame Public Class MlemGame
Inherits Game Inherits Game
Implements IDisposable Implements IDisposable
inheritance: inheritance:
- System.Object - System.Object

View file

@ -10,8 +10,6 @@ items:
- MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,MLEM.Misc.Padding) - 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)
- MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32,System.Int32,System.Int32,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.Padding
- MLEM.Textures.NinePatch.Region - MLEM.Textures.NinePatch.Region
- MLEM.Textures.NinePatch.SourceRectangles - MLEM.Textures.NinePatch.SourceRectangles
@ -29,14 +27,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: NinePatch id: NinePatch
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 8 startLine: 12
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures 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: syntax:
content: 'public class NinePatch : GenericDataHolder' content: 'public class NinePatch : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class NinePatch Public Class NinePatch
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -78,10 +79,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Region id: Region
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 10 startLine: 17
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe texture region of this nine patch\n"
example: []
syntax: syntax:
content: public readonly TextureRegion Region content: public readonly TextureRegion Region
return: return:
@ -111,10 +114,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Padding id: Padding
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 11 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe padding in each direction that marks where the outline area stops\n"
example: []
syntax: syntax:
content: public readonly Padding Padding content: public readonly Padding Padding
return: return:
@ -144,10 +149,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: SourceRectangles id: SourceRectangles
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 12 startLine: 25
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe nine patches that result from the <xref href=\"MLEM.Textures.NinePatch.Padding\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public readonly Rectangle[] SourceRectangles content: public readonly Rectangle[] SourceRectangles
return: return:
@ -177,17 +184,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 14 startLine: 32
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new nine patch from a texture and a padding\n"
example: []
syntax: syntax:
content: public NinePatch(TextureRegion texture, Padding padding) content: public NinePatch(TextureRegion texture, Padding padding)
parameters: parameters:
- id: texture - id: texture
type: MLEM.Textures.TextureRegion type: MLEM.Textures.TextureRegion
description: The texture to use
- id: padding - id: padding
type: MLEM.Misc.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) content.vb: Public Sub New(texture As TextureRegion, padding As Padding)
overload: MLEM.Textures.NinePatch.#ctor* overload: MLEM.Textures.NinePatch.#ctor*
modifiers.csharp: modifiers.csharp:
@ -212,23 +223,30 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 20 startLine: 46
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new nine patch from a texture and a padding\n"
example: []
syntax: syntax:
content: public NinePatch(TextureRegion texture, int paddingLeft, int paddingRight, int paddingTop, int paddingBottom) content: public NinePatch(TextureRegion texture, int paddingLeft, int paddingRight, int paddingTop, int paddingBottom)
parameters: parameters:
- id: texture - id: texture
type: MLEM.Textures.TextureRegion type: MLEM.Textures.TextureRegion
description: The texture to use
- id: paddingLeft - id: paddingLeft
type: System.Int32 type: System.Int32
description: The padding on the left edge
- id: paddingRight - id: paddingRight
type: System.Int32 type: System.Int32
description: The padding on the right edge
- id: paddingTop - id: paddingTop
type: System.Int32 type: System.Int32
description: The padding on the top edge
- id: paddingBottom - id: paddingBottom
type: System.Int32 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) 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* overload: MLEM.Textures.NinePatch.#ctor*
modifiers.csharp: modifiers.csharp:
@ -253,10 +271,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 24 startLine: 51
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public NinePatch(Texture2D texture, int paddingLeft, int paddingRight, int paddingTop, int paddingBottom) content: public NinePatch(Texture2D texture, int paddingLeft, int paddingRight, int paddingTop, int paddingBottom)
parameters: parameters:
@ -294,17 +313,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 28 startLine: 60
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new nine patch from a texture and a uniform padding\n"
example: []
syntax: syntax:
content: public NinePatch(Texture2D texture, int padding) content: public NinePatch(Texture2D texture, int padding)
parameters: parameters:
- id: texture - id: texture
type: Microsoft.Xna.Framework.Graphics.Texture2D type: Microsoft.Xna.Framework.Graphics.Texture2D
description: The texture to use
- id: padding - id: padding
type: System.Int32 type: System.Int32
description: The padding that each edge should have
content.vb: Public Sub New(texture As Texture2D, padding As Integer) content.vb: Public Sub New(texture As Texture2D, padding As Integer)
overload: MLEM.Textures.NinePatch.#ctor* overload: MLEM.Textures.NinePatch.#ctor*
modifiers.csharp: modifiers.csharp:
@ -329,10 +352,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 31 startLine: 64
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public NinePatch(TextureRegion texture, int padding) content: public NinePatch(TextureRegion texture, int padding)
parameters: parameters:
@ -346,80 +370,6 @@ items:
- public - public
modifiers.vb: modifiers.vb:
- Public - 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<Rectangle> 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<RectangleF> 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: references:
- uid: MLEM.Textures - uid: MLEM.Textures
commentId: N:MLEM.Textures commentId: N:MLEM.Textures
@ -941,6 +891,9 @@ references:
name: Padding name: Padding
nameWithType: Padding nameWithType: Padding
fullName: MLEM.Misc.Padding fullName: MLEM.Misc.Padding
- uid: MLEM.Textures.NinePatch.Padding
commentId: F:MLEM.Textures.NinePatch.Padding
isExternal: true
- uid: Microsoft.Xna.Framework.Rectangle[] - uid: Microsoft.Xna.Framework.Rectangle[]
isExternal: true isExternal: true
name: Rectangle[] name: Rectangle[]
@ -979,6 +932,9 @@ references:
name: Int32 name: Int32
nameWithType: Int32 nameWithType: Int32
fullName: System.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 - uid: Microsoft.Xna.Framework.Graphics.Texture2D
commentId: T:Microsoft.Xna.Framework.Graphics.Texture2D commentId: T:Microsoft.Xna.Framework.Graphics.Texture2D
parent: Microsoft.Xna.Framework.Graphics parent: Microsoft.Xna.Framework.Graphics
@ -992,165 +948,6 @@ references:
name: Microsoft.Xna.Framework.Graphics name: Microsoft.Xna.Framework.Graphics
nameWithType: Microsoft.Xna.Framework.Graphics nameWithType: Microsoft.Xna.Framework.Graphics
fullName: Microsoft.Xna.Framework.Graphics fullName: Microsoft.Xna.Framework.Graphics
- uid: MLEM.Textures.NinePatch.CreateRectangles* - uid: MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32)
commentId: Overload:MLEM.Textures.NinePatch.CreateRectangles commentId: M:MLEM.Textures.NinePatch.#ctor(MLEM.Textures.TextureRegion,System.Int32)
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
isExternal: true 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<Rectangle>
nameWithType: IEnumerable<Rectangle>
fullName: System.Collections.Generic.IEnumerable<Microsoft.Xna.Framework.Rectangle>
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<T>
nameWithType: IEnumerable<T>
fullName: System.Collections.Generic.IEnumerable<T>
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<RectangleF>
nameWithType: IEnumerable<RectangleF>
fullName: System.Collections.Generic.IEnumerable<MLEM.Misc.RectangleF>
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: )

View file

@ -23,10 +23,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: NinePatchExtensions id: NinePatchExtensions
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 64 startLine: 100
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nA set of extensions that allow for <xref href=\"MLEM.Textures.NinePatch\" data-throw-if-not-resolved=\"false\"></xref> rendering\n"
example: []
syntax: syntax:
content: public static class NinePatchExtensions content: public static class NinePatchExtensions
content.vb: Public Module NinePatchExtensions content.vb: Public Module NinePatchExtensions
@ -66,31 +68,42 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 66 startLine: 114
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nDraws a nine patch area using the given sprite batch\n"
example: []
syntax: 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) 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: parameters:
- id: batch - id: batch
type: Microsoft.Xna.Framework.Graphics.SpriteBatch type: Microsoft.Xna.Framework.Graphics.SpriteBatch
description: The batch to draw with
- id: texture - id: texture
type: MLEM.Textures.NinePatch type: MLEM.Textures.NinePatch
description: The nine patch to draw
- id: destinationRectangle - id: destinationRectangle
type: MLEM.Misc.RectangleF type: MLEM.Misc.RectangleF
description: The area that should be covered by this nine patch
- id: color - id: color
type: Microsoft.Xna.Framework.Color type: Microsoft.Xna.Framework.Color
description: The color to use
- id: rotation - id: rotation
type: System.Single type: System.Single
description: The rotation
- id: origin - id: origin
type: Microsoft.Xna.Framework.Vector2 type: Microsoft.Xna.Framework.Vector2
description: The origin position
- id: effects - id: effects
type: Microsoft.Xna.Framework.Graphics.SpriteEffects type: Microsoft.Xna.Framework.Graphics.SpriteEffects
description: The effects that the sprite should have
- id: layerDepth - id: layerDepth
type: System.Single type: System.Single
description: The depth
- id: patchScale - id: patchScale
type: System.Single type: System.Single
description: The scale of each area of the nine patch
content.vb: >- content.vb: >-
<ExtensionAttribute> <ExtensionAttribute>
@ -121,10 +134,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 76 startLine: 125
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: 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) 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: parameters:
@ -176,10 +190,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 80 startLine: 130
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public static void Draw(this SpriteBatch batch, NinePatch texture, RectangleF destinationRectangle, Color color, float patchScale = 1F) content: public static void Draw(this SpriteBatch batch, NinePatch texture, RectangleF destinationRectangle, Color color, float patchScale = 1F)
parameters: parameters:
@ -223,10 +238,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/NinePatch.cs path: ../MLEM/Textures/NinePatch.cs
startLine: 84 startLine: 135
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public static void Draw(this SpriteBatch batch, NinePatch texture, Rectangle destinationRectangle, Color color, float patchScale = 1F) content: public static void Draw(this SpriteBatch batch, NinePatch texture, Rectangle destinationRectangle, Color color, float patchScale = 1F)
parameters: parameters:
@ -252,6 +268,12 @@ items:
- Public - Public
- Shared - Shared
references: references:
- uid: MLEM.Textures.NinePatch
commentId: T:MLEM.Textures.NinePatch
parent: MLEM.Textures
name: NinePatch
nameWithType: NinePatch
fullName: MLEM.Textures.NinePatch
- uid: MLEM.Textures - uid: MLEM.Textures
commentId: N:MLEM.Textures commentId: N:MLEM.Textures
name: MLEM.Textures name: MLEM.Textures
@ -561,12 +583,6 @@ references:
name: SpriteBatch name: SpriteBatch
nameWithType: SpriteBatch nameWithType: SpriteBatch
fullName: Microsoft.Xna.Framework.Graphics.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 - uid: MLEM.Misc.RectangleF
commentId: T:MLEM.Misc.RectangleF commentId: T:MLEM.Misc.RectangleF
parent: MLEM.Misc parent: MLEM.Misc
@ -618,6 +634,9 @@ references:
name: Microsoft.Xna.Framework name: Microsoft.Xna.Framework
nameWithType: Microsoft.Xna.Framework nameWithType: Microsoft.Xna.Framework
fullName: 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 - uid: Microsoft.Xna.Framework.Rectangle
commentId: T:Microsoft.Xna.Framework.Rectangle commentId: T:Microsoft.Xna.Framework.Rectangle
parent: Microsoft.Xna.Framework parent: Microsoft.Xna.Framework

View file

@ -31,14 +31,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TextureRegion id: TextureRegion
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 6 startLine: 9
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThis class represents a part of a texture.\n"
example: []
syntax: syntax:
content: 'public class TextureRegion : GenericDataHolder' content: 'public class TextureRegion : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class TextureRegion Public Class TextureRegion
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -80,10 +83,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Texture id: Texture
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 8 startLine: 14
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe texture that this region is a part of\n"
example: []
syntax: syntax:
content: public readonly Texture2D Texture content: public readonly Texture2D Texture
return: return:
@ -113,10 +118,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Area id: Area
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 9 startLine: 18
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe area that is covered by this texture region\n"
example: []
syntax: syntax:
content: public readonly Rectangle Area content: public readonly Rectangle Area
return: return:
@ -146,10 +153,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Position id: Position
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 10 startLine: 22
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe top left corner of this texture region\n"
example: []
syntax: syntax:
content: public Point Position { get; } content: public Point Position { get; }
parameters: [] parameters: []
@ -181,10 +190,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: U id: U
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 11 startLine: 26
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe x coordinate of the top left corner of this texture region\n"
example: []
syntax: syntax:
content: public int U { get; } content: public int U { get; }
parameters: [] parameters: []
@ -216,10 +227,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: V id: V
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 12 startLine: 30
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe y coordinate of the top left corner of this texture region\n"
example: []
syntax: syntax:
content: public int V { get; } content: public int V { get; }
parameters: [] parameters: []
@ -251,10 +264,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Size id: Size
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 13 startLine: 34
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe size of this texture region\n"
example: []
syntax: syntax:
content: public Point Size { get; } content: public Point Size { get; }
parameters: [] parameters: []
@ -286,10 +301,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Width id: Width
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 14 startLine: 38
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe width of this texture region\n"
example: []
syntax: syntax:
content: public int Width { get; } content: public int Width { get; }
parameters: [] parameters: []
@ -321,10 +338,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Height id: Height
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 15 startLine: 42
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe height of this texture region\n"
example: []
syntax: syntax:
content: public int Height { get; } content: public int Height { get; }
parameters: [] parameters: []
@ -356,17 +375,21 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 17 startLine: 49
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new texture region from a texture and a rectangle which defines the region&apos;s area\n"
example: []
syntax: syntax:
content: public TextureRegion(Texture2D texture, Rectangle area) content: public TextureRegion(Texture2D texture, Rectangle area)
parameters: parameters:
- id: texture - id: texture
type: Microsoft.Xna.Framework.Graphics.Texture2D type: Microsoft.Xna.Framework.Graphics.Texture2D
description: The texture to use
- id: area - id: area
type: Microsoft.Xna.Framework.Rectangle 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) content.vb: Public Sub New(texture As Texture2D, area As Rectangle)
overload: MLEM.Textures.TextureRegion.#ctor* overload: MLEM.Textures.TextureRegion.#ctor*
modifiers.csharp: modifiers.csharp:
@ -391,15 +414,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 22 startLine: 58
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new texture region that spans the entire texture\n"
example: []
syntax: syntax:
content: public TextureRegion(Texture2D texture) content: public TextureRegion(Texture2D texture)
parameters: parameters:
- id: texture - id: texture
type: Microsoft.Xna.Framework.Graphics.Texture2D type: Microsoft.Xna.Framework.Graphics.Texture2D
description: The texture to use
content.vb: Public Sub New(texture As Texture2D) content.vb: Public Sub New(texture As Texture2D)
overload: MLEM.Textures.TextureRegion.#ctor* overload: MLEM.Textures.TextureRegion.#ctor*
modifiers.csharp: modifiers.csharp:
@ -424,23 +450,30 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 25 startLine: 69
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new texture region based on a texture and area coordinates\n"
example: []
syntax: syntax:
content: public TextureRegion(Texture2D texture, int u, int v, int width, int height) content: public TextureRegion(Texture2D texture, int u, int v, int width, int height)
parameters: parameters:
- id: texture - id: texture
type: Microsoft.Xna.Framework.Graphics.Texture2D type: Microsoft.Xna.Framework.Graphics.Texture2D
description: The texture to use
- id: u - id: u
type: System.Int32 type: System.Int32
description: The x coordinate of the top left corner of this area
- id: v - id: v
type: System.Int32 type: System.Int32
description: The y coordinate of the top left corner of this area
- id: width - id: width
type: System.Int32 type: System.Int32
description: The width of this area
- id: height - id: height
type: System.Int32 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) 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* overload: MLEM.Textures.TextureRegion.#ctor*
modifiers.csharp: modifiers.csharp:
@ -465,19 +498,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 28 startLine: 78
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new texture region based on a texture, a position and a size\n"
example: []
syntax: syntax:
content: public TextureRegion(Texture2D texture, Point uv, Point size) content: public TextureRegion(Texture2D texture, Point uv, Point size)
parameters: parameters:
- id: texture - id: texture
type: Microsoft.Xna.Framework.Graphics.Texture2D type: Microsoft.Xna.Framework.Graphics.Texture2D
description: The texture to use
- id: uv - id: uv
type: Microsoft.Xna.Framework.Point type: Microsoft.Xna.Framework.Point
description: The top left corner of this area
- id: size - id: size
type: Microsoft.Xna.Framework.Point 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) content.vb: Public Sub New(texture As Texture2D, uv As Point, size As Point)
overload: MLEM.Textures.TextureRegion.#ctor* overload: MLEM.Textures.TextureRegion.#ctor*
modifiers.csharp: modifiers.csharp:

View file

@ -26,10 +26,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: TextureRegionExtensions id: TextureRegionExtensions
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 33 startLine: 86
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThis class provides a set of extension methods for dealing with <xref href=\"MLEM.Textures.TextureRegion\" data-throw-if-not-resolved=\"false\"></xref>\n"
example: []
syntax: syntax:
content: public static class TextureRegionExtensions content: public static class TextureRegionExtensions
content.vb: Public Module TextureRegionExtensions content.vb: Public Module TextureRegionExtensions
@ -69,10 +71,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 35 startLine: 89
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: 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) 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: parameters:
@ -124,10 +127,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 39 startLine: 94
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: 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) 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: parameters:
@ -179,10 +183,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 43 startLine: 99
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Rectangle destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth) content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Rectangle destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth)
parameters: parameters:
@ -232,10 +237,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 47 startLine: 104
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public static void Draw(this SpriteBatch batch, TextureRegion texture, RectangleF destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth) content: public static void Draw(this SpriteBatch batch, TextureRegion texture, RectangleF destinationRectangle, Color color, float rotation, Vector2 origin, SpriteEffects effects, float layerDepth)
parameters: parameters:
@ -285,10 +291,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 51 startLine: 109
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Vector2 position, Color color) content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Vector2 position, Color color)
parameters: parameters:
@ -330,10 +337,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 55 startLine: 114
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Rectangle destinationRectangle, Color color) content: public static void Draw(this SpriteBatch batch, TextureRegion texture, Rectangle destinationRectangle, Color color)
parameters: parameters:
@ -375,10 +383,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Draw id: Draw
path: ../MLEM/Textures/TextureRegion.cs path: ../MLEM/Textures/TextureRegion.cs
startLine: 59 startLine: 119
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public static void Draw(this SpriteBatch batch, TextureRegion texture, RectangleF destinationRectangle, Color color) content: public static void Draw(this SpriteBatch batch, TextureRegion texture, RectangleF destinationRectangle, Color color)
parameters: parameters:
@ -402,6 +411,12 @@ items:
- Public - Public
- Shared - Shared
references: references:
- uid: MLEM.Textures.TextureRegion
commentId: T:MLEM.Textures.TextureRegion
parent: MLEM.Textures
name: TextureRegion
nameWithType: TextureRegion
fullName: MLEM.Textures.TextureRegion
- uid: MLEM.Textures - uid: MLEM.Textures
commentId: N:MLEM.Textures commentId: N:MLEM.Textures
name: MLEM.Textures name: MLEM.Textures
@ -699,6 +714,9 @@ references:
name: System name: System
nameWithType: System nameWithType: System
fullName: 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* - uid: MLEM.Textures.TextureRegionExtensions.Draw*
commentId: Overload:MLEM.Textures.TextureRegionExtensions.Draw commentId: Overload:MLEM.Textures.TextureRegionExtensions.Draw
name: Draw name: Draw
@ -711,12 +729,6 @@ references:
name: SpriteBatch name: SpriteBatch
nameWithType: SpriteBatch nameWithType: SpriteBatch
fullName: Microsoft.Xna.Framework.Graphics.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 - uid: Microsoft.Xna.Framework.Vector2
commentId: T:Microsoft.Xna.Framework.Vector2 commentId: T:Microsoft.Xna.Framework.Vector2
parent: Microsoft.Xna.Framework parent: Microsoft.Xna.Framework

View file

@ -30,14 +30,17 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: UniformTextureAtlas id: UniformTextureAtlas
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 7 startLine: 12
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThis class represents an atlas of <xref href=\"MLEM.Textures.TextureRegion\" data-throw-if-not-resolved=\"false\"></xref> objects that is uniform.\nUniform, in this case, means that the texture atlas&apos; 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: syntax:
content: 'public class UniformTextureAtlas : GenericDataHolder' content: 'public class UniformTextureAtlas : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class UniformTextureAtlas Public Class UniformTextureAtlas
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -77,10 +80,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: Texture id: Texture
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 9 startLine: 17
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe texture to use for this atlas\n"
example: []
syntax: syntax:
content: public readonly Texture2D Texture content: public readonly Texture2D Texture
return: return:
@ -110,10 +115,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RegionAmountX id: RegionAmountX
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 10 startLine: 21
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe amount of sub-regions this atlas has in the x direction\n"
example: []
syntax: syntax:
content: public readonly int RegionAmountX content: public readonly int RegionAmountX
return: return:
@ -143,10 +150,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RegionAmountY id: RegionAmountY
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 11 startLine: 25
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe amount of sub-regions this atlas has in the y direction\n"
example: []
syntax: syntax:
content: public readonly int RegionAmountY content: public readonly int RegionAmountY
return: return:
@ -176,10 +185,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RegionWidth id: RegionWidth
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 12 startLine: 29
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe width of each region, based on the texture&apos;s width and the amount of regions\n"
example: []
syntax: syntax:
content: public readonly int RegionWidth content: public readonly int RegionWidth
return: return:
@ -209,10 +220,12 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: RegionHeight id: RegionHeight
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 13 startLine: 33
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nThe height of reach region, based on the texture&apos;s height and the amount of regions\n"
example: []
syntax: syntax:
content: public readonly int RegionHeight content: public readonly int RegionHeight
return: return:
@ -242,15 +255,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: this[] id: this[]
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 14 startLine: 39
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nReturns the <xref href=\"MLEM.Textures.TextureRegion\" data-throw-if-not-resolved=\"false\"></xref> at this texture atlas&apos;s given index.\nThe index is zero-based, where rows come first and columns come second.\n"
example: []
syntax: syntax:
content: public TextureRegion this[int index] { get; } content: public TextureRegion this[int index] { get; }
parameters: parameters:
- id: index - id: index
type: System.Int32 type: System.Int32
description: The zero-based texture index
return: return:
type: MLEM.Textures.TextureRegion type: MLEM.Textures.TextureRegion
content.vb: Public ReadOnly Property Item(index As Integer) As TextureRegion content.vb: Public ReadOnly Property Item(index As Integer) As TextureRegion
@ -282,15 +298,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: this[] id: this[]
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 15 startLine: 44
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nReturns the <xref href=\"MLEM.Textures.TextureRegion\" data-throw-if-not-resolved=\"false\"></xref> at this texture atlas&apos; given region position\n"
example: []
syntax: syntax:
content: public TextureRegion this[Point point] { get; } content: public TextureRegion this[Point point] { get; }
parameters: parameters:
- id: point - id: point
type: Microsoft.Xna.Framework.Point type: Microsoft.Xna.Framework.Point
description: The region&apos;s x and y location
return: return:
type: MLEM.Textures.TextureRegion type: MLEM.Textures.TextureRegion
content.vb: Public ReadOnly Property Item(point As Point) As TextureRegion content.vb: Public ReadOnly Property Item(point As Point) As TextureRegion
@ -322,10 +341,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: this[] id: this[]
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 16 startLine: 46
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public TextureRegion this[int x, int y] { get; } content: public TextureRegion this[int x, int y] { get; }
parameters: parameters:
@ -364,15 +384,18 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: this[] id: this[]
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 17 startLine: 52
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nReturns the <xref href=\"MLEM.Textures.TextureRegion\" data-throw-if-not-resolved=\"false\"></xref> at this texture atlas&apos; given region position and size.\nNote that the region size is not in pixels, but in region units.\n"
example: []
syntax: syntax:
content: public TextureRegion this[Rectangle rect] { get; } content: public TextureRegion this[Rectangle rect] { get; }
parameters: parameters:
- id: rect - id: rect
type: Microsoft.Xna.Framework.Rectangle type: Microsoft.Xna.Framework.Rectangle
description: The region&apos;s area
return: return:
type: MLEM.Textures.TextureRegion type: MLEM.Textures.TextureRegion
content.vb: Public ReadOnly Property Item(rect As Rectangle) As TextureRegion content.vb: Public ReadOnly Property Item(rect As Rectangle) As TextureRegion
@ -404,10 +427,11 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: this[] id: this[]
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 18 startLine: 54
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
example: []
syntax: syntax:
content: public TextureRegion this[int x, int y, int width, int height] { get; } content: public TextureRegion this[int x, int y, int width, int height] { get; }
parameters: parameters:
@ -450,19 +474,24 @@ items:
repo: https://github.com/Ellpeck/MLEM repo: https://github.com/Ellpeck/MLEM
id: .ctor id: .ctor
path: ../MLEM/Textures/UniformTextureAtlas.cs path: ../MLEM/Textures/UniformTextureAtlas.cs
startLine: 22 startLine: 64
assemblies: assemblies:
- MLEM - MLEM
namespace: MLEM.Textures namespace: MLEM.Textures
summary: "\nCreates a new uniform texture atlas with the given texture and region amount.\n"
example: []
syntax: syntax:
content: public UniformTextureAtlas(Texture2D texture, int regionAmountX, int regionAmountY) content: public UniformTextureAtlas(Texture2D texture, int regionAmountX, int regionAmountY)
parameters: parameters:
- id: texture - id: texture
type: Microsoft.Xna.Framework.Graphics.Texture2D type: Microsoft.Xna.Framework.Graphics.Texture2D
description: The texture to use for this atlas
- id: regionAmountX - id: regionAmountX
type: System.Int32 type: System.Int32
description: The amount of texture regions in the x direction
- id: regionAmountY - id: regionAmountY
type: System.Int32 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) content.vb: Public Sub New(texture As Texture2D, regionAmountX As Integer, regionAmountY As Integer)
overload: MLEM.Textures.UniformTextureAtlas.#ctor* overload: MLEM.Textures.UniformTextureAtlas.#ctor*
modifiers.csharp: modifiers.csharp:
@ -470,6 +499,12 @@ items:
modifiers.vb: modifiers.vb:
- Public - Public
references: references:
- uid: MLEM.Textures.TextureRegion
commentId: T:MLEM.Textures.TextureRegion
parent: MLEM.Textures
name: TextureRegion
nameWithType: TextureRegion
fullName: MLEM.Textures.TextureRegion
- uid: MLEM.Textures - uid: MLEM.Textures
commentId: N:MLEM.Textures commentId: N:MLEM.Textures
name: MLEM.Textures name: MLEM.Textures
@ -928,12 +963,6 @@ references:
name: Item name: Item
nameWithType: UniformTextureAtlas.Item nameWithType: UniformTextureAtlas.Item
fullName: MLEM.Textures.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 - uid: Microsoft.Xna.Framework.Point
commentId: T:Microsoft.Xna.Framework.Point commentId: T:Microsoft.Xna.Framework.Point
parent: Microsoft.Xna.Framework parent: Microsoft.Xna.Framework
@ -947,6 +976,9 @@ references:
name: Microsoft.Xna.Framework name: Microsoft.Xna.Framework
nameWithType: Microsoft.Xna.Framework nameWithType: Microsoft.Xna.Framework
fullName: 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 - uid: Microsoft.Xna.Framework.Rectangle
commentId: T:Microsoft.Xna.Framework.Rectangle commentId: T:Microsoft.Xna.Framework.Rectangle
parent: Microsoft.Xna.Framework parent: Microsoft.Xna.Framework
@ -954,6 +986,9 @@ references:
name: Rectangle name: Rectangle
nameWithType: Rectangle nameWithType: Rectangle
fullName: Microsoft.Xna.Framework.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* - uid: MLEM.Textures.UniformTextureAtlas.#ctor*
commentId: Overload:MLEM.Textures.UniformTextureAtlas.#ctor commentId: Overload:MLEM.Textures.UniformTextureAtlas.#ctor
name: UniformTextureAtlas name: UniformTextureAtlas

View file

@ -39,6 +39,7 @@ items:
content: 'public class Button : Element' content: 'public class Button : Element'
content.vb: >- content.vb: >-
Public Class Button Public Class Button
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -39,6 +39,7 @@ items:
content: 'public class Checkbox : Element' content: 'public class Checkbox : Element'
content.vb: >- content.vb: >-
Public Class Checkbox Public Class Checkbox
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -33,6 +33,7 @@ items:
content: 'public class CustomDrawGroup : Group' content: 'public class CustomDrawGroup : Group'
content.vb: >- content.vb: >-
Public Class CustomDrawGroup Public Class CustomDrawGroup
Inherits Group Inherits Group
inheritance: inheritance:
- System.Object - System.Object

View file

@ -34,6 +34,7 @@ items:
content: 'public class Dropdown : Button' content: 'public class Dropdown : Button'
content.vb: >- content.vb: >-
Public Class Dropdown Public Class Dropdown
Inherits Button Inherits Button
inheritance: inheritance:
- System.Object - System.Object

View file

@ -109,6 +109,7 @@ items:
content: 'public abstract class Element : GenericDataHolder' content: 'public abstract class Element : GenericDataHolder'
content.vb: >- content.vb: >-
Public MustInherit Class Element Public MustInherit Class Element
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object
@ -1941,6 +1942,7 @@ items:
syntax: syntax:
content: >- content: >-
public T AddChild<T>(T element, int index = -1) public T AddChild<T>(T element, int index = -1)
where T : Element where T : Element
parameters: parameters:
- id: element - id: element
@ -2499,6 +2501,7 @@ items:
syntax: syntax:
content: >- content: >-
public IEnumerable<T> GetChildren<T>(Func<T, bool> condition = null, bool regardGrandchildren = false, bool ignoreFalseGrandchildren = false) public IEnumerable<T> GetChildren<T>(Func<T, bool> condition = null, bool regardGrandchildren = false, bool ignoreFalseGrandchildren = false)
where T : Element where T : Element
parameters: parameters:
- id: condition - id: condition

View file

@ -29,6 +29,7 @@ items:
content: 'public class Group : Element' content: 'public class Group : Element'
content.vb: >- content.vb: >-
Public Class Group Public Class Group
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -39,6 +39,7 @@ items:
content: 'public class Image : Element' content: 'public class Image : Element'
content.vb: >- content.vb: >-
Public Class Image Public Class Image
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -38,6 +38,7 @@ items:
content: 'public class Panel : Element' content: 'public class Panel : Element'
content.vb: >- content.vb: >-
Public Class Panel Public Class Panel
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -31,6 +31,7 @@ items:
content: 'public class Link : Element' content: 'public class Link : Element'
content.vb: >- content.vb: >-
Public Class Link Public Class Link
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -47,6 +47,7 @@ items:
content: 'public class Paragraph : Element' content: 'public class Paragraph : Element'
content.vb: >- content.vb: >-
Public Class Paragraph Public Class Paragraph
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -38,6 +38,7 @@ items:
content: 'public class ProgressBar : Element' content: 'public class ProgressBar : Element'
content.vb: >- content.vb: >-
Public Class ProgressBar Public Class ProgressBar
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -30,6 +30,7 @@ items:
content: 'public class RadioButton : Checkbox' content: 'public class RadioButton : Checkbox'
content.vb: >- content.vb: >-
Public Class RadioButton Public Class RadioButton
Inherits Checkbox Inherits Checkbox
inheritance: inheritance:
- System.Object - System.Object

View file

@ -44,6 +44,7 @@ items:
content: 'public class ScrollBar : Element' content: 'public class ScrollBar : Element'
content.vb: >- content.vb: >-
Public Class ScrollBar Public Class ScrollBar
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -29,6 +29,7 @@ items:
content: 'public class Slider : ScrollBar' content: 'public class Slider : ScrollBar'
content.vb: >- content.vb: >-
Public Class Slider Public Class Slider
Inherits ScrollBar Inherits ScrollBar
inheritance: inheritance:
- System.Object - System.Object

View file

@ -31,6 +31,7 @@ items:
content: 'public class SpriteAnimationImage : Image' content: 'public class SpriteAnimationImage : Image'
content.vb: >- content.vb: >-
Public Class SpriteAnimationImage Public Class SpriteAnimationImage
Inherits Image Inherits Image
inheritance: inheritance:
- System.Object - System.Object

View file

@ -54,6 +54,7 @@ items:
content: 'public class TextField : Element' content: 'public class TextField : Element'
content.vb: >- content.vb: >-
Public Class TextField Public Class TextField
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -34,6 +34,7 @@ items:
content: 'public class Tooltip : Panel' content: 'public class Tooltip : Panel'
content.vb: >- content.vb: >-
Public Class Tooltip Public Class Tooltip
Inherits Panel Inherits Panel
inheritance: inheritance:
- System.Object - System.Object

View file

@ -28,6 +28,7 @@ items:
content: 'public class VerticalSpace : Element' content: 'public class VerticalSpace : Element'
content.vb: >- content.vb: >-
Public Class VerticalSpace Public Class VerticalSpace
Inherits Element Inherits Element
inheritance: inheritance:
- System.Object - System.Object

View file

@ -60,6 +60,7 @@ items:
content: 'public class UiStyle : GenericDataHolder' content: 'public class UiStyle : GenericDataHolder'
content.vb: >- content.vb: >-
Public Class UiStyle Public Class UiStyle
Inherits GenericDataHolder Inherits GenericDataHolder
inheritance: inheritance:
- System.Object - System.Object

View file

@ -28,6 +28,7 @@ items:
content: 'public class UntexturedStyle : UiStyle' content: 'public class UntexturedStyle : UiStyle'
content.vb: >- content.vb: >-
Public Class UntexturedStyle Public Class UntexturedStyle
Inherits UiStyle Inherits UiStyle
inheritance: inheritance:
- System.Object - System.Object

View file

@ -62,7 +62,9 @@ items:
content: 'public class UiSystem : GameComponent, IGameComponent, IUpdateable, IComparable<GameComponent>, IDisposable' content: 'public class UiSystem : GameComponent, IGameComponent, IUpdateable, IComparable<GameComponent>, IDisposable'
content.vb: >- content.vb: >-
Public Class UiSystem Public Class UiSystem
Inherits GameComponent Inherits GameComponent
Implements IGameComponent, IUpdateable, IComparable(Of GameComponent), IDisposable Implements IGameComponent, IUpdateable, IComparable(Of GameComponent), IDisposable
inheritance: inheritance:
- System.Object - System.Object

Some files were not shown because too many files have changed in this diff Show more