SuperLib  _SuperLib_VERSION
 All Classes Functions
Public Member Functions | Static Public Attributes | List of all members
_SuperLib_Story Class Reference

Public Member Functions

function NewStoryPage (company, title,...)
 This function creates a new story page with page elements.
function NewStoryPage2 (company, title,...)
function ShowMessage (company, text, title=null, question_id=0, question_type=GSGoal.QT_INFORMATION, question_buttons=GSGoal.BUTTON_CLOSE)
function IsStoryBookAvailable ()

Static Public Attributes

static APICheck = this

Member Function Documentation

function _SuperLib_Story::NewStoryPage ( company  ,
title  ,
  ... 
)

This function creates a new story page with page elements.

If any part fails, the page will be removed and the function returns -1.

This function verify that the Story Book API exist before trying to call it. Thus you can use it to display pages that will show for users that play with a recent enough OpenTTD version without breaking compatibility with older OpenTTD versions.

Args: company, title, [ [type, reference, text], [type, reference, text], [type, reference, text], ... ] or company, title, type, reference, text, type, reference, text, type, reference, text, ...

1) Each element is passed as an array with three unnamed elements. All elements are packed into an array. 2) Each element is passed as a sequence of three arguments.

See the API docs for StoryPage.NewElement for details on the allowed page element arguments.

Return: The page id of created page or -1 if anything fails.


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