Package de.gurkenlabs.litiengine.gui

Class SpeechBubble

java.lang.Object

de.gurkenlabs.litiengine.gui.GuiComponent

de.gurkenlabs.litiengine.gui.SpeechBubble

All Implemented Interfaces:

IRenderable, IUpdateable, Tweenable, MouseListener, MouseMotionListener, MouseWheelListener, EventListener

public class SpeechBubble
extends GuiComponent
implements IUpdateable

A SpeechBubble is a GuiComponent with a given text that is pinned to an entity and moves with it. After initializing the speech bubble, you can start it separately, which will add the component to the current screen, register it for updates and make it visible on screen. Stopping the speech bubble will remove the component and deregister its updates.

Field Summary

Fields inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

ICON_FONT

Constructor Summary

Constructors

Constructor	Description
SpeechBubble(IEntity entity, double width, double height, int displayTime, String text)	Instantiates a new Speech bubble.
SpeechBubble(IEntity entity, String text)	Instantiates a new speech bubble.

Method Summary

Modifier and Type	Method	Description
Align	getBoxAlign()	Gets the horizontal speech bubble alignment that dictates its position relative to the entity center point.
int	getDisplayTime()	Gets the duration in milliseconds for which this speech bubble will be active.
IEntity	getEntity()	Gets the entity to which this speech bubble is pinned.
String	getTotalText()	Gets the total text that this Speech bubble will display.
Path2D	getTriangle()	Gets the triangle indicator's shape, translated to the correct location on screen.
double	getTriangleSize()	Gets the triangle indicator size.
int	getTypeDelay()	Gets type delay, which determines how fast the typewriter effect will be.
Sound	getTypeSound()	Gets the sound that is played every time a new letter appears.
boolean	isRenderingTriangle()	Checks if the triangle indicator is active.
void	render(Graphics2D g)	Note: If you override this and are modifying swing components, be sure you are in the AWT thread when you do so!
void	setBoxAlign(Align boxAlign)	Sets the horizontal speech bubble alignment that dictates its position relative to the entity center point.
void	setDisplayTime(int displayTime)	Sets the duration in milliseconds for which this speech bubble will be active.
void	setHeight(double height)	Sets the GuiComponent's height.
void	setLocation(Point2D location)	Sets this GuiComponent's location.
void	setRenderTriangle(boolean renderTriangle)	Sets the visibility status of the triangle indicator.
void	setTriangleSize(double triangleSize)	Gets the triangle indicator size.
void	setTypeDelay(int typeDelay)	Sets type delay, which determines how fast the typewriter effect will be.
void	setTypeSound(Sound typeSound)	Sets the sound that is played every time a new letter appears.
void	setWidth(double width)	Sets the GuiComponent's width.
void	start()	Start the speech bubble.
void	stop()	Stop the speech bubble.
void	update()	This method is called by the game loop on all objects that are attached to the loop.

Methods inherited from class de.gurkenlabs.litiengine.gui.GuiComponent

addRenderedListener, addRenderListener, getAppearance, getAppearanceDisabled, getAppearanceHovered, getBoundingBox, getCenterX, getCenterY, getClickConsumer, getComponentId, getComponents, getCurrentAppearance, getFont, getHeight, getHoverConsumer, getHoverSound, getLocation, getMouseDraggedConsumer, getMouseEnterConsumer, getMouseLeaveConsumer, getMouseMovedConsumer, getMousePressedConsumer, getMouseReleasedConsumer, getMouseWheelConsumer, getName, getShape, getTag, getText, getTextAlign, getTextAngle, getTextShadowColor, getTextShadowRadius, getTextToRender, getTextValign, getTextX, getTextY, getTweenValues, getWidth, getX, getY, hasAutomaticLineBreaks, hasTextAntialiasing, hasTextShadow, initializeComponents, isEnabled, isForwardMouseEvents, isHovered, isPressed, isSelected, isSuspended, isVisible, mouseClicked, mouseDragged, mouseEntered, mouseEventShouldBeForwarded, mouseExited, mouseMoved, mousePressed, mouseReleased, mouseWheelMoved, onClicked, onHovered, onMouseDragged, onMouseEnter, onMouseLeave, onMouseMoved, onMousePressed, onMouseReleased, onMouseWheelScrolled, onTextChanged, prepare, removeListener, removeListener, setAutomaticLineBreaks, setDimension, setEnabled, setFont, setFontSize, setForwardMouseEvents, setHovered, setHoverSound, setLocation, setName, setSelected, setTag, setText, setTextAlign, setTextAngle, setTextAntialiasing, setTextShadow, setTextShadowColor, setTextShadowRadius, setTextValign, setTextX, setTextY, setTweenValues, setVisible, setX, setY, suspend, toggleSelection, toggleSuspension

Methods inherited from class java.lang.Object

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

Constructor Details

SpeechBubble

public SpeechBubble(IEntity entity,
 String text)

Instantiates a new speech bubble.

Parameters:

entity - the entity to which the Speech bubble will be pinned

text - the text which will appear in the speech bubble

SpeechBubble

public SpeechBubble(IEntity entity,
 double width,
 double height,
 int displayTime,
 String text)

Instantiates a new Speech bubble.

Parameters:

entity - the entity to which the Speech bubble will be pinned

width - the width of the text box

height - the height of the text box

displayTime - the display time in milliseconds

text - the text which will appear in the speech bubble

Method Details

getEntity

public IEntity getEntity()

Gets the entity to which this speech bubble is pinned.

Returns:

the entity

getDisplayTime

public int getDisplayTime()

Gets the duration in milliseconds for which this speech bubble will be active.

Returns:

the display time in milliseconds

setDisplayTime

public void setDisplayTime(int displayTime)

Sets the duration in milliseconds for which this speech bubble will be active.

Parameters:

displayTime - the display time in milliseconds

start

public void start()

Start the speech bubble. This will add it to the current Screen's components, make it visible and register it for updates in the Game loop. After the display time has elapsed, the speech bubble will be stopped automatically.

stop

public void stop()

Stop the speech bubble. This will remove it from the current Screen's components, make it invisible and deregister it from updates in the Game loop.

render

public void render(Graphics2D g)

Description copied from class: GuiComponent

Note: If you override this and are modifying swing components, be sure you are in the AWT thread when you do so!

Specified by:

render in interface IRenderable

Overrides:

render in class GuiComponent

Parameters:

g - The current graphics object onto which this instance will render its visual contents.

See Also:

• RenderEngine.renderEntity(Graphics2D, de.gurkenlabs.litiengine.entities.IEntity)

getBoxAlign

public Align getBoxAlign()

Gets the horizontal speech bubble alignment that dictates its position relative to the entity center point.

Returns:

the box Align

setBoxAlign

public void setBoxAlign(Align boxAlign)

Sets the horizontal speech bubble alignment that dictates its position relative to the entity center point.

Parameters:

boxAlign - the box Align

update

public void update()

Description copied from interface: IUpdateable

This method is called by the game loop on all objects that are attached to the loop. It's called on every tick of the loop and the frequency can be configured using the ClientConfiguration.

Specified by:

update in interface IUpdateable

See Also:

• ClientConfiguration.setMaxFps(int)

isRenderingTriangle

public boolean isRenderingTriangle()

Checks if the triangle indicator is active.

Returns:

true, if the speech bubble is rendering a triangle indicator on the bottom.

setRenderTriangle

public void setRenderTriangle(boolean renderTriangle)

Sets the visibility status of the triangle indicator.

Parameters:

renderTriangle - if true, the triangle will be visible.

setLocation

public void setLocation(Point2D location)

Description copied from class: GuiComponent

Sets this GuiComponent's location.

Overrides:

setLocation in class GuiComponent

Parameters:

location - the new location

setWidth

public void setWidth(double width)

Description copied from class: GuiComponent

Sets the GuiComponent's width.

Overrides:

setWidth in class GuiComponent

Parameters:

width - the new width

setHeight

public void setHeight(double height)

Description copied from class: GuiComponent

Sets the GuiComponent's height.

Overrides:

setHeight in class GuiComponent

Parameters:

height - the new height

getTriangle

public Path2D getTriangle()

Gets the triangle indicator's shape, translated to the correct location on screen.

Returns:

A Path2D object representing the triangle indicator.

getTriangleSize

public double getTriangleSize()

Gets the triangle indicator size. Its size is identical for width and height.

Returns:

the triangle indicator size

setTriangleSize

public void setTriangleSize(double triangleSize)

Gets the triangle indicator size. Its size is identical for width and height.

Parameters:

triangleSize - the new triangle indicator size

getTypeDelay

public int getTypeDelay()

Gets type delay, which determines how fast the typewriter effect will be.

Returns:

the type delay in milliseconds

setTypeDelay

public void setTypeDelay(int typeDelay)

Sets type delay, which determines how fast the typewriter effect will be.

Parameters:

typeDelay - the type delay in milliseconds

getTypeSound

public Sound getTypeSound()

Gets the sound that is played every time a new letter appears.

Returns:

the type sound

setTypeSound

public void setTypeSound(Sound typeSound)

Sets the sound that is played every time a new letter appears.

Parameters:

typeSound - the type sound

getTotalText

public String getTotalText()

Gets the total text that this Speech bubble will display.

Returns:

the total text