1
0
Fork 0
mirror of https://github.com/Ellpeck/MLEM.git synced 2024-11-14 10:09:09 +01:00
MLEM/Docs/api/MLEM.Formatting.Codes.ImageCodeExtensions.yml

516 lines
17 KiB
YAML
Raw Normal View History

### YamlMime:ManagedReference
items:
- uid: MLEM.Formatting.Codes.ImageCodeExtensions
commentId: T:MLEM.Formatting.Codes.ImageCodeExtensions
id: ImageCodeExtensions
parent: MLEM.Formatting.Codes
children:
- MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Animations.SpriteAnimation,System.Boolean)
- MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion,System.Boolean)
langs:
- csharp
- vb
name: ImageCodeExtensions
nameWithType: ImageCodeExtensions
fullName: MLEM.Formatting.Codes.ImageCodeExtensions
type: Class
source:
remote:
path: MLEM/Formatting/Codes/ImageCode.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: ImageCodeExtensions
path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 50
assemblies:
- MLEM
namespace: MLEM.Formatting.Codes
summary: A set of extensions that allow easily adding image formatting codes to a text formatter.
example: []
syntax:
content: public static class ImageCodeExtensions
content.vb: Public Module ImageCodeExtensions
inheritance:
- System.Object
inheritedMembers:
- System.Object.ToString
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- uid: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion,System.Boolean)
commentId: M:MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion,System.Boolean)
id: AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Textures.TextureRegion,System.Boolean)
isExtensionMethod: true
parent: MLEM.Formatting.Codes.ImageCodeExtensions
langs:
- csharp
- vb
name: AddImage(TextFormatter, string, TextureRegion, bool)
nameWithType: ImageCodeExtensions.AddImage(TextFormatter, string, TextureRegion, bool)
fullName: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter, string, MLEM.Textures.TextureRegion, bool)
type: Method
source:
remote:
path: MLEM/Formatting/Codes/ImageCode.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: AddImage
path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 59
assemblies:
- MLEM
namespace: MLEM.Formatting.Codes
summary: Adds a new image formatting code to the given text formatter
example: []
syntax:
content: public static void AddImage(this TextFormatter formatter, string name, TextureRegion image, bool copyTextColor = false)
parameters:
- id: formatter
type: MLEM.Formatting.TextFormatter
description: The formatter to add the code to
- id: name
type: System.String
description: The name of the formatting code. The regex for this code will be between angle brackets.
- id: image
type: MLEM.Textures.TextureRegion
description: The image to render at the code's position
- id: copyTextColor
type: System.Boolean
description: Whether or not the image code should use the text's color instead of White
content.vb: Public Shared Sub AddImage(formatter As TextFormatter, name As String, image As TextureRegion, copyTextColor As Boolean = False)
overload: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage*
nameWithType.vb: ImageCodeExtensions.AddImage(TextFormatter, String, TextureRegion, Boolean)
fullName.vb: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter, String, MLEM.Textures.TextureRegion, Boolean)
name.vb: AddImage(TextFormatter, String, TextureRegion, Boolean)
- uid: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Animations.SpriteAnimation,System.Boolean)
commentId: M:MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Animations.SpriteAnimation,System.Boolean)
id: AddImage(MLEM.Formatting.TextFormatter,System.String,MLEM.Animations.SpriteAnimation,System.Boolean)
isExtensionMethod: true
parent: MLEM.Formatting.Codes.ImageCodeExtensions
langs:
- csharp
- vb
name: AddImage(TextFormatter, string, SpriteAnimation, bool)
nameWithType: ImageCodeExtensions.AddImage(TextFormatter, string, SpriteAnimation, bool)
fullName: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter, string, MLEM.Animations.SpriteAnimation, bool)
type: Method
source:
remote:
path: MLEM/Formatting/Codes/ImageCode.cs
branch: main
repo: https://github.com/Ellpeck/MLEM
id: AddImage
path: ../MLEM/Formatting/Codes/ImageCode.cs
startLine: 64
assemblies:
- MLEM
namespace: MLEM.Formatting.Codes
summary: Adds a new image formatting code to the given text formatter
example: []
syntax:
content: public static void AddImage(this TextFormatter formatter, string name, SpriteAnimation image, bool copyTextColor = false)
parameters:
- id: formatter
type: MLEM.Formatting.TextFormatter
description: The formatter to add the code to
- id: name
type: System.String
description: The name of the formatting code. The regex for this code will be between angle brackets.
- id: image
type: MLEM.Animations.SpriteAnimation
description: The image to render at the code's position
- id: copyTextColor
type: System.Boolean
description: Whether or not the image code should use the text's color instead of White
content.vb: Public Shared Sub AddImage(formatter As TextFormatter, name As String, image As SpriteAnimation, copyTextColor As Boolean = False)
overload: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage*
nameWithType.vb: ImageCodeExtensions.AddImage(TextFormatter, String, SpriteAnimation, Boolean)
fullName.vb: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage(MLEM.Formatting.TextFormatter, String, MLEM.Animations.SpriteAnimation, Boolean)
name.vb: AddImage(TextFormatter, String, SpriteAnimation, Boolean)
references:
- uid: MLEM.Formatting.Codes
commentId: N:MLEM.Formatting.Codes
href: MLEM.html
name: MLEM.Formatting.Codes
nameWithType: MLEM.Formatting.Codes
fullName: MLEM.Formatting.Codes
spec.csharp:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Formatting
name: Formatting
href: MLEM.Formatting.html
- name: .
- uid: MLEM.Formatting.Codes
name: Codes
href: MLEM.Formatting.Codes.html
spec.vb:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Formatting
name: Formatting
href: MLEM.Formatting.html
- name: .
- uid: MLEM.Formatting.Codes
name: Codes
href: MLEM.Formatting.Codes.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage*
commentId: Overload:MLEM.Formatting.Codes.ImageCodeExtensions.AddImage
href: MLEM.Formatting.Codes.ImageCodeExtensions.html#MLEM_Formatting_Codes_ImageCodeExtensions_AddImage_MLEM_Formatting_TextFormatter_System_String_MLEM_Textures_TextureRegion_System_Boolean_
name: AddImage
nameWithType: ImageCodeExtensions.AddImage
fullName: MLEM.Formatting.Codes.ImageCodeExtensions.AddImage
- uid: MLEM.Formatting.TextFormatter
commentId: T:MLEM.Formatting.TextFormatter
parent: MLEM.Formatting
href: MLEM.Formatting.TextFormatter.html
name: TextFormatter
nameWithType: TextFormatter
fullName: MLEM.Formatting.TextFormatter
- uid: System.String
commentId: T:System.String
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.string
name: string
nameWithType: string
fullName: string
nameWithType.vb: String
fullName.vb: String
name.vb: String
- uid: MLEM.Textures.TextureRegion
commentId: T:MLEM.Textures.TextureRegion
parent: MLEM.Textures
href: MLEM.Textures.TextureRegion.html
name: TextureRegion
nameWithType: TextureRegion
fullName: MLEM.Textures.TextureRegion
- uid: System.Boolean
commentId: T:System.Boolean
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.boolean
name: bool
nameWithType: bool
fullName: bool
nameWithType.vb: Boolean
fullName.vb: Boolean
name.vb: Boolean
- uid: MLEM.Formatting
commentId: N:MLEM.Formatting
href: MLEM.html
name: MLEM.Formatting
nameWithType: MLEM.Formatting
fullName: MLEM.Formatting
spec.csharp:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Formatting
name: Formatting
href: MLEM.Formatting.html
spec.vb:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Formatting
name: Formatting
href: MLEM.Formatting.html
- uid: MLEM.Textures
commentId: N:MLEM.Textures
href: MLEM.html
name: MLEM.Textures
nameWithType: MLEM.Textures
fullName: MLEM.Textures
spec.csharp:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Textures
name: Textures
href: MLEM.Textures.html
spec.vb:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Textures
name: Textures
href: MLEM.Textures.html
- uid: MLEM.Animations.SpriteAnimation
commentId: T:MLEM.Animations.SpriteAnimation
parent: MLEM.Animations
href: MLEM.Animations.SpriteAnimation.html
name: SpriteAnimation
nameWithType: SpriteAnimation
fullName: MLEM.Animations.SpriteAnimation
- uid: MLEM.Animations
commentId: N:MLEM.Animations
href: MLEM.html
name: MLEM.Animations
nameWithType: MLEM.Animations
fullName: MLEM.Animations
spec.csharp:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Animations
name: Animations
href: MLEM.Animations.html
spec.vb:
- uid: MLEM
name: MLEM
href: MLEM.html
- name: .
- uid: MLEM.Animations
name: Animations
href: MLEM.Animations.html