Dragengine.Utils.StyledText.STDTRRBinding Class Reference

Rule for resolving a binding tag in STDTagResolver. More...

Inheritance diagram for Dragengine.Utils.StyledText.STDTRRBinding:

Public Member Functions
BindingManager	getBindings ()
	Used bindings. More...
CommandManager	getCommands ()
	Supported commands. More...
STDTRRBinding	new (CommandManager commands, BindingManager bindings, STDStyle style)
	Create resolve tag rule. More...
STDTRRBinding	new (CommandManager commands, BindingManager bindings, String styleName)
	Create resolve tag rule. More...
STDTRRBinding	new (STDStyle style)
	Create resolve tag rule. More...
STDTRRBinding	new (String styleName)
	Create resolve tag rule. More...
void	resolveTag (STDTagResolver resolver, STDNText target, STDNTextSpan source, bool first, String parameters)
	Resolve tag adding STDNTextSpan to STDNText. More...
void	setBindingManager (BindingManager bindings)
	Set used bindings. More...
void	setCommands (CommandManager commands)
	Set supported commands. More...
Public Member Functions inherited from Dragengine.Utils.StyledText.STDTRRStyle
STDStyle	getStyle ()
	Style or null if not used. More...
String	getStyleName ()
	Style name or null if not used. More...
void	setStyle (STDStyle style)
	Set style or null if not used. More...
void	setStyleName (String name)
	Set style or null if not used. More...

Detailed Description

Rule for resolving a binding tag in STDTagResolver.

Version

1.16

Resolves tags of the form {binding:command-name}. Looks up the matching command and outputs all bindings assinged to the command. Useful to output in conversation instructions to the player what input to press to trigger an action. The bindings are optionally output in a different font and/or color. Usually using a different color is recommended but using a different font can help to better recognize such output in a conversation.

Member Function Documentation

getBindings()

BindingManager Dragengine.Utils.StyledText.STDTRRBinding.getBindings

(

)

Used bindings.

getCommands()

CommandManager Dragengine.Utils.StyledText.STDTRRBinding.getCommands

(

)

Supported commands.

new() [1/4]

STDTRRBinding Dragengine.Utils.StyledText.STDTRRBinding.new	(	CommandManager	commands,
		BindingManager	bindings,
		STDStyle	style
	)

Create resolve tag rule.

new() [2/4]

STDTRRBinding Dragengine.Utils.StyledText.STDTRRBinding.new	(	CommandManager	commands,
		BindingManager	bindings,
		String	styleName
	)

Create resolve tag rule.

new() [3/4]

STDTRRBinding Dragengine.Utils.StyledText.STDTRRBinding.new

(

STDStyle

style

)

Create resolve tag rule.

Reimplemented from Dragengine.Utils.StyledText.STDTRRStyle.

new() [4/4]

STDTRRBinding Dragengine.Utils.StyledText.STDTRRBinding.new

(

String

styleName

)

Create resolve tag rule.

Reimplemented from Dragengine.Utils.StyledText.STDTRRStyle.

resolveTag()

void Dragengine.Utils.StyledText.STDTRRBinding.resolveTag	(	STDTagResolver	resolver,
		STDNText	target,
		STDNTextSpan	source,
		bool	first,
		String	parameters
	)

Resolve tag adding STDNTextSpan to STDNText.

Parameters

resolver	STDTagResolver using the rule to resolve.
target	STDNText to add resolved STDNTextSpan to.
source	STDNTextSpan containing the tag name to resolve.
first	First span to be added. Image of source should be set to first added span.
parameters	Content of tag between curly brackets after ":" delimiter

Reimplemented from Dragengine.Utils.StyledText.STDTRRStyle.

setBindingManager()

void Dragengine.Utils.StyledText.STDTRRBinding.setBindingManager

(

BindingManager

bindings

)

Set used bindings.

setCommands()

void Dragengine.Utils.StyledText.STDTRRBinding.setCommands

(

CommandManager

commands

)

Set supported commands.

---

The documentation for this class was generated from the following file:

• STDTRRBinding.ds