Static Public Member Functions

ScriptViewport Class Reference

Class that manipultes the users viewport. More...

#include <script_viewport.hpp>

Inheritance diagram for ScriptViewport:
ScriptObject SimpleCountedObject

Static Public Member Functions

static void ScrollTo (TileIndex tile)
 Scroll the viewport to the given tile, where the tile will be in the center of the screen.

Detailed Description

Class that manipultes the users viewport.

game

Definition at line 22 of file script_viewport.hpp.


Member Function Documentation

void ScriptViewport::ScrollTo ( TileIndex  tile  )  [static]

Scroll the viewport to the given tile, where the tile will be in the center of the screen.

Parameters:
tile The tile to put in the center of the screen.
Precondition:
!ScriptGameIsMultiplayer().
ScriptMap::IsValidTile(tile).

Definition at line 18 of file script_viewport.cpp.

References ScriptGame::IsMultiplayer(), ScriptMap::IsValidTile(), and ScrollMainWindowToTile().


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