Class ImageCode

Namespace

MLEM.Formatting.Codes

Assembly

MLEM.dll

An instance of a formatting code that can be used for a TextFormatter. To add a new formatting code, see Codes

public class ImageCode : Code, IGenericDataHolder

Inheritance

object

GenericDataHolder

Code

ImageCode

Implements

IGenericDataHolder

Inherited Members

Code.Regex

Code.Match

Code.Tokens

Code.EndsOther(Code)

Code.GetColor(Color)

Code.GetFont(GenericFont)

Code.DrawCharacter(GameTime, SpriteBatch, int, string, Token, int, Vector2, ref Vector2, GenericFont, ref Color, ref Vector2, ref float, ref Vector2, float, SpriteEffects, Vector2, Vector2)

GenericDataHolder.SetData<T>(string, T)

GenericDataHolder.GetData<T>(string)

GenericDataHolder.GetDataKeys()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

ImageCode(Match, Regex, SpriteAnimation, bool)

public ImageCode(Match match, Regex regex, SpriteAnimation image, bool copyTextColor)

Parameters

match Match

regex Regex

image SpriteAnimation

copyTextColor bool

Methods

DrawSelf(GameTime, SpriteBatch, Token, Vector2, Vector2, GenericFont, Color, Vector2, float, Vector2, float, SpriteEffects, Vector2)

Draws the token itself, including all of the Code instances that this token contains. Note that, to draw the token's actual string, DrawCharacter(GameTime, SpriteBatch, int, string, int, Vector2, Vector2, GenericFont, Color, Vector2, float, Vector2, float, SpriteEffects, Vector2, Vector2) is used.

public override void DrawSelf(GameTime time, SpriteBatch batch, Token token, Vector2 stringPos, Vector2 charPosOffset, GenericFont font, Color color, Vector2 scale, float rotation, Vector2 origin, float depth, SpriteEffects effects, Vector2 stringSize)

Parameters

time GameTime

The time

batch SpriteBatch

The sprite batch to use

token Token

stringPos Vector2

The position the string is drawn at.

charPosOffset Vector2

The offset from the stringPos that the current character is drawn at.

font GenericFont

The font to use to draw

color Color

The color to draw with

scale Vector2

The scale to draw with.

rotation float

The rotation to draw with.

origin Vector2

The origin to subtract from the position.

depth float

The depth to draw at

effects SpriteEffects

The flipping to draw with.

stringSize Vector2

The size of the string.

EndsHere(Code)

Returns whether this formatting code should end when the passed formatting code starts. If this method returns true, a new Token is started at its position. This is the opposite version of EndsOther(Code).

public override bool EndsHere(Code other)

Parameters

other Code

The code that is started here.

Returns

bool

If this code should end here.

GetSelfWidth(GenericFont)

Returns the width of the token itself, including all of the Code instances that this token contains. Note that this method does not return the width of this token's DisplayString, but only the width that the codes themselves take up.

public override float GetSelfWidth(GenericFont font)

Parameters

font GenericFont

The font to use for calculating the width.

Returns

float

The width of this token itself.

Update(GameTime)

Update this formatting code's animations etc.

public override void Update(GameTime time)

Parameters

time GameTime

The game's time