NewsCarousel.c File Reference

Enumerations
enum	NewsCategory { DLCS , DLC_PROMO , MISC_PROMO }

Functions
void	NewsCarousel (Widget parent, UIScriptedMenu mainMenu)
void	~NewsCarousel ()
void	Destroy ()
	Cleans up the Effect, including unregistering if needed.
protected void	SwitchNews ()
void	ShowNewsCarousel (bool show)
protected void	UpdateCarouselInfo ()
protected void	ShowPost (int index)
void	OnAnimationCompleted ()
protected void	ColorHighlight (Widget w)
protected void	ColorNormal (Widget w)
void	OnClickNextArticle ()
protected void	NextArticle ()
void	OnClickPreviousArticle ()
protected void	PreviousArticle ()
protected void	ShowArrowRight (bool state)
protected void	ShowArrowLeft (bool state)
void	ShowPromotion ()
override bool	OnClick (Widget w, int x, int y, int button)
override bool	OnMouseEnter (Widget w, int x, int y)
override bool	OnMouseLeave (Widget w, Widget enterW, int x, int y)
protected void	OnInputDeviceChanged (EInputDeviceType pInputDeviceType)
protected string	GetButtonLabel (string color)
void	Update (float timeslice)

Variables
enum NewsCategory	MAX_ARTICLES = 3
protected const float	ARTICLE_SWITCH_TIME = 3.0
protected Widget	m_Root
protected ButtonWidget	m_HotlinkButton
protected RichTextWidget	m_HotlinkButtonLabel
protected ImageWidget	m_Image
protected TextWidget	m_TitleText
protected ButtonWidget	m_NextPageBtn
protected ButtonWidget	m_PrevPageBtn
protected ImageWidget	m_NextPageBtnIcon
protected ImageWidget	m_PrevPageBtnIcon
protected ref array< JsonDataNewsArticle >	m_NewsArticles
protected JsonDataNewsArticle	m_CurrentArticle
protected ModInfo	m_CurrentModInfo
protected int	m_ArticleIndex
protected ref Timer	m_NewsSwitchTimer
protected bool	m_SwitchToNext = true
protected MainMenu	m_MainMenu
protected GridSpacerWidget	m_GridSpacer
protected ref AnimatedGridSpacer	m_AnimatedSpacer
protected EInputDeviceType	m_CurrentInputDevice

Enumeration Type Documentation

NewsCategory

enum NewsCategory

Enumerator
DLCS
DLC_PROMO
MISC_PROMO

Function Documentation

ColorHighlight()

protected void ColorHighlight

(

Widget

w

)

References ARGB().

Referenced by OptionSelectorBase::OnMouseEnter(), and ServerBrowserTab::OnMouseEnter().

ColorNormal()

protected void ColorNormal

(

Widget

w

)

References ARGB().

Referenced by OptionSelectorBase::OnMouseLeave(), and ServerBrowserTab::OnMouseLeave().

GetButtonLabel()

protected string GetButtonLabel

(

string

color

)

References JsonDataNewsArticle::categoryID, string::Empty, string::Format(), JsonDataNewsArticle::fullUrl, InputUtils::GetRichtextButtonIconFromInputAction(), m_CurrentArticle, and m_CurrentInputDevice.

Referenced by NewsCarousel(), OnAnimationCompleted(), OnInputDeviceChanged(), OnMouseEnter(), and OnMouseLeave().

NewsCarousel()

void NewsCarousel	(	Widget	parent,
		UIScriptedMenu	mainMenu
	)

References g_Game, GetButtonLabel(), m_GridSpacer, m_HotlinkButton, m_HotlinkButtonLabel, m_MainMenu, m_NextPageBtn, m_NextPageBtnIcon, m_PrevPageBtn, m_PrevPageBtnIcon, m_Root, m_TitleText, OnInputDeviceChanged(), ScriptedWidgetEventHandler::OnInputDeviceChanged(), and UpdateCarouselInfo().

Referenced by UIScriptedMenu::CheckWidth(), UIScriptedMenu::Init(), UIScriptedMenu::OnDLCChange(), and UIScriptedMenu::OnShow().

NextArticle()

protected void NextArticle

(

)

References m_AnimatedSpacer, m_ArticleIndex, m_NewsArticles, ShowArrowLeft(), ShowArrowRight(), and ShowPost().

Referenced by OnClickNextArticle(), and SwitchNews().

OnAnimationCompleted()

void OnAnimationCompleted

(

)

References GetButtonLabel(), GetWidgetUnderCursor(), m_HotlinkButton, and m_HotlinkButtonLabel.

Referenced by UpdateCarouselInfo().

OnClick()

override bool OnClick	(	Widget	w,
		int	x,
		int	y,
		int	button
	)

References m_HotlinkButton, m_NextPageBtn, m_PrevPageBtn, OnClickNextArticle(), OnClickPreviousArticle(), and ShowPromotion().

OnClickNextArticle()

void OnClickNextArticle

(

)

References m_NewsSwitchTimer, NextArticle(), and Timer::Stop().

Referenced by OnClick().

OnClickPreviousArticle()

void OnClickPreviousArticle

(

)

References m_NewsSwitchTimer, PreviousArticle(), and Timer::Stop().

Referenced by OnClick().

OnInputDeviceChanged()

protected void OnInputDeviceChanged

(

EInputDeviceType

pInputDeviceType

)

References g_Game, GetButtonLabel(), m_ArticleIndex, m_CurrentInputDevice, m_HotlinkButtonLabel, m_NewsArticles, m_NextPageBtnIcon, and m_PrevPageBtnIcon.

OnMouseEnter()

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

References ARGB(), string::Empty, JsonDataNewsArticle::fullUrl, GetButtonLabel(), m_CurrentArticle, m_HotlinkButton, m_HotlinkButtonLabel, m_NextPageBtn, m_NextPageBtnIcon, m_PrevPageBtn, and m_PrevPageBtnIcon.

OnMouseLeave()

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

References ARGB(), string::Empty, JsonDataNewsArticle::fullUrl, GetButtonLabel(), m_CurrentArticle, m_HotlinkButton, m_HotlinkButtonLabel, m_NextPageBtn, m_NextPageBtnIcon, m_PrevPageBtn, and m_PrevPageBtnIcon.

PreviousArticle()

protected void PreviousArticle

(

)

References m_AnimatedSpacer, m_ArticleIndex, m_NewsArticles, ShowArrowLeft(), ShowArrowRight(), and ShowPost().

Referenced by OnClickPreviousArticle(), and SwitchNews().

ShowArrowLeft()

protected void ShowArrowLeft

(

bool

state

)

References g_Game, m_CurrentInputDevice, and m_PrevPageBtnIcon.

Referenced by NextArticle(), and PreviousArticle().

ShowArrowRight()

protected void ShowArrowRight

(

bool

state

)

References g_Game, m_CurrentInputDevice, and m_NextPageBtnIcon.

Referenced by NextArticle(), and PreviousArticle().

ShowNewsCarousel()

void ShowNewsCarousel

(

bool

show

)

References m_Root, and UpdateCarouselInfo().

Referenced by UIScriptedMenu::Init(), and UIScriptedMenu::~MainMenu().

ShowPost()

protected void ShowPost

(

int

index

)

References ScriptedWidgetEventHandler::ColorHighlight(), ScriptedWidgetEventHandler::ColorNormal(), JsonDataNewsArticle::coverImage, JsonDataNewsArticle::dlcName, ErrorEx, MainMenuData::GetDLCModInfoByName(), m_ArticleIndex, m_CurrentArticle, m_CurrentModInfo, m_NewsArticles, m_Root, m_TitleText, MAX_ARTICLES, and JsonDataNewsArticle::title.

Referenced by NextArticle(), PreviousArticle(), and UpdateCarouselInfo().

ShowPromotion()

void ShowPromotion

(

)

References ErrorEx, JsonDataNewsArticle::fullUrl, g_Game, ModInfo::GoToStore(), m_ArticleIndex, m_CurrentModInfo, and m_NewsArticles.

Referenced by OnClick().

SwitchNews()

protected void SwitchNews

(

)

References m_ArticleIndex, m_NewsArticles, m_SwitchToNext, NextArticle(), and PreviousArticle().

Update()

void Update

(

float

timeslice

)

References m_AnimatedSpacer.

UpdateCarouselInfo()

protected void UpdateCarouselInfo

(

)

References AnimatedGridSpacer(), ARTICLE_SWITCH_TIME, CALL_CATEGORY_GUI, JsonDataNewsArticle::categoryID, JsonDataNewsArticle::dlcName, MainMenuData::GetDLCModInfoByName(), ModInfo::GetIsOwned(), MainMenuData::GetNewsData(), m_AnimatedSpacer, m_GridSpacer, m_NewsArticles, m_NewsSwitchTimer, m_NextPageBtnIcon, m_Root, MAX_ARTICLES, JsonDataNewsList::News, OnAnimationCompleted(), and ShowPost().

Referenced by NewsCarousel(), and ShowNewsCarousel().

~NewsCarousel()

void ~NewsCarousel

(

)

References g_Game, m_NewsSwitchTimer, OnInputDeviceChanged(), and Timer::Stop().

Variable Documentation

ARTICLE_SWITCH_TIME

protected const float ARTICLE_SWITCH_TIME = 3.0

Referenced by UpdateCarouselInfo().

m_AnimatedSpacer

protected ref AnimatedGridSpacer m_AnimatedSpacer

Referenced by NextArticle(), PreviousArticle(), Update(), and UpdateCarouselInfo().

m_ArticleIndex

protected int m_ArticleIndex

Referenced by NextArticle(), OnInputDeviceChanged(), PreviousArticle(), ShowPost(), ShowPromotion(), and SwitchNews().

m_CurrentArticle

protected JsonDataNewsArticle m_CurrentArticle

Referenced by GetButtonLabel(), OnMouseEnter(), OnMouseLeave(), and ShowPost().

m_CurrentInputDevice

protected EInputDeviceType m_CurrentInputDevice

Referenced by GetButtonLabel(), OnInputDeviceChanged(), ShowArrowLeft(), and ShowArrowRight().

m_CurrentModInfo

protected ModInfo m_CurrentModInfo

Referenced by ShowPost(), and ShowPromotion().

m_GridSpacer

protected GridSpacerWidget m_GridSpacer

m_HotlinkButton

protected ButtonWidget m_HotlinkButton

Referenced by NewsCarousel(), OnAnimationCompleted(), OnClick(), OnMouseEnter(), and OnMouseLeave().

m_HotlinkButtonLabel

protected RichTextWidget m_HotlinkButtonLabel

Referenced by NewsCarousel(), OnAnimationCompleted(), OnInputDeviceChanged(), OnMouseEnter(), and OnMouseLeave().

m_Image

protected ImageWidget m_Image

m_MainMenu

protected MainMenu m_MainMenu

Referenced by NewsCarousel().

m_NewsArticles

protected ref array<JsonDataNewsArticle> m_NewsArticles

Referenced by NextArticle(), OnInputDeviceChanged(), PreviousArticle(), ShowPost(), ShowPromotion(), SwitchNews(), and UpdateCarouselInfo().

m_NewsSwitchTimer

protected ref Timer m_NewsSwitchTimer

Referenced by OnClickNextArticle(), OnClickPreviousArticle(), UpdateCarouselInfo(), and ~NewsCarousel().

m_NextPageBtn

protected ButtonWidget m_NextPageBtn

Referenced by NewsCarousel(), OnClick(), OnMouseEnter(), and OnMouseLeave().

m_NextPageBtnIcon

protected ImageWidget m_NextPageBtnIcon

Referenced by NewsCarousel(), OnInputDeviceChanged(), OnMouseEnter(), OnMouseLeave(), ShowArrowRight(), and UpdateCarouselInfo().

m_PrevPageBtn

protected ButtonWidget m_PrevPageBtn

Referenced by NewsCarousel(), OnClick(), OnMouseEnter(), and OnMouseLeave().

m_PrevPageBtnIcon

protected ImageWidget m_PrevPageBtnIcon

Referenced by NewsCarousel(), OnInputDeviceChanged(), OnMouseEnter(), OnMouseLeave(), and ShowArrowLeft().

m_Root

protected Widget m_Root

m_SwitchToNext

protected bool m_SwitchToNext = true

Referenced by SwitchNews().

m_TitleText

protected TextWidget m_TitleText

Referenced by NewsCarousel(), and ShowPost().

MAX_ARTICLES

enum NewsCategory MAX_ARTICLES = 3

Referenced by ShowPost(), and UpdateCarouselInfo().