SCR_BookmarkSettingsPlugin Interface Reference

Inheritance diagram for SCR_BookmarkSettingsPlugin:

Public Member Functions
ResourceName	GetBookmarkFile (int bookmarkIndex)
bool	SetBookmarkFile (int bookmarkIndex, ResourceName newBookmark)

Protected Member Functions
override void	Configure ()
int	BtnSave ()
int	BtnCancel ()

Protected Attributes
ResourceName	m_sBookmark_1
ResourceName	m_sBookmark_2
ResourceName	m_sBookmark_3
ResourceName	m_sBookmark_4
ResourceName	m_sBookmark_5
ResourceName	m_sBookmark_6
ResourceName	m_sBookmark_7
ResourceName	m_sBookmark_8
ResourceName	m_sBookmark_9
ResourceName	m_sBookmark_10

Member Function Documentation

BtnCancel()

int SCR_BookmarkSettingsPlugin.BtnCancel ( )

protected

BtnSave()

int SCR_BookmarkSettingsPlugin.BtnSave ( )

protected

Configure()

override void SCR_BookmarkSettingsPlugin.Configure ( )

protected

GetBookmarkFile()

ResourceName SCR_BookmarkSettingsPlugin.GetBookmarkFile

(

int

bookmarkIndex

)

Parameters

[in]

bookmarkIndex

a value in range 1..10

Returns

bookmark's resource name or empty if invalid value provided

SetBookmarkFile()

bool SCR_BookmarkSettingsPlugin.SetBookmarkFile	(	int	bookmarkIndex,
		ResourceName	newBookmark )

Parameters

[in]	bookmarkIndex	a value in range 1..10
[in]	newBookmark	the new bookmark value - can be empty

Returns

true on success, false otherwise (wrong bookmark index provided)

Member Data Documentation

m_sBookmark_1

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_1

protected

m_sBookmark_10

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_10

protected

m_sBookmark_2

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_2

protected

m_sBookmark_3

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_3

protected

m_sBookmark_4

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_4

protected

m_sBookmark_5

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_5

protected

m_sBookmark_6

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_6

protected

m_sBookmark_7

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_7

protected

m_sBookmark_8

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_8

protected

m_sBookmark_9

ResourceName SCR_BookmarkSettingsPlugin.m_sBookmark_9

protected

---

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

• WorkbenchGame/ResourceManager/SCR_BookmarkPlugin.c