ScriptConsole.c File Reference

Go to the source code of this file.

Classes
class	UIScriptedMenu
class	JsonHintsData

Functions
void	OnWidgetScriptInit (Widget w)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
bool	Tick ()
void	DisplayHint (string message)
void	HideHint ()
string	GetMessage ()
void	HoverSuccess ()
void	HoverInterrupt ()

Variables
class ScriptConsole extends UIScriptedMenu	HintMessage
Widget	m_Root
float	m_HoverTime
bool	m_HoverSuccessTriggered
Widget	m_CurrentHoverWidget
Widget	m_HintWidgetRoot
ImageWidget	m_HintWidgetBackground
RichTextWidget	m_HintWidget
ref Timer	m_Timer

Function Documentation

DisplayHint()

void DisplayHint ( string message )

protected

Definition at line 493 of file ScriptConsole.c.

  {
    if (message)
    {
      m_HintWidgetRoot = GetGame().GetWorkspace().CreateWidgets("gui/layouts/script_console/script_console_hint.layout");
      m_HintWidgetBackground = ImageWidget.Cast(m_HintWidgetRoot.FindAnyWidget("Background"));
      m_HintWidget = RichTextWidget.Cast(m_HintWidgetRoot.FindAnyWidget("HintText"));
 
      m_HintWidgetRoot.Show(true);
      m_HintWidget.SetText(message);
 
      int offsetX = 0;
      int offsetY = 10;
 
      int screenW, screenH;
      GetScreenSize(screenW, screenH);
 
      int mouseX, mouseY;
      GetMousePos(mouseX, mouseY);
 
      float relativeX = mouseX / screenW;
      float relativeY = mouseY / screenH;
 
      int width, height;
      m_HintWidget.GetTextSize(width, height);
      if (relativeX > 0.8)
        offsetX = -width - offsetX;
      if (relativeY > 0.8)
        offsetY = -height - offsetY;
 
      m_HintWidgetRoot.SetPos(mouseX + offsetX, mouseY + offsetY);
      m_HintWidgetBackground.SetScreenSize(width + 5, height + 5);
 
    }
  }

References GetGame(), GetMousePos(), GetScreenSize(), m_HintWidget, m_HintWidgetBackground, and m_HintWidgetRoot.

Referenced by HoverSuccess().

GetMessage()

string GetMessage ( )

protected

Definition at line 536 of file ScriptConsole.c.

  {
    return HintMessage;
  }

References HintMessage.

Referenced by HoverSuccess().

HideHint()

void HideHint ( )

protected

Definition at line 529 of file ScriptConsole.c.

  {
    if (m_HintWidgetRoot)
      m_HintWidgetRoot.Show(false);
  }

References m_HintWidgetRoot.

Referenced by HoverInterrupt().

HoverInterrupt()

void HoverInterrupt ( )

protected

Definition at line 547 of file ScriptConsole.c.

  {
    m_Timer = null;
    m_HoverSuccessTriggered = false;
    m_CurrentHoverWidget = null;
    m_HoverTime = 0;
    HideHint();
  }

References HideHint(), m_CurrentHoverWidget, m_HoverSuccessTriggered, m_HoverTime, and m_Timer.

Referenced by OnMouseLeave(), and Tick().

HoverSuccess()

void HoverSuccess ( )

protected

Definition at line 541 of file ScriptConsole.c.

  {
    m_HoverSuccessTriggered = true;
    DisplayHint(GetMessage());
  }

References DisplayHint(), GetMessage(), and m_HoverSuccessTriggered.

Referenced by Tick().

OnMouseEnter()

override bool OnMouseEnter ( Widget w, int x, int y )

protected

Definition at line 465 of file ScriptConsole.c.

  {
    m_Timer = new Timer();
    m_Timer.Run(0.1, this, "Tick", NULL, true);
 
    m_CurrentHoverWidget = w;
    return true;
  }

References m_CurrentHoverWidget, and m_Timer.

OnMouseLeave()

override bool OnMouseLeave ( Widget w, Widget enterW, int x, int y )

protected

Definition at line 474 of file ScriptConsole.c.

  {
    HoverInterrupt();
    return true;
  }

References HoverInterrupt().

OnWidgetScriptInit()

void OnWidgetScriptInit ( Widget w )

protected

Definition at line 458 of file ScriptConsole.c.

  {
    m_Root = w;
    m_Root.SetHandler(this);
    m_Root.SetFlags(WidgetFlags.VEXACTPOS);
  }

References m_Root.

Tick()

bool Tick ( )

protected

Definition at line 480 of file ScriptConsole.c.

  {
    if (!m_Root.IsVisibleHierarchy())
      HoverInterrupt();
    if (m_CurrentHoverWidget && !m_HoverSuccessTriggered)
    {
      m_HoverTime += 0.1;
      if (m_HoverTime > 1)
        HoverSuccess();
    }
    return true;
  }

References HoverInterrupt(), HoverSuccess(), m_CurrentHoverWidget, m_HoverSuccessTriggered, m_HoverTime, and m_Root.

Variable Documentation

HintMessage

class ScriptConsole extends UIScriptedMenu HintMessage

Referenced by GetMessage().

m_CurrentHoverWidget

Widget m_CurrentHoverWidget

protected

Definition at line 451 of file ScriptConsole.c.

Referenced by UIScriptedMenu::GetMessage(), HoverInterrupt(), UIScriptedMenu::OnClick(), UIScriptedMenu::OnMouseEnter(), OnMouseEnter(), Tick(), and UIScriptedMenu::Update().

m_HintWidget

RichTextWidget m_HintWidget

protected

Definition at line 454 of file ScriptConsole.c.

Referenced by UIScriptedMenu::DisplayHint(), and DisplayHint().

m_HintWidgetBackground

ImageWidget m_HintWidgetBackground

protected

Definition at line 453 of file ScriptConsole.c.

Referenced by UIScriptedMenu::DisplayHint(), and DisplayHint().

m_HintWidgetRoot

Widget m_HintWidgetRoot

protected

Definition at line 452 of file ScriptConsole.c.

Referenced by UIScriptedMenu::DisplayHint(), DisplayHint(), UIScriptedMenu::HideHint(), HideHint(), UIScriptedMenu::Update(), and UIScriptedMenu::~ScriptConsole().

m_HoverSuccessTriggered

bool m_HoverSuccessTriggered

protected

Definition at line 450 of file ScriptConsole.c.

Referenced by UIScriptedMenu::HoverInterrupt(), HoverInterrupt(), UIScriptedMenu::HoverSuccess(), HoverSuccess(), Tick(), and UIScriptedMenu::Update().

m_HoverTime

float m_HoverTime

protected

Definition at line 449 of file ScriptConsole.c.

Referenced by UIScriptedMenu::HoverInterrupt(), HoverInterrupt(), Tick(), and UIScriptedMenu::Update().

m_Root

Widget m_Root

protected

Definition at line 446 of file ScriptConsole.c.

m_Timer

ref Timer m_Timer

protected

Definition at line 456 of file ScriptConsole.c.