SCR_MapJournalUI Class Reference

Inheritance diagram for SCR_MapJournalUI:

Protected Member Functions
override void	Init ()
override void	OnMapOpen (MapConfiguration config)
void	UpdateJournalPosition ()
	Adjuts size of journal to match height of tool bar.
void	OnPlayerFactionResponse (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)
void	ToggleVisible ()
	Toggle visibility for the journal.
void	SetJournalVisibility (bool visibility)
void	GetJournalForPlayer ()
void	ShowEntryByID (int id)
void	ShowEntry (SCR_MapJournalUIButton journalBtn)
void	FocusOnFirstEntry ()
bool	IsVisible ()
void	DisableMapUIComponent ()
override void	HandlerDeattached (Widget w)

Protected Attributes
string	m_sRootWidgetName
string	m_sTaskListToolMenuIconName
string	m_sToolMenuIconName
int	m_iOffset
SCR_MapToolMenuUI	m_ToolMenu
SCR_MapToolEntry	m_ToolMenuEntry
SCR_MapTaskListUI	m_MapTaskList
SCR_JournalSetupConfig	m_JournalConfig
SCR_PlayerFactionAffiliationComponent	m_PlyFactionAffilComp
SCR_MapJournalUIButton	m_LastInteractedEntry
ref array< SCR_MapJournalUIButton >	m_aEntries = {}
int	m_iCurrentEntryId = -1
Widget	m_wJournalFrame
bool	m_bFirstOpening = true
ref SCR_JournalWidgets	m_Widgets = new SCR_JournalWidgets()

Detailed Description

Definition at line 2 of file SCR_MapJournalUI.c.

Member Function Documentation

DisableMapUIComponent()

void SCR_MapJournalUI::DisableMapUIComponent ( )

inlineprotected

Definition at line 289 of file SCR_MapJournalUI.c.

FocusOnFirstEntry()

void SCR_MapJournalUI::FocusOnFirstEntry ( )

inlineprotected

Definition at line 276 of file SCR_MapJournalUI.c.

GetJournalForPlayer()

void SCR_MapJournalUI::GetJournalForPlayer ( )

inlineprotected

Definition at line 175 of file SCR_MapJournalUI.c.

HandlerDeattached()

override void SCR_MapJournalUI::HandlerDeattached ( Widget w )

inlineprotected

Definition at line 295 of file SCR_MapJournalUI.c.

Init()

override void SCR_MapJournalUI::Init ( )

inlineprotected

Definition at line 34 of file SCR_MapJournalUI.c.

IsVisible()

bool SCR_MapJournalUI::IsVisible ( )

inlineprotected

Definition at line 283 of file SCR_MapJournalUI.c.

OnMapOpen()

override void SCR_MapJournalUI::OnMapOpen ( MapConfiguration config )

inlineprotected

Definition at line 60 of file SCR_MapJournalUI.c.

OnPlayerFactionResponse()

void SCR_MapJournalUI::OnPlayerFactionResponse ( SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response )

inlineprotected

Definition at line 132 of file SCR_MapJournalUI.c.

SetJournalVisibility()

void SCR_MapJournalUI::SetJournalVisibility ( bool visibility )

inlineprotected

Parameters

[in]

visibility

of journal to be set.

Definition at line 162 of file SCR_MapJournalUI.c.

ShowEntry()

void SCR_MapJournalUI::ShowEntry ( SCR_MapJournalUIButton journalBtn )

inlineprotected

Controls visuals of journal entries.

Parameters

[in]

journalBtn

clicked button.

Definition at line 247 of file SCR_MapJournalUI.c.

ShowEntryByID()

void SCR_MapJournalUI::ShowEntryByID ( int id )

inlineprotected

Show the entry defined by the parameter

Parameters

[in]

id

index of the entry defined in the SCR_JournalConfig

Definition at line 220 of file SCR_MapJournalUI.c.

ToggleVisible()

void SCR_MapJournalUI::ToggleVisible ( )

inlineprotected

Toggle visibility for the journal.

Definition at line 146 of file SCR_MapJournalUI.c.

UpdateJournalPosition()

void SCR_MapJournalUI::UpdateJournalPosition ( )

inlineprotected

Adjuts size of journal to match height of tool bar.

Definition at line 118 of file SCR_MapJournalUI.c.

Member Data Documentation

m_aEntries

ref array<SCR_MapJournalUIButton> SCR_MapJournalUI::m_aEntries = {}

protected

Definition at line 23 of file SCR_MapJournalUI.c.

m_bFirstOpening

bool SCR_MapJournalUI::m_bFirstOpening = true

protected

Definition at line 29 of file SCR_MapJournalUI.c.

m_iCurrentEntryId

int SCR_MapJournalUI::m_iCurrentEntryId = -1

protected

Definition at line 24 of file SCR_MapJournalUI.c.

m_iOffset

int SCR_MapJournalUI::m_iOffset

protected

Definition at line 14 of file SCR_MapJournalUI.c.

m_JournalConfig

SCR_JournalSetupConfig SCR_MapJournalUI::m_JournalConfig

protected

Definition at line 19 of file SCR_MapJournalUI.c.

m_LastInteractedEntry

SCR_MapJournalUIButton SCR_MapJournalUI::m_LastInteractedEntry

protected

Definition at line 21 of file SCR_MapJournalUI.c.

m_MapTaskList

SCR_MapTaskListUI SCR_MapJournalUI::m_MapTaskList

protected

Definition at line 18 of file SCR_MapJournalUI.c.

m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_MapJournalUI::m_PlyFactionAffilComp

protected

Definition at line 20 of file SCR_MapJournalUI.c.

m_sRootWidgetName

string SCR_MapJournalUI::m_sRootWidgetName

protected

Definition at line 5 of file SCR_MapJournalUI.c.

m_sTaskListToolMenuIconName

string SCR_MapJournalUI::m_sTaskListToolMenuIconName

protected

Definition at line 8 of file SCR_MapJournalUI.c.

m_sToolMenuIconName

string SCR_MapJournalUI::m_sToolMenuIconName

protected

Definition at line 11 of file SCR_MapJournalUI.c.

m_ToolMenu

SCR_MapToolMenuUI SCR_MapJournalUI::m_ToolMenu

protected

Definition at line 16 of file SCR_MapJournalUI.c.

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapJournalUI::m_ToolMenuEntry

protected

Definition at line 17 of file SCR_MapJournalUI.c.

m_Widgets

ref SCR_JournalWidgets SCR_MapJournalUI::m_Widgets = new SCR_JournalWidgets()

protected

Definition at line 31 of file SCR_MapJournalUI.c.

m_wJournalFrame

Widget SCR_MapJournalUI::m_wJournalFrame

protected

Definition at line 26 of file SCR_MapJournalUI.c.

---

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

• scripts/Game/Map/ComponentsUI/SCR_MapJournalUI.c