OpenTTD Source: src/story_type.h File Reference

OpenTTD Source 15.0-beta1

Typedefs | Variables
story_type.h File Reference

basic types related to story pages More...

`#include "core/enum_type.hpp"`

Go to the source code of this file.

## Typedefs
typedef uint16_t | StoryPageElementID
| ID of a story page element.
typedef uint16_t | StoryPageID
| ID of a story page.

## Variables
static const StoryPageElementID | INVALID_STORY_PAGE_ELEMENT = 0xFFFF
| Constant representing a non-existing story page element.
static const StoryPageID | INVALID_STORY_PAGE = 0xFFFF
| Constant representing a non-existing story page.

## Detailed Description

basic types related to story pages

Definition in file story_type.h.

## Typedef Documentation

## ◆ StoryPageElementID

typedef uint16_t StoryPageElementID

ID of a story page element.

Definition at line 15 of file story_type.h.

## ◆ StoryPageID

typedef uint16_t StoryPageID

ID of a story page.

Definition at line 16 of file story_type.h.

## Variable Documentation

## ◆ INVALID_STORY_PAGE

const StoryPageID INVALID_STORY_PAGE = 0xFFFF
| static

Constant representing a non-existing story page.

Definition at line 22 of file story_type.h.

Referenced by CmdCreateStoryPage(), StoryBookWindow::OnInvalidateData(), and ShowStoryBook().

## ◆ INVALID_STORY_PAGE_ELEMENT

const StoryPageElementID INVALID_STORY_PAGE_ELEMENT = 0xFFFF
| static

Constant representing a non-existing story page element.

Definition at line 21 of file story_type.h.

Referenced by CmdCreateStoryPageElement(), StoryBookWindow::OnPageElementClick(), StoryBookWindow::OnPlaceObject(), StoryBookWindow::OnPlaceObjectAbort(), StoryBookWindow::OnTimeout(), StoryBookWindow::RefreshSelectedPage(), and StoryBookWindow::SetSelectedPage().