ChatLine Class Reference

Collaboration diagram for ChatLine:

Protected Member Functions
void	SetColorByParam (string pParamValue, int pFallback)
void	Clear ()
int	ColorNameToColor (string pColorName)

Private Member Functions
void	ChatLine (Widget root_widget)
void	~ChatLine ()
void	Set (ChatMessageEventParams params)
void	SetColour (int colour)

Private Attributes
const float	FADE_TIMEOUT = 30
const float	FADE_OUT_DURATION = 3
const float	FADE_IN_DURATION = 0.5
const string	RADIO_PREFIX = "(" + "#str_radio" + ") "
const string	GAME_PREFIX = "(" + "#layout_chat_game" + ") "
const string	ADMIN_PREFIX = "(" + "#STR_MP_MASTER" + ") "
const int	DEFAULT_COLOUR = ARGB(255, 255, 255, 255)
const int	GAME_TEXT_COLOUR = ARGB(255, 255, 0, 0)
const int	ADMIN_TEXT_COLOUR = ARGB(255, 255, 255, 0)
Widget	m_RootWidget
TextWidget	m_NameWidget
TextWidget	m_TextWidget
ref WidgetFadeTimer	m_FadeTimer
ref Timer	m_TimeoutTimer

Detailed Description

Definition at line 1 of file ChatLine.c.

Constructor & Destructor Documentation

ChatLine()

void ChatLine::ChatLine ( Widget root_widget )

inlineprivate

Definition at line 23 of file ChatLine.c.

  {
    m_RootWidget = GetGame().GetWorkspace().CreateWidgets("gui/layouts/day_z_chat_item.layout", root_widget);
 
    m_NameWidget = TextWidget.Cast(m_RootWidget.FindAnyWidget("ChatItemSenderWidget"));
    m_TextWidget = TextWidget.Cast(m_RootWidget.FindAnyWidget("ChatItemTextWidget"));
 
    m_FadeTimer = new WidgetFadeTimer;
    m_TimeoutTimer = new Timer(CALL_CATEGORY_GUI);
  }

References CALL_CATEGORY_GUI, GetGame(), m_FadeTimer, m_NameWidget, m_RootWidget, m_TextWidget, and m_TimeoutTimer.

~ChatLine()

void ChatLine::~ChatLine ( )

inlineprivate

Definition at line 34 of file ChatLine.c.

  {
    delete m_TextWidget;
  }

References m_TextWidget.

Member Function Documentation

Clear()

void ChatLine::Clear ( )

inlineprotected

Definition at line 126 of file ChatLine.c.

  {
    m_RootWidget.Show(false);
    m_TimeoutTimer.Stop();
    m_FadeTimer.Stop();
  }

References m_FadeTimer, m_RootWidget, and m_TimeoutTimer.

ColorNameToColor()

int ChatLine::ColorNameToColor ( string pColorName )

inlineprotected

Definition at line 133 of file ChatLine.c.

  {
    int color = 0xFFFFFFFF;
    switch (pColorName)
    {
    case "colorStatusChannel":
      color = COLOR_BLUE;
      break;
    case "colorAction":
      color = COLOR_YELLOW;
      break;
    case "colorFriendly":
      color = COLOR_GREEN;
      break;
    case "colorImportant":
      color = COLOR_RED;
      break;
    }
 
    return color;
  }

References COLOR_BLUE, COLOR_GREEN, COLOR_RED, and COLOR_YELLOW.

Referenced by SetColorByParam().

Set()

void ChatLine::Set ( ChatMessageEventParams params )

inlineprivate

Definition at line 39 of file ChatLine.c.

  {
    int channel;
 
    m_NameWidget.SetText("");
    m_TextWidget.SetText("");
 
    SetColour(DEFAULT_COLOUR);
    m_RootWidget.Show(true);
 
    channel = params.param1; // 0 = Survior   1 = Game/System   2 = Admin
 
    /*
      if (params.param2 != "")
      {
      m_NameWidget.SetText( params.param2 + " : ");
      }
 
      if( channel & CCSystem )
      {
      if(params.param2 != "")
      {
        m_NameWidget.SetText(GAME_PREFIX + ": " );
      }
      SetColour(GAME_TEXT_COLOUR);
      }
      else if( channel & CCAdmin )
      {
      m_NameWidget.SetText(ADMIN_PREFIX + ": ");
      SetColour(ADMIN_TEXT_COLOUR);
      }
      else if( channel & CCTransmitter )
      {
      m_NameWidget.SetText(RADIO_PREFIX + params.param2 + " : ");
      }
    */
 
    if (channel & CCSystem)
    {
      // Game
      if (params.param2 != "")
        m_NameWidget.SetText(GAME_PREFIX + ": ");
 
      SetColorByParam(params.param4, GAME_TEXT_COLOUR);
    }
    else if (channel & CCAdmin)
    {
      // Admin
      m_NameWidget.SetText(ADMIN_PREFIX + ": ");
      SetColorByParam(params.param4, ADMIN_TEXT_COLOUR);
    }
    else if (channel & CCTransmitter)
    {
      // Radio - Trasnmitter
      m_NameWidget.SetText(RADIO_PREFIX + params.param2 + " : ");
    }
    else if (channel == 0 || channel & CCDirect)
    {
      // Player
      if (params.param2 != "")
        m_NameWidget.SetText(params.param2 + " : ");
    }
 
 
    m_TextWidget.SetText(params.param3);
 
    m_FadeTimer.FadeIn(m_RootWidget, FADE_IN_DURATION);
    m_TimeoutTimer.Run(FADE_TIMEOUT, m_FadeTimer, "FadeOut", new Param2<Widget, float>(m_RootWidget, FADE_OUT_DURATION));
  }

References ADMIN_PREFIX, ADMIN_TEXT_COLOUR, DEFAULT_COLOUR, FADE_IN_DURATION, FADE_OUT_DURATION, FADE_TIMEOUT, GAME_PREFIX, GAME_TEXT_COLOUR, m_FadeTimer, m_NameWidget, m_RootWidget, m_TextWidget, m_TimeoutTimer, RADIO_PREFIX, SetColorByParam(), and SetColour().

SetColorByParam()

void ChatLine::SetColorByParam ( string pParamValue, int pFallback )

inlineprotected

Definition at line 115 of file ChatLine.c.

  {
    if (pParamValue != "")
    {
      SetColour(ColorNameToColor(pParamValue));
      return;
    }
 
    SetColour(pFallback);
  }

References ColorNameToColor(), and SetColour().

Referenced by Set().

SetColour()

void ChatLine::SetColour ( int colour )

inlineprivate

Definition at line 109 of file ChatLine.c.

  {
    m_NameWidget.SetColor(colour);
    m_TextWidget.SetColor(colour);
  }

References m_NameWidget, and m_TextWidget.

Referenced by Set(), and SetColorByParam().

Member Data Documentation

ADMIN_PREFIX

const string ChatLine::ADMIN_PREFIX = "(" + "#STR_MP_MASTER" + ") "

private

Definition at line 10 of file ChatLine.c.

Referenced by Set().

ADMIN_TEXT_COLOUR

const int ChatLine::ADMIN_TEXT_COLOUR = ARGB(255, 255, 255, 0)

private

Definition at line 13 of file ChatLine.c.

Referenced by Set().

DEFAULT_COLOUR

const int ChatLine::DEFAULT_COLOUR = ARGB(255, 255, 255, 255)

private

Definition at line 11 of file ChatLine.c.

Referenced by Set().

FADE_IN_DURATION

const float ChatLine::FADE_IN_DURATION = 0.5

private

Definition at line 6 of file ChatLine.c.

Referenced by Set().

FADE_OUT_DURATION

const float ChatLine::FADE_OUT_DURATION = 3

private

Definition at line 5 of file ChatLine.c.

Referenced by Set().

FADE_TIMEOUT

const float ChatLine::FADE_TIMEOUT = 30

private

Definition at line 4 of file ChatLine.c.

Referenced by Set().

GAME_PREFIX

const string ChatLine::GAME_PREFIX = "(" + "#layout_chat_game" + ") "

private

Definition at line 9 of file ChatLine.c.

Referenced by Set().

GAME_TEXT_COLOUR

const int ChatLine::GAME_TEXT_COLOUR = ARGB(255, 255, 0, 0)

private

Definition at line 12 of file ChatLine.c.

Referenced by Set().

m_FadeTimer

ref WidgetFadeTimer ChatLine::m_FadeTimer

private

Definition at line 20 of file ChatLine.c.

Referenced by ChatLine(), Clear(), and Set().

m_NameWidget

TextWidget ChatLine::m_NameWidget

private

Definition at line 17 of file ChatLine.c.

Referenced by ChatLine(), Set(), and SetColour().

m_RootWidget

Widget ChatLine::m_RootWidget

private

Definition at line 16 of file ChatLine.c.

Referenced by ChatLine(), Clear(), and Set().

m_TextWidget

TextWidget ChatLine::m_TextWidget

private

Definition at line 18 of file ChatLine.c.

Referenced by ChatLine(), Set(), SetColour(), and ~ChatLine().

m_TimeoutTimer

ref Timer ChatLine::m_TimeoutTimer

private

Definition at line 21 of file ChatLine.c.

Referenced by ChatLine(), Clear(), and Set().

RADIO_PREFIX

const string ChatLine::RADIO_PREFIX = "(" + "#str_radio" + ") "

private

Definition at line 8 of file ChatLine.c.

Referenced by Set().

---

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

• scripts/5_Mission/GUI/Chat/ChatLine.c