Public Types | Static Public Member Functions

ScriptWaypoint Class Reference

Class that handles all waypoint related functions. More...

#include <script_waypoint.hpp>

Inheritance diagram for ScriptWaypoint:
ScriptBaseStation ScriptObject SimpleCountedObject

Public Types

enum  ErrorMessages { ERR_WAYPOINT_BASE = ScriptError::ERR_CAT_WAYPOINT << ScriptError::ERR_CAT_BIT_SIZE, ERR_WAYPOINT_TOO_CLOSE_TO_ANOTHER_WAYPOINT, ERR_WAYPOINT_ADJOINS_MULTIPLE_WAYPOINTS }
 

All waypoint related error messages.

More...
enum  WaypointType { WAYPOINT_RAIL = ::FACIL_TRAIN, WAYPOINT_BUOY = ::FACIL_DOCK, WAYPOINT_ANY = WAYPOINT_RAIL | WAYPOINT_BUOY }
 

Type of waypoints known in the game.

More...

Static Public Member Functions

static bool IsValidWaypoint (StationID waypoint_id)
 Checks whether the given waypoint is valid and owned by you.
static StationID GetWaypointID (TileIndex tile)
 Get the StationID of a tile.
static bool HasWaypointType (StationID waypoint_id, WaypointType waypoint_type)
 Check if any part of the waypoint contains a waypoint of the type waypoint_type.

Detailed Description

Class that handles all waypoint related functions.

ai game

Definition at line 22 of file script_waypoint.hpp.


Member Enumeration Documentation

All waypoint related error messages.

Enumerator:
ERR_WAYPOINT_BASE 

Base for waypoint related errors.

ERR_WAYPOINT_TOO_CLOSE_TO_ANOTHER_WAYPOINT 

The waypoint is build too close to another waypoint.

ERR_WAYPOINT_ADJOINS_MULTIPLE_WAYPOINTS 

The waypoint would join more than one existing waypoint together.

Definition at line 27 of file script_waypoint.hpp.

Type of waypoints known in the game.

Enumerator:
WAYPOINT_RAIL 

Rail waypoint.

WAYPOINT_BUOY 

Buoy.

WAYPOINT_ANY 

All waypoint types.

Definition at line 41 of file script_waypoint.hpp.


Member Function Documentation

StationID ScriptWaypoint::GetWaypointID ( TileIndex  tile  )  [static]

Get the StationID of a tile.

Parameters:
tile The tile to find the StationID of.
Precondition:
ScriptRail::IsRailWaypointTile(tile).
Returns:
StationID of the waypoint.

Definition at line 24 of file script_waypoint.cpp.

References GetStationIndex(), ScriptMarine::IsBuoyTile(), and ScriptRail::IsRailWaypointTile().

bool ScriptWaypoint::HasWaypointType ( StationID  waypoint_id,
WaypointType  waypoint_type 
) [static]

Check if any part of the waypoint contains a waypoint of the type waypoint_type.

Parameters:
waypoint_id The waypoint to look at.
waypoint_type The WaypointType to look for.
Returns:
True if the waypoint has a waypoint part of the type waypoint_type.

Definition at line 31 of file script_waypoint.cpp.

References HasExactlyOneBit(), and IsValidWaypoint().

bool ScriptWaypoint::IsValidWaypoint ( StationID  waypoint_id  )  [static]

Checks whether the given waypoint is valid and owned by you.

Parameters:
waypoint_id The waypoint to check.
Returns:
True if and only if the waypoint is valid.

Definition at line 18 of file script_waypoint.cpp.

References ScriptObject::GetCompany(), and OWNER_DEITY.

Referenced by HasWaypointType().


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