Screen Actions

In order to work with Screens and Screen Language, an Encyclopaedia has a collection of custom Screen Actions available.

PreviousEntry

Changes the currently active EncEntry to the previous one. If the currently active EncEntry is the first one, this action will do nothing.

textbutton "Previous Entry" action my_encyclopaedia.PreviousEntry()

NextEntry

Changes the currently active EncEntry to the next one. If the currently active EncEntry is the last one, this action will do nothing.

textbutton "Next Entry" action my_encyclopaedia.NextEntry()

PreviousPage

Changes the currently active EncEntry’s Sub-Page to the previous one. If the currently active Sub-Page is the first one, this action will do nothing.

textbutton "Previous Page" action my_encyclopaedia.PreviousPage()

NextPage

Changes the currently active EncEntry’s Sub-Page to the next one. If the currently active Sub-Page is the last one, this action will do nothing.

textbutton "Next Page" action my_encyclopaedia.NextPage()

Sort

Sorts the encyclopaedia by the sorting mode provided.

Takes a valid sorting mode as an argument.

textbutton "Sort By Unread" action my_encyclopaedia.Sort(Encyclopaedia.SORT_UNREAD)

SetEntry

Set an EncEntry as the active entry, then opens the Encyclopaedia’s Entry Screen.

textbutton "Open an Entry" action my_encyclopaedia.SetEntry(my_enc_entry)

ResetSubPage

Sets the currently active EncEntry’s Sub-Page to the first page.

textbutton "Return to First Page" action my_encyclopaedia.ResetSubPage()

ToggleShowLockedButtons

Toggles if locked Entries will be visible in the list of Entries.

textbutton "Show Locked Buttons" action my_encyclopaedia.ToggleShowLockedButtons()

ToggleShowLockedEntry

Toggles if locked Entries can be viewed.

textbutton "Show Locked Entries" action my_encyclopaedia.ToggleShowLockedEntry()

FilterBySubject

Create a filter for EncEntry in an Encyclopaedia, based on the “subject” attribute.

textbutton "Only Show Blue Things" action my_encyclopaedia.FilterBySubject("Blue")

ClearFilter

If a filter is active, this will clear it.

textbutton "Clear Filter" action my_encyclopaedia.ClearFilter()