Novelty scripting reference > Types > Page

Page

Script representation of a Novelty page.
Page is a reference type. This means it has no constructor and can only be passed around by handle (Page@).


Members

const string name
The page's name.


Methods

Scene@ GetScene()
Returns a handle to the page's scene.

Chapter@ GetChapter()
Returns a handle to the chapter that the page is part of.

Page@ GetNextPage() const
Returns a handle to the succeeding page (within the same chapter), or null.

Page@ GetPreviousPage() const
Returns a handle to the preceding page (within the same chapter), or null.

bool CanSave() const
Returns true if the player is allowed to save the game in the page.

bool CanLoad() const
Returns true if the player is allowed to load a game in the page.

void EnumerateThreads(array<string> &inout stringArray) const
Populates the string array with the names of the page's threads.

void EnableBackground(bool enable) const
Toggles custom background color.

Color GetColor() const
Returns the custom background color.

void SetColor(const Color &in color) const
Sets a custom background color (and enables it).

string GetBackgroundImage() const
Returns the name of the page's current background texture.

bool SetBackgroundImage(const string &in assetName)
bool SetBackgroundImage(const string &in assetName, float time)
Change the page's background texture and returns true on success.

UID GetUID() const
Returns the unique id (UID) of the page.

string AsString() const
Returns a string describing the page.


Back to top