cz.cuni.amis.pogamut.emohawk.agent.module.sensomotoric
Class Emoticons

java.lang.Object
  cz.cuni.amis.pogamut.base.agent.module.AgentModule<AGENT>
      cz.cuni.amis.pogamut.base.agent.module.SensomotoricModule<UT2004Bot>
          cz.cuni.amis.pogamut.emohawk.agent.module.sensomotoric.Emoticons

All Implemented Interfaces:

IComponent

public class Emoticons
extends SensomotoricModule<UT2004Bot>

Wraps emoticon control.

Author:

Knight

Field Summary

Fields inherited from class cz.cuni.amis.pogamut.base.agent.module.SensomotoricModule

act, worldView

Fields inherited from class cz.cuni.amis.pogamut.base.agent.module.AgentModule

agent, controller, eventBus, log

Constructor Summary

Emoticons(UT2004Bot agent)
Default constructor.

Method Summary

void	clearEmoticons() Stops displaying all emoticons.
EmoticonBubbleType	getCurrentBubbleType() Returns current bot bubble.
EmoticonType	getCurrentCenterEmoticonType() Returns current bot center emoticon.
Emoticon	getCurrentEmoticon() Returns current bot emoticon.
EmoticonType[]	getCurrentEmoticonTypes() Returns all 3 emoticons as currently displayed by you (displayed from LEFT-to-RIGHT).
EmoticonType	getCurrentLeftEmoticonType() Returns current bot left emoticon.
EmoticonType	getCurrentRightEmoticonType() Returns current bot right emoticon.
Emoticon	getPlayerEmoticon(Player player) Gets the current emoticon of input player from input Player object.
EmoticonInfo	getPlayerEmoticonInfo(cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId playerId) Returns emoticon info for player of input id.
void	setCenterEmoticonType(EmoticonType type) Deprecated.
void	setCenterEmoticonType(EmoticonType type, double duration) Deprecated.
void	setCenterEmoticonType(EmoticonType centerEmoticon, double duration, EmoticonBubbleType bubble) Deprecated.
void	setDoubleEmoticon(EmoticonType left, EmoticonType right) Deprecated.
void	setDoubleEmoticon(EmoticonType left, EmoticonType right, double duration) Deprecated.
void	setDoubleEmoticon(EmoticonType left, EmoticonType right, double duration, EmoticonBubbleType bubble) Deprecated.
void	setEmoticon(Emoticon emoticon) Sets emoticon for the bot for input duration (seconds).
void	setEmoticon(Emoticon emoticon, double duration) Sets emoticon for the bot for input duration (seconds).
void	setEmoticons(double duration, EmoticonBubbleType bubble, EmoticonType... emoticons) May set multiple emoticons at once.
void	setTripleEmoticon(EmoticonType left, EmoticonType center, EmoticonType right) Deprecated.
void	setTripleEmoticon(EmoticonType left, EmoticonType center, EmoticonType right, double duration) Deprecated.
void	setTripleEmoticon(EmoticonType left, EmoticonType center, EmoticonType right, double duration, EmoticonBubbleType bubble) Deprecated.

Methods inherited from class cz.cuni.amis.pogamut.base.agent.module.AgentModule

cleanUp, getComponentId, getLog, getState, initComponentId, isRunning, kill, pause, reset, resume, start, stop, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Emoticons

public Emoticons(UT2004Bot agent)

Default constructor.

Parameters:

agent -

Method Detail

getCurrentEmoticonTypes

public EmoticonType[] getCurrentEmoticonTypes()

Returns all 3 emoticons as currently displayed by you (displayed from LEFT-to-RIGHT). 0 emoticons displayed: returns [] 1 emoticon displayed: returns [CENTER] 2 emoticons displayed: returns [LEFT, RIGHT] 3 emoticons displayed: returns [LEFT, CENTER, RIGHT]

Returns:

array of [left, center, right] emoticon being displayed, NONE emoticons are omitted!

getCurrentEmoticon

public Emoticon getCurrentEmoticon()

Returns current bot emoticon.

Returns:

getPlayerEmoticon

public Emoticon getPlayerEmoticon(Player player)

Gets the current emoticon of input player from input Player object.

Parameters:

player -

Returns:

getPlayerEmoticonInfo

public EmoticonInfo getPlayerEmoticonInfo(cz.cuni.amis.pogamut.unreal.communication.messages.UnrealId playerId)

Returns emoticon info for player of input id. Not only you get emoticon, but also the SimTime long when the emoticon was set! If no value, blank emoticon and 0 time will be returned.

Parameters:

playerId -

Returns:

setEmoticon

public void setEmoticon(Emoticon emoticon)

Sets emoticon for the bot for input duration (seconds).

Parameters:

emoticon -

setEmoticon

public void setEmoticon(Emoticon emoticon,
                        double duration)

Sets emoticon for the bot for input duration (seconds).

Parameters:

emoticon -

duration -

getCurrentLeftEmoticonType

public EmoticonType getCurrentLeftEmoticonType()

Returns current bot left emoticon.

Returns:

getCurrentCenterEmoticonType

public EmoticonType getCurrentCenterEmoticonType()

Returns current bot center emoticon.

Returns:

getCurrentRightEmoticonType

public EmoticonType getCurrentRightEmoticonType()

Returns current bot right emoticon.

Returns:

getCurrentBubbleType

public EmoticonBubbleType getCurrentBubbleType()

Returns current bot bubble.

Returns:

setEmoticons

public void setEmoticons(double duration,
                         EmoticonBubbleType bubble,
                         EmoticonType... emoticons)

May set multiple emoticons at once. Can be invoked with 0 / 1 / 2 / 3 emoticon types. 0 emoticons - stops displaying all emoticons 1 emoticon - display emoticon as "center" one. 2 emoticons - display emoticons as "left" and "center" ones respectively. 3 emoticons - display emoticons as "left" and "center" and "right" ones respectively.

Parameters:

duration - in seconds

bubble -

emoticons -

clearEmoticons

public void clearEmoticons()

Stops displaying all emoticons.

setCenterEmoticonType

@Deprecated
public void setCenterEmoticonType(EmoticonType type)

Deprecated.

Sets emoticon in the center with default bubble and default duration. Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

type -

setCenterEmoticonType

@Deprecated
public void setCenterEmoticonType(EmoticonType type,
                                             double duration)

Deprecated.

Sets emoticon in the center for input duration (seconds). Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

type -

duration -

setCenterEmoticonType

@Deprecated
public void setCenterEmoticonType(EmoticonType centerEmoticon,
                                             double duration,
                                             EmoticonBubbleType bubble)

Deprecated.

Sets emoticon in the center for input duration (seconds) with input bubble. Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

centerEmoticon -

duration -

bubble -

setDoubleEmoticon

@Deprecated
public void setDoubleEmoticon(EmoticonType left,
                                         EmoticonType right)

Deprecated.

Sets double emoticon - left and right for the default duration with default bubble. Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

left -

right -

setDoubleEmoticon

@Deprecated
public void setDoubleEmoticon(EmoticonType left,
                                         EmoticonType right,
                                         double duration)

Deprecated.

Sets double emoticon - left and right for input duration with default bubble. Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

left -

right -

duration -

setDoubleEmoticon

@Deprecated
public void setDoubleEmoticon(EmoticonType left,
                                         EmoticonType right,
                                         double duration,
                                         EmoticonBubbleType bubble)

Deprecated.

Sets double emoticon - left and right for input duration with input bubble. Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

left -

right -

duration -

bubble -

setTripleEmoticon

@Deprecated
public void setTripleEmoticon(EmoticonType left,
                                         EmoticonType center,
                                         EmoticonType right)

Deprecated.

Sets triple emoticon - left, center and right for default duration with default bubble. Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

left -

center -

right -

setTripleEmoticon

@Deprecated
public void setTripleEmoticon(EmoticonType left,
                                         EmoticonType center,
                                         EmoticonType right,
                                         double duration)

Deprecated.

Sets triple emoticon - left, center and right for input duration with default bubble.4 Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

left -

center -

right -

duration -

setTripleEmoticon

@Deprecated
public void setTripleEmoticon(EmoticonType left,
                                         EmoticonType center,
                                         EmoticonType right,
                                         double duration,
                                         EmoticonBubbleType bubble)

Deprecated.

Sets triple emoticon - left, center and right for input duration with input bubble. Use: setEmoticons(double, EmoticonBubbleType, EmoticonType...) instead.

Parameters:

left -

center -

right -

duration -

bubble -