com.github.tommyettinger.textra

Class TypingLabel

java.lang.Object

com.badlogic.gdx.scenes.scene2d.Actor

com.badlogic.gdx.scenes.scene2d.ui.Widget

com.github.tommyettinger.textra.TextraLabel

com.github.tommyettinger.textra.TypingLabel

All Implemented Interfaces:

com.badlogic.gdx.scenes.scene2d.utils.Layout

public class TypingLabel
extends TextraLabel

An extension of Label that progressively shows the text as if it was being typed in real time, and allows the use of tokens in the following format: {TOKEN=PARAMETER}.

Field Summary

Fields

Modifier and Type	Field and Description
protected com.badlogic.gdx.utils.Array<Effect>	activeEffects
com.badlogic.gdx.utils.FloatArray	offsets Contains two floats per glyph; even items are x offsets, odd items are y offsets.
com.badlogic.gdx.utils.FloatArray	rotations Contains one float per glyph; each is a rotation in degrees to apply to that glyph (around its center).
com.badlogic.gdx.utils.FloatArray	sizing Contains two floats per glyph, as size multipliers; even items apply to x, odd items apply to y.
protected com.badlogic.gdx.utils.Array<com.github.tommyettinger.textra.TokenEntry>	tokenEntries
protected Layout	workingLayout

Fields inherited from class com.github.tommyettinger.textra.TextraLabel

align, font, layout, storedText, style, wrap

Constructor Summary

Constructors

Constructor and Description
TypingLabel()
TypingLabel(java.lang.String text, Font font)
TypingLabel(java.lang.String text, Font font, com.badlogic.gdx.graphics.Color color)
TypingLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style)
TypingLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style, Font replacementFont)
TypingLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin)
TypingLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, Font replacementFont)
TypingLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName)
TypingLabel(java.lang.String text, com.badlogic.gdx.scenes.scene2d.ui.Skin skin, java.lang.String styleName, Font replacementFont)

Method Summary

Modifier and Type	Method and Description
void	act(float delta)
void	cancelSkipping() Cancels calls to skipToTheEnd().
void	clearVariables() Removes all variables from this label.
void	draw(com.badlogic.gdx.graphics.g2d.Batch batch, float parentAlpha) If your font uses Font.DistanceFieldType.SDF or Font.DistanceFieldType.MSDF, then this has to do some extra work to use the appropriate shader.
com.badlogic.gdx.graphics.Color	getClearColor() Returns a Color instance with the color to be used on CLEARCOLOR tokens.
java.lang.String	getDefaultToken() Returns the default token being used in this label.
long	getFromIntermediate(int index)
long	getInLayout(Layout layout, int index)
java.lang.StringBuilder	getIntermediateText()
float	getLineHeight(int index)
Line	getLineInLayout(Layout layout, int index)
java.lang.StringBuilder	getOriginalText() Similar to Layout.toString(), but returns the original text with all the tokens unchanged.
TypingListener	getTypingListener() Returns the TypingListener associated with this label.
com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.String>	getVariables() Returns an ObjectMap with all the variable names and their respective replacement values.
boolean	hasEnded() Returns whether or not this label's char progression has ended.
boolean	isPaused() Returns whether or not this label is paused.
boolean	isSkipping() Returns whether or not this label is currently skipping its typing progression all the way to the end.
void	layout()
void	parseTokens() Parses all tokens of this label.
void	pause() Pauses this label's character progression.
boolean	remove()
void	restart() Restarts this label with the original text and starts the char progression right away.
void	restart(java.lang.String newText) Restarts this label with the given text and starts the char progression right away.
protected void	restoreOriginalText() Restores the original text with all tokens unchanged to this label.
void	resume() Resumes this label's character progression.
protected void	saveOriginalText(java.lang.CharSequence text) Copies the content of getOriginalText() to the StringBuilder containing the original text with all tokens unchanged.
void	setDefaultToken(java.lang.String defaultToken) Sets the default token being used in this label.
void	setInLayout(Layout layout, int index, long newGlyph)
void	setIntermediateText(java.lang.CharSequence text, boolean modifyOriginalText, boolean restart)
void	setInWorkingLayout(int index, long newGlyph)
void	setSize(float width, float height)
void	setText(java.lang.String newText) Modifies the text of this label.
protected void	setText(java.lang.String newText, boolean modifyOriginalText) Sets the text of this label.
protected void	setText(java.lang.String newText, boolean modifyOriginalText, boolean restart) Sets the text of this label.
void	setTypingListener(TypingListener listener) Sets the TypingListener associated with this label, or null to remove the current one.
void	setVariable(java.lang.String var, java.lang.String value) Registers a variable and its respective replacement value to this label.
void	setVariables(java.util.Map<java.lang.String,java.lang.String> variableMap) Registers a set of variables and their respective replacement values to this label.
void	setVariables(com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.String> variableMap) Registers a set of variables and their respective replacement values to this label.
void	skipToTheEnd() Skips the char progression to the end, showing the entire label.
void	skipToTheEnd(boolean ignoreEvents) Skips the char progression to the end, showing the entire label.
void	skipToTheEnd(boolean ignoreEvents, boolean ignoreEffects) Skips the char progression to the end, showing the entire label.
java.lang.String	toString()

Methods inherited from class com.github.tommyettinger.textra.TextraLabel

getAlignment, getPrefHeight, getPrefWidth, isWrap, setAlignment, setWrap, useIntegerPositions

Methods inherited from class com.badlogic.gdx.scenes.scene2d.ui.Widget

getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, invalidate, invalidateHierarchy, needsLayout, pack, setFillParent, setLayoutEnabled, sizeChanged, validate

Methods inherited from class com.badlogic.gdx.scenes.scene2d.Actor

addAction, addCaptureListener, addListener, ancestorsVisible, ascendantsVisible, clear, clearActions, clearListeners, clipBegin, clipBegin, clipEnd, debug, drawDebug, drawDebugBounds, fire, firstAscendant, getActions, getCaptureListeners, getColor, getDebug, getHeight, getListeners, getName, getOriginX, getOriginY, getParent, getRight, getRotation, getScaleX, getScaleY, getStage, getTop, getTouchable, getUserObject, getWidth, getX, getX, getY, getY, getZIndex, hasActions, hasKeyboardFocus, hasParent, hasScrollFocus, hit, isAscendantOf, isDescendantOf, isTouchable, isTouchFocusListener, isTouchFocusTarget, isVisible, localToActorCoordinates, localToAscendantCoordinates, localToParentCoordinates, localToScreenCoordinates, localToStageCoordinates, moveBy, notify, parentToLocalCoordinates, positionChanged, removeAction, removeCaptureListener, removeListener, rotateBy, rotationChanged, scaleBy, scaleBy, scaleChanged, screenToLocalCoordinates, setBounds, setColor, setColor, setDebug, setHeight, setName, setOrigin, setOrigin, setOriginX, setOriginY, setParent, setPosition, setPosition, setRotation, setScale, setScale, setScaleX, setScaleY, setStage, setTouchable, setUserObject, setVisible, setWidth, setX, setX, setY, setY, setZIndex, sizeBy, sizeBy, stageToLocalCoordinates, toBack, toFront

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

tokenEntries

protected final com.badlogic.gdx.utils.Array<com.github.tommyettinger.textra.TokenEntry> tokenEntries

workingLayout

protected final Layout workingLayout

offsets

public final com.badlogic.gdx.utils.FloatArray offsets

Contains two floats per glyph; even items are x offsets, odd items are y offsets.

sizing

public final com.badlogic.gdx.utils.FloatArray sizing

Contains two floats per glyph, as size multipliers; even items apply to x, odd items apply to y.

rotations

public final com.badlogic.gdx.utils.FloatArray rotations

Contains one float per glyph; each is a rotation in degrees to apply to that glyph (around its center).

activeEffects

protected final com.badlogic.gdx.utils.Array<Effect> activeEffects

Constructor Detail

TypingLabel

public TypingLabel()

TypingLabel

public TypingLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin)

TypingLabel

public TypingLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   Font replacementFont)

TypingLabel

public TypingLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName)

TypingLabel

public TypingLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Skin skin,
                   java.lang.String styleName,
                   Font replacementFont)

TypingLabel

public TypingLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style)

TypingLabel

public TypingLabel(java.lang.String text,
                   com.badlogic.gdx.scenes.scene2d.ui.Label.LabelStyle style,
                   Font replacementFont)

TypingLabel

public TypingLabel(java.lang.String text,
                   Font font)

TypingLabel

public TypingLabel(java.lang.String text,
                   Font font,
                   com.badlogic.gdx.graphics.Color color)

Method Detail

setText

public void setText(java.lang.String newText)

Modifies the text of this label. If the char progression is already running, it's highly recommended to use restart(String) instead.

Overrides:

setText in class TextraLabel

Parameters:

newText - a String that can contain Font markup

setText

protected void setText(java.lang.String newText,
                       boolean modifyOriginalText)

Sets the text of this label.

Parameters:

modifyOriginalText - Flag determining if the original text should be modified as well. If false, only the display text is changed while the original text is untouched. If true, then this runs Parser.preprocess(CharSequence) on the text, which should only generally be run once per original text.

See Also:

restart(String)

setText

protected void setText(java.lang.String newText,
                       boolean modifyOriginalText,
                       boolean restart)

Sets the text of this label.

Parameters:

modifyOriginalText - Flag determining if the original text should be modified as well. If false, only the display text is changed while the original text is untouched.

restart - Whether this label should restart. Defaults to true.

See Also:

restart(String)

getOriginalText

public java.lang.StringBuilder getOriginalText()

Similar to Layout.toString(), but returns the original text with all the tokens unchanged.

saveOriginalText

protected void saveOriginalText(java.lang.CharSequence text)

Copies the content of getOriginalText() to the StringBuilder containing the original text with all tokens unchanged.

restoreOriginalText

protected void restoreOriginalText()

Restores the original text with all tokens unchanged to this label. Make sure to call parseTokens() to parse the tokens again.

getTypingListener

public TypingListener getTypingListener()

Returns the TypingListener associated with this label. May be null.

setTypingListener

public void setTypingListener(TypingListener listener)

Sets the TypingListener associated with this label, or null to remove the current one.

getClearColor

public com.badlogic.gdx.graphics.Color getClearColor()

Returns a Color instance with the color to be used on CLEARCOLOR tokens. Modify this instance to change the token color. Default value is specified by TypingConfig.

See Also:

TypingConfig.DEFAULT_CLEAR_COLOR

getDefaultToken

public java.lang.String getDefaultToken()

Returns the default token being used in this label. Defaults to empty string.

setDefaultToken

public void setDefaultToken(java.lang.String defaultToken)

Sets the default token being used in this label. This token will be used before the label's text, and after each {RESET} call. Useful if you want a certain token to be active at all times without having to type it all the time.

parseTokens

public void parseTokens()

Parses all tokens of this label. Use this after setting the text and any variables that should be replaced.

skipToTheEnd

public void skipToTheEnd()

Skips the char progression to the end, showing the entire label. Useful for when users don't want to wait for too long. Ignores all subsequent events by default.

skipToTheEnd

public void skipToTheEnd(boolean ignoreEvents)

Skips the char progression to the end, showing the entire label. Useful for when users don't want to wait for too long.

Parameters:

ignoreEvents - If true, skipped events won't be reported to the listener.

skipToTheEnd

public void skipToTheEnd(boolean ignoreEvents,
                         boolean ignoreEffects)

Skips the char progression to the end, showing the entire label. Useful for when users don't want to wait for too long.

Parameters:

ignoreEvents - If true, skipped events won't be reported to the listener.

ignoreEffects - If true, all text effects will be instantly cancelled.

cancelSkipping

public void cancelSkipping()

Cancels calls to skipToTheEnd(). Useful if you need to restore the label's normal behavior at some event after skipping.

isSkipping

public boolean isSkipping()

Returns whether or not this label is currently skipping its typing progression all the way to the end. This is only true if skipToTheEnd is called.

isPaused

public boolean isPaused()

Returns whether or not this label is paused.

pause

public void pause()

Pauses this label's character progression.

resume

public void resume()

Resumes this label's character progression.

hasEnded

public boolean hasEnded()

Returns whether or not this label's char progression has ended.

restart

public void restart()

Restarts this label with the original text and starts the char progression right away. All tokens are automatically parsed.

restart

public void restart(java.lang.String newText)

Restarts this label with the given text and starts the char progression right away. All tokens are automatically parsed.

getVariables

public com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.String> getVariables()

Returns an ObjectMap with all the variable names and their respective replacement values.

setVariable

public void setVariable(java.lang.String var,
                        java.lang.String value)

Registers a variable and its respective replacement value to this label.

setVariables

public void setVariables(com.badlogic.gdx.utils.ObjectMap<java.lang.String,java.lang.String> variableMap)

Registers a set of variables and their respective replacement values to this label.

setVariables

public void setVariables(java.util.Map<java.lang.String,java.lang.String> variableMap)

Registers a set of variables and their respective replacement values to this label.

clearVariables

public void clearVariables()

Removes all variables from this label.

act

public void act(float delta)

Overrides:

act in class com.badlogic.gdx.scenes.scene2d.Actor

remove

public boolean remove()

Overrides:

remove in class com.badlogic.gdx.scenes.scene2d.Actor

setSize

public void setSize(float width,
                    float height)

Overrides:

setSize in class TextraLabel

layout

public void layout()

Specified by:

layout in interface com.badlogic.gdx.scenes.scene2d.utils.Layout

Overrides:

layout in class TextraLabel

draw

public void draw(com.badlogic.gdx.graphics.g2d.Batch batch,
                 float parentAlpha)

If your font uses Font.DistanceFieldType.SDF or Font.DistanceFieldType.MSDF, then this has to do some extra work to use the appropriate shader. If Font.enableShader(Batch) was called before rendering a group of TypingLabels, then they will try to share one Batch; otherwise this will change the shader to render SDF or MSDF, then change it back at the end of each draw() call.

Overrides:

draw in class TextraLabel

Parameters:

batch -

parentAlpha -

toString

public java.lang.String toString()

Overrides:

toString in class com.badlogic.gdx.scenes.scene2d.Actor

setIntermediateText

public void setIntermediateText(java.lang.CharSequence text,
                                boolean modifyOriginalText,
                                boolean restart)

getIntermediateText

public java.lang.StringBuilder getIntermediateText()

getInLayout

public long getInLayout(Layout layout,
                        int index)

getLineInLayout

public Line getLineInLayout(Layout layout,
                            int index)

getLineHeight

public float getLineHeight(int index)

getFromIntermediate

public long getFromIntermediate(int index)

setInLayout

public void setInLayout(Layout layout,
                        int index,
                        long newGlyph)

setInWorkingLayout

public void setInWorkingLayout(int index,
                               long newGlyph)