Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Protected Attributes | List of all members
SCR_EditorContentBrowserSaveStateData Interface Reference

Editor Content browser State data (Eg: Saved active filters, Search string and pagination) as well as tab UI info of content browser states. More...

Inheritance diagram for SCR_EditorContentBrowserSaveStateData:
[legend]

Public Member Functions

int GetSavedLabelCount ()
 Get saved Label filters count.
 
void SetLabels (notnull array< EEditableEntityLabel > savedLabels, bool checkForInvalid=false)
 Set saved Label filters.
 
void AddRemoveLabel (EEditableEntityLabel label, bool addLabel)
 Add or remove the given label.
 
int GetLabels (out notnull array< EEditableEntityLabel > labels)
 Get saved Label filters.
 
bool ContainsLabel (EEditableEntityLabel label)
 Check if provided label is on the list of saved labels.
 
void SetPageIndex (int pageIndex)
 Set saved page index.
 
int GetPageIndex ()
 Get saved page index.
 
void SetSearchString (string searchString)
 Set saved search string.
 
string GetSearchString ()
 Get saved search string.
 
bool HasSearchSaved ()
 Get has search string saved.
 

Protected Attributes

ref array< EEditableEntityLabel > m_iSavedLabels
 
int m_iPageIndex = 0
 
string m_sSearchString
 

Detailed Description

Editor Content browser State data (Eg: Saved active filters, Search string and pagination) as well as tab UI info of content browser states.

This is used for persistence states between games. Saving it in Editor Settings

Member Function Documentation

◆ AddRemoveLabel()

void SCR_EditorContentBrowserSaveStateData.AddRemoveLabel ( EEditableEntityLabel  label,
bool  addLabel 
)

Add or remove the given label.

Parameters
labelLabel to add or remove
addLabelIf true will add the label. Else will remove

◆ ContainsLabel()

bool SCR_EditorContentBrowserSaveStateData.ContainsLabel ( EEditableEntityLabel  label)

Check if provided label is on the list of saved labels.

Returns
true if given label is on the list

◆ GetLabels()

int SCR_EditorContentBrowserSaveStateData.GetLabels ( out notnull array< EEditableEntityLabel >  labels)

Get saved Label filters.

Parameters
[out]labelsSaved labels
Returns
Saved label count

◆ GetPageIndex()

int SCR_EditorContentBrowserSaveStateData.GetPageIndex ( )

Get saved page index.

Returns
Saved page index

◆ GetSavedLabelCount()

int SCR_EditorContentBrowserSaveStateData.GetSavedLabelCount ( )

Get saved Label filters count.

Returns
Saved label count

◆ GetSearchString()

string SCR_EditorContentBrowserSaveStateData.GetSearchString ( )

Get saved search string.

Returns
Saved search string

◆ HasSearchSaved()

bool SCR_EditorContentBrowserSaveStateData.HasSearchSaved ( )

Get has search string saved.

Returns
True if search string is saved

◆ SetLabels()

void SCR_EditorContentBrowserSaveStateData.SetLabels ( notnull array< EEditableEntityLabel >  savedLabels,
bool  checkForInvalid = false 
)

Set saved Label filters.

Parameters
savedLabelslabels to save
Iftrue will check if saved label is still valid

◆ SetPageIndex()

void SCR_EditorContentBrowserSaveStateData.SetPageIndex ( int  pageIndex)

Set saved page index.

Parameters
pageIndexPage index to save

◆ SetSearchString()

void SCR_EditorContentBrowserSaveStateData.SetSearchString ( string  searchString)

Set saved search string.

Parameters
searchStringSearch string to save

Member Data Documentation

◆ m_iPageIndex

int SCR_EditorContentBrowserSaveStateData.m_iPageIndex = 0
protected

◆ m_iSavedLabels

ref array<EEditableEntityLabel> SCR_EditorContentBrowserSaveStateData.m_iSavedLabels
protected

◆ m_sSearchString

string SCR_EditorContentBrowserSaveStateData.m_sSearchString
protected

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