TextBubble Class Reference

Used to modify the behavior of a text bubble. Can display text, modify text and more. More...

Public Member Functions
void	Display (Context instigator, long index)
	Displays a specific text in the text bubble.
void	Display (Context instigator, long index, bool showProgress, bool showInteract)
	Displays a specific text in the text bubble.
void	DisplayWithDuration (Context instigator, int index, float duration)
	Displays a specific text in the text bubble for a certain duration.
void	DisplayWithDuration (Context instigator, int index, float duration, bool showProgress, bool showInteract)
	Displays a specific text in the text bubble for a certain duration.
void	DisplayForTarget (Context instigator, Context target, long index)
	Displays a specific text to a single player in the text bubble.
void	DisplayForTarget (Context instigator, Context target, long index, bool showProgress, bool showInteract)
	Displays a specific text to a single player in the text bubble.
void	DisplayForTargetWithDuration (Context instigator, Context target, long index, float duration)
	Displays a specific text to a single player in the text bubble for a duration.
void	DisplayForTargetWithDuration (Context instigator, Context target, long index, float duration, bool showProgress, bool showInteract)
	Displays a specific text to a single player in the text bubble for a duration.
void	Close (Context instigator)
	Closes the text bubble.
void	CloseForTarget (Context instigator, Context target)
	Closes the text bubble for a specific player context.
string[]	GetTexts ()
	Gets an array of all the texts in this text bubble currently.
void	SetLocalizedTextViaTable (Context instigator, LuaTable newText)
	Sets the text of this text bubble with a lua table.
int	GetTextLength ()
	Gets the number of texts in this text bubble.
void	SetLocalizedText (Context instigator, LocalizedString[] text)
	Sets the text of this text bubble with a localized string array.
void	SetLocalizedText (Context instigator, LocalizedString text)
	Sets the text of this text bubble to the LocalizedString.
void	SetDisplayName (Context instigator, LocalizedString text)
	Sets the display name for this text bubble.
void	SetFontSize (Context instigator, float fontSize)
void	ResetFontSize (Context instigator)
void	ShakeForTarget (Context instigator, Context target)
void	ShakeForAll (Context instigator)
void	ShowAlert (Context instigator, string displayText)
void	ShowAlertForTarget (Context instigator, Context target, string displayText)

Properties
float	ShakeDuration [get]

Detailed Description

Used to modify the behavior of a text bubble. Can display text, modify text and more.

Member Function Documentation

Close()

void Close

(

Context

instigator

)

Closes the text bubble.

CloseForTarget()

void CloseForTarget	(	Context	instigator,
		Context	target )

Closes the text bubble for a specific player context.

Parameters

instigator	The source context triggering this change
target	The target to close the text bubble for.

Display() [1/2]

void Display	(	Context	instigator,
		long	index )

Displays a specific text in the text bubble.

Parameters

instigator	The source context triggering this change
index	The index of the text to display

Display() [2/2]

void Display	(	Context	instigator,
		long	index,
		bool	showProgress,
		bool	showInteract )

Displays a specific text in the text bubble.

Parameters

instigator	The source context triggering this change
index	The index of the text to display
showProgress	Should it show the X/Y text?
showInteract	Should it show the interact key to progress?

DisplayForTarget() [1/2]

void DisplayForTarget	(	Context	instigator,
		Context	target,
		long	index )

Displays a specific text to a single player in the text bubble.

Parameters

instigator	The source context triggering this change
target	The context of the player to display the text to.
index	The index of the text to display.

DisplayForTarget() [2/2]

void DisplayForTarget	(	Context	instigator,
		Context	target,
		long	index,
		bool	showProgress,
		bool	showInteract )

Displays a specific text to a single player in the text bubble.

Parameters

instigator	The source context triggering this change
target	The context of the player to display the text to.
index	The index of the text to display.
showProgress	Should it show the X/Y text?
showInteract	Should it show the interact key to progress?

DisplayForTargetWithDuration() [1/2]

void DisplayForTargetWithDuration	(	Context	instigator,
		Context	target,
		long	index,
		float	duration )

Displays a specific text to a single player in the text bubble for a duration.

Parameters

instigator	The source context triggering this change
target	The context of the player to display the text to.
index	The index of the text to display.
duration	The duration in seconds for the text to be displayed.

DisplayForTargetWithDuration() [2/2]

void DisplayForTargetWithDuration	(	Context	instigator,
		Context	target,
		long	index,
		float	duration,
		bool	showProgress,
		bool	showInteract )

Displays a specific text to a single player in the text bubble for a duration.

Parameters

instigator	The source context triggering this change
target	The context of the player to display the text to.
index	The index of the text to display.
duration	The duration in seconds for the text to be displayed.
showProgress	Should it show the X/Y text?
showInteract	Should it show the interact key to progress?

DisplayWithDuration() [1/2]

void DisplayWithDuration	(	Context	instigator,
		int	index,
		float	duration )

Displays a specific text in the text bubble for a certain duration.

Parameters

instigator	The source context triggering this change
index	The index of the text to display.
duration	The duration in seconds for the text to be displayed.

DisplayWithDuration() [2/2]

void DisplayWithDuration	(	Context	instigator,
		int	index,
		float	duration,
		bool	showProgress,
		bool	showInteract )

Displays a specific text in the text bubble for a certain duration.

Parameters

instigator	The source context triggering this change
index	The index of the text to display.
duration	The duration in seconds for the text to be displayed.
showProgress	Should it show the X/Y text?
showInteract	Should it show the interact key to progress?

GetTextLength()

int GetTextLength

(

)

Gets the number of texts in this text bubble.

Returns

The number of texts in this text bubble.

GetTexts()

string[] GetTexts

(

)

Gets an array of all the texts in this text bubble currently.

Returns

An array of localized strings containing the text on this text bubble

ResetFontSize()

void ResetFontSize

(

Context

instigator

)

SetDisplayName()

void SetDisplayName	(	Context	instigator,
		LocalizedString	text )

Sets the display name for this text bubble.

Parameters

instigator	The source context triggering this change
text	The display name.

SetFontSize()

void SetFontSize	(	Context	instigator,
		float	fontSize )

SetLocalizedText() [1/2]

void SetLocalizedText	(	Context	instigator,
		LocalizedString	text )

Sets the text of this text bubble to the LocalizedString.

Parameters

instigator	The source context triggering this change
text	The LocalizedString containing the text for the text bubble

SetLocalizedText() [2/2]

void SetLocalizedText	(	Context	instigator,
		LocalizedString[]	text )

Sets the text of this text bubble with a localized string array.

Parameters

instigator	The source context triggering this change
text	The new text for the text bubble

SetLocalizedTextViaTable()

void SetLocalizedTextViaTable	(	Context	instigator,
		LuaTable	newText )

Sets the text of this text bubble with a lua table.

Parameters

instigator	The source context triggering this change
newText	The new text for the text bubble

ShakeForAll()

void ShakeForAll

(

Context

instigator

)

ShakeForTarget()

void ShakeForTarget	(	Context	instigator,
		Context	target )

ShowAlert()

void ShowAlert	(	Context	instigator,
		string	displayText )

ShowAlertForTarget()

void ShowAlertForTarget	(	Context	instigator,
		Context	target,
		string	displayText )

Property Documentation

ShakeDuration

float ShakeDuration

get