SCR_DownloadManager_AddonDownloadLine Interface Reference

Component for a line which indicates addon download state in the download manager. More...

Inheritance diagram for SCR_DownloadManager_AddonDownloadLine:

Public Member Functions
override void	HandlerAttached (Widget w)
override void	HandlerDeattached (Widget w)
void	InitForDownloadAction (SCR_WorkshopItemActionDownload action)
	Initializes the line in interactive mode.
void	InitForCancelDownloadAction (SCR_WorkshopItemActionDownload action)
	Initializes the line in non-interactive mode, shows basic data about a download which is already running.
void	InitForServerDownloadAction (SCR_WorkshopItemActionDownload action)
	Initializes the line in non-interactive mode, shows basic data about a download relating to joining servers.
void	InitForServerBrowser (SCR_WorkshopItem item, Revision overrideTargetVersion=null, bool showVersionAndSize=true)
	Initializes the line in non-interactive mode, shows basic data about a download.
void	InitForWorkshopItem (SCR_WorkshopItem item, Revision versionTo=null, bool showVersionAndSize=true)
	Initializes the line in passive mode. It will just show basic information once.
void	DisplayError (string msg, bool positive=false)
	Display error massage, based on positivity message is green or red.
SCR_WorkshopItem	GetItem ()
Widget	GetRootWidget ()
SCR_WorkshopItemActionDownload	GetDownloadAction ()

Public Attributes
bool	m_bHideButtons

Protected Member Functions
void	Update ()
void	UpdateAllWidgets ()
	Updates all widgets. Only relevant in the mode InitForDownloadAction.
void	OnPauseButton ()
void	OnCancelButton ()
void	DisplayActionIcon (Revision vFrom, Revision vTo)
	Display icon with action that need to done - download, update, downgrade.

Protected Attributes
ref SCR_DownloadManager_AddonDownloadLineBaseWidgets	m_Widgets = new SCR_DownloadManager_AddonDownloadLineBaseWidgets()
ref SCR_WorkshopItemActionDownload	m_Action
ref SCR_WorkshopItem	m_Item
ResourceName	m_IconImageSet
bool	m_bVersionChange = false
Widget	m_wRoot

Static Protected Attributes
const string	ICON_UP = "up"
const string	ICON_DOWN = "down"
const Color	ICON_COLOR_DOWNLOAD = UIColors.CONTRAST_COLOR
const Color	ICON_COLOR_UP = UIColors.CONFIRM
const Color	ICON_COLOR_DOWN = UIColors.WARNING
const Color	TEXT_SIZE_COLOR_DOWNLOAD = UIColors.CONTRAST_COLOR
const Color	TEXT_SIZE_COLOR_DOWNLOADED = UIColors.NEUTRAL_INFORMATION
const Color	TEXT_SIZE_COLOR_ERROR = UIColors.WARNING

Detailed Description

Component for a line which indicates addon download state in the download manager.

Member Function Documentation

DisplayActionIcon()

void SCR_DownloadManager_AddonDownloadLine.DisplayActionIcon ( Revision  vFrom, Revision  vTo  )

protected

Display icon with action that need to done - download, update, downgrade.

DisplayError()

void SCR_DownloadManager_AddonDownloadLine.DisplayError	(	string	msg,
		bool	positive = false
	)

Display error massage, based on positivity message is green or red.

GetDownloadAction()

SCR_WorkshopItemActionDownload SCR_DownloadManager_AddonDownloadLine.GetDownloadAction

(

)

GetItem()

SCR_WorkshopItem SCR_DownloadManager_AddonDownloadLine.GetItem

(

)

GetRootWidget()

Widget SCR_DownloadManager_AddonDownloadLine.GetRootWidget

(

)

HandlerAttached()

override void SCR_DownloadManager_AddonDownloadLine.HandlerAttached

(

Widget

w

)

HandlerDeattached()

override void SCR_DownloadManager_AddonDownloadLine.HandlerDeattached

(

Widget

w

)

InitForCancelDownloadAction()

void SCR_DownloadManager_AddonDownloadLine.InitForCancelDownloadAction

(

SCR_WorkshopItemActionDownload

action

)

Initializes the line in non-interactive mode, shows basic data about a download which is already running.

InitForDownloadAction()

void SCR_DownloadManager_AddonDownloadLine.InitForDownloadAction

(

SCR_WorkshopItemActionDownload

action

)

Initializes the line in interactive mode.

It will be able to interact with the download action.

InitForServerBrowser()

void SCR_DownloadManager_AddonDownloadLine.InitForServerBrowser	(	SCR_WorkshopItem	item,
		Revision	overrideTargetVersion = null,
		bool	showVersionAndSize = true
	)

Initializes the line in non-interactive mode, shows basic data about a download.

InitForServerDownloadAction()

void SCR_DownloadManager_AddonDownloadLine.InitForServerDownloadAction

(

SCR_WorkshopItemActionDownload

action

)

Initializes the line in non-interactive mode, shows basic data about a download relating to joining servers.

InitForWorkshopItem()

void SCR_DownloadManager_AddonDownloadLine.InitForWorkshopItem	(	SCR_WorkshopItem	item,
		Revision	versionTo = null,
		bool	showVersionAndSize = true
	)

Initializes the line in passive mode. It will just show basic information once.

OnCancelButton()

void SCR_DownloadManager_AddonDownloadLine.OnCancelButton ( )

protected

OnPauseButton()

void SCR_DownloadManager_AddonDownloadLine.OnPauseButton ( )

protected

Update()

void SCR_DownloadManager_AddonDownloadLine.Update ( )

protected

UpdateAllWidgets()

void SCR_DownloadManager_AddonDownloadLine.UpdateAllWidgets ( )

protected

Updates all widgets. Only relevant in the mode InitForDownloadAction.

Member Data Documentation

ICON_COLOR_DOWN

const Color SCR_DownloadManager_AddonDownloadLine.ICON_COLOR_DOWN = UIColors.WARNING

staticprotected

ICON_COLOR_DOWNLOAD

const Color SCR_DownloadManager_AddonDownloadLine.ICON_COLOR_DOWNLOAD = UIColors.CONTRAST_COLOR

staticprotected

ICON_COLOR_UP

const Color SCR_DownloadManager_AddonDownloadLine.ICON_COLOR_UP = UIColors.CONFIRM

staticprotected

ICON_DOWN

const string SCR_DownloadManager_AddonDownloadLine.ICON_DOWN = "down"

staticprotected

ICON_UP

const string SCR_DownloadManager_AddonDownloadLine.ICON_UP = "up"

staticprotected

m_Action

ref SCR_WorkshopItemActionDownload SCR_DownloadManager_AddonDownloadLine.m_Action

protected

m_bHideButtons

bool SCR_DownloadManager_AddonDownloadLine.m_bHideButtons

m_bVersionChange

bool SCR_DownloadManager_AddonDownloadLine.m_bVersionChange = false

protected

m_IconImageSet

ResourceName SCR_DownloadManager_AddonDownloadLine.m_IconImageSet

protected

m_Item

ref SCR_WorkshopItem SCR_DownloadManager_AddonDownloadLine.m_Item

protected

m_Widgets

ref SCR_DownloadManager_AddonDownloadLineBaseWidgets SCR_DownloadManager_AddonDownloadLine.m_Widgets = new SCR_DownloadManager_AddonDownloadLineBaseWidgets()

protected

m_wRoot

Widget SCR_DownloadManager_AddonDownloadLine.m_wRoot

protected

TEXT_SIZE_COLOR_DOWNLOAD

const Color SCR_DownloadManager_AddonDownloadLine.TEXT_SIZE_COLOR_DOWNLOAD = UIColors.CONTRAST_COLOR

staticprotected

TEXT_SIZE_COLOR_DOWNLOADED

const Color SCR_DownloadManager_AddonDownloadLine.TEXT_SIZE_COLOR_DOWNLOADED = UIColors.NEUTRAL_INFORMATION

staticprotected

TEXT_SIZE_COLOR_ERROR

const Color SCR_DownloadManager_AddonDownloadLine.TEXT_SIZE_COLOR_ERROR = UIColors.WARNING

staticprotected

---

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

• Game/UI/Menu/DownloadManager/SCR_DownloadManager_AddonDownloadLine.c