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	Disable ()
bool	IsVisible ()
Public Member Functions inherited from SCR_MapUIBaseComponent
bool	IsConfigDisabled ()
void	SetActive (bool active, bool isCleanup=false)
	Enable open/close events, called every time component is activated, usually on map open.
void	Init ()
	Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
void	Update (float timeSlice)
	Update method for frame operations.
bool	IsToolMenuFocused ()
void	SCR_MapUIBaseComponent ()

Protected Member Functions
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)
void	FocusOnFirstEntry ()
Protected Member Functions inherited from SCR_MapUIBaseComponent
void	OnMapOpen (MapConfiguration config)
	SCR_MapEntity event.
void	OnMapClose (MapConfiguration config)
	SCR_MapEntity event.

Protected Attributes
SCR_JournalSetupConfig	m_JournalConfig
string	m_sEntryList
Widget	m_wEntryList
string	m_sEntryLayout
Widget	m_wEntryLayout
ref array< SCR_MapJournalUIButton >	m_aEntries = {}
int	m_iCurrentEntryId = -1
string	m_sRootWidgetName
Widget	m_wJournalFrame
string	m_sToolMenuIconName
SCR_MapToolMenuUI	m_ToolMenu
SCR_MapToolEntry	m_ToolMenuEntry
SCR_PlayerFactionAffiliationComponent	m_PlyFactionAffilComp
string	m_sMapTaskListFrame
string	m_sTaskListToolMenuIconName
ResourceName	m_sJournalLayout
bool	m_bFirstOpening = true
Protected Attributes inherited from SCR_MapUIBaseComponent
bool	m_bDisableComponent
bool	m_bHookToRoot = false
Widget	m_RootWidget
SCR_MapEntity	m_MapEntity

Member Function Documentation

Disable()

void SCR_MapJournalUI.Disable

(

)

FocusOnFirstEntry()

void SCR_MapJournalUI.FocusOnFirstEntry ( )

protected

GetJournalForPlayer()

void SCR_MapJournalUI.GetJournalForPlayer ( )

protected

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

ShowEntry()

void SCR_MapJournalUI.ShowEntry ( SCR_MapJournalUIButton  journalBtn )

protected

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.

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_JournalConfig

SCR_JournalSetupConfig SCR_MapJournalUI.m_JournalConfig

protected

m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_MapJournalUI.m_PlyFactionAffilComp

protected

m_sEntryLayout

string SCR_MapJournalUI.m_sEntryLayout

protected

m_sEntryList

string SCR_MapJournalUI.m_sEntryList

protected

m_sJournalLayout

ResourceName SCR_MapJournalUI.m_sJournalLayout

protected

m_sMapTaskListFrame

string SCR_MapJournalUI.m_sMapTaskListFrame

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_wEntryLayout

Widget SCR_MapJournalUI.m_wEntryLayout

protected

m_wEntryList

Widget SCR_MapJournalUI.m_wEntryList

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