Package com.github.tommyettinger.textra
Interface TypingListener
- All Known Implementing Classes:
TypingAdapter
public interface TypingListener
Simple listener for label events.
-
Method Summary
Modifier and TypeMethodDescriptionvoid
end()
Called when the char progression reaches the end.void
Called each time anEVENT
token is processed.void
onChar
(long ch) Called when a new character is displayed.replaceVariable
(String variable) Called when variable tokens are replaced in text.
-
Method Details
-
event
Called each time anEVENT
token is processed.- Parameters:
event
- Name of the event specified in the token. e.g.{EVENT=player_name}
will haveplayer_name
as argument.
-
end
void end()Called when the char progression reaches the end. -
replaceVariable
Called when variable tokens are replaced in text. This is an alternative method to deal with variables, other than directly assigning replacement values to the label. Replacements returned by this method have priority over direct values, unlessnull
is returned.- Parameters:
variable
- The variable name assigned to the{VAR}
token. For example, in{VAR=townName}
, the variable will betownName
- Returns:
- The replacement String, or
null
if this method should be ignored and the regular values should be used instead. - See Also:
-
onChar
void onChar(long ch) Called when a new character is displayed. May be called many times per frame depending on the label configurations and text speed. Useful to do a certain action each time a character is displayed, like playing a sound effect.
-