org.botlibre.api.avatar

Interface Avatar

All Known Implementing Classes:

BasicAvatar, ImageAvatar

public interface Avatar

Allows visual expression of emotions and state.

Method Summary

Modifier and Type	Method and Description
void	awake()
void	evaluateOutput(Vertex output) Evaluate the output and express in the Avatar's image.
void	evaluateResponse(Vertex output, Vertex response, Vertex meta, java.util.Map<Vertex,Vertex> variables, Network network) Evaluate the input response for actions and poses.
java.lang.String	getAction()
Bot	getBot()
java.lang.String	getCommand()
BinaryData	getCurrentImage()
java.lang.String	getEmote()
java.lang.String	getPose()
Primitive	getPrimitive()
void	initialize(java.util.Map<java.lang.String,java.lang.Object> properties) Initialize any configuration properties.
void	pool()
void	reset()
void	setAction(java.lang.String action)
void	setBot(Bot Bot)
void	setCommand(java.lang.String command)
void	setEmote(java.lang.String emote)
void	setPose(java.lang.String pose)
void	shutdown()

Method Detail

shutdown

void shutdown()

awake

void awake()

pool

void pool()

reset

void reset()

getCurrentImage

BinaryData getCurrentImage()

getBot

Bot getBot()

getPrimitive

Primitive getPrimitive()

setBot

void setBot(Bot Bot)

getAction

java.lang.String getAction()

setAction

void setAction(java.lang.String action)

getCommand

java.lang.String getCommand()

setCommand

void setCommand(java.lang.String command)

getPose

java.lang.String getPose()

setPose

void setPose(java.lang.String pose)

getEmote

java.lang.String getEmote()

setEmote

void setEmote(java.lang.String emote)

evaluateOutput

void evaluateOutput(Vertex output)

Evaluate the output and express in the Avatar's image.

evaluateResponse

void evaluateResponse(Vertex output,
                      Vertex response,
                      Vertex meta,
                      java.util.Map<Vertex,Vertex> variables,
                      Network network)

Evaluate the input response for actions and poses.

initialize

void initialize(java.util.Map<java.lang.String,java.lang.Object> properties)

Initialize any configuration properties.