Inheritance diagram for SCR_MapJournalUIButton:

[legend]

Public Member Functions
void	SetEntry (SCR_JournalEntry entry, int id)

void	ShowEntry (Widget target)

int	GetId ()

Public Member Functions inherited from SCR_ButtonComponent
override void	HandlerAttached (Widget w)

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

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

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

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

void	ColorizeWidgets (Color colorBackground, Color colorContent, float speed=-1)

void	SetHorizontalAlign (LayoutHorizontalAlign horizontalAlign)

void	SetContent (string text)

void	SetContentFromUIInfo (SCR_UIInfo info)

string	GetContent ()

Public Member Functions inherited from SCR_ButtonBaseComponent
override void	HandlerAttached (Widget w)

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)

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

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

void	SetToggled (bool toggled, bool animate=true, bool invokeChange=true, bool instant=false)

bool	IsToggled ()

void	SetToggleable (bool togglable)

bool	GetToggleable ()

void	ShowBorder (bool show, bool animate=true)

bool	IsBorderShown ()

void	SetBackgroundColors (Color defColor=null, Color hoverColor=null, Color selectColor=null, Color selectHoverColor=null, Color clickColor=null)
	Alternate way of setting button background colors through script.

void	ColorizeBackground (bool animate=true)

Public Member Functions inherited from SCR_WLibComponentBase
override void	HandlerAttached (Widget w)

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

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

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

void	SetHoverSound (string soundHover)

void	SetClickedSound (string soundClicked)

string	GetHoverSound ()

string	GetClickedSound ()

void	SetEnabled (bool enabled, bool animate=true)

void	SetVisible (bool visible, bool animate=true)

bool	IsEnabled ()

void	SetMouseOverToFocus (bool mouseOverToFocus)

void	SetDisabledOpacity (float newDisabledOpacity)

Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void	HandlerAttached (Widget w)

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

Widget	GetRootWidget ()

bool	IsVisible ()

Protected Attributes
SCR_JournalEntry	m_Entry

int	m_iEntryId

Protected Attributes inherited from SCR_ButtonComponent
LocalizedString	m_sContent

Widget	m_wOverlay

Widget	m_wContent

ref Color	COLOR_BACKGROUND_DEFAULT = UIColors.BACKGROUND_DEFAULT

ref Color	COLOR_BACKGROUND_HOVERED = UIColors.BACKGROUND_HOVERED

ref Color	COLOR_BACKGROUND_FOCUSED = UIColors.BACKGROUND_HOVERED

ref Color	COLOR_BACKGROUND_CLICKED = UIColors.BACKGROUND_HOVERED

ref Color	COLOR_CONTENT_DEFAULT = Color.White

ref Color	COLOR_CONTENT_HOVERED = Color.White

ref Color	COLOR_CONTENT_FOCUSED = Color.White

ref Color	COLOR_CONTENT_CLICKED = Color.White

Protected Attributes inherited from SCR_ButtonBaseComponent
bool	m_bIsToggled

MenuBase	m_ParentMenu

SCR_SubMenuBase	m_ParentSubMenu

Protected Attributes inherited from SCR_WLibComponentBase
string	m_sSoundHovered

string	m_sSoundClicked

float	m_fAnimationTime

bool	m_bMouseOverToFocus

float	m_fDisabledOpacity

float	m_fAnimationRate

Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget	m_wRoot

Additional Inherited Members
Static Public Member Functions inherited from SCR_ButtonComponent
static SCR_ButtonComponent	GetButtonComponent (string name, Widget parent, bool searchAllChildren=true)
	Static method to easily find component by providing name and parent.

Static Public Member Functions inherited from SCR_ButtonBaseComponent
static SCR_ButtonBaseComponent	GetButtonBase (string name, Widget parent, bool searchAllChildren=true)

Static Public Member Functions inherited from SCR_WLibComponentBase
static bool	SetTexture (ImageWidget widget, ResourceName texture, string image="")

Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent	GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
	Base method for component lookup through the widget library.

Public Attributes inherited from SCR_ButtonComponent
ref ScriptInvoker	m_OnHover = new ScriptInvoker()

ref ScriptInvoker< Widget >	m_OnHoverLeave = new ScriptInvoker()

Public Attributes inherited from SCR_ButtonBaseComponent
bool	m_bCanBeToggled

bool	m_bUseColorization

ref Color	m_BackgroundDefault

ref Color	m_BackgroundHovered

ref Color	m_BackgroundSelected

ref Color	m_BackgroundSelectedHovered

ref Color	m_BackgroundClicked

bool	m_bShowBorderOnFocus

bool	m_bShowBackgroundOnFocus

bool	m_bNoBorderAnimation

bool	m_bNoBackgroundAnimation

bool	m_bShowBorderOnHover

Widget	m_wBackground

Widget	m_wBorder

ref ScriptInvoker	m_OnClicked = new ScriptInvoker()

ref ScriptInvoker	m_OnToggled = new ScriptInvoker()

ref ScriptInvoker< Widget >	m_OnFocus = new ScriptInvoker<Widget>()

ref ScriptInvoker< Widget >	m_OnFocusLost = new ScriptInvoker<Widget>()

ref ScriptInvoker	m_OnShowBorder = new ScriptInvoker()

Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker	m_OnClick = new ScriptInvoker

Static Public Attributes inherited from SCR_WLibComponentBase
static const float	START_ANIMATION_RATE = 10001

static const float	START_ANIMATION_PERIOD = 250

Protected Member Functions inherited from SCR_ButtonBaseComponent
void	OnMenuSelect ()

void	MenuSelectBase ()

void	FindParentMenu ()
	Finds the parent menu of this component.

bool	IsParentMenuFocused ()
	Returns true if parent menu is focused, or if there is no parent menu.

Protected Member Functions inherited from SCR_WLibComponentBase
void	OnEnabled (bool animate)

void	OnDisabled (bool animate)

bool	IsChildWidget (Widget parent, Widget child)

void	SetAnimationRate ()

void	PlaySound (string sound)

Member Function Documentation

◆ GetId()

int SCR_MapJournalUIButton.GetId ( )

Returns

◆ SetEntry()

void SCR_MapJournalUIButton.SetEntry	(	SCR_JournalEntry	entry,
		int	id
	)

Parameters

[in]	entry
[in]	id

◆ ShowEntry()

void SCR_MapJournalUIButton.ShowEntry ( Widget target )

Parameters

[in] target

Member Data Documentation

◆ m_Entry

SCR_JournalEntry SCR_MapJournalUIButton.m_Entry

protected

◆ m_iEntryId

int SCR_MapJournalUIButton.m_iEntryId

protected

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

Game/Map/ComponentsUI/SCR_MapJournalUI.c

Public Member Functions

Protected Attributes