SCR_MapJournalUI Interface Reference

Inheritance diagram for SCR_MapJournalUI:

Public Member Functions
override void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
override void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	SetJournalVisibility (bool visibility)
bool	IsVisible ()
void	DisableMapUIComponent ()
override void	HandlerDeattached (Widget w)
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
bool	IsExclusive ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
void	Update (float timeSlice)
	Update method for frame operations.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Protected Member Functions
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	GetJournalForPlayer ()
void	ShowEntryByID (int id)
	Show the entry defined by the parameter.
void	ShowEntry (SCR_MapJournalUIButton journalBtn)
	Controls visuals of journal entries.
void	FocusOnFirstEntry ()
Protected Member Functions inherited from SCR_MapUIBaseComponent
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

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()
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bIsExclusive
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Member Function Documentation

DisableMapUIComponent()

void SCR_MapJournalUI.DisableMapUIComponent

(

)

FocusOnFirstEntry()

void SCR_MapJournalUI.FocusOnFirstEntry ( )

protected

GetJournalForPlayer()

void SCR_MapJournalUI.GetJournalForPlayer ( )

protected

HandlerDeattached()

override void SCR_MapJournalUI.HandlerDeattached

(

Widget

w

)

Init()

override void SCR_MapJournalUI.Init

(

)

Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.

Implements SCR_MapUIBaseComponent.

IsVisible()

bool SCR_MapJournalUI.IsVisible

(

)

OnMapOpen()

override void SCR_MapJournalUI.OnMapOpen

(

MapConfiguration

config

)

SCR_MapEntity event.

Parameters

[in]

config

Implements SCR_MapUIBaseComponent.

OnPlayerFactionResponse()

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

protected

SetJournalVisibility()

void SCR_MapJournalUI.SetJournalVisibility

(

bool

visibility

)

Parameters

[in]

visibility

of journal to be set.

ShowEntry()

void SCR_MapJournalUI.ShowEntry ( SCR_MapJournalUIButton journalBtn )

protected

Controls visuals of journal entries.

Parameters

[in]

journalBtn

clicked button.

ShowEntryByID()

void SCR_MapJournalUI.ShowEntryByID ( int id )

protected

Show the entry defined by the parameter.

Parameters

[in]

id

index of the entry defined in the SCR_JournalConfig

ToggleVisible()

void SCR_MapJournalUI.ToggleVisible ( )

protected

Toggle visibility for the journal.

UpdateJournalPosition()

void SCR_MapJournalUI.UpdateJournalPosition ( )

protected

Adjuts size of journal to match height of tool bar.

Member Data Documentation

m_aEntries

ref array<SCR_MapJournalUIButton> SCR_MapJournalUI.m_aEntries = {}

protected

m_bFirstOpening

bool SCR_MapJournalUI.m_bFirstOpening = true

protected

m_iCurrentEntryId

int SCR_MapJournalUI.m_iCurrentEntryId = -1

protected

m_iOffset

int SCR_MapJournalUI.m_iOffset

protected

m_JournalConfig

SCR_JournalSetupConfig SCR_MapJournalUI.m_JournalConfig

protected

m_LastInteractedEntry

SCR_MapJournalUIButton SCR_MapJournalUI.m_LastInteractedEntry

protected

m_MapTaskList

SCR_MapTaskListUI SCR_MapJournalUI.m_MapTaskList

protected

m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_MapJournalUI.m_PlyFactionAffilComp

protected

m_sRootWidgetName

string SCR_MapJournalUI.m_sRootWidgetName

protected

m_sTaskListToolMenuIconName

string SCR_MapJournalUI.m_sTaskListToolMenuIconName

protected

m_sToolMenuIconName

string SCR_MapJournalUI.m_sToolMenuIconName

protected

m_ToolMenu

SCR_MapToolMenuUI SCR_MapJournalUI.m_ToolMenu

protected

m_ToolMenuEntry

SCR_MapToolEntry SCR_MapJournalUI.m_ToolMenuEntry

protected

m_Widgets

ref SCR_JournalWidgets SCR_MapJournalUI.m_Widgets = new SCR_JournalWidgets()

protected

m_wJournalFrame

Widget SCR_MapJournalUI.m_wJournalFrame

protected

---

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

• Game/Map/ComponentsUI/SCR_MapJournalUI.c